authlete 1.0.21 → 1.2.0

data/lib/authlete/model/sns-credentials.rb

@@ -1,124 +1,51 @@
-# :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 SnsCredentials < Authlete::Model::Hashable
-      # The API key. (String)
-      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
-      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
-      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 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=
+
+      attr_accessor :apiSecret
+      alias_method  :api_secret,  :apiSecret
+      alias_method  :api_secret=, :apiSecret=
+
+      private
+
+      def defaults
+        {
+          sns:       nil,
+          apiKey:    nil,
+          apiSecret: nil
+        }
+      end
+
+      def set_params(hash)
+        @sns       = hash[:sns]
+        @apiKey    = hash[:apiKey]
+        @apiSecret = hash[:apiSecret]
+      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,99 +1,70 @@
-# :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 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']
-
-      if /^Bearer[ ]+(.+)/i =~ header
-        return $1
-      end
-
-      request['access_token']
-    end
-
-    def get_parsed_array(array)
-      if array.nil? or (array.kind_of?(Array) == false) or (array.empty?)
-        return nil
-      end
-
-      elements = []
-
-      array.each do |element|
-        parsed_element = yield(element)
-        elements.push(parsed_element) unless parsed_element.nil?
-      end
-
-      elements.empty? ? nil : elements
-    end
-
-    def to_rack_response_json(status_code, content)
-      [
-        status_code,
-        {
-          'Content-Type'  => 'application/json;charset=UTF-8',
-          'Cache-Control' => 'no-store',
-          'Pragma'        => 'no-cache'
-        },
-        [
-          content
-        ]
-      ]
-    end
-
-    def to_rack_response_www_authenticate(status_code, content)
-      [
-        status_code,
-        {
-          'WWW-Authenticate' => content,
-          'Cache-Control'    => 'no-store',
-          'Pragma'           => 'no-cache'
-        },
-        nil
-      ]
-    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 Utility
+    # Extract an access token (RFC 6750)
+    def extract_access_token(request)
+      header = request.env['HTTP_AUTHORIZATION']
+
+      if /^Bearer[ ]+(.+)/i =~ header
+        return $1
+      end
+
+      request['access_token']
+    end
+
+    def get_parsed_array(array)
+      return nil if !array.kind_of?(Array) or array.empty?
+
+      elements = []
+
+      array.each do |element|
+        parsed_element = yield(element)
+        elements.push(parsed_element) unless parsed_element.nil?
+      end
+
+      elements.empty? ? nil : elements
+    end
+
+    def to_rack_response_json(status_code, content)
+      [
+        status_code,
+        {
+          'Content-Type'  => 'application/json;charset=UTF-8',
+          'Cache-Control' => 'no-store',
+          'Pragma'        => 'no-cache'
+        },
+        [
+          content
+        ]
+      ]
+    end
+
+    def to_rack_response_www_authenticate(status_code, content)
+      [
+        status_code,
+        {
+          'WWW-Authenticate' => content,
+          'Cache-Control'    => 'no-store',
+          'Pragma'           => 'no-cache'
+        },
+        nil
+      ]
+    end
+  end
+end