authlete 0.5.1 → 1.0.0

data/lib/authlete/model/response/revocation-response.rb

@@ -0,0 +1,49 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2018 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
+      # == 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 = {})
+          super(hash)
+
+          @action          = extract_value(hash, :action)
+          @responseContent = extract_value(hash, :responseContent)
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,51 @@
-# :nodoc:
-#
-# Copyright (C) 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 Response
-      # == Authlete::Model::Response::ServiceCreatableResponse class
-      class ServiceCreatableResponse
-        include Authlete::Utility
-        # A boolean flag to indicate whether the service owner can
-        # create a new service or not.
-        attr_accessor :creatable
-
-        # The number of services that the service owner currently has.
-        attr_accessor :count
-
-        # The maximum number of services allowed in the plan of the
-        # service owner.
-        attr_accessor :limit
-
-        # The plan of the service owner.
-        attr_accessor :plan
-
-        # The constructor which takes a hash that represents a JSON
-        # response from /api/service/creatable API.
-        def initialize(hash = {})
-          @creatable = extract_boolean_value(hash, :creatable)
-          @count     = extract_value(hash, :count)
-          @limit     = extract_value(hash, :limit)
-          @plan      = extract_value(hash, :plan)
-        end
-
-        alias_method :creatable?, :creatable
-      end
-    end
-  end
+# :nodoc:
+#
+# Copyright (C) 2014-2018 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
+      # == Authlete::Model::Response::ServiceCreatableResponse class
+      class ServiceCreatableResponse
+        include Authlete::Utility
+        # A boolean flag to indicate whether the service owner can
+        # create a new service or not.
+        attr_accessor :creatable
+
+        # The number of services that the service owner currently has.
+        attr_accessor :count
+
+        # The maximum number of services allowed in the plan of the
+        # service owner.
+        attr_accessor :limit
+
+        # The plan of the service owner.
+        attr_accessor :plan
+
+        # The constructor which takes a hash that represents a JSON
+        # response from /api/service/creatable API.
+        def initialize(hash = {})
+          @creatable = extract_boolean_value(hash, :creatable)
+          @count     = extract_integer_value(hash, :count)
+          @limit     = extract_integer_value(hash, :limit)
+          @plan      = extract_value(hash, :plan)
+        end
+
+        alias_method :creatable?, :creatable
+      end
+    end
+  end
 end

data/lib/authlete/model/response/standard-introspection-response.rb

@@ -0,0 +1,49 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2018 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
+      # == 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 = {})
+          super(hash)
+
+          @action          = extract_value(hash, :action)
+          @responseContent = extract_value(hash, :responseContent)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2018 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
+      # == 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=
+
+        # 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=
+
+        # The duration of the newly issued access token in seconds. (Integer)
+        attr_accessor :expires_in
+        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
+
+        # 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
+
+        # 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
+
+        # The token type of the access token. (String)
+        attr_accessor :tokenType
+        alias_method  :token_type,  :tokenType
+        alias_method  :token_type=, :tokenType=
+
+        # The constructor which takes a hash that represents a JSON response
+        # from /api/auth/token/create API.
+        def initialize(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)
+        end
+      end
+    end
+  end
+end

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

@@ -1,50 +1,50 @@
-# :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 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)
-        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 = {})
-          super(hash)
-
-          @action          = extract_value(hash, :action)
-          @responseContent = extract_value(hash, :responseContent)
-        end
-      end
-    end
-  end
+# :nodoc:
+#
+# Copyright (C) 2014-2018 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
+      # == 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)
+        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 = {})
+          super(hash)
+
+          @action          = extract_value(hash, :action)
+          @responseContent = extract_value(hash, :responseContent)
+        end
+      end
+    end
+  end
 end

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

@@ -1,50 +1,139 @@
-authorization-response.rb# :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 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=
-
-        private
-
-        # The constructor which takes a hash that represents a JSON response
-        # from Authlete's /api/auth/token/issue API.
-        def initialize(hash = {})
-          super(hash)
-
-          @action          = extract_value(hash, :action)
-          @responseContent = extract_value(hash, :responseContent)
-        end
-      end
-    end
-  end
+# :nodoc:
+#
+# Copyright (C) 2014-2018 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
+      # == 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
+
+        private
+
+        # The constructor which takes a hash that represents a JSON response
+        # from Authlete's /api/auth/token/issue API.
+        def initialize(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
+        end
+      end
+    end
+  end
 end