gcloud 0.5.0 → 0.6.0

data/lib/gcloud/dns/project.rb

@@ -171,12 +171,10 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:token]</code>::
+      # +token+::
       #   A previously-returned page token representing part of the larger set
       #   of results to view. (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   Maximum number of zones to return. (+Integer+)
       #
       # === Returns
@@ -210,9 +208,9 @@ module Gcloud
       #     zones = zones.next
       #   end
       #
-      def zones options = {}
+      def zones token: nil, max: nil
         ensure_connection!
-        resp = connection.list_zones options
+        resp = connection.list_zones token: token, max: max
         if resp.success?
           Zone::List.from_response resp, connection
         else
@@ -234,13 +232,11 @@ module Gcloud
       # +zone_dns+::
       #   The DNS name of this managed zone, for instance "example.com.".
       #   (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:description]</code>::
+      # +description+::
       #   A string of at most 1024 characters associated with this resource for
       #   the user's convenience. Has no effect on the managed zone's function.
       #   (+String+)
-      # <code>options[:name_server_set]</code>::
+      # +name_server_set+::
       #   A NameServerSet is a set of DNS name servers that all host the same
       #   ManagedZones. Most users will leave this field unset. (+String+)
       #
@@ -256,9 +252,12 @@ module Gcloud
       #   dns = gcloud.dns
       #   zone = dns.create_zone "example-com", "example.com."
       #
-      def create_zone zone_name, zone_dns, options = {}
+      def create_zone zone_name, zone_dns, description: nil,
+                      name_server_set: nil
         ensure_connection!
-        resp = connection.create_zone zone_name, zone_dns, options
+        resp = connection.create_zone zone_name, zone_dns,
+                                      description: description,
+                                      name_server_set: name_server_set
         if resp.success?
           Zone.from_gapi resp.data, connection
         else

data/lib/gcloud/dns/zone.rb

@@ -121,9 +121,7 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:force]</code>::
+      # +force+::
       #   If +true+, ensures the deletion of the zone by first deleting all
       #   records. If +false+ and the zone contains non-essential records, the
       #   request will fail. Default is +false+. (+Boolean+)
@@ -150,8 +148,8 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   zone.delete force: true
       #
-      def delete options = {}
-        clear! if options[:force]
+      def delete force: false
+        clear! if force
 
         ensure_connection!
         resp = connection.delete_zone id
@@ -222,14 +220,12 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:token]</code>::
+      # +token+::
       #   A previously-returned page token representing part of the larger set
       #   of results to view. (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   Maximum number of changes to return. (+Integer+)
-      # <code>options[:order]</code>::
+      # +order+::
       #   Sort the changes by change sequence. (+Symbol+ or +String+)
       #
       #   Acceptable values are:
@@ -278,13 +274,14 @@ module Gcloud
       #     changes = changes.next
       #   end
       #
-      def changes options = {}
+      def changes token: nil, max: nil, order: nil
         ensure_connection!
         # Fix the sort options
-        options[:order] = adjust_change_sort_order options[:order]
-        options[:sort]  = "changeSequence" if options[:order]
+        order = adjust_change_sort_order order
+        sort  = "changeSequence" if order
         # Continue with the API call
-        resp = connection.list_changes id, options
+        resp = connection.list_changes id, token: token, max: max,
+                                           order: order, sort: sort
         if resp.success?
           Change::List.from_response resp, self
         else
@@ -304,12 +301,10 @@ module Gcloud
       #   Return only records with this {record
       #   type}[https://cloud.google.com/dns/what-is-cloud-dns].
       #   If present, the +name+ parameter must also be present. (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:token]</code>::
+      # +token+::
       #   A previously-returned page token representing part of the larger set
       #   of results to view. (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   Maximum number of records to return. (+Integer+)
       #
       # === Returns
@@ -367,12 +362,12 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   records = zone.records.all
       #
-      def records name = nil, type = nil, options = {}
+      def records name = nil, type = nil, token: nil, max: nil
         ensure_connection!
 
-        options = build_records_options name, type, options
+        name = fqdn(name) if name
 
-        resp = connection.list_records id, options
+        resp = connection.list_records id, name, type, token: token, max: max
         if resp.success?
           Record::List.from_response resp, self
         else
@@ -463,16 +458,14 @@ module Gcloud
       # +path_or_io+::
       #   The path to a zone file on the filesystem, or an IO instance from
       #   which zone file data can be read. (+String+ or +IO+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:only]</code>::
+      # +only+::
       #   Include only records of this type or types. (+String+ or +Array+)
-      # <code>options[:except]</code>::
+      # +except+::
       #   Exclude records of this type or types. (+String+ or +Array+)
-      # <code>options[:skip_soa]</code>::
+      # +skip_soa+::
       #   Do not automatically update the SOA record serial number. See #update
       #   for details. (+Boolean+)
-      # <code>options[:soa_serial]</code>::
+      # +soa_serial+::
       #   A value (or a lambda or Proc returning a value) for the new SOA record
       #   serial number. See #update for details. (+Integer+, lambda, or +Proc+)
       #
@@ -489,11 +482,12 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   change = zone.import "path/to/db.example.com"
       #
-      def import path_or_io, options = {}
-        options[:except] = Array(options[:except]).map(&:to_s).map(&:upcase)
-        options[:except] = (options[:except] + %w(SOA NS)).uniq
-        additions = Gcloud::Dns::Importer.new(self, path_or_io).records(options)
-        update additions, []
+      def import path_or_io, only: nil, except: nil,
+                 skip_soa: nil, soa_serial: nil
+        except = (Array(except).map(&:to_s).map(&:upcase) + %w(SOA NS)).uniq
+        importer = Gcloud::Dns::Importer.new self, path_or_io
+        additions = importer.records only: only, except: except
+        update additions, [], skip_soa: skip_soa, soa_serial: soa_serial
       end
 
       # rubocop:disable all
@@ -516,11 +510,9 @@ module Gcloud
       #   The Record or array of records to add. (Record or +Array+)
       # +deletions+::
       #   The Record or array of records to remove. (Record or +Array+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:skip_soa]</code>::
+      # +skip_soa+::
       #   Do not automatically update the SOA record serial number. (+Boolean+)
-      # <code>options[:soa_serial]</code>::
+      # +soa_serial+::
       #   A value (or a lambda or Proc returning a value) for the new SOA record
       #   serial number. (+Integer+, lambda, or +Proc+)
       #
@@ -571,7 +563,7 @@ module Gcloud
       #   new_record = zone.record "example.com.", "A", 86400, ["1.2.3.4"]
       #   change = zone.update new_record, soa_serial: lambda { |sn| sn + 10 }
       #
-      def update additions = [], deletions = [], options = {}
+      def update additions = [], deletions = [], skip_soa: nil, soa_serial: nil
         # Handle only sending in options
         if additions.is_a?(::Hash) && deletions.empty? && options.empty?
           options = additions
@@ -594,8 +586,8 @@ module Gcloud
         to_add    = additions - deletions
         to_remove = deletions - additions
         return nil if to_add.empty? && to_remove.empty?
-        unless options[:skip_soa] || detect_soa(to_add) || detect_soa(to_remove)
-          increment_soa to_add, to_remove, options[:soa_serial]
+        unless skip_soa || detect_soa(to_add) || detect_soa(to_remove)
+          increment_soa to_add, to_remove, soa_serial
         end
         create_change to_add, to_remove
       end
@@ -627,12 +619,10 @@ module Gcloud
       #   (section 3.6.1)}[http://tools.ietf.org/html/rfc1034#section-3.6.1].
       #   For example: +192.0.2.1+ or +example.com.+. (+String+ or +Array+ of
       #   +String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:skip_soa]</code>::
+      # +skip_soa+::
       #   Do not automatically update the SOA record serial number. See #update
       #   for details. (+Boolean+)
-      # <code>options[:soa_serial]</code>::
+      # +soa_serial+::
       #   A value (or a lambda or Proc returning a value) for the new SOA record
       #   serial number. See #update for details. (+Integer+, lambda, or +Proc+)
       #
@@ -649,8 +639,9 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   change = zone.add "example.com.", "A", 86400, ["1.2.3.4"]
       #
-      def add name, type, ttl, data, options = {}
-        update [record(name, type, ttl, data)], [], options
+      def add name, type, ttl, data, skip_soa: nil, soa_serial: nil
+        update [record(name, type, ttl, data)], [],
+               skip_soa: skip_soa, soa_serial: soa_serial
       end
 
       ##
@@ -669,12 +660,10 @@ module Gcloud
       #   The identifier of a {supported record
       #   type}[https://cloud.google.com/dns/what-is-cloud-dns].
       #   For example: +A+, +AAAA+, +CNAME+, +MX+, or +TXT+. (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:skip_soa]</code>::
+      # +skip_soa+::
       #   Do not automatically update the SOA record serial number. See #update
       #   for details. (+Boolean+)
-      # <code>options[:soa_serial]</code>::
+      # +soa_serial+::
       #   A value (or a lambda or Proc returning a value) for the new SOA record
       #   serial number. See #update for details. (+Integer+, lambda, or +Proc+)
       #
@@ -691,8 +680,9 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   change = zone.remove "example.com.", "A"
       #
-      def remove name, type, options = {}
-        update [], records(name: name, type: type).all.to_a, options
+      def remove name, type, skip_soa: nil, soa_serial: nil
+        update [], records(name, type).all.to_a,
+               skip_soa: skip_soa, soa_serial: soa_serial
       end
 
       ##
@@ -721,12 +711,10 @@ module Gcloud
       #   3.6.1)}[http://tools.ietf.org/html/rfc1034#section-3.6.1]. For
       #   example: +192.0.2.1+ or +example.com.+. (+String+ or +Array+ of
       #   +String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:skip_soa]</code>::
+      # +skip_soa+::
       #   Do not automatically update the SOA record serial number. See #update
       #   for details. (+Boolean+)
-      # <code>options[:soa_serial]</code>::
+      # +soa_serial+::
       #   A value (or a lambda or Proc returning a value) for the new SOA record
       #   serial number. See #update for details. (+Integer+, lambda, or +Proc+)
       #
@@ -743,10 +731,10 @@ module Gcloud
       #   zone = dns.zone "example-com"
       #   change = zone.replace "example.com.", "A", 86400, ["5.6.7.8"]
       #
-      def replace name, type, ttl, data, options = {}
+      def replace name, type, ttl, data, skip_soa: nil, soa_serial: nil
         update [record(name, type, ttl, data)],
-               records(name: name, type: type).all.to_a,
-               options
+               records(name, type).all.to_a,
+               skip_soa: skip_soa, soa_serial: soa_serial
       end
 
       def to_zonefile #:nodoc:
@@ -768,12 +756,10 @@ module Gcloud
       #   The identifier of a {supported record
       #   type}[https://cloud.google.com/dns/what-is-cloud-dns].
       #   For example: +A+, +AAAA+, +CNAME+, +MX+, or +TXT+. (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:skip_soa]</code>::
+      # +skip_soa+::
       #   Do not automatically update the SOA record serial number. See #update
       #   for details. (+Boolean+)
-      # <code>options[:soa_serial]</code>::
+      # +soa_serial+::
       #   A value (or a lambda or Proc returning a value) for the new SOA record
       #   serial number. See #update for details. (+Integer+, lambda, or +Proc+)
       #
@@ -792,11 +778,11 @@ module Gcloud
       #     mx.ttl = 3600 # change only the TTL
       #   end
       #
-      def modify name, type, options = {}
-        existing = records(name: name, type: type).all.to_a
+      def modify name, type, skip_soa: nil, soa_serial: nil
+        existing = records(name, type).all.to_a
         updated = existing.map(&:dup)
         updated.each { |r| yield r }
-        update updated, existing, options
+        update updated, existing, skip_soa: skip_soa, soa_serial: soa_serial
       end
 
       ##
@@ -847,32 +833,6 @@ module Gcloud
         fail "Must have active connection" unless connection
       end
 
-      # rubocop:disable all
-      # Disabled rubocop because this complexity cannot easily be avoided.
-
-      def build_records_options name, type, options
-        # Handle only sending in options
-        if name.is_a?(::Hash) && type.nil? && options.empty?
-          options = name
-          name = nil
-        elsif type.is_a?(::Hash) && options.empty?
-          options = type
-          type = nil
-        end
-
-        # Set parameters as options, params have priority
-        options[:name] = name || options[:name]
-        options[:type] = type || options[:type]
-
-        # Ensure name is a FQDN
-        options[:name] = fqdn(options[:name]) if options[:name]
-
-        # return only the options
-        options
-      end
-
-      # rubocop:enable all
-
       def create_change additions, deletions
         ensure_connection!
         resp = connection.create_change id,
@@ -886,7 +846,7 @@ module Gcloud
       end
 
       def increment_soa to_add, to_remove, soa_serial
-        current_soa = detect_soa records(name: dns, type: "SOA").all
+        current_soa = detect_soa records(dns, "SOA").all
         return false if current_soa.nil?
         updated_soa = current_soa.dup
         updated_soa.data[0] = replace_soa_serial updated_soa.data[0], soa_serial

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

@@ -111,7 +111,7 @@ module Gcloud
         #   end
         #
         def remove name, type
-          @deletions += @zone.records(name: name, type: type).all
+          @deletions += @zone.records(name, type).all
         end
 
         ##
@@ -180,7 +180,7 @@ module Gcloud
         #   end
         #
         def modify name, type
-          existing = @zone.records(name: name, type: type).all.to_a
+          existing = @zone.records(name, type).all.to_a
           updated = existing.map(&:dup)
           updated.each { |r| yield r }
           @additions += updated

data/lib/gcloud/pubsub.rb

@@ -31,9 +31,7 @@ module Gcloud
   # +keyfile+::
   #   Keyfile downloaded from Google Cloud. If file path the file must be
   #   readable. (+String+ or +Hash+)
-  # +options+::
-  #   An optional Hash for controlling additional behavior. (+Hash+)
-  # <code>options[:scope]</code>::
+  # +scope+::
   #   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+
@@ -56,12 +54,12 @@ module Gcloud
   #   topic = pubsub.topic "my-topic"
   #   topic.publish "task completed"
   #
-  def self.pubsub project = nil, keyfile = nil, options = {}
+  def self.pubsub project = nil, keyfile = nil, scope: nil
     project ||= Gcloud::Pubsub::Project.default_project
     if keyfile.nil?
-      credentials = Gcloud::Pubsub::Credentials.default options
+      credentials = Gcloud::Pubsub::Credentials.default scope: scope
     else
-      credentials = Gcloud::Pubsub::Credentials.new keyfile, options
+      credentials = Gcloud::Pubsub::Credentials.new keyfile, scope: scope
     end
     Gcloud::Pubsub::Project.new project, credentials
   end

data/lib/gcloud/pubsub/connection.rb

@@ -280,7 +280,7 @@ module Gcloud
       def subscription_data topic, options = {}
         deadline   = options[:deadline]
         endpoint   = options[:endpoint]
-        attributes = hashify options[:attributes]
+        attributes = (options[:attributes] || {}).to_h
 
         data = { topic: topic_path(topic) }
         data[:ackDeadlineSeconds] = deadline if deadline
@@ -290,17 +290,6 @@ module Gcloud
         end
         data
       end
-
-      ##
-      # Make sure the object is converted to a hash
-      # Ruby 1.9.3 doesn't support to_h, so here we are.
-      def hashify hash
-        if hash.respond_to? :to_h
-          hash.to_h
-        else
-          Hash.try_convert(hash) || {}
-        end
-      end
     end
   end
 end

data/lib/gcloud/pubsub/project.rb

@@ -85,17 +85,15 @@ module Gcloud
       #
       # +topic_name+::
       #   Name of a topic. (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:autocreate]</code>::
+      # +autocreate+::
       #   Flag to control whether the requested topic will be created if it does
       #   not exist. Ignored if +skip_lookup+ is +true+. The default value is
       #   +false+. (+Boolean+)
-      # <code>options[:project]</code>::
+      # +project+::
       #   If the topic belongs to a project other than the one currently
       #   connected to, the alternate project ID can be specified here.
       #   (+String+)
-      # <code>options[:skip_lookup]</code>::
+      # +skip_lookup+::
       #   Optionally create a Topic object without verifying the topic resource
       #   exists on the Pub/Sub service. Calls made on this object will raise
       #   errors if the topic resource does not exist. Default is +false+.
@@ -150,15 +148,14 @@ module Gcloud
       #   pubsub = gcloud.pubsub
       #   topic = pubsub.topic "another-topic", skip_lookup: true
       #
-      def topic topic_name, options = {}
+      def topic topic_name, autocreate: nil, project: nil, skip_lookup: nil
         ensure_connection!
-        if options[:skip_lookup]
-          return Topic.new_lazy(topic_name, connection, options)
-        end
+        options = { project: project }
+        return Topic.new_lazy(topic_name, connection, options) if skip_lookup
         resp = connection.get_topic topic_name
         return Topic.from_gapi(resp.data, connection) if resp.success?
         if resp.status == 404
-          return create_topic(topic_name) if options[:autocreate]
+          return create_topic(topic_name) if autocreate
           return nil
         end
         fail ApiError.from_response(resp)
@@ -202,14 +199,11 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      #   (+String+)
-      # <code>options[:token]</code>::
+      # +token+::
       #   The +token+ value returned by the last call to +topics+; indicates
       #   that this is a continuation of a call, and that the system should
       #   return the next page of data. (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   Maximum number of topics to return. (+Integer+)
       #
       # === Returns
@@ -248,8 +242,9 @@ module Gcloud
       #     tmp_topics = pubsub.topics token: tmp_topics.token
       #   end
       #
-      def topics options = {}
+      def topics token: nil, max: nil
         ensure_connection!
+        options = { token: token, max: max }
         resp = connection.list_topics options
         if resp.success?
           Topic::List.from_response resp, connection
@@ -353,15 +348,13 @@ module Gcloud
       #   periods (.), tildes (~), plus (+) or percent signs (%). It must be
       #   between 3 and 255 characters in length, and it must not start with
       #   "goog". (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:deadline]</code>::
+      # +deadline+::
       #   The maximum number of seconds after a subscriber receives a message
       #   before the subscriber should acknowledge the message. (+Integer+)
-      # <code>options[:endpoint]</code>::
+      # +endpoint+::
       #   A URL locating the endpoint to which messages should be pushed.
       #   e.g. "https://example.com/push" (+String+)
-      # <code>attributes[:autocreate]</code>::
+      # +autocreate+::
       #   Flag to control whether the topic will be created if it does not
       #   exist.
       #
@@ -411,15 +404,18 @@ module Gcloud
       #
       #   sub = pubsub.subscribe "new-topic", "new-topic-sub", autocreate: true
       #
-      def subscribe topic_name, subscription_name, options = {}
+      def subscribe topic_name, subscription_name, deadline: nil, endpoint: nil,
+                    autocreate: nil
         ensure_connection!
+        options = { deadline: deadline, endpoint: endpoint }
         resp = connection.create_subscription topic_name,
                                               subscription_name, options
         return Subscription.from_gapi(resp.data, connection) if resp.success?
-        if options[:autocreate] && resp.status == 404
+        if autocreate && resp.status == 404
           create_topic topic_name
           return subscribe(topic_name, subscription_name,
-                           options.merge(autocreate: false))
+                           deadline: deadline, endpoint: endpoint,
+                           autocreate: false)
         end
         fail ApiError.from_response(resp)
       end
@@ -433,13 +429,11 @@ module Gcloud
       #
       # +subscription_name+::
       #   Name of a subscription. (+String+)
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:project]</code>::
+      # +project+::
       #   If the subscription belongs to a project other than the one currently
       #   connected to, the alternate project ID can be specified here.
       #   (+String+)
-      # <code>options[:skip_lookup]</code>::
+      # +skip_lookup+::
       #   Optionally create a Subscription object without verifying the
       #   subscription resource exists on the Pub/Sub service. Calls made on
       #   this object will raise errors if the service resource does not exist.
@@ -471,9 +465,10 @@ module Gcloud
       #   subscription = pubsub.subscription "my-sub", skip_lookup: true
       #   puts subscription.name
       #
-      def subscription subscription_name, options = {}
+      def subscription subscription_name, project: nil, skip_lookup: nil
         ensure_connection!
-        if options[:skip_lookup]
+        options = { project: project }
+        if skip_lookup
           return Subscription.new_lazy(subscription_name, connection, options)
         end
         resp = connection.get_subscription subscription_name
@@ -489,15 +484,13 @@ module Gcloud
       #
       # === Parameters
       #
-      # +options+::
-      #   An optional Hash for controlling additional behavior. (+Hash+)
-      # <code>options[:prefix]</code>::
+      # +prefix+::
       #   Filter results to subscriptions whose names begin with this prefix.
       #   (+String+)
-      # <code>options[:token]</code>::
+      # +token+::
       #   A previously-returned page token representing part of the larger set
       #   of results to view. (+String+)
-      # <code>options[:max]</code>::
+      # +max+::
       #   Maximum number of subscriptions to return. (+Integer+)
       #
       # === Returns
@@ -537,8 +530,9 @@ module Gcloud
       #     tmp_subs = pubsub.subscriptions token: tmp_subs.token
       #   end
       #
-      def subscriptions options = {}
+      def subscriptions prefix: nil, token: nil, max: nil
         ensure_connection!
+        options = { prefix: prefix, token: token, max: max }
         resp = connection.list_subscriptions options
         if resp.success?
           Subscription::List.from_response resp, connection