authlete 0.3.6 → 0.3.7

data/lib/authlete/model/response/result.rb

@@ -0,0 +1,45 @@
+# :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.
+
+
+module Authlete
+  module Model
+    module Response
+      # == Authlete::Model::Response::BaseResponse
+      #
+      # The base class of responses from Authlete Web APIs.
+      class Result
+        include Authlete::Utility
+        # The code assigned to the result of the API call.
+        # (String)
+        attr_accessor :result_code
+
+        # The message about the result of the API call.
+        # (String)
+        attr_accessor :result_message
+
+        private
+
+        # The constructor which takes a hash that represents a JSON response
+        # from /api/auth/introspection API.
+        def initialize(hash = {})
+          @result_code      = extract_value(hash, :resultCode)
+          @response_content = extract_value(hash, :responseContent)
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/service-creatable-response.rb

@@ -0,0 +1,51 @@
+# :nodoc:
+#
+# Copyright (C) 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.
+
+
+module Authlete
+  module Model
+    module Response
+      # == Authlete::Model::Response::ServiceCreatableResponse class
+      class ServiceCreatableResponse
+        include Authlete::Utility
+        # A boolean flag to indicate whether the service owner can
+        # create a new service or not.
+        attr_accessor :creatable
+
+        # The number of services that the service owner currently has.
+        attr_accessor :count
+
+        # The maximum number of services allowed in the plan of the
+        # service owner.
+        attr_accessor :limit
+
+        # The plan of the service owner.
+        attr_accessor :plan
+
+        # The constructor which takes a hash that represents a JSON
+        # response from /api/service/creatable API.
+        def initialize(hash = {})
+          @creatable = extract_boolean_value(hash, :creatable)
+          @count     = extract_value(hash, :count);
+          @limit     = extract_value(hash, :limit);
+          @plan      = extract_value(hash, :plan);
+        end
+
+        alias_method :creatable?, :creatable
+      end
+    end
+  end
+end

data/lib/authlete/model/response/token-fail-response.rb

@@ -0,0 +1,48 @@
+# :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.
+
+
+module Authlete
+  module Model
+    module Response
+      # == Authlete::Model::Response::TokenFailRequest class
+      #
+      # This class represents a response from Authlete's /api/auth/token API.
+      class TokenFailRequest
+        include Authlete::Utility < Authlete::Model::Response::Result
+        # The next action that the service implementation should take.
+        # (String)
+        attr_accessor :action
+
+        # The response content which can be used to generate a response
+        # to the client application. The format of the value varies
+        # depending on the value of "action". (String)
+        attr_accessor :response_content
+
+        private
+
+        # The constructor which takes a hash that represents a JSON response
+        # from Authlete's /api/auth/token/fail API.
+        def initialize(hash = {})
+          super(hash)
+
+          @action           = extract_value(hash, :action)
+          @response_content = extract_value(hash, :responseContent)
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/token-issue-response.rb

@@ -0,0 +1,48 @@
+authorization-response.rb# :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.
+
+
+module Authlete
+  module Model
+    module Response
+      # == Authlete::Model::Response::TokenIssueResponse class
+      #
+      # This class represents a response from Authlete's /api/auth/token/issue API.
+      class TokenIssueResponse < Authlete::Model::Response::Result
+        include Authlete::Utility
+        # The next action that the service implementation should take.
+        # (String)
+        attr_accessor :action
+
+        # The response content which can be used to generate a response
+        # to the client application. The format of the value varies
+        # depending on the value of "action". (String)
+        attr_accessor :response_content
+
+        private
+
+        # The constructor which takes a hash that represents a JSON response
+        # from Authlete's /api/auth/token/issue API.
+        def initialize(hash = {})
+          super(hash)
+
+          @action           = extract_value(hash, :action)
+          @response_content = extract_value(hash, :responseContent)
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/token-response.rb

@@ -0,0 +1,69 @@
+# :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.
+
+
+module Authlete
+  module Model
+    module Response
+      # == Authlete::Model::Response::TokenResponse class
+      #
+      # This class represents a response from Authlete's /api/auth/token API.
+      class TokenResponse < Authlete::Model::Response::Result
+        include Authlete::Utility
+        # The next action that the service implementation should take.
+        # (String)
+        attr_accessor :action
+
+        # The value of "password" request parameter.
+        #
+        # This value is non-null only when the value of
+        # "grant_type" request parameter in the token request is "password".
+        attr_accessor :password
+
+        # The response content which can be used to generate a response
+        # to the client application. The format of the value varies
+        # depending on the value of "action". (String)
+        attr_accessor :response_content
+
+        # The ticket issued from Authlete's /api/auth/token endpoint.
+        # This parameter is to be used as "ticket" request parameter
+        # for /api/auth/token/issue API or /api/auth/token/fail API.
+        # This parameter is non-null only when "action" is "PASSWORD PASSWORD".
+        attr_accessor :ticket
+
+        # The value of "username" request parameter.
+        #
+        # This value is non-null only when the value of
+        # "grant_type" request parameter in the token request is "password".
+        attr_accessor :username
+
+        private
+
+        # The constructor which takes a hash that represents a JSON response
+        # from Authlete's /api/auth/token API.
+        def initialize(hash = {})
+          super(hash)
+
+          @action           = extract_value(hash, :action)
+          @response_content = extract_value(hash, :responseContent)
+          @password         = extract_value(hash, :password)
+          @ticket           = extract_value(hash, :ticket)
+          @username         = extract_value(hash, :username)
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/scope.rb

@@ -20,7 +20,7 @@ require 'set'
 
 module Authlete
   module Model
-    class Scope
+    class Scope < Authlete::Model::Hashable
       # The description about this scope. (String)
       attr_accessor :description
 
@@ -36,13 +36,13 @@ module Authlete
       private
 
       # Boolean attributes.
-      BOOLEAN_ATTRIBUTES = ::Set.new([:defaultEntry])
+      BOOLEAN_ATTRIBUTES = ::Set.new([ :defaultEntry ])
 
       # String attributes.
-      STRING_ATTRIBUTES = ::Set.new([:description, :name])
+      STRING_ATTRIBUTES = ::Set.new([ :description, :name ])
 
       # Mapping from snake cases to camel cases.
-      SNAKE_TO_CAMEL = {:default_entry => :defaultEntry}
+      SNAKE_TO_CAMEL = { :default_entry => :defaultEntry }
 
       # The constructor
       def initialize(hash = new)
@@ -57,10 +57,10 @@ module Authlete
         end
 
         # Set attribute values using the given hash.
-        authlete_model_scope_update(hash)
+        authlete_model_update(hash)
       end
 
-      def authlete_model_scope_to_key(key)
+      def authlete_model_convert_key(key)
         key = key.to_sym
 
         # Convert snakecase to camelcase, if necessary.
@@ -68,30 +68,26 @@ module Authlete
           key = SNAKE_TO_CAMEL[key]
         end
 
-        return key
+        key
       end
 
-      def authlete_model_scope_simple_attribute?(key)
+      def authlete_model_simple_attribute?(key)
         BOOLEAN_ATTRIBUTES.include?(key) or
         STRING_ATTRIBUTES.include?(key)
       end
 
-      def authlete_model_scope_update(hash)
-        if hash.nil?
-          return
-        end
+      def authlete_model_update(hash)
+        return if hash.nil?
 
         hash.each do |key, value|
-          key = authlete_model_scope_to_key(key)
+          key = authlete_model_convert_key(key)
 
-          # If the attribute is a simple one.
-          if authlete_model_scope_simple_attribute?(key)
+          if authlete_model_simple_attribute?(key)
             send("#{key}=", value)
-            next
           end
         end
 
-        return self
+        self
       end
 
       public
@@ -105,12 +101,12 @@ module Authlete
           return nil
         end
 
-        return Authlete::Model::Scope.new(hash)
+        Authlete::Model::Scope.new(hash)
       end
 
       # Set attribute values using the given hash.
       def update(hash)
-        authlete_model_scope_update(hash)
+        authlete_model_update(hash)
       end
 
       # Convert this object into a hash.
@@ -124,29 +120,8 @@ module Authlete
           hash[key] = val
         end
 
-        return hash
-      end
-
-      def [](key)
-        key = authlete_model_scope_to_key(key)
-
-        if respond_to?(key)
-          return send(key)
-        else
-          return nil
-        end
-      end
-
-      def []=(key, value)
-        key = authlete_model_scope_to_key(key)
-        method = "#{key}="
-
-        if respond_to?(method)
-          return send(method, value)
-        else
-          return nil
-        end
+        hash
       end
     end
   end
-end
+end

data/lib/authlete/model/service-list.rb

@@ -20,7 +20,8 @@ require 'set'
 
 module Authlete
   module Model
-    class ServiceList
+    class ServiceList < Authlete::Model::Hashable
+      include Authlete::Utility
       # The start index (inclusive) of the services in this list.
       attr_accessor :start
 
@@ -38,7 +39,7 @@ module Authlete
       private
 
       # Integer attributes.
-      INTEGER_ATTRIBUTES = ::Set.new([:start, :end, :totalCount])
+      INTEGER_ATTRIBUTES = ::Set.new([ :start, :end, :totalCount ])
 
       # Mapping from snake cases to camel cases.
       SNAKE_TO_CAMEL = { :total_count => :totalCount }
@@ -53,10 +54,10 @@ module Authlete
         @services = nil
 
         # Set attribute values using the given hash.
-        authlete_model_serviceList_update(hash)
+        authlete_model_update(hash)
       end
 
-      def authlete_model_serviceList_to_key(key)
+      def authlete_model_convert_key(key)
         key = key.to_sym
 
         # Convert snakecase to camelcase, if necessary.
@@ -64,58 +65,29 @@ module Authlete
           key = SNAKE_TO_CAMEL[key]
         end
 
-        return key
+        key
       end
 
-      def authlete_model_serviceList_simple_attribute?(key)
+      def authlete_model_simple_attribute?(key)
         INTEGER_ATTRIBUTES.include?(key)
       end
 
-      def authlete_model_serviceList_update(hash)
-        if hash.nil?
-          return
-        end
+      def authlete_model_update(hash)
+        return if hash.nil?
 
         hash.each do |key, value|
-          key = authlete_model_serviceList_to_key(key)
+          key = authlete_model_convert_key(key)
 
-          # If the attribute is a simple one.
-          if authlete_model_serviceList_simple_attribute?(key)
+          if authlete_model_simple_attribute?(key)
             send("#{key}=", value)
-            next
-          end
-
-          if key == :services
-            # The attribute 'services'.
-            @services = authlete_model_serviceList_parse_array(value) do |element|
+          elsif key == :services
+            @services = get_parsed_array(value) do |element|
               Authlete::Model::Service.parse(element)
             end
           end
         end
 
-        return self
-      end
-
-      def authlete_model_serviceList_parse_array(array)
-        if array.nil? or (array.kind_of?(Array) == false) or (array.length == 0)
-          return nil
-        end
-
-        elements = []
-
-        array.each do |element|
-          parsed_element = yield(element)
-
-          if parsed_element.nil? == false
-            elements.push(parsed_element)
-          end
-        end
-
-        if elements.length == 0
-          return nil
-        end
-
-        return elements
+        self
       end
 
       public
@@ -129,12 +101,7 @@ module Authlete
           return nil
         end
 
-        return ServiceList.new(hash)
-      end
-
-      # Set attribute values using the given hash.
-      def update(hash)
-        authlete_model_serviceList_update(hash)
+        ServiceList.new(hash)
       end
 
       # Convert this object into a hash.
@@ -145,37 +112,15 @@ module Authlete
           key = var.to_s.delete("@").to_sym
           val = instance_variable_get(var)
 
-          if authlete_model_serviceList_simple_attribute?(key) or val.nil?
+          if authlete_model_simple_attribute?(key) or val.nil?
             hash[key] = val
           elsif val.kind_of?(Array)
-            hash[key] = val.map {|element| element.to_hash}
+            hash[key] = val.map { |element| element.to_hash }
           end
         end
 
-        return hash
-      end
-
-      def [](key)
-        key = authlete_model_serviceList_to_key(key)
-
-        if respond_to?(key)
-          return send(key)
-        else
-          return nil
-        end
-      end
-
-      def []=(key, value)
-        key = authlete_model_serviceList_to_key(key)
-        method = "#{key}="
-
-        if respond_to?(method)
-          return send(method, value)
-        else
-          return nil
-        end
+        hash
       end
     end
   end
-end
-
+end