gcloud 0.4.1 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGI1YjI0MjIxZDhhNmI1YjY0ZWM2MjY0YTg5ZDY3OWZlMmVlYjhhNw==
+    NGQ2OGZmZTRjOGY4ZGRiNjZmZTE0OGExZTZmODJkYjE4MmJlN2E4YQ==
   data.tar.gz: !binary |-
-    MzdkOGRmYTY3MmQ0YzU0ZGM4YmIwZGQwNDdmY2EzNDNjYTY4NjRlYg==
+    YmYxMDQyOGNjNDBhZmMyNTgwMjBkYzhiM2Y4YTk0Y2JkYzQxN2QwNg==
 SHA512:
   metadata.gz: !binary |-
-    MTU4ZGJkZmM4YTg2YWY2YWNiYjQyYmQxNDM3YzBhNTczZDViMzgzMGQyMGIz
-    ODVlY2JmNDJjNjljMmRlZTY5MmZhNzdiZTg3ZjUxMTI0MjM5ZTA5OWM4Njg4
-    NzdiNmE4ZTVjOTk3MzIwODliYjM0NTcyNmFmNDVmYWFhZDU3OWM=
+    MGEwZmE1NzFkZGQ1MzE1YTliMmM5MDhmNWQ0MDliMTkxMDk4ZjUyNWI2MmQy
+    NGZkNWNkZTJhODY2OGJmMDg1Zjg2MWMwMzVlMzAyNDJkMmFmZmJlNWM4Y2Zk
+    NjJjNWRiZmU5YzM2ZjRmMjQ3MWE1MWE5ZmZhMDU5ZGI2NjczMWM=
   data.tar.gz: !binary |-
-    NjNkMTAzNDI0YWE1ZWJjOTVjZGMzZjZlMGNhOTQ2NWNmYWZkZGE2NzFkMDY5
-    MGU3OTkxMGRlZWIzNjQzOGM4OTJhNWExY2MyM2E1NzQ1MDNhZTNjMjhkMjAz
-    ZjZkZGI2OGJkMjliYzQyNTkyMmFkNzU2MDRkNmNiYWQxYWE4ZmE=
+    NDI4OGMxMmVkMGVjMDBiMTExM2E5MGNmMGJhMTc0ODFlYjIwMTRlNTc1MDli
+    OTg1NjJjMDdkYTJiNDZjMGU1YmYyNTFjZWU4MzgzNzdlZDYyZDYwNGM1MjYy
+    YmRmMjJkZDNjMTAyMjBlMmZjY2FhMGRiZDc3ODkxYTA0NDczODI=

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 0.5.0 / 2015-10-29
+
+#### Changes
+
+* Add support for Release Manager service
+* Pub/Sub Additions
+  * Fix issue getting and setting policies (jeffmendoza)
+  * Modified `autocreate` default value and behavior
+  * Add `skip_lookup` option on resource lookup methods
+  * Add `Project#publish` method
+  * Add `Project#subscribe` method
+* Datastore Additions
+  * Add `namespace` option on running queries (jondot)
+  * Add `query`, `entity`, and `key` helpers to Dataset
+
 ### 0.4.1 / 2015-10-20
 
 #### Changes

data/OVERVIEW.md

@@ -53,16 +53,16 @@ gcloud = Gcloud.new
 dataset = gcloud.datastore
 
 # Create a new task to demo datastore
-demo_task = Gcloud::Datastore::Entity.new
-demo_task.key = Gcloud::Datastore::Key.new "Task", "datastore-demo"
-demo_task[:description] = "Demonstrate Datastore functionality"
-demo_task[:completed] = false
+demo_task = dataset.entity "Task", "datastore-demo" do |t|
+  t["description"] = "Demonstrate Datastore functionality"
+  t["completed"] = false
+end
 
 # Save the new task
 dataset.save demo_task
 
 # Run a query for all completed tasks
-query = Gcloud::Datastore::Query.new.kind("Task").
+query = dataset.query("Task").
   where("completed", "=", true)
 completed_tasks = dataset.run query
 ```
@@ -120,6 +120,39 @@ sub = pubsub.subscription "my-topic-sub"
 msgs = sub.pull
 ```
 
+# Resource Manager
+
+[Google Cloud Resource Manager](https://cloud.google.com/resource-manager/) ([docs](https://cloud.google.com/resource-manager/reference/rest/)) provides methods that you can use to programmatically manage your projects in the Google Cloud Platform. You may be familiar with managing projects in the [Developers Console](https://developers.google.com/console/help/new/). With this API you can do the following:
+
+* Get a list of all projects associated with an account
+* Create new projects
+* Update existing projects
+* Delete projects
+* Undelete, or recover, projects that you don't want to delete
+
+See the [gcloud-ruby Resource Manager API documentation](rdoc-ref:Gcloud::ResourceManager) to learn how to connect to Cloud Resource Manager using this library.
+
+```ruby
+require "gcloud"
+
+gcloud = Gcloud.new
+resource_manager = gcloud.resource_manager
+
+# List all projects
+resource_manager.projects.each do |project|
+  puts projects.project_id
+end
+
+# Label a project as production
+project = resource_manager.project "tokyo-rain-123"
+project.update do |p|
+  p.labels["env"] = "production"
+end
+
+# List only projects with the "production" label
+projects = resource_manager.projects filter: "labels.env:production"
+```
+
 # Storage
 
 [Google Cloud Storage](https://cloud.google.com/storage/) ([docs](https://cloud.google.com/storage/docs/json_api/)) allows you to store data on Google infrastructure with very high reliability, performance and availability, and can be used to distribute large data objects to users via direct download.

data/lib/gcloud.rb

@@ -96,10 +96,10 @@ module Gcloud
   #   gcloud  = Gcloud.new
   #   dataset = gcloud.datastore
   #
-  #   entity = Gcloud::Datastore::Entity.new
-  #   entity.key = Gcloud::Datastore::Key.new "Task"
-  #   entity["description"] = "Get started with Google Cloud"
-  #   entity["completed"] = false
+  #   entity = dataset.entity "Task" do |t|
+  #     t["description"] = "Get started with Google Cloud"
+  #     t["completed"] = false
+  #   end
   #
   #   dataset.save entity
   #
@@ -299,4 +299,55 @@ module Gcloud
     require "gcloud/dns"
     Gcloud.dns @project, @keyfile, options
   end
+
+  # rubocop:disable Metrics/LineLength
+  # Disabled because the readonly scope in the example code is long and we can't
+  # shorten it.
+
+  ##
+  # Creates a new object for connecting to the Resource Manager service.
+  # Each call creates a new connection.
+  #
+  # === Parameters
+  #
+  # +options+::
+  #   An optional Hash for controlling additional behavior. (+Hash+)
+  # <code>options[:scope]</code>::
+  #   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 scope is:
+  #
+  #   * +https://www.googleapis.com/auth/cloud-platform+
+  #
+  # === Returns
+  #
+  # Gcloud::ResourceManager::Manager
+  #
+  # === Examples
+  #
+  #   require "gcloud"
+  #
+  #   gcloud = Gcloud.new
+  #   resource_manager = gcloud.resource_manager
+  #   resource_manager.projects.each do |project|
+  #     puts projects.project_id
+  #   end
+  #
+  # The default scope can be overridden with the +scope+ option:
+  #
+  #   require "gcloud"
+  #
+  #   gcloud  = Gcloud.new
+  #   readonly_scope = "https://www.googleapis.com/auth/cloudresourcemanager.readonly"
+  #   resource_manager = gcloud.resource_manager scope: readonly_scope
+  #
+  def resource_manager options = {}
+    require "gcloud/resource_manager"
+    Gcloud.resource_manager @keyfile, options
+  end
+
+  # rubocop:enable Metrics/LineLength
 end

data/lib/gcloud/bigquery/data.rb

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "delegate"
+
 module Gcloud
   module Bigquery
     ##

data/lib/gcloud/bigquery/dataset.rb

@@ -530,7 +530,7 @@ module Gcloud
       # === Returns
       #
       # Array of Gcloud::Bigquery::Table or Gcloud::Bigquery::View
-      # (Gcloud::Bigquery::Table::List)
+      # (See Gcloud::Bigquery::Table::List)
       #
       # === Examples
       #

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

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "delegate"
+
 module Gcloud
   module Bigquery
     class Dataset

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

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "delegate"
+
 module Gcloud
   module Bigquery
     class Job

data/lib/gcloud/bigquery/project.rb

@@ -266,10 +266,6 @@ module Gcloud
         end
       end
 
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
-      # Disabled rubocop because the level of abstraction is not violated here
-
       ##
       # Creates a new dataset.
       #
@@ -357,9 +353,6 @@ module Gcloud
         end
       end
 
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
-
       ##
       # Retrieves the list of datasets belonging to the project.
       #
@@ -378,7 +371,7 @@ module Gcloud
       #
       # === Returns
       #
-      # Array of Gcloud::Bigquery::Dataset (Gcloud::Bigquery::Dataset::List)
+      # Array of Gcloud::Bigquery::Dataset (See Gcloud::Bigquery::Dataset::List)
       #
       # === Examples
       #
@@ -489,7 +482,7 @@ module Gcloud
       #
       # === Returns
       #
-      # Array of Gcloud::Bigquery::Job (Gcloud::Bigquery::Job::List)
+      # Array of Gcloud::Bigquery::Job (See Gcloud::Bigquery::Job::List)
       #
       # === Examples
       #

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

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "delegate"
+
 module Gcloud
   module Bigquery
     class Table

data/lib/gcloud/datastore.rb

@@ -57,10 +57,10 @@ module Gcloud
   #   dataset = Gcloud.datastore "my-todo-project",
   #                              "/path/to/keyfile.json"
   #
-  #   entity = Gcloud::Datastore::Entity.new
-  #   entity.key = Gcloud::Datastore::Key.new "Task"
-  #   entity["description"] = "Get started with Google Cloud"
-  #   entity["completed"] = false
+  #   entity = dataset.entity "Task" do |t|
+  #     t["description"] = "Get started with Google Cloud"
+  #     t["completed"] = false
+  #   end
   #
   #   dataset.save entity
   #
@@ -125,7 +125,7 @@ module Gcloud
   #
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
-  #   key = Gcloud::Datastore::Key.new "Task", 12345
+  #   key = dataset.key "Task", 12345
   #   entity = dataset.find key
   #
   # See Gcloud::Datastore::Dataset#find
@@ -139,8 +139,7 @@ module Gcloud
   #
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
-  #   query = Gcloud::Datastore::Query.new
-  #   query.kind("List").
+  #   query = dataset.query("List").
   #     where("active", "=", true)
   #   active_lists = dataset.run query
   #
@@ -150,8 +149,7 @@ module Gcloud
   #
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
-  #   query = Gcloud::Datastore::Query.new
-  #   query.kind("List").
+  #   query = dataset.query("List").
   #     where("active", "=", true).
   #     order("name")
   #   active_lists = dataset.run query
@@ -163,8 +161,7 @@ module Gcloud
   #
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
-  #   query = Gcloud::Datastore::Query.new
-  #   query.kind("List").
+  #   query = dataset.query("List").
   #     where("active", "=", true).
   #     order("name").
   #     limit(5)
@@ -179,8 +176,7 @@ module Gcloud
   #   dataset = gcloud.datastore
   #
   #   list = dataset.find "List", "todos"
-  #   query = Gcloud::Datastore::Query.new
-  #   query.kind("Task").
+  #   query = dataset.query("Task").
   #     ancestor(list.key)
   #   items = dataset.run query
   #
@@ -198,8 +194,7 @@ module Gcloud
   #   dataset = gcloud.datastore
   #
   #   list = dataset.find "List", "todos"
-  #   query = Gcloud::Datastore::Query.new
-  #   query.kind("Task").
+  #   query = dataset.query("Task").
   #     ancestor(list.key)
   #   all_tasks = []
   #   tmp_tasks = dataset.run query
@@ -228,9 +223,9 @@ module Gcloud
   #
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
-  #   entity = Gcloud::Datastore::Entity.new
-  #   entity.key = Gcloud::Datastore::Key.new "User"
-  #   entity["name"] = "Heidi Henderson"
+  #   entity = dataset.entity "User" do |e|
+  #     e["name"] = "Heidi Henderson"
+  #   end
   #   entity.key.id #=> nil
   #   dataset.save entity
   #   entity.key.id #=> 123456789
@@ -277,12 +272,12 @@ module Gcloud
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
   #
-  #   key = Gcloud::Datastore::Key.new "User", "heidi"
+  #   key = dataset.key "User", "heidi"
   #
-  #   user = Gcloud::Datastore::Entity.new
-  #   user.key = key
-  #   user["name"] = "Heidi Henderson"
-  #   user["email"] = "heidi@example.net"
+  #   user = dataset.entity key do |u|
+  #     u["name"] = "Heidi Henderson"
+  #     u["email"] = "heidi@example.net"
+  #   end
   #
   #   dataset.transaction do |tx|
   #     if tx.find(user.key).nil?
@@ -298,12 +293,12 @@ module Gcloud
   #   gcloud = Gcloud.new
   #   dataset = gcloud.datastore
   #
-  #   key = Gcloud::Datastore::Key.new "User", "heidi"
+  #   key = dataset.key "User", "heidi"
   #
-  #   user = Gcloud::Datastore::Entity.new
-  #   user.key = key
-  #   user["name"] = "Heidi Henderson"
-  #   user["email"] = "heidi@example.net"
+  #   user = dataset.entity key do |u|
+  #     u["name"] = "Heidi Henderson"
+  #     u["email"] = "heidi@example.net"
+  #   end
   #
   #   tx = dataset.transaction
   #   begin

data/lib/gcloud/datastore/connection.rb

@@ -67,9 +67,11 @@ module Gcloud
       end
 
       # Query for entities.
-      def run_query query
+      def run_query query, partition = nil
         run_query = Proto::RunQueryRequest.new.tap do |rq|
           rq.query = query
+          rq.partition_id = partition if partition
+          rq
         end
 
         Proto::RunQueryResponse.decode rpc("runQuery", run_query)

data/lib/gcloud/datastore/dataset.rb

@@ -39,7 +39,7 @@ module Gcloud
     #   gcloud = Gcloud.new
     #   dataset = gcloud.datastore
     #
-    #   query = Gcloud::Datastore::Query.new.kind("Task").
+    #   query = dataset.query("Task").
     #     where("completed", "=", true)
     #
     #   tasks = dataset.run query
@@ -101,7 +101,7 @@ module Gcloud
       #
       # === Example
       #
-      #   empty_key = Gcloud::Datastore::Key.new "Task"
+      #   empty_key = dataset.key "Task"
       #   task_keys = dataset.allocate_ids empty_key, 5
       #
       def allocate_ids incomplete_key, count = 1
@@ -160,7 +160,7 @@ module Gcloud
       #
       # Finding an entity with a key:
       #
-      #   key = Gcloud::Datastore::Key.new "Task", 123456
+      #   key = dataset.key "Task", 123456
       #   task = dataset.find key
       #
       # Finding an entity with a +kind+ and +id+/+name+:
@@ -169,7 +169,9 @@ module Gcloud
       #
       def find key_or_kind, id_or_name = nil
         key = key_or_kind
-        key = Key.new key_or_kind, id_or_name unless key_or_kind.is_a? Key
+        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
@@ -190,8 +192,8 @@ module Gcloud
       #
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
-      #   key1 = Gcloud::Datastore::Key.new "Task", 123456
-      #   key2 = Gcloud::Datastore::Key.new "Task", 987654
+      #   key1 = dataset.key "Task", 123456
+      #   key2 = dataset.key "Task", 987654
       #   tasks = dataset.find_all key1, key2
       #
       def find_all *keys
@@ -239,19 +241,31 @@ module Gcloud
       #
       # +query+::
       #   The Query object with the search criteria. (+Query+)
+      # +options+::
+      #   An optional Hash for controlling additional behavior. (+Hash+)
+      # <code>options[:namespace]</code>::
+      #   The namespace the query is to run within. (+String+)
       #
       # === Returns
       #
       # Gcloud::Datastore::Dataset::QueryResults
       #
-      # === Example
+      # === Examples
       #
-      #   query = Gcloud::Datastore::Query.new.kind("Task").
+      #   query = dataset.query("Task").
       #     where("completed", "=", true)
       #   tasks = dataset.run query
       #
-      def run query
-        response = connection.run_query query.to_proto
+      # The query can optionally run within namespace when the +namespace+
+      # option is provided:
+      #
+      #   query = Gcloud::Datastore::Query.new.kind("Task").
+      #     where("completed", "=", true)
+      #   tasks = dataset.run query, namespace: "ns~todo-project"
+      #
+      def run query, options = {}
+        partition = optional_partition_id options[:namespace]
+        response = connection.run_query query.to_proto, partition
         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
@@ -271,12 +285,10 @@ module Gcloud
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
       #
-      #   key = Gcloud::Datastore::Key.new "User", "heidi"
-      #
-      #   user = Gcloud::Datastore::Entity.new
-      #   user.key = key
-      #   user["name"] = "Heidi Henderson"
-      #   user["email"] = "heidi@example.net"
+      #   user = dataset.entity "User", "heidi" do |u|
+      #     u["name"] = "Heidi Henderson"
+      #     u["email"] = "heidi@example.net"
+      #   end
       #
       #   dataset.transaction do |tx|
       #     if tx.find(user.key).nil?
@@ -291,12 +303,10 @@ module Gcloud
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
       #
-      #   key = Gcloud::Datastore::Key.new "User", "heidi"
-      #
-      #   user = Gcloud::Datastore::Entity.new
-      #   user.key = key
-      #   user["name"] = "Heidi Henderson"
-      #   user["email"] = "heidi@example.net"
+      #   user = dataset.entity "User", "heidi" do |u|
+      #     u["name"] = "Heidi Henderson"
+      #     u["email"] = "heidi@example.net"
+      #   end
       #
       #   tx = dataset.transaction
       #   begin
@@ -321,6 +331,133 @@ module Gcloud
         end
       end
 
+      ##
+      # Create a new Query instance. This is a convenience method to make the
+      # creation of Query objects easier.
+      #
+      # === Parameters
+      #
+      # +kinds+::
+      #   The kind of entities to query. This is optional. (+String+)
+      #
+      # === Returns
+      #
+      # Gcloud::Datastore::Query
+      #
+      # === Example
+      #
+      #   query = dataset.query("Task").
+      #     where("completed", "=", true)
+      #   tasks = dataset.run query
+      #
+      # This code is equivalent to the following:
+      #
+      #   query = Gcloud::Datastore::Query.new.
+      #     kind("Task").
+      #     where("completed", "=", true)
+      #   tasks = dataset.run query
+      #
+      def query *kinds
+        query = Query.new
+        query.kind(*kinds) unless kinds.empty?
+        query
+      end
+
+      ##
+      # Create a new Key instance. This is a convenience method to make the
+      # creation of Key objects easier.
+      #
+      # === Parameters
+      #
+      # +kind+::
+      #   The kind of the Key. This is optional. (+String+)
+      # +id_or_name+::
+      #   The id or name of the Key. This is optional. (+Integer+ or +String+)
+      #
+      # === Returns
+      #
+      # Gcloud::Datastore::Key
+      #
+      # === Example
+      #
+      #   key = dataset.key "User", "heidi@example.com"
+      #
+      # This code is equivalent to the following:
+      #
+      #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+      #
+      def key kind = nil, id_or_name = nil
+        Key.new kind, id_or_name
+      end
+
+      ##
+      # Create a new empty Entity instance. This is a convenience method to make
+      # the creation of Entity objects easier.
+      #
+      # === Parameters
+      #
+      # +key_or_kind+::
+      #   A Key object or +kind+ string value. This is optional. (+Key+ or
+      #   +String+ or +nil+)
+      # +id_or_name+::
+      #   The Key's +id+ or +name+ value if a +kind+ was provided in the first
+      #   parameter. (+Integer+ or +String+ or +nil+)
+      #
+      # === Returns
+      #
+      # Gcloud::Datastore::Entity
+      #
+      # === Examples
+      #
+      #   entity = dataset.entity
+      #
+      # This code is equivalent to the following:
+      #
+      #   entity = Gcloud::Datastore::Entity.new
+      #
+      # The key can also be passed in as an object:
+      #
+      #   key = dataset.key "User", "heidi@example.com"
+      #   entity = dataset.entity key
+      #
+      # Or the key values can be passed in as parameters:
+      #
+      #   entity = dataset.entity "User", "heidi@example.com"
+      #
+      # This code is equivalent to the following:
+      #
+      #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+      #   entity = Gcloud::Datastore::Entity.new
+      #   entity.key = key
+      #
+      # The newly created entity object can also be configured using a block:
+      #
+      #   user = dataset.entity "User", "heidi@example.com" do |u|
+      #     u["name"] = "Heidi Henderson"
+      #  end
+      #
+      # This code is equivalent to the following:
+      #
+      #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+      #   entity = Gcloud::Datastore::Entity.new
+      #   entity.key = key
+      #   entity["name"] = "Heidi Henderson"
+      #
+      def entity key_or_kind = nil, id_or_name = nil
+        entity = Entity.new
+
+        # Set the key
+        key = key_or_kind
+        unless key.is_a? Gcloud::Datastore::Key
+          key = Key.new key_or_kind, id_or_name
+        end
+        entity.key = key
+
+        yield entity if block_given?
+
+        entity
+      end
+
       protected
 
       ##
@@ -372,6 +509,14 @@ module Gcloud
           end
         end
       end
+
+      def optional_partition_id namespace = nil
+        return nil if namespace.nil?
+        Proto::PartitionId.new.tap do |p|
+          p.namespace = namespace
+          p.dataset_id = project
+        end
+      end
     end
   end
 end