gcloud 0.10.0 → 0.11.0

data/lib/gcloud/dns/connection.rb

@@ -14,6 +14,7 @@
 
 
 require "gcloud/version"
+require "gcloud/backoff"
 require "google/api_client"
 
 module Gcloud
@@ -38,14 +39,14 @@ module Gcloud
       end
 
       def get_project project_id = @project
-        @client.execute(
+        execute(
           api_method: @dns.projects.get,
           parameters: { project: project_id }
         )
       end
 
       def get_zone zone_id
-        @client.execute(
+        execute(
           api_method: @dns.managed_zones.get,
           parameters: { project: @project, managedZone: zone_id }
         )
@@ -57,7 +58,7 @@ module Gcloud
                    maxResults: max
                  }.delete_if { |_, v| v.nil? }
 
-        @client.execute(
+        execute(
           api_method: @dns.managed_zones.list,
           parameters: params
         )
@@ -71,7 +72,7 @@ module Gcloud
                  nameServerSet: name_server_set
                }.delete_if { |_, v| v.nil? }
 
-        @client.execute(
+        execute(
           api_method: @dns.managed_zones.create,
           parameters: { project: @project },
           body_object: body
@@ -79,14 +80,14 @@ module Gcloud
       end
 
       def delete_zone zone_id
-        @client.execute(
+        execute(
           api_method: @dns.managed_zones.delete,
           parameters: { project: @project, managedZone: zone_id }
         )
       end
 
       def get_change zone_id, change_id
-        @client.execute(
+        execute(
           api_method: @dns.changes.get,
           parameters: { project: @project, managedZone: zone_id,
                         changeId: change_id }
@@ -101,7 +102,7 @@ module Gcloud
                    sortOrder: order
                  }.delete_if { |_, v| v.nil? }
 
-        @client.execute(
+        execute(
           api_method: @dns.changes.list,
           parameters: params
         )
@@ -112,7 +113,7 @@ module Gcloud
                    "additions" => Array(additions),
                    "deletions" => Array(deletions) }
 
-        @client.execute(
+        execute(
           api_method: @dns.changes.create,
           parameters: { project: @project, managedZone: zone_id },
           body_object: change
@@ -127,7 +128,7 @@ module Gcloud
                    type: type
                  }.delete_if { |_, v| v.nil? }
 
-        @client.execute(
+        execute(
           api_method: @dns.resource_record_sets.list,
           parameters: params
         )
@@ -159,6 +160,14 @@ module Gcloud
       def inspect
         "#{self.class}(#{@project})"
       end
+
+      protected
+
+      def execute options
+        Gcloud::Backoff.new.execute_gapi do
+          @client.execute options
+        end
+      end
     end
   end
 end

data/lib/gcloud/dns/project.rb

@@ -180,25 +180,21 @@ module Gcloud
       #     puts zone.name
       #   end
       #
-      # @example With pagination: (See {Gcloud::Dns::Zone::List})
+      # @example Retrieve all zones: (See {Zone::List#all})
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
       #   dns = gcloud.dns
       #   zones = dns.zones
-      #   loop do
-      #     zones.each do |zone|
-      #       puts zone.name
-      #     end
-      #     break unless zones.next?
-      #     zones = zones.next
+      #   zones.all do |zone|
+      #     puts zone.name
       #   end
       #
       def zones token: nil, max: nil
         ensure_connection!
         resp = connection.list_zones token: token, max: max
         if resp.success?
-          Zone::List.from_response resp, connection
+          Zone::List.from_response resp, connection, max
         else
           fail ApiError.from_response(resp)
         end

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

@@ -27,54 +27,137 @@ module Gcloud
         attr_accessor :token
 
         ##
-        # Create a new Record::List with an array of Record instances.
+        # @private Create a new Record::List with an array of Record instances.
         def initialize arr = []
           super arr
         end
 
         ##
         # Whether there a next page of records.
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #
+        #   records = zone.records "example.com."
+        #   if records.next?
+        #     next_records = records.next
+        #   end
+        #
         def next?
           !token.nil?
         end
 
         ##
         # Retrieve the next page of records.
+        #
+        # @return [Record::List]
+        #
+        # @example
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #
+        #   records = zone.records "example.com."
+        #   if records.next?
+        #     next_records = records.next
+        #   end
+        #
         def next
           return nil unless next?
           ensure_zone!
-          @zone.records token: token
+          @zone.records @name, @type, token: token, max: @max
         end
 
         ##
-        # Retrieves all records by repeatedly loading pages until {#next?}
-        # returns false. Returns the list instance for method chaining.
+        # Retrieves all records by repeatedly loading {#next} until {#next?}
+        # returns `false`. Calls the given block once for each record, which is
+        # passed as the parameter.
         #
-        # @example
+        # An Enumerator is returned if no block is given.
+        #
+        # This method may make several API calls until all records are
+        # retrieved. Be sure to use as narrow a search criteria as possible.
+        # Please use with caution.
+        #
+        # @param [Integer] request_limit The upper limit of API requests to make
+        #   to load all records. Default is no limit.
+        # @yield [record] The block for accessing each record.
+        # @yieldparam [Record] record The record object.
+        #
+        # @return [Enumerator]
+        #
+        # @example Iterating each record by passing a block:
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #   records = zone.records "example.com."
+        #
+        #   records.all do |record|
+        #     puts record.name
+        #   end
+        #
+        # @example Using the enumerator by not passing a block:
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #   records = zone.records "example.com."
+        #
+        #   all_names = records.all.map do |record|
+        #     record.name
+        #   end
+        #
+        # @example Limit the number of API calls made:
         #   require "gcloud"
         #
         #   gcloud = Gcloud.new
         #   dns = gcloud.dns
         #   zone = dns.zone "example-com"
-        #   records = zone.records.all # Load all pages of records
+        #   records = zone.records "example.com."
         #
-        def all
-          while next?
-            next_records = self.next
-            push(*next_records)
-            self.token = next_records.token
+        #   records.all(request_limit: 10) do |record|
+        #     puts record.name
+        #   end
+        #
+        def all request_limit: nil
+          request_limit = request_limit.to_i if request_limit
+          unless block_given?
+            return enum_for(:all, request_limit: request_limit)
+          end
+          results = self
+          loop do
+            results.each { |r| yield r }
+            if request_limit
+              request_limit -= 1
+              break if request_limit < 0
+            end
+            break unless results.next?
+            results = results.next
           end
-          self
         end
 
         ##
         # @private New Records::List from a response object.
-        def self.from_response resp, zone
+        def self.from_response resp, zone, name = nil, type = nil, max = nil
           records = new(Array(resp.data["rrsets"]).map do |gapi_object|
             Record.from_gapi gapi_object
           end)
           records.instance_variable_set "@token", resp.data["nextPageToken"]
           records.instance_variable_set "@zone",  zone
+          records.instance_variable_set "@name",  name
+          records.instance_variable_set "@type",  type
+          records.instance_variable_set "@max",   max
           records
         end
 

data/lib/gcloud/dns/zone.rb

@@ -236,19 +236,15 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   changes = zone.changes order: :desc
       #
-      # @example With pagination: (See {Gcloud::Dns::Change::List})
+      # @example Retrieve all changes: (See {Change::List#all})
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
       #   dns = gcloud.dns
       #   zone = dns.zone "example-com"
       #   changes = zone.changes
-      #   loop do
-      #     changes.each do |change|
-      #       puts "#{change.name} - #{change.status}"
-      #     end
-      #     break unless changes.next?
-      #     changes = changes.next
+      #   changes.all do |change|
+      #     puts "#{change.name} - #{change.status}"
       #   end
       #
       def changes token: nil, max: nil, order: nil
@@ -260,7 +256,7 @@ module Gcloud
         resp = connection.list_changes id, token: token, max: max,
                                            order: order, sort: sort
         if resp.success?
-          Change::List.from_response resp, self
+          Change::List.from_response resp, self, max, order
         else
           fail ApiError.from_response(resp)
         end
@@ -304,28 +300,17 @@ module Gcloud
       #   records = zone.records "www", "A"
       #   records.first.name #=> "www.example.com."
       #
-      # @example With pagination: (See {Gcloud::Dns::Record::List})
+      # @example Retrieve all records: (See {Gcloud::Dns::Record::List#all})
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
       #   dns = gcloud.dns
       #   zone = dns.zone "example-com"
       #   records = zone.records "example.com."
-      #   loop do
-      #     records.each do |record|
-      #       puts record.name
-      #     end
-      #     break unless records.next?
-      #     records = records.next
-      #   end
-      #
-      # @example Retrieve all pages: (See {Gcloud::Dns::Record::List#all})
-      #   require "gcloud"
       #
-      #   gcloud = Gcloud.new
-      #   dns = gcloud.dns
-      #   zone = dns.zone "example-com"
-      #   records = zone.records.all
+      #   records.all do |record|
+      #     puts record.name
+      #   end
       #
       def records name = nil, type = nil, token: nil, max: nil
         ensure_connection!
@@ -334,7 +319,7 @@ module Gcloud
 
         resp = connection.list_records id, name, type, token: token, max: max
         if resp.success?
-          Record::List.from_response resp, self
+          Record::List.from_response resp, self, name, type, max
         else
           fail ApiError.from_response(resp)
         end

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

@@ -22,43 +22,140 @@ module Gcloud
       # Zone::List is a special case Array with additional values.
       class List < DelegateClass(::Array)
         ##
-        # If not empty, indicates that there are more records that match
+        # If not empty, indicates that there are more zones that match
         # the request and this value should be passed to continue.
         attr_accessor :token
 
         ##
-        # Create a new Zone::List with an array of Zone instances.
+        # @private Create a new Zone::List with an array of Zone instances.
         def initialize arr = []
           super arr
         end
 
         ##
         # Whether there a next page of zones.
+        #
+        # @return [Boolean]
+        #
+        # @example
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #
+        #   zones = dns.zones
+        #   if zones.next?
+        #     next_zones = zones.next
+        #   end
+        #
         def next?
           !token.nil?
         end
 
         ##
         # Retrieve the next page of zones.
+        #
+        # @return [Zone::List]
+        #
+        # @example
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #
+        #   zones = dns.zones
+        #   if zones.next?
+        #     next_zones = zones.next
+        #   end
+        #
         def next
           return nil unless next?
           ensure_connection!
-          resp = @connection.list_zones token: token
+          resp = @connection.list_zones token: token, max: @max
           if resp.success?
-            Zone::List.from_response resp, @connection
+            Zone::List.from_response resp, @connection, @max
           else
             fail ApiError.from_response(resp)
           end
         end
 
+        ##
+        # Retrieves all zones by repeatedly loading {#next} until {#next?}
+        # returns `false`. Calls the given block once for each zone, which is
+        # passed as the parameter.
+        #
+        # An Enumerator is returned if no block is given.
+        #
+        # This method may make several API calls until all zones are retrieved.
+        # Be sure to use as narrow a search criteria as possible. Please use
+        # with caution.
+        #
+        # @param [Integer] request_limit The upper limit of API requests to make
+        #   to load all zones. Default is no limit.
+        # @yield [zone] The block for accessing each zone.
+        # @yieldparam [Zone] zone The zone object.
+        #
+        # @return [Enumerator]
+        #
+        # @example Iterating each zone by passing a block:
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zones = dns.zones
+        #
+        #   zones.all do |zone|
+        #     puts zone.name
+        #   end
+        #
+        # @example Using the enumerator by not passing a block:
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zones = dns.zones
+        #
+        #   all_names = zones.all.map do |zone|
+        #     zone.name
+        #   end
+        #
+        # @example Limit the number of API calls made:
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zones = dns.zones
+        #
+        #   zones.all(request_limit: 10) do |zone|
+        #     puts zone.name
+        #   end
+        #
+        def all request_limit: nil
+          request_limit = request_limit.to_i if request_limit
+          unless block_given?
+            return enum_for(:all, request_limit: request_limit)
+          end
+          results = self
+          loop do
+            results.each { |r| yield r }
+            if request_limit
+              request_limit -= 1
+              break if request_limit < 0
+            end
+            break unless results.next?
+            results = results.next
+          end
+        end
+
         ##
         # @private New Zones::List from a response object.
-        def self.from_response resp, conn
+        def self.from_response resp, conn, max = nil
           zones = new(Array(resp.data["managedZones"]).map do |gapi_object|
             Zone.from_gapi gapi_object, conn
           end)
           zones.instance_variable_set "@token",      resp.data["nextPageToken"]
           zones.instance_variable_set "@connection", conn
+          zones.instance_variable_set "@max",        max
           zones
         end