grape_oauth2 0.1.1 → 0.2.0

data/lib/grape_oauth2/responses/authorization.rb

@@ -1,10 +1,11 @@
-module Grape
-  module OAuth2
-    # Grape::OAuth2 responses namespace.
-    module Responses
-      # Authorization response.
-      class Authorization < Base
-      end
-    end
-  end
-end
+module Grape
+  module OAuth2
+    # Grape::OAuth2 responses namespace.
+    module Responses
+      # Authorization response.
+      class Authorization < Base
+        # [IMPORTANT]: need to be implemented!
+      end
+    end
+  end
+end

data/lib/grape_oauth2/responses/base.rb

@@ -1,56 +1,56 @@
-module Grape
-  module OAuth2
-    # Grape::OAuth2 responses namespace.
-    module Responses
-      # Base class for Grape::OAuth2 endpoints responses.
-      # Processes raw Rack Responses and contains helper methods.
-      class Base
-        # Raw Rack::Response to process
-        #
-        # @return [Array] Rack response
-        #
-        # @example
-        #   response = Grape::OAuth2::Responses::Base.new([200, {}, Rack::BodyProxy.new('Test')])
-        #   response.rack_response
-        #
-        #   #=> [200, {}, Rack::BodyProxy.new('Test')]
-        #
-        attr_reader :rack_response
-
-        # OAuth2 response class.
-        #
-        # @param rack_response [Array]
-        #   raw Rack::Response object
-        #
-        def initialize(rack_response)
-          # Rack Body:
-          #   [Status Code, Headers, Body]
-          @rack_response = rack_response
-        end
-
-        # Response status
-        def status
-          @rack_response[0]
-        end
-
-        # Response headers
-        def headers
-          @rack_response[1]
-        end
-
-        # Raw Rack body
-        def raw_body
-          @rack_response[2].body
-        end
-
-        # JSON-parsed body
-        def body
-          response_body = raw_body.first
-          return {} if response_body.nil? || response_body.empty?
-
-          JSON.parse(response_body)
-        end
-      end
-    end
-  end
-end
+module Grape
+  module OAuth2
+    # Grape::OAuth2 responses namespace.
+    module Responses
+      # Base class for Grape::OAuth2 endpoints responses.
+      # Processes raw Rack Responses and contains helper methods.
+      class Base
+        # Raw Rack::Response to process
+        #
+        # @return [Array] Rack response
+        #
+        # @example
+        #   response = Grape::OAuth2::Responses::Base.new([200, {}, Rack::BodyProxy.new('Test')])
+        #   response.rack_response
+        #
+        #   #=> [200, {}, Rack::BodyProxy.new('Test')]
+        #
+        attr_reader :rack_response
+
+        # OAuth2 response class.
+        #
+        # @param rack_response [Array]
+        #   raw Rack::Response object
+        #
+        def initialize(rack_response)
+          # Rack Body:
+          #   [Status Code, Headers, Body]
+          @rack_response = rack_response
+        end
+
+        # Response status
+        def status
+          @rack_response[0]
+        end
+
+        # Response headers
+        def headers
+          @rack_response[1]
+        end
+
+        # Raw Rack body
+        def raw_body
+          @rack_response[2].body
+        end
+
+        # JSON-parsed body
+        def body
+          response_body = raw_body.first
+          return {} if response_body.nil? || response_body.empty?
+
+          JSON.parse(response_body)
+        end
+      end
+    end
+  end
+end

data/lib/grape_oauth2/responses/token.rb

@@ -1,10 +1,10 @@
-module Grape
-  module OAuth2
-    # Grape::OAuth2 responses namespace.
-    module Responses
-      # Token response.
-      class Token < Base
-      end
-    end
-  end
-end
+module Grape
+  module OAuth2
+    # Grape::OAuth2 responses namespace.
+    module Responses
+      # Token response.
+      class Token < Base
+      end
+    end
+  end
+end

data/lib/grape_oauth2/scopes.rb

@@ -1,74 +1,74 @@
-module Grape
-  module OAuth2
-    # OAuth2 helper for scopes validation
-    # (between requested and presented in Access Token).
-    class Scopes
-      # Array of requested scopes
-      #
-      # @return [Array<String>] scopes
-      #
-      attr_reader :scopes
-
-      # Helper class initializer.
-      #
-      # @param scopes [Array, String, #to_a]
-      #   array, string of any object that responds to `to_a`
-      #
-      def initialize(scopes)
-        @scopes = to_array(scopes || [])
-      end
-
-      # Checks if requested scopes (passed and processed on initialization)
-      # are presented in the Access Token.
-      #
-      # @param access_token [Object]
-      #   instance of the Access Token class that responds to `scopes`
-      #
-      # @return [Boolean]
-      #   true if requested scopes are empty or present in access token scopes
-      #   and false in other cases
-      #
-      def valid_for?(access_token)
-        scopes.empty? || present_in?(access_token.scopes)
-      end
-
-      private
-
-      # Checks if scopes present in Access Token scopes.
-      #
-      # @param token_scopes [Array, String, #to_a]
-      #   array, string of any object that responds to `to_a`
-      #
-      # @return [Boolean]
-      #   true if requested scopes present in Access Token and false in other cases
-      #
-      def present_in?(token_scopes)
-        required_scopes = Set.new(to_array(scopes))
-        authorized_scopes = Set.new(to_array(token_scopes))
-
-        authorized_scopes >= required_scopes
-      end
-
-      # Converts scopes set to the array.
-      #
-      # @param scopes [Array, String, #to_a]
-      #   string, array or object that responds to `to_a`
-      # @return [Array<String>]
-      #   array of scopes
-      #
-      def to_array(scopes)
-        return [] if scopes.nil?
-
-        collection = if scopes.is_a?(Array) || scopes.respond_to?(:to_a)
-                       scopes.to_a
-                     elsif scopes.is_a?(String)
-                       scopes.split
-                     else
-                       raise ArgumentError, 'scopes class is not supported!'
-                     end
-
-        collection.map(&:to_s)
-      end
-    end
-  end
-end
+module Grape
+  module OAuth2
+    # OAuth2 helper for scopes validation
+    # (between requested and presented in Access Token).
+    class Scopes
+      # Array of requested scopes
+      #
+      # @return [Array<String>] scopes
+      #
+      attr_reader :scopes
+
+      # Helper class initializer.
+      #
+      # @param scopes [Array, String, #to_a]
+      #   array, string of any object that responds to `to_a`
+      #
+      def initialize(scopes)
+        @scopes = to_array(scopes || [])
+      end
+
+      # Checks if requested scopes (passed and processed on initialization)
+      # are presented in the Access Token.
+      #
+      # @param access_token [Object]
+      #   instance of the Access Token class that responds to `scopes`
+      #
+      # @return [Boolean]
+      #   true if requested scopes are empty or present in access token scopes
+      #   and false in other cases
+      #
+      def valid_for?(access_token)
+        scopes.empty? || present_in?(access_token.scopes)
+      end
+
+      private
+
+      # Checks if scopes present in Access Token scopes.
+      #
+      # @param token_scopes [Array, String, #to_a]
+      #   array, string of any object that responds to `to_a`
+      #
+      # @return [Boolean]
+      #   true if requested scopes present in Access Token and false in other cases
+      #
+      def present_in?(token_scopes)
+        required_scopes = Set.new(to_array(scopes))
+        authorized_scopes = Set.new(to_array(token_scopes))
+
+        authorized_scopes >= required_scopes
+      end
+
+      # Converts scopes set to the array.
+      #
+      # @param scopes [Array, String, #to_a]
+      #   string, array or object that responds to `to_a`
+      # @return [Array<String>]
+      #   array of scopes
+      #
+      def to_array(scopes)
+        return [] if scopes.nil?
+
+        collection = if scopes.is_a?(Array) || scopes.respond_to?(:to_a)
+                       scopes.to_a
+                     elsif scopes.is_a?(String)
+                       scopes.split
+                     else
+                       raise ArgumentError, 'scopes class is not supported!'
+                     end
+
+        collection.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/grape_oauth2/strategies/authorization_code.rb

@@ -1,38 +1,38 @@
-module Grape
-  module OAuth2
-    module Strategies
-      # Auth Code strategy class.
-      # Processes request and responds with Token or Code
-      # (depend on requested response type).
-      class AuthorizationCode < Base
-        class << self
-          # Processes Authorization request.
-          def process(request, response)
-            client = authenticate_client(request)
-            request.bad_request! if client.nil?
-
-            response.redirect_uri = request.verify_redirect_uri!(client.redirect_uri)
-
-            # TODO: verify scopes if they valid
-            # scopes = request.scope
-            # request.invalid_scope! "Unknown scope: #{scope}"
-
-            case request.response_type
-            when :code
-              # resource owner can't be nil!
-              authorization_code = config.access_grant_class.create_for(client, nil, response.redirect_uri)
-              response.code = authorization_code.token
-            when :token
-              # resource owner can't be nil!
-              access_token = config.access_token_class.create_for(client, nil, scopes_from(request))
-              response.access_token = expose_to_bearer_token(access_token)
-            end
-
-            response.approve!
-            response
-          end
-        end
-      end
-    end
-  end
-end
+module Grape
+  module OAuth2
+    module Strategies
+      # Auth Code strategy class.
+      # Processes request and responds with Token or Code
+      # (depend on requested response type).
+      class AuthorizationCode < Base
+        class << self
+          # Processes Authorization request.
+          def process(request, response)
+            client = authenticate_client(request)
+            request.bad_request! if client.nil?
+
+            response.redirect_uri = request.verify_redirect_uri!(client.redirect_uri)
+
+            # TODO: verify scopes if they valid
+            # scopes = request.scope
+            # request.invalid_scope! "Unknown scope: #{scope}"
+
+            case request.response_type
+            when :code
+              # resource owner can't be nil!
+              authorization_code = config.access_grant_class.create_for(client, nil, response.redirect_uri)
+              response.code = authorization_code.token
+            when :token
+              # resource owner can't be nil!
+              access_token = config.access_token_class.create_for(client, nil, scopes_from(request))
+              response.access_token = expose_to_bearer_token(access_token)
+            end
+
+            response.approve!
+            response
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape_oauth2/strategies/base.rb

@@ -1,47 +1,47 @@
-module Grape
-  module OAuth2
-    # Grape::OAuth2 strategies namespace
-    module Strategies
-      # Base Grape::OAuth2 Strategies class .
-      # Contains common functionality for all the descendants.
-      class Base
-        class << self
-          # Authenticates Client from the request.
-          def authenticate_client(request)
-            config.client_class.authenticate(request.client_id, request.try(:client_secret))
-          end
-
-          # Authenticates Resource Owner from the request.
-          def authenticate_resource_owner(client, request)
-            config.resource_owner_class.oauth_authenticate(client, request.username, request.password)
-          end
-
-          # Short getter for Grape::OAuth2 configuration
-          def config
-            Grape::OAuth2.config
-          end
-
-          # Converts scopes from the request string. Separate them by the whitespace.
-          # @return [String] scopes string
-          #
-          def scopes_from(request)
-            return nil if request.scope.nil?
-
-            Array(request.scope).join(' ')
-          end
-
-          # Exposes token object to Bearer token.
-          #
-          # @param token [#to_bearer_token]
-          #   any object that responds to `to_bearer_token`
-          # @return [Rack::OAuth2::AccessToken::Bearer]
-          #   bearer token instance
-          #
-          def expose_to_bearer_token(token)
-            Rack::OAuth2::AccessToken::Bearer.new(token.to_bearer_token)
-          end
-        end
-      end
-    end
-  end
-end
+module Grape
+  module OAuth2
+    # Grape::OAuth2 strategies namespace
+    module Strategies
+      # Base Grape::OAuth2 Strategies class .
+      # Contains common functionality for all the descendants.
+      class Base
+        class << self
+          # Authenticates Client from the request.
+          def authenticate_client(request)
+            config.client_class.authenticate(request.client_id, request.try(:client_secret))
+          end
+
+          # Authenticates Resource Owner from the request.
+          def authenticate_resource_owner(client, request)
+            config.resource_owner_class.oauth_authenticate(client, request.username, request.password)
+          end
+
+          # Short getter for Grape::OAuth2 configuration
+          def config
+            Grape::OAuth2.config
+          end
+
+          # Converts scopes from the request string. Separate them by the whitespace.
+          # @return [String] scopes string
+          #
+          def scopes_from(request)
+            return nil if request.scope.nil?
+
+            Array(request.scope).join(' ')
+          end
+
+          # Exposes token object to Bearer token.
+          #
+          # @param token [#to_bearer_token]
+          #   any object that responds to `to_bearer_token`
+          # @return [Rack::OAuth2::AccessToken::Bearer]
+          #   bearer token instance
+          #
+          def expose_to_bearer_token(token)
+            Rack::OAuth2::AccessToken::Bearer.new(token.to_bearer_token)
+          end
+        end
+      end
+    end
+  end
+end