gcloud 0.3.0 → 0.3.1

data/lib/gcloud/bigquery/table/list.rb

@@ -38,7 +38,7 @@ module Gcloud
 
         ##
         # New Table::List from a response object.
-        def self.from_resp resp, conn #:nodoc:
+        def self.from_response resp, conn #:nodoc:
           tables = List.new(Array(resp.data["tables"]).map do |gapi_object|
             Table.from_gapi gapi_object, conn
           end)

data/lib/gcloud/bigquery/table/schema.rb

@@ -0,0 +1,252 @@
+#--
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# 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 Gcloud
+  module Bigquery
+    class Table
+      ##
+      # = Table Schema
+      #
+      # A builder for BigQuery table schemas, passed to block arguments to
+      # Dataset#create_table and Table#schema. Supports nested and
+      # repeated fields via a nested block. For more information about BigQuery
+      # schema definitions, see {Preparing Data for BigQuery
+      # }[https://cloud.google.com/bigquery/preparing-data-for-bigquery].
+      #
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   bigquery = gcloud.bigquery
+      #   dataset = bigquery.dataset "my_dataset"
+      #   table = dataset.create_table "my_table"
+      #
+      #   table.schema do |schema|
+      #     schema.string "first_name", mode: :required
+      #     schema.record "cities_lived", mode: :repeated do |cities_lived|
+      #       cities_lived.string "place", mode: :required
+      #       cities_lived.integer "number_of_years", mode: :required
+      #     end
+      #   end
+      #
+      class Schema
+        MODES = %w( NULLABLE REQUIRED REPEATED ) #:nodoc:
+        TYPES = %w( STRING INTEGER FLOAT BOOLEAN TIMESTAMP RECORD ) #:nodoc:
+
+        attr_reader :fields #:nodoc:
+
+        ##
+        # Initializes a new schema object with an existing schema.
+        def initialize schema = nil, nested = false #:nodoc:
+          fields = (schema && schema["fields"]) || []
+          @original_fields = fields.dup
+          @fields = fields.dup
+          @nested = nested
+        end
+
+        def changed? #:nodoc:
+          @original_fields != @fields
+        end
+
+        ##
+        # Returns the schema as hash containing the keys and values specified by
+        # the Google Cloud BigQuery {Rest API
+        # }[https://cloud.google.com/bigquery/docs/reference/v2/tables#resource]
+        # .
+        def schema #:nodoc:
+          {
+            "fields" => @fields
+          }
+        end
+
+        ##
+        # Adds a string field to the schema.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The field name. The name must contain only letters (a-z, A-Z),
+        #   numbers (0-9), or underscores (_), and must start with a letter or
+        #   underscore. The maximum length is 128 characters. (+String+)
+        # +options+::
+        #   An optional Hash for controlling additional behavior. (+Hash+)
+        # <code>options[:description]</code>::
+        #   A description of the field. (+String+)
+        # <code>options[:mode]</code>::
+        #   The field's mode. The possible values are +:nullable+, +:required+,
+        #   and +:repeated+. The default value is +:nullable+. (+Symbol+)
+        def string name, options = {}
+          add_field name, :string, nil, options
+        end
+
+        ##
+        # Adds an integer field to the schema.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The field name. The name must contain only letters (a-z, A-Z),
+        #   numbers (0-9), or underscores (_), and must start with a letter or
+        #   underscore. The maximum length is 128 characters. (+String+)
+        # +options+::
+        #   An optional Hash for controlling additional behavior. (+Hash+)
+        # <code>options[:description]</code>::
+        #   A description of the field. (+String+)
+        # <code>options[:mode]</code>::
+        #   The field's mode. The possible values are +:nullable+, +:required+,
+        #   and +:repeated+. The default value is +:nullable+. (+Symbol+)
+        def integer name, options = {}
+          add_field name, :integer, nil, options
+        end
+
+        ##
+        # Adds a floating-point number field to the schema.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The field name. The name must contain only letters (a-z, A-Z),
+        #   numbers (0-9), or underscores (_), and must start with a letter or
+        #   underscore. The maximum length is 128 characters. (+String+)
+        # +options+::
+        #   An optional Hash for controlling additional behavior. (+Hash+)
+        # <code>options[:description]</code>::
+        #   A description of the field. (+String+)
+        # <code>options[:mode]</code>::
+        #   The field's mode. The possible values are +:nullable+, +:required+,
+        #   and +:repeated+. The default value is +:nullable+. (+Symbol+)
+        def float name, options = {}
+          add_field name, :float, nil, options
+        end
+
+        ##
+        # Adds a boolean field to the schema.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The field name. The name must contain only letters (a-z, A-Z),
+        #   numbers (0-9), or underscores (_), and must start with a letter or
+        #   underscore. The maximum length is 128 characters. (+String+)
+        # +options+::
+        #   An optional Hash for controlling additional behavior. (+Hash+)
+        # <code>options[:description]</code>::
+        #   A description of the field. (+String+)
+        # <code>options[:mode]</code>::
+        #   The field's mode. The possible values are +:nullable+, +:required+,
+        #   and +:repeated+. The default value is +:nullable+. (+Symbol+)
+        def boolean name, options = {}
+          add_field name, :boolean, nil, options
+        end
+
+        ##
+        # Adds a timestamp field to the schema.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The field name. The name must contain only letters (a-z, A-Z),
+        #   numbers (0-9), or underscores (_), and must start with a letter or
+        #   underscore. The maximum length is 128 characters. (+String+)
+        # +options+::
+        #   An optional Hash for controlling additional behavior. (+Hash+)
+        # <code>options[:description]</code>::
+        #   A description of the field. (+String+)
+        # <code>options[:mode]</code>::
+        #   The field's mode. The possible values are +:nullable+, +:required+,
+        #   and +:repeated+. The default value is +:nullable+. (+Symbol+)
+        def timestamp name, options = {}
+          add_field name, :timestamp, nil, options
+        end
+
+        ##
+        # Adds a record field to the schema. A block must be passed describing
+        # the nested fields of the record. For more information about nested
+        # and repeated records, see {Preparing Data for BigQuery
+        # }[https://cloud.google.com/bigquery/preparing-data-for-bigquery].
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The field name. The name must contain only letters (a-z, A-Z),
+        #   numbers (0-9), or underscores (_), and must start with a letter or
+        #   underscore. The maximum length is 128 characters. (+String+)
+        # +options+::
+        #   An optional Hash for controlling additional behavior. (+Hash+)
+        # <code>options[:description]</code>::
+        #   A description of the field. (+String+)
+        # <code>options[:mode]</code>::
+        #   The field's mode. The possible values are +:nullable+, +:required+,
+        #   and +:repeated+. The default value is +:nullable+. (+Symbol+)
+        #
+        # === Example
+        #
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   bigquery = gcloud.bigquery
+        #   dataset = bigquery.dataset "my_dataset"
+        #   table = dataset.create_table "my_table"
+        #
+        #   table.schema do |schema|
+        #     schema.string "first_name", mode: :required
+        #     schema.record "cities_lived", mode: :repeated do |cities_lived|
+        #       cities_lived.string "place", mode: :required
+        #       cities_lived.integer "number_of_years", mode: :required
+        #     end
+        #   end
+        #
+        def record name, options = {}
+          fail ArgumentError, "nested RECORD type is not permitted" if @nested
+          fail ArgumentError, "a block is required" unless block_given?
+          nested_schema = self.class.new nil, true
+          yield nested_schema
+          add_field name, :record, nested_schema.fields, options
+        end
+
+        protected
+
+        def upcase_type type
+          upcase_type = type.to_s.upcase
+          unless TYPES.include? upcase_type
+            fail ArgumentError,
+                 "Type '#{upcase_type}' not found in #{TYPES.inspect}"
+          end
+          upcase_type
+        end
+
+        def upcase_mode mode
+          upcase_mode = mode.to_s.upcase
+          unless MODES.include? upcase_mode
+            fail ArgumentError "Unable to determine mode for '#{mode}'"
+          end
+          upcase_mode
+        end
+
+        def add_field name, type, nested_fields, options
+          # Remove any existing field of this name
+          @fields.reject! { |h| h["name"] == name }
+          field = {
+            "name" => name,
+            "type" => upcase_type(type)
+          }
+          field["mode"] = upcase_mode(options[:mode]) if options[:mode]
+          field["description"] =options[:description] if options[:description]
+          field["fields"] = nested_fields if nested_fields
+          @fields << field
+        end
+      end
+    end
+  end
+end

data/lib/gcloud/bigquery/view.rb

@@ -83,6 +83,15 @@ module Gcloud
         @gapi["tableReference"]["projectId"]
       end
 
+      ##
+      # The gapi fragment containing the Project ID, Dataset ID, and Table ID as
+      # a camel-cased hash.
+      def table_ref #:nodoc:
+        table_ref = @gapi["tableReference"]
+        table_ref = table_ref.to_hash if table_ref.respond_to? :to_hash
+        table_ref
+      end
+
       ##
       # The name of the table.
       #
@@ -367,6 +376,22 @@ module Gcloud
         end
       end
 
+      ##
+      # Reloads the table with current data from the BigQuery service.
+      #
+      # :category: Lifecycle
+      #
+      def reload!
+        ensure_connection!
+        resp = connection.get_table dataset_id, table_id
+        if resp.success?
+          @gapi = resp.data
+        else
+          fail ApiError.from_response(resp)
+        end
+      end
+      alias_method :refresh!, :reload!
+
       ##
       # New Table from a Google API Client object.
       def self.from_gapi gapi, conn #:nodoc:

data/lib/gcloud/datastore/connection.rb

@@ -144,6 +144,10 @@ module Gcloud
         @http_host = new_http_host
       end
 
+      def inspect #:nodoc:
+        "#{self.class}(#{@dataset_id})"
+      end
+
       protected
 
       ##

data/lib/gcloud/datastore/dataset.rb

@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gcloud/gce"
 require "gcloud/datastore/connection"
 require "gcloud/datastore/credentials"
 require "gcloud/datastore/entity"
@@ -77,9 +78,11 @@ module Gcloud
       ##
       # Default project.
       def self.default_project #:nodoc:
-        ENV["DATASTORE_PROJECT"] ||
+        ENV["DATASTORE_DATASET"] ||
+          ENV["DATASTORE_PROJECT"] ||
           ENV["GCLOUD_PROJECT"] ||
-          ENV["GOOGLE_CLOUD_PROJECT"]
+          ENV["GOOGLE_CLOUD_PROJECT"] ||
+          Gcloud::GCE.project_id
       end
 
       ##

data/lib/gcloud/datastore/errors.rb

@@ -13,7 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "gcloud"
+require "gcloud/errors"
 
 module Gcloud
   module Datastore

data/lib/gcloud/datastore/properties.rb

@@ -89,6 +89,7 @@ module Gcloud
         if Time                      === value ||
            Gcloud::Datastore::Key    === value ||
            Gcloud::Datastore::Entity === value ||
+           NilClass                  === value ||
            TrueClass                 === value ||
            FalseClass                === value ||
            Float                     === value ||

data/lib/gcloud/datastore/proto.rb

@@ -14,6 +14,7 @@
 # limitations under the License.
 
 require "gcloud/proto/datastore_v1.pb"
+require "gcloud/datastore/errors"
 
 module Gcloud
   module Datastore
@@ -63,6 +64,8 @@ module Gcloud
           v.key_value = value.to_proto
         elsif Gcloud::Datastore::Entity === value
           v.entity_value = value.to_proto
+        elsif NilClass === value
+          # The correct behavior is to not set a value property
         elsif TrueClass === value
           v.boolean_value = true
         elsif FalseClass === value

data/lib/gcloud/errors.rb

@@ -0,0 +1,23 @@
+#--
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# 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.
+
+#--
+# Google Cloud Errors
+module Gcloud
+  ##
+  # Base Gcloud exception class.
+  class Error < StandardError
+  end
+end

data/lib/gcloud/gce.rb

@@ -0,0 +1,62 @@
+#--
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# 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 "faraday"
+
+#--
+# Google Cloud Compute Engine
+module Gcloud
+  ##
+  # Represents the Google Compute Engine environment.
+  module GCE #:nodoc:
+    CHECK_URI = "http://169.254.169.254"
+    PROJECT_URI = "#{CHECK_URI}/computeMetadata/v1/project/project-id"
+
+    # rubocop:disable all
+    # Disabled rubocop because this is private and we don't need more methods.
+
+    def self.gce? options = {}
+      conn = options[:connection] || Faraday.default_connection
+      resp = conn.get CHECK_URI do |req|
+        req.options.timeout = 0.1
+      end
+      return false unless resp.status == 200
+      return false unless resp.headers.key? "Metadata-Flavor"
+      return resp.headers["Metadata-Flavor"] == "Google"
+    rescue Faraday::TimeoutError, Faraday::ConnectionFailed
+      return false
+    end
+
+    def self.project_id options = {}
+      @gce ||= {}
+      return @gce[:project_id] if @gce.key? :project_id
+      conn = options[:connection] || Faraday.default_connection
+      conn.headers = { "Metadata-Flavor" => "Google" }
+      resp = conn.get PROJECT_URI do |req|
+        req.options.timeout = 0.1
+      end
+      if resp.status == 200
+        @gce[:project_id] = resp.body
+      else
+        @gce[:project_id] = nil
+      end
+    rescue Faraday::TimeoutError, Faraday::ConnectionFailed
+      @gce ||= {}
+      @gce[:project_id] = nil
+    end
+
+    # rubocop:enable all
+  end
+end