authlete 1.0.21 → 1.2.0

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

@@ -0,0 +1,64 @@
+# :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 TokenListResponse < Authlete::Model::Base
+        include Authlete::Utility
+
+        attr_accessor :start
+
+        attr_accessor :end
+
+        attr_accessor :client
+
+        attr_accessor :subject
+
+        attr_accessor :totalCount
+        alias_method  :total_count,  :totalCount
+        alias_method  :total_count=, :totalCount=
+
+        attr_accessor :accessTokens
+        alias_method  :access_tokens,  :accessTokens
+        alias_method  :access_tokens=, :accessTokens=
+
+        private
+
+        def defaults
+          {
+            start:        nil,
+            end:          nil,
+            client:       nil,
+            subject:      nil,
+            totalCount:   0,
+            accessTokens: nil
+          }
+        end
+
+        def set_params(hash)
+          @start        = hash[:start]
+          @end          = hash[:end]
+          @client       = Authlete::Model::Client.parse(hash[:client])
+          @subject      = hash[:subject]
+          @totalCount   = hash[:totalCount]
+          @accessTokens = get_parsed_array(hash[:accessTokens]) { |e| Authlete::Model::Response::AccessToken.parse(e) }
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/token-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,152 +18,132 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::TokenResponse class
-      #
-      # This class represents a response from Authlete's /api/auth/token API.
       class TokenResponse < Authlete::Model::Result
-        include Authlete::Utility
-        # 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=
 
-        # The value of "username" request parameter.
-        #
-        # This value is non-nil only when the value of
-        # "grant_type" request parameter in the token request is "password".
         attr_accessor :username
 
-        # The value of "password" request parameter.
-        #
-        # This value is non-nil only when the value of
-        # "grant_type" request parameter in the token request is "password".
         attr_accessor :password
 
-        # The ticket issued from Authlete's /api/auth/token endpoint.
-        # This parameter is to be used as "ticket" request parameter
-        # for /api/auth/token/issue API or /api/auth/token/fail API.
-        # This parameter is non-nil only when "action" is "PASSWORD PASSWORD".
         attr_accessor :ticket
 
-        # The newly issued access token. (String)
         attr_accessor :accessToken
         alias_method  :access_token,  :accessToken
         alias_method  :access_token=, :accessToken=
 
-        # The datetime at which the newly issued access token will expire.
-        # The value is represented in milliseconds since the Unix epoch (1970-01-01).
-        # (Integer)
         attr_accessor :accessTokenExpiresAt
         alias_method  :access_token_expires_at,  :accessTokenExpiresAt
         alias_method  :access_token_expires_at=, :accessTokenExpiresAt=
 
-        # The duration of the newly issued access token in seconds. (Integer)
         attr_accessor :accessTokenDuration
         alias_method  :access_token_duration,  :accessTokenDuration
         alias_method  :access_token_duration=, :accessTokenDuration=
 
-        # The newly issued refresh token. (String)
         attr_accessor :refreshToken
         alias_method  :refresh_token,  :refreshToken
         alias_method  :refresh_token=, :refreshToken=
 
-        # The datetime at which the newly issued refresh token will expire.
-        # The value is represented in milliseconds since the Unix epoch (1970-01-01).
-        # (Integer)
         attr_accessor :refreshTokenExpiresAt
         alias_method  :refresh_token_expires_at,  :refreshTokenExpiresAt
         alias_method  :refresh_token_expires_at=, :refreshTokenExpiresAt=
 
-        # The duration of the newly issued refresh token in seconds. (Integer)
         attr_accessor :refreshTokenDuration
         alias_method  :refresh_token_duration,  :refreshTokenDuration
         alias_method  :refresh_token_duration=, :refreshTokenDuration=
 
-        # The newly issued ID token. Note that an ID token is issued from
-        # a Token Endpoint only when the "response_type" request parameter
-        # of the authorization request to an Authorization Endpoint has contained
-        # "code" and the "scope" request parameter has contained "openid".
-        # (String)
         attr_accessor :idToken
         alias_method  :id_token,  :idToken
         alias_method  :id_token=, :idToken=
 
-        # The grant type of the token request. (String)
         attr_accessor :grantType
         alias_method  :grant_type,  :grantType
         alias_method  :grant_type=, :grantType=
 
-        # The client ID. (Integer)
         attr_accessor :clientId
         alias_method  :client_id, :clientId
         alias_method  :client_id=, :clientId=
 
-        # Alias of client ID. (String)
         attr_accessor :clientIdAlias
         alias_method  :client_id_alias,  :clientIdAlias
         alias_method  :client_id_alias=, :clientIdAlias=
 
-        # The flag which indicates whether the client ID alias was used when
-        # the token request was made. "true" if the client ID alias was used
-        # when the token request was made. (Boolean)
         attr_accessor :clientIdAliasUsed
         alias_method  :client_id_alias_used,  :clientIdAliasUsed
         alias_method  :client_id_alias_used=, :clientIdAliasUsed=
 
-        # The subject (= resource owner's ID) of the access token.
-        # Even if an access token has been issued by the call of /api/auth/token API,
-        # this parameter is "nil" if the flow of the token request was "Client Credentials Flow"
-        # (grant_type=client_credentials) because it means the access token
-        # is not associated with any specific end-user.
-        # (String)
         attr_accessor :subject
 
-        # The scopes covered by the access token.
-        # (Scope array)
         attr_accessor :scopes
 
-        # The extra properties associated with the access token.
-        # This parameter is "nil" when no extra property is associated with
-        # the issued access token.
         attr_accessor :properties
 
+        attr_accessor :jwtAccessToken
+        alias_method  :jwt_access_token,  :jwtAccessToken
+        alias_method  :jwt_access_token=, :jwtAccessToken=
+
+        attr_accessor :accessTokenResources
+        alias_method  :access_token_resources,  :accessTokenResources
+        alias_method  :access_token_resources=, :accessTokenResources=
+
         private
 
-        # The constructor which takes a hash that represents a JSON response
-        # from Authlete's /api/auth/token API.
-        def initialize(hash = {})
+        def defaults
+          super.merge(
+            action:                nil,
+            responseContent:       nil,
+            username:              nil,
+            password:              nil,
+            ticket:                nil,
+            accessToken:           nil,
+            accessTokenExpiresAt:  0,
+            accessTokenDuration:   0,
+            refreshToken:          nil,
+            refreshTokenExpiresAt: 0,
+            refreshTokenDuration:  0,
+            idToken:               nil,
+            grantType:             nil,
+            clientId:              0,
+            clientIdAlias:         nil,
+            clientIdAliasUsed:     false,
+            subject:               nil,
+            scopes:                nil,
+            properties:            nil,
+            jwtAccessToken:        nil,
+            accessTokenResources:  nil
+          )
+        end
+
+        def set_params(hash)
           super(hash)
 
-          @action                = extract_value(hash, :action)
-          @responseContent       = extract_value(hash, :responseContent)
-          @username              = extract_value(hash, :username)
-          @password              = extract_value(hash, :password)
-          @ticket                = extract_value(hash, :ticket)
-          @accessToken           = extract_value(hash, :accessToken)
-          @accessTokenExpiresAt  = extract_integer_value(hash, :accessTokenExpiresAt)
-          @accessTokenDuration   = extract_integer_value(hash, :accessTokenDuration)
-          @refreshToken          = extract_value(hash, :refreshToken)
-          @refreshTokenExpiresAt = extract_integer_value(hash, :refreshTokenExpiresAt)
-          @refreshTokenDuration  = extract_integer_value(hash, :refreshTokenDuration)
-          @idToken               = extract_value(hash, :idToken)
-          @grantType             = extract_value(hash, :grantType)
-          @clientId              = extract_integer_value(hash, :clientId)
-          @clientIdAlias         = extract_value(hash, :clientIdAlias)
-          @clientIdAliasUsed     = extract_boolean_value(hash, :clientIdAliasUsed)
-          @subject               = extract_value(hash, :subject)
-          @scopes                = extract_value(hash, :scopes)
-          @properties            = extract_array_value(hash, :scopes) do |element|
-            Authlete::Model::Property.parse(element)
-          end
+          @action                = hash[:action]
+          @responseContent       = hash[:responseContent]
+          @username              = hash[:username]
+          @password              = hash[:password]
+          @ticket                = hash[:ticket]
+          @accessToken           = hash[:accessToken]
+          @accessTokenExpiresAt  = hash[:accessTokenExpiresAt]
+          @accessTokenDuration   = hash[:accessTokenDuration]
+          @refreshToken          = hash[:refreshToken]
+          @refreshTokenExpiresAt = hash[:refreshTokenExpiresAt]
+          @refreshTokenDuration  = hash[:refreshTokenDuration]
+          @idToken               = hash[:idToken]
+          @grantType             = hash[:grantType]
+          @clientId              = hash[:clientId]
+          @clientIdAlias         = hash[:clientIdAlias]
+          @clientIdAliasUsed     = hash[:clientIdAliasUsed]
+          @subject               = hash[:subject]
+          @scopes                = hash[:scopes]
+          @properties            = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
+          @jwtAccessToken        = hash[:jwtAccessToken]
+          @accessTokenResources  = hash[:accessTokenResources]
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/response/token-update-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,45 +18,50 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::TokenUpdateResponse class
-      #
-      # A class that represents a response from Authlete's
-      # /api/auth/token/update API.
       class TokenUpdateResponse < Authlete::Model::Result
-        # The next action which the caller of the API should take next.
-        # (String)
+
         attr_accessor :action
 
-        # The access token which has been specified by the request. (String)
         attr_accessor :accessToken
         alias_method  :access_token,  :accessToken
         alias_method  :access_token=, :accessToken=
 
-        # The date at which the access token will expire. (Integer)
+        attr_accessor :tokenType
+        alias_method  :token_type,  :tokenType
+        alias_method  :token_type=, :tokenType=
+
         attr_accessor :accessTokenExpiresAt
         alias_method  :access_token_expires_at,  :accessTokenExpiresAt
         alias_method  :access_token_expires_at=, :accessTokenExpiresAt=
 
-        # Extra properties associated with the access token. (Property array)
+        attr_accessor :scopes
+
         attr_accessor :properties
 
-        # The scopes which is associated with the access token. (String array)
-        attr_accessor :scopes
+        private
+
+        def defaults
+          super.merge(
+            action:               nil,
+            accessToken:          nil,
+            tokenType:            nil,
+            accessTokenExpiresAt: 0,
+            scopes:               nil,
+            properties:           nil
+          )
+        end
 
-        # The constructor which takes a hash that represents a JSON response
-        # from /api/auth/token/update API.
-        def initialize(hash = {})
+        def set_params(hash)
           super(hash)
 
-          @action               = extract_value(hash, :action)
-          @accessToken          = extract_value(hash, :accessToken)
-          @accessTokenExpiresAt = extract_integer_value(hash, :accessTokenExpiresAt)
-          @properties           = extract_array_value(hash, :scopes) do |element|
-            Authlete::Model::Property.parse(element)
-          end
-          @scopes               = extract_value(hash, :scopes)
+          @action               = hash[:action]
+          @accessToken          = hash[:accessToken]
+          @tokenType            = hash[:tokenType]
+          @accessTokenExpiresAt = hash[:accessTokenExpiresAt]
+          @scopes               = hash[:scopes]
+          @properties           = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/response/user-info-issue-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,30 +18,30 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::UserInfoIssueResponse class
-      #
-      # A class that represents a response from Authlete's
-      # /api/auth/userinfo/issue API.
       class UserInfoIssueResponse < Authlete::Model::Result
-        # The next action which the caller of the API should take next.
-        # (String)
+
         attr_accessor :action
 
-        # The content of the error response that the service implementation
-        # should return to the client application. (String)
-        attr_accessor :response_content
+        attr_accessor :responseContent
         alias_method  :response_content,  :responseContent
         alias_method  :response_content=, :responseContent=
 
-        # The constructor which takes a hash that represents a JSON response
-        # from /api/auth/userinfo/issue API.
-        def initialize(hash = {})
+        private
+
+        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

data/lib/authlete/model/response/user-info-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,68 +18,74 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::UserInfoResponse class
-      #
-      # A class that represents a response from Authlete's
-      # /api/auth/userinfo API.
       class UserInfoResponse < Authlete::Model::Result
-        # The next action which the caller of the API should take next.
-        # (String)
-        attr_accessor :action
 
-        # The list of claims that the client application requests to be
-        # embedded in the ID token. (String array)
-        attr_accessor :claims
+        attr_accessor :action
 
-        # The ID of the client application which is associated with
-        # the access token. (Integer)
         attr_accessor :clientId
         alias_method  :client_id,  :clientId
         alias_method  :client_id=, :clientId=
 
-        # The client ID alias when the authorization request for the access
-        # token was made. (String)
+        attr_accessor :subject
+
+        attr_accessor :scopes
+
+        attr_accessor :claims
+
+        attr_accessor :token
+
+        attr_accessor :responseContent
+        alias_method  :response_content,  :responseContent
+        alias_method  :response_content=, :responseContent=
+
+        attr_accessor :properties
+
         attr_accessor :clientIdAlias
         alias_method  :client_id_alias,  :clientIdAlias
         alias_method  :client_id_alias=, :clientIdAlias=
 
-        # The flag which indicates whether the client ID alias was used when
-        # the authorization request or the token request for the access token
-        # was made. (Boolean)
         attr_accessor :clientIdAliasUsed
         alias_method  :client_id_alias_used,  :clientIdAliasUsed
         alias_method  :client_id_alias_used=, :clientIdAliasUsed=
 
-        # The content of the error response that the service implementation
-        # should return to the client application. (String)
-        attr_accessor :response_content
-        alias_method  :response_content,  :responseContent
-        alias_method  :response_content=, :responseContent=
+        attr_accessor :userInfoClaims
+        alias_method  :user_info_claims,  :userInfoClaims
+        alias_method  :user_info_claims=, :userInfoClaims=
 
-        # The scopes covered by the access token. (String array)
-        attr_accessor :scopes
-
-        # The subject (= resource owner's ID). (String)
-        attr_accessor :subject
+        private
 
-        # The access token that came along with the userinfo request. (String)
-        attr_accessor :token
+        def defaults
+          super.merge(
+            action:            nil,
+            clientId:          0,
+            subject:           nil,
+            scopes:            nil,
+            claims:            nil,
+            token:             nil,
+            responseContent:   nil,
+            properties:        nil,
+            clientIdAlias:     nil,
+            clientIdAliasUsed: false,
+            userInfoClaims:    nil
+          )
+        end
 
-        # The constructor which takes a hash that represents a JSON response
-        # from /api/auth/introspection API.
-        def initialize(hash = {})
+        def set_params(hash)
           super(hash)
 
-          @action            = extract_value(hash, :action)
-          @clientId          = extract_value(hash, :clientId)
-          @clientIdAlias     = extract_value(hash, :clientIdAlias)
-          @clientIdAliasUsed = extract_boolean_value(hash, :clientIdAliasUsed)
-          @responseContent   = extract_value(hash, :responseContent)
-          @scopes            = extract_value(hash, :scopes)
-          @subject           = extract_value(hash, :subject)
-          @token             = extract_value(hash, :token)
+          @action            = hash[:action]
+          @clientId          = hash[:clientId]
+          @subject           = hash[:subject]
+          @scopes            = hash[:scopes]
+          @claims            = hash[:claims]
+          @token             = hash[:token]
+          @responseContent   = hash[:responseContent]
+          @properties        = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
+          @clientIdAlias     = hash[:clientIdAlias]
+          @clientIdAliasUsed = hash[:clientIdAliasUsed]
+          @userInfoClaims    = hash[:userInfoClaims]
         end
       end
     end
   end
-end
+end