miniorange-oauth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f78f4cba3bbd5ffac7fe891ec1d19a78762d5120fceefc46f1f09aebaacd32f
+  data.tar.gz: e0d7e5513728efaf7e921cd958d1e94c7180d0317c895a9ad2033836f7c74208
+SHA512:
+  metadata.gz: d260da2d8bc932c440d410a50fb425ed2fbea4ca4e13f093fdcb3019db1a3ecdeaca6ab1270f4ca5e60b52792ccaf08df21183691bbcf0f25a8ed04ee9d218b9
+  data.tar.gz: 9fd28cdc031d60efaa7f8332484b7ee1fe9a482048f9a803abf07f838495d76a493c29801c491ec82d3f214b814629485a5d2013027645161fc7172b5ff16858

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-02
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/README.md

@@ -0,0 +1,71 @@
+# MiniOrange OAuth Connector
+
+A Ruby gem for implementing OAuth 2.0 authentication with miniOrange.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'miniorange-oauth'
+```
+
+And then execute:
+```bash
+bundle install
+```
+
+Or install it yourself as:
+```bash
+gem install miniorange-oauth
+```
+
+## Usage
+
+1. Configure the OAuth client:
+
+```ruby
+MiniOrange::Oauth.configure do |config|
+  config.client_id = "your_client_id"
+  config.client_secret = "your_client_secret"
+  config.redirect_uri = "https://your-app.com/sso/callback"
+  config.baseUri = "https://miniorange.com"
+  config.loginRedirectUri = "https://your-app.com/dashboard"
+  config.logoutRedirectUri = "https://your-app.com"
+  config.brokerUri = "https://broker.miniorange.com" # Optional
+end
+```
+
+2. Generate authorization URL:
+
+```ruby
+auth_handler = MiniOrange::Oauth::Handlers::AuthorizationHandler.new
+auth_url = auth_handler.generate_authorization_url
+# Redirect user to auth_url
+```
+
+3. Handle the callback:
+
+```ruby
+callback_handler = MiniOrange::Oauth::Handlers::CallbackHandler.new
+result = callback_handler.handle_callback(callback_url)
+
+if result
+  user_info = result[:user_info]
+  # Handle user information as needed
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/ruby-oauth.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/miniorange/oauth/config/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MiniOrange
+  module Oauth
+    module Config
+      class Configuration
+        def initialize
+        end
+
+        # Client credentials
+        attr_accessor :client_id, :client_secret
+
+        # URIs
+        attr_accessor :redirect_uri, :base_uri, :logout_redirect_uri, :broker_uri
+
+        private
+
+        def validate_uri(uri)
+          URI.parse(uri)
+          true
+        rescue URI::InvalidURIError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/miniorange/oauth/handlers/authorization_handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MiniOrange
+  module Oauth
+    module Handlers
+      class AuthorizationHandler
+        def generate_authorization_url
+          client_id = config.client_id
+          redirect_uri = URI.encode_www_form_component(config.redirect_uri)
+          scope = "openid"
+
+          # Use broker_uri or base_uri
+          auth_url = if config.broker_uri && !config.broker_uri.empty?
+                       config.broker_uri
+                     else
+                       Utils::UrlUtils.create_authorization_url(config.base_uri)
+                     end
+
+          # Construct full URL
+          "#{auth_url}?response_type=code&client_id=#{client_id}&redirect_uri=#{redirect_uri}&scope=#{scope}"
+        end
+
+        private
+
+        def config
+          MiniOrange::Oauth.configuration
+        end
+      end
+    end
+  end
+end

data/lib/miniorange/oauth/handlers/callback_handler.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "uri"
+require "json"
+
+module MiniOrange
+  module Oauth
+    module Handlers
+      class CallbackHandler
+        def initialize(config = MiniOrange::Oauth.configuration)
+          @config = config
+        end
+
+        def handle_callback(callback_url)
+          uri = URI.parse(callback_url)
+          return unless uri.path&.start_with?("/sso/callback")
+
+          params = URI.decode_www_form(uri.query.to_s).to_h
+          code = params["code"]
+          raise Error, "No authorization code found in callback URL" unless code
+
+          access_token = fetch_token(code)
+          user_info = fetch_user_info(access_token)
+
+          { user_info: user_info, access_token: access_token }
+        end
+
+        private
+
+        def fetch_token(code)
+          token_url = MiniOrange::Oauth::Utils::UrlUtils.create_token_url(@config.base_uri)
+          response = Faraday.post(token_url) do |req|
+            req.headers["Content-Type"] = "application/x-www-form-urlencoded"
+            req.body = build_query_string(
+              grant_type:    "authorization_code",
+              code:          code,
+              client_id:     @config.client_id,
+              client_secret: @config.client_secret,
+              redirect_uri:  @config.redirect_uri,
+              scope:         "openid"
+            )
+          end
+
+          raise Error, "Failed to get access token: #{response.body}" unless response.status == 200
+
+          JSON.parse(response.body)["access_token"]
+        end
+
+        def fetch_user_info(access_token)
+          user_info_url = MiniOrange::Oauth::Utils::UrlUtils.get_user_info_url(@config.base_uri)
+          response = Faraday.get(user_info_url) do |req|
+            req.headers["Authorization"] = "Bearer #{access_token}"
+            req.headers["Accept"]        = "application/json"
+          end
+
+          raise Error, "Failed to get user info: #{response.body}" unless response.status == 200
+
+          JSON.parse(response.body)
+        end
+
+        def build_query_string(params)
+          params.compact.map { |k, v| "#{k}=#{URI.encode_www_form_component(v)}" }.join("&")
+        end
+      end
+    end
+  end
+end

data/lib/miniorange/oauth/handlers/logout_handler.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module MiniOrange
+  module Oauth
+    module Handlers
+      class LogoutHandler
+        def initialize(config = MiniOrange::Oauth.configuration)
+          @config = config
+        end
+
+        def generate_logout_url
+          base_url = @config.base_uri
+          post_logout_redirect_uri = @config.logout_redirect_uri
+
+          raise Error, "Missing logout_redirect_uri in configuration" unless post_logout_redirect_uri
+          raise Error, "Missing base_uri in configuration" unless base_url
+
+          Utils::UrlUtils.create_logout_url(base_url, post_logout_redirect_uri)
+        end
+      end
+    end
+  end
+end

data/lib/miniorange/oauth/utils/url_utils.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module MiniOrange
+  module Oauth
+    module Utils
+      class UrlUtils
+        class << self
+          def create_token_url(base_url)
+            "#{base_url}/rest/oauth/token"
+          end
+
+          def create_authorization_url(base_url)
+            "#{base_url}/idp/openidsso"
+          end
+
+          def create_revocation_url(base_url)
+            "#{base_url}/rest/oauth/revoke"
+          end
+
+          def create_introspection_url(base_url)
+            "#{base_url}/rest/oauth/introspect"
+          end
+
+          def get_user_info_url(base_url)
+            "#{base_url}/rest/oauth/getuserinfo"
+          end
+
+          def create_logout_url(base_url, logout_redirect_uri)
+            "#{base_url}/idp/oidc/logout?post_logout_redirect_uri=#{URI.encode_www_form_component(logout_redirect_uri)}"
+          end
+
+          private
+
+          def ensure_no_trailing_slash(url)
+            url.chomp("/")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/miniorange/oauth/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module MiniOrange
+  module Oauth
+    VERSION = "0.1.0"
+  end
+end

data/lib/miniorange/oauth.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+require_relative "oauth/version"
+require_relative "oauth/config/configuration"
+require_relative "oauth/handlers/authorization_handler"
+require_relative "oauth/handlers/callback_handler"
+require_relative "oauth/handlers/logout_handler"
+require_relative "oauth/utils/url_utils"
+
+module MiniOrange
+  module Oauth
+    class Error < StandardError; end
+
+    class << self
+      def configuration
+        @configuration ||= Config::Configuration.new
+      end
+
+      def configure
+        yield(configuration) if block_given?
+      end
+
+      def reset_configuration!
+        @configuration = Config::Configuration.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: miniorange-oauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- miniOrange
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby gem for implementing OAuth 2.0 authentication with miniOrange
+email:
+- idpsupport@xecurify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- lib/miniorange/oauth.rb
+- lib/miniorange/oauth/config/configuration.rb
+- lib/miniorange/oauth/handlers/authorization_handler.rb
+- lib/miniorange/oauth/handlers/callback_handler.rb
+- lib/miniorange/oauth/handlers/logout_handler.rb
+- lib/miniorange/oauth/utils/url_utils.rb
+- lib/miniorange/oauth/version.rb
+homepage: https://github.com/miniOrangeDev/ruby-oauth
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Ruby OAuth Connector for miniOrange
+test_files: []