fog 1.9.0 → 1.10.0

data/lib/fog/dreamhost/examples/dns/getting_started.md

@@ -0,0 +1,105 @@
+# Getting started with Fog::DNS and Dreamhost (2013/01/21)
+
+You'll need a [Dreamhost](http://www.dreamhost.com) account and API key 
+to use this.
+
+See http://wiki.dreamhost.com/API.
+
+Create an API key selecting **'All dns functions'** to be able to add/remove/list
+records.
+
+## Create the service
+
+We need to create the service first, using the API key from our account:
+
+```ruby
+require 'fog' 
+require 'pp'
+
+dh = Fog::DNS.new( :provider => "Dreamhost",
+                   :dreamhost_api_key => '6SHU5P2HLDAYECUM' )
+```
+
+## List all the DNS zones
+
+This will list all the DNS zones avaialble in your account:
+
+```ruby
+dh.zones.each do |zone|
+  puts zone.domain
+end
+```
+
+## Retrieve all the records
+
+List all the records available in your Dreamhost account, accross all the zones:
+
+```ruby
+dh.records.each do |r|
+  puts r.name
+end
+```
+
+If you  want to fetch all the records in a single zone:
+
+```ruby
+zone = dh.zones.get 'fog-dream.com'
+zone.records.each do |r|
+  # do something with the record
+end
+```
+
+See http://wiki.dreamhost.com/API/Dns_commands#dns-list_records
+
+## Retrieve a single record
+
+Get a single record and do something with the attributes:
+
+```ruby
+rec = dh.records.get 'msn.jabber.groo.com'
+rec.type       # A, CNAME, TXT, etc
+rec.zone       # zone the record belongs to
+rec.account_id # Dreamhost account ID
+rec.comment    # Record text comment
+rec.value      # record value
+```
+
+## Create a new A record
+
+Let's create a new A record:
+
+```
+zone = dh.zones.get 'rbel.co'
+zone.records.create :name => 'stuff.rbel.co',
+                    :type => 'TXT',
+                    :value => 'foobar bar bar'
+```
+
+Since Dreamhost API does not support the concept of zone,
+you can also use this code to accomplish the same thing:
+
+```ruby
+dh.records.create(
+  :name => 'stuff.rbel.co', 
+  :type => 'A',
+  :value => '8.8.8.8'
+)
+```
+
+## Destroy all the records in a zone
+
+```ruby
+(dh.zones.get 'rbel.co').records.each do |rec|
+  rec.destroy
+end
+```
+
+## Resources
+
+The Dreamhost API:
+
+http://wiki.dreamhost.com/Application_programming_interface
+
+DNS API commands:
+
+http://wiki.dreamhost.com/API/Dns_commands

data/lib/fog/dreamhost/models/dns/record.rb

@@ -0,0 +1,35 @@
+require 'fog/core/model'
+
+module Fog
+  module DNS
+    class Dreamhost
+
+      class Record < Fog::Model
+
+        identity  :name, :aliases => 'record'
+
+        attribute :value
+        attribute :zone     
+        attribute :type
+        attribute :editable
+        attribute :account_id
+        attribute :comment
+
+        def destroy
+          service.delete_record(name, type, value)
+          true
+        end
+
+        def save
+          requires :name, :type, :value
+
+          data = service.create_record(name, type, value, comment).body
+          merge_attributes(data)
+          true
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/dreamhost/models/dns/records.rb

@@ -0,0 +1,38 @@
+require 'fog/core/collection'
+require 'fog/dreamhost/models/dns/record'
+
+module Fog
+  module DNS
+    class Dreamhost
+
+      class Records < Fog::Collection
+
+        model Fog::DNS::Dreamhost::Record
+
+        def all(filter = {})
+          clear
+          if filter[:zone]
+            data = service.list_records.body['data'].find_all { |r| r['zone'] == filter[:zone] }
+          else
+            data = service.list_records.body['data']
+          end
+          load(data)
+        end
+
+        def get(record_name)
+          data = service.list_records.body['data'].find { |r| r['record'] == record_name }
+          new(data)
+        rescue Excon::Errors::NotFound
+          nil
+        end
+
+      end
+
+      def new(attributes = {})
+        requires :zone
+        super({ :zone => zone }.merge!(attributes))
+      end
+
+    end
+  end
+end

data/lib/fog/dreamhost/models/dns/zone.rb

@@ -0,0 +1,59 @@
+require 'fog/core/model'
+require 'fog/dreamhost/models/dns/records'
+
+module Fog
+  module DNS
+    class Dreamhost 
+
+      #
+      # Dreamhost API has no concept of 'Zone', but we
+      # can emulate it.
+      #
+      # http://wiki.dreamhost.com/API/Dns_commands
+      #
+      class Zone < Fog::Model
+
+        identity :id
+        attribute :domain,     :aliases => 'name'
+
+        # 
+        # There's no destroy API call
+        #
+        def destroy
+          raise NotImplementedError.new
+        end
+
+        #
+        # Return a list of records for this zone
+        #
+        # Since Dreamhost does not support zones, this is
+        # emulated. Iterates over all the records and discards
+        # the ones where Record.zone != domain (the current zone domain)
+        #
+        def records
+          service.records.all :zone => domain
+        end
+
+        #
+        # Return the Dreamhost nameserver list
+        #
+        def nameservers
+          [
+           "ns1.dreamhost.com",
+           "ns2.dreamhost.com",
+           "ns3.dreamhost.com",
+          ]
+        end
+
+        # 
+        # There's no zone create API call
+        #
+        def save
+          raise NotImplementedError.new
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/dreamhost/models/dns/zones.rb

@@ -0,0 +1,41 @@
+require 'fog/core/collection'
+require 'fog/dreamhost/models/dns/zone'
+
+module Fog
+  module DNS
+    class Dreamhost 
+
+      #
+      # Dreamhost API has no concept of 'Zone', but we
+      # can emulate it.
+      #
+      # http://wiki.dreamhost.com/API/Dns_commands
+      #
+      class Zones < Fog::Collection
+
+        model Fog::DNS::Dreamhost::Zone
+
+        def all
+          clear
+          zones = []
+          zones_added = []
+          service.records.each do |r|
+            unless zones_added.include?(r.zone)
+              zones << { :id => r.zone, :domain => r.zone }
+              zones_added << r.zone
+            end
+          end
+          load(zones)
+        end
+
+        def get(zone_id)
+          service.zones.find { |z| z.domain == zone_id }
+        rescue Excon::Errors::NotFound
+          nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fog/dreamhost/requests/dns/create_record.rb

@@ -0,0 +1,32 @@
+module Fog
+  module DNS
+    class Dreamhost
+
+      class Mock
+
+        def create_record(record, type, value, comment = "")
+          Fog::Mock.not_implemented
+        end
+
+      end
+
+      class Real
+
+        def create_record(record, type, value, comment = "")
+          request( :expects  => 200,
+                   :method   => 'GET',
+                   :path     => "/",
+                   :query    => { 
+                     :record    => record,
+                     :type      => type,
+                     :value     => value,
+                     :cmd       => 'dns-add_record',
+                     :comment   => comment
+                   }
+                 )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/dreamhost/requests/dns/delete_record.rb

@@ -0,0 +1,31 @@
+module Fog
+  module DNS
+    class Dreamhost
+
+      class Mock
+
+        def delete_record(name, type, value)
+          raise Fog::Mock.not_implemented
+        end
+
+      end
+
+      class Real
+
+        def delete_record(name, type, value)
+          request( :expects  => 200,
+                   :method   => "GET",
+                   :path     => "/",
+                   :query    => { 
+                     :cmd      => 'dns-remove_record',
+                     :type     => type,
+                     :record   => name,
+                     :value    => value,
+                   } 
+                 )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/dreamhost/requests/dns/list_records.rb

@@ -0,0 +1,25 @@
+module Fog
+  module DNS
+    class Dreamhost 
+
+      class Mock
+
+        def request(*args)
+          Fog::Mock.not_implemented
+        end
+
+      end
+
+      class Real
+
+        def list_records
+          request( :expects  => 200,
+                   :method   => "GET",
+                   :path     => "/",
+                   :query    => { :cmd => 'dns-list_records' } )
+        end
+
+      end
+    end
+  end
+end

data/lib/fog/ecloud/models/compute/detached_disks.rb

@@ -17,11 +17,7 @@ module Fog
 
         def get(uri)
           data = service.get_detached_disk(uri).body
-          if data == ""
-            new({})
-          else
-            new(data)
-          end
+          new(data)
         rescue Fog::Errors::NotFound
           nil
         end

data/lib/fog/ecloud/models/compute/internet_services.rb

@@ -20,11 +20,7 @@ module Fog
 
         def get(uri)
           data = service.get_internet_service(uri).body
-          if data == ""
-            new({})
-          else
-            new(data)
-          end
+          new(data)
         rescue Fog::Errors::NotFound
           nil
         end

data/lib/fog/ecloud/models/compute/nodes.rb

@@ -20,11 +20,7 @@ module Fog
 
         def get(uri)
           data = service.get_node(uri).body
-          if data == ""
-            new({})
-          else
-            new(data)
-          end
+          new(data)
         rescue Fog::Errors::NotFound
           nil
         end

data/lib/fog/ecloud/models/compute/public_ips.rb

@@ -17,11 +17,7 @@ module Fog
 
         def get(uri)
           data = service.get_public_ip(uri).body
-          if data == ""
-            new({})
-          else
-            new(data)
-          end
+          new(data)
         rescue Fog::Errors::NotFound
           nil
         end

data/lib/fog/ecloud/models/compute/servers.rb

@@ -23,12 +23,8 @@ module Fog
 
         def get(uri)
           data = service.get_server(uri).body
-          if data == ""
-            new({})
-          else
-            new(data)
-          end
-        rescue Excon::Errors::NotFound
+          new(data)
+        rescue Fog::Errors::NotFound
           nil
         end