pdns_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa80cf3197ec8aadd0d2a93cf3cf0a1df581034c
-  data.tar.gz: 5c0e8f49631af8097165db914a239cc527033992
+  metadata.gz: 657948fecf6bc98b2564c4ca8a662fe535effc76
+  data.tar.gz: 5f3d133e97e22df2ff682500d079bc0cbeed06f8
 SHA512:
-  metadata.gz: 533c9908e0d64d37594c683476009952606007ed065f5ff06f4ced79199eb5bb1bf88f739ad487982f6d9adb6eaabbe30654bff5e7378492f94ea2ed15f4e5c6
-  data.tar.gz: 52f239530706b483f0b21b55fc8c014a0e84c609ff0b51cd0dfda9403bc51d3b403123358c0ef858f62339a84edaa62b3eb6e993fd1ee7a1b026e2831e66e745
+  metadata.gz: b1f5e2794d3d8da64596717ac8beb59328e90eb6774e91561aff3183eb6ed9e5bfb74549056c6247599279b56482046dad74e195692d4d2d11b13a20131978bc
+  data.tar.gz: b4f3d1ac66fd8abe82170710da88927f86d4283018384804188eb715472203347306c227d8d2536a17df995af6286587e7dfbcd2545eb00551c85a37e72ec077

data/lib/pdns_api/api.rb

@@ -44,6 +44,14 @@ module PDNS
     #
     # If +info+ is set this method updates the current information.
     # The current information is used to create the object.
+    #
+    # Example:
+    #  zone.create(
+    #    name: zone.id,
+    #    kind: 'Native',
+    #    dnssec: true,
+    #    nameservers: %w( ns0.example.com. ns1.example.com. )
+    #  )
     def create(info = nil)
       info(info)
       @http.post("#{@parent.url}/#{@class}", @info)

data/lib/pdns_api/config.rb

@@ -25,10 +25,6 @@ module PDNS
     # The name of the configuration option.
     attr_accessor :name
 
-    ##
-    # The value of the configuration option.
-    attr_accessor :value
-
     ##
     # Disabled common methods
     undef_method :delete
@@ -75,6 +71,10 @@ module PDNS
     #
     # If +value+ is set, the current +value+ is used.
     # If +value+ is not set, +value+ is updated and then used.
+    #
+    # Example:
+    #   config.change('PowerDNS v3.14159265')
+    #
     def change(value = nil)
       value(value)
       @http.put(@url, @info)

data/lib/pdns_api/metadata.rb

@@ -25,10 +25,6 @@ module PDNS
     # The kind of metadata.
     attr_accessor :kind
 
-    ##
-    # The value of the metadata.
-    attr_accessor :value
-
     ##
     # Creates a configuration option object.
     #

data/lib/pdns_api/version.rb

@@ -20,5 +20,5 @@
 module PDNS
   ##
   # The version of +pdns_api+.
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/lib/pdns_api/zone.rb

@@ -47,6 +47,13 @@ module PDNS
     ##
     # Modifies information (records) of a zone.
     # Also formats records to match the API requirements.
+    #
+    # Example:
+    #  zone.modify([
+    #     changetype: 'DELETE',
+    #     name: 'www.example.com.',
+    #     type: 'A'
+    #  ])
     def modify(rrsets)
       rrsets.map! do |rrset|
         rrset = format_records(rrset) if rrset.key?(:records)
@@ -92,6 +99,30 @@ module PDNS
     # Adds records to the ones already existing in the zone.
     #
     # The existing records are retrieved and merged with the ones given in +rrsets+.
+    #
+    # Elements of +rrsets+ can contain +:records+, which can be:
+    # - A +String+ containing a single record value.
+    # - An +Array+ containing record values.
+    # - An +Array+ containing hashes as specified in the PowerDNS API.
+    #
+    # Example:
+    #   zone.add({
+    #     name: 'www0.example.com.',
+    #     type: 'A',
+    #     ttl:  86_400,
+    #     records: '127.0.1.1',
+    #   }, {
+    #     name: 'www1.example.com.',
+    #     type: 'A',
+    #     ttl:  86_400,
+    #     records: ['127.0.1.1', '127.0.0.1'],
+    #   }, {
+    #     name: 'www2.example.com.',
+    #     type: 'A',
+    #     ttl:  86_400,
+    #     records: [{content: '127.0.1.1'},{content: '127.0.0.1', disabled: true}],
+    #   })
+    #
     def add(*rrsets)
       # Get current zone data
       data = get
@@ -114,6 +145,32 @@ module PDNS
 
     ##
     # Updates (replaces) records for a name/type combination in the zone.
+    #
+    # +rrsets+ is used to create a changeset.
+    #
+    # Elements of +rrsets+ can contain +:records+, which can be:
+    # - A +String+ containing a single record value.
+    # - An +Array+ containing record values.
+    # - An +Array+ containing hashes as specified in the PowerDNS API.
+    #
+    # Example:
+    #   zone.update({
+    #     name: 'www0.example.com.',
+    #     type: 'A',
+    #     ttl:  86_400,
+    #     records: '127.0.1.1'
+    #   }, {
+    #     name: 'www1.example.com.',
+    #     type: 'A',
+    #     ttl:  86_400,
+    #     records: ['127.0.1.1', '127.0.0.1']
+    #   }, {
+    #     name: 'www2.example.com.',
+    #     type: 'A',
+    #     ttl:  86_400,
+    #     records: [{content: '127.0.1.1'},{content: '127.0.0.1', disabled: true}]
+    #   })
+    #
     def update(*rrsets)
       # Set type and format records
       rrsets.map! do |rrset|
@@ -126,6 +183,16 @@ module PDNS
 
     ##
     # Removes all records for a name/type combination from the zone.
+    #
+    # Example:
+    #   zone.remove({
+    #     name: 'www0.example.com.',
+    #     type: 'A'
+    #   }, {
+    #     name: 'www1.example.com.',
+    #     type: 'A'
+    #   })
+    #
     def remove(*rrsets)
       # Set type and format records
       rrsets.map! do |rrset|
@@ -142,6 +209,17 @@ module PDNS
     #
     # If +kind+ is set a +Metadata+ object is returned using the provided +kind+.
     # If +value+ is set as well, a complete Metadata object is returned.
+    #
+    # Example:
+    #  # Retrieve all metadata in a hash
+    #  zone.metadata
+    #  # Create a metadata object
+    #  meta = zone.metadata('ALLOW-AXFR-FROM')
+    #  puts meta.get
+    #  # Create a metadata object with a value
+    #  meta = zone.metadata('ALLOW-AXFR-FROM','AUTO-NS')
+    #  meta.change
+    #
     def metadata(kind = nil, value = nil)
       return Metadata.new(@http, self, kind, value) unless kind.nil? || value.nil?
       return Metadata.new(@http, self, kind) unless kind.nil?
@@ -163,6 +241,10 @@ module PDNS
     # containing +CryptoKey+ objects.
     #
     # If +id+ is set a +CryptoKey+ object with the provided ID is returned.
+    #
+    # Example:
+    #  ckeys = zone.cryptokeys
+    #  ckey  = zone.cryptokey(12)
     def cryptokeys(id = nil)
       return CryptoKey.new(@http, self, id) unless id.nil?
 
@@ -214,8 +296,8 @@ module PDNS
     # Returns the records matching the ones in +rrset+ from +data+.
     # +data+ should be the result from +get+.
     def current_records(rrset, data)
-      # Get the records from the data, `records` is v0, `rrset` is v1
-      records = data[:records] || data[:rrset]
+      # Get the records from the data, `records` is v0, `rrsets` is v1
+      records = data[:records] || data[:rrsets]
 
       # Select records matching type/name
       current = records.select { |r| r[:name] == rrset[:name] && r[:type] == rrset[:type] }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdns_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Silke Hofstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies: []
 description: A gem for manipulation of DNS through the PowerDNS API
 email: silke.ruby@slxh.nl