authlete 1.0.24 → 1.1.0

data/lib/authlete/model/response/pushed-auth-req-response.rb

@@ -0,0 +1,59 @@
+# :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 PushedAuthReqResponse < Authlete::Model::Result
+
+        attr_accessor :action
+
+        attr_accessor :responseContent
+        alias_method  :response_content,  :responseContent
+        alias_method  :response_content=, :responseContent=
+
+        attr_accessor :clientAuthMethod
+        alias_method  :client_auth_method,  :clientAuthMethod
+        alias_method  :client_auth_method=, :clientAuthMethod=
+
+        attr_accessor :requestUri
+        alias_method  :request_uri,  :requestUri
+        alias_method  :request_uri=, :requestUri=
+
+        private
+
+        def defaults
+          super.merge(
+            action:           nil,
+            responseContent:  nil,
+            clientAuthMethod: nil,
+            requestUri:       nil
+          )
+        end
+
+        def set_params(hash)
+          super(hash)
+
+          @action           = hash[:action]
+          @responseContent  = hash[:responseContent]
+          @clientAuthMethod = hash[:clientAuthMethod]
+          @requestUri       = hash[:requestUri]
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/revocation-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,29 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::RevicationResponse class
-      #
-      # This class represents a response from Authlete's /api/auth/revocation API.
       class RevocationResponse < 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/revocation 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

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

@@ -0,0 +1,54 @@
+# :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 ServiceListResponse < Authlete::Model::Base
+        include Authlete::Utility
+
+        attr_accessor :start
+
+        attr_accessor :end
+
+        attr_accessor :totalCount
+        alias_method  :total_count,  :totalCount
+        alias_method  :total_count=, :totalCount=
+
+        attr_accessor :services
+
+        private
+
+        def defaults
+          {
+            start:      0,
+            end:        0,
+            totalCount: 0,
+            services:   nil
+          }
+        end
+
+        def set_params(hash)
+          @start      = hash[:start]
+          @end        = hash[:end]
+          @totalCount = hash[:totalCount]
+          @services   = get_parsed_array(hash[:services]) { |e| Authlete::Model::Service.parse(e) }
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/standard-introspection-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::StandardIntrospectionResponse class
-      #
-      # This class represents a response from Authlete's /api/auth/introspection/standard API.
       class StandardIntrospectionResponse < 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/introspection/standard 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

data/lib/authlete/model/response/token-create-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,83 +18,78 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::TokenCreateResponse class
-      #
-      # A class that represents a response from Authlete's
-      # /api/auth/token/create API.
       class TokenCreateResponse < Authlete::Model::Result
-        # The next action which the caller of the API should take next.
-        # (String)
+
         attr_accessor :action
 
-        # The newly issued access token. (String)
-        attr_accessor :accessToken
-        alias_method  :access_token,  :accessToken
-        alias_method  :access_token=, :accessToken=
+        attr_accessor :grantType
+        alias_method  :grant_type,  :grantType
+        alias_method  :grant_type=, :grantType=
 
-        # 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 time at which the access token expires. (Integer)
-        attr_accessor :expiresAt
-        alias_method  :expires_at,  :expiresAt
-        alias_method  :expires_at=, :expiresAt=
+        attr_accessor :subject
+
+        attr_accessor :scopes
+
+        attr_accessor :accessToken
+        alias_method  :access_token,  :accessToken
+        alias_method  :access_token=, :accessToken=
+
+        attr_accessor :tokenType
+        alias_method  :token_type,  :tokenType
+        alias_method  :token_type=, :tokenType=
 
-        # The duration of the newly issued access token in seconds. (Integer)
-        attr_accessor :expires_in
+        attr_accessor :expiresIn
         alias_method  :expires_in,  :expiresIn
         alias_method  :expires_in=, :expiresIn=
 
-        # The grant type for the newly issued access token. (String)
-        attr_accessor :grantType
-        alias_method  :grant_type,  :grantType
-        alias_method  :grant_type=, :grantType=
-
-        # Extra properties associated with the access token. (Property array)
-        attr_accessor :properties
+        attr_accessor :expiresAt
+        alias_method  :expires_at,  :expiresAt
+        alias_method  :expires_at=, :expiresAt=
 
-        # The newly issued refresh token. (String)
         attr_accessor :refreshToken
         alias_method  :refresh_token,  :refreshToken
         alias_method  :refresh_token=, :refreshToken=
 
-        # The scopes which is associated with the access token. (String array)
-        attr_accessor :scopes
+        attr_accessor :properties
 
-        # The subject which is associated with the access token.
-        # This is <tt>nil</tt> if the access token was created
-        # through {Client Credentials Flow}[https://tools.ietf.org/html/rfc6749#section-4.4].
-        # (String)
-        attr_accessor :subject
+        private
 
-        # The token type of the access token. (String)
-        attr_accessor :tokenType
-        alias_method  :token_type,  :tokenType
-        alias_method  :token_type=, :tokenType=
+        def defaults
+          super.merge(
+            action:       nil,
+            grantType:    nil,
+            clientId:     0,
+            subject:      nil,
+            scopes:       nil,
+            accessToken:  nil,
+            tokenType:    nil,
+            expiresIn:    0,
+            expiresAt:    0,
+            refreshToken: nil,
+            properties:   nil
+          )
+        end
 
-        # The constructor which takes a hash that represents a JSON response
-        # from /api/auth/token/create API.
-        def initialize(hash = {})
+        def set_params(hash)
           super(hash)
 
-          @action       = extract_value(hash, :action)
-          @accessToken  = extract_value(hash, :accessToken)
-          @clientId     = extract_integer_value(hash, :clientId)
-          @expiresAt    = extract_integer_value(hash, :expiresAt)
-          @expiresIn    = extract_integer_value(hash, :expiresIn)
-          @grantType    = extract_value(hash, :grantType)
-          @properties   = extract_array_value(hash, :scopes) do |element|
-            Authlete::Model::Property.parse(element)
-          end
-          @refreshToken = extract_value(hash, :refreshToken)
-          @scopes       = extract_value(hash, :scopes)
-          @subject      = extract_value(hash, :subject)
-          @tokenType    = extract_value(hash, :tokenType)
+          @action       = hash[:action]
+          @grantType    = hash[:grantType]
+          @clientId     = hash[:clientId]
+          @subject      = hash[:subject]
+          @scopes       = hash[:scopes]
+          @accessToken  = hash[:accessToken]
+          @tokenType    = hash[:tokenType]
+          @expiresIn    = hash[:expiresIn]
+          @expiresAt    = hash[:expiresAt]
+          @refreshToken = hash[:refreshToken]
+          @properties   = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/response/token-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,33 +18,30 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::TokenFailRequest class
-      #
-      # This class represents a response from Authlete's /api/auth/token API.
-      class TokenFailRequest
-        include Authlete::Utility < Authlete::Model::Result
-        # The next action that the service implementation should take.
-        # (String)
+      class TokenFailResponse < Authlete::Model::Result
+
         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/token/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

data/lib/authlete/model/response/token-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,122 +18,109 @@
 module Authlete
   module Model
     module Response
-      # == Authlete::Model::Response::TokenIssueResponse class
-      #
-      # This class represents a response from Authlete's /api/auth/token/issue API.
       class TokenIssueResponse < 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 newly issued access token. This parameter is a non-nil value
-        # only when the value of "action" parameter is "OK". (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 refresh token. This parameter is a non-nil value only when
-        # "action" = "OK" and the service supports the refresh token flow.
-        # If "Refresh Token Continuous Use" configuration parameter is "NO"
-        # (= refreshTokenKept=false), a new refresh token is issued and the
-        # old refresh token used in the refresh token flow is invalidated.
-        # On the contrary, if the configuration parameter is "YES", the refresh
-        # token itself is not refreshed. (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 client ID. (Integer)
         attr_accessor :clientId
         alias_method  :client_id, :clientId
         alias_method  :client_id=, :clientId=
 
-        # If the client did not have an alias, this parameter is nil. (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/issue API.
-        def initialize(hash = {})
+        def defaults
+          super.merge(
+            action:                nil,
+            responseContent:       nil,
+            accessToken:           nil,
+            accessTokenExpiresAt:  0,
+            accessTokenDuration:   0,
+            refreshToken:          nil,
+            refreshTokenExpiresAt: 0,
+            refreshTokenDuration:  0,
+            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)
-          @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)
-          @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]
+          @accessToken           = hash[:accessToken]
+          @accessTokenExpiresAt  = hash[:accessTokenExpiresAt]
+          @accessTokenDuration   = hash[:accessTokenDuration]
+          @refreshToken          = hash[:refreshToken]
+          @refreshTokenExpiresAt = hash[:refreshTokenExpiresAt]
+          @refreshTokenDuration  = hash[:refreshTokenDuration]
+          @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