authlete 1.0.24 → 1.1.0

data/lib/authlete/model/request/user-info-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,99 +15,33 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
     module Request
-      # == Authlete::Model::Request::UserInfoRequest class
-      #
-      # This class represents a request to Authlete's /api/auth/userinfo/issue API.
-      class UserInfoIssueRequest < Authlete::Model::Hashable
-        # An access token to introspect. (String)
+      class UserInfoIssueRequest < Authlete::Model::Request::Base
+
         attr_accessor :token
 
-        # Claims in JSON format.
-        # As for the format, see "OpenID Connect Core 1.0, 5.1. Standard Claims".
-        # (String)
         attr_accessor :claims
 
-        # The value of the "sub" claim. If the value of this request parameter
-        # is not empty, it is used as the value of the "sub" claim. Otherwise,
-        # the value of the subject associated with the access token is used.
-        # (String)
         attr_accessor :sub
 
         private
 
-        # String attributes.
-        STRING_ATTRIBUTES = ::Set.new([ :token, :claims, :sub ])
-
-        # The constructor which takes a hash that represents a JSON request to
-        # Authlete's /api/auth/userinfo/issue 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
+          {
+            token:  nil,
+            clamis: nil,
+            sub:    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, UserInfoIssueRequest.new(hash) is returned.
-        def self.parse(hash)
-          if hash.nil? or (hash.kind_of?(Hash) == false)
-            return nil
-          end
-
-          return UserInfoIssueRequest.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)
+          @token  = hash[:token]
+          @claims = hash[:clamis]
+          @sub    = hash[:sub]
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/request/user-info-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,88 +15,43 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
     module Request
-      # == Authlete::Model::Request::UserInfoRequest class
-      #
-      # This class represents a request to Authlete's /api/auth/userinfo API.
-      class UserInfoRequest < Authlete::Model::Hashable
-        # An access token to introspect. (String)
-        attr_accessor :token
-
-        private
+      class UserInfoRequest < Authlete::Model::Request::Base
 
-        # String attributes.
-        STRING_ATTRIBUTES = ::Set.new([ :token ])
-
-        # The constructor which takes a hash that represents a JSON request to
-        # Authlete's /api/auth/userinfo 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)
-        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?
+        attr_accessor :token
 
-          hash.each do |key, value|
-            key = authlete_model_convert_key(key)
+        attr_accessor :clientCertificate
+        alias_method  :client_certificate,  :clientCertificate
+        alias_method  :client_certificate=, :clientCertificate=
 
-            if authlete_model_simple_attribute?(key)
-              send("#{key}=", value)
-            end
-          end
+        attr_accessor :dpop
 
-          self
-        end
+        attr_accessor :htu
 
-        public
+        attr_accessor :htm
 
-        # Construct an instance from the given hash.
-        #
-        # If the given argument is nil or is not a Hash, nil is returned.
-        # Otherwise, UserInfoRequest.new(hash) is returned.
-        def self.parse(hash)
-          if hash.nil? or (hash.kind_of?(Hash) == false)
-            return nil
-          end
+        private
 
-          return UserInfoRequest.new(hash)
+        def defaults
+          {
+            token:             nil,
+            clientCertificate: nil,
+            dpop:              nil,
+            htu:               nil,
+            htm:               nil
+          }
         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)
+          @token             = hash[:token]
+          @clientCertificate = hash[:clientCertificate]
+          @dpop              = hash[:dpop]
+          @htu               = hash[:htu]
+          @htm               = hash[:htm]
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/response/access-token.rb

@@ -0,0 +1,96 @@
+# :nodoc:
+#
+# 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.
+# 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 Response
+      class AccessToken < Authlete::Model::Base
+        include Authlete::Utility
+
+        attr_accessor :accessTokenHash
+        alias_method  :access_token_hash,  :accessTokenHash
+        alias_method  :access_token_hash=, :accessTokenHash=
+
+        attr_accessor :refreshTokenHash
+        alias_method  :refresh_token_hash,  :refreshTokenHash
+        alias_method  :refresh_token_hash=, :refreshTokenHash=
+
+        attr_accessor :clientId
+        alias_method  :client_id,  :clientId
+        alias_method  :client_id=, :clientId=
+
+        attr_accessor :subject
+
+        attr_accessor :grantType
+        alias_method  :grant_type,  :grantType
+        alias_method  :grant_type=, :grantType=
+
+        attr_accessor :scopes
+
+        attr_accessor :accessTokenExpiresAt
+        alias_method  :access_token_expires_at,  :accessTokenExpiresAt
+        alias_method  :access_token_expires_at=, :accessTokenExpiresAt=
+
+        attr_accessor :refreshTokenExpiresAt
+        alias_method  :refresh_token_expires_at,  :refreshTokenExpiresAt
+        alias_method  :refresh_token_expires_at=, :refreshTokenExpiresAt=
+
+        attr_accessor :createdAt
+        alias_method  :created_at,  :createdAt
+        alias_method  :created_at=, :createdAt=
+
+        attr_accessor :lastRefreshedAt
+        alias_method  :last_refreshed_at,  :lastRefreshedAt
+        alias_method  :last_refreshed_at=, :lastRefreshedAt=
+
+        attr_accessor :properties
+
+        private
+
+        def defaults
+          {
+            accessTokenHash:       nil,
+            refreshTokenHash:      nil,
+            clientId:              0,
+            subject:               nil,
+            grantType:             nil,
+            scopes:                nil,
+            accessTokenExpiresAt:  0,
+            refreshTokenExpiresAt: 0,
+            createdAt:             0,
+            lastRefreshedAt:       0,
+            properties:            nil
+          }
+        end
+
+        def set_params(hash)
+          @accessTokenHash       = hash[:accessTokenHash]
+          @refreshTokenHash      = hash[:refreshTokenHash]
+          @clientId              = hash[:clientId]
+          @subject               = hash[:subject]
+          @grantType             = hash[:grantType]
+          @scopes                = hash[:scopes]
+          @accessTokenExpiresAt  = hash[:accessTokenExpiresAt]
+          @refreshTokenExpiresAt = hash[:refreshTokenExpiresAt]
+          @createdAt             = hash[:createdAt]
+          @lastRefreshedAt       = hash[:lastRefreshedAt]
+          @properties            = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/authentication-callback-response.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,40 +15,45 @@
 # limitations under the License.
 
 
+require 'json'
+
+
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::AuthenticationCallbackResponse class
-      #
-      # This class represents a response from an authentication callback endpoint.
-      class AuthenticationCallbackResponse
+      class AuthenticationCallbackResponse < Authlete::Model::Base
         include Authlete::Utility
-        # True when the end-user has been authenticated (= is a valid user).
+
         attr_accessor :authenticated
 
-        # The unique identifier of the end-user.
         attr_accessor :subject
 
-        # Pieces of information about the end-user in JSON format.
         attr_accessor :claims
 
-        # The constructor which takes a hash that represents a JSON response
-        # from an authentication callback endpoint.
-        def initialize(hash = {})
-          @authenticated = extract_boolean_value(hash, :authenticated)
-          @subject       = extract_value(hash, :subject)
-          @claims        = extract_value(hash, :claims)
+        private
+
+        def defaults
+          {
+            authenticated: false,
+            subject:       nil,
+            claims:        nil
+          }
+        end
+
+        def set_params(hash)
+          @authenticated = hash[:authenticated]
+          @subject       = hash[:subject]
+          @claims        = hash[:claims]
         end
 
-        # Generate an array which is usable as a Rack response from this instance.
         def to_rack_response
           to_rack_response_json(200, JSON.generate(
-            :authenticated => @authenticated,
-            :subject       => @subject,
-            :claims        => @claims
+            authenticated: @authenticated,
+            subject:       @subject,
+            claims:        @claims
           ))
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/response/authorization-fail-response.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.
@@ -18,32 +18,30 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::AuthorizationFailResponse class
-      #
-      # This class represents a response from Authlete's /api/auth/authorization/fail API.
       class AuthorizationFailResponse < Authlete::Model::Result
-        # The next action that the service implementation should take.
-        # (String)
+
         attr_accessor :action
 
-        # The response content which can be used to generate a response
-        # to the client application. The format of the value varies
-        # depending on the value of "action". (String)
         attr_accessor :responseContent
         alias_method  :response_content,  :responseContent
         alias_method  :response_content=, :responseContent=
 
         private
 
-        # The constructor which takes a hash that represents a JSON response
-        # from Authlete's /api/auth/authorization/fail API.
-        def initialize(hash = {})
+        def defaults
+          super.merge(
+            action:          nil,
+            responseContent: nil
+          )
+        end
+
+        def set_params(hash)
           super(hash)
 
-          @action          = extract_value(hash, :action)
-          @responseContent = extract_value(hash, :responseContent)
+          @action          = hash[:action]
+          @responseContent = hash[:responseContent]
         end
       end
     end
   end
-end
+end