authlete 0.3.6 → 0.3.7

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

@@ -0,0 +1,85 @@
+# :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::DeveloperAuthenticationCallbackRequest class
+      #
+      # This class represents a request to a developer authentication callback endpoint.
+      class DeveloperAuthenticationCallbackRequest
+        include Authlete::Utility
+        # The API key of the service.
+        attr_accessor :service_api_key
+
+        # The login ID that the developer input to the login ID field.
+        # When 'sns' attribute is not nil, this attribute holds the
+        # subject (= unique identifier) of the developer in the SNS.
+        attr_accessor :id
+
+        # The password that the developer input to the password field.
+        # If 'sns' property is nil, it is ensured that this attribute
+        # is not nil. In such a case, authentication should be performed
+        # on the pair of 'id' attribute and this 'password' attribute.
+        # On the other hand, if 'sns' attribute is not nil, this attribute
+        # has no meaning, because authentication has performed by the SNS.
+        attr_accessor :password
+
+        # The SNS which the developer 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 a developer authentication callback endpoint.
+        def initialize(hash = {})
+          @service_api_key    = extract_value(hash, :serviceApiKey)
+          @id                 = extract_value(hash, :id)
+          @password           = extract_value(hash, :password)
+          @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 a developer
+        # authentication callback endpoint and generate an instance of
+        # DeveloperAuthenticationCallbackRequest.
+        def self.parse(json)
+          DeveloperAuthenticationCallbackRequest.new(JSON.parse(json))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# :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::IntrospectionRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/introspection API.
+      class IntrospectionRequest
+        include Authlete::Utility
+        # The constructor which takes a hash that represents a JSON request
+        # to Authlete's /api/auth/introspection API.
+        def initialize(hash = {})
+        end
+
+        # Parse a JSON string which represents a request to
+        # Authlete's /api/auth/introspection API
+        # and generate an instance of IntrospectionRequest.
+        def self.parse(json)
+          IntrospectionRequest.new(parse_json(json))
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/token-fail-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.
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::TokenFailRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/token/fail API.
+      class TokenFailRequest < Authlete::Model::Hashable
+        # The ticket issued by Authlete's /api/auth/token API. (String)
+        attr_accessor :ticket
+
+        # The reason of the failure. (String)
+        attr_accessor :reason
+
+        private
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :ticket, :reason ])
+
+        # The constructor which takes a hash that represents a JSON request to
+        # Authlete's /api/auth/token/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, TokenFailRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return TokenFailRequest.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/token-issue-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.
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::TokenIssueRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/token/issue API.
+      class TokenIssueRequest < 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
+
+        private
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :ticket, :subject ])
+
+        # The constructor which takes a hash that represents a JSON request to
+        # Authlete's /api/auth/token/issue 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, TokenIssueRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return TokenIssueRequest.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/token-request.rb

@@ -0,0 +1,124 @@
+# :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::TokenRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/token API.
+      class TokenRequest < Authlete::Model::Hashable
+        # OAuth 2.0 token request parameters. (String)
+        attr_accessor :parameters
+
+        # Client ID. (String)
+        attr_accessor :clientId
+        alias_method  :client_id,  :clientId
+        alias_method  :client_id=, :clientId=
+
+        # Client Secret. (String)
+        attr_accessor :clientSecret
+        alias_method  :client_secret,  :clientSecret
+        alias_method  :client_secret=, :clientSecret=
+
+        private
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :parameters, :clientId, :clientSecret ])
+
+        # Mapping from snake cases to camel cases.
+        SNAKE_TO_CAMEL = {
+          :client_id     => :clientId,
+          :client_secret => :clientSecret
+        }
+
+        # The constructor which takes a hash that represents a JSON request
+        # to Authlete's /api/auth/token 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 = 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)
+          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, TokenRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return TokenRequest.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