linode 0.6.2 → 0.6.3

data/{spec/spec.opts → .rspec}

@@ -1,6 +1,4 @@
 --format
 s
 --colour
---loadby
-mtime
 --backtrace

data/CHANGELOG

@@ -1,2 +1,80 @@
 
- * 2009/08/04 - Initial commit.
+0.6.3 / 2010-11-23 
+==================
+  * Can now initialize w/ username/pass; also support for user.getapikey API call
+
+2010-11-21	Rick Bradley <rick@rickbradley.com>
+	* Adding rspec2 support for autotest
+	* Continuing conversion of spec_helper for rspec2
+	* moving spec/spec.opts to /.rspec
+
+2010-11-21	Aaron Hamid <aaron.hamid@gmail.com>
+	* did the minimal amount necessary to get tests to run on latest RSpec release; https://github.com/rick/linode/issues#issue/3
+
+2010-08-03	Rick Bradley <rick@rickbradley.com>
+	* updating gemspec for 0.6.2
+	* Version bump to 0.6.2
+	* remove Jeweler warning as noone else needs to ever see it, basically
+	* make 'rake test' an alias for 'rake spec'
+
+2010-03-31	Rick Bradley <rick@rickbradley.com>
+	* updated gemspec
+	* Version bump to 0.6.1
+	* Missed a couple new Linode API stackscript bits.
+
+2010-03-27	Rick Bradley <rick@rickbradley.com>
+	* Merge branch 'newgem'
+	* updating gemspec
+	* Regenerated gemspec for version 0.6.0
+	* Version bump to 0.6.0
+	* adding support for stackscript API
+
+2009-12-21	Rick Bradley <rick@rickbradley.com>
+	* updating README (thx dvyjones!)
+
+2009-12-20	Rick Bradley <rick@rickbradley.com>
+	* updated gemspec
+	* Version bump to 0.5.4
+	* enabling GemCutter support for our gem
+
+2009-08-05	Rick Bradley <rick@rickbradley.com>
+	* new gemspec
+	* Version bump to 0.5.3
+	* make error messages much more helpful, including link to relevant API page.
+	* fixing mis-named spec example descriptions for nested namespaces
+	* updating gemspec
+	* Version bump to 0.5.2
+	* tiny tweak to use has_namespace instead of an old literal method declaration
+	* updating gemspec
+	* Version bump to 0.5.1
+	* making sure rake actually runs specs; adding httparty gem dependency
+	* Version bump to 0.5.0
+	* adding Jeweler recipe, gemspec, etc.
+	* README now has examples.
+	* Linode.Ip API
+	* Linode.Job API
+	* Linode.Disk API
+	* Linode.Config API
+	* the Linode
+	* more metaprogramming, now that we know how a namespace behaves
+	* Domain.Resource nested API
+	* cleaning up missed example description change
+	* metprogramming avail, user, test APIs
+	* adding domain spec; using domain spec to introduce has_method metaprogramming
+	* adding User API
+	* making the data -> object(s) conversion more robust
+	* Avail API specs and methods
+	* metaprogramming the Test API specs, for later use in other specs
+	* first working version of a simple request (test.echo)
+	* adding httparty dependency to README
+
+2009-08-04	Rick Bradley <rick@rickbradley.com>
+	* set real API URL, allow overriding
+	* Adding basic request method to base class.
+	* trivial testing dependencies in README
+	* add Avail API hook, reorganize how subclass specs are stored
+	* nest namespace classes, automate discovery
+	* making a way to access our simplest API (Linode.test)
+	* Linode.new.
+	* initial commit.
+

data/README

@@ -138,3 +138,6 @@ Here is an annoyingly exhaustive IRB session where I play around with the API:
  irb> l.linode.ip.list(:LinodeId => 12446)
  => [#<OpenStruct rdns_name="byggvir.websages.com", ipaddressid=12286, linodeid=12446, ispublic=1, ipaddress="209.123.234.161">, #<OpenStruct rdns_name="li101-51.members.linode.com", ipaddressid=23981, linodeid=12446, ispublic=1, ipaddress="97.107.140.51">]
  irb> ^D@ Wed Aug 05 01:50:52 rick@Yer-Moms-Computer
+
+CREDITS:
+ - Thanks to Aaron Hamid for updates for RSpec 2 and work on user.getapikey + username/password initialization.

data/Rakefile

@@ -1,14 +1,14 @@
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 
 desc 'Default: run specs.'
 task :default => :spec
 
 desc 'Test the linode library.'
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*_spec.rb'
 end
 
 desc 'Test the linode library.'

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.3

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/linode.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 require 'httparty'
 
 class Linode
-  attr_reader :api_key
+  attr_reader :username, :password
   
   def self.has_method(*actions)
     actions.each do |action|
@@ -30,31 +30,53 @@ class Linode
   has_namespace :test, :avail, :user, :domain, :linode
   
   def initialize(args)
-    raise ArgumentError, ":api_key is required" unless args[:api_key]
-    @api_key = args[:api_key]
     @api_url = args[:api_url] if args[:api_url]
+    
+    if args.include?(:api_key)
+      @api_key = args[:api_key]
+    elsif args.include?(:username) and args.include?(:password)
+      @username = args[:username]
+      @password = args[:password]
+    else
+      raise ArgumentError, "Either :api_key, or both :username and :password, are required."
+    end
   end
     
   def api_url
     @api_url || 'https://api.linode.com/'
   end
 
+  def api_key
+    @api_key ||= fetch_api_key
+  end
+  
   def send_request(action, data)
     data.delete_if {|k,v| [:api_key, :api_action, :api_responseFormat].include?(k) }
-    result = Crack::JSON.parse(HTTParty.get(api_url, :query => { :api_key => api_key, :api_action => action, :api_responseFormat => 'json' }.merge(data)))
-    raise "Errors completing request [#{action}] @ [#{api_url}] with data [#{data.inspect}]:\n#{error_message(result, action)}" if error?(result)
-    reformat_response(result)
+    response = get({ :api_key => api_key, :api_action => action, :api_responseFormat => 'json' }.merge(data))
+    raise "Errors completing request [#{action}] @ [#{api_url}] with data [#{data.inspect}]:\n#{error_message(response, action)}" if error?(response)
+    reformat_response(response)
   end
  
   protected
   
+  def fetch_api_key
+    response = get(:api_action => 'user.getapikey', :api_responseFormat => 'json', :username => username, :password => password)
+    raise "Errors completing request [user.getapikey] @ [#{api_url}] for username [#{username}]:\n#{error_message(response, 'user.getapikey')}" if error?(response)
+    reformat_response(response).api_key
+  end
+  
+  def get(data)
+    Crack::JSON.parse(HTTParty.get(api_url, :query => data))
+  end
+  
   def error?(response)
     response and response["ERRORARRAY"] and ! response["ERRORARRAY"].empty?
   end
   
   def error_message(response, action)
     response["ERRORARRAY"].collect { |err|
-      "  - Error \##{err["ERRORCODE"]} - #{err["ERRORMESSAGE"]}.  (Please consult http://www.linode.com/api/autodoc.cfm?method=#{action})"
+      "  - Error \##{err["ERRORCODE"]} - #{err["ERRORMESSAGE"]}.  "+
+      "(Please consult http://www.linode.com/api/autodoc.cfm?method=#{action})"
     }.join("\n")
   end
   

data/lib/linode/user.rb

@@ -1,3 +1,5 @@
 class Linode::User < Linode
-  has_method :getapikey
+  def getapikey
+    api_key
+  end
 end

data/linode.gemspec

@@ -1,74 +1,73 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{linode}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rick Bradley"]
-  s.date = %q{2010-08-03}
+  s.date = %q{2010-11-23}
   s.description = %q{This is a wrapper around Linode's automation facilities.}
   s.email = %q{rick@rickbradley.com}
   s.extra_rdoc_files = [
     "README"
   ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG",
-     "MIT-LICENSE",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "lib/linode.rb",
-     "lib/linode/avail.rb",
-     "lib/linode/domain.rb",
-     "lib/linode/domain/resource.rb",
-     "lib/linode/linode.rb",
-     "lib/linode/linode/config.rb",
-     "lib/linode/linode/disk.rb",
-     "lib/linode/linode/ip.rb",
-     "lib/linode/linode/job.rb",
-     "lib/linode/stackscript.rb",
-     "lib/linode/test.rb",
-     "lib/linode/user.rb",
-     "linode.gemspec",
-     "spec/linode/avail_spec.rb",
-     "spec/linode/domain/resource_spec.rb",
-     "spec/linode/domain_spec.rb",
-     "spec/linode/linode/config_spec.rb",
-     "spec/linode/linode/disk_spec.rb",
-     "spec/linode/linode/ip_spec.rb",
-     "spec/linode/linode/job_spec.rb",
-     "spec/linode/linode_spec.rb",
-     "spec/linode/stackscript_spec.rb",
-     "spec/linode/test_spec.rb",
-     "spec/linode/user_spec.rb",
-     "spec/linode_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    ".rspec",
+    "CHANGELOG",
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "autotest/discover.rb",
+    "lib/linode.rb",
+    "lib/linode/avail.rb",
+    "lib/linode/domain.rb",
+    "lib/linode/domain/resource.rb",
+    "lib/linode/linode.rb",
+    "lib/linode/linode/config.rb",
+    "lib/linode/linode/disk.rb",
+    "lib/linode/linode/ip.rb",
+    "lib/linode/linode/job.rb",
+    "lib/linode/stackscript.rb",
+    "lib/linode/test.rb",
+    "lib/linode/user.rb",
+    "linode.gemspec",
+    "spec/linode/avail_spec.rb",
+    "spec/linode/domain/resource_spec.rb",
+    "spec/linode/domain_spec.rb",
+    "spec/linode/linode/config_spec.rb",
+    "spec/linode/linode/disk_spec.rb",
+    "spec/linode/linode/ip_spec.rb",
+    "spec/linode/linode/job_spec.rb",
+    "spec/linode/linode_spec.rb",
+    "spec/linode/stackscript_spec.rb",
+    "spec/linode/test_spec.rb",
+    "spec/linode/user_spec.rb",
+    "spec/linode_spec.rb",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/rick/linode}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{a Ruby wrapper for the Linode API}
   s.test_files = [
     "spec/linode/avail_spec.rb",
-     "spec/linode/domain/resource_spec.rb",
-     "spec/linode/domain_spec.rb",
-     "spec/linode/linode/config_spec.rb",
-     "spec/linode/linode/disk_spec.rb",
-     "spec/linode/linode/ip_spec.rb",
-     "spec/linode/linode/job_spec.rb",
-     "spec/linode/linode_spec.rb",
-     "spec/linode/stackscript_spec.rb",
-     "spec/linode/test_spec.rb",
-     "spec/linode/user_spec.rb",
-     "spec/linode_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/linode/domain/resource_spec.rb",
+    "spec/linode/domain_spec.rb",
+    "spec/linode/linode/config_spec.rb",
+    "spec/linode/linode/disk_spec.rb",
+    "spec/linode/linode/ip_spec.rb",
+    "spec/linode/linode/job_spec.rb",
+    "spec/linode/linode_spec.rb",
+    "spec/linode/stackscript_spec.rb",
+    "spec/linode/test_spec.rb",
+    "spec/linode/user_spec.rb",
+    "spec/linode_spec.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/linode/user_spec.rb

@@ -11,35 +11,22 @@ describe Linode::User do
     @linode.class.should < Linode
   end
   
-  %w(getapikey).each do |action|
-    it "should allow accessing the #{action} API" do
-      @linode.should respond_to(action.to_sym)
-    end
+  it 'should be able to return the API key for the connection' do
+    @linode.should respond_to(:getapikey)
+  end
   
-    describe "when accessing the #{action} API" do
-      it 'should allow a data hash' do
-        lambda { @linode.send(action.to_sym, {}) }.should_not raise_error(ArgumentError)
-      end
-    
-      it 'should not require arguments' do
-        lambda { @linode.send(action.to_sym) }.should_not raise_error(ArgumentError)      
-      end
-    
-      it "should request the user.#{action} action" do
-        @linode.expects(:send_request).with {|api_action, data| api_action == "user.#{action}" }
-        @linode.send(action.to_sym)
-      end
+  describe 'when returning the API key for the connection' do
+    it 'should work without arguments' do
+      lambda { @linode.getapikey }.should_not raise_error(ArgumentError)
+    end
     
-      it 'should provide the data hash when making its request' do
-        @linode.expects(:send_request).with {|api_action, data| data = { :foo => :bar } }
-        @linode.send(action.to_sym, {:foo => :bar})
-      end
+    it 'should not allow arguments' do
+      lambda { @linode.getapikey(:foo) }.should raise_error(ArgumentError)      
+    end
     
-      it 'should return the result of the request' do
-        @linode.expects(:send_request).returns(:bar => :baz)      
-        @linode.send(action.to_sym).should == { :bar => :baz }      
-      end
+    it 'should return the api_key via the Linode handle' do
+      @linode.stubs(:api_key).returns('foo')
+      @linode.getapikey.should == 'foo'
     end
   end
-  
 end

data/spec/linode_spec.rb

@@ -15,8 +15,16 @@ describe Linode do
       it 'should require an arguments hash' do
         lambda { Linode.new }.should raise_error(ArgumentError)
       end
-
-      it 'should fail if no API key is given' do
+      
+      it 'should not fail if an API key is given' do
+        lambda { Linode.new({ :api_key => 'foo' }) }.should_not raise_error(ArgumentError)        
+      end
+      
+      it 'should not fail if a username/password combo is given' do
+        lambda { Linode.new({ :username => 'bar', :password => 'baz' }) }.should_not raise_error(ArgumentError)        
+      end
+      
+      it 'should fail if no API key nor username/password combo is given' do
         lambda { Linode.new({}) }.should raise_error(ArgumentError)        
       end
       
@@ -31,26 +39,89 @@ describe 'Linode' do
   before :each do
     @api_key = 'foo'
     @api_url = 'https://fake.linode.com/'
+    @username = 'bar'
+    @password = 'baz'
     @linode = Linode.new(:api_key => @api_key, :api_url => @api_url)
   end
   
-  it 'should be able to return the API key provided at creation time' do
-    @linode.api_key.should == 'foo'
-  end
-  
-  it 'should be able to return the current API URL' do
-    @linode.should respond_to(:api_url)
+  describe 'when initialized with username and password' do
+    before :each do
+      @linode = Linode.new(:username => @username, :password => @password, :api_url => @api_url)
+    end
+    
+    it 'should be able to return the username provided at creation time' do
+      @linode.username.should == 'bar'      
+    end
+
+    it 'should be able to return the password provided at creation time' do
+      @linode.password.should == 'baz'
+    end
+
+    describe 'when returning the current API URL' do
+      it 'should return the API URL provided at creation time if one was provided' do
+        @linode.api_url.should == 'https://fake.linode.com/'
+      end
+
+      it 'should return the stock linode API URL if none was provided at creation time' do
+        @linode = Linode.new(:username => @username, :password => @api_url)
+        @linode.api_url.should == 'https://api.linode.com/'      
+      end
+    end
+
+    it 'should use the user.getapikey remote call to look up the API key associated with the username/password combo specified at creation time' do
+      @json = '{"ERRORARRAY":[],"DATA":{"USERNAME":"ogc","API_KEY":"blahblahblah"},"ACTION":"user.getapikey"}'
+      HTTParty.expects(:get).with(@api_url, 
+        :query => { 
+          :api_action => 'user.getapikey', 
+          :api_responseFormat => 'json', 
+          :username => @username, 
+          :password => @password 
+        }
+      ).returns(@json)
+      @linode.api_key
+    end
+
+    it 'should return the API key associated with the username/password combo specified at creation time' do
+      @linode.stubs(:fetch_api_key).returns(@api_key)
+      @linode.api_key.should == @api_key
+    end
+    
+    it 'should fail when looking up the API key if API key remote lookup fails' do
+      @linode.stubs(:fetch_api_key).raises
+      lambda { @linode.api_key }.should raise_error
+    end
+    
+    it 'should cache API key remote lookups for later use' do
+      @linode.stubs(:fetch_api_key).returns(@api_key)
+      @linode.api_key
+      @linode.stubs(:fetch_api_key).raises
+      @linode.api_key.should == @api_key
+    end
   end
   
-  describe 'when returning the current API URL' do
-    it 'should return the API URL provided at creation time if one was provided' do
-      @linode = Linode.new(:api_key => @api_key, :api_url => 'https://fake.linode.com/')
-      @linode.api_url.should == 'https://fake.linode.com/'
+  describe 'when initialized with API key' do
+    it 'should return a nil username' do
+      @linode.username.should be_nil
+    end
+    
+    it 'should return a nil password' do
+      @linode.password.should be_nil
     end
     
-    it 'should return the stock linode API URL if none was provided at creation time' do
-      @linode = Linode.new(:api_key => @api_key)
-      @linode.api_url.should == 'https://api.linode.com/'      
+    it 'should be able to return the API key provided at creation time' do
+      @linode.api_key.should == 'foo'
+    end
+
+    describe 'when returning the current API URL' do
+      it 'should return the API URL provided at creation time if one was provided' do
+        @linode = Linode.new(:api_key => @api_key, :api_url => 'https://fake.linode.com/')
+        @linode.api_url.should == 'https://fake.linode.com/'
+      end
+
+      it 'should return the stock linode API URL if none was provided at creation time' do
+        @linode = Linode.new(:api_key => @api_key)
+        @linode.api_url.should == 'https://api.linode.com/'      
+      end
     end
   end
   

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
 # this is my favorite way to require ever
 begin
-  require 'spec'
+  require 'rspec'
 rescue LoadError
   require 'rubygems'
   gem 'rspec'
-  require 'spec'
+  require 'rspec'
 end
 
 begin
@@ -15,7 +15,7 @@ rescue LoadError
   require 'mocha'
 end
 
-Spec::Runner.configure do |config|
+Rspec.configure do |config|
   config.mock_with :mocha
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: linode
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 6
-  - 2
-  version: 0.6.2
+  - 3
+  version: 0.6.3
 platform: ruby
 authors: 
 - Rick Bradley
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 -05:00
+date: 2010-11-23 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,12 +43,13 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
-- .gitignore
+- .rspec
 - CHANGELOG
 - MIT-LICENSE
 - README
 - Rakefile
 - VERSION
+- autotest/discover.rb
 - lib/linode.rb
 - lib/linode/avail.rb
 - lib/linode/domain.rb
@@ -74,15 +75,14 @@ files:
 - spec/linode/test_spec.rb
 - spec/linode/user_spec.rb
 - spec/linode_spec.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/rick/linode
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,2 +0,0 @@
-coverage/
-pkg/