authlete 1.0.24 → 1.1.0

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

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2018 Authlete, Inc.
+# Copyright (C) 2014-2020 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,77 +15,85 @@
 # 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.
+      class AuthenticationCallbackRequest < Authlete::Model::Request::Base
+
+        attr_accessor :serviceApiKey
+        alias_method  :service_api_key,  :serviceApiKey
+        alias_method  :service_api_key=, :serviceApiKey=
+
+        attr_accessor :clientId
+        alias_method  :client_id,  :clientId
+        alias_method  :client_id=, :clientId=
+
         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
+        attr_accessor :claimsLocales
+        alias_method  :claims_locales,  :claimsLocales
+        alias_method  :claims_locales=, :claimsLocales=
 
-        # 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)
+        attr_accessor :accessToken
+        alias_method  :access_token,  :accessToken
+        alias_method  :access_token=, :accessToken=
+
+        attr_accessor :refreshToken
+        alias_method  :refresh_token,  :refreshToken
+        alias_method  :refresh_token=, :refreshToken=
+
+        attr_accessor :expiresIn
+        alias_method  :expires_in,  :expiresIn
+        alias_method  :expires_in=, :expiresIn=
+
+        attr_accessor :rawTokenResponse
+        alias_method  :raw_token_response,  :rawTokenResponse
+        alias_method  :raw_token_response=, :rawTokenResponse=
+
+        private
+
+        def defaults
+          {
+            serviceApiKey:    nil,
+            clientId:         0,
+            id:               nil,
+            password:         nil,
+            claims:           nil,
+            claimsLocales:    nil,
+            sns:              nil,
+            accessToken:      nil,
+            refreshToken:     nil,
+            expiresIn:        0,
+            rawTokenResponse: nil
+          }
+        end
+
+        def set_params(hash)
+          @serviceApiKey    = hash[:serviceApiKey]
+          @clientId         = hash[:clientId]
+          @id               = hash[:id]
+          @password         = hash[:password]
+          @claims           = hash[:claims]
+          @claimsLocales    = hash[:claimsLocales]
+          @sns              = hash[:sns]
+          @accessToken      = hash[:accessToken]
+          @refreshToken     = hash[:refreshToken]
+          @expiresIn        = hash[:expiresIn]
+          @rawTokenResponse = hash[:rawTokenResponse]
         end
 
-        # Parse a JSON string which represents a request to an authentication
-        # callback endpoint and generate an instance of AuthenticationCallbackRequest.
+        public
+
         def self.parse(json)
           AuthenticationCallbackRequest.new(JSON.parse(json))
         end
       end
     end
   end
-end
+end

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

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2018 Authlete, Inc.
+# Copyright (C) 2014-2020 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,94 +15,33 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 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)
+      class AuthorizationFailRequest < Authlete::Model::Request::Base
+
         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 = nil)
-          # 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)
+        def defaults
+          {
+            ticket:      nil,
+            reason:      nil,
+            description: nil
+          }
         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
+        def set_params(hash)
+          @ticket      = hash[:ticket]
+          @reason      = hash[:reason]
+          @description = hash[:description]
         end
       end
     end
   end
-end
+end

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

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2018 Authlete, Inc.
+# Copyright (C) 2014-2020 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,154 +15,73 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 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)
+      class AuthorizationIssueRequest < Authlete::Model::Request::Base
+        include Authlete::Utility
+
         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
 
-        # Extra properties to associate with an access token and/or an
-        # authorization code. (String)
         attr_accessor :properties
 
-        # Scopes to associate with an access token and/or an authorization code.
-        # If a non-empty string array is given, it replaces the scopes specified
-        # by the original authorization request. (String array)
         attr_accessor :scopes
 
-        # The value of the "sub" claim to embed in an ID token. If this request
-        # parameter is "nil" or empty, the value of the subject request parameter
-        # is used as the value of the "sub" claim. (String)
         attr_accessor :sub
 
-        private
-
-        # Integer attributes.
-        INTEGER_ATTRIBUTES = ::Set.new([ :authTime ])
-
-        # String attributes.
-        STRING_ATTRIBUTES = ::Set.new([ :ticket, :subject, :acr, :claims, :sub ])
-
-        # String array attributes.
-        STRING_ARRAY_ATTRIBUTES = ::Set.new([ :scopes ])
-
-        # 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 = nil)
-          # 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 default values to string array attributes.
-          STRING_ARRAY_ATTRIBUTES.each do |attr|
-            send("#{attr}=", nil)
-          end
-
-          @properties = nil
-
-          # Set attribute values using the given hash.
-          authlete_model_update(hash)
-        end
+        attr_accessor :idtHeaderParams
+        alias_method  :idt_header_params,  :idtHeaderParams
+        alias_method  :idt_header_params=, :idtHeaderParams=
 
-        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) or
-          STRING_ARRAY_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)
-            elsif key == :properties
-              @properties = get_parsed_array(value) do |element|
-                Authlete::Model::Property.parse(element)
-              end
-            end
-          end
+        private
 
-          self
+        def defaults
+          {
+            ticket:           nil,
+            subject:          nil,
+            authTime:         0,
+            acr:              nil,
+            claims:           nil,
+            properties:       nil,
+            scopes:           nil,
+            sub:              nil,
+            idtHeaderParams:  nil
+          }
         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)
+        def set_params(hash)
+          @ticket          = hash[:ticket]
+          @subject         = hash[:subject]
+          @authTime        = hash[:authTime]
+          @acr             = hash[:acr]
+          @claims          = hash[:claims]
+          @properties      = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
+          @scopes          = hash[:scopes]
+          @sub             = hash[:sub]
+          @idtHeaderParams = hash[:idtHeaderParams]
         end
 
-        # Convert this object into a hash.
-        def to_hash
-          hash = {}
+        def to_hash_value(key, var)
+          raw_val = instance_variable_get(var)
 
-          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
-            elsif key == :properties
-              hash[key] = val.map { |element| element.to_hash }
-            end
+          case key
+            when :properties
+              raw_val&.map { |e| e.to_hash }
+            else
+              raw_val
           end
-
-          hash
         end
       end
     end
   end
-end
+end