authlete 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDkwYjI3NWM2ZjgwMmIzN2FmMTM1OTQ2YTVkZTQ1N2FlYzRhZDY5Nw==
+    OWIyYTAxYmQyNTRlM2I3MTI0NTJkYTdhZmRmZGM3YTNiYTRiZjM4Nw==
   data.tar.gz: !binary |-
-    Mjc4NmNjNzUwMWQyMjI1MjQ3NDUxYWFlZTVhY2VhMzQyNTI1NDE1Ng==
+    ODNhM2RkZGY5ZjA4MzlhZmFlOTg4MjcxYjNlZTJjYzMyYTIxYTU2Yw==
 SHA512:
   metadata.gz: !binary |-
-    MzcxZTg0NDI4YTkxOWQwYWIxMmFjYWU3YjhmYWE0YTJiNWRmODQyYWEyOGQ1
-    OWViYTczNzIyNDY2YTA0NTZiODVhY2QxMjczOTU3ZDg1N2RkODBmMDEwNDBk
-    YWI2MjFhNTM5NzFhNWI1MjdhOWU4MWE1MGU1NDNiMmRmMmJkNGI=
+    MThiYzIyNmYxNDMwM2E5M2Q4Nzc2MjJiNTBmNDNjMzA5MmY2Y2I2ZGNkM2Jh
+    NTA2MDFhNGU2MDZlMTliMDgzNzA2N2I2NDQ4OTA2MjIwMWFiZWU1NjAyNTYw
+    MGFmYTY1MzgwOTYzMTU4ODk0OGFjYzhjNzQwMmZhNTI5MDg0NzE=
   data.tar.gz: !binary |-
-    ZWFkNzY2NmE2ZDIxZGUzZWIyMjU2OTJiM2JmOTkzZDY1YzY0NDYyMGUzMzkz
-    NDQ5YjU5ZWQ3NDk2ZDBjNjMxNmY4MWJjMzkyZjU5ODNjYmI2ZDI0YzA2NTJh
-    YmYxNDdiNjk2NjU4ZjAyNDY3Y2FiOThhYzg2NWMxNjg2N2FjZWQ=
+    NzZhNzA4YzFmZmNlMTY3M2Y3MjI0NzU3NDM3Y2FkMWE0ZTgxNzRlMjRkNTU4
+    Y2M2NzE5MWM2MWExYjQ5YzNhZGNlYjRjNTE0NWE1NzgxYzRmM2FhMTg2OGZm
+    ZWYwOWYyYTZkMzIwMjZjNWI0OWUzNzcwM2ViODcwMTI2YjBkNTY=

data/lib/authlete.rb

@@ -31,6 +31,7 @@ module Authlete
   module Model
     autoload :Scope, 'authlete/model/scope'
     autoload :Service, 'authlete/model/service'
+    autoload :ServiceList, 'authlete/model/service-list'
     autoload :SnsCredentials, 'authlete/model/sns-credentials'
   end
 

data/lib/authlete/client.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014 Authlete, Inc.
+# 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.
@@ -44,6 +44,9 @@ module Authlete
     # The API secret of a service.
     attr_accessor :service_api_secret
 
+    # Extra HTTP headers
+    attr_accessor :extra_headers
+
     # The constructor which takes a hash containing configuration
     # parameters. Valid configuration parameter names are as follows.
     #
@@ -64,23 +67,57 @@ module Authlete
     private
 
     def call_api(method, path, content_type, payload, user, password)
+      headers = {}
+
+      if content_type.nil? == false
+        headers.merge!(:content_type => content_type)
+      end
+
+      if @extra_headers.nil? == false
+        headers.merge!(@extra_headers)
+      end
+
       response = RestClient::Request.new(
         :method   => method,
         :url      => @host + path,
-        :headers  => { :content_type => content_type },
+        :headers  => headers,
         :payload  => payload,
         :user     => user,
         :password => password
       ).execute
 
-      JSON.parse(response.to_str, :symbolize_names => true)
+      body = body_as_string(response)
+
+      if body.nil?
+        return nil
+      end
+
+      JSON.parse(response.body.to_s, :symbolize_names => true)
+    end
+
+    def body_as_string(response)
+      if response.body.nil?
+        return nil
+      end
+
+      body = response.body.to_s
+
+      if body.length == 0
+        return nil
+      end
+
+      return body
+    end
+
+    def call_api_service_owner(method, path, content_type, payload)
+      call_api(method, path, content_type, payload, @service_owner_api_key, @service_owner_api_secret)
     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)
+    def call_api_json_service_owner(path, body)
       call_api_json(path, body, @service_owner_api_key, @service_owner_api_secret)
     end
 
@@ -106,8 +143,105 @@ module Authlete
       end
     end
 
+    def to_query(params)
+      if params.nil? || params.size == 0
+        return ""
+      end
+
+      array = []
+
+      params.each do |key, value|
+        array.push("#{key}=#{value}")
+      end
+
+      return "?" + array.join("&")
+    end
+
     public
 
+
+    # Call Authlete's /api/service/create API.
+    #
+    # <tt>service</tt> is the content of a new service to create. The type of
+    # the given object is either <tt>Hash</tt> or any object which
+    # responds to <tt>to_hash</tt>. In normal cases, Authlete::Model::Service
+    # (which responds to <tt>to_hash</tt>) should be used.
+    #
+    # On success, an instance of Authlete::Model::ServiceList is returned.
+    # On error, RestClient::Exception (of rest-client GEM) is raised.
+    def service_create(service)
+      if service.kind_of?(Hash) == false
+        if service.respond_to?('to_hash')
+          service = service.to_hash
+        end
+      end
+
+      hash = call_api_json_service_owner("/api/service/create", service)
+
+      Authlete::Model::Service.new(hash)
+    end
+
+    # Call Authlete's /api/service/delete/{api_key} API.
+    #
+    # On error, RestClient::Exception (of rest-client GEM) is raised.
+    def service_delete(api_key)
+      call_api_service_owner(:delete, "/api/service/delete/#{api_key}", nil, nil)
+    end
+
+
+    # Call Authlete's /api/service/get/{api_key} API.
+    #
+    # <tt>api_key</tt> is the API key of the service whose information
+    # you want to get.
+    #
+    # On success, an instance of Authlete::Model::Service is returned.
+    # On error, RestClient::Exception (of rest-client GEM) is raised.
+    def service_get(api_key)
+      hash = call_api_service_owner(:get, "/api/service/get/#{api_key}", nil, nil)
+
+      Authlete::Model::Service.new(hash)
+    end
+
+    # Call Authlete's /api/service/get/list API.
+    #
+    # <tt>params</tt> is an optional hash which contains query parameters
+    # for /api/service/get/list API. <tt>:start</tt> and <tt>:end</tt> are
+    # a start index (inclusive) and an end index (exclusive), respectively.
+    #
+    # On success, an instance of Authlete::Model::ServiceList is returned.
+    # On error, RestClient::Exception (of rest-client GEM) is raised.
+    def service_get_list(params = nil)
+      hash = call_api_service_owner(:get, "/api/service/get/list#{to_query(params)}", nil, nil)
+
+      Authlete::Model::ServiceList.new(hash)
+    end
+
+
+    # Call Authlete's /api/service/update/{api_key} API.
+    #
+    # <tt>api_key</tt> is the API key of the service whose information
+    # you want to get.
+    #
+    # <tt>service</tt> is the new content of the service. The type of
+    # the given object is either <tt>Hash</tt> or any object which
+    # responds to <tt>to_hash</tt>. In normal cases, Authlete::Model::Service
+    # (which responds to <tt>to_hash</tt>) should be used.
+    #
+    # On success, an instance of Authlete::Model::Service is returned.
+    # On error, RestClient::Exception (of rest-client GEM) is raised.
+    def service_update(api_key, service)
+      if service.kind_of?(Hash) == false
+        if service.respond_to?('to_hash')
+          service = service.to_hash
+        end
+      end
+
+      hash = call_api_json_service_owner("/api/service/update/#{api_key}", service)
+
+      Authlete::Model::Service.new(hash)
+    end
+
+
     # Call Authlete's {/auth/introspection}
     # [https://www.authlete.com/authlete_web_apis_introspection.html#auth_introspection]
     # API.
@@ -136,6 +270,7 @@ module Authlete
       Authlete::Response::IntrospectionResponse.new(hash)
     end
 
+
     # Ensure that the request contains a valid access token.
     #
     # This method extracts an access token from the given request based on the

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

@@ -0,0 +1,181 @@
+# :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.
+
+
+require 'set'
+
+
+module Authlete
+  module Model
+    class ServiceList
+      # The start index (inclusive) of the services in this list.
+      attr_accessor :start
+
+      # The end index (exclusive) of the services in this list.
+      attr_accessor :end
+
+      # The total count of services.
+      attr_accessor :totalCount
+      alias_method  :total_count,  :totalCount
+      alias_method  :total_count=, :totalCount=
+
+      # The list of services.
+      attr_accessor :services
+
+      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
+
+        @services = nil
+
+        # Set attribute values using the given hash.
+        authlete_model_serviceList_update(hash)
+      end
+
+      def authlete_model_serviceList_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_serviceList_simple_attribute?(key)
+        INTEGER_ATTRIBUTES.include?(key)
+      end
+
+      def authlete_model_serviceList_update(hash)
+        if hash.nil?
+          return
+        end
+
+        hash.each do |key, value|
+          key = authlete_model_serviceList_to_key(key)
+
+          # If the attribute is a simple one.
+          if authlete_model_serviceList_simple_attribute?(key)
+            send("#{key}=", value)
+            next
+          end
+
+          if key == :services
+            # The attribute 'services'.
+            @services = authlete_model_serviceList_parse_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
+      end
+
+      public
+
+      # Construct an instance from the given hash.
+      #
+      # If the given argument is nil or is not a Hash, nil is returned.
+      # Otherwise, ServiceList.new(hash) is returned.
+      def self.parse(hash)
+        if hash.nil? or (hash.kind_of?(Hash) == false)
+          return nil
+        end
+
+        return ServiceList.new(hash)
+      end
+
+      # Set attribute values using the given hash.
+      def update(hash)
+        authlete_model_serviceList_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_serviceList_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_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
+      end
+    end
+  end
+end
+

data/lib/authlete/version.rb

@@ -1,3 +1,3 @@
 module Authlete
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authlete
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Takahiko Kawasaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -71,6 +71,7 @@ files:
 - lib/authlete/client.rb
 - lib/authlete/host.rb
 - lib/authlete/model/scope.rb
+- lib/authlete/model/service-list.rb
 - lib/authlete/model/service.rb
 - lib/authlete/model/sns-credentials.rb
 - lib/authlete/request/authentication-callback-request.rb