gcloud 0.12.2 → 0.20.0

data/lib/gcloud/datastore/service.rb

@@ -1,167 +0,0 @@
-# Copyright 2016 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 "gcloud/datastore/credentials"
-require "google/datastore/v1beta3/datastore_services"
-require "gcloud/backoff"
-
-module Gcloud
-  module Datastore
-    ##
-    # @private Represents the gRPC Datastore service, including all the API
-    # methods.
-    class Service
-      attr_accessor :project, :credentials, :host, :retries, :timeout
-
-      ##
-      # Creates a new Service instance.
-      def initialize project, credentials, host: nil, retries: nil, timeout: nil
-        @project = project
-        @credentials = credentials
-        @host = host || "datastore.googleapis.com"
-        @retries = retries
-        @timeout = timeout
-      end
-
-      def creds
-        return credentials if insecure?
-        GRPC::Core::ChannelCredentials.new.compose \
-          GRPC::Core::CallCredentials.new credentials.client.updater_proc
-      end
-
-      def datastore
-        return mocked_datastore if mocked_datastore
-        @datastore ||= Google::Datastore::V1beta3::Datastore::Stub.new(
-          host, creds, timeout: timeout)
-      end
-      attr_accessor :mocked_datastore
-
-      def insecure?
-        credentials == :this_channel_is_insecure
-      end
-
-      ##
-      # Allocate IDs for incomplete keys.
-      # (This is useful for referencing an entity before it is inserted.)
-      def allocate_ids *incomplete_keys
-        allocate_req = Google::Datastore::V1beta3::AllocateIdsRequest.new(
-          project_id: project,
-          keys: incomplete_keys
-        )
-
-        execute { datastore.allocate_ids allocate_req }
-      end
-
-      ##
-      # Look up entities by keys.
-      def lookup *keys, consistency: nil, transaction: nil
-        lookup_req = Google::Datastore::V1beta3::LookupRequest.new(
-          project_id: project,
-          keys: keys
-        )
-        lookup_req.read_options = generate_read_options consistency, transaction
-
-        execute { datastore.lookup lookup_req }
-      end
-
-      # Query for entities.
-      def run_query query, namespace = nil, consistency: nil, transaction: nil
-        run_req = Google::Datastore::V1beta3::RunQueryRequest.new(
-          project_id: project)
-        if query.is_a? Google::Datastore::V1beta3::Query
-          run_req["query"] = query
-        elsif query.is_a? Google::Datastore::V1beta3::GqlQuery
-          run_req["gql_query"] = query
-        else
-          fail ArgumentError, "Unable to query with a #{query.class} object."
-        end
-        run_req.read_options = generate_read_options consistency, transaction
-
-        run_req.partition_id = Google::Datastore::V1beta3::PartitionId.new(
-          namespace_id: namespace) if namespace
-
-        execute { datastore.run_query run_req }
-      end
-
-      ##
-      # Begin a new transaction.
-      def begin_transaction
-        tx_req = Google::Datastore::V1beta3::BeginTransactionRequest.new(
-          project_id: project
-        )
-
-        execute { datastore.begin_transaction tx_req }
-      end
-
-      ##
-      # Commit a transaction, optionally creating, deleting or modifying
-      # some entities.
-      def commit mutations, transaction: nil
-        commit_req = Google::Datastore::V1beta3::CommitRequest.new(
-          project_id: project,
-          mode: :NON_TRANSACTIONAL,
-          mutations: mutations
-        )
-        if transaction
-          commit_req.mode = :TRANSACTIONAL
-          commit_req.transaction = transaction
-        end
-
-        execute { datastore.commit commit_req }
-      end
-
-      ##
-      # Roll back a transaction.
-      def rollback transaction
-        rb_req = Google::Datastore::V1beta3::RollbackRequest.new(
-          project_id: project,
-          transaction: transaction
-        )
-
-        execute { datastore.rollback rb_req }
-      end
-
-      def inspect
-        "#{self.class}(#{@project})"
-      end
-
-      ##
-      # Performs backoff and error handling
-      def execute
-        Gcloud::Backoff.new(retries: retries).execute_grpc do
-          yield
-        end
-      rescue GRPC::BadStatus => e
-        raise Gcloud::Error.from_error(e)
-      end
-
-      protected
-
-      def generate_read_options consistency, transaction
-        if consistency == :eventual
-          return Google::Datastore::V1beta3::ReadOptions.new(
-            read_consistency: :EVENTUAL)
-        elsif consistency == :strong
-          return  Google::Datastore::V1beta3::ReadOptions.new(
-            read_consistency: :STRONG)
-        elsif transaction
-          return  Google::Datastore::V1beta3::ReadOptions.new(
-            transaction: transaction)
-        end
-        nil
-      end
-    end
-  end
-end

data/lib/gcloud/datastore/transaction.rb

@@ -1,362 +0,0 @@
-# Copyright 2014 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 Datastore
-    ##
-    # # Transaction
-    #
-    # 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 and Service instead of project and Credentials.
-      def initialize service
-        @service = service
-        reset!
-        start
-      end
-
-      ##
-      # Persist entities in a transaction.
-      #
-      # @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 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
-
-      ##
-      # Remove entities in a transaction.
-      #
-      # @example
-      #   datastore.transaction do |tx|
-      #     if tx.find(task_list.key).nil?
-      #       tx.delete task1, task2
-      #     end
-      #   end
-      #
-      def delete *entities_or_keys
-        @commit.delete(*entities_or_keys)
-        # Do not delete yet
-        true
-      end
-
-      ##
-      # Retrieve an entity by providing key information. The lookup is run
-      # within the transaction.
-      #
-      # @param [Key, String] key_or_kind A Key object or `kind` string value.
-      #
-      # @return [Gcloud::Datastore::Entity, nil]
-      #
-      # @example Finding an entity with a key:
-      #   task_key = datastore.key "Task", "sampleTask"
-      #   task = datastore.find task_key
-      #
-      # @example Finding an entity with a `kind` and `id`/`name`:
-      #   task = datastore.find "Task", "sampleTask"
-      #
-      def find key_or_kind, id_or_name = nil
-        key = key_or_kind
-        unless key.is_a? Gcloud::Datastore::Key
-          key = Key.new key_or_kind, id_or_name
-        end
-        find_all(key).first
-      end
-      alias_method :get, :find
-
-      ##
-      # Retrieve the entities for the provided keys. The lookup is run within
-      # the transaction.
-      #
-      # @param [Key] keys One or more Key objects to find records for.
-      #
-      # @return [Gcloud::Datastore::Dataset::LookupResults]
-      #
-      # @example
-      #   gcloud = Gcloud.new
-      #   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
-        ensure_service!
-        lookup_res = service.lookup(*Array(keys).flatten.map(&:to_grpc),
-                                    transaction: @id)
-        LookupResults.from_grpc lookup_res, service, nil, @id
-      end
-      alias_method :lookup, :find_all
-
-      ##
-      # Retrieve entities specified by a Query. The query is run within the
-      # transaction.
-      #
-      # @param [Query] query The Query object with the search criteria.
-      # @param [String] namespace The namespace the query is to run within.
-      #
-      # @return [Gcloud::Datastore::Dataset::QueryResults]
-      #
-      # @example
-      #   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("done", "=", false)
-      #   datastore.transaction do |tx|
-      #     tasks = tx.run query, namespace: "ns~todo-project"
-      #   end
-      #
-      def run query, namespace: nil
-        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
-      end
-      alias_method :run_query, :run
-
-      ##
-      # Begins a transaction.
-      # This method is run when a new Transaction is created.
-      def start
-        fail TransactionError, "Transaction already opened." unless @id.nil?
-
-        ensure_service!
-        tx_res = service.begin_transaction
-        @id = tx_res.transaction
-      end
-      alias_method :begin_transaction, :start
-
-      ##
-      # Commits a transaction.
-      #
-      # @yield [commit] an optional block for making changes
-      # @yieldparam [Commit] commit The object that changes are made on
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   datastore = gcloud.datastore
-      #
-      #   task = datastore.entity "Task" do |t|
-      #     t["type"] = "Personal"
-      #     t["done"] = false
-      #     t["priority"] = 4
-      #     t["description"] = "Learn Cloud Datastore"
-      #   end
-      #
-      #   tx = datastore.transaction
-      #   begin
-      #     if tx.find(task.key).nil?
-      #       tx.save task
-      #     end
-      #     tx.commit
-      #   rescue
-      #     tx.rollback
-      #   end
-      #
-      # @example Commit can be passed a block, same as {Dataset#commit}:
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   datastore = gcloud.datastore
-      #
-      #   tx = datastore.transaction
-      #   begin
-      #     tx.commit do |c|
-      #       c.save task1, task2
-      #       c.delete entity1, entity2
-      #     end
-      #   rescue
-      #     tx.rollback
-      #   end
-      #
-      def commit
-        fail TransactionError,
-             "Cannot commit when not in a transaction." if @id.nil?
-
-        yield @commit if block_given?
-
-        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
-        entities.each { |e| e.key.freeze unless e.persisted? }
-        true
-      end
-
-      ##
-      # Rolls a transaction back.
-      #
-      # @example
-      #   require "gcloud"
-      #
-      #   gcloud = Gcloud.new
-      #   datastore = gcloud.datastore
-      #
-      #   task = datastore.entity "Task" do |t|
-      #     t["type"] = "Personal"
-      #     t["done"] = false
-      #     t["priority"] = 4
-      #     t["description"] = "Learn Cloud Datastore"
-      #   end
-      #
-      #   tx = datastore.transaction
-      #   begin
-      #     if tx.find(task.key).nil?
-      #       tx.save task
-      #     end
-      #     tx.commit
-      #   rescue
-      #     tx.rollback
-      #   end
-      def rollback
-        if @id.nil?
-          fail TransactionError, "Cannot rollback when not in a transaction."
-        end
-
-        ensure_service!
-        service.rollback @id
-        true
-      end
-
-      ##
-      # Reset the transaction.
-      # {Transaction#start} must be called afterwards.
-      def reset!
-        @id = nil
-        @commit = Commit.new
-      end
-    end
-  end
-end