keywright 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5c865e5e16398211703a4fd06e282ef417ef5b95d1ff7eb7a474594b4119405
+  data.tar.gz: 88066856bca9240a75e7894a4c56c813ba4c647c351c12fa0d1f20b92d906d6e
+SHA512:
+  metadata.gz: efd18518a43e444e07930913394e7f93f25a584dba3bae03f90040a40a85b4defc0cdd81f307c798d61755f7cf346c084ebff89be840e2cc8c700d865db389d6
+  data.tar.gz: 66739623a0fda46ab8496b3873ed65d5779b41bc917324768500f1385e33d0a1ad599456d3f8153b044ad1f2a868009e66b1edd47b34904664e6686500ec0c68

data/lib/keywright/authorization.rb

@@ -0,0 +1,61 @@
+module Keywright 
+  class Authorization
+
+    class << self 
+
+      def code_from_uri( uri )
+        uri = URI.parse( uri )
+        query_string = uri.query
+        params = UriHelpers.parse_query( query_string )
+        params[ 'code' ]
+      end
+
+    end
+
+    def initialize( configuration = nil )
+      @configuration = ( configuration || Keywright.configuration )&.to_h
+      yield self if block_given?
+    end
+
+    #
+    # The url method will return a url, with the required parameters including the client id, 
+    # redirect_uri, scopes and state, that the user agent should be redirected to for
+    # authorization.
+    #
+    # The authorization_uri and client_id are required. These must be provided through the 
+    # options or previously assigned to the instance configuration or global configuration.
+    #
+    # The redirect_uri, scopes, and state parameters are optional. If the redirect_uri is blank
+    # it will not be included. If the scopes are blank the scopes from the configuration will 
+    # be used ( if any ). If the state is blank it will not be included. 
+    #
+    def url( **options )
+      authorization_uri = options[ :authorization_uri ] || @configuration[ :authorization_uri ]
+      raise ArgumentError.new( 'The authorization_uri must be provided or configured.' ) \
+        unless UriHelpers.valid?( authorization_uri )
+
+      client_id = options[ :client_id ] || @configuration[ :client_id ]
+      raise ArgumentError.new( 'The client_id must be provided or configured.' ) \
+        if client_id.nil?
+
+      uri = URI.parse( authorization_uri )
+      params = UriHelpers.parse_query( uri.query )
+
+      params = params.merge( { 
+        'client_id' => client_id,
+
+        'redirect_uri' => options[ :redirect_uri ],
+        'scope' => options[ :scopes ] || @configuration.scopes,
+        'state' => options[ :state ]
+      }.compact )
+
+      uri.query = URI.encode_www_form( params )
+      uri.to_s
+    end
+
+    def code_from_uri( url )
+      self.class.code_from_uri( url )
+    end
+
+  end
+end

data/lib/keywright/configuration.rb

@@ -0,0 +1,44 @@
+module Keywright 
+  class Configuration
+    include DynamicSchema::Definable 
+
+    schema do 
+      authorization_uri             URI, required: true
+      token_uri                     URI, required: true
+      userinfo_uri                  URI
+
+      client_authorization_methods  String, array: true 
+      client_id                     String  
+      client_secret                 String 
+
+      scopes                        String, array: true
+    end
+
+    def self.build( configuration = nil, &block )
+      new( builder.build( configuration, &block ) )
+    end 
+
+    def self.build!( configuration = nil, &block )
+      new( builder.build!( configuration, &block ) )
+    end 
+
+    def initialize( configuration = {} )
+      @configuration = self.class.builder.build( configuration || {} )
+    end
+
+    def []( key )
+      @configuration[ key ]
+    end
+
+    def to_h
+      @configuration.to_h
+    end
+
+  end
+end
+
+
+
+
+
+

data/lib/keywright/error_result.rb

@@ -0,0 +1,45 @@
+module Keywright 
+  class ErrorResult < Result 
+
+    attr_reader :error, :error_description  
+    
+    def initialize( status_code, attributes = nil )
+      super( attributes )
+      if @error.nil? || @error_description.nil? 
+        error, error_description = status_code_to_error( status_code )
+        @error ||= error
+        @error_description ||= error_description  
+      end
+    end 
+
+  private 
+    def status_code_to_error( status_code )
+      case status_code 
+      when 400
+        [ :invalid_request_error, 
+          "The request format or content is invalid." ]
+      when 401
+        [ :authentication_error, 
+          "The request credentials are invalid." ]
+      when 404
+        [ :not_found_error, 
+          "The request resource/path was not found." ]
+      when 422 
+        [ :invalid_data_error,
+          "The request body is invalid." ]
+      when 429
+        [ :rate_limit_error, 
+          "The authorization service failed with a rate limit error." ]
+      when 500..505
+        [ :fatal_error, 
+          "The authorization service failed with error: '#{status_code}'." ]
+      when 529
+        [ :overloaded_error, 
+          "The authorization service is overloaded." ]
+      else
+        [ :unknown_error, 
+          "The authorization service returned error: '#{status_code}'." ]
+      end
+    end
+  end
+end

data/lib/keywright/refresh_token_request.rb

@@ -0,0 +1,45 @@
+module Keywright
+  class RefreshTokenRequest < Request
+
+    #
+    # The submit method makes a request to retrieve the OAuth token from the authorization server
+    # given the refresh_token.  
+    #
+    def submit( **arguments )
+
+      refresh_token = arguments[ :refresh_token ]
+      raise ArgumentError.new( 'A `refresh_token` is required.' ) \
+        if refresh_token.nil?
+
+      token_uri = arguments[ :token_uri ] || @configuration[ :token_uri ]
+      raise ArgumentError.new( 'The token uri must be provided or configured.' ) \
+        unless UriHelpers.valid?( token_uri )
+
+      client_id = arguments[ :client_id ] || @configuration[ :client_id ]
+      client_secret = arguments[ :client_secret ] || @configuration[ :client_secret ]
+      raise ArgumentError.new( 'The client credentials must be provided or configured.' ) \
+        if client_id.nil? || client_secret.nil?
+
+      response = Keywright.connection.post( token_uri ) do | request |
+        request.headers[ 'Authorization' ] =  
+          "Basic #{Base64.strict_encode64( "#{client_id}:#{client_secret}")}"
+        request.body = {
+          grant_type: 'refresh_token',
+          refresh_token: refresh_token
+        }
+        yield( request ) if block_given?
+      end
+
+      body = JSON.parse( response.body, symbolize_names: true ) rescue nil 
+      result = nil 
+      if response.success?
+        result = TokenResult.new( body )
+      else 
+        result = ErrorResult.new( response.status, body )
+      end
+      ResponseMethods.install( response, result )
+
+    end
+
+  end
+end

data/lib/keywright/request.rb

@@ -0,0 +1,34 @@
+ module Keywright 
+
+  ##
+  # The +Request+ class encapsulates a request to the OAuth 2 server. This class serves as the 
+  # basis for the TokenRequest and UserInfoRequest classes.
+  #  
+  class Request 
+   
+    ##
+    # The +initialize+ method initializes the +Request+ instance. 
+    #
+    def initialize( connection: nil, configuration: nil )
+      @connection = connection || Keywright.connection
+      @configuration = configuration || Keywright.configuration
+    end
+
+  protected
+
+  	attr_reader :connection, :configuration
+
+    def post( uri, body = {}, headers = {}, &block )
+      @connection.post( uri, body, headers, &block )
+    end 
+
+    def get( uri, headers = nil, &block )
+      @connection.get( uri ) do | request |
+        headers&.each { | key, value | request.headers[ key ] = value }
+        block.call( request ) if block 
+      end
+    end 
+
+  end
+
+end

data/lib/keywright/response_methods.rb

@@ -0,0 +1,15 @@
+module Keywright 
+  #
+  # The ResponseMethods module extends a Faraday reponse, adding the +result+ method. 
+  #
+  module ResponseMethods
+    def self.install( response, result )
+      response.instance_variable_set( "@_keywright_result", result )
+      response.extend( ResponseMethods )    
+    end 
+
+    def result
+      @_keywright_result
+    end 
+  end
+end 

data/lib/keywright/result.rb

@@ -0,0 +1,9 @@
+module Keywright 
+  class Result
+    def initialize( attributes = {} )
+      attributes&.each do | key, value |
+        self.instance_variable_set( "@#{key}", value )
+      end
+    end
+  end
+end

data/lib/keywright/token_request.rb

@@ -0,0 +1,46 @@
+module Keywright
+  class TokenRequest < Request
+
+    #
+    # The submit method makes a request to retrieve the OAuth token from the authorization server
+    # given the authorization code.  
+    #
+    def submit( **arguments )
+
+      code = arguments[ :code ]
+      raise ArgumentError.new( 'An authorization `code` is required.' ) \
+        if code.nil?
+
+      token_uri = arguments[ :token_uri ] || @configuration[ :token_uri ]
+      raise ArgumentError.new( 'The token uri must be provided or configured.' ) \
+        unless UriHelpers.valid?( token_uri )
+
+      client_id = arguments[ :client_id ] || @configuration[ :client_id ]
+      client_secret = arguments[ :client_secret ] || @configuration[ :client_secret ]
+      raise ArgumentError.new( 'The client credentials must be configured.' ) \
+        if client_id.nil? || client_secret.nil?
+
+      response = Keywright.connection.post( token_uri ) do | request |
+        request.headers[ 'Authorization' ] =  
+          "Basic #{Base64.strict_encode64( "#{client_id}:#{client_secret}")}"
+        request.body = {
+          grant_type: 'authorization_code',
+          code: code,
+          redirect_uri: arguments[ :redirect_uri ]
+        }
+        yield( request ) if block_given?
+      end
+
+      body = JSON.parse( response.body, symbolize_names: true ) rescue nil 
+      result = nil 
+      if response.success?
+        result = TokenResult.new( body )
+      else 
+        result = ErrorResult.new( response.status, body )
+      end
+      ResponseMethods.install( response, result )
+
+    end
+
+  end
+end

data/lib/keywright/token_result.rb

@@ -0,0 +1,5 @@
+module Keywright
+  class TokenResult < Result
+    attr_accessor :access_token, :token_type, :expires_in, :refresh_token
+  end
+end

data/lib/keywright/uri_helpers.rb

@@ -0,0 +1,45 @@
+module Keywright
+  module UriHelpers
+
+    def valid?( uri )
+      uri = uri.is_a?( URI ) ? uri : URI.parse( uri.to_s ) 
+      return false unless uri.is_a?( URI::HTTP ) || uri.is_a?( URI::HTTPS )
+      return false if uri.host.nil? || uri.host.strip.empty?
+      true
+    rescue URI::InvalidURIError
+      false
+    end
+
+    def parse_query( query, delimiter = nil )
+      params = {}
+
+      max_key_space = 1024
+      bytes = 0
+
+      ( query || '' ).split( delimiter ? /[#{delimiter}] */n : /[&;] */n ).each do | pair |
+        key, value = pair.split( '=', 2 ).map { | x | URI.decode_www_form_component( x ) }
+
+        if key
+          bytes += key.size
+          if bytes > max_key_space
+            raise RangeError, "exceeded available parameter key space"
+          end
+        end
+
+        if current = params[ key ]
+          if current.class == Array
+            params[ key ] << value
+          else
+            params[ key ] = [ current, value ]
+          end
+        else
+          params[ key ] = value 
+        end
+      end
+
+      return params
+    end
+
+    module_function :valid?, :parse_query
+  end
+end

data/lib/keywright/user_info_request.rb

@@ -0,0 +1,33 @@
+module Keywright
+  class UserInfoRequest < Request
+
+    #
+    # The submit method makes a request to retrieve the OIDC userinfo given an access token. 
+    #
+    def submit( **arguments )
+
+      access_token = arguments[ :access_token ]
+      raise ArgumentError.new( 'An access token is required.' ) if access_token.nil?
+
+      userinfo_uri = arguments[ :userinfo_uri ] || @configuration[ :userinfo_uri ]
+      raise ArgumentError.new( 'The userinfo uri must be provided or configured.' ) \
+        unless UriHelpers.valid?( userinfo_uri )
+
+      response = Keywright.connection.get( userinfo_uri ) do | request |
+        request.headers[ 'Authorization' ] = "Bearer #{access_token}"
+        yield( request ) if block_given?
+      end
+
+      body = JSON.parse( response.body, symbolize_names: true ) rescue nil 
+      result = nil 
+      if response.success?
+        result = UserInfoResult.new( body )
+      else 
+        result = ErrorResult.new( response.status, body )
+      end
+      ResponseMethods.install( response, result )
+
+    end
+
+  end
+end

data/lib/keywright/user_info_result.rb

@@ -0,0 +1,23 @@
+module Keywright
+  class UserInfoResult < Result
+    attr_accessor :updated_at
+    attr_accessor :sub
+    attr_accessor :name
+    attr_accessor :given_name
+    attr_accessor :family_name
+    attr_accessor :middle_name
+    attr_accessor :nickname
+    attr_accessor :preferred_username
+    attr_accessor :profile
+    attr_accessor :picture
+    attr_accessor :website
+    attr_accessor :email
+    attr_accessor :email_verified
+    attr_accessor :gender
+    attr_accessor :birthdate
+    attr_accessor :zoneinfo
+    attr_accessor :locale
+    attr_accessor :phone_number
+    attr_accessor :phone_number_verified
+  end
+end

data/lib/keywright/version.rb

@@ -0,0 +1,3 @@
+module Keywright
+  VERSION = "0.0.1"
+end

data/lib/keywright.rb

@@ -0,0 +1,57 @@
+require 'uri'
+require 'base64'
+require 'faraday'
+require 'dynamic_schema'
+
+require 'keywright/version'
+require 'keywright/uri_helpers'
+require 'keywright/configuration'
+require 'keywright/authorization'
+require 'keywright/result'
+require 'keywright/error_result'
+require 'keywright/token_result'
+require 'keywright/response_methods'
+require 'keywright/request'
+require 'keywright/token_request'
+require 'keywright/refresh_token_request'
+require 'keywright/user_info_result'
+require 'keywright/user_info_request'
+require 'keywright'
+
+module Keywright 
+  class << self
+
+    #
+    # The connection method allows the caller to setup the Farday connection used
+    # by Keywright in interacting with the authorization server.
+    #
+    def connection
+      @connection ||= Faraday.new do | connection |
+        connection.request  :url_encoded
+        connection.adapter  Faraday.default_adapter
+      end
+      yield( @connection ) if block_given?
+      @connection
+    end
+
+    # the default singleton keywright configuration may be assigned; it will used when a when 
+    # neither a required parameter or configuration are otherwise provided 
+    attr_writer :configuration
+
+    #
+    # The configuration method returns the default configuration and, if the caller supplies 
+    # a block, allows that caller to customize this configuration.
+    #
+    # The configuration includes the client credentials, the urls of the authorization,
+    # token and userinfo endpoints, the grant types, scopes, and authentication methods
+    # the authorization server supports for the token endpoint.
+    #
+    # This method may be called repeatedly to update the global configuration.
+    #
+    def configuration( &block )
+      @configuration = Configuration.build!( @configuration&.to_h, &block ) if block_given?
+      @configuration
+    end
+
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: keywright
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kristoph Cichocki-Romanov
+bindir: bin
+cert_chain: []
+date: 2025-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: dynamicschema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta04
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta04
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+description: 'The Keywright gem implements a lightweigh, flexible client for use with '
+email:
+- rubygems.org@kristoph.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/keywright.rb
+- lib/keywright/authorization.rb
+- lib/keywright/configuration.rb
+- lib/keywright/error_result.rb
+- lib/keywright/refresh_token_request.rb
+- lib/keywright/request.rb
+- lib/keywright/response_methods.rb
+- lib/keywright/result.rb
+- lib/keywright/token_request.rb
+- lib/keywright/token_result.rb
+- lib/keywright/uri_helpers.rb
+- lib/keywright/user_info_request.rb
+- lib/keywright/user_info_result.rb
+- lib/keywright/version.rb
+homepage: https://github.com/EndlessInternational/keywright
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A flexible and lightweignt OAuth 2 Authorization / OIDC client.
+test_files: []