authlete 1.0.22 → 1.3.0

data/lib/authlete/model/sns-credentials.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,110 +15,37 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
-    class SnsCredentials < Authlete::Model::Hashable
-      # The API key. (String)
+    class SnsCredentials < Authlete::Model::Base
+      include Authlete::Model::Hashable
+      include Authlete::Utility
+
+      attr_accessor :sns
+
       attr_accessor :apiKey
       alias_method  :api_key,  :apiKey
       alias_method  :api_key=, :apiKey=
 
-      # The API secret. (String)
       attr_accessor :apiSecret
       alias_method  :api_secret,  :apiSecret
       alias_method  :api_secret=, :apiSecret=
 
-      # The SNS. (String)
-      #
-      # Currently, the only valid value is "FACEBOOK".
-      attr_accessor :sns
-
       private
 
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([ :apiKey, :apiSecret, :sns ])
-
-      # Mapping from snake cases to camel cases.
-      SNAKE_TO_CAMEL = {
-        :api_key    => :apiKey,
-        :api_secret => :apiSecret
-      }
-
-      # The constructor.
-      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 = 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)
-        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
+      def defaults
+        {
+          sns:       nil,
+          apiKey:    nil,
+          apiSecret: nil
+        }
       end
 
-      public
-
-      # Construct an instance from the given hash.
-      #
-      # If the given argument is nil or is not a Hash, nil is returned.
-      # Otherwise, SnsCredentials.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        Authlete::Model::SnsCredentials.new(hash)
-      end
-
-      # Set attribute values using the given hash.
-      def update(hash)
-        authlete_model_update(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)
-
-          hash[key] = val
-        end
-
-        hash
+      def set_params(hash)
+        @sns       = hash[:sns]
+        @apiKey    = hash[:apiKey]
+        @apiSecret = hash[:apiSecret]
       end
     end
   end
-end
+end

data/lib/authlete/model/tagged-value.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,84 +15,29 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
-    class TaggedValue < Authlete::Model::Hashable
-      # The language tag part. (String)
+    class TaggedValue < Authlete::Model::Base
+      include Authlete::Model::Hashable
+      include Authlete::Utility
+
       attr_accessor :tag
 
-      # The value part. (String)
       attr_accessor :value
 
       private
 
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([ :tag, :value ])
-
-      # The constructor
-      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
+        {
+          tag:   nil,
+          value: 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 the attribute is a simple one.
-          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, TaggedValue.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        Authlete::Model::TaggedValue.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)
-
-          hash[key] = val
-        end
-
-        hash
+      def set_params(hash)
+        @tag   = hash[:tag]
+        @value = hash[:value]
       end
     end
   end
-end
+end

data/lib/authlete/utility.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.
@@ -17,33 +17,6 @@
 
 module Authlete
   module Utility
-    def extract_value(hash, key)
-      if hash.has_key?(key)
-        hash[key]
-      else
-        hash[key.to_s]
-      end
-    end
-
-    def extract_integer_value(hash, key)
-      extract_value(hash, key).to_i
-    end
-
-    def extract_boolean_value(hash, key)
-      value = extract_value(hash, key)
-      (value == true || value == 'true')
-    end
-
-    def extract_array_value(hash, key)
-      array = extract_value(hash, key)
-
-      # Parse each of the elements in the array.
-      # Then, put them into an array.
-      get_parsed_array(array) do |element|
-        yield(element)
-      end
-    end
-
     # Extract an access token (RFC 6750)
     def extract_access_token(request)
       header = request.env['HTTP_AUTHORIZATION']
@@ -56,9 +29,7 @@ module Authlete
     end
 
     def get_parsed_array(array)
-      if array.nil? or (array.kind_of?(Array) == false) or (array.empty?)
-        return nil
-      end
+      return nil if !array.kind_of?(Array) or array.empty?
 
       elements = []
 
@@ -96,4 +67,4 @@ module Authlete
       ]
     end
   end
-end
+end

data/lib/authlete/version.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2019 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.
@@ -16,5 +16,5 @@
 
 
 module Authlete
-  VERSION = "1.0.22"
-end
+  VERSION = "1.3.0"
+end

data/test/authlete/model/request/test_authentication-callback-request.rb

@@ -0,0 +1,100 @@
+# :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.
+
+
+require 'authlete'
+require 'minitest/autorun'
+
+
+class AuthenticationCallbackRequestTest < Minitest::Test
+  SERVICE_API_KEY    = '<service-api-key>'
+  CLIENT_ID          = 12345
+  ID                 = '<id>'
+  PASSWORD           = '<password>'
+  CLAIMS             = [ 'claim0', 'claim1' ]
+  CLAIMS_LOCALES     = [ 'en', 'ja' ]
+  SNS                = 'FACEBOOK'
+  ACCESS_TOKEN       = '<access-token>'
+  REFRESH_TOKEN      = '<refresh-token>'
+  EXPIRES_IN         = 30000
+  RAW_TOKEN_RESPONSE = '<raw-token-response>'
+
+
+  def set_params(obj)
+    obj.service_api_key    = SERVICE_API_KEY
+    obj.client_id          = CLIENT_ID
+    obj.id                 = ID
+    obj.password           = PASSWORD
+    obj.claims             = CLAIMS
+    obj.claims_locales     = CLAIMS_LOCALES
+    obj.sns                = SNS
+    obj.access_token       = ACCESS_TOKEN
+    obj.refresh_token      = REFRESH_TOKEN
+    obj.expires_in         = EXPIRES_IN
+    obj.raw_token_response = RAW_TOKEN_RESPONSE
+  end
+
+
+  def match(obj)
+    assert_equal SERVICE_API_KEY,    obj.serviceApiKey
+    assert_equal CLIENT_ID,          obj.clientId
+    assert_equal ID,                 obj.id
+    assert_equal PASSWORD,           obj.password
+    assert_equal CLAIMS,             obj.claims
+    assert_equal CLAIMS_LOCALES,     obj.claimsLocales
+    assert_equal SNS,                obj.sns
+    assert_equal ACCESS_TOKEN,       obj.accessToken
+    assert_equal REFRESH_TOKEN,      obj.refreshToken
+    assert_equal EXPIRES_IN,         obj.expiresIn
+    assert_equal RAW_TOKEN_RESPONSE, obj.rawTokenResponse
+  end
+
+
+  def generate_hash
+    {
+      serviceApiKey:    '<service-api-key>',
+      clientId:         12345,
+      id:               '<id>',
+      password:         '<password>',
+      claims:           [ 'claim0', 'claim1' ],
+      claimsLocales:    [ 'en', 'ja' ],
+      sns:              'FACEBOOK',
+      accessToken:      '<access-token>',
+      refreshToken:     '<refresh-token>',
+      expiresIn:        30000,
+      rawTokenResponse: '<raw-token-response>'
+    }
+  end
+
+
+  def test_setters
+    actual = Authlete::Model::Request::AuthenticationCallbackRequest.new
+    set_params(actual)
+
+    match(actual)
+  end
+
+
+  def test_to_hash
+    obj = Authlete::Model::Request::AuthenticationCallbackRequest.new
+    set_params(obj)
+    actual   = obj.to_hash
+    expected = generate_hash
+
+    assert_equal expected, actual
+  end
+end
+

data/test/authlete/model/request/test_authorization-fail-request.rb

@@ -0,0 +1,67 @@
+# :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.
+
+
+require 'authlete'
+require 'minitest/autorun'
+
+
+class AuthorizationFailRequestTest < Minitest::Test
+  TICKET      = '<ticket>'
+  REASON      = 'DENIED'
+  DESCRIPTION = '<description>'
+
+
+  def set_params(obj)
+    obj.ticket      = TICKET
+    obj.reason      = REASON
+    obj.description = DESCRIPTION
+  end
+
+
+  def match(obj)
+    assert_equal TICKET,      obj.ticket
+    assert_equal REASON,      obj.reason
+    assert_equal DESCRIPTION, obj.description
+  end
+
+
+  def generate_hash
+    {
+      ticket:      '<ticket>',
+      reason:      'DENIED',
+      description: '<description>'
+    }
+  end
+
+
+  def test_setters
+    actual = Authlete::Model::Request::AuthorizationFailRequest.new
+    set_params(actual)
+
+    match(actual)
+  end
+
+
+  def test_to_hash
+    obj = Authlete::Model::Request::AuthorizationFailRequest.new
+    set_params(obj)
+    actual   = obj.to_hash
+    expected = generate_hash
+
+    assert_equal expected, actual
+  end
+end