gcloud 0.3.1 → 0.4.0

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

@@ -0,0 +1,75 @@
+#--
+# Copyright 2015 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 Dns
+    class Zone
+      ##
+      # 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
+        # the request and this value should be passed to continue.
+        attr_accessor :token
+
+        ##
+        # Create a new Zone::List with an array of Zone instances.
+        def initialize arr = []
+          super arr
+        end
+
+        ##
+        # Whether there a next page of zones.
+        def next?
+          !token.nil?
+        end
+
+        ##
+        # Retrieve the next page of zones.
+        def next
+          return nil unless next?
+          ensure_connection!
+          resp = @connection.list_zones token: token
+          if resp.success?
+            Zone::List.from_response resp, @connection
+          else
+            fail ApiError.from_response(resp)
+          end
+        end
+
+        ##
+        # New Zones::List from a response object.
+        def self.from_response resp, conn #:nodoc:
+          zones = new(Array(resp.data["managedZones"]).map do |gapi_object|
+            Zone.from_gapi gapi_object, conn
+          end)
+          zones.instance_eval do
+            @token = resp.data["nextPageToken"]
+            @connection = conn
+          end
+          zones
+        end
+
+        protected
+
+        ##
+        # Raise an error unless an active connection is available.
+        def ensure_connection!
+          fail "Must have active connection" unless @connection
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,192 @@
+#--
+# Copyright 2015 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 Dns
+    class Zone
+      ##
+      # = DNS Zone Transaction
+      #
+      # This object is used by Zone#update when passed a block. These methods
+      # are used to update the records that are sent to the Google Cloud DNS
+      # API.
+      #
+      #   require "gcloud"
+      #
+      #   gcloud = Gcloud.new
+      #   dns = gcloud.dns
+      #   zone = dns.zone "example-com"
+      #   zone.update do |tx|
+      #     tx.add     "example.com.", "A",  86400, "1.2.3.4"
+      #     tx.remove  "example.com.", "TXT"
+      #     tx.replace "example.com.", "MX", 86400, ["10 mail1.example.com.",
+      #                                              "20 mail2.example.com."]
+      #     tx.modify "www.example.com.", "CNAME" do |cname|
+      #       cname.ttl = 86400 # only change the TTL
+      #     end
+      #   end
+      #
+      class Transaction
+        attr_reader :additions, :deletions #:nodoc:
+
+        ##
+        # Creates a new transaction.
+        def initialize zone #:nodoc:
+          @zone = zone
+          @additions = []
+          @deletions = []
+        end
+
+        ##
+        # Adds a record to the Zone.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The owner of the record. For example: +example.com.+. (+String+)
+        # +type+::
+        #   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+)
+        # +ttl+::
+        #   The number of seconds that the record can be cached by resolvers.
+        #   (+Integer+)
+        # +data+::
+        #   The resource record data, as determined by +type+ and defined in
+        #   {RFC 1035 (section 5)}[http://tools.ietf.org/html/rfc1035#section-5]
+        #   and {RFC 1034 (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+)
+        #
+        # === Example
+        #
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #   zone.update do |tx|
+        #     tx.add     "example.com.", "A",  86400, "1.2.3.4"
+        #   end
+        #
+        def add name, type, ttl, data
+          @additions += Array(@zone.record(name, type, ttl, data))
+        end
+
+        ##
+        # Removes records from the Zone. The records are looked up before they
+        # are removed.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The owner of the record. For example: +example.com.+. (+String+)
+        # +type+::
+        #   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+)
+        #
+        # === Example
+        #
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #   zone.update do |tx|
+        #     tx.remove  "example.com.", "TXT"
+        #   end
+        #
+        def remove name, type
+          @deletions += @zone.records(name: name, type: type).all
+        end
+
+        ##
+        # Replaces existing records on the Zone. Records matching the +name+ and
+        # +type+ are replaced.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The owner of the record. For example: +example.com.+. (+String+)
+        # +type+::
+        #   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+)
+        # +ttl+::
+        #   The number of seconds that the record can be cached by resolvers.
+        #   (+Integer+)
+        # +data+::
+        #   The resource record data, as determined by +type+ and defined in
+        #   {RFC 1035 (section 5)}[http://tools.ietf.org/html/rfc1035#section-5]
+        #   and {RFC 1034 (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+)
+        #
+        # === Example
+        #
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone = dns.zone "example-com"
+        #   zone.update do |tx|
+        #     tx.replace "example.com.", "MX", 86400, ["10 mail1.example.com.",
+        #                                              "20 mail2.example.com."]
+        #   end
+        #
+        def replace name, type, ttl, data
+          remove name, type
+          add name, type, ttl, data
+        end
+
+        ##
+        # Modifies records on the Zone. Records matching the +name+ and +type+
+        # are yielded to the block where they can be modified.
+        #
+        # === Parameters
+        #
+        # +name+::
+        #   The owner of the record. For example: +example.com.+. (+String+)
+        # +type+::
+        #   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+)
+        #
+        # === Example
+        #
+        #   require "gcloud"
+        #
+        #   gcloud = Gcloud.new
+        #   dns = gcloud.dns
+        #   zone.update do |tx|
+        #     tx.modify "www.example.com.", "CNAME" do |cname|
+        #       cname.ttl = 86400 # only change the TTL
+        #     end
+        #   end
+        #
+        def modify name, type
+          existing = @zone.records(name: name, type: type).all.to_a
+          updated = existing.map(&:dup)
+          updated.each { |r| yield r }
+          @additions += updated
+          @deletions += existing
+        end
+      end
+    end
+  end
+end

data/lib/gcloud/storage.rb

@@ -229,19 +229,28 @@ module Gcloud
   #
   # === A note about large uploads
   #
-  # You may encounter a broken pipe error while attempting to upload large
-  # files. To avoid this problem, add
-  # {httpclient}[https://rubygems.org/gems/httpclient] as a dependency to your
-  # project, and configure {Faraday}[https://rubygems.org/gems/faraday] to use
-  # it, after requiring Gcloud, but before initiating your Gcloud connection.
+  # You may encounter a Broken pipe (Errno::EPIPE) error when attempting to
+  # upload large files. To avoid this problem, add the
+  # {httpclient}[https://rubygems.org/gems/httpclient] gem to your project, and
+  # the line (or lines) of configuration shown below. These lines must execute
+  # after you require gcloud but before you make your first gcloud connection.
+  # The first statement configures {Faraday}[https://rubygems.org/gems/faraday]
+  # to use httpclient. The second statement, which should only be added if you
+  # are using a version of Faraday at or above 0.9.2, is a workaround for {this
+  # gzip issue}[https://github.com/GoogleCloudPlatform/gcloud-ruby/issues/367].
   #
   #   require "gcloud"
   #
+  #   # Use httpclient to avoid broken pipe errors with large uploads
   #   Faraday.default_adapter = :httpclient
   #
+  #   # Only add the following statement if using Faraday >= 0.9.2
+  #   # Override gzip middleware with no-op for httpclient
+  #   Faraday::Response.register_middleware :gzip =>
+  #                                           Faraday::Response::Middleware
+  #
   #   gcloud = Gcloud.new
   #   storage = gcloud.storage
-  #   bucket = storage.bucket "my-todo-app"
   #
   # == Downloading a File
   #

data/lib/gcloud/storage/bucket.rb

@@ -326,20 +326,29 @@ module Gcloud
       #
       # ==== A note about large uploads
       #
-      # You may encounter a broken pipe error while attempting to upload large
-      # files. To avoid this problem, add
-      # {httpclient}[https://rubygems.org/gems/httpclient] as a dependency to
-      # your project, and configure {Faraday}[https://rubygems.org/gems/faraday]
-      # to use it, after requiring Gcloud, but before initiating your Gcloud
-      # connection.
+      # You may encounter a Broken pipe (Errno::EPIPE) error when attempting to
+      # upload large files. To avoid this problem, add the
+      # {httpclient}[https://rubygems.org/gems/httpclient] gem to your project,
+      # and the line (or lines) of configuration shown below. These lines must
+      # execute after you require gcloud but before you make your first gcloud
+      # connection. The first statement configures
+      # {Faraday}[https://rubygems.org/gems/faraday] to use httpclient. The
+      # second statement, which should only be added if you are using a version
+      # of Faraday at or above 0.9.2, is a workaround for {this gzip
+      # issue}[https://github.com/GoogleCloudPlatform/gcloud-ruby/issues/367].
       #
       #   require "gcloud"
       #
+      #   # Use httpclient to avoid broken pipe errors with large uploads
       #   Faraday.default_adapter = :httpclient
       #
+      #   # Only add the following statement if using Faraday >= 0.9.2
+      #   # Override gzip middleware with no-op for httpclient
+      #   Faraday::Response.register_middleware :gzip =>
+      #                                           Faraday::Response::Middleware
+      #
       #   gcloud = Gcloud.new
       #   storage = gcloud.storage
-      #   bucket = storage.bucket "my-todo-app"
       #
       def create_file file, path = nil, options = {}
         ensure_connection!

data/lib/gcloud/version.rb

@@ -16,5 +16,5 @@
 #--
 # Google Cloud Version
 module Gcloud
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcloud
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Silvano Luciani
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beefcake
@@ -67,6 +67,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: zonefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.04'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.04'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +272,19 @@ files:
 - lib/gcloud/datastore/proto.rb
 - lib/gcloud/datastore/query.rb
 - lib/gcloud/datastore/transaction.rb
+- lib/gcloud/dns.rb
+- lib/gcloud/dns/change.rb
+- lib/gcloud/dns/change/list.rb
+- lib/gcloud/dns/connection.rb
+- lib/gcloud/dns/credentials.rb
+- lib/gcloud/dns/errors.rb
+- lib/gcloud/dns/importer.rb
+- lib/gcloud/dns/project.rb
+- lib/gcloud/dns/record.rb
+- lib/gcloud/dns/record/list.rb
+- lib/gcloud/dns/zone.rb
+- lib/gcloud/dns/zone/list.rb
+- lib/gcloud/dns/zone/transaction.rb
 - lib/gcloud/errors.rb
 - lib/gcloud/gce.rb
 - lib/gcloud/proto/datastore_v1.pb.rb