gcloud 0.4.1 → 0.5.0

data/lib/gcloud/datastore/dataset/lookup_results.rb

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

data/lib/gcloud/datastore/dataset/query_results.rb

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

data/lib/gcloud/datastore/entity.rb

@@ -26,9 +26,9 @@ module Gcloud
     # Every Entity has a Key, and a list of properties.
     #
     #   entity = Gcloud::Datastore::Entity.new
-    #   entity.key = Gcloud::Datastore::Key.new "User", "username"
-    #   entity["name"] = "User McUser"
-    #   entity["email"] = "user@example.net"
+    #   entity.key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+    #   entity["name"] = "Heidi Henderson"
+    #
     class Entity
       ##
       # The Key that identifies the entity.
@@ -62,7 +62,7 @@ module Gcloud
       #
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
-      #   user = dataset.find "User", "heidi"
+      #   user = dataset.find "User", "heidi@example.com"
       #   user["name"] #=> "Heidi Henderson"
       #
       # Or with a symbol name:
@@ -71,7 +71,7 @@ module Gcloud
       #
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
-      #   user = dataset.find "User", "heidi"
+      #   user = dataset.find "User", "heidi@example.com"
       #   user[:name] #=> "Heidi Henderson"
       #
       def [] prop_name
@@ -96,7 +96,7 @@ module Gcloud
       #
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
-      #   user = dataset.find "User", "heidi"
+      #   user = dataset.find "User", "heidi@example.com"
       #   user["name"] = "Heidi H. Henderson"
       #
       # Or with a symbol name:
@@ -105,7 +105,7 @@ module Gcloud
       #
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
-      #   user = dataset.find "User", "heidi"
+      #   user = dataset.find "User", "heidi@example.com"
       #   user[:name] = "Heidi H. Henderson"
       #
       def []= prop_name, prop_value
@@ -122,8 +122,8 @@ module Gcloud
       #
       # === Example
       #
-      #   entity.properties[:name] = "User McUser"
-      #   entity.properties["name"] #=> "User McUser"
+      #   entity.properties[:name] = "Heidi H. Henderson"
+      #   entity.properties["name"] #=> "Heidi H. Henderson"
       #
       #   entity.properties.each do |name, value|
       #     puts "property #{name} has a value of #{value}"
@@ -168,7 +168,7 @@ module Gcloud
       #
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
-      #   entity = dataset.find "User", "heidi"
+      #   entity = dataset.find "User", "heidi@example.com"
       #   entity.persisted? #=> true
       #   entity.key = Gcloud::Datastore::Key.new "User" #=> RuntimeError
       #   entity.key.frozen? #=> true
@@ -192,7 +192,7 @@ module Gcloud
       #   new_entity = Gcloud::Datastore::Entity.new
       #   new_entity.persisted? #=> false
       #
-      #   found_entity = dataset.find "User", "heidi"
+      #   found_entity = dataset.find "User", "heidi@example.com"
       #   found_entity.persisted? #=> true
       #
       def persisted?

data/lib/gcloud/datastore/key.rb

@@ -25,7 +25,7 @@ module Gcloud
     # name string, assigned explicitly by the application, or an integer numeric
     # ID, assigned automatically by Datastore.
     #
-    #   key = Gcloud::Datastore::Key.new "User", "username"
+    #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
     class Key
       ##
       # The kind of the Key.
@@ -57,7 +57,7 @@ module Gcloud
       #                       "/path/to/keyfile.json"
       #
       #   dataset = gcloud.datastore
-      #   entity = dataset.find "User", "heidi"
+      #   entity = dataset.find "User", "heidi@example.com"
       #   entity.key.dataset_id #=> "my-todo-project"
       #
       attr_accessor :dataset_id
@@ -77,11 +77,29 @@ module Gcloud
       #                       "/path/to/keyfile.json"
       #
       #   dataset = gcloud.datastore
-      #   entity = dataset.find "User", "heidi"
+      #   entity = dataset.find "User", "heidi@example.com"
       #   entity.key.namespace #=> "ns~todo-project"
       #
       attr_accessor :namespace
 
+      ##
+      # Create a new Key instance.
+      #
+      # === 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::Dataset::Key
+      #
+      # === Example
+      #
+      #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+      #
       def initialize kind = nil, id_or_name = nil
         @kind = kind
         if id_or_name.is_a? Integer
@@ -101,9 +119,9 @@ module Gcloud
       #
       # === Example
       #
-      #   key = Gcloud::Datastore::Key.new "User", "heidi"
+      #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
       #   key.id #=> nil
-      #   key.name #=> "heidi"
+      #   key.name #=> "heidi@example.com"
       #   key.id = 654321
       #   key.id #=> 654321
       #   key.name #=> nil
@@ -140,9 +158,9 @@ module Gcloud
       #   key = Gcloud::Datastore::Key.new "User", 123456
       #   key.id #=> 123456
       #   key.name #=> nil
-      #   key.name = "heidi"
+      #   key.name = "heidi@example.com"
       #   key.id #=> nil
-      #   key.name #=> "heidi"
+      #   key.name #=> "heidi@example.com"
       #
       def name= new_name #:nodoc:
         @id = nil if new_name
@@ -158,8 +176,8 @@ module Gcloud
       #
       # === Example
       #
-      #   key = Gcloud::Datastore::Key.new "User", "heidi"
-      #   key.name #=> "heidi"
+      #   key = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+      #   key.name #=> "heidi@example.com"
       #
       attr_reader :name
 
@@ -173,7 +191,7 @@ module Gcloud
       # === Example
       #
       #   key = Gcloud::Datastore::Key.new "List", "todos"
-      #   key.parent = Gcloud::Datastore::Key.new "User", "heidi"
+      #   key.parent = Gcloud::Datastore::Key.new "User", "heidi@example.com"
       #
       def parent= new_parent #:nodoc:
         # store key if given an entity
@@ -195,12 +213,11 @@ module Gcloud
       #   gcloud = Gcloud.new
       #   dataset = gcloud.datastore
       #
-      #   user = dataset.find "User", "heidi"
-      #   query = Gcloud::Datastore::Query.new
-      #   query.kind("List").
+      #   user = dataset.find "User", "heidi@example.com"
+      #   query = dataset.query("List").
       #     ancestor(user.key)
       #   lists = dataset.run query
-      #   lists.first.key.parent #=> Key("User", "heidi")
+      #   lists.first.key.parent #=> Key("User", "heidi@example.com")
       #
       attr_reader :parent
 
@@ -216,8 +233,8 @@ module Gcloud
       # === Example
       #
       #   key = Gcloud::Datastore::Key.new "List", "todos"
-      #   key.parent = Gcloud::Datastore::Key.new "User", "heidi"
-      #   key.path #=> [["User", "heidi"], ["List", "todos"]]
+      #   key.parent = Gcloud::Datastore::Key.new "User", "heidi@example.com"
+      #   key.path #=> [["User", "heidi@example.com"], ["List", "todos"]]
       #
       def path
         new_path = parent ? parent.path : []

data/lib/gcloud/dns/change/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 Dns
     class Change

data/lib/gcloud/dns/project.rb

@@ -181,7 +181,7 @@ module Gcloud
       #
       # === Returns
       #
-      # Array of Gcloud::Dns::Zone (Gcloud::Dns::Zone::List)
+      # Array of Gcloud::Dns::Zone (See Gcloud::Dns::Zone::List)
       #
       # === Examples
       #

data/lib/gcloud/dns/record/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 Dns
     class Record

data/lib/gcloud/dns/zone.rb

@@ -238,7 +238,7 @@ module Gcloud
       #
       # === Returns
       #
-      # Array of Gcloud::Dns::Change (Gcloud::Dns::Change::List)
+      # Array of Gcloud::Dns::Change (See Gcloud::Dns::Change::List)
       #
       # === Examples
       #
@@ -314,7 +314,7 @@ module Gcloud
       #
       # === Returns
       #
-      # Array of Gcloud::Dns::Record (Gcloud::Dns::Record::List)
+      # Array of Gcloud::Dns::Record (See Gcloud::Dns::Record::List)
       #
       # === Examples
       #

data/lib/gcloud/dns/zone/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 Dns
     class Zone

data/lib/gcloud/gce.rb

@@ -24,9 +24,6 @@ module Gcloud
     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|
@@ -56,7 +53,5 @@ module Gcloud
       @gce ||= {}
       @gce[:project_id] = nil
     end
-
-    # rubocop:enable all
   end
 end

data/lib/gcloud/pubsub.rb

@@ -114,44 +114,6 @@ module Gcloud
   #   pubsub = gcloud.pubsub
   #   topic = pubsub.create_topic "my-topic"
   #
-  # == Publishing Messages
-  #
-  # Messages are published to a topic. (See Topic#publish)
-  #
-  #   require "gcloud"
-  #
-  #   gcloud = Gcloud.new
-  #   pubsub = gcloud.pubsub
-  #
-  #   topic = pubsub.topic "my-topic"
-  #   msg = topic.publish "new-message"
-  #
-  # Messages can also be published with attributes:
-  #
-  #   require "gcloud"
-  #
-  #   gcloud = Gcloud.new
-  #   pubsub = gcloud.pubsub
-  #
-  #   topic = pubsub.topic "my-topic"
-  #   msg = topic.publish "new-message",
-  #                       foo: :bar,
-  #                       this: :that
-  #
-  # Multiple messages can be published at the same time by passing a block:
-  #
-  #   require "gcloud"
-  #
-  #   gcloud = Gcloud.new
-  #   pubsub = gcloud.pubsub
-  #
-  #   topic = pubsub.topic "my-topic"
-  #   msgs = topic.publish do |batch|
-  #     batch.publish "new-message-1", foo: :bar
-  #     batch.publish "new-message-2", foo: :baz
-  #     batch.publish "new-message-3", foo: :bif
-  #   end
-  #
   # == Retrieving Subscriptions
   #
   # A Subscription is a named resource representing the stream of messages from
@@ -169,7 +131,8 @@ module Gcloud
   #
   # == Creating a Subscription
   #
-  # A Subscription is created from a Topic. (See Topic#subscribe)
+  # A Subscription is created from a Topic. (See Topic#subscribe and
+  # Project#subscribe)
   #
   #   require "gcloud"
   #
@@ -193,41 +156,45 @@ module Gcloud
   #                         deadline: 120,
   #                         endpoint: "https://example.com/push"
   #
-  # == Working Across Projects
+  # == Publishing Messages
   #
-  # All calls to the Pub/Sub service use the same project and credentials
-  # provided to the Gcloud#pubsub method. However, it is common to reference
-  # topics or subscriptions in other projects, which can be achieved by using
-  # the +project+ option. The main credentials must have permissions to the
-  # topics and subscriptions in other projects.
+  # Messages are published to a topic. Any message published to a topic without
+  # a subscription will be lost. Ensure the topic has a subscription before
+  # publishing. (See Topic#publish and Project#publish)
   #
   #   require "gcloud"
   #
-  #   gcloud = Gcloud.new # my-project-id
+  #   gcloud = Gcloud.new
   #   pubsub = gcloud.pubsub
   #
-  #   # Get a topic in the current project
-  #   my_topic = pubsub.topic "my-topic"
-  #   my_topic.name #=> "projects/my-project-id/topics/my-topic"
-  #   # Get a topic in another project
-  #   other_topic = pubsub.topic "other-topic", project: "other-project-id"
-  #   other_topic.name #=> "projects/other-project-id/topics/other-topic"
+  #   topic = pubsub.topic "my-topic"
+  #   msg = topic.publish "new-message"
   #
-  # It is possible to create a subscription in the current project that pulls
-  # from a topic in another project:
+  # Messages can also be published with attributes:
   #
   #   require "gcloud"
   #
-  #   gcloud = Gcloud.new # my-project-id
+  #   gcloud = Gcloud.new
   #   pubsub = gcloud.pubsub
   #
-  #   # Get a topic in another project
-  #   topic = pubsub.topic "other-topic", project: "other-project-id"
-  #   # Create a subscription in the current project that pulls from
-  #   # the topic in another project
-  #   sub = topic.subscribe "my-sub"
-  #   sub.name #=> "projects/my-project-id/subscriptions/my-sub"
-  #   sub.topic.name #=> "projects/other-project-id/topics/other-topic"
+  #   topic = pubsub.topic "my-topic"
+  #   msg = topic.publish "new-message",
+  #                       foo: :bar,
+  #                       this: :that
+  #
+  # Multiple messages can be published at the same time by passing a block:
+  #
+  #   require "gcloud"
+  #
+  #   gcloud = Gcloud.new
+  #   pubsub = gcloud.pubsub
+  #
+  #   topic = pubsub.topic "my-topic"
+  #   msgs = topic.publish do |batch|
+  #     batch.publish "new-message-1", foo: :bar
+  #     batch.publish "new-message-2", foo: :baz
+  #     batch.publish "new-message-3", foo: :bif
+  #   end
   #
   # == Pulling Messages
   #
@@ -381,6 +348,42 @@ module Gcloud
   #     # process msg
   #   end
   #
+  # == Working Across Projects
+  #
+  # All calls to the Pub/Sub service use the same project and credentials
+  # provided to the Gcloud#pubsub method. However, it is common to reference
+  # topics or subscriptions in other projects, which can be achieved by using
+  # the +project+ option. The main credentials must have permissions to the
+  # topics and subscriptions in other projects.
+  #
+  #   require "gcloud"
+  #
+  #   gcloud = Gcloud.new # my-project-id
+  #   pubsub = gcloud.pubsub
+  #
+  #   # Get a topic in the current project
+  #   my_topic = pubsub.topic "my-topic"
+  #   my_topic.name #=> "projects/my-project-id/topics/my-topic"
+  #   # Get a topic in another project
+  #   other_topic = pubsub.topic "other-topic", project: "other-project-id"
+  #   other_topic.name #=> "projects/other-project-id/topics/other-topic"
+  #
+  # It is possible to create a subscription in the current project that pulls
+  # from a topic in another project:
+  #
+  #   require "gcloud"
+  #
+  #   gcloud = Gcloud.new # my-project-id
+  #   pubsub = gcloud.pubsub
+  #
+  #   # Get a topic in another project
+  #   topic = pubsub.topic "other-topic", project: "other-project-id"
+  #   # Create a subscription in the current project that pulls from
+  #   # the topic in another project
+  #   sub = topic.subscribe "my-sub"
+  #   sub.name #=> "projects/my-project-id/subscriptions/my-sub"
+  #   sub.topic.name #=> "projects/other-project-id/topics/other-topic"
+  #
   module Pubsub
   end
 end