Skip to content

Latest commit

 

History

History
110 lines (70 loc) · 3.52 KB

README.md

File metadata and controls

110 lines (70 loc) · 3.52 KB
Raw

ring-okta

Build and Test Clojars Project

Ring middleware for Okta Single Sign-on.

Installation

Leiningen/Boot

[bostonaholic/ring-okta "1.0.7"]

Clojure CLI/deps.edn

bostonaholic/ring-okta {:mvn/version "1.0.7"}

Gradle

implementation("bostonaholic:ring-okta:1.0.7")

Maven

<dependency>
  <groupId>bostonaholic</groupId>
  <artifactId>ring-okta</artifactId>
  <version>1.0.7</version>
</dependency>

Okta SAML Toolkit Dependency

Since Okta doesn't publish the SAML Toolkit for Java, you must download it here. You then must mvn install it to your local maven repository. Check the project.clj for the version of the SAML Toolkit to download from Okta.

Usage

(ns com.company.core
  (:require [compojure.core :refer :all]
            [compojure.route :as route]
            [ring.middleware.okta :refer [wrap-okta okta-routes]]))

(defroutes company-routes
  (GET "/" [] "<h1>Hello World</h1>")

  okta-routes

  (route/not-found "<h1>Page not found</h1>"))

(def app
  (-> company-routes
      (wrap-okta "https://company.okta.com")))

Documentation

The documentation is built with codox (lein codox) and published to ./docs which ends up being hosted by GitHub Pages.

Test Coverage

The test coverage summary is built with cloverage (lein cloverage) and published to ./docs/coverage and is hosted here.

Development

As 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:

mvn install:install-file -Dfile=saml-toolkit.jar -DgroupId=com.okta -DartifactId=saml-toolkit -Dpackaging=jar -Dversion=<version> -DcreateChecksum=true -DupdateReleaseInfo=true -DgeneratePom=true -DlocalRepositoryPath=/path/to/localRepo

Releases

ring-okta is released on no particular schedule. New versions are released as needed when features are added or bugs are fixed.

Refer to the CHANGELOG.md for all version releases and the included changes.

The process for releasing a new version is as follows:

Pre-steps

  1. Bump version in project.clj following Semantic Versioning 2.0.0
  2. Bump version in README.md to match project.clj
  3. Add changes to CHANGELOG.md following Keep a Changelog
  4. Generate API docs with lein codox

Release

  1. Commit changes with commit message Release v<version>
  2. Tag the commit with git tag v<version>
  3. Push changes to GitHub (including new tag with --tags option)
  4. Deploy release to Clojars with lein deploy clojars

Post-steps

  1. Bump patch version of project.clj to next -SNAPSHOT
  2. Commit snapshot version with commit message <version>

License

Copyright © 2024 Matthew Boston

Released under the MIT License.