authlete 1.0.20 → 1.1.0

data/lib/authlete/model/result.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,29 +17,30 @@
 
 module Authlete
   module Model
-    # == Authlete::Model::Result
-    #
-    # The base class of responses from Authlete Web APIs.
-    class Result
+    class Result < Authlete::Model::Base
       include Authlete::Utility
-      # The code assigned to the result of the API call.
-      # (String)
+
       attr_accessor :resultCode
       alias_method  :result_code, :resultCode
       alias_method  :result_code=, :resultCode=
 
-      # The message about the result of the API call.
-      # (String)
       attr_accessor :resultMessage
       alias_method  :result_message, :resultMessage
       alias_method  :result_message=, :resultMessage=
 
       private
 
-      def initialize(hash = {})
-        @resultCode    = extract_value(hash, :resultCode)
-        @resultMessage = extract_value(hash, :resultMessage)
+      def defaults
+        {
+          resultCode:    nil,
+          resultMessage: nil
+        }
+      end
+
+      def set_params(hash)
+        @resultCode    = hash[:resultCode]
+        @resultMessage = hash[:resultMessage]
       end
     end
   end
-end
+end

data/lib/authlete/model/scope.rb

@@ -1,158 +1,68 @@
-# :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
-    class Scope < Authlete::Model::Hashable
-      include Authlete::Utility
-      # The attributes of this scopes. (Pair array)
-      attr_accessor :attributes
-
-      # The description about this scope. (String)
-      attr_accessor :description
-
-      # The descriptions about this scope with language tags.
-      # (TaggedValue array)
-      attr_accessor :descriptions
-
-      # The name of this scope. (String)
-      attr_accessor :name
-
-      # The flag to indicate whether this scope is included in the
-      # default scope set. (Boolean)
-      attr_accessor :defaultEntry
-      alias_method  :default_entry,  :defaultEntry
-      alias_method  :default_entry=, :defaultEntry=
-
-      private
-
-      # Boolean attributes.
-      BOOLEAN_ATTRIBUTES = ::Set.new([ :defaultEntry ])
-
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([ :description, :name ])
-
-      # Tagged value array attributes.
-      TAGGED_VALUE_ARRAY_ATTRIBUTES = ::Set.new([ :descriptions ])
-
-      # Mapping from snake cases to camel cases.
-      SNAKE_TO_CAMEL = { :default_entry => :defaultEntry }
-
-      # The constructor
-      def initialize(hash = nil)
-        # Set default values to boolean attributes.
-        BOOLEAN_ATTRIBUTES.each do |attr|
-          send("#{attr}=", false)
-        end
-
-        # Set default values to string attributes.
-        STRING_ATTRIBUTES.each do |attr|
-          send("#{attr}=", nil)
-        end
-
-        # Set default values to tagged value array attributes.
-        TAGGED_VALUE_ARRAY_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)
-        BOOLEAN_ATTRIBUTES.include?(key) or
-        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)
-          elsif TAGGED_VALUE_ARRAY_ATTRIBUTES.include?(key)
-            # Get an array consisting of "TaggedValue" objects.
-            parsed = get_parsed_array(value) do |element|
-              Authlete::Model::TaggedValue.parse(element)
-            end
-
-            send("#{key}=", parsed)
-          elsif key == :attributes
-            @attributes = get_parsed_array(value) do |element|
-              Authlete::Model::Pair.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, Scope.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        Authlete::Model::Scope.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)
-
-          if authlete_model_simple_attribute?(key) or val.nil?
-            hash[key] = val
-          elsif key == :attributes or key == :descriptions
-            hash[key] = val.map { |element| element.to_hash }
-          end
-        end
-
-        hash
-      end
-    end
-  end
-end
+# :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
+    class Scope < Authlete::Model::Base
+      include Authlete::Model::Hashable
+      include Authlete::Utility
+
+      attr_accessor :name
+
+      attr_accessor :defaultEntry
+      alias_method  :default_entry,  :defaultEntry
+      alias_method  :default_entry=, :defaultEntry=
+
+      attr_accessor :description
+
+      attr_accessor :descriptions
+
+      attr_accessor :attributes
+
+      private
+
+      def defaults
+        {
+          name:          nil,
+          defaultEntry:  false,
+          description:   nil,
+          descriptions:  nil,
+          attributes:    nil
+        }
+      end
+
+      def set_params(hash)
+        @name         = hash[:name]
+        @defaultEntry = hash[:defaultEntry]
+        @description  = hash[:description]
+        @descriptions = get_parsed_array(hash[:descriptions]) { |e| Authlete::Model::TaggedValue.parse(e) }
+        @attributes   = get_parsed_array(hash[:attributes]) { |e| Authlete::Model::Pair.parse(e) }
+      end
+
+      def to_hash_value(key, var)
+        raw_val = instance_variable_get(var)
+
+        case key
+          when :descriptions, :attributes
+            raw_val&.map { |e| e.to_hash }
+          else
+            raw_val
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/service-owner.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,139 +15,55 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
-    class ServiceOwner < Authlete::Model::Hashable
-      # The API key of the service owner. (Long)
-      attr_accessor :apiKey
-      alias_method  :api_key,  :apiKey
-      alias_method  :api_key=, :apiKey=
+    class ServiceOwner < Authlete::Model::Base
+      include Authlete::Model::Hashable
+      include Authlete::Utility
 
-      # The API secret of the service owner. (String)
-      attr_accessor :apiSecret
-      alias_method  :api_secret,  :apiSecret
-      alias_method  :api_secret=, :apiSecret=
+      attr_accessor :number
+
+      attr_accessor :name
 
-      # The email address of the service owner. (String)
       attr_accessor :email
 
-      # The login ID of the service owner. (String)
       attr_accessor :loginId
       alias_method  :login_id,  :loginId
       alias_method  :login_id=, :loginId=
 
-      # The service owner name. (String)
-      attr_accessor :name
+      attr_accessor :apiKey
+      alias_method  :api_key,  :apiKey
+      alias_method  :api_key=, :apiKey=
 
-      # The service owner number. (Integer)
-      attr_accessor :number
+      attr_accessor :apiSecret
+      alias_method  :api_secret,  :apiSecret
+      alias_method  :api_secret=, :apiSecret=
 
-      # The plan. (String)
       attr_accessor :plan
 
       private
 
-      # Integer attributes.
-      INTEGER_ATTRIBUTES = ::Set.new([
-        :apiKey, :number
-      ])
-
-
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([
-        :apiSecret, :email, :loginId, :name, :plan
-      ])
-
-      # Mapping from snake cases to camel cases.
-      SNAKE_TO_CAMEL = {
-        :api_key     => :apiKey,
-        :api_secret  => :apiSecret,
-        :login_id    => :loginId
-      }
-
-      # The constructor
-      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 = key.to_sym
-
-        # Convert snakecase to camelcase, if necessary.
-        if SNAKE_TO_CAMEL.has_key?(key)
-          key = SNAKE_TO_CAMEL[key]
-        end
-
-        return key
-      end
-
-      def authlete_model_simple_attribute?(key)
-        INTEGER_ATTRIBUTES.include?(key) or
-        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, ServiceOwner.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        ServiceOwner.new(hash)
+      def defaults
+        {
+          number:    0,
+          name:      nil,
+          email:     nil,
+          loginId:   nil,
+          apiKey:    nil,
+          apiSecret: nil,
+          plan:      nil
+        }
       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)
-
-          if authlete_model_simple_attribute?(key) or val.nil?
-            hash[key] = val
-          end
-        end
-
-        hash
+      def set_params(hash)
+        @number    = hash[:number]
+        @name      = hash[:name]
+        @email     = hash[:email]
+        @loginId   = hash[:loginId]
+        @apiKey    = hash[:apiKey]
+        @apiSecret = hash[:apiSecret]
+        @plan      = hash[:plan]
       end
     end
   end
-end
+end