authlete 0.3.6 → 0.3.7

data/lib/authlete/model/hashable.rb

@@ -0,0 +1,65 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2015 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Authlete
+  module Model
+    class Hashable
+      private
+
+      def authlete_model_convert_key(key)
+      end
+
+      def authelte_model_simple_attribute?(key)
+      end
+
+      def authlete_model_update(hash)
+      end
+
+      public
+
+      # Convert this object into a hash.
+      def to_hash
+      end
+
+      # Set attribute values using the given hash.
+      def update(hash = {})
+        authlete_model_update(hash)
+      end
+
+      def [](key)
+        key = authlete_model_convert_key(key)
+
+        if respond_to?(key)
+          send(key)
+        else
+          nil
+        end
+      end
+
+      def []=(key, value)
+        key = authlete_model_convert_key(key)
+        method = "#{key}="
+
+        if respond_to?(method)
+          send(method, value)
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/authentication-callback-request.rb

@@ -0,0 +1,91 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2015 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'json'
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::AuthenticationCallbackRequest class
+      #
+      # This class represents a request to an authentication callback endpoint.
+      class AuthenticationCallbackRequest
+        include Authlete::Utility
+        # The API key of the service.
+        attr_accessor :service_api_key
+
+        # The ID of the client application which has triggered the authentication
+        # callback request.
+        attr_accessor :client_id
+
+        # The login ID that the end-user input to the login ID field.
+        attr_accessor :id
+
+        # The password that the end-user input to the password field.
+        attr_accessor :password
+
+        # Names of requested claims (string array).
+        attr_accessor :claims
+
+        # Names of requested claim locales (string array). The values come
+        # from 'claims_locales' request parameter of an authorization request.
+        attr_accessor :claims_locales
+
+        # The SNS which the end-user used for social login.
+        # For example, 'FACEBOOK'.
+        attr_accessor :sns
+
+        # The access token issued at the token endpoint of the SNS.
+        attr_accessor :access_token
+
+        # The refresh token issued along with the access token.
+        attr_accessor :refresh_token
+
+        # The duration of the access token.
+        attr_accessor :expires_in
+
+        # The raw content of the response from the token endpoint of the SNS.
+        # Correct OAuth 2.0 implementations return 'application/json', but Facebook
+        # returns 'application/x-www-form-url-encoded'.
+        attr_accessor :raw_token_response
+
+        # The constructor which takes a hash that represents a JSON request
+        # to an authentication callback endpoint.
+        def initialize(hash = {})
+          @service_api_key    = extract_value(hash, :serviceApiKey)
+          @client_id          = extract_value(hash, :clientId)
+          @id                 = extract_value(hash, :id)
+          @password           = extract_value(hash, :password)
+          @claims             = extract_value(hash, :claims)
+          @claims_locales     = extract_value(hash, :claimsLocales)
+          @sns                = extract_value(hash, :sns)
+          @access_token       = extract_value(hash, :accessToken)
+          @refresh_token      = extract_value(hash, :refreshToken)
+          @expires_in         = extract_integer_value(hash, :expiresIn)
+          @raw_token_response = extract_value(hash, :rawTokenResponse)
+        end
+
+        # Parse a JSON string which represents a request to an authentication
+        # callback endpoint and generate an instance of AuthenticationCallbackRequest.
+        def self.parse(json)
+          AuthenticationCallbackRequest.new(JSON.parse(json))
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/authorization-fail-request.rb

@@ -0,0 +1,107 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2015 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::AuthorizationFailRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/authorization/fail API.
+      class AuthorizationFailRequest < Authlete::Model::Hashable
+        # The ticket issued by Authlete's /api/auth/authorization API. (String)
+        attr_accessor :ticket
+
+        # The reason of the failure. (String)
+        attr_accessor :reason
+
+        # The custom description about the failure. (String)
+        attr_accessor :description
+
+        private
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :ticket, :reason, :description ])
+
+        # The constructor which takes a hash that represents a JSON request to
+        # Authlete's /api/auth/authorization/fail API.
+        def initialize(hash = {})
+          super
+
+          # Set default values to string attributes.
+          STRING_ATTRIBUTES.each do |attr|
+            send("#{attr}=", nil)
+          end
+
+          # Set attribute values using the given hash.
+          authlete_model_update(hash)
+        end
+
+        def authlete_model_convert_key(key)
+          key.to_sym
+        end
+
+        def authlete_model_simple_attribute?(key)
+          STRING_ATTRIBUTES.include?(key)
+        end
+
+        def authlete_model_update(hash)
+          return if hash.nil?
+
+          hash.each do |key, value|
+            key = authlete_model_convert_key(key)
+
+            if authlete_model_simple_attribute?(key)
+              send("#{key}=", value)
+            end
+          end
+
+          self
+        end
+
+        public
+
+        # Construct an instance from the given hash.
+        #
+        # If the given argument is nil or is not a Hash, nil is returned.
+        # Otherwise, AuthorizationFailRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return AuthorizationFailRequest.new(hash)
+        end
+
+        # Convert this object into a hash.
+        def to_hash
+          hash = {}
+
+          instance_variables.each do |var|
+            key = var.to_s.delete("@").to_sym
+            val = instance_variable_get(var)
+
+            if authlete_model_simple_attribute?(key) or val.nil?
+              hash[key] = val
+            end
+          end
+
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/authorization-issue-request.rb

@@ -0,0 +1,136 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2015 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::AuthorizationIssueRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/authorization/issue API.
+      class AuthorizationIssueRequest < Authlete::Model::Hashable
+        # The ticket issued by Authlete's /api/auth/authorization API. (String)
+        attr_accessor :ticket
+
+        # The subject (end-user) managed by the service. (String)
+        attr_accessor :subject
+
+        # The time when the end-user was authenticated. (Integer)
+        attr_accessor :authTime
+        alias_method  :auth_time, :authTime
+        alias_method  :auth_time=, :authTime=
+
+        # The authentication context class reference. (String)
+        attr_accessor :acr
+
+        # Claims in JSON format. (String)
+        attr_accessor :claims
+
+        private
+
+        # Integer attributes.
+        INTEGER_ATTRIBUTES = ::Set.new([ :authTime ])
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :ticket, :subject, :acr, :claims ])
+
+        # Mapping from snake cases to camel cases.
+        SNAKE_TO_CAMEL = {
+          :auth_time => :authTime
+        }
+
+        # The constructor which takes a hash that represents a JSON request to
+        # Authlete's /api/auth/authorization/issue API.
+        def initialize(hash = {})
+          super
+
+          # Set default values to integer attributes.
+          INTEGER_ATTRIBUTES.each do |attr|
+            send("#{attr}=", 0)
+          end
+
+          # Set default values to string attributes.
+          STRING_ATTRIBUTES.each do |attr|
+            send("#{attr}=", nil)
+          end
+
+          # Set attribute values using the given hash.
+          authlete_model_update(hash)
+        end
+
+        def authlete_model_convert_key(key)
+          key = key.to_sym
+
+          # Convert snakecase to camelcase, if necessary.
+          if SNAKE_TO_CAMEL.has_key?(key)
+            key = SNAKE_TO_CAMEL[key]
+          end
+
+          key
+        end
+
+        def authlete_model_simple_attribute?(key)
+          INTEGER_ATTRIBUTES.include?(key) or
+          STRING_ATTRIBUTES.include?(key)
+        end
+
+        def authlete_model_update(hash)
+          return if hash.nil?
+
+          hash.each do |key, value|
+            key = authlete_model_convert_key(key)
+
+            if authlete_model_simple_attribute?(key)
+              send("#{key}=", value)
+            end
+          end
+
+          self
+        end
+
+        public
+
+        # Construct an instance from the given hash.
+        #
+        # If the given argument is nil or is not a Hash, nil is returned.
+        # Otherwise, AuthorizationIssueRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return AuthorizationIssueRequest.new(hash)
+        end
+
+        # Convert this object into a hash.
+        def to_hash
+          hash = {}
+
+          instance_variables.each do |var|
+            key = var.to_s.delete("@").to_sym
+            val = instance_variable_get(var)
+
+            if authlete_model_simple_attribute?(key) or val.nil?
+              hash[key] = val
+            end
+          end
+
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/authorization-request.rb

@@ -0,0 +1,104 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2015 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'set'
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::AuthorizationRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/authorization API.
+      class AuthorizationRequest < Authlete::Model::Hashable
+        # The OAuth 2.0 authorization request parameters. (String)
+        attr_accessor :parameters
+
+        private
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :parameters ])
+
+        # The constructor which takes a hash that represents a JSON request to
+        # Authlete's /api/auth/authorization API.
+        def initialize(hash = {})
+          super
+
+          # Set default values to string attributes.
+          STRING_ATTRIBUTES.each do |attr|
+            send("#{attr}=", nil)
+          end
+
+          # Set attribute values using the given hash.
+          authlete_model_update(hash)
+        end
+
+        def authlete_model_convert_key(key)
+          key.to_sym
+        end
+
+        def authlete_model_simple_attribute?(key)
+          STRING_ATTRIBUTES.include?(key)
+        end
+
+        def authlete_model_update(hash)
+          return if hash.nil?
+
+          hash.each do |key, value|
+            key = authlete_model_convert_key(key)
+
+            if authlete_model_simple_attribute?(key)
+              send("#{key}=", value)
+            end
+          end
+
+          self
+        end
+
+        public
+
+        # Construct an instance from the given hash.
+        #
+        # If the given argument is nil or is not a Hash, nil is returned.
+        # Otherwise, AuthorizationRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return AuthorizationRequest.new(hash)
+        end
+
+        # Convert this object into a hash.
+        def to_hash
+          hash = {}
+
+          instance_variables.each do |var|
+            key = var.to_s.delete("@").to_sym
+            val = instance_variable_get(var)
+
+            if authlete_model_simple_attribute?(key) or val.nil?
+              hash[key] = val
+            end
+          end
+
+          hash
+        end
+      end
+    end
+  end
+end