grape_simple_auth 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 514832426298a7161edf6a2ee9eecc2744da6c345f5f5abb0a0c2f2bc0f7849d
-  data.tar.gz: 925214598e994294a61ef684a08b9b385d8e6d1ae437128b658f89621a87de5d
+  metadata.gz: f284706ebd22652e4d0fd2afe39321cb558bf8cd3c13e040b245f30837b93ac2
+  data.tar.gz: 563e0dd5b540a4e8aa86615a1ed9ab3ad92bd1c9312396c7e90c38dc0386a28b
 SHA512:
-  metadata.gz: 3300fdfa4bfbfdfd7f82449ca3ebb7584392d707bb4752b885c20f337afdc7860a159dfabaf11b23afd0cfe5a67f62cece011cf91455fa91df49ce74745ca38c
-  data.tar.gz: 7bb618d60232690f1923744dccb5bdaf4603ca8c5038f7fe2f6135906bb9410f93e9ee0e361d596d291f763e42f2c07821b60e8e27509e8d0ffdaaf362693dd4
+  metadata.gz: 6c124c991f8105fd19ef3ff8642322fe4abcddcb819c938973cd9414e656d5af20ce8c67da639ea8f649a198daec880e94f9a69870957e39162296220829026a
+  data.tar.gz: 23392e6693e89484c3d87d60d64add602e3cd3ecfbde0980d1df5340e9c35d9cdf791eb422c26f55e40a10a2f267dd6e54632740355ced1870787c3c426079d2

data/Gemfile.lock

@@ -1,52 +1,57 @@
 PATH
   remote: .
   specs:
-    grape_simple_auth (0.1.2)
-      grape (~> 1.1.0)
-      httparty (~> 0.16.3)
+    grape_simple_auth (0.5.0)
+      grape (~> 1.6)
+      httparty (~> 0.20)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.4)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.3)
-    equalizer (0.0.11)
-    grape (1.1.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
+    grape (1.6.2)
       activesupport
       builder
+      dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-      virtus (>= 1.0.0)
-    httparty (0.16.3)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.3.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
-    mime-types (3.2.2)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
-    minitest (5.11.3)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.3)
     multi_xml (0.6.0)
-    mustermann (1.0.3)
-    mustermann-grape (1.0.0)
-      mustermann (~> 1.0.0)
-    rack (2.0.6)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.2)
+      mustermann (>= 1.0.0)
+    rack (3.0.1)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rake (10.5.0)
@@ -63,23 +68,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.3)
   grape_simple_auth!
   rake (~> 10.0)
-  rspec (~> 3.0)
+  rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.4
+   2.3.26

data/README.md

@@ -62,14 +62,20 @@ end
 rescue_from GrapeSimpleAuth::Errors::InvalidScope do |e|
   error!(e, 401)
 end
+rescue_from GrapeSimpleAuth::Errors::InvalidScopeMatcher do |e|
+  error!(e, 401)
+end
 ```
 
 ### Protecting your endpoint
 
 In your endpoint you need to define which protected endpoint by adding this DSL :
 
-1.  `oauth2`
-2.  `oauth2 "email"`
+1.  `oauth2` => Any scopes as long as the token is valid
+2.  `oauth2 "email"` => Scope can be "email"
+3.  `oauth2 "email", match: "all"` => Scope must be "email"
+4.  `oauth2 "email", "phone"` Scopes can match "email" or "phone"
+5.  `oauth2 "email", "phone", match: "all"` Scopes must match "email" and "phone"
 
 Example :
 

data/grape_simple_auth.gemspec

@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.3"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_dependency "httparty", "~> 0.16.3"
-  spec.add_dependency "grape", "~> 1.1.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_dependency "httparty", "~> 0.20"
+  spec.add_dependency "grape", "~> 1.6"
 end

data/lib/grape_simple_auth/auth_methods/auth_methods.rb

@@ -10,6 +10,14 @@ module GrapeSimpleAuth
       @protected_endpoint || false
     end
 
+    def optional_endpoint=(opt)
+      @optional_endpoint = opt
+    end
+
+    def optional_endpoint?
+      @optional_endpoint || false
+    end
+
     def the_access_token
       @_the_access_token
     end
@@ -25,7 +33,7 @@ module GrapeSimpleAuth
     def current_user
       @_current_user
     end
-    
+
     def credentials=(data)
       @credentials = JSON.parse(data.to_json, object_class: DataStruct)
     end

data/lib/grape_simple_auth/auth_strategies/swagger.rb

@@ -2,6 +2,10 @@ module GrapeSimpleAuth
   module AuthStrategies
     class Swagger < GrapeSimpleAuth::BaseStrategy
 
+      def optional_endpoint?
+        has_authorizations? && !!optional_oauth2
+      end
+
       def endpoint_protected?
         has_authorizations? && !!authorization_type_oauth2
       end
@@ -11,7 +15,15 @@ module GrapeSimpleAuth
       end
 
       def auth_scopes
-        authorization_type_oauth2.map { |hash| hash[:scope].to_sym }
+        if optional_endpoint?
+          optional_oauth2.map { |hash| hash[:scope].to_sym }
+        else
+          authorization_type_oauth2.map { |hash| hash[:scope].to_sym }
+        end
+      end
+
+      def auth_scope_match
+        authorization_type_oauth2_scope_match
       end
 
       private
@@ -28,6 +40,14 @@ module GrapeSimpleAuth
         endpoint_authorizations[:oauth2]
       end
 
+      def authorization_type_oauth2_scope_match
+        endpoint_authorizations[:scope_match]
+      end
+
+      def optional_oauth2
+        endpoint_authorizations[:optional_oauth2]
+      end
+
     end
   end
 end

data/lib/grape_simple_auth/errors/invalid_scope_matcher.rb

@@ -0,0 +1,9 @@
+module GrapeSimpleAuth
+  module Errors
+    class InvalidScopeMatcher < StandardError
+      def initialize msg = "match must be one of all or any"
+        super
+      end
+    end
+  end
+end

data/lib/grape_simple_auth/extension.rb

@@ -1,7 +1,7 @@
 module GrapeSimpleAuth
   module Extension
     
-    def oauth2(*scopes)
+    def oauth2(*scopes, match: 'any')
       description = if respond_to?(:route_setting) # >= grape-0.10.0
         route_setting(:description) || route_setting(:description, {})
       else
@@ -9,9 +9,20 @@ module GrapeSimpleAuth
       end
 
       description[:auth] = { scopes: scopes }
-      description[:authorizations] = { oauth2: scopes.map { |x| { scope: x } } }
+      description[:authorizations] = { oauth2: scopes.map { |x| { scope: x } }, scope_match: match }
     end
 
-    Grape::API.extend self
+    def optional_oauth2(*scopes)
+      description = if respond_to?(:route_setting) # >= grape-0.10.0
+        route_setting(:description) || route_setting(:description, {})
+      else
+        @last_description ||= {}
+      end
+
+      description[:authorizations] = { optional_oauth2: scopes.map { |x| { scope: x } } }
+    end
+
+    grape_api = defined?(Grape::API::Instance) ? Grape::API::Instance : Grape::API
+    grape_api.extend self
   end
 end

data/lib/grape_simple_auth/oauth2.rb

@@ -39,6 +39,10 @@ module GrapeSimpleAuth
       auth_strategy.endpoint_protected?
     end
 
+    def optional_endpoint?
+      auth_strategy.optional_endpoint?
+    end
+
     def auth_scopes
       return *nil unless auth_strategy.has_auth_scopes?
       auth_strategy.auth_scopes
@@ -47,9 +51,25 @@ module GrapeSimpleAuth
     def authorize!(*scopes)
       response = HTTParty.get(GrapeSimpleAuth.verify_url, {query: {access_token: token}})
       if response.code == 200
-        scopes = response.parsed_response["data"]["credential"]["scopes"]
-        unless auth_strategy.auth_scopes & scopes == auth_strategy.auth_scopes
-          raise GrapeSimpleAuth::Errors::InvalidScope
+        begin
+          scopes = response.parsed_response["data"]["credential"]["scopes"]
+        rescue NoMethodError
+          raise GrapeSimpleAuth::Errors::InvalidToken
+        end
+        if auth_strategy.auth_scope_match == 'all'
+          unless auth_strategy.auth_scopes.sort && scopes.map(&:to_sym).sort == auth_strategy.auth_scopes.sort
+            raise GrapeSimpleAuth::Errors::InvalidScope
+          end
+        elsif auth_strategy.auth_scope_match == 'any'
+          if auth_strategy.auth_scopes.any?
+            match_any = false
+            scopes.map(&:to_sym).each do |scope|
+              match_any = true if scope.in?(auth_strategy.auth_scopes)
+            end
+            raise GrapeSimpleAuth::Errors::InvalidScope unless match_any
+          end
+        elsif auth_strategy.auth_scope_match.nil?
+          raise GrapeSimpleAuth::Errors::InvalidScopeMatcher
         end
         return response
       end
@@ -66,13 +86,20 @@ module GrapeSimpleAuth
       context.extend(GrapeSimpleAuth::AuthMethods)
 
       context.protected_endpoint = endpoint_protected?
-      return unless context.protected_endpoint?
+      context.optional_endpoint = optional_endpoint?
 
+      return unless context.protected_endpoint? || context.optional_endpoint?
+      
       self.the_request = env
-      resp = authorize!(*auth_scopes)
-      context.the_access_token = token
-      context.current_user = resp.parsed_response["data"]["info"] rescue nil
-      context.credentials = resp.parsed_response["data"]["credential"] rescue nil
+      
+      if token.present? && (context.protected_endpoint? || context.optional_endpoint?)
+        resp = authorize!(*auth_scopes)
+        context.the_access_token = token
+        context.current_user = resp.parsed_response["data"]["info"] rescue nil
+        context.credentials = resp.parsed_response["data"]["credential"] rescue nil
+      elsif token.nil? && context.protected_endpoint?
+        raise GrapeSimpleAuth::Errors::InvalidToken
+      end
     end
 
 

data/lib/grape_simple_auth/version.rb

@@ -1,3 +1,3 @@
 module GrapeSimpleAuth
-  VERSION = "0.2.1"
+  VERSION = "0.5.0"
 end

data/lib/grape_simple_auth.rb

@@ -15,6 +15,7 @@ require 'grape_simple_auth/auth_methods/auth_methods'
 
 require 'grape_simple_auth/errors/invalid_token'
 require 'grape_simple_auth/errors/invalid_scope'
+require 'grape_simple_auth/errors/invalid_scope_matcher'
 
 module GrapeSimpleAuth
   extend GrapeSimpleAuth::Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape_simple_auth
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Yunan Helmy
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-31 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.6'
 description: Grape Simple Auth is a Grape middleware to connect your API resources
   with your API authenticator.
 email:
@@ -108,6 +108,7 @@ files:
 - lib/grape_simple_auth/base_strategy.rb
 - lib/grape_simple_auth/configuration.rb
 - lib/grape_simple_auth/errors/invalid_scope.rb
+- lib/grape_simple_auth/errors/invalid_scope_matcher.rb
 - lib/grape_simple_auth/errors/invalid_token.rb
 - lib/grape_simple_auth/extension.rb
 - lib/grape_simple_auth/helpers.rb
@@ -118,7 +119,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Grape Simple Auth is a Grape middleware to connect your API resources with
   your API authenticator.