gcloud 0.8.2 → 0.9.0

data/lib/gcloud/datastore/transaction.rb

@@ -21,14 +21,46 @@ module Gcloud
     # Special Connection instance for running transactions.
     #
     # See {Gcloud::Datastore::Dataset#transaction}
+    #
+    # @see https://cloud.google.com/datastore/docs/concepts/transactions
+    #   Transactions
+    #
+    # @example Transactional update:
+    #   def transfer_funds from_key, to_key, amount
+    #     datastore.transaction do |tx|
+    #       from = tx.find from_key
+    #       from["balance"] -= amount
+    #       to = tx.find to_key
+    #       to["balance"] += amount
+    #       tx.save from, to
+    #     end
+    #   end
+    #
+    # @example Retry logic using the transactional update example above:
+    #   (1..5).each do |i|
+    #     begin
+    #       return transfer_funds from_key, to_key, amount
+    #     rescue Gcloud::Error => e
+    #       raise e if i == 5
+    #     end
+    #   end
+    #
+    # @example Transactional read:
+    #   task_list_key = datastore.key "TaskList", "default"
+    #   datastore.transaction do |tx|
+    #     task_list = tx.find task_list_key
+    #     query = tx.query("Task").ancestor(task_list)
+    #     tasks_in_list = tx.run query
+    #   end
+    #
     class Transaction < Dataset
       attr_reader :id
 
       ##
       # @private Creates a new Transaction instance.
-      # Takes a Connection instead of project and Credentials.
-      def initialize connection
-        @connection = connection
+      # Takes a Connection and Service instead of project and Credentials.
+      def initialize service
+        @service = service
         reset!
         start
       end
@@ -36,16 +68,76 @@ module Gcloud
       ##
       # Persist entities in a transaction.
       #
-      # @example
-      #   dataset.transaction do |tx|
-      #     if tx.find(user.key).nil?
-      #       tx.save task1, task2
+      # @example Transactional get or create:
+      #   task_key = datastore.key "Task", "sampleTask"
+      #
+      #   task = nil
+      #   datastore.transaction do |tx|
+      #     task = tx.find task_key
+      #     if task.nil?
+      #       task = datastore.entity task_key do |t|
+      #         t["type"] = "Personal"
+      #         t["done"] = false
+      #         t["priority"] = 4
+      #         t["description"] = "Learn Cloud Datastore"
+      #       end
+      #       tx.save task
       #     end
       #   end
       #
       def save *entities
         @commit.save(*entities)
-        # Do not save or assign auto_ids yet
+        # Do not save yet
+        entities
+      end
+      alias_method :upsert, :save
+
+      ##
+      # Insert entities in a transaction. An InvalidArgumentError will raised if
+      # the entities cannot be inserted.
+      #
+      # @example Transactional insert:
+      #   task_key = datastore.key "Task", "sampleTask"
+      #
+      #   task = nil
+      #   datastore.transaction do |tx|
+      #     task = tx.find task_key
+      #     if task.nil?
+      #       task = datastore.entity task_key do |t|
+      #         t["type"] = "Personal"
+      #         t["done"] = false
+      #         t["priority"] = 4
+      #         t["description"] = "Learn Cloud Datastore"
+      #       end
+      #       tx.insert task
+      #     end
+      #   end
+      #
+      def insert *entities
+        @commit.insert(*entities)
+        # Do not insert yet
+        entities
+      end
+
+      ##
+      # Update entities in a transaction. An InvalidArgumentError will raised if
+      # the entities cannot be updated.
+      #
+      # @example Transactional update:
+      #   task_key = datastore.key "Task", "sampleTask"
+      #
+      #   task = nil
+      #   datastore.transaction do |tx|
+      #     task = tx.find task_key
+      #     if task
+      #       task["done"] = true
+      #       tx.update task
+      #     end
+      #   end
+      #
+      def update *entities
+        @commit.update(*entities)
+        # Do not update yet
         entities
       end
 
@@ -53,8 +145,8 @@ module Gcloud
       # Remove entities in a transaction.
       #
       # @example
-      #   dataset.transaction do |tx|
-      #     if tx.find(user.key).nil?
+      #   datastore.transaction do |tx|
+      #     if tx.find(task_list.key).nil?
       #       tx.delete task1, task2
       #     end
       #   end
@@ -74,11 +166,11 @@ module Gcloud
       # @return [Gcloud::Datastore::Entity, nil]
       #
       # @example Finding an entity with a key:
-      #   key = dataset.key "Task", 123456
-      #   task = dataset.find key
+      #   task_key = datastore.key "Task", "sampleTask"
+      #   task = datastore.find task_key
       #
       # @example Finding an entity with a `kind` and `id`/`name`:
-      #   task = dataset.find "Task", 123456
+      #   task = datastore.find "Task", "sampleTask"
       #
       def find key_or_kind, id_or_name = nil
         key = key_or_kind
@@ -99,18 +191,21 @@ module Gcloud
       #
       # @example
       #   gcloud = Gcloud.new
-      #   dataset = gcloud.datastore
-      #   key1 = dataset.key "Task", 123456
-      #   key2 = dataset.key "Task", 987654
-      #   tasks = dataset.find_all key1, key2
+      #   datastore = gcloud.datastore
+      #   task_key1 = datastore.key "Task", 123456
+      #   task_key2 = datastore.key "Task", 987654
+      #   tasks = datastore.find_all task_key1, task_key2
       #
       def find_all *keys
-        response = connection.lookup(*keys.map(&:to_proto),
-                                     transaction: @id)
-        entities = to_gcloud_entities response.found
-        deferred = to_gcloud_keys response.deferred
-        missing  = to_gcloud_entities response.missing
+        ensure_service!
+        lookup_res = service.lookup(*keys.map(&:to_grpc),
+                                    transaction: @id)
+        entities = to_gcloud_entities lookup_res.found
+        deferred = to_gcloud_keys lookup_res.deferred
+        missing  = to_gcloud_entities lookup_res.missing
         LookupResults.new entities, deferred, missing
+      rescue GRPC::BadStatus => e
+        raise Gcloud::Error.from_error(e)
       end
       alias_method :lookup, :find_all
 
@@ -124,27 +219,29 @@ module Gcloud
       # @return [Gcloud::Datastore::Dataset::QueryResults]
       #
       # @example
-      #   query = dataset.query("Task").
-      #     where("completed", "=", true)
-      #   dataset.transaction do |tx|
+      #   query = datastore.query("Task").
+      #     where("done", "=", false)
+      #   datastore.transaction do |tx|
       #     tasks = tx.run query
       #   end
       #
       # @example Run the query within a namespace with the `namespace` option:
       #   query = Gcloud::Datastore::Query.new.kind("Task").
-      #     where("completed", "=", true)
-      #   dataset.transaction do |tx|
+      #     where("done", "=", false)
+      #   datastore.transaction do |tx|
       #     tasks = tx.run query, namespace: "ns~todo-project"
       #   end
       #
       def run query, namespace: nil
-        partition = optional_partition_id namespace
-        response = connection.run_query query.to_proto, partition,
-                                        transaction: @id
-        entities = to_gcloud_entities response.batch.entity_result
-        cursor = Proto.encode_cursor response.batch.end_cursor
-        more_results = Proto.to_more_results_string response.batch.more_results
-        QueryResults.new entities, cursor, more_results
+        ensure_service!
+        unless query.is_a?(Query) || query.is_a?(GqlQuery)
+          fail ArgumentError, "Cannot run a #{query.class} object."
+        end
+        query_res = service.run_query query.to_grpc, namespace,
+                                      transaction: @id
+        QueryResults.from_grpc query_res, service, namespace, query.to_grpc.dup
+      rescue GRPC::BadStatus => e
+        raise Gcloud::Error.from_error(e)
       end
       alias_method :run_query, :run
 
@@ -154,8 +251,11 @@ module Gcloud
       def start
         fail TransactionError, "Transaction already opened." unless @id.nil?
 
-        response = connection.begin_transaction
-        @id = response.transaction
+        ensure_service!
+        tx_res = service.begin_transaction
+        @id = tx_res.transaction
+      rescue GRPC::BadStatus => e
+        raise Gcloud::Error.from_error(e)
       end
       alias_method :begin_transaction, :start
 
@@ -169,17 +269,19 @@ module Gcloud
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
-      #   dataset = gcloud.datastore
+      #   datastore = gcloud.datastore
       #
-      #   user = dataset.entity "User", "heidi" do |u|
-      #     u["name"] = "Heidi Henderson"
-      #     u["email"] = "heidi@example.net"
+      #   task = datastore.entity "Task" do |t|
+      #     t["type"] = "Personal"
+      #     t["done"] = false
+      #     t["priority"] = 4
+      #     t["description"] = "Learn Cloud Datastore"
       #   end
       #
-      #   tx = dataset.transaction
+      #   tx = datastore.transaction
       #   begin
-      #     if tx.find(user.key).nil?
-      #       tx.save user
+      #     if tx.find(task.key).nil?
+      #       tx.save task
       #     end
       #     tx.commit
       #   rescue
@@ -190,9 +292,9 @@ module Gcloud
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
-      #   dataset = gcloud.datastore
+      #   datastore = gcloud.datastore
       #
-      #   tx = dataset.transaction
+      #   tx = datastore.transaction
       #   begin
       #     tx.commit do |c|
       #       c.save task1, task2
@@ -203,17 +305,25 @@ module Gcloud
       #   end
       #
       def commit
-        if @id.nil?
-          fail TransactionError, "Cannot commit when not in a transaction."
-        end
+        fail TransactionError,
+             "Cannot commit when not in a transaction." if @id.nil?
 
         yield @commit if block_given?
-        response = connection.commit @commit.mutation, @id
-        auto_id_assign_ids @commit.auto_id_entities,
-                           response.mutation_result.insert_auto_id_key
+
+        ensure_service!
+
+        commit_res = service.commit @commit.mutations, transaction: @id
+        entities = @commit.entities
+        returned_keys = commit_res.mutation_results.map(&:key)
+        returned_keys.each_with_index do |key, index|
+          next if entities[index].nil?
+          entities[index].key = Key.from_grpc(key) unless key.nil?
+        end
         # Make sure all entity keys are frozen so all show as persisted
-        @commit.entities.each { |e| e.key.freeze unless e.persisted? }
+        entities.each { |e| e.key.freeze unless e.persisted? }
         true
+      rescue GRPC::BadStatus => e
+        raise Gcloud::Error.from_error(e)
       end
 
       ##
@@ -223,17 +333,19 @@ module Gcloud
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
-      #   dataset = gcloud.datastore
+      #   datastore = gcloud.datastore
       #
-      #   user = dataset.entity "User", "heidi" do |u|
-      #     u["name"] = "Heidi Henderson"
-      #     u["email"] = "heidi@example.net"
+      #   task = datastore.entity "Task" do |t|
+      #     t["type"] = "Personal"
+      #     t["done"] = false
+      #     t["priority"] = 4
+      #     t["description"] = "Learn Cloud Datastore"
       #   end
       #
-      #   tx = dataset.transaction
+      #   tx = datastore.transaction
       #   begin
-      #     if tx.find(user.key).nil?
-      #       tx.save user
+      #     if tx.find(task.key).nil?
+      #       tx.save task
       #     end
       #     tx.commit
       #   rescue
@@ -244,8 +356,11 @@ module Gcloud
           fail TransactionError, "Cannot rollback when not in a transaction."
         end
 
-        connection.rollback @id
+        ensure_service!
+        service.rollback @id
         true
+      rescue GRPC::BadStatus => e
+        raise Gcloud::Error.from_error(e)
       end
 
       ##

data/lib/gcloud/dns/change/list.rb

@@ -52,10 +52,8 @@ module Gcloud
           changes = new(Array(resp.data["changes"]).map do |gapi_object|
             Change.from_gapi gapi_object, zone
           end)
-          changes.instance_eval do
-            @token = resp.data["nextPageToken"]
-            @zone = zone
-          end
+          changes.instance_variable_set "@token", resp.data["nextPageToken"]
+          changes.instance_variable_set "@zone",  zone
           changes
         end
 

data/lib/gcloud/dns/record/list.rb

@@ -73,10 +73,8 @@ module Gcloud
           records = new(Array(resp.data["rrsets"]).map do |gapi_object|
             Record.from_gapi gapi_object
           end)
-          records.instance_eval do
-            @token = resp.data["nextPageToken"]
-            @zone = zone
-          end
+          records.instance_variable_set "@token", resp.data["nextPageToken"]
+          records.instance_variable_set "@zone",  zone
           records
         end
 

data/lib/gcloud/dns/zone/list.rb

@@ -57,10 +57,8 @@ module Gcloud
           zones = new(Array(resp.data["managedZones"]).map do |gapi_object|
             Zone.from_gapi gapi_object, conn
           end)
-          zones.instance_eval do
-            @token = resp.data["nextPageToken"]
-            @connection = conn
-          end
+          zones.instance_variable_set "@token",      resp.data["nextPageToken"]
+          zones.instance_variable_set "@connection", conn
           zones
         end
 

data/lib/gcloud/grpc_utils.rb

@@ -72,5 +72,16 @@ module Gcloud
         Google::Protobuf::Value.new string_value: obj.to_s
       end
     end
+
+    ##
+    # @private Convert a Google::Protobuf::Map to a Hash
+    def self.map_to_hash map
+      if map.respond_to? :to_h
+        map.to_h
+      else
+        # Enumerable doesn't have to_h on ruby 2.0...
+        Hash[map.to_a]
+      end
+    end
   end
 end

data/lib/gcloud/logging/entry.rb

@@ -226,24 +226,13 @@ module Gcloud
           e.timestamp = extract_timestamp(grpc)
           e.severity = grpc.severity
           e.insert_id = grpc.insert_id
-          e.labels = map_to_hash(grpc.labels)
+          e.labels = GRPCUtils.map_to_hash(grpc.labels)
           e.payload = extract_payload(grpc)
-          e.instance_eval do
-            @resource = Resource.from_grpc grpc.resource
-            @http_request = HttpRequest.from_grpc grpc.http_request
-            @operation = Operation.from_grpc grpc.operation
-          end
-        end
-      end
-
-      ##
-      # @private Convert a Google::Protobuf::Map to a Hash
-      def self.map_to_hash map
-        if map.respond_to? :to_h
-          map.to_h
-        else
-          # Enumerable doesn't have to_h on ruby 2.0...
-          Hash[map.to_a]
+          e.instance_variable_set "@resource", Resource.from_grpc(grpc.resource)
+          e.instance_variable_set "@http_request",
+                                  HttpRequest.from_grpc(grpc.http_request)
+          e.instance_variable_set "@operation",
+                                  Operation.from_grpc(grpc.operation)
         end
       end
 

data/lib/gcloud/logging/entry/list.rb

@@ -85,15 +85,14 @@ module Gcloud
           entries = new(Array(grpc_list.entries).map do |grpc_entry|
             Entry.from_grpc grpc_entry
           end)
-          entries.instance_eval do
-            @token = grpc_list.next_page_token
-            @token = nil if @token == ""
-            @service = service
-            @projects = projects
-            @filter = filter
-            @order = order
-            @max = max
-          end
+          token = grpc_list.next_page_token
+          token = nil if token == ""
+          entries.instance_variable_set "@token", token
+          entries.instance_variable_set "@service", service
+          entries.instance_variable_set "@projects", projects
+          entries.instance_variable_set "@filter", filter
+          entries.instance_variable_set "@order", order
+          entries.instance_variable_set "@max", max
           entries
         end