activerecord_simple_oauth2 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1b9d315283a5d0e8765086620eb7e3bc934e43ce1030a6b530d66477fca4785
+  data.tar.gz: 2e77cc93bbed2bacd7d001365499b1e608d8da1b1994f5bd3d69b9f9f5db05d6
+SHA512:
+  metadata.gz: 7ef4322ff5b2e509c4e0d89a5ef05236c1e7d15b195c441e1a2050a339e0c2a743d94fbe6d54ad525adb4f01858f10ec69dd91735079691f76a89efbd8300219
+  data.tar.gz: fee3651f816d3c235df49de59ba6a7b3975f1f867ffe9a4602c5a2d0535a0d543e21b85020bb5cc728390bc8159b39261fbe7ee5607edba5a536e31348db60e7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Simple OAuth2
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/lib/activerecord_simple_oauth2.rb

@@ -0,0 +1,6 @@
+require 'simple_oauth2'
+
+require 'activerecord_simple_oauth2/mixins/access_token'
+require 'activerecord_simple_oauth2/mixins/access_grant'
+require 'activerecord_simple_oauth2/mixins/resource_owner'
+require 'activerecord_simple_oauth2/mixins/client'

data/lib/activerecord_simple_oauth2/mixins/access_grant.rb

@@ -0,0 +1,81 @@
+module ActiveRecord
+  module Simple
+    module OAuth2
+      # AccessGrant role mixin for ActiveRecord.
+      # Includes all the required API, associations, validations and callbacks.
+      module AccessGrant
+        extend ActiveSupport::Concern
+
+        included do
+          # Returns associated Client instance.
+          #
+          # @return [Object] Client instance.
+          #
+          belongs_to :client, class_name: ::Simple::OAuth2.config.client_class_name, foreign_key: :client_id
+
+          # Returns associated ResourceOwner instance.
+          #
+          # @return [Object] ResourceOwner instance.
+          #
+          belongs_to :resource_owner, class_name: ::Simple::OAuth2.config.resource_owner_class_name,
+                                      foreign_key: :resource_owner_id
+
+          # Required fields!
+          validates :client_id, :redirect_uri, :token, presence: true
+          validates :token, uniqueness: true
+
+          # Generate token
+          before_validation :generate_token, on: :create
+          # Setup lifetime for `#code` value.
+          before_validation :setup_expiration, on: :create
+
+          # Searches for AccessGrant record with the specific `#token` value.
+          #
+          # @param token [#to_s] token value (any object that responds to `#to_s`).
+          #
+          # @return [Object, nil] AccessGrant object or nil if there is no record with such `#token`.
+          #
+          def self.by_token(token)
+            where(token: token.to_s).first
+          end
+
+          # Create a new AccessGrant object.
+          #
+          # @param client [Object] Client instance.
+          # @param resource_owner [Object] ResourceOwner instance.
+          # @param redirect_uri [String] Redirect URI callback.
+          # @param scopes [String] set of scopes.
+          #
+          # @return [Object] AccessGrant object.
+          #
+          def self.create_for(client, resource_owner, redirect_uri, scopes = nil)
+            create(
+              client_id: client.id,
+              resource_owner_id: resource_owner.id,
+              redirect_uri: redirect_uri,
+              scopes: scopes
+            )
+          end
+
+          private
+
+          # Generate token
+          #
+          # @return token [String] string object.
+          #
+          def generate_token
+            self.token = ::Simple::OAuth2.config.token_generator.generate
+          end
+
+          # Set lifetime for `#code` value during creating a new record.
+          #
+          # @return clock [Time] time object.
+          #
+          def setup_expiration
+            self.expires_at = Time.now.utc + ::Simple::OAuth2.config.authorization_code_lifetime if expires_at.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord_simple_oauth2/mixins/access_token.rb

@@ -0,0 +1,132 @@
+module ActiveRecord
+  module Simple
+    module OAuth2
+      # AccessToken role mixin for ActiveRecord.
+      # Includes all the required API, associations, validations and callbacks.
+      module AccessToken
+        extend ActiveSupport::Concern
+
+        included do # rubocop:disable Metrics/BlockLength
+          # Returns associated Client instance.
+          #
+          # @return [Object] Client instance.
+          #
+          belongs_to :client, class_name: ::Simple::OAuth2.config.client_class_name, foreign_key: :client_id
+
+          # Returns associated ResourceOwner instance.
+          #
+          # @return [Object] ResourceOwner instance.
+          #
+          belongs_to :resource_owner, class_name: ::Simple::OAuth2.config.resource_owner_class_name,
+                                      foreign_key: :resource_owner_id
+
+          # Required field!
+          validates :token, presence: true, uniqueness: true
+
+          # Generate tokens
+          before_validation :generate_tokens, on: :create
+          # Setup lifetime for `#token` value.
+          before_validation :setup_expiration, on: :create
+
+          class << self
+            # Searches for AccessToken record with the specific `#token` value.
+            #
+            # @param token [#to_s] token value (any object that responds to `#to_s`).
+            #
+            # @return [Object, nil] AccessToken object or nil if there is no record with such `#token`.
+            #
+            def by_token(token)
+              where(token: token.to_s).first
+            end
+
+            # Returns an instance of the AccessToken with specific `#refresh_token` value.
+            #
+            # @param refresh_token [#to_s] refresh token value (any object that responds to `#to_s`).
+            #
+            # @return [Object, nil] AccessToken object or nil if there is no record with such `#refresh_token`.
+            #
+            def by_refresh_token(refresh_token)
+              where(refresh_token: refresh_token.to_s).first
+            end
+
+            # Create a new AccessToken object.
+            #
+            # @param client [Object] Client instance.
+            # @param resource_owner [Object] ResourceOwner instance.
+            # @param scopes [String] set of scopes.
+            #
+            # @return [Object] AccessToken object.
+            #
+            def create_for(client, resource_owner, scopes = nil)
+              create(
+                client_id: client.id,
+                resource_owner_id: resource_owner.id,
+                scopes: scopes
+              )
+            end
+          end
+
+          # Indicates whether the object is expired (`#expires_at` present and expiration time has come).
+          #
+          # @return [Boolean] true if object expired and false in other case.
+          #
+          def expired?
+            expires_at && Time.now.utc > expires_at
+          end
+
+          # Indicates whether the object has been revoked.
+          #
+          # @return [Boolean] true if revoked, false in other case.
+          #
+          def revoked?
+            revoked_at && revoked_at <= Time.now.utc
+          end
+
+          # Revokes the object (updates `:revoked_at` attribute setting its value to the specific time).
+          #
+          # @param revoked_at [Time] time object.
+          #
+          # @return [Object] AccessToken object or raise ActiveRecord::Error::DocumentInvalid.
+          #
+          def revoke!(revoked_at = Time.now)
+            update_column(:revoked_at, revoked_at.utc)
+          end
+
+          # Exposes token object to Bearer token.
+          #
+          # @return [Hash] bearer token instance.
+          #
+          def to_bearer_token
+            {
+              access_token: token,
+              expires_in: expires_at && ::Simple::OAuth2.config.access_token_lifetime.to_i,
+              refresh_token: refresh_token,
+              scope: scopes
+            }
+          end
+
+          private
+
+          # Generate tokens
+          #
+          # @return token [String] string object.
+          # @return refresh_token [String] string object.
+          #
+          def generate_tokens
+            self.token = ::Simple::OAuth2.config.token_generator.generate if token.blank?
+            self.refresh_token = ::Simple::OAuth2::UniqToken.generate if ::Simple::OAuth2.config.issue_refresh_token
+          end
+
+          # Set lifetime for token value during creating a new record.
+          #
+          # @return clock [Time] time object.
+          #
+          def setup_expiration
+            expires_in = ::Simple::OAuth2.config.access_token_lifetime.to_i
+            self.expires_at = Time.now.utc + expires_in if expires_at.nil? && !expires_in.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord_simple_oauth2/mixins/client.rb

@@ -0,0 +1,55 @@
+module ActiveRecord
+  module Simple
+    module OAuth2
+      # Client role mixin for ActiveRecord.
+      # Includes all the required API, associations, validations and callbacks.
+      module Client
+        extend ActiveSupport::Concern
+
+        included do
+          # Returns associated AccessToken array.
+          #
+          # @return [Array<Object>] AccessToken array.
+          #
+          has_many :access_tokens, class_name: ::Simple::OAuth2.config.access_token_class_name,
+                                   foreign_key: :client_id,
+                                   dependent: :destroy
+
+          # Returns associated AccessGrant array.
+          #
+          # @return [Array<Object>] AccessGrant array.
+          #
+          has_many :access_grants, class_name: ::Simple::OAuth2.config.access_grant_class_name, foreign_key: :client_id
+
+          # Required fields!
+          validates :key, :secret, presence: true, uniqueness: true
+
+          # Generate tokens
+          before_validation :generate_tokens, on: :create
+
+          # Searches for Client record with the specific `#key` value.
+          #
+          # @param key [#to_s] key value (any object that responds to `#to_s`).
+          #
+          # @return [Object, nil] Client object or nil if there is no record with such `#key`.
+          #
+          def self.by_key(key)
+            where(key: key.to_s).first
+          end
+
+          private
+
+          # Generate tokens
+          #
+          # @return token [String] string object.
+          # @return refresh_token [String] string object.
+          #
+          def generate_tokens
+            self.key = ::Simple::OAuth2::UniqToken.generate if key.blank?
+            self.secret = ::Simple::OAuth2::UniqToken.generate if secret.blank?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord_simple_oauth2/mixins/resource_owner.rb

@@ -0,0 +1,26 @@
+module ActiveRecord
+  module Simple
+    module OAuth2
+      # ResourceOwner role mixin for ActiveRecord.
+      # Includes all the required API, associations, validations and callbacks
+      module ResourceOwner
+        extend ActiveSupport::Concern
+
+        included do
+          # Searches for ResourceOwner record with the specific params.
+          #
+          # @param _client [Object] Client instance.
+          # @param username [String, #to_s] username value (any object that responds to `#to_s`).
+          # @param password [String] password value.
+          #
+          # @return [Object, nil] ResourceOwner object or nil if there is no record with such params.
+          #
+          def self.oauth_authenticate(_client, username, password)
+            user = where(username: username.to_s).first
+            user if user && user.encrypted_password == password
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord_simple_oauth2/version.rb

@@ -0,0 +1,29 @@
+module ActiveRecord
+  module Simple
+    # Semantic versioning
+    module OAuth2
+      # ActiveRecordSimpleOAuth2 version
+      #
+      # @return [Gem::Version] version of the gem
+      #
+      def self.gem_version
+        Gem::Version.new VERSION::STRING
+      end
+
+      # ActiveRecordSimpleOAuth2 semantic versioning module.
+      # Contains detailed info about gem version
+      module VERSION
+        # Level changes for implementation level detail changes, such as small bug fixes
+        PATCH = 0
+        # Level changes for any backwards compatible API changes, such as new functionality/features
+        MINOR = 0
+        # Level changes for backwards incompatible API changes,
+        # such as changes that will break existing users code if they update
+        MAJOR = 0
+
+        # Full gem version string
+        STRING = [MAJOR, MINOR, PATCH].join('.')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_simple_oauth2
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Volodimir Partytskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple_oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+description: ActiveRecord mixin for SimpleOAuth2 authorization
+email: volodimir.partytskyi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/activerecord_simple_oauth2.rb
+- lib/activerecord_simple_oauth2/mixins/access_grant.rb
+- lib/activerecord_simple_oauth2/mixins/access_token.rb
+- lib/activerecord_simple_oauth2/mixins/client.rb
+- lib/activerecord_simple_oauth2/mixins/resource_owner.rb
+- lib/activerecord_simple_oauth2/version.rb
+homepage: https://github.com/simple-oauth2/activerecord_simple_oauth2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Mixin for ActiveRecord ORM
+test_files: []