{"id":16724614,"url":"https://github.com/bostonaholic/ring-okta","last_synced_at":"2025-03-17T01:31:30.340Z","repository":{"id":40663984,"uuid":"59499783","full_name":"bostonaholic/ring-okta","owner":"bostonaholic","description":"Ring middleware for Okta Single Sign-on","archived":false,"fork":false,"pushed_at":"2025-02-24T14:12:16.000Z","size":447,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-08T17:54:50.497Z","etag":null,"topics":["clojure","middleware","okta","okta-saml-toolkit","ring","ring-middleware","saml","single-sign-on","sso"],"latest_commit_sha":null,"homepage":"https://bostonaholic.github.io/ring-okta/index.html","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bostonaholic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-23T16:35:08.000Z","updated_at":"2025-02-24T14:12:19.000Z","dependencies_parsed_at":"2024-02-13T18:30:33.438Z","dependency_job_id":"fc84a75e-af4a-4b4d-93a4-001acbe3b4a1","html_url":"https://github.com/bostonaholic/ring-okta","commit_stats":{"total_commits":268,"total_committers":4,"mean_commits":67.0,"dds":0.4328358208955224,"last_synced_commit":"685a9eef3d5a5f729d70c3665a3e531a3d6dbd2c"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bostonaholic%2Fring-okta","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bostonaholic%2Fring-okta/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bostonaholic%2Fring-okta/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bostonaholic%2Fring-okta/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bostonaholic","download_url":"https://codeload.github.com/bostonaholic/ring-okta/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243836015,"owners_count":20355615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clojure","middleware","okta","okta-saml-toolkit","ring","ring-middleware","saml","single-sign-on","sso"],"created_at":"2024-10-12T22:45:57.430Z","updated_at":"2025-03-17T01:31:30.333Z","avatar_url":"https://github.com/bostonaholic.png","language":"Clojure","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ring-okta\n\n[![Build and Test](https://github.com/bostonaholic/ring-okta/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/bostonaholic/ring-okta/actions/workflows/build-and-test.yml) [![Clojars Project](https://img.shields.io/clojars/v/bostonaholic/ring-okta.svg)](https://clojars.org/bostonaholic/ring-okta)\n\nRing middleware for Okta Single Sign-on.\n\n## Installation\n\n### Leiningen/Boot\n\n```clojure\n[bostonaholic/ring-okta \"1.0.7\"]\n```\n\n### Clojure CLI/deps.edn\n\n```clojure\nbostonaholic/ring-okta {:mvn/version \"1.0.7\"}\n```\n\n### Gradle\n\n```gradle\nimplementation(\"bostonaholic:ring-okta:1.0.7\")\n```\n\n### Maven\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ebostonaholic\u003c/groupId\u003e\n  \u003cartifactId\u003ering-okta\u003c/artifactId\u003e\n  \u003cversion\u003e1.0.7\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Okta SAML Toolkit Dependency\n\nSince Okta doesn't publish the SAML Toolkit for Java, you must download it [here](https://support.okta.com/entries/25009573-Current-SAML-Toolkit-for-Java-Version). You then must `mvn install` it to your local maven repository. Check the [project.clj](./project.clj) for the version of the SAML Toolkit to download from Okta.\n\n## Usage\n\n```clojure\n(ns com.company.core\n  (:require [compojure.core :refer :all]\n            [compojure.route :as route]\n            [ring.middleware.okta :refer [wrap-okta okta-routes]]))\n\n(defroutes company-routes\n  (GET \"/\" [] \"\u003ch1\u003eHello World\u003c/h1\u003e\")\n\n  okta-routes\n\n  (route/not-found \"\u003ch1\u003ePage not found\u003c/h1\u003e\"))\n\n(def app\n  (-\u003e company-routes\n      (wrap-okta \"https://company.okta.com\")))\n```\n\n## Documentation\n\n- [API Docs](http://bostonaholic.github.io/ring-okta/index.html)\n\nThe documentation is built with [codox](https://github.com/weavejester/codox) (`lein codox`) and published to `./docs` which ends up being hosted by GitHub Pages.\n\n## Test Coverage\n\nThe test coverage summary is built with [cloverage](https://github.com/lshift/cloverage) (`lein cloverage`) and published to `./docs/coverage` and is hosted [here](https://bostonaholic.github.io/ring-okta/coverage/index.html).\n\n## Development\n\nAs described in **Usage** above, the Okta SAML Toolkit must be downloaded and installed to your local maven repository. When updating this dependency, here is how you can install the downloaded jar:\n\n```shell\nmvn install:install-file -Dfile=saml-toolkit.jar -DgroupId=com.okta -DartifactId=saml-toolkit -Dpackaging=jar -Dversion=\u003cversion\u003e -DcreateChecksum=true -DupdateReleaseInfo=true -DgeneratePom=true -DlocalRepositoryPath=/path/to/localRepo\n```\n\n## Releases\n\n`ring-okta` is released on no particular schedule. New versions are released as needed when features are added or bugs are fixed.\n\nRefer to the [CHANGELOG.md](./CHANGELOG.md) for all version releases and the included changes.\n\nThe process for releasing a new version is as follows:\n\n### Pre-steps\n\n1. Bump version in project.clj following [Semantic Versioning 2.0.0](https://semver.org/)\n2. Bump version in [README.md](./README.md) to match `project.clj`\n3. Add changes to [CHANGELOG.md](./CHANGELOG.md) following [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)\n4. Generate API docs with `lein codox`\n\n### Release\n\n1. Commit changes with commit message `Release v\u003cversion\u003e`\n2. Tag the commit with `git tag v\u003cversion\u003e`\n3. Push changes to GitHub (including new tag with `--tags` option)\n4. Deploy release to [Clojars](https://clojars.org) with `lein deploy clojars`\n\n### Post-steps\n\n1. Bump patch version of `project.clj` to next `-SNAPSHOT`\n2. Commit snapshot version with commit message `\u003cversion\u003e`\n\n## License\n\nCopyright © 2025 Matthew Boston\n\nReleased under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbostonaholic%2Fring-okta","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbostonaholic%2Fring-okta","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbostonaholic%2Fring-okta/lists"}