authlete 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a8446a852c5b0aece8b3f18a299407ed29e6fa
-  data.tar.gz: c5ead8e2f82f26ab7b9549a75cbd3cd1eb595dc9
+  metadata.gz: db827aa9d47c8832b6f2472046bdf4d7a2eb560a
+  data.tar.gz: 8ca80b2dcb5e7746c69775c860adc9041800cffe
 SHA512:
-  metadata.gz: bf07053faa5d79fb84a58f71f70ed17a41a9700d7bffb8b9b6440ab8c9799f1a1589dd548198838f047bced62b5425d942f94b74cb79317883503aa908cc9290
-  data.tar.gz: 55e6a410992f0e9c8019e70e175da08176bbf2d4adbd4a441e9f8011eb7601c560cd958896cb9f805e0a8ebc43785fdd88d221e38f62ac96146f93ba009bc2c0
+  metadata.gz: d55ae0fe32f6e14a1f79cb832b8554000015e897af58156aae7c8014e5c14d0c864a45941d3c902ea26f608f44f5b4ae05965011c52dfa36cb4d27e9894a0fda
+  data.tar.gz: 1f38e0904b2e68f7d2ef4ecd68311c472c5a3e69853dc00cbad084a3bc746f6524e93f98ab0489ce8c2721303d380c4d9830fffe9ce13e4eeaef41cd02d6c39d

data/lib/authlete.rb

@@ -20,8 +20,7 @@ require 'authlete/version'
 
 # == Authlete Module
 #
-# A library for {Authlete Web APIs}[https://www.authlete.com/authlete_web_apis.html].
-#
+# A library for Authlete Web APIs.
 module Authlete
   autoload :AuthenticationServer, 'authlete/authentication-server'
   autoload :Api, 'authlete/api'
@@ -30,6 +29,7 @@ module Authlete
   autoload :Utility, 'authlete/utility'
 
   module Model
+    autoload :Hashable, 'authlete/model/hashable'
     autoload :Client, 'authlete/model/client'
     autoload :ClientList, 'authlete/model/client-list'
     autoload :Scope, 'authlete/model/scope'
@@ -38,18 +38,18 @@ module Authlete
     autoload :ServiceOwner, 'authlete/model/service-owner'
     autoload :SnsCredentials, 'authlete/model/sns-credentials'
     autoload :TaggedValue, 'authlete/model/tagged-value'
-  end
 
-  module Request
-    autoload :AuthenticationCallbackRequest, 'authlete/request/authentication-callback-request'
-    autoload :DeveloperAuthenticationCallbackRequest, 'authlete/request/developer-authentication-callback-request'
-  end
+    module Request
+      autoload :AuthenticationCallbackRequest, 'authlete/model/request/authentication-callback-request'
+      autoload :DeveloperAuthenticationCallbackRequest, 'authlete/model/request/developer-authentication-callback-request'
+    end
 
-  module Response
-    autoload :AuthenticationCallbackResponse, 'authlete/response/authentication-callback-response'
-    autoload :BaseResponse, 'authlete/response/base-response'
-    autoload :DeveloperAuthenticationCallbackResponse, 'authlete/response/developer-authentication-callback-response'
-    autoload :IntrospectionResponse, 'authlete/response/introspection-response'
-    autoload :ServiceCreatableResponse, 'authlete/response/service-creatable-response'
+    module Response
+      autoload :AuthenticationCallbackResponse, 'authlete/model/response/authentication-callback-response'
+      autoload :Result, 'authlete/model/response/result'
+      autoload :DeveloperAuthenticationCallbackResponse, 'authlete/model/response/developer-authentication-callback-response'
+      autoload :IntrospectionResponse, 'authlete/model/response/introspection-response'
+      autoload :ServiceCreatableResponse, 'authlete/model/response/service-creatable-response'
+    end
   end
-end
+end

data/lib/authlete/api.rb

@@ -69,13 +69,9 @@ module Authlete
     def call_api(method, path, content_type, payload, user, password)
       headers = {}
 
-      if content_type.nil? == false
-        headers.merge!(:content_type => content_type)
-      end
+      headers.merge!(:content_type => content_type) unless content_type.nil?
 
-      if @extra_headers.nil? == false
-        headers.merge!(@extra_headers)
-      end
+      headers.merge!(@extra_headers) unless @extra_headers.nil?
 
       response = execute(
         :method   => method,
@@ -88,11 +84,7 @@ module Authlete
 
       body = body_as_string(response)
 
-      if body.nil?
-        return nil
-      end
-
-      JSON.parse(response.body.to_s, :symbolize_names => true)
+      body.nil? ? nil : JSON.parse(response.body.to_s, :symbolize_names => true)
     end
 
     def execute(parameters)
@@ -151,17 +143,11 @@ module Authlete
     end
 
     def body_as_string(response)
-      if response.body.nil?
-        return nil
-      end
+      return nil if response.body.nil?
 
       body = response.body.to_s
 
-      if body.length == 0
-        return nil
-      end
-
-      return body
+      body.length == 0 ? nil : body
     end
 
     def call_api_service_owner(method, path, content_type, payload)
@@ -213,19 +199,19 @@ module Authlete
         array.push("#{key}=#{value}")
       end
 
-      return "?" + array.join("&")
+      "?" + array.join("&")
     end
 
     public
 
     # Call Authlete's /api/service/creatable API.
     #
-    # On success, an instance of Authlete::Response::ServiceCreatableResponse is returned.
+    # On success, an instance of Authlete::Model::Response::ServiceCreatableResponse is returned.
     # On error, Authlete::Exception is raised.
     def service_creatable(api_key)
       hash = call_api_service_owner(:get, "/api/service/creatable", nil, nil)
 
-      Authlete::Response::ServiceCreatableResponse.new(hash)
+      Authlete::Model::Response::ServiceCreatableResponse.new(hash)
     end
 
     # Call Authlete's /api/service/create API.
@@ -390,9 +376,103 @@ module Authlete
       Authlete::Model::Client.new(hash)
     end
 
-    # Call Authlete's {/auth/introspection}
-    # [https://www.authlete.com/authlete_web_apis_introspection.html#auth_introspection]
-    # API.
+    # Call Authlete's /api/auth/authorization API.
+    #
+    # On success, an instance of Authlete::Model::Response::AuthorizationResponse is returned.
+    # On error, Authlete::Exception is raised.
+    def authorization(request)
+      if request.kind_of?(Hash) == false
+        if request.respond_to?('to_hash')
+          request = request.to_hash
+        end
+      end
+
+      hash = call_api_json_service("/api/auth/authorization", request)
+
+      Authlete::Model::Response::AuthorizationResponse.new(hash)
+    end
+
+    # Call Authlete's /api/auth/authorization/issue API.
+    #
+    # On success, an instance of Authlete::Model::Response::AuthorizationIssueResponse is returned.
+    # On error, Authlete::Exception is raised.
+    def authorization_Issue(request)
+      if request.kind_of?(Hash) == false
+        if request.respond_to?('to_hash')
+          request = request.to_hash
+        end
+      end
+
+      hash = call_api_json_service("/api/auth/authorization/issue", request)
+
+      Authlete::Model::Response::AuthorizationIssueResponse.new(hash)
+    end
+
+    # Call Authlete's /api/auth/authorization/fail API.
+    #
+    # On success, an instance of Authlete::Model::Response::AuthorizationFailResponse is returned.
+    # On error, Authlete::Exception is raised.
+    def authorization_fail(request)
+      if request.kind_of?(Hash) == false
+        if request.respond_to?('to_hash')
+          request = request.to_hash
+        end
+      end
+
+      hash = call_api_json_service("/api/auth/authorization/fail", request)
+
+      Authlete::Model::Response::AuthorizationFailResponse.new(hash)
+    end
+
+    # Call Authlete's /api/auth/token API.
+    #
+    # On success, an instance of Authlete::Model::Response::TokenResponse is returned.
+    # On error, Authlete::Exception is raised.
+    def token(request)
+      if request.kind_of?(Hash) == false
+        if request.respond_to?('to_hash')
+          request = request.to_hash
+        end
+      end
+
+      hash = call_api_json_service("/api/auth/token", request)
+
+      Authlete::Model::Response::TokenResponse.new(hash)
+    end
+
+    # Call Authlete's /api/auth/token/issue API.
+    #
+    # On success, an instance of Authlete::Model::Response::TokenIssueResponse is returned.
+    # On error, Authlete::Exception is raised.
+    def token_issue(request)
+      if request.kind_of?(Hash) == false
+        if request.respond_to?('to_hash')
+          request = request.to_hash
+        end
+      end
+
+      hash = call_api_json_service("/api/auth/token/issue", request)
+
+      Authlete::Model::Response::TokenIssueResponse.new(hash)
+    end
+
+    # Call Authlete's /api/auth/token/fail API.
+    #
+    # On success, an instance of Authlete::Model::Response::TokenFailResponse is returned.
+    # On error, Authlete::Exception is raised.
+    def token_fail(request)
+      if request.kind_of?(Hash) == false
+        if request.respond_to?('to_hash')
+          request = request.to_hash
+        end
+      end
+
+      hash = call_api_json_service("/api/auth/token/fail", request)
+
+      Authlete::Model::Response::TokenFailResponse.new(hash)
+    end
+
+    # Call Authlete's /api/auth/introspection API.
     #
     # <tt>token</tt> is an access token presented by a client application.
     # This is a must parameter. In a typical case, a client application uses
@@ -409,13 +489,13 @@ module Authlete
     # subject, Authlete prepares the content of the error response.
     #
     # On success, this method returns an instance of
-    # <tt>Authlete::Response::IntrospectionResponse</tt>. On error, this method
+    # <tt>Authlete::Model::Response::IntrospectionResponse</tt>. On error, this method
     # throws <tt>RestClient::Exception</tt>.
     def introspection(token, scopes = nil, subject = nil)
       hash = call_api_json_service('/api/auth/introspection',
                                    :token => token, :scopes => scopes, :subject => subject)
 
-      Authlete::Response::IntrospectionResponse.new(hash)
+      Authlete::Model::Response::IntrospectionResponse.new(hash)
     end
 
 
@@ -423,7 +503,7 @@ module Authlete
     #
     # This method extracts an access token from the given request based on the
     # rules described in RFC 6750 and introspects the access token by calling
-    # Authlete's /auth/introspection API.
+    # Authlete's /api/auth/introspection API.
     #
     # The first argument <tt>request</tt> is a Rack request.
     #
@@ -435,7 +515,7 @@ module Authlete
     # is optional.
     #
     # This method returns an instance of
-    # <tt>Authlete::Response::IntrospectionResponse</tt>. If its <tt>action</tt>
+    # <tt>Authlete::Model::Response::IntrospectionResponse</tt>. If its <tt>action</tt>
     # method returns 'OK', it means that the access token exists, has not
     # expired, covers the requested scopes (if specified), and is associated
     # with the requested subject (if specified). Otherwise, it means that the
@@ -448,31 +528,31 @@ module Authlete
       # If the request does not contain any access token.
       if access_token.nil?
         # The request does not contain a valid access token.
-        return Authlete::Response::IntrospectionResponse.new(
+        return Authlete::Model::Response::IntrospectionResponse.new(
           :action          => 'BAD_REQUEST',
           :responseContent => 'Bearer error="invalid_token",error_description="The request does not contain a valid access token."'
         )
       end
 
       begin
-        # Call Authlete's /auth/introspection API to introspect the access token.
+        # Call Authlete's /api/auth/introspection API to introspect the access token.
         result = introspection(access_token, scopes, subject)
       rescue => e
         # Error message.
-        message = build_error_message('/auth/introspection', e)
+        message = build_error_message('/api/auth/introspection', e)
 
         # Emit a Rack error message.
         emit_rack_error_message(request, message)
 
         # Failed to introspect the access token.
-        return Authlete::Response::IntrospectionResponse.new(
+        return Authlete::Model::Response::IntrospectionResponse.new(
           :action          => 'INTERNAL_SERVER_ERROR',
           :responseContent => "Bearer error=\"server_error\",error_description=\"#{message}\""
         )
       end
 
-      # Return the response from Authlete's /auth/introspection API.
+      # Return the response from Authlete's /api/auth/introspection API.
       result
     end
   end
-end
+end

data/lib/authlete/authentication-server.rb

@@ -67,7 +67,7 @@ module Authlete
       end
 
       # Prepare an empty response.
-      res = Authlete::Response::AuthenticationCallbackResponse.new
+      res = Authlete::Model::Response::AuthenticationCallbackResponse.new
 
       # Let the subclass authenticate the end-user.
       # When authenticated successfully, a non-nil value is returned.
@@ -163,7 +163,7 @@ module Authlete
       json = request.body.read
 
       # Parse the authentication callback request.
-      Authlete::Request::AuthenticationCallbackRequest.parse(json)
+      Authlete::Model::Request::AuthenticationCallbackRequest.parse(json)
     end
 
     protected
@@ -184,7 +184,7 @@ module Authlete
     # This default implementation returns nil, meaning 'invalid end-user'.
     #
     # The argument of this method is an instance of
-    # <tt>Authlete::Request::AuthenticationCallbackRequest</tt>.
+    # <tt>Authlete::Model::Request::AuthenticationCallbackRequest</tt>.
     # When the end-user is successfully authenticated, this method must
     # return a unique identifier (= subject) of the end-user. Otherwise,
     # nil must be returned to indicate authentication failure.
@@ -197,7 +197,7 @@ module Authlete
     # method. This default implementation returns nil, meaning 'no claim values'.
     #
     # The argument of this method is an instance of
-    # <tt>Authlete::Request::AuthenticationCallbackRequest</tt> and the subject
+    # <tt>Authlete::Model::Request::AuthenticationCallbackRequest</tt> and the subject
     # which has been returned from the preceding call of <tt>authenticate_user</tt>
     # method.
     #

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

@@ -1,181 +1,127 @@
-# :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 ClientList
-      # The start index (inclusive) of the clients in this list.
-      attr_accessor :start
-
-      # The end index (exclusive) of the clients in this list.
-      attr_accessor :end
-
-      # The total count of clients.
-      attr_accessor :totalCount
-      alias_method  :total_count,  :totalCount
-      alias_method  :total_count=, :totalCount=
-
-      # The list of clients.
-      attr_accessor :clients
-
-      private
-
-      # Integer attributes.
-      INTEGER_ATTRIBUTES = ::Set.new([:start, :end, :totalCount])
-
-      # Mapping from snake cases to camel cases.
-      SNAKE_TO_CAMEL = { :total_count => :totalCount }
-
-      # The constructor
-      def initialize(hash = nil)
-        # Set default values to integer attributes.
-        INTEGER_ATTRIBUTES.each do |attr|
-          send("#{attr}=", 0)
-        end
-
-        @clients = nil
-
-        # Set attribute values using the given hash.
-        authlete_model_clientList_update(hash)
-      end
-
-      def authlete_model_clientList_to_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_clientList_simple_attribute?(key)
-        INTEGER_ATTRIBUTES.include?(key)
-      end
-
-      def authlete_model_clientList_update(hash)
-        if hash.nil?
-          return
-        end
-
-        hash.each do |key, value|
-          key = authlete_model_clientList_to_key(key)
-
-          # If the attribute is a simple one.
-          if authlete_model_clientList_simple_attribute?(key)
-            send("#{key}=", value)
-            next
-          end
-
-          if key == :clients
-            # The attribute 'clients'.
-            @clients = authlete_model_clientList_parse_array(value) do |element|
-              Authlete::Model::Client.parse(element)
-            end
-          end
-        end
-
-        return self
-      end
-
-      def authlete_model_clientList_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
-      end
-
-      public
-
-      # Construct an instance from the given hash.
-      #
-      # If the given argument is nil or is not a Hash, nil is returned.
-      # Otherwise, ClientList.new(hash) is returned.
-      def self.parse(hash)
-        if hash.nil? or (hash.kind_of?(Hash) == false)
-          return nil
-        end
-
-        return ClientList.new(hash)
-      end
-
-      # Set attribute values using the given hash.
-      def update(hash)
-        authlete_model_clientList_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_clientList_simple_attribute?(key) or val.nil?
-            hash[key] = val
-          elsif val.kind_of?(Array)
-            hash[key] = val.map {|element| element.to_hash}
-          end
-        end
-
-        return hash
-      end
-
-      def [](key)
-        key = authlete_model_clientList_to_key(key)
-
-        if respond_to?(key)
-          return send(key)
-        else
-          return nil
-        end
-      end
-
-      def []=(key, value)
-        key = authlete_model_clientList_to_key(key)
-        method = "#{key}="
-
-        if respond_to?(method)
-          return send(method, value)
-        else
-          return nil
-        end
-      end
-    end
-  end
-end
-
+# :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 ClientList < Authlete::Model::Hashable
+      include Authlete::Utility
+      # The start index (inclusive) of the clients in this list.
+      attr_accessor :start
+
+      # The end index (exclusive) of the clients in this list.
+      attr_accessor :end
+
+      # The total count of clients.
+      attr_accessor :totalCount
+      alias_method  :total_count,  :totalCount
+      alias_method  :total_count=, :totalCount=
+
+      # The list of clients.
+      attr_accessor :clients
+
+      private
+
+      # Integer attributes.
+      INTEGER_ATTRIBUTES = ::Set.new([ :start, :end, :totalCount ])
+
+      # Mapping from snake cases to camel cases.
+      SNAKE_TO_CAMEL = { :total_count => :totalCount }
+
+      # The constructor
+      def initialize(hash = nil)
+        # Set default values to integer attributes.
+        INTEGER_ATTRIBUTES.each do |attr|
+          send("#{attr}=", 0)
+        end
+
+        @clients = nil
+
+        # 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)
+        INTEGER_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 key == :clients
+            # Get an array consisting of "Client" objects.
+            @clients = get_parsed_array(value) do |element|
+              Authlete::Model::Client.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, ClientList.new(hash) is returned.
+      def self.parse(hash)
+        if hash.nil? or (hash.kind_of?(Hash) == false)
+          return nil
+        end
+
+        return ClientList.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)
+
+          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 }
+          end
+        end
+
+        hash
+      end
+    end
+  end
+end