fog 1.7.0 → 1.8.0

data/.gitignore

@@ -6,17 +6,17 @@
 .bundle
 .DS_Store
 .idea
+.yardoc
 /tests/.fog
 bin/*
 !bin/fog
-!bin/rdoc
 .fog
 coverage
 doc/*
 docs/_site/*
 docs/about/supported_services.markdown
 Gemfile.lock
-rdoc
+yardoc
 pkg
 spec/credentials.yml
 vendor/*

data/README.md

@@ -1,12 +1,13 @@
 ![fog](http://geemus.s3.amazonaws.com/fog.png)
 
-fog is the Ruby cloud computing library, top to bottom:
+fog is the Ruby cloud services 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.
 
 [![Build Status](https://secure.travis-ci.org/fog/fog.png?branch=master)](http://travis-ci.org/fog/fog)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/fog/fog)
 
 ## Getting Started
 
@@ -112,23 +113,21 @@ geemus says: "That should give you everything you need to get started, but let m
 
 ## Contributing
 
-* Find something you would like to work on. For suggestions look for the `easy`, `medium` and `hard` tags in the [issues](https://github.com/fog/fog/issues)
+* Find something you would like to work on.
+  * Look for anything you can help with in the [issue tracker](https://github.com/fog/fog/issues).
+  * Look at the [code quality metrics](https://codeclimate.com/github/fog/fog) for anything you can help clean up.
+  * Or anything else!
 * Fork the project and do your work in a topic branch.
-* Add a config at `~/.fog` for the component you want to test.
+  * Make sure your changes will work on both Ruby 1.8.7 and Ruby 1.9
+* Add a config at `tests/.fog` for the component you want to test.
 * Add shindo tests to prove your code works and run all the tests using `bundle exec rake`.
-* Rebase your branch against fog/fog to make sure everything is up to date.
+* Rebase your branch against `fog/fog` to make sure everything is up to date.
 * Commit your changes and send a pull request.
 
 ## Additional Resources
 
 [fog.io](http://fog.io)
 
-## Sponsorship
-
-![Engine Yard](http://www.engineyard.com/images/logo.png)
-
-All new work on fog is sponsored by [Engine Yard](http://engineyard.com)
-
 ## Copyright
 
 (The MIT License)

data/Rakefile

@@ -1,8 +1,8 @@
 require 'bundler/setup'
 require 'date'
 require 'rubygems'
-require 'rdoc/task'
 require 'rubygems/package_task'
+require 'yard'
 require File.dirname(__FILE__) + '/lib/fog'
 
 #############################################################################
@@ -16,8 +16,7 @@ def name
 end
 
 def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+  Fog::VERSION
 end
 
 def date
@@ -49,6 +48,9 @@ end
 GEM_NAME = "#{name}"
 task :default => :test
 
+require "tasks/test_task"
+Fog::Rake::TestTask.new
+
 namespace :test do
   task :dynect do
     [false].each do |mock|
@@ -58,39 +60,6 @@ namespace :test do
   end
 end
 
-task :test do
-  Rake::Task[:mock_tests].invoke
-end
-
-def tests(mocked)
-  Formatador.display_line
-  start = Time.now.to_i
-  threads = []
-  Thread.main[:results] = []
-  Fog.providers.each do |key, value|
-    threads << Thread.new do
-      Thread.main[:results] << {
-        :provider => value,
-        :success  => sh("export FOG_MOCK=#{mocked} && bundle exec shindont +#{key}")
-      }
-    end
-  end
-  threads.each do |thread|
-    thread.join
-  end
-  Formatador.display_table(Thread.main[:results].sort {|x,y| x[:provider] <=> y[:provider]})
-  Formatador.display_line("[bold]FOG_MOCK=#{mocked}[/] tests completed in [bold]#{Time.now.to_i - start}[/] seconds")
-  Formatador.display_line
-end
-
-task :mock_tests do
-  tests(true)
-end
-
-task :real_tests do
-  tests(false)
-end
-
 task :nuke do
   Fog.providers.each do |provider|
     next if ['Vmfusion'].include?(provider)
@@ -116,14 +85,6 @@ task :nuke do
   end
 end
 
-require 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "#{name} #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -r ./lib/#{name}.rb"
@@ -171,7 +132,7 @@ task :gemspec => :validate do
 end
 
 task :validate do
-  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}", "lib/tasks"]
   unless libfiles.empty?
     puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
     exit!
@@ -182,261 +143,16 @@ task :validate do
   end
 end
 
-task :changelog do
-  timestamp = Time.now.utc.strftime('%m/%d/%Y')
-  sha = `git log | head -1`.split(' ').last
-  changelog = ["#{version} #{timestamp} #{sha}"]
-  changelog << ('=' * changelog[0].length)
-  changelog << ''
-
-  require 'multi_json'
-  github_repo_data = Fog::JSON.decode(Excon.get('https://api.github.com/repos/fog/fog').body)
-  data = github_repo_data.reject {|key, value| !['forks', 'open_issues', 'watchers'].include?(key)}
-  github_collaborator_data = Fog::JSON.decode(Excon.get('https://api.github.com/repos/fog/fog/collaborators').body)
-  data['collaborators'] = github_collaborator_data.length
-  rubygems_data = Fog::JSON.decode(Excon.get('https://rubygems.org/api/v1/gems/fog.json').body)
-  data['downloads'] = rubygems_data['downloads']
-  stats = []
-  for key in data.keys.sort
-    stats << "'#{key}' => #{data[key]}"
-  end
-  changelog << "Stats! { #{stats.join(', ')} }"
-  changelog << ''
-
-  last_sha = `cat changelog.txt | head -1`.split(' ').last
-  shortlog = `git shortlog #{last_sha}..HEAD`
-  changes = {}
-  committers = {}
-  for line in shortlog.split("\n")
-    if line =~ /^\S/
-      committer = line.split(' (', 2).first
-      committers[committer] = 0
-    elsif line =~ /^\s*((Merge.*)|(Release.*))?$/
-      # skip empty lines, Merge and Release commits
-    else
-      unless line[-1..-1] == '.'
-        line << '.'
-      end
-      line.lstrip!
-      line.gsub!(/^\[([^\]]*)\] /, '')
-      tag = $1 || 'misc'
-      changes[tag] ||= []
-      changes[tag] << (line << ' thanks ' << committer)
-      committers[committer] += 1
-    end
-  end
-
-  for committer, commits in committers.to_a.sort {|x,y| y[1] <=> x[1]}
-    if [
-        'Aaron Suggs',
-        'Brian Hartsock',
-        'Christopher Oliver',
-        'Decklin Foster',
-        'Dylan Egan',
-        'geemus',
-        'Henry Addison',
-        'Kevin Menard',
-        'Lincoln Stoll',
-        'Luqman Amjad',
-        'Michael Zeng',
-        'Nick Osborn',
-        'nightshade427',
-        'Patrick Debois',
-        'Stepan G. Fedorov',
-        'Wesley Beary'
-      ].include?(committer)
-      next
-    end
-    changelog << "MVP! #{committer}"
-    changelog << ''
-    break
-  end
-
-  for tag in changes.keys.sort
-    changelog << ('[' << tag << ']')
-    for commit in changes[tag]
-      changelog << ('  ' << commit)
-    end
-    changelog << ''
-  end
-
-  old_changelog = File.read('changelog.txt')
-  File.open('changelog.txt', 'w') do |file|
-    file.write(changelog.join("\n"))
-    file.write("\n\n")
-    file.write(old_changelog)
-  end
+# Include Yard tasks for rake yard
+YARDOC_LOCATION = "doc"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', "README"]
+  t.options = ["--output-dir", YARDOC_LOCATION, "--title", "#{name} #{version}"]
 end
 
-task :docs do
-  Rake::Task[:supported_services_docs].invoke
-  Rake::Task[:upload_fog_io].invoke
-  Rake::Task[:upload_rdoc].invoke
-
-  # connect to storage provider
-  Fog.credential = :geemus
-  storage = Fog::Storage.new(:provider => 'AWS')
-  directory = storage.directories.new(:key => 'fog.io')
-  # write base index with redirect to new version
-  directory.files.create(
-    :body         => redirecter('latest'),
-    :content_type => 'text/html',
-    :key          => 'index.html',
-    :public       => true
-  )
+require "tasks/changelog_task"
+Fog::Rake::ChangelogTask.new
 
-  Formatador.display_line
-end
+require "tasks/documentation_task"
+Fog::Rake::DocumentationTask.new
 
-task :supported_services_docs do
-  support, shared = {}, []
-  for key, values in Fog.services
-    unless values.length == 1
-      shared |= [key]
-      values.each do |value|
-        support[value] ||= {}
-        support[value][key] = '+'
-      end
-    else
-      value = values.first
-      support[value] ||= {}
-      support[value][:other] ||= []
-      support[value][:other] << key
-    end
-  end
-  shared.sort! {|x,y| x.to_s <=> y.to_s}
-  columns = [:provider] + shared + [:other]
-  data = []
-  for key in support.keys.sort {|x,y| x.to_s <=> y.to_s}
-    data << { :provider => key }.merge!(support[key])
-  end
-
-  table = ''
-  table << "<table border='1'>\n"
-
-  table << "  <tr>"
-  for column in columns
-    table << "<th>#{column}</th>"
-  end
-  table << "</tr>\n"
-
-  for datum in data
-    table << "  <tr>"
-    for column in columns
-      if value = datum[column]
-        case value
-        when Array
-          table << "<td>#{value.join(', ')}</td>"
-        when '+'
-          table << "<td style='text-align: center;'>#{value}</td>"
-        else
-          table << "<th>#{value}</th>"
-        end
-      else
-        table << "<td></td>"
-      end
-    end
-    table << "</tr>\n"
-  end
-
-  table << "</table>\n"
-
-  File.open('docs/about/supported_services.markdown', 'w') do |file|
-    file.puts <<-METADATA
----
-layout: default
-title:  Supported Services
----
-
-METADATA
-    file.puts(table)
-  end
-end
-
-task :upload_fog_io do
-  # connect to storage provider
-  Fog.credential = :geemus
-  storage = Fog::Storage.new(:provider => 'AWS')
-  directory = storage.directories.new(:key => 'fog.io')
-
-  # build the docs locally
-  sh "jekyll docs docs/_site"
-
-  # write web page files to versioned 'folder'
-  for file_path in Dir.glob('docs/_site/**/*')
-    next if File.directory?(file_path)
-    file_name = file_path.gsub('docs/_site/', '')
-    key = '' << version << '/' << file_name
-    Formatador.redisplay(' ' * 128)
-    Formatador.redisplay("Uploading [bold]#{key}[/]")
-    if File.extname(file_name) == '.html'
-      # rewrite links with version
-      body = File.read(file_path)
-      body.gsub!(/vX.Y.Z/, 'v' << version)
-      body.gsub!(/='\//, %{='/} << version << '/')
-      body.gsub!(/="\//, %{="/} << version << '/')
-      content_type = 'text/html'
-      directory.files.create(
-        :body         => redirecter(key),
-        :content_type => 'text/html',
-        :key          => 'latest/' << file_name,
-        :public       => true
-      )
-    else
-      body = File.open(file_path)
-      content_type = nil # leave it up to mime-types
-    end
-    directory.files.create(
-      :body         => body,
-      :content_type => content_type,
-      :key          => key,
-      :public       => true
-    )
-  end
-  Formatador.redisplay(' ' * 128)
-  Formatador.redisplay("Uploaded docs/_site\n")
-end
-
-task :upload_rdoc do
-  # connect to storage provider
-  Fog.credential = :geemus
-  storage = Fog::Storage.new(:provider => 'AWS')
-  directory = storage.directories.new(:key => 'fog.io')
-
-  # write rdoc files to versioned 'folder'
-  Rake::Task[:rdoc].invoke
-  for file_path in Dir.glob('rdoc/**/*')
-    next if File.directory?(file_path)
-    file_name = file_path.gsub('rdoc/', '')
-    key = '' << version << '/rdoc/' << file_name
-    Formatador.redisplay(' ' * 128)
-    Formatador.redisplay("Uploading [bold]#{key}[/]")
-    directory.files.create(
-      :body         => File.open(file_path),
-      :key          => key,
-      :public       => true
-    )
-  end
-  Formatador.redisplay(' ' * 128)
-  directory.files.create(
-    :body         => redirecter("#{version}/rdoc/index.html"),
-    :content_type => 'text/html',
-    :key          => 'latest/rdoc/index.html',
-    :public       => true
-  )
-  Formatador.redisplay("Uploaded rdoc\n")
-end
-
-def redirecter(path)
-  redirecter = <<-HTML
-<!doctype html>
-<head>
-<title>fog</title>
-<meta http-equiv="REFRESH" content="0;url=http://fog.io/#{path}">
-</head>
-<body>
-  <a href="http://fog.io/#{path}">redirecting to lastest (#{path})</a>
-</body>
-</html>
-HTML
-end

data/changelog.txt

@@ -1,3 +1,156 @@
+1.8.0 12/01/2012 057c0c525a39e77cb2037c9fec3d851b209c151b
+=========================================================
+
+Stats! { 'collaborators' => 41, 'downloads' => 1334733, 'forks' => 630, 'open_issues' => 98, 'watchers' => 2258 }
+
+[AWS]
+  Adds ModifyVolumeAttribute. thanks Eric Stonfer
+
+[Brightbox]
+  Removes incorrect yard tag. thanks Paul Thornthwaite
+  Updates request docs to use Yard. thanks Paul Thornthwaite
+  Adds baseline documentation. thanks Paul Thornthwaite
+  Documents #request method. thanks Paul Thornthwaite
+  Comments out rogue text. thanks Paul Thornthwaite
+  Fixes generated files EOF with newlines. thanks Paul Thornthwaite
+  Adds Servers#bootstrap. thanks Paul Thornthwaite
+  Adds way to check auth method. thanks Paul Thornthwaite
+  Adds reset FTP for scoped accounts. thanks Paul Thornthwaite
+  Fixes Compute#account to pass service. thanks Paul Thornthwaite
+  Fixes Account#reset_ftp_password. thanks Paul Thornthwaite
+  Fixes test to run out of sequence. thanks Paul Thornthwaite
+  Expands documentation for Compute class. thanks Paul Thornthwaite
+  Tests recognised options. thanks Paul Thornthwaite
+  Refactors credential code in Compute. thanks Paul Thornthwaite
+  Extracts authentication connection. thanks Paul Thornthwaite
+  Refactors how tokens are requested. thanks Paul Thornthwaite
+  Moves tokens to CredentialSet. thanks Paul Thornthwaite
+  Extracts parts of request out of compute. thanks Paul Thornthwaite
+  Adds support for refresh tokens. thanks Paul Thornthwaite
+  Adds option to disable token management. thanks Paul Thornthwaite
+  Adds means to update scoped account. thanks Paul Thornthwaite
+  Moves more of public API into Shared. thanks Paul Thornthwaite
+  Guards unimplemented mock tests. thanks Paul Thornthwaite
+
+[Docs]
+  Switches to using Yard for documentation. thanks Paul Thornthwaite
+
+[aws]
+  fixed auto scaling model group 'destroy' method where it needs to use merge! instead of merge to set the opts local variable in place,  otherwise the options passed to the method are droppedon the floor. thanks Jay Perry
+
+[aws|compute]
+  add offeringType to output from describe_reserved_instances_offerings. thanks geemus
+  fix mocks/tests around describe_reserved_instances_offerings. thanks geemus
+  fix one more offeringType mock format test failure. thanks geemus
+
+[aws|dynamodb]
+  port off of sts for credentials, now uses signature v4. thanks geemus
+
+[aws|storage]
+  Add Fog::Storage::AWS#delete_multiple_objects. thanks Garret Alfert
+  Add mock for Fog::Storage::AWS#delete_multiple_objects. thanks Garret Alfert
+  Little improvements to delete_multiple_objects tests. thanks Garret Alfert
+  Add Fog::Storage::AWS#delete_multiple_objects. thanks Garret Alfert
+  Add mock for Fog::Storage::AWS#delete_multiple_objects. thanks Garret Alfert
+  Little improvements to delete_multiple_objects tests. thanks Garret Alfert
+
+[core]
+  Adds fog User-Agent header. thanks Paul Thornthwaite
+  Splits Fog::VERSION into own file. thanks Paul Thornthwaite
+  Adds fog User-Agent header. thanks Paul Thornthwaite
+  Updates Rakefile to use Fog::VERSION. thanks Paul Thornthwaite
+
+[dns]
+  Add more record tests. thanks Brian Hartsock
+
+[docs]
+  Updates link on fog.io to point to doc. thanks Paul Thornthwaite
+  Updates contributing notes. thanks Paul Thornthwaite
+  Replaces link to API to `rubydoc.info`. thanks Paul Thornthwaite
+  Adds 1.8.7 note to fog.io collaborators guide. thanks Paul Thornthwaite
+
+[misc]
+  Add support for AWS Australia (ap-southeast-2). thanks Amy Woodward
+  Add Hosted Zone ID for ap-southeast-2. thanks Amy Woodward
+  Do not add empty security group. thanks Dan Bode
+  Add attr group. thanks Dan Bode
+  Sync with latest OpenStack flavors extensions. thanks Dan Prince
+  OpenStack floating_ip (aka address) test fixes. thanks Dan Prince
+  OpenStack: Remove volumes from limits tests. thanks Dan Prince
+  OpenStack: updates to quota tests. thanks Dan Prince
+  OpenStack: security group test fixes. thanks Dan Prince
+  add support for Storage::Rackspace::File#access_control_allow_origin and #origin. thanks Dusty Jones
+  add support for Storage::Rackspace::File#access_control_allow_origin and #origin. thanks Dusty Jones
+  Save the file instance before testing for presence of attribute. thanks Dusty Jones
+  Fix describe_instances stateReason handling. thanks Edward Muller
+  added support for Storage::Rackspace::File#metadata. thanks Evan Smith
+  added support for Storage::Rackspace::File#metadata. thanks Evan Smith
+  merged with origin. thanks Evan Smith
+  Rackspace Cloud Files. can load metadata from existing file. can set metadata for new file. can unset metadata for existing file. thanks Evan Smith
+  merged with upstream master. thanks Evan Smith
+  Implemented bootstrap method for Rackspace Compute v2.     Added ability to set "metadata" and "personality" fields when creating a server on Rackspace Compute v2.     Improved response parsing when dealing with Rackspace DNS service. thanks Jesse Scott
+  Removed the commented out password setting line for Rackspace Compute v2 bootstrap method. thanks Jesse Scott
+  Clarified the logic for finding the newly created DNS record for Rackspace Cloud DNS. thanks Jesse Scott
+  fix warning message to follow correct bucket naming guidelines. thanks Michael Elfassy
+  Bucket names cannot begin with the "goog" prefix. Also change for DNS compliant subdomain. thanks Michael Elfassy
+  VMWare vsphere provider refactor. thanks Ohad Levy
+  do not force trailing / on path. thanks Ohad Levy
+  Removes dead link to DNS tests. thanks Paul Thornthwaite
+  Adds link to Code Climate metrics. thanks Paul Thornthwaite
+  Extracts Changelog Rake task to class. thanks Paul Thornthwaite
+  Moves fog.io generation a prerequsite. thanks Paul Thornthwaite
+  Extracts docs rake tasks to a class. thanks Paul Thornthwaite
+  Extracts testing Rake tasks to class. thanks Paul Thornthwaite
+  Moves new Task classes to better location. thanks Paul Thornthwaite
+  Revert "[core] Adds fog User-Agent header". thanks Paul Thornthwaite
+  Inconsistent usage of cpus / vpcus in libvirt / requests.     Reported number of cpus was always 1 for libvirt domains. thanks Romain Vrignaud
+  use CGI.escape when encoding the POST body. thanks Sam Cooper
+  Added versioned delete_multiple_objects support. thanks Timur Alperovich
+  Add support for volume_pool_name. thanks Vincent Demeester
+  fixes issue#1313 ~ Creating user via `Aws.iam.users` ignores `:path`. thanks VirtualStaticVoid
+  revised create logic to default path to '/'. thanks VirtualStaticVoid
+  added test for create logic to default path to '/'. thanks VirtualStaticVoid
+  added support for mock. thanks VirtualStaticVoid
+  revised test order. thanks VirtualStaticVoid
+  README: s/'cloud computing'/'cloud services'. thanks Wesley Beary
+  Adding explicit support for metadata for Rackspace compute_v2. thanks heyryanw
+  removed Fog::AWS[:rds] this was creating issues with was security credentials. thanks mauro catenacci
+  Adding public_ip_address and private_ip_address to Fog::Compute::RackspaceV2::Server. thanks sashap
+  Adding bootstrap and setup for RackspaceV2 servers. thanks sashap
+
+[openstack]
+  Add Accept header with application/json media type to requests. thanks Andrew Donald Kennedy
+  Refactor Openstack Authentication. thanks Nelvin Driz
+  Fix Typo in Merge of Authentication Refactoring. thanks Nelvin Driz
+  Make use of the unscoped token for reauthentication. thanks Philip Mark M. Deazeta
+
+[openstack|compute]
+  Add "Reset Server State" request. thanks Nelvin Driz
+  Add `get_limits` request. thanks Nelvin Driz
+
+[openstack|identity]
+  use tenant_id parameter in users model. thanks Philip Mark M. Deazeta
+  Add `attr_accessor :unscoped_token` to Mock. thanks Philip Mark M. Deazeta
+
+[opnestack|identity]
+  Added set_tenant request for identity service. thanks Philip Mark M. Deazeta
+
+[rackspace|computev2]
+  aded test for bootstrap. thanks Brian Hartsock
+
+[rackspace|dns]
+  fixed tests, merged some formatting to reduce duplication. thanks Brian Hartsock
+
+[rackspace|storage]
+  rackspace files tests should be pending in mocked mode. thanks geemus
+
+[readme]
+  update outdated sponsorship section. thanks geemus
+
+[vsphere]
+  ensure reload works correctly for server. thanks Ohad Levy
+
+
 1.7.0 11/04/2012 aa853488c9d84d849f52cf348787030fbb963163
 =========================================================