gcloud 0.5.0 → 0.6.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGQ2OGZmZTRjOGY4ZGRiNjZmZTE0OGExZTZmODJkYjE4MmJlN2E4YQ==
+    MzYyZTAzYjI3MDRlNWZmODg4OTlmMzU4MWVhOWJjNTg2NTFjZjgyMw==
   data.tar.gz: !binary |-
-    YmYxMDQyOGNjNDBhZmMyNTgwMjBkYzhiM2Y4YTk0Y2JkYzQxN2QwNg==
+    MTBlNzFkOGIxMTFmYzFhZWVkZmIzZGE0NzAxYjExMDM1MDU1ZjQ2ZA==
 SHA512:
   metadata.gz: !binary |-
-    MGEwZmE1NzFkZGQ1MzE1YTliMmM5MDhmNWQ0MDliMTkxMDk4ZjUyNWI2MmQy
-    NGZkNWNkZTJhODY2OGJmMDg1Zjg2MWMwMzVlMzAyNDJkMmFmZmJlNWM4Y2Zk
-    NjJjNWRiZmU5YzM2ZjRmMjQ3MWE1MWE5ZmZhMDU5ZGI2NjczMWM=
+    MTdiZTVjZjViOTM4ZmQxZDZjMGZiMmQ1MDAzNmFmYWU1N2Q2ZTg2NTAzMjQx
+    NTk4YTU2NmQ1ZGVjOTFjOGQ5OThhMDIxNDU0YjNmZTczMTc3ZTQ1ZDRmNTVi
+    YzJhMWY2YTJlNTQwZDcyMmYyOWE3ZjkzY2YwYjRlZTZlYzFlYzU=
   data.tar.gz: !binary |-
-    NDI4OGMxMmVkMGVjMDBiMTExM2E5MGNmMGJhMTc0ODFlYjIwMTRlNTc1MDli
-    OTg1NjJjMDdkYTJiNDZjMGU1YmYyNTFjZWU4MzgzNzdlZDYyZDYwNGM1MjYy
-    YmRmMjJkZDNjMTAyMjBlMmZjY2FhMGRiZDc3ODkxYTA0NDczODI=
+    YTI5YjRiMWE2YTE0ZjJlYzk5OWNhNjkyNjQ4ZWM1NGQwOTRkZjllZGU0MGFk
+    MWEyMmFkYTFiODk3NGNiZmE3ZDA5YTMxODliNjFiY2IzNDEzMjNkZGZmYzZm
+    MGQ0MzA5ZjNhOTlhOGZkMTQ3YjMyNjM0ZTJkMDczODFhY2Q3Njc=

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### 0.6.0 / 2015-12-11
+
+#### Changes
+
+* Add support for Search service
+* Drop support for Ruby 1.9.3
+  * Replace options hash parameter with named parameters
+
 ### 0.5.0 / 2015-10-29
 
 #### Changes

data/lib/gcloud.rb

@@ -72,9 +72,7 @@ module Gcloud
   #
   # === Parameters
   #
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -112,9 +110,9 @@ module Gcloud
   #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
   #   dataset = gcloud.datastore scope: platform_scope
   #
-  def datastore options = {}
+  def datastore scope: nil
     require "gcloud/datastore"
-    Gcloud.datastore @project, @keyfile, options
+    Gcloud.datastore @project, @keyfile, scope: scope
   end
 
   ##
@@ -123,9 +121,7 @@ module Gcloud
   #
   # === Parameters
   #
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -158,9 +154,9 @@ module Gcloud
   #   readonly_scope = "https://www.googleapis.com/auth/devstorage.read_only"
   #   readonly_storage = gcloud.storage scope: readonly_scope
   #
-  def storage options = {}
+  def storage scope: nil
     require "gcloud/storage"
-    Gcloud.storage @project, @keyfile, options
+    Gcloud.storage @project, @keyfile, scope: scope
   end
 
   ##
@@ -169,9 +165,7 @@ module Gcloud
   #
   # === Parameters
   #
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -202,9 +196,9 @@ module Gcloud
   #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
   #   pubsub = gcloud.pubsub scope: platform_scope
   #
-  def pubsub options = {}
+  def pubsub scope: nil
     require "gcloud/pubsub"
-    Gcloud.pubsub @project, @keyfile, options
+    Gcloud.pubsub @project, @keyfile, scope: scope
   end
 
   ##
@@ -213,9 +207,7 @@ module Gcloud
   #
   # === Parameters
   #
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -249,9 +241,9 @@ module Gcloud
   #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
   #   bigquery = gcloud.bigquery scope: platform_scope
   #
-  def bigquery options = {}
+  def bigquery scope: nil
     require "gcloud/bigquery"
-    Gcloud.bigquery @project, @keyfile, options
+    Gcloud.bigquery @project, @keyfile, scope: scope
   end
 
   ##
@@ -260,9 +252,7 @@ module Gcloud
   #
   # === Parameters
   #
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -295,9 +285,9 @@ module Gcloud
   #   readonly_scope = "https://www.googleapis.com/auth/ndev.clouddns.readonly"
   #   dns = gcloud.dns scope: readonly_scope
   #
-  def dns options = {}
+  def dns scope: nil
     require "gcloud/dns"
-    Gcloud.dns @project, @keyfile, options
+    Gcloud.dns @project, @keyfile, scope: scope
   end
 
   # rubocop:disable Metrics/LineLength
@@ -310,9 +300,7 @@ module Gcloud
   #
   # === Parameters
   #
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -344,10 +332,40 @@ module Gcloud
   #   readonly_scope = "https://www.googleapis.com/auth/cloudresourcemanager.readonly"
   #   resource_manager = gcloud.resource_manager scope: readonly_scope
   #
-  def resource_manager options = {}
+  def resource_manager scope: nil
     require "gcloud/resource_manager"
-    Gcloud.resource_manager @keyfile, options
+    Gcloud.resource_manager @keyfile, scope: scope
   end
 
   # rubocop:enable Metrics/LineLength
+
+  ##
+  # Creates a new object for connecting to the Search service.
+  # Each call creates a new connection.
+  #
+  # === Parameters
+  #
+  # +scope+::
+  #   The OAuth 2.0 scopes controlling the set of resources and operations that
+  #   the connection can access. See {Using OAuth 2.0 to Access Google
+  #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
+  #   or +Array+)
+  #
+  #   The default scopes are:
+  #
+  #   * +https://www.googleapis.com/auth/cloudsearch+
+  #   * +https://www.googleapis.com/auth/userinfo.email+
+  #
+  # === Returns
+  #
+  # Gcloud::Search::Project
+  #
+  # === Examples
+  #
+  #   require "gcloud"
+  #
+  def search scope: nil
+    require "gcloud/search"
+    Gcloud.search @project, @keyfile, scope: scope
+  end
 end

data/lib/gcloud/bigquery.rb

@@ -30,9 +30,7 @@ module Gcloud
   # +keyfile+::
   #   Keyfile downloaded from Google Cloud. If file path the file must be
   #   readable. (+String+ or +Hash+)
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   The OAuth 2.0 scopes controlling the set of resources and operations that
   #   the connection can access. See {Using OAuth 2.0 to Access Google
   #   APIs}[https://developers.google.com/identity/protocols/OAuth2]. (+String+
@@ -54,12 +52,12 @@ module Gcloud
   #   dataset = bigquery.dataset "my_dataset"
   #   table = dataset.table "my_table"
   #
-  def self.bigquery project = nil, keyfile = nil, options = {}
+  def self.bigquery project = nil, keyfile = nil, scope: nil
     project ||= Gcloud::Bigquery::Project.default_project
     if keyfile.nil?
-      credentials = Gcloud::Bigquery::Credentials.default options
+      credentials = Gcloud::Bigquery::Credentials.default scope: scope
     else
-      credentials = Gcloud::Bigquery::Credentials.new keyfile, options
+      credentials = Gcloud::Bigquery::Credentials.new keyfile, scope: scope
     end
     Gcloud::Bigquery::Project.new project, credentials
   end

data/lib/gcloud/bigquery/connection.rb

@@ -94,11 +94,11 @@ module Gcloud
       # either manually or by specifying force: true in options.
       # Immediately after deletion, you can create another dataset with
       # the same name.
-      def delete_dataset dataset_id, options = {}
+      def delete_dataset dataset_id, force = nil
         @client.execute(
           api_method: @bigquery.datasets.delete,
           parameters: { projectId: @project, datasetId: dataset_id,
-                        deleteContents: options[:force]
+                        deleteContents: force
                       }.delete_if { |_, v| v.nil? }
         )
       end
@@ -344,17 +344,6 @@ module Gcloud
 
       protected
 
-      ##
-      # Make sure the object is converted to a hash
-      # Ruby 1.9.3 doesn't support to_h, so here we are.
-      def hashify hash
-        if hash.respond_to? :to_h
-          hash.to_h
-        else
-          Hash.try_convert(hash) || {}
-        end
-      end
-
       ##
       # Create the HTTP body for insert dataset
       def insert_dataset_request dataset_id, options = {}
@@ -482,7 +471,6 @@ module Gcloud
           "defaultDataset" => dataset_config,
           "timeoutMs" => options[:timeout],
           "dryRun" => options[:dryrun],
-          "preserveNulls" => options[:preserve_nulls],
           "useQueryCache" => options[:cache]
         }.delete_if { |_, v| v.nil? }
       end

data/lib/gcloud/bigquery/dataset.rb

@@ -281,9 +281,7 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:force]</code>::
+      # +force+::
       #   If +true+, delete all the tables in the dataset. If +false+ and the
       #   dataset contains tables, the request will fail. Default is +false+.
       #   (+Boolean+)
@@ -304,9 +302,9 @@ module Gcloud
       #
       # :category: Lifecycle
       #
-      def delete options = {}
+      def delete force: nil
         ensure_connection!
-        resp = connection.delete_dataset dataset_id, options
+        resp = connection.delete_dataset dataset_id, force
         if resp.success?
           true
         else
@@ -323,13 +321,11 @@ module Gcloud
       #   The ID of the table. The ID must contain only letters (a-z, A-Z),
       #   numbers (0-9), or underscores (_). The maximum length is 1,024
       #   characters. (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:name]</code>::
+      # +name+::
       #   A descriptive name for the table. (+String+)
-      # <code>options[:description]</code>::
+      # +description+::
       #   A user-friendly description of the table. (+String+)
-      # <code>options[:schema]</code>::
+      # +schema+::
       #   A hash specifying fields and data types for the table. A block may be
       #   passed instead (see examples.) For the format of this hash, see the
       #   {Tables resource
@@ -415,16 +411,17 @@ module Gcloud
       #
       # :category: Table
       #
-      def create_table table_id, options = {}
+      def create_table table_id, name: nil, description: nil, schema: nil
         ensure_connection!
         if block_given?
-          if options[:schema]
+          if schema
             fail ArgumentError, "only schema block or schema option is allowed"
           end
           schema_builder = Table::Schema.new nil
           yield schema_builder
-          options[:schema] = schema_builder.schema if schema_builder.changed?
+          schema = schema_builder.schema if schema_builder.changed?
         end
+        options = { name: name, description: description, schema: schema }
         insert_table table_id, options
       end
 
@@ -440,11 +437,9 @@ module Gcloud
       # +query+::
       #   The query that BigQuery executes when the view is referenced.
       #   (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:name]</code>::
+      # +name+::
       #   A descriptive name for the table. (+String+)
-      # <code>options[:description]</code>::
+      # +description+::
       #   A user-friendly description of the table. (+String+)
       #
       # === Returns
@@ -474,9 +469,9 @@ module Gcloud
       #
       # :category: Table
       #
-      def create_view table_id, query, options = {}
-        options[:query] = query
-        create_table table_id, options
+      def create_view table_id, query, name: nil, description: nil
+        options = { query: query, name: name, description: description }
+        insert_table table_id, options
       end
 
       ##
@@ -519,12 +514,10 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:token]</code>::
+      # +token+::
       #   A previously-returned page token representing part of the larger set
       #   of results to view. (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   Maximum number of tables to return. (+Integer+)
       #
       # === Returns
@@ -567,8 +560,9 @@ module Gcloud
       #
       # :category: Table
       #
-      def tables options = {}
+      def tables token: nil, max: nil
         ensure_connection!
+        options = { token: token, max: max }
         resp = connection.list_tables dataset_id, options
         if resp.success?
           Table::List.from_response resp, connection
@@ -591,25 +585,25 @@ module Gcloud
       #   syntax}[https://cloud.google.com/bigquery/query-reference], of the
       #   query to execute. Example: "SELECT count(f1) FROM
       #   [myProjectId:myDatasetId.myTableId]". (+String+)
-      # <code>options[:priority]</code>::
+      # +priority+::
       #   Specifies a priority for the query. Possible values include
       #   +INTERACTIVE+ and +BATCH+. The default value is +INTERACTIVE+.
       #   (+String+)
-      # <code>options[:cache]</code>::
+      # +cache+::
       #   Whether to look for the result in the query cache. The query cache is
       #   a best-effort cache that will be flushed whenever tables in the query
       #   are modified. The default value is +true+. (+Boolean+)
-      # <code>options[:table]</code>::
+      # +table+::
       #   The destination table where the query results should be stored. If not
       #   present, a new table will be created to store the results. (+Table+)
-      # <code>options[:create]</code>::
+      # +create+::
       #   Specifies whether the job is allowed to create new tables. (+String+)
       #
       #   The following values are supported:
       #   * +needed+ - Create the table if it does not exist.
       #   * +never+ - The table must already exist. A 'notFound' error is
       #     raised if the table does not exist.
-      # <code>options[:write]</code>::
+      # +write+::
       #   Specifies the action that occurs if the destination table already
       #   exists. (+String+)
       #
@@ -618,14 +612,14 @@ module Gcloud
       #   * +append+ - BigQuery appends the data to the table.
       #   * +empty+ - A 'duplicate' error is returned in the job result if the
       #     table exists and contains data.
-      # <code>options[:large_results]</code>::
+      # +large_results+::
       #   If +true+, allows the query to produce arbitrarily large result tables
-      #   at a slight cost in performance. Requires <code>options[:table]</code>
-      #   to be set. (+Boolean+)
-      # <code>options[:flatten]</code>::
+      #   at a slight cost in performance. Requires +table+ parameter to be set.
+      #   (+Boolean+)
+      # +flatten+::
       #   Flattens all nested and repeated fields in the query results. The
-      #   default value is +true+. <code>options[:large_results]</code> must be
-      #   +true+ if this is set to +false+. (+Boolean+)
+      #   default value is +true+. +large_results+ parameter must be +true+ if
+      #   this is set to +false+. (+Boolean+)
       #
       # === Returns
       #
@@ -649,7 +643,11 @@ module Gcloud
       #
       # :category: Data
       #
-      def query_job query, options = {}
+      def query_job query, priority: "INTERACTIVE", cache: true, table: nil,
+                    create: nil, write: nil, large_results: nil, flatten: nil
+        options = { priority: priority, cache: cache, table: table,
+                    create: create, write: write, large_results: large_results,
+                    flatten: flatten }
         options[:dataset] ||= self
         ensure_connection!
         resp = connection.query_job query, options
@@ -674,26 +672,26 @@ module Gcloud
       #   syntax}[https://cloud.google.com/bigquery/query-reference], of the
       #   query to execute. Example: "SELECT count(f1) FROM
       #   [myProjectId:myDatasetId.myTableId]". (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   The maximum number of rows of data to return per page of results.
       #   Setting this flag to a small value such as 1000 and then paging
       #   through results might improve reliability when the query result set is
       #   large. In addition to this limit, responses are also limited to 10 MB.
       #   By default, there is no maximum row count, and only the byte limit
       #   applies. (+Integer+)
-      # <code>options[:timeout]</code>::
+      # +timeout+::
       #   How long to wait for the query to complete, in milliseconds, before
       #   the request times out and returns. Note that this is only a timeout
       #   for the request, not the query. If the query takes longer to run than
       #   the timeout value, the call returns without any results and with
       #   QueryData#complete? set to false. The default value is 10000
       #   milliseconds (10 seconds). (+Integer+)
-      # <code>options[:dryrun]</code>::
+      # +dryrun+::
       #   If set to +true+, BigQuery doesn't run the job. Instead, if the query
       #   is valid, BigQuery returns statistics about the job such as how many
       #   bytes would be processed. If the query is invalid, an error returns.
       #   The default value is +false+. (+Boolean+)
-      # <code>options[:cache]</code>::
+      # +cache+::
       #   Whether to look for the result in the query cache. The query cache is
       #   a best-effort cache that will be flushed whenever tables in the query
       #   are modified. The default value is true. For more information, see
@@ -718,7 +716,8 @@ module Gcloud
       #
       # :category: Data
       #
-      def query query, options = {}
+      def query query, max: nil, timeout: 10000, dryrun: nil, cache: true
+        options = { max: max, timeout: timeout, dryrun: dryrun, cache: cache }
         options[:dataset] ||= dataset_id
         options[:project] ||= project_id
         ensure_connection!