authlete 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in authlete.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -0,0 +1,20 @@
+authlete-ruby-gem
+=================
+
+# Overview
+
+Ruby library for [Authlete Web APIs](https://www.authlete.com/authlete_web_apis.html).
+
+
+# License
+
+Apache License, Version 2.0
+
+
+# See Also
+
+* [Authlete Website](https://www.authlete.com/)
+* [Authlete Facebook](https://www.facebook.com/authlete)
+* [Authelte Twitter](https://twitter.com/authlete)
+* [Authlete GitHub](https://github.com/authlete)
+* [Authlete Email](mailto:support@authlete.com)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/authlete.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authlete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "authlete"
+  spec.version       = Authlete::VERSION
+  spec.authors       = ["Takahiko Kawasaki"]
+  spec.email         = ["taka@authlete.com"]
+  spec.summary       = "A library for Authlete Web APIs"
+  spec.description   = "A library for Authlete Web APIs. See https://www.authlete.com/authlete_web_apis.html for details."
+  spec.homepage      = "https://www.authlete.com/"
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rest-client", "~> 1.7.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/authlete.rb

@@ -0,0 +1,42 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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 'authlete/version'
+
+
+# == Authlete Module
+#
+# A library for {Authlete Web APIs}[https://www.authlete.com/authlete_web_apis.html].
+#
+module Authlete
+  # The host of Authlete Web APIs for evaluation.
+  HOST_EVALUATION = 'https://evaluation-dot-authlete.appspot.com'
+
+  autoload :AuthenticationServer, 'authlete/authentication-server'
+  autoload :Client, 'authlete/client'
+  autoload :Utility, 'authlete/utility'
+
+  module Request
+    autoload :AuthenticationCallbackRequest, 'authlete/request/authentication-callback-request'
+  end
+
+  module Response
+    autoload :AuthenticationCallbackResponse, 'authlete/response/authentication-callback-response'
+    autoload :BaseResponse, 'authlete/response/base-response'
+    autoload :IntrospectionResponse, 'authlete/response/introspection-response'
+  end
+end

data/lib/authlete/authentication-server.rb

@@ -0,0 +1,221 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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 'rack'
+
+
+module Authlete
+  # == Authlete::AuthenticationServer class
+  #
+  # This class is a base class for an authentication server based on Rack.
+  # Some method must/should be overridden by subclasses.
+  #
+  # 1. <tt>authenticate_api_call</tt>
+  # 2. <tt>authenticate_user</tt>
+  # 3. <tt>collect_claims</tt>
+  # 4. <tt>authentication_callback_endpoint_path</tt>
+  class AuthenticationServer
+    def initialize(app = nil)
+      # Accept 'app' so that this class can work as a Rack middleware
+      # as well as a Rack application.
+      @app = app
+    end
+
+    def call(env)
+      # Request
+      request = Rack::Request.new(env)
+
+      # If the path is different from the name of the authentication
+      # callback endpoint.
+      if request.post? == false || request.path_info != authentication_callback_endpoint_path()
+        # If this class is used as a Rack middleware.
+        if @app && @app.respond_to?(:call)
+          # Call chain to the next Rack middleware.
+          return @app.call(env)
+        else
+          # 404 Not Found
+          return generate_not_found(request)
+        end
+      end
+
+      # Basic Authentication for the API call.
+      authenticated = do_authenticate_api_call(env)
+      if authenticated == false
+        # 401 Unauthorized
+        return generate_api_call_authentication_failure()
+      end
+
+      begin
+        # Parse the request body as AuthenticationCallbackRequest.
+        req = parse_authentication_callback_request(request)
+      rescue => e
+        # 400 Bad Request
+        return generate_authentication_callback_request_format_error(e)
+      end
+
+      # Prepare an empty response.
+      res = Authlete::Response::AuthenticationCallbackResponse.new
+
+      # Let the subclass authenticate the end-user.
+      # When authenticated successfully, a non-nil value is returned.
+      subject = authenticate_user(req)
+      if subject.nil?
+        # End-user authentication failed.
+        # Return {"authenticated": false} to Authlete.
+        res.authenticated = false
+        return res.to_rack_response
+      end
+
+      # The end-user has been authenticated successfully.
+      res.authenticated = true
+      res.subject       = subject
+
+      # Make the subclass collect values of the requested claims.
+      res.claims = collect_claims(req, subject)
+
+      # Return {"authenticated": true, ...} to Authlete.
+      return res.to_rack_response
+    end
+
+    private
+
+    def do_authenticate_api_call(env)
+      # API key and secret for the API call to the authentication endpoint.
+      api_key, api_secret = nil, nil
+
+      # Basic Authentication for the API call.
+      auth = Rack::Auth::Basic::Request.new(env)
+
+      if auth.provided? && auth.basic?
+        api_key, api_secret = *auth.credentials
+      end
+
+      # Let the subclass authenticate the API call.
+      authenticate_api_call(api_key, api_secret)
+    end
+
+    # 404 Not Found
+    def generate_not_found(request)
+      [
+        404,
+        {
+          'Content-Type' => 'text/plain'
+        },
+        [
+          "'#{request.request_method} #{request.path_info}' is not found on this server."
+        ]
+      ]
+    end
+
+    # 401 Unauthorized
+    def generate_api_call_authentication_failure
+      [
+        401,
+        {
+          'Content-Type'     => 'text/plain',
+          'WWW-Authenticate' => 'Basic realm="Authentication Callback Endpoint"'
+        },
+        [
+          'Authentication of the API call to the authentication callback endpoint failed.'
+        ]
+      ]
+    end
+
+    # 400 Bad Request
+    def generate_authentication_callback_request_format_error(exception)
+      p exception
+      [
+        400,
+        {
+          'Content-Type' => 'text/plain',
+        },
+        [
+          'The format of the authentication callback request was wrong.'
+        ]
+      ]
+    end
+
+    def parse_authentication_callback_request(request)
+      # In case someone has already read it.
+      request.body.rewind
+
+      # Parse the authentication callback request.
+      Authlete::Request::AuthenticationCallbackRequest.parse(request.body.read)
+    end
+
+    protected
+
+    # Authenticate the API call to the authentication callback endpoint
+    # from Authlete. Subclasses must override this method. This default
+    # implementation returns false, meaning 'unauthorized API call'.
+    #
+    # The argument of this method is the API key and the API secret that
+    # the caller has presented. When the pair of the API credentials is
+    # valid, return true. Otherwise, return false.
+    def authenticate_api_call(api_key, api_secret)
+      # Unauthorized API call.
+      false
+    end
+
+    # Authenticate the end-user. Subclasses must override this method.
+    # This default implementation returns nil, meaning 'invalid end-user'.
+    #
+    # The argument of this method is an instance of
+    # <tt>Authlete::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.
+    def authenticate_user(req)
+      # Invalid end-user.
+      nil
+    end
+
+    # Collect claim values of the end-user. Subclasses should override this
+    # 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
+    # which has been returned from the preceding call of <tt>authenticate_user</tt>
+    # method.
+    #
+    # 'Claim' is a piece of information about an end-user. A subclass should
+    # collect values of requested claims (<tt>req.claims</tt>) as many as
+    # possible and format them in JSON format like below.
+    #
+    #   {
+    #     "name": "Takahiko Kawasaki",
+    #     "gender": "male"
+    #   }
+    #
+    # Collected claim values are used to generate an {ID token}
+    # [http://openid.net/specs/openid-connect-core-1_0.html#IDToken].
+    #
+    # If no claim values are available, or if you don't want to provide any
+    # claim value, return nil.
+    def collect_claims(req, subject)
+      # No claim values.
+      nil
+    end
+
+    # Get the path of the authentication callback endpoint. This default
+    # implementation returns '/authentication'. Subclasses may override
+    # this method to change the path.
+    def authentication_callback_endpoint_path
+      '/authentication'
+    end
+  end
+end

data/lib/authlete/client.rb

@@ -0,0 +1,120 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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'
+require 'rest-client'
+
+
+module Authlete
+  # == Authlete::Client Module
+  #
+  # A web client that accesses Authlete Web APIs.
+  #
+  class Client
+    include Authlete::Utility
+
+    # The host which provides Authlete Web APIs.
+    # For example, <tt>https://evaluation-dot-authlete.appspot.com</tt>
+    attr_accessor :host
+
+    # The API key of a service owner.
+    attr_accessor :service_owner_api_key
+
+    # The API secret of a service owner.
+    attr_accessor :service_owner_api_secret
+
+    # The API key of a service.
+    attr_accessor :service_api_key
+
+    # The API secret of a service.
+    attr_accessor :service_api_secret
+
+    # The constructor which takes a hash containing configuration
+    # parameters. Valid configuration parameter names are as follows.
+    #
+    # - <tt>:host</tt>
+    # - <tt>:service_owner_api_key</tt>
+    # - <tt>:service_owner_api_secret</tt>
+    # - <tt>:service_api_key</tt>
+    # - <tt>:service_api_secret</tt>
+    #
+    def initialize(config = {})
+      @host                     = extract_value(config, :host)
+      @service_owner_api_key    = extract_value(config, :service_owner_api_key)
+      @service_owner_api_secret = extract_value(config, :service_owner_api_secret)
+      @service_api_key          = extract_value(config, :service_api_key)
+      @service_api_secret       = extract_value(config, :service_api_secret]
+    end
+
+    private
+
+    def call_api(method, path, content_type, payload, user, password)
+      response = RestClient::Request.new(
+        :method   => :method,
+        :url      => @host + path,
+        :headers  => { :content_type => content_type },
+        :payload  => payload,
+        :user     => user,
+        :password => password
+      ).execute
+
+      JSON.parse(response.to_str, :symbolize_names => true)
+    end
+
+    def call_api_json(path, body, user, password)
+      call_api(:post, path, 'application/json;charset=UTF-8', JSON.generate(body), user, password)
+    end
+
+    def call_api_json_servie_owner(path, body)
+      call_api_json(path, body, @service_owner_api_key, @service_owner_api_secret)
+    end
+
+    def call_api_json_service(path, body)
+      call_api_json(path, body, @service_api_key, @service_api_secret)
+    end
+
+    public
+
+    # Call Authlete's {/auth/introspection}
+    # [https://www.authlete.com/authlete_web_apis_introspection.html#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
+    # one of the means listed in {RFC 6750}[https://tools.ietf.org/html/rfc6750]
+    # to present an access token to a {protected resource endpoint}
+    # [https://tools.ietf.org/html/rfc6749#section-7].
+    #
+    # <tt>scopes</tt> is an array of scope names. This is an optional parameter.
+    # When the specified scopes are not covered by the access token, Authlete
+    # prepares the content of the error response.
+    #
+    # <tt>subject</tt> is a unique identifier of an end-user. This is an optional
+    # parameter. When the access token is not associated with the specified
+    # 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
+    # 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)
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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 Request
+    # == Authlete::Request::AuthenticationCallbackRequest class
+    #
+    # This class represents a request to an authentication callback endpoint.
+    class AuthenticationCallbackRequest
+      include Authlete::Utility
+
+      # 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 :claimsLocales
+
+      # The constructor which takes a hash that represents a JSON request
+      # to an authentication callback endpoint.
+      def initialize(hash = {})
+        @id            = extract_value(hash, :id)
+        @password      = extract_value(hash, :password)
+        @claims        = extract_value(hash, :claims)
+        @claimsLocales = extract_value(hash, :claimsLocales)
+      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

data/lib/authlete/response/authentication-callback-response.rb

@@ -0,0 +1,63 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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 Response
+    # == Authlete::Response::AuthenticationCallbackResponse class
+    #
+    # This class represents a response from an authentication callback endpoint.
+    class AuthenticationCallbackResponse
+      include Authlete::Utility
+
+      # True when the end-user has been authenticated (= is a valid user).
+      attr_accessor :authenticated
+
+      # The unique identifier of the end-user.
+      attr_accessor :subject
+
+      # Pieces of information about the end-user in JSON format.
+      attr_accessor :claims
+
+      # The constructor which takes a hash that represents a JSON response
+      # from an authentication callback endpoint.
+      def initialize(hash = {})
+        @authenticated = extract_boolean_value(hash, :authenticated)
+        @subject       = extract_value(hash, :subject)
+        @claims        = extract_value(hash, :claims)
+      end
+
+      # Generate an array which is usable as a Rack response from this instance.
+      def to_rack_response
+        [
+          200,
+          {
+            'Content-Type'  => 'application/json;charset=UTF-8',
+            'Cache-Control' => 'no-store',
+            'Pragma'        => 'no-cache'
+          },
+          [
+            JSON.generate(
+              :authenticated => @authenticated,
+              :subject       => @subject,
+              :claims        => @claims
+            )
+          ]
+        ]
+      end
+    end
+  end
+end

data/lib/authlete/response/base-response.rb

@@ -0,0 +1,41 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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 Response
+    # == Authlete::Response::Base
+    #
+    # The base class of responses from Authlete Web APIs.
+    #
+    class BaseResponse
+      include Authlete::Utility
+
+      # The code assigned to the result of the API call.
+      attr_accessor :result_code
+
+      # The message about the result of the API call.
+      attr_accessor :result_message
+
+      # The constructor which takes a hash that represents a JSON response
+      # from an Authlete API.
+      def initialize(hash = {})
+        @result_code    = extract_value(hash, :resultCode)
+        @result_message = extract_value(hash, :resultMessage)
+      end
+    end
+  end
+end

data/lib/authlete/response/introspection-response.rb

@@ -0,0 +1,86 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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 Response
+    # == Authlete::Response::IntrospectionResponse class
+    #
+    # A class that represents a response from Authlete's
+    # {/auth/introspection}[https://www.authlete.com/authlete_web_apis_introspection.html#auth_introspection]
+    # API.
+    #
+    class IntrospectionResponse < Athlete::Response::BaseResponse
+      # The next action which the caller of the API should take next.
+      attr_accessor :action
+
+      # The ID of the client application which is associated with
+      # the access token.
+      attr_accessor :client_id
+
+      # The subject which is associated with the access token.
+      # This is <tt>nil</tt> if the access token was created
+      # through {Client Credentials Flow}[https://tools.ietf.org/html/rfc6749#section-4.4].
+      attr_accessor :subject
+
+      # The scopes which is associated with the access token.
+      attr_accessor :scopes
+
+      # True when the access token exists.
+      attr_accessor :existent
+
+      # True when the access token is usable (= exists and has not expired).
+      attr_accessor :usable
+
+      # True when the access token covers all the scopes (if specified).
+      attr_accessor :sufficient
+
+      # True when the access token can be refreshed using its corresponding
+      # refresh token.
+      attr_accessor :refreshable
+
+      # The content of the error response that the service implementation
+      # should return to the client application.
+      attr_accessor :response_content
+
+      # The constructor which takes a hash that represents a JSON response from
+      # {/auth/introspection}[https://www.authlete.com/authlete_web_apis_introspection.html#auth_introspection]
+      # API.
+      def initialize(hash = {})
+        super(hash)
+
+        @action           = extract_value(hash, :action)
+        @client_id        = extract_value(hash, :clientId)
+        @subject          = extract_value(hash, :subject)
+        @scopes           = extract_value(hash, :scopes)
+        @existent         = extract_boolean_value(hash, :existent)
+        @usable           = extract_boolean_value(hash, :usable)
+        @sufficient       = extract_boolean_value(hash, :sufficient)
+        @refreshable      = extract_boolean_value(hash, :refreshable)
+        @response_content = extract_value(hash, :responseContent)
+      end
+
+      alias_method :existent?,    :existent
+      alias_method :exists,       :existent
+      alias_method :exists?,      :existent
+      alias_method :exist,        :existent
+      alias_method :exist?,       :existent
+      alias_method :usable?,      :usable
+      alias_method :sufficient?,  :sufficient
+      alias_method :refreshable?, :refreshable
+    end
+  end
+end

data/lib/authlete/utility.rb

@@ -0,0 +1,34 @@
+# :nodoc:
+#
+# Copyright (C) 2014 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_boolean_value(hash, key)
+      value = extract_value(hash, key)
+
+      return (value == true || value == 'true')
+    end
+  end
+end

data/lib/authlete/version.rb

@@ -0,0 +1,3 @@
+module Authlete
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: authlete
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Takahiko Kawasaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A library for Authlete Web APIs. See https://www.authlete.com/authlete_web_apis.html
+  for details.
+email:
+- taka@authlete.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authlete.gemspec
+- lib/authlete.rb
+- lib/authlete/authentication-server.rb
+- lib/authlete/client.rb
+- lib/authlete/request/authentication-callback-request.rb
+- lib/authlete/response/authentication-callback-response.rb
+- lib/authlete/response/base-response.rb
+- lib/authlete/response/introspection-response.rb
+- lib/authlete/utility.rb
+- lib/authlete/version.rb
+homepage: https://www.authlete.com/
+licenses:
+- Apache License, Version 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: A library for Authlete Web APIs
+test_files: []