fog 0.3.31 → 0.3.32

data/.document

@@ -0,0 +1,3 @@
+README.rdoc
+lib/**/*.rb
+bin/*

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.rbc
+*.sw?
+.bundle
+.DS_Store
+coverage
+doc/*
+rdoc
+pkg
+spec/credentials.yml

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    fog (0.3.31)
+    fog (0.3.32)
       builder
       excon (>= 0.3.3)
       formatador (>= 0.0.16)
       json
       mime-types
-      named-parameters (>= 0.0.17)
       net-ssh (>= 2.0.23)
       nokogiri (>= 1.4.4)
       ruby-hmac
@@ -22,7 +21,6 @@ GEM
       formatador (>= 0.0.12)
     json (1.4.6)
     mime-types (1.16)
-    named-parameters (0.0.18)
     net-ssh (2.0.23)
     nokogiri (1.4.4)
     rake (0.8.7)
@@ -42,7 +40,6 @@ DEPENDENCIES
   formatador (>= 0.0.16)
   json
   mime-types
-  named-parameters (>= 0.0.17)
   net-ssh (>= 2.0.23)
   nokogiri (>= 1.4.4)
   rake

data/README.rdoc

@@ -1,20 +1,16 @@
 http://geemus.s3.amazonaws.com/fog.png
 
-fog is the Ruby cloud computing library.
-
-The quick and dirty, top to bottom:
+fog is the Ruby cloud computing library, top to bottom:
 
 * Collections provide a simplified interface, making clouds easier to work with and switch between.
 * Requests allow power users to get the most out of the features of each individual cloud.
 * Mocks make testing and integrating a breeze.
 
-Put them together and you get a great cloud computing experience, but we are getting ahead of ourselves...
-
 == Getting Started
 
   sudo gem install fog
 
-Now just type 'fog' to trying stuff out, confident that fog should let you know what you need to do. Here is an example of wading through server creation for Amazon Elastic Compute Cloud:
+Now type 'fog' to try stuff, confident that fog will let you know what to do. Here is an example of wading through server creation for Amazon Elastic Compute Cloud:
 
   >> server = AWS.servers.create
   ArgumentError: image_id is required for this operation
@@ -27,73 +23,67 @@ Now just type 'fog' to trying stuff out, confident that fog should let you know
 
 == Collections
 
-A high level interface to each cloud is provided through collections, such as images and servers.
-You can see a list of available collections by calling #collections on the connection object. You can try it out using the `fog` command:
+A high level interface to each cloud is provided through collections, such as `images` and `servers`.
+You can see a list of available collections by calling `collections` on the connection object. You can try it out using the `fog` command:
 
-  >> server = AWS.collections
+  >> AWS.collections
   [:addresses, :directories, :files, :flavors, :images, :key_pairs, :security_groups, :servers, :snapshots, :volumes]
 
-Some of these collections are available across multiple providers. For example, all compute providers have +flavors+, +images+ and +servers+, and storage providers have +directory+ and +file+. 
+Some collections are available across multiple providers. For example, compute providers have +flavors+, +images+ and +servers+, and storage providers have +directory+ and +file+.
 
-Collections share most of the basic CRUD type operations, such as:
+Collections share basic CRUD type operations, such as:
 * +all+ - fetch every object of that type from the provider.
-* +create+ - initialize a new record locally and then persists it with the provider.
-* +get+ - fetch a single object by its identity from the provider.
-* +new+ - initialize a new record locally, but do not persist it to the provider.
+* +create+ - initialize a new record locally and a remote resource with the provider.
+* +get+ - fetch a single object by it's identity from the provider.
+* +new+ - initialize a new record locally, but do not create a remote resource with the provider.
 
 As an example, we'll try initializing and persisting a Rackspace Cloud server:
 
   require 'fog'
 
-  # initialize a connection to Rackspace Cloud Servers
-  connection = Fog::Rackspace::Servers.new(
-    :rackspace_api_key => key,
+  compute = Fog::Compute.new(
+    :provider           => 'Rackspace',
+    :rackspace_api_key  => key,
     :rackspace_username => username
   )
 
   # boot a gentoo server (flavor 1 = 256, image 3 = gentoo 2008.0)
-  server = connection.servers.create(:flavor_id => 1, :image_id => 3, :name => 'my_server')
-
-  # wait for it to be ready to do stuff
-  server.wait_for { ready? }
+  server = compute.servers.create(:flavor_id => 1, :image_id => 3, :name => 'my_server')
+  server.wait_for { ready? } # give server time to boot
 
   # DO STUFF
 
-  # shutdown the server
-  server.destroy
+  server.destroy # cleanup after yourself or regret it, trust me
 
 == Models
 
-Many of the collection methods return individual objects, which also provide some common methods:
+Many of the collection methods return individual objects, which also provide common methods:
 * +destroy+ - will destroy the persisted object from the provider
 * +save+ - persist the object to the provider
 * +wait_for+ - takes a block and waits for either the block to return true for the object or for a timeout (defaults to 10 minutes)
 
 == Mocks
 
-As you might imagine, testing code using Fog could be feasibly slow and expensive to constantly be turning and and shutting down instances. Fortunately, fog includes support for mocking itself out.
-
-Mocking provides an in memory representation of the state of cloud resources as you make requests.
-Mocked calls to mimic the behavior of each provider while eliminating the cost and time needed to actually use cloud resources.
-Enabling mocking easy to use, before you run any other commands run:
+As you might imagine, testing code using Fog can be slow and expensive, constantly turning on and and shutting down instances.
+Mocking allows skipping this overhead by providing an in memory representation resources as you make requests.
+Enabling mocking easy to use, before you run other commands, simply run:
 
   Fog.mock!
 
-Then you can run other commands just like you always would.
-Some mocks are not implemented just yet, but fog will raise an error to let you know and contributions are always welcome!
+Then proceed as usual, if you run into unimplemented mocks fog will raise an error and as always contributions are welcome!
 
 == Requests
 
 Requests allow you to dive deeper when the models just can't cut it.
 You can see a list of available requests by calling #requests on the connection object.
-For instance, ec2 provides methods related to reserved instances that don't have any models (yet).
-Here is how you can lookup your reserved instances:
+
+For instance, ec2 provides methods related to reserved instances that don't have any models (yet). Here is how you can lookup your reserved instances:
 
   $ fog
   >> AWS[:ec2].describe_reserved_instances
   #<Excon::Response [...]>
 
-It will return an {excon}[http://github.com/geemus/excon] response, which has #headers and #body. Both return nice hashes.
+It will return an {excon}[http://github.com/geemus/excon] response, which has `body`, `headers` and `status`. Both return nice hashes.
 
 == Go forth and conquer
 
@@ -114,15 +104,16 @@ You should try out the (varying) support fog has for:
 * {Blue Box Group}[http://www.blueboxgrp.com] [{Compute}[http://www.blueboxgrp.com/blocks]]
 * {Brightbox}[http://www.brightbox.co.uk] [{Compute}[http://beta.brightbox.com/]]
 * {Google}[http://www.google.com] [{Storage}[http://code.google.com/apis/storage]]
+* Local [Storage]
 * {Rackspace}[http://www.rackspace.com] [{Compute}[http://www.rackspacecloud.com/cloud_hosting_products/servers], {Storage}[http://www.rackspacecloud.com/cloud_hosting_products/files]]
-* {Slicehost}[http://www.slicehost.com] [{Compute}[http://www.slicehost.com]]
+* {Slicehost}[http://www.slicehost.com] [{Compute}[http://www.slicehost.com], {DNS}[http://www.slicehost.com]]
 * {Terremark}[http://www.terremark.com] [{vCloud Express}[http://vcloudexpress.terremark.com]]
 
 There are also the basics of these providers (that could use your love):
 * {GoGrid}[http://www.gogrid.com] [{Compute}[http://www.gogrid.com]]
-* {Linode}[http://www.linode.com] [{Compute}[http://www.linode.com]]
-* Local [Storage]
+* {Linode}[http://www.linode.com] [{Compute}[http://www.linode.com], {DNS}[http://www.linode.com]]
 * {New Servers}[http://www.newservers.com] [{Compute}[http://www.newservers.com]]
+* {Zerigo}[http://www.zerigo.com] [{DNS}[http://www.zerigo.com/managed-dns]]
 
 Enjoy, and let me know what I can do to continue improving fog!
 
@@ -132,6 +123,7 @@ Enjoy, and let me know what I can do to continue improving fog!
 * Report bugs or find stuff to work on in {issues}[http://github.com/geemus/fog/issues]
 * Learn about {contributing}[http://github.com/geemus/fog/wiki/contributor-guide] or find more info about the {Providers}[http://github.com/geemus/fog/wiki/Providers] (including some todo items)
 * See what already uses fog and add your own stuff to {the list}[http://wiki.github.com/geemus/fog/in-the-wild]
+* Check out blog posts and other mentions from elsewhere {press}[http://wiki.github.com/geemus/fog/press]
 
 == Sponsorship
 

data/Rakefile

@@ -46,13 +46,6 @@ end
 task :default => :test
 
 task :test do
-  sh("export FOG_MOCK=true  && bundle exec spec -cfs spec") &&
-  sh("export FOG_MOCK=true  && bundle exec shindo tests") &&
-  sh("export FOG_MOCK=false && bundle exec spec -cfs spec") &&
-  sh("export FOG_MOCK=false && bundle exec shindo tests")
-end
-
-task :ci do
   sh("export FOG_MOCK=true  && bundle exec spec spec") &&
   sh("export FOG_MOCK=true  && bundle exec shindont tests") &&
   sh("export FOG_MOCK=false && bundle exec spec spec") &&
@@ -108,27 +101,14 @@ end
 task :gemspec => :validate do
   # read spec file and split out manifest section
   spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
 
   # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
+  replace_header(spec, :name)
+  replace_header(spec, :version)
+  replace_header(spec, :date)
   #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  replace_header(spec, :rubyforge_project)
+
   File.open(gemspec_file, 'w') { |io| io.write(spec) }
   puts "Updated #{gemspec_file}"
 end

data/bin/fog

@@ -2,9 +2,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'fog'))
 require 'irb'
 require 'yaml'
-require File.join('fog', 'core', 'credentials')
 Fog.credential = ARGV.first ? ARGV.first.to_sym : nil
-Fog.bin = true
 Fog.mock! if ENV['FOG_MOCK']
 unless Fog.credentials
   exit
@@ -35,7 +33,7 @@ else
   @irb.context.workspace = IRB::WorkSpace.new(binding)
 
   Formatador.display_line('Welcome to fog interactive!')
-  Formatador.display_line(":#{Fog.credential.to_s} credentials provide #{providers}")
+  Formatador.display_line(":#{Fog.credential} provides #{providers}")
   providers = Fog.providers
   Fog.modules.each do |_module_|
     if _module_.respond_to?(:startup_notice)

data/examples/dns_methods.rb

@@ -0,0 +1,389 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib', 'fog')
+require 'fog/core/bin'
+
+#mark true for each cloud you wish to enable/run the sample for
+RUN_AWS_SAMPLE = true
+RUN_LINODE_SAMPLE = false
+RUN_SLICEHOST_SAMPLE = false
+RUN_ZERIGO_SAMPLE = false
+
+#domain to use in examples
+TEST_DOMAIN = 'test-343246324434.com'
+
+# example of how to use AWS Route 53 DNS calls
+def show_aws_dns_usage
+
+  begin    
+    
+    #use to keep track of zone we create
+    zone_id= nil
+    
+    # see if domain is already hosted on AWS
+    # important to check as AWS will let you create multiple zones with the same domain name
+    options= { :max_items => 200 }
+    response = AWS[:dns].list_hosted_zones( options)
+    if response.status == 200
+      zones = response.body['HostedZones']
+      zones.each { |zone|
+        domain_name = zone['Name']
+        if domain_name.chop == TEST_DOMAIN
+          zone_id = zone['Id'].sub('/hostedzone/', '')
+        end
+      }
+    end
+    
+    #if domain not yet created, do so now
+    if zone_id.nil?
+      options= { :comment => 'test domain - not for production use' }
+      response = AWS[:dns].create_hosted_zone( TEST_DOMAIN, options)
+      if response.status == 201
+        zone_id = response.body['HostedZone']['Id']
+        change_id = response.body['ChangeInfo']['Id']
+        status = response.body['ChangeInfo']['Status']
+      end
+    end
+    
+    #get details about zone including name servers (which AWS adds automatically)
+    response = AWS[:dns].get_hosted_zone( zone_id)
+    if response.status == 200
+      zone_info = response.body['HostedZone']
+      name_servers = response.body['NameServers']
+      num_ns_servers = name_servers.count
+    end
+
+    #add an A record for www
+    change_batch = []
+    host = 'www.' + TEST_DOMAIN
+    ip_addr = '1.2.3.4'
+    record = { :name => host, :type => 'A', :resource_records => [ip_addr], :ttl => 3600 }
+    
+    resource_record_set = record.merge( :action => 'CREATE' )
+    change_batch << resource_record_set
+    options = { :comment => 'add A record for www'}
+    response = AWS[:dns].change_resource_record_sets( zone_id, change_batch, options)
+    if response.status == 200
+      change_id = response.body['Id']
+      status = response.body['Status']
+    end
+    
+    debugger
+
+    #wait until new zone is live across all name servers
+    while status == 'PENDING'
+      sleep 2
+      response = AWS[:dns].get_change( change_id)
+      if response.status == 200
+        change_id = response.body['Id']
+        status = response.body['Status']
+      end
+      puts "your changes are #{status}"    
+    end
+
+    # get resource records for zone
+    response = AWS[:dns].list_resource_record_sets( zone_id)
+    if response.status == 200
+      record_sets= response.body['ResourceRecordSets']
+      num_records= record_sets.count
+    end
+
+    #now delete record for www
+    resource_record_set = record.merge( :action => 'DELETE' )
+    change_batch = []
+    change_batch << resource_record_set
+    options = { :comment => 'remove A record for www'}
+    response = AWS[:dns].change_resource_record_sets( zone_id, change_batch, options)
+    if response.status == 200
+      change_id = response.body['Id']
+      status = response.body['Status']
+    end
+    
+    #delete the zone
+    response = AWS[:dns].delete_hosted_zone( zone_id)
+    if response.status == 200
+      change_id = response.body['ChangeInfo']['Id']
+    end
+
+
+  rescue 
+    #opps, ran into a problem
+    puts $!.message
+    return false
+  end
+
+  true
+end
+
+
+# example of how to use Linode DNS calls
+def show_linode_dns_usage
+  
+  begin
+    
+    #create a zone for a domain
+    type = 'master'
+    options = { :SOA_email => 'netops@sample-domain.com', :description => "Sample-Domain Inc", :status => 0}
+    response = Linode[:compute].domain_create( TEST_DOMAIN, type, options)
+    if response.status == 200
+      master_zone_id = response.body['DATA']['DomainID']
+      puts "created zone for #{TEST_DOMAIN} - ID: #{master_zone_id}"
+    end
+    
+    #create a slave zone
+    domain = 'sample-slave-domain.com'
+    type = 'slave'
+    options = { :master_ips => '1.2.3.4; 1.2.3.5'}
+    response = Linode[:compute].domain_create( domain, type, options)
+    if response.status == 200
+      slave_zone_id = response.body['DATA']['DomainID']
+      puts "created slave zone for #{domain} - ID: #{slave_zone_id}"
+    end
+
+    #get a list of zones Linode hosted for account
+    response = Linode[:compute].domain_list()
+    if response.status == 200
+      zones = response.body['DATA']
+      num_zones = zones.count
+      puts "Linode is hosting #{num_zones} DNS zones for this account:"
+      zones.each { |zone|
+        puts "  #{zone['DOMAIN']}\n"
+      }
+    end
+
+    #add an A and a MX record
+    domain= 'www.' + TEST_DOMAIN
+    options = { :name => domain, :target => '4.5.6.7', :ttl_sec => 7200 }
+    response = Linode[:compute].domain_resource_create( master_zone_id, 'A', options)
+    if response.status == 200
+      resource_id = response.body['DATA']['ResourceID']
+      puts "added an A record for #{domain} - ID: #{resource_id}"
+    end
+
+    domain= 'mail.' + TEST_DOMAIN
+    options = { :target => domain, :priority => 1 }
+    response = Linode[:compute].domain_resource_create( master_zone_id, 'MX', options)
+    if response.status == 200
+      resource_id = response.body['DATA']['ResourceID']
+      puts "added a MX record for #{TEST_DOMAIN} - ID: #{resource_id}"
+    end
+
+    #change MX to have a lower priority
+    options = { :priority => 5 }
+    response = Linode[:compute].domain_resource_update( master_zone_id, resource_id, options)
+    if response.status == 200
+      resource_id = response.body['DATA']['ResourceID']
+      puts "updated MX record for #{TEST_DOMAIN} with new priority - ID: #{resource_id}"      
+    end
+    
+    #get the list of resource records for the domain
+    response = Linode[:compute].domain_resource_list( master_zone_id)
+    if response.status == 200
+      num_records = response.body['DATA'].count
+      puts "#{TEST_DOMAIN} zone has #{num_records} resource records"
+    end
+
+    #finally cleanup by deleting the zone we created
+    response = Linode[:compute].domain_delete( master_zone_id)
+    if response.status == 200
+      puts "deleted #{TEST_DOMAIN} zone"
+    end
+    response = Linode[:compute].domain_delete( slave_zone_id)
+    if response.status == 200
+      puts "deleted slave zone"
+    end
+       
+  rescue
+    #opps, ran into a problem
+    puts $!.message
+    return false
+  end
+
+  true
+end
+
+
+# example of how to use Slicehost DNS calls
+def show_slicehost_dns_usage
+  
+  begin
+    #create a zone for a domain
+    zone_id = 0
+    options = { :ttl => 1800, :active => 'N' }
+    response= Slicehost[:compute].create_zone( TEST_DOMAIN, options)
+    if response.status == 201
+      zone_id= response.body['id']
+      puts "created zone for #{TEST_DOMAIN} - ID: #{zone_id}"
+    end
+    
+    #add an A record for website 
+    record_id = 0
+    options = { :ttl => 3600, :active => 'N' }
+    host = "www.#{TEST_DOMAIN}"
+    response= Slicehost[:compute].create_record( 'A', zone_id, host, "1.2.3.4", options)
+    if response.status == 201
+      record_id= response.body['id']
+      puts "created 'A' record for #{host} - ID: #{record_id}"
+    end
+    
+    #get a list of zones Slicehost hosted for account
+    response = Slicehost[:compute].get_zones()
+    if response.status == 200
+      zones = response.body['zones']
+      num_zones= zones.count
+      puts "Slicehost is hosting #{num_zones} DNS zones for this account"
+      zones.each { |zone|
+        puts "  #{zone['origin']}\n"
+      }
+    end
+  
+    #now get details on www record for the zone
+    if record_id > 0
+      response = Slicehost[:compute].get_record( record_id)
+      if response.status == 200
+        record = response.body['records'][0]
+        name = record['name']
+        type = record['record-type']
+        puts "got details on record #{record_id} -is an #{type} record for #{name} domain"
+      end
+    end
+  
+    #finally cleanup by deleting the zone we created
+    if zone_id > 0
+      response = Slicehost[:compute].delete_zone( zone_id)
+      if response.status == 200
+        puts "#{TEST_DOMAIN} removed from Slicehost DNS"
+      end
+    end
+      
+  rescue 
+    #opps, ran into a problem
+    puts $!.message
+    return false
+  end
+
+  true
+end
+
+# example of how to use Zerigo DNS calls
+def show_zerigo_dns_usage
+  
+  begin
+    #create a domain
+    options = { :nx_ttl => 1800 }
+    response = Zerigo[:compute].create_zone( "sample-domain.com", 3600, 'pri_sec', options)
+    if response.status == 201
+      zone_id = response.body['id']
+    end
+
+    #update zone
+    options = { :notes => "domain for client ABC"}
+    response = Zerigo[:compute].update_zone( zone_id, options)
+    if response.status == 200
+      puts "update of zone #{zone_id} worked"
+    end
+    
+    #get details on the zone
+    response = Zerigo[:compute].get_zone( zone_id)
+    if response.status == 200
+      domain = response.body['domain']
+      hosts = response.body['hosts']
+    end
+    
+    #get zone stats    
+    response = Zerigo[:compute].get_zone_stats( zone_id)
+    if response.status == 200
+      queries = response.body['queries']
+    end
+    
+    #list all domains on this accont
+    response= Zerigo[:compute].list_zones()
+    if response.status == 200
+      zone_count = response.headers['X-Query-Count'].to_i
+    end
+   
+    #add an A record to the zone
+    options = { :hostname => 'www' }
+    response = Zerigo[:compute].create_host( zone_id, 'A', '1.2.3.4', options )
+    if response.status == 201
+      host_id = response.body['id']
+    end
+    
+    #add an MX record to the zone
+    options = { :priority => 5 }
+    response = Zerigo[:compute].create_host( zone_id, 'MX', 'mail.sample-domain.com', options)
+    if response.status == 201
+      mail_host_id = response.body['id']
+    end
+    
+    #update the record
+    options = { :priority => 10 }
+    response = Zerigo[:compute].update_host( mail_host_id, options)
+    if response.status == 200
+      #updated priority
+    end
+  
+    #find a specific record
+    response = Zerigo[:compute].find_hosts( "sample-domain.com" )
+    if response.status == 200
+      hosts= response.body['hosts']
+      num_records = hosts.count
+    end
+    
+    #get host record
+    response = Zerigo[:compute].get_host( host_id)
+    if response.status == 200
+      fqdn = response.body['fqdn']
+    end
+    
+    #list hosts
+    response = Zerigo[:compute].list_hosts( zone_id)
+    if response.status == 200
+      hosts = response.body['hosts']
+    end
+    
+    #delete the host record
+    response = Zerigo[:compute].delete_host( host_id)
+    if response.status == 200
+      puts "host record #{host_id} deleted from zone"
+    end
+    
+    #delete the zone we created
+    response = Zerigo[:compute].delete_zone( zone_id)
+    if response.status == 200
+      puts "deleted zone #{zone_id}"
+    end  
+    
+  rescue
+    #opps, ran into a problem
+    puts $!.message
+    return false
+  end
+  
+end
+
+######################################
+
+# make sure Fog credentials file has been setup 
+# (will throw exception if not)
+Fog::credentials
+
+# AWS Route 53
+if RUN_AWS_SAMPLE and Fog::credentials[:aws_access_key_id] and Fog::credentials[:aws_secret_access_key]
+  show_aws_dns_usage
+end
+
+# Linode
+if RUN_LINODE_SAMPLE and Fog::credentials[:linode_api_key]
+  show_linode_dns_usage
+end
+
+# Slicehost
+if RUN_SLICEHOST_SAMPLE and Fog::credentials[:slicehost_password]
+  show_slicehost_dns_usage
+end
+
+if RUN_ZERIGO_SAMPLE and Fog::credentials[:zerigo_email] and Fog::credentials[:zerigo_password]
+  show_zerigo_dns_usage
+end