authlete 1.0.24 → 1.1.0

data/lib/authlete/model/request/authorization-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,23 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
     module Request
-      # == Authlete::Model::Request::AuthorizationRequest class
-      #
-      # This class represents a request to Authlete's /api/auth/authorization API.
-      class AuthorizationRequest < Authlete::Model::Hashable
-        # The OAuth 2.0 authorization request parameters. (String)
+      class AuthorizationRequest < Authlete::Model::Request::Base
+
         attr_accessor :parameters
 
         private
 
-        # String attributes.
-        STRING_ATTRIBUTES = ::Set.new([ :parameters ])
-
-        # The constructor which takes a hash that represents a JSON request to
-        # Authlete's /api/auth/authorization 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
+          { parameters: 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, AuthorizationRequest.new(hash) is returned.
-        def self.parse(hash)
-          if hash.nil? or (hash.kind_of?(Hash) == false)
-            return nil
-          end
-
-          return AuthorizationRequest.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)
+          @parameters = hash[:parameters]
         end
       end
     end
   end
-end
+end

data/lib/authlete/model/request/backchannel-authentication-complete-request.rb

@@ -0,0 +1,97 @@
+# :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 Request
+      class BackchannelAuthenticationCompleteRequest < Authlete::Model::Request::Base
+        include Authlete::Utility
+
+        attr_accessor :ticket
+
+        attr_accessor :result
+
+        attr_accessor :subject
+
+        attr_accessor :sub
+
+        attr_accessor :authTime
+        alias_method  :auth_time,  :authTime
+        alias_method  :auth_time=, :authTime=
+
+        attr_accessor :acr
+
+        attr_accessor :claims
+
+        attr_accessor :properties
+
+        attr_accessor :scopes
+
+        attr_accessor :errorDescription
+        alias_method  :error_description,  :errorDescription
+        alias_method  :error_description=, :errorDescription=
+
+        attr_accessor :errorUri
+        alias_method  :error_uri,  :errorUri
+        alias_method  :error_uri=, :errorUri=
+
+        private
+
+        def defaults
+          {
+            ticket:           nil,
+            result:           nil,
+            subject:          nil,
+            sub:              nil,
+            authTime:         0,
+            acr:              nil,
+            claims:           nil,
+            properties:       nil,
+            scopes:           nil,
+            errorDescription: nil,
+            errorUri:         nil
+          }
+        end
+
+        def set_params(hash)
+          @ticket           = hash[:ticket]
+          @result           = hash[:result]
+          @subject          = hash[:subject]
+          @sub              = hash[:sub]
+          @authTime         = hash[:authTime]
+          @acr              = hash[:acr]
+          @claims           = hash[:claims]
+          @properties       = get_parsed_array(hash[:properties]) { |e| Authlete::Model::Property.parse(e) }
+          @scopes           = hash[:scopes]
+          @errorDescription = hash[:errorDescription]
+          @errorUri         = hash[:errorUri]
+        end
+
+        def to_hash_value(key, var)
+          raw_val = instance_variable_get(var)
+
+          case key
+            when :properties
+              raw_val&.map { |e| e.to_hash }
+            else
+              raw_val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/backchannel-authentication-fail-request.rb

@@ -0,0 +1,55 @@
+# :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 Request
+      class BackchannelAuthenticationFailRequest < Authlete::Model::Request::Base
+
+        attr_accessor :ticket
+
+        attr_accessor :reason
+
+        attr_accessor :errorDescription
+        alias_method  :error_description,  :errorDescription
+        alias_method  :error_description=, :errorDescription=
+
+        attr_accessor :errorUri
+        alias_method  :error_uri,  :errorUri
+        alias_method  :error_uri=, :errorUri=
+
+        private
+
+        def defaults
+          {
+            ticket:           nil,
+            reason:           nil,
+            errorDescription: nil,
+            errorUri:         nil
+          }
+        end
+
+        def set_params(hash)
+          @ticket           = hash[:ticket]
+          @reason           = hash[:reason]
+          @errorDescription = hash[:errorDescription]
+          @errorUri         = hash[:errorUri]
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/backchannel-authentication-issue-request.rb

@@ -0,0 +1,37 @@
+# :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 Request
+      class BackchannelAuthenticationIssueRequest < Authlete::Model::Request::Base
+
+        attr_accessor :ticket
+
+        private
+
+        def defaults
+          { ticket: nil }
+        end
+
+        def set_params(hash)
+          @ticket = hash[:ticket]
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/backchannel-authentication-request.rb

@@ -0,0 +1,63 @@
+# :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 Request
+      class BackchannelAuthenticationRequest < Authlete::Model::Request::Base
+
+        attr_accessor :parameters
+
+        attr_accessor :clientId
+        alias_method  :client_id,  :clientId
+        alias_method  :client_id=, :clientId=
+
+        attr_accessor :clientSecret
+        alias_method  :client_secret,  :clientSecret
+        alias_method  :client_secret=, :clientSecret=
+
+        attr_accessor :clientCertificate
+        alias_method  :client_certificate,  :clientCertificate
+        alias_method  :client_certificate=, :clientCertificate=
+
+        attr_accessor :clientCertificatePath
+        alias_method  :client_certificate_path, :clientCertificatePath
+        alias_method  :client_certificate_path=, :clientCertificatePath=
+
+        private
+
+        def defaults
+          {
+            parameters:            nil,
+            clientId:              nil,
+            clientSecret:          nil,
+            clientCertificate:     nil,
+            clientCertificatePath: nil
+          }
+        end
+
+        def set_params(hash)
+          @parameters            = hash[:parameters]
+          @clientId              = hash[:clientId]
+          @clientSecret          = hash[:clientSecret]
+          @clientCertificate     = hash[:clientCertificate]
+          @clientCertificatePath = hash[:clientCertificatePath]
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/request/base.rb

@@ -0,0 +1,26 @@
+# :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 Request
+      class Base < Authlete::Model::Base
+        include Authlete::Model::Hashable
+      end
+    end
+  end
+end

data/lib/authlete/model/request/client-authorization-delete-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,109 +15,23 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
     module Request
-      # == Authlete::Model::Request::ClientAuthorizationDeleteRequest class
-      #
-      # This class represents a request to Authlete's /api/client/authorization/delete API.
-      class ClientAuthorizationDeleteRequest < Authlete::Model::Hashable
+      class ClientAuthorizationDeleteRequest < Authlete::Model::Request::Base
 
-        # Unique user ID. (String)
         attr_accessor :subject
 
-        # Start index of search results (inclusive).
-        # (Integer)
-        attr_accessor :start
-
-        # End index of search results (exclusive).
-        # (Integer)
-        attr_accessor :end
-
-        # Unique Developer ID. (String)
-        attr_accessor :developer
-
         private
 
-        # Integer attributes.
-        INTEGER_ATTRIBUTES = ::Set.new([ :start, :end ])
-
-        # String attributes.
-        STRING_ATTRIBUTES = ::Set.new([ :subject, :developer ])
-
-        # The constructor which takes a hash that represents a JSON request
-        # to Authlete's /api/client/authorization/delete 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 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)
-          INTEGER_ATTRIBUTES.include?(key) or
-          STRING_ATTRIBUTES.include?(key)
+        def defaults
+          { subject: nil }
         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, ClientAuthorizationDeleteRequest.new(hash) is returned.
-        def self.parse(hash)
-          if hash.nil? or (hash.kind_of?(Hash) == false)
-            return nil
-          end
-
-          return ClientAuthorizationDeleteRequest.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)
+          @subject = hash[:subject]
         end
       end
     end
   end
-end
+end