google-cloud-dns 0.20.0

data/lib/google/cloud/dns/zone/list.rb

@@ -0,0 +1,170 @@
+# 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.
+
+
+require "delegate"
+
+module Google
+  module Cloud
+    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 zones that match
+          # the request and this value should be passed to continue.
+          attr_accessor :token
+
+          ##
+          # @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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.new
+          #   dns = gcloud.dns
+          #
+          #   zones = dns.zones
+          #   if zones.next?
+          #     next_zones = zones.next
+          #   end
+          #
+          def next
+            return nil unless next?
+            ensure_service!
+            gapi = @service.list_zones token: token, max: @max
+            Zone::List.from_gapi gapi, @service, @max
+          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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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 ListManagedZonesResponse object.
+          def self.from_gapi gapi, conn, max = nil
+            zones = new(Array(gapi.managed_zones).map do |g|
+              Zone.from_gapi g, conn
+            end)
+            zones.instance_variable_set "@token",   gapi.next_page_token
+            zones.instance_variable_set "@service", conn
+            zones.instance_variable_set "@max",     max
+            zones
+          end
+
+          protected
+
+          ##
+          # Raise an error unless an active connection is available.
+          def ensure_service!
+            fail "Must have active connection" unless @service
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dns/zone/transaction.rb

@@ -0,0 +1,180 @@
+# 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 Google
+  module Cloud
+    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.
+        #
+        # @example
+        #   require "google/cloud"
+        #
+        #   gcloud = Google::Cloud.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
+          # @private
+          attr_reader :additions, :deletions
+
+          ##
+          # @private Creates a new transaction.
+          def initialize zone
+            @zone = zone
+            @additions = []
+            @deletions = []
+          end
+
+          ##
+          # Adds a record to the Zone.
+          #
+          # @param [String] name The owner of the record. For example:
+          #   `example.com.`.
+          # @param [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`.
+          # @param [Integer] ttl The number of seconds that the record can be
+          #   cached by resolvers.
+          # @param [String, Array<String>] 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.`.
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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.
+          #
+          # @param [String] name The owner of the record. For example:
+          #   `example.com.`.
+          # @param [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`.
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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, type).all.to_a
+          end
+
+          ##
+          # Replaces existing records on the Zone. Records matching the `name`
+          # and `type` are replaced.
+          #
+          # @param [String] name The owner of the record. For example:
+          #   `example.com.`.
+          # @param [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`.
+          # @param [Integer] ttl The number of seconds that the record can be
+          #   cached by resolvers.
+          # @param [String, Array<String>] 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.`.
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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.
+          #
+          # @param [String] name The owner of the record. For example:
+          #   `example.com.`.
+          # @param [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`.
+          # @yield [record] a block yielding each matching record
+          # @yieldparam [Record] record the record to be modified
+          #
+          # @example
+          #   require "google/cloud"
+          #
+          #   gcloud = Google::Cloud.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, type).all.to_a
+            updated = existing.map(&:dup)
+            updated.each { |r| yield r }
+            @additions += updated
+            @deletions += existing
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: google-cloud-dns
+version: !ruby/object:Gem::Version
+  version: 0.20.0
+platform: ruby
+authors:
+- Mike Moore
+- Chris Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: autotest-suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: google-cloud-dns is the official library for Google Cloud DNS.
+email:
+- mike@blowmage.com
+- quartzmo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/google-cloud-dns.rb
+- lib/google/cloud/dns.rb
+- lib/google/cloud/dns/change.rb
+- lib/google/cloud/dns/change/list.rb
+- lib/google/cloud/dns/credentials.rb
+- lib/google/cloud/dns/importer.rb
+- lib/google/cloud/dns/project.rb
+- lib/google/cloud/dns/record.rb
+- lib/google/cloud/dns/record/list.rb
+- lib/google/cloud/dns/service.rb
+- lib/google/cloud/dns/version.rb
+- lib/google/cloud/dns/zone.rb
+- lib/google/cloud/dns/zone/list.rb
+- lib/google/cloud/dns/zone/transaction.rb
+homepage: http://googlecloudplatform.github.io/google-cloud-ruby/
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: API Client library for Google Cloud DNS
+test_files: []