authlete 0.5.1 → 1.0.0

data/lib/authlete/model/request/token-update-request.rb

@@ -0,0 +1,165 @@
+# :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.
+
+
+require 'set'
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::TokenUpdateRequest class
+      #
+      # This class represents a request to Authlete's /api/auth/token/update API.
+      class TokenUpdateRequest < Authlete::Model::Hashable
+        # An existing access token. (String)
+        attr_accessor :accessToken
+        alias_method  :access_token,  :accessToken
+        alias_method  :access_token=, :accessToken=
+
+        #A new date at which the access token will expire in milliseconds
+        # since the Unix epoch (1970-01-01). If the accessTokenExpiresAt request
+        # parameter is not included in a request or its value is 0 (or negative),
+        # the expiration date of the access token is not changed. (Integer)
+        attr_accessor :accessTokenExpiresAt
+        alias_method  :access_token_expires_at,  :accessTokenExpiresAt
+        alias_method  :access_token_expires_at=, :accessTokenExpiresAt=
+
+        # A new set of scopes assigned to the access token. Scopes that are not
+        # supported by the service and those that the client application associated
+        # with the access token is not allowed to request are ignored on the
+        # server side. If the scopes request parameter is not included in a
+        # request or its value is nil, the scopes of the access token are not
+        # changed. (String array)
+        attr_accessor :scopes
+
+        # A new set of properties assigned to the access token. If the properties
+        # request parameter is not included in a request or its value is nil,
+        # the properties of the access token are not changed.
+        # (Property array)
+        attr_accessor :properties
+
+        private
+
+        # Integer attributes.
+        INTEGER_ATTRIBUTES = ::Set.new([ :accessTokenExpiresAt ])
+
+        # String attributes.
+        STRING_ATTRIBUTES = ::Set.new([ :accessToken ])
+
+        # String array attributes.
+        STRING_ARRAY_ATTRIBUTES = ::Set.new([ :scopes ])
+
+        # Mapping from snake cases to camel cases.
+        SNAKE_TO_CAMEL = {
+          :access_token      => :accessToken,
+          :access_expires_at => :accessTokenExpiresAt
+        }
+
+        # The constructor which takes a hash that represents a JSON request to
+        # Authlete's /api/auth/token/update 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
+
+        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
+
+          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, TokenUpdateRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return TokenUpdateRequest.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
+            elsif key == :properties
+              hash[key] = val.map { |element| element.to_hash }
+            end
+          end
+
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/user-info-issue-request.rb

@@ -0,0 +1,113 @@
+# :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.
+
+
+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)
+        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)
+        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
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/user-info-request.rb

@@ -0,0 +1,102 @@
+# :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.
+
+
+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
+
+        # 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?
+
+          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, UserInfoRequest.new(hash) is returned.
+        def self.parse(hash)
+          if hash.nil? or (hash.kind_of?(Hash) == false)
+            return nil
+          end
+
+          return UserInfoRequest.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
+        end
+      end
+    end
+  end
+end

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

@@ -1,54 +1,54 @@
-# :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::AuthenticationCallbackResponse class
-      #
-      # This class represents a response from an authentication callback endpoint.
-      class AuthenticationCallbackResponse
-        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)
-        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
-          ))
-        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::AuthenticationCallbackResponse class
+      #
+      # This class represents a response from an authentication callback endpoint.
+      class AuthenticationCallbackResponse
+        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)
+        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
+          ))
+        end
+      end
+    end
+  end
 end