Merge pull request googleapis#87 from sgomes/new_programming_interface

New programming interface for the client library

Author: sqrrrl

lib/google/api_client/service.rb

@@ -0,0 +1,205 @@
+# Copyright 2013 Google 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 'google/api_client'
+require 'google/api_client/service/stub_generator'
+require 'google/api_client/service/resource'
+require 'google/api_client/service/request'
+require 'google/api_client/service/result'
+require 'google/api_client/service/batch'
+
+module Google
+  class APIClient
+
+    ##
+    # Experimental new programming interface at the API level.
+    # Hides Google::APIClient. Designed to be easier to use, with less code.
+    #
+    # @example
+    #   calendar = Google::APIClient::Service.new('calendar', 'v3')
+    #   result = calendar.events.list('calendarId' => 'primary').execute()
+    class Service
+      include Google::APIClient::Service::StubGenerator
+      extend Forwardable
+
+      # Cache for discovered APIs.
+      @@discovered = {}
+
+      ##
+      # Creates a new Service.
+      #
+      # @param [String, Symbol] api_name
+      #   The name of the API this service will access.
+      # @param [String, Symbol] api_version
+      #   The version of the API this service will access.
+      # @param [Hash] options
+      #   The configuration parameters for the service.
+      # @option options [Symbol, #generate_authenticated_request] :authorization
+      #   (:oauth_1)
+      #   The authorization mechanism used by the client.  The following
+      #   mechanisms are supported out-of-the-box:
+      #   <ul>
+      #     <li><code>:two_legged_oauth_1</code></li>
+      #     <li><code>:oauth_1</code></li>
+      #     <li><code>:oauth_2</code></li>
+      #   </ul>
+      # @option options [Boolean] :auto_refresh_token (true)
+      #   The setting that controls whether or not the api client attempts to
+      #   refresh authorization when a 401 is hit in #execute. If the token does
+      #   not support it, this option is ignored.
+      # @option options [String] :application_name
+      #   The name of the application using the client.
+      # @option options [String] :application_version
+      #   The version number of the application using the client.
+      # @option options [String] :host ("www.googleapis.com")
+      #   The API hostname used by the client. This rarely needs to be changed.
+      # @option options [String] :port (443)
+      #   The port number used by the client. This rarely needs to be changed.
+      # @option options [String] :discovery_path ("/discovery/v1")
+      #   The discovery base path. This rarely needs to be changed.
+      # @option options [String] :ca_file
+      #   Optional set of root certificates to use when validating SSL connections.
+      #   By default, a bundled set of trusted roots will be used.
+      # @option options [#generate_authenticated_request] :authorization
+      #   The authorization mechanism for requests. Used only if
+      #   `:authenticated` is `true`.
+      # @option options [TrueClass, FalseClass] :authenticated (default: true)
+      #   `true` if requests must be signed or somehow
+      #   authenticated, `false` otherwise.
+      # @option options [TrueClass, FalseClass] :gzip (default: true)
+      #   `true` if gzip enabled, `false` otherwise.
+      # @option options [Faraday::Connection] :connection
+      #   A custom connection to be used for all requests.
+      def initialize(api_name, api_version, options = {})
+        @api_name = api_name.to_s
+        if api_version.nil?
+          raise ArgumentError,
+            "API version must be set"
+        end
+        @api_version = api_version.to_s
+        if options && !options.respond_to?(:to_hash)
+          raise ArgumentError,
+            "expected options Hash, got #{options.class}"
+        end
+
+        params = {}
+        [:application_name, :application_version, :authorization, :host, :port,
+         :discovery_path, :auto_refresh_token, :key, :user_ip,
+         :ca_file].each do |option|
+          if options.include? option
+            params[option] = options[option]
+          end
+        end
+
+        @client = Google::APIClient.new(params)
+        @client.logger = options[:logger] if options.include? :logger
+
+        @connection = options[:connection] || @client.connection
+
+        @options = options
+
+        # Cache discovered APIs in memory.
+        # Not thread-safe, but the worst that can happen is a cache miss.
+        unless @api = @@discovered[[api_name, api_version]]
+          @@discovered[[api_name, api_version]] = @api = @client.discovered_api(
+            api_name, api_version)
+        end
+
+        generate_call_stubs(self, @api)
+      end
+
+      ##
+      # Logger for the Service.
+      #
+      # @return [Logger]
+      #  The logger instance.
+      def_delegators :@client, :logger, :logger=
+
+      ##
+      # Returns the authorization mechanism used by the service.
+      #
+      # @return [#generate_authenticated_request] The authorization mechanism.
+      def_delegators :@client, :authorization, :authorization=
+
+      ##
+      # The setting that controls whether or not the service attempts to
+      # refresh authorization when a 401 is hit during an API call.
+      #
+      # @return [Boolean]
+      def_delegators :@client, :auto_refresh_token, :auto_refresh_token=
+
+      ##
+      # The application's API key issued by the API console.
+      #
+      # @return [String] The API key.
+      def_delegators :@client, :key, :key=
+
+      ##
+      # The Faraday/HTTP connection used by this service.
+      #
+      # @return [Faraday::Connection]
+      attr_accessor :connection
+
+      ##
+      # Prepares a Google::APIClient::BatchRequest object to make batched calls.
+      # @param [Array] calls
+      #   Optional array of Google::APIClient::Service::Request to initialize
+      #   the batch request with.
+      # @param [Proc] block
+      #   Callback for every call's response. Won't be called if a call defined
+      #   a callback of its own.
+      #
+      # @yield [Google::APIClient::Service::Result]
+      #   block to be called when result ready
+      def batch(calls = nil, &block)
+        Google::APIClient::Service::BatchRequest.new(self, calls, &block)
+      end
+
+      ##
+      # Executes an API request.
+      # Do not call directly; this method is only used by Request objects when
+      # executing.
+      #
+      # @param [Google::APIClient::Service::Request,
+      #         Google::APIClient::Service::BatchCall] request
+      #   The request to be executed.
+      def execute(request)
+        if request.instance_of? Google::APIClient::Service::Request
+          params = {:api_method => request.method,
+            :parameters => request.parameters,
+            :connection => @connection}
+          if request.respond_to? :body
+            if request.body.respond_to? :to_hash
+              params[:body_object] = request.body
+            else
+              params[:body] = request.body
+            end
+          end
+          if request.respond_to? :media
+            params[:media] = request.media
+          end
+          [:authenticated, :gzip].each do |option|
+            if @options.include? option
+              params[option] = @options[option]
+            end
+          end
+          result = @client.execute(params)
+          return Google::APIClient::Service::Result.new(request, result)
+        elsif request.instance_of? Google::APIClient::Service::BatchRequest
+          @client.execute(request.base_batch)
+        end
+      end
+    end
+  end
+end

lib/google/api_client/service/batch.rb

@@ -0,0 +1,103 @@
+# Copyright 2013 Google 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 'google/api_client/service/result'
+require 'google/api_client/batch'
+
+module Google
+  class APIClient
+    class Service
+
+      ##
+      # Helper class to contain the result of an individual batched call.
+      #
+      class BatchedCallResult < Result
+        # @return [Fixnum] Index of the call
+        def call_index
+          return @base_result.response.call_id.to_i - 1
+        end
+      end
+
+      ##
+      #
+      #
+      class BatchRequest
+        ##
+        # Creates a new batch request.
+        # This class shouldn't be instantiated directly, but rather through
+        # Service.batch.
+        #
+        # @param [Array] calls
+        #   List of Google::APIClient::Service::Request to be made.
+        # @param [Proc] block
+        #   Callback for every call's response. Won't be called if a call
+        #   defined a callback of its own.
+        #
+        # @yield [Google::APIClient::Service::Result]
+        #   block to be called when result ready
+        def initialize(service, calls, &block)
+          @service = service
+          @base_batch = Google::APIClient::BatchRequest.new
+          @global_callback = block if block_given?
+
+          if calls && calls.length > 0
+            calls.each do |call|
+              add(call)
+            end
+          end
+        end
+
+        ##
+        # Add a new call to the batch request.
+        #
+        # @param [Google::APIClient::Service::Request] call
+        #   the call to be added.
+        # @param [Proc] block
+        #   callback for this call's response.
+        #
+        # @return [Google::APIClient::Service::BatchRequest]
+        #   the BatchRequest, for chaining
+        #
+        # @yield [Google::APIClient::Service::Result]
+        #   block to be called when result ready
+        def add(call, &block)
+          if !block_given? && @global_callback.nil?
+            raise BatchError, 'Request needs a block'
+          end
+          callback = block || @global_callback
+          base_call = {
+            :api_method => call.method,
+            :parameters => call.parameters
+          }
+          @base_batch.add(base_call) do |base_result|
+            result = Google::APIClient::Service::BatchedCallResult.new(
+                call, base_result)
+            callback.call(result)
+          end
+          return self
+        end
+
+        ##
+        # Executes the batch request.
+        def execute
+          @service.execute(self)
+        end
+
+        attr_reader :base_batch
+
+      end
+
+    end
+  end
+end