authlete 1.0.21 → 1.2.0

data/lib/authlete/model/hashable.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,49 +17,29 @@
 
 module Authlete
   module Model
-    class Hashable
+    module Hashable
+
       private
 
-      def authlete_model_convert_key(key)
+      def to_hash_key(var)
+        var.to_s.delete("@").to_sym
       end
 
-      def authelte_model_simple_attribute?(key)
+      def to_hash_value(key, var)
+        instance_variable_get(var)
       end
 
-      def authlete_model_update(hash)
+      def to_key_value_pair(var)
+        key   = to_hash_key(var)
+        value = to_hash_value(key, var)
+        [ key, value ]
       end
 
       public
 
-      # Convert this object into a hash.
       def to_hash
-      end
-
-      # Set attribute values using the given hash.
-      def update(hash = {})
-        authlete_model_update(hash)
-      end
-
-      def [](key)
-        key = authlete_model_convert_key(key)
-
-        if respond_to?(key)
-          send(key)
-        else
-          nil
-        end
-      end
-
-      def []=(key, value)
-        key = authlete_model_convert_key(key)
-        method = "#{key}="
-
-        if respond_to?(method)
-          send(method, value)
-        else
-          nil
-        end
+        Hash[ instance_variables.map { |var| to_key_value_pair(var) } ]
       end
     end
   end
-end
+end

data/lib/authlete/model/named-uri.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,89 +15,28 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
-    class NamedUri < Authlete::Model::Hashable
-      include Authlete::Utility
-      # The name of the URI. (String)
+    class NamedUri < Authlete::Model::Base
+      include Authlete::Model::Hashable
+
       attr_accessor :name
 
-      # The value of the URI. (String)
       attr_accessor :uri
 
       private
 
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([ :name, :uri ])
-
-      # 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.to_sym
-      end
-
-      def authlete_model_simple_attribute?(key)
-        STRING_ATTRIBUTES.include?(key)
+      def defaults
+        {
+          name: nil,
+          uri:  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, NamedUri.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        Authlete::Model::NamedUri.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)
+        @name = hash[:name]
+        @uri  = hash[:uri]
       end
     end
   end
-end
+end

data/lib/authlete/model/pair.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,89 +15,28 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
-    class Pair < Authlete::Model::Hashable
-      include Authlete::Utility
-      # The key of this pair. (String)
+    class Pair < Authlete::Model::Base
+      include Authlete::Model::Hashable
+
       attr_accessor :key
 
-      # The value of this pair. (String)
       attr_accessor :value
 
       private
 
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([ :key, :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)
-      end
-
-      def authlete_model_convert_key(key)
-        key.to_sym
-      end
-
-      def authlete_model_simple_attribute?(key)
-        STRING_ATTRIBUTES.include?(key)
+      def defaults
+        {
+          key:   nil,
+          value: 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, Pair.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        Authlete::Model::Pair.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)
+        @key   = hash[:key]
+        @value = hash[:value]
       end
     end
   end
-end
+end

data/lib/authlete/model/param-initializer.rb

@@ -0,0 +1,45 @@
+# :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 ParamInitializer
+
+    private
+
+    def initialize(hash = {})
+      set_params( merge_hash(hash) )
+    end
+
+    def merge_hash(hash)
+      hash.kind_of?(Hash) ? defaults.merge( normalize_hash_key(hash) ) : defaults
+    end
+
+    def normalize_hash_key(hash)
+      Hash[ hash.map{ |(k, v)| [ k.to_sym, v ] } ]
+    end
+
+    #
+    # Override this method.
+    #
+    def set_params(hash); end
+
+    #
+    # Override this method.
+    #
+    def defaults; end
+  end
+end

data/lib/authlete/model/property.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,102 +15,32 @@
 # limitations under the License.
 
 
-require 'set'
-
-
 module Authlete
   module Model
-    class Property < Authlete::Model::Hashable
-      include Authlete::Utility
-      # The key part. (String)
+    class Property < Authlete::Model::Base
+      include Authlete::Model::Hashable
+
       attr_accessor :key
 
-      # The value part. (String)
       attr_accessor :value
 
-      # The flag to indicate whether this property hidden from or visible
-      # to client applications. (Boolean)
       attr_accessor :hidden
 
       private
 
-      # Boolean attributes.
-      BOOLEAN_ATTRIBUTES = ::Set.new([ :hidden ])
-
-      # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([ :key, :value ])
-
-      # 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 attribute values using the given hash.
-        authlete_model_update(hash)
+      def defaults
+        {
+          key:    nil,
+          value:  nil,
+          hidden: false
+        }
       end
 
-      def authlete_model_convert_key(key)
-        key.to_sym
-      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)
-          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, Property.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        Authlete::Model::Property.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)
+        @key    = hash[:key]
+        @value  = hash[:value]
+        @hidden = hash[:hidden]
       end
     end
   end
-end
+end