authlete 0.5.1 → 1.0.0

data/lib/authlete/model/hashable.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2015 Authlete, Inc.
+# 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.

data/lib/authlete/model/pair.rb

@@ -1,103 +1,103 @@
-# :nodoc:
-#
-# Copyright (C) 2014-2015 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 Pair < Authlete::Model::Hashable
-      include Authlete::Utility
-      # The key of this pair. (String)
-      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)
-      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, Scope.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
-      end
-    end
-  end
+# :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 Pair < Authlete::Model::Hashable
+      include Authlete::Utility
+      # The key of this pair. (String)
+      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)
+      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
+      end
+    end
+  end
 end

data/lib/authlete/model/property.rb

@@ -0,0 +1,116 @@
+# :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 Property < Authlete::Model::Hashable
+      include Authlete::Utility
+      # The key part. (String)
+      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)
+      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
+      end
+    end
+  end
+end

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

@@ -1,91 +1,91 @@
-# :nodoc:
-#
-# Copyright (C) 2014-2015 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 'json'
-
-
-module Authlete
-  module Model
-    module Request
-      # == Authlete::Model::Request::AuthenticationCallbackRequest class
-      #
-      # This class represents a request to an authentication callback endpoint.
-      class AuthenticationCallbackRequest
-        include Authlete::Utility
-        # The API key of the service.
-        attr_accessor :service_api_key
-
-        # The ID of the client application which has triggered the authentication
-        # callback request.
-        attr_accessor :client_id
-
-        # The login ID that the end-user input to the login ID field.
-        attr_accessor :id
-
-        # The password that the end-user input to the password field.
-        attr_accessor :password
-
-        # Names of requested claims (string array).
-        attr_accessor :claims
-
-        # Names of requested claim locales (string array). The values come
-        # from 'claims_locales' request parameter of an authorization request.
-        attr_accessor :claims_locales
-
-        # The SNS which the end-user used for social login.
-        # For example, 'FACEBOOK'.
-        attr_accessor :sns
-
-        # The access token issued at the token endpoint of the SNS.
-        attr_accessor :access_token
-
-        # The refresh token issued along with the access token.
-        attr_accessor :refresh_token
-
-        # The duration of the access token.
-        attr_accessor :expires_in
-
-        # The raw content of the response from the token endpoint of the SNS.
-        # Correct OAuth 2.0 implementations return 'application/json', but Facebook
-        # returns 'application/x-www-form-url-encoded'.
-        attr_accessor :raw_token_response
-
-        # The constructor which takes a hash that represents a JSON request
-        # to an authentication callback endpoint.
-        def initialize(hash = {})
-          @service_api_key    = extract_value(hash, :serviceApiKey)
-          @client_id          = extract_value(hash, :clientId)
-          @id                 = extract_value(hash, :id)
-          @password           = extract_value(hash, :password)
-          @claims             = extract_value(hash, :claims)
-          @claims_locales     = extract_value(hash, :claimsLocales)
-          @sns                = extract_value(hash, :sns)
-          @access_token       = extract_value(hash, :accessToken)
-          @refresh_token      = extract_value(hash, :refreshToken)
-          @expires_in         = extract_integer_value(hash, :expiresIn)
-          @raw_token_response = extract_value(hash, :rawTokenResponse)
-        end
-
-        # Parse a JSON string which represents a request to an authentication
-        # callback endpoint and generate an instance of AuthenticationCallbackRequest.
-        def self.parse(json)
-          AuthenticationCallbackRequest.new(JSON.parse(json))
-        end
-      end
-    end
-  end
+# :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 'json'
+
+
+module Authlete
+  module Model
+    module Request
+      # == Authlete::Model::Request::AuthenticationCallbackRequest class
+      #
+      # This class represents a request to an authentication callback endpoint.
+      class AuthenticationCallbackRequest
+        include Authlete::Utility
+        # The API key of the service.
+        attr_accessor :service_api_key
+
+        # The ID of the client application which has triggered the authentication
+        # callback request.
+        attr_accessor :client_id
+
+        # The login ID that the end-user input to the login ID field.
+        attr_accessor :id
+
+        # The password that the end-user input to the password field.
+        attr_accessor :password
+
+        # Names of requested claims (string array).
+        attr_accessor :claims
+
+        # Names of requested claim locales (string array). The values come
+        # from 'claims_locales' request parameter of an authorization request.
+        attr_accessor :claims_locales
+
+        # The SNS which the end-user used for social login.
+        # For example, 'FACEBOOK'.
+        attr_accessor :sns
+
+        # The access token issued at the token endpoint of the SNS.
+        attr_accessor :access_token
+
+        # The refresh token issued along with the access token.
+        attr_accessor :refresh_token
+
+        # The duration of the access token.
+        attr_accessor :expires_in
+
+        # The raw content of the response from the token endpoint of the SNS.
+        # Correct OAuth 2.0 implementations return 'application/json', but Facebook
+        # returns 'application/x-www-form-url-encoded'.
+        attr_accessor :raw_token_response
+
+        # The constructor which takes a hash that represents a JSON request
+        # to an authentication callback endpoint.
+        def initialize(hash = {})
+          @service_api_key    = extract_value(hash, :serviceApiKey)
+          @client_id          = extract_value(hash, :clientId)
+          @id                 = extract_value(hash, :id)
+          @password           = extract_value(hash, :password)
+          @claims             = extract_value(hash, :claims)
+          @claims_locales     = extract_value(hash, :claimsLocales)
+          @sns                = extract_value(hash, :sns)
+          @access_token       = extract_value(hash, :accessToken)
+          @refresh_token      = extract_value(hash, :refreshToken)
+          @expires_in         = extract_integer_value(hash, :expiresIn)
+          @raw_token_response = extract_value(hash, :rawTokenResponse)
+        end
+
+        # Parse a JSON string which represents a request to an authentication
+        # callback endpoint and generate an instance of AuthenticationCallbackRequest.
+        def self.parse(json)
+          AuthenticationCallbackRequest.new(JSON.parse(json))
+        end
+      end
+    end
+  end
 end