Clean up REST docs

.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/

CONTRIBUTORS.md

@@ -0,0 +1 @@
+* Chris Luo <[email protected]>

Rakefile

@@ -1,2 +1,11 @@
 require "bundler/gem_tasks"
 
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  puts "#{name}"
+  sh "irb -rubygems -r ./lib/fog/powerdns.rb"
+end

lib/fog/powerdns/models/dns/record.rb

@@ -4,6 +4,7 @@ module Fog
   module DNS
     class PowerDNS
       class Record < Fog::Model
+        # TODO: Needs work to comply with powerdns api
         identity :name
 
         attribute :content
@@ -20,12 +21,9 @@ def domain
         end
         def destroy
           # service.delete_record(id)
-          # maybe hack our own delete? this does nothing for now
+          # TODO: maybe hack our own delete? this does nothing for now
           true
         end
-        def zone
-          @zone
-        end
 
       end
     end

lib/fog/powerdns/models/dns/zone.rb

@@ -29,7 +29,6 @@ def records
 
         def save
           requires :zone
-          # TODO: What does this do?
           data = service.create_zone(zone).body["zone"]
           merge_attributes(data)
           true

lib/fog/powerdns/requests/dns/delete_zone.rb

@@ -14,7 +14,7 @@ class Real
         # * response<~Excon::Response>:
         #   * body<~Hash>:
         #   * status<~Integer> - 204 when successful
-        # TODO: Verify this returns
+        #
 
         def delete_zone(server, zone)
           request(

lib/fog/powerdns/requests/dns/list_cryptokeys.rb

@@ -5,7 +5,8 @@ class Real
         # Get details of all public cryptokeys
         #
         # ==== Parameters
-        # Need server_id, zone_id
+        # server<~String> - server id
+        # zone<~String> - zone id
         #
         # ==== Returns
         # * response<~Excon::Response>:

lib/fog/powerdns/requests/dns/list_zones.rb

@@ -5,7 +5,7 @@ class Real
         # Get details of a server's DNS zones
         #
         # ==== Parameters
-        # * zone<~String> - server id
+        # * server<~String> - server id
         #
         # ==== Returns
         # * response<~Excon::Response>:

lib/fog/powerdns/requests/dns/notify_zone.rb

@@ -11,8 +11,30 @@ class Real
         # * zone<~String> - zone name
         #
         # ==== Returns
-        # TODO: Fill this out
-        #
+        # TODO: Untested
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * 'id': <~String>,
+        #     * "name": <~String>,
+        #     * 'type': <~String>,
+        #     * 'url': <~String>,
+        #     * 'kind': <~String>,
+        #     * 'serial': <~Integer>,
+        #     * 'notified_serial': <~Int>,
+        #     * 'masters': <~Array,
+        #     * 'dnssec': <~Boolean>,
+        #     * 'nsec3param': <~String>,
+        #     * 'nsec3narrow': <~Boolean>,
+        #     * 'presigned': <~Boolean>,
+        #     * 'soa_edit': '<~String>',
+        #     * 'soa_edit_api': '<~String>',
+        #     * 'account': '<~String>',
+        #     * 'nameservers': <~Array>,
+        #     * 'servers': <~Array>,
+        #     * 'recursion_desired': <~Boolean>,
+        #     * 'records': <~Array>,
+        #     * 'comments': <~Array>,
+        #   * status<~Integer>  200 when successful
 
         def notify_zone(server, zone)
           request(

lib/fog/powerdns/requests/dns/retrieve_zone.rb

@@ -11,8 +11,30 @@ class Real
         # * zone<~String> - zone name
         #
         # ==== Returns
-        # TODO: Fill this out
-        #
+        # TODO: Untested
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * 'id': <~String>,
+        #     * "name": <~String>,
+        #     * 'type': <~String>,
+        #     * 'url': <~String>,
+        #     * 'kind': <~String>,
+        #     * 'serial': <~Integer>,
+        #     * 'notified_serial': <~Int>,
+        #     * 'masters': <~Array,
+        #     * 'dnssec': <~Boolean>,
+        #     * 'nsec3param': <~String>,
+        #     * 'nsec3narrow': <~Boolean>,
+        #     * 'presigned': <~Boolean>,
+        #     * 'soa_edit': '<~String>',
+        #     * 'soa_edit_api': '<~String>',
+        #     * 'account': '<~String>',
+        #     * 'nameservers': <~Array>,
+        #     * 'servers': <~Array>,
+        #     * 'recursion_desired': <~Boolean>,
+        #     * 'records': <~Array>,
+        #     * 'comments': <~Array>,
+        #   * status<~Integer>  201 when successful
 
         def retrieve_zone(server, zone)
           request(

lib/fog/powerdns/requests/dns/update_rrsets.rb

@@ -5,15 +5,31 @@ class Real
         # Modify existing RRset's of a zone
         #
         # ==== Parameters
-        # TODO: Display response JSON keys
+        # server<~String> - server id
+        # zone<~String> - zone id
+        # options<~Hash> - see pdns api for rules
         #
         # ==== Returns
         # * response<~Excon::Response>:
         #   * body<~Hash>:
-        #     * 'zone'<~Hash> The representation of the rrsets.
+        #     * 'rrsets'<~Hash> The representation of the rrsets:
+        #       * 'name': <~String>,
+        #       * 'type': <~String>,
+        #       * 'changetype': <~String>,
+        #       * 'records' <~Hash> domain records:
+        #         * 'content': <~String>,
+        #         * 'name': <~String>,
+        #         * 'ttl': <~Integer>,
+        #         * 'type': <~String>,
+        #         * 'disabled': <~Boolean>,
+        #         * 'set-ptr': <~Boolean>
+        #       * 'comments' <~Hash> comments:
+        #         * 'account': <~String>,
+        #         * 'content': <~String>,
+        #         * 'modfied_at': <~Integer>
 
-        def update_rrsets(server, id, options = {})
-          # TODO: Have kind default to Native
+
+        def update_rrsets(server, zone, options = {})
           options.each { |option, value|
             body[option] = value;
           }
@@ -22,7 +38,7 @@ def update_rrsets(server, id, options = {})
               :body     => Fog::JSON.encode(body),
               :expects  => 200,
               :method   => 'PATCH',
-              :path     => "/servers/#{server}/zones/#{id}/"
+              :path     => "/servers/#{server}/zones/#{zone}/"
           )
         end
       end

lib/fog/powerdns/requests/dns/update_zone.rb

@@ -5,7 +5,9 @@ class Real
         # Modify a single zone in PowerDNS
         #
         # ==== Parameters
-        # server, name, options
+        # server<~String> - server id
+        # zone<~String> - zone id
+        # options<~Hash> - pairs enumerated below
         #
         #
         # ==== Returns