linode 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de9411d548f39b5daf2fca55e3fd7ffbad6eba21
-  data.tar.gz: fe8344bce96367b6e9fd3a324a9a9bec6a8d265e
+  metadata.gz: 9a231618cd2673977b0cd51db2a668cc8bc16f33
+  data.tar.gz: 373181a8417e1d7d9cc433bb899cf472395da55c
 SHA512:
-  metadata.gz: f6ef8c7081d9acdc29baa57c67cc2387943872935a19fa6231b8e338d98f264fc2a9c73ab50ed60ea59f5ff1280fa9dba4aeac8c46e1fcb591c3500e5986bc48
-  data.tar.gz: bf0bb76385fb2d1770c255e200304e43b16ba10f8a7a5b2c955baf39b06c5badfd0fa224a8821cd0bb877c8523d90232a46be4567cc365f8d0f92a3aa8273736
+  metadata.gz: 31a2549bb3a7717450268fa62f376e284a3eb977de81b075ef998cb2366abb10ab68d39ad75f6abc838687cd7b467fcea3572a3499dfe74c787391150d5f56e8
+  data.tar.gz: 8fe99fa8ed3b992811411db750a03b725568895c6a82372858e098ff81d0da51a788cfaf70adb9129880e0663c172c6f2957ecf1c53a3dac60d593bd9dd52096

data/.gitignore

@@ -1,3 +1,4 @@
 coverage/
 pkg/
 .rbenv*
+Gemfile.lock

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.9.1 / 2016-08-18
+==================
+  * Removed explicit dependency on JSON gem
+  * Removed Gemfile.lock as this is a library
+  * Made Gemfile rely on gemspec to remove duplication
+  * Updated README to include how to use with older Rubies
+  * Updated README to encourage using Gemfile and Bundler for Installation
+  * Updated README to include a CONTRIBUTE section
 
 0.7.10 / 2012-10-19
 ===================

data/Gemfile

@@ -1,10 +1,3 @@
 source "http://rubygems.org"
 
-group :test do
-  gem "rake", "~>10.0"
-  gem "rspec","~>2.0"
-  gem "mocha", "~>1.0"
-end
-
-gem "httparty", "~>0.0"
-gem "json", "~>1.0"
+gemspec

data/README.md

@@ -1,12 +1,70 @@
 # Linode Ruby API
 
+## NOTICE
+
+Please welcome [Marques Johansson](https://github.com/displague) and [Drew DeVault](https://github.com/sircmpwn), 
+both of Linode, as new maintainers of the ruby Linode API library!
+
 ## INSTALLATION:
 
- Make sure gemcutter.org is in your gem sources list, then:
+The recommended way to use this library is to include `linode` in your Gemfile and use Bundler.
+
+```ruby
+gem 'linode', '~> 0.9.0'
+```
+
+By default, this will also install the latest version of the linode library's dependencies:
+
+* httparty
 
-     % sudo gem install linode
+The latest version of these dependencies requires Ruby >= 1.9.3  
+If for some reason you need to use an older version of Ruby (1.8.7),
+you can include the following dependencies in your Gemfile.
 
- To run tests you will need both rspec and mocha installed.
+```ruby
+gem 'json', '~>1.8'
+gem 'httparty', '0.11'
+```
+
+Running on versions of Ruby older than 1.9.3 is considered deprecated
+and support will not actively be maintained for older versions of Ruby.
+Using this library with EOL versions of Ruby is frowned upon :(
+
+At this point you can use Bundler to install or update your dependencies.
+
+```bash
+bundle install
+```
+
+## CONTRIBUTING
+
+If you would like to submit a bug fix or feature, you can do so with the traditional GitHub workflow.
+
+* Fork this repo
+* Git clone your repo locally
+* `cd` into the repo
+* `bundle install` to get all runtime and development dependencies
+* Make a new branch
+* Submit a PR
+
+### Development
+
+Bug fixes and features should include new tests using the RSpec format.
+Reviewing the current way tests are written is the best way to understand this.
+All tests live under the `spec` folder at the root of the repo.
+
+You can run the tests suite by executing:
+
+```bash
+rake test
+```
+
+Adding new dependencies is highly discouraged!  
+Maintaining compatibility with Ruby 1.9.3 is currently required.
+
+Testing your changes against Ruby 1.9.3 and ~> 2.3 should be enough to ensure compatibilty between all version inclusively.
+
+[RVM](rmv.io) can greatly help with testing different versions of Ruby.
 
 ## RUNNING:
 
@@ -16,7 +74,8 @@ You will need to get an API key (check your account profile).
 Here is an annoyingly exhaustive IRB session where I play around with the API:
 
 ```ruby
-irb> require 'rubygems'
+bundle exec irb
+
 irb> require 'linode'
 irb> api_key = 'TOPSECRETAPIKEY'
 irb> l = Linode.new(:api_key => api_key)

data/Rakefile

@@ -1,12 +1,6 @@
 require 'rubygems'
 require 'rake'
 require 'rake/testtask'
-
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rake/rdoctask'
-end
 require 'rspec/core/rake_task'
 
 desc 'Default: run specs.'

data/VERSION

@@ -1 +1 @@
-0.9.0
+0.9.1

data/lib/linode.rb

@@ -83,14 +83,25 @@ class Linode
     reformat_response(response)
   end
 
-  protected
+  def fetch_api_key(options = {})
+    request = { :api_action => 'user.getapikey', :api_responseFormat => 'json', :username => username, :password => password }
+
+    if options.key?(:label)
+      request[:label] = options[:label]
+    end
 
-  def fetch_api_key
-    response = post(:api_action => 'user.getapikey', :api_responseFormat => 'json', :username => username, :password => password)
+    if options.key?(:expires)
+      expires = options[:expires]
+      request[:expires] = expires.nil? ? 0 : expires
+    end
+
+    response = post(request)
     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
 
+  protected
+
   def post(data)
     logger.info "POST #{api_url.to_s} body:#{data.inspect}" if logger
     HTTParty.post(api_url, :body => data).parsed_response

data/lib/linode/linode.rb

@@ -1,5 +1,5 @@
 class Linode::Linode < Linode
   documentation_category "linode"
   has_namespace :config, :disk, :ip, :job
-  has_method :update, :create, :list, :shutdown, :boot, :delete, :reboot, :clone, :resize
+  has_method :update, :create, :kvmify, :list, :mutate, :shutdown, :boot, :delete, :reboot, :clone, :resize
 end

data/linode.gemspec

@@ -2,8 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "linode"
-  s.version = "0.9.0"
-  s.date = "2016-01-02"
+  s.version = File.open("VERSION", "r").read.strip
   s.description = "This is a wrapper around Linode's automation facilities."
   s.summary = "a Ruby wrapper for the Linode API"
   s.authors = ["Rick Bradley"]
@@ -25,7 +24,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency(%q<httparty>, ["~> 0.0"])
-  s.add_runtime_dependency(%q<json>, ["~> 1.0"])
+  s.add_runtime_dependency "httparty", "~> 0.0"
+
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "mocha", "~> 1.0"
 end
 

data/spec/linode/linode_spec.rb

@@ -11,7 +11,7 @@ describe Linode::Linode do
     @linode.class.should < Linode
   end
 
-  %w(update create list shutdown boot delete reboot clone resize).each do |action|
+  %w(update create kvmify list mutate shutdown boot delete reboot clone resize).each do |action|
     it "should allow accessing the #{action} API" do
       @linode.should respond_to(action.to_sym)
     end

data/spec/linode_spec.rb

@@ -93,6 +93,80 @@ describe 'Linode' do
       @linode.api_key.should == @api_key
     end
 
+    it 'should request the API key only when accessed' do
+      @linode = Linode.new(:username => @username, :password => @api_url)
+      @linode.stubs(:fetch_api_key).returns 'foo'
+      @linode.api_key.should == 'foo'
+    end
+
+    it 'should allow assigning a label to an API key' do
+      @json = '{"ERRORARRAY":[],"DATA":{"USERNAME":"ogc","API_KEY":"blahblahblah"},"ACTION":"user.getapikey"}'
+      @json.stubs(:parsed_response).returns(JSON.parse(@json))
+
+      HTTParty.expects(:post).with(@api_url,
+        :body => {
+          :api_action => 'user.getapikey',
+          :api_responseFormat => 'json',
+          :username => @username,
+          :password => @password,
+          :label => 'foobar'
+        }
+      ).returns(@json)
+
+      @linode.fetch_api_key(:label => 'foobar')
+    end
+
+    it 'should allow assigning expires when requesting an API key' do
+      @json = '{"ERRORARRAY":[],"DATA":{"USERNAME":"ogc","API_KEY":"blahblahblah"},"ACTION":"user.getapikey"}'
+      @json.stubs(:parsed_response).returns(JSON.parse(@json))
+
+      HTTParty.expects(:post).with(@api_url,
+        :body => {
+          :api_action => 'user.getapikey',
+          :api_responseFormat => 'json',
+          :username => @username,
+          :password => @password,
+          :expires => 5
+        }
+      ).returns(@json)
+
+      @linode.fetch_api_key(:expires => 5)
+    end
+
+    it 'should allow use 0 to signify a non-expiring api-key when passed a nil :expires' do
+      @json = '{"ERRORARRAY":[],"DATA":{"USERNAME":"ogc","API_KEY":"blahblahblah"},"ACTION":"user.getapikey"}'
+      @json.stubs(:parsed_response).returns(JSON.parse(@json))
+
+      HTTParty.expects(:post).with(@api_url,
+        :body => {
+          :api_action => 'user.getapikey',
+          :api_responseFormat => 'json',
+          :username => @username,
+          :password => @password,
+          :expires => 0
+        }
+      ).returns(@json)
+
+      @linode.fetch_api_key(:expires => nil)
+    end
+
+    it 'should not specify expires when :expires was not specified' do
+      @json = '{"ERRORARRAY":[],"DATA":{"USERNAME":"ogc","API_KEY":"blahblahblah"},"ACTION":"user.getapikey"}'
+      @json.stubs(:parsed_response).returns(JSON.parse(@json))
+
+      HTTParty.expects(:post).with(@api_url,
+        :body => {
+          :api_action => 'user.getapikey',
+          :api_responseFormat => 'json',
+          :username => @username,
+          :password => @password
+        }
+      ).returns(@json)
+
+      @linode.fetch_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linode
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Rick Bradley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-02 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -25,13 +25,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -49,7 +77,6 @@ files:
 - ".rspec"
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -111,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: a Ruby wrapper for the Linode API

data/Gemfile.lock

@@ -1,31 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    httparty (0.13.1)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.1)
-    metaclass (0.0.4)
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
-    multi_xml (0.5.5)
-    rake (10.3.2)
-    rspec (2.99.0)
-      rspec-core (~> 2.99.0)
-      rspec-expectations (~> 2.99.0)
-      rspec-mocks (~> 2.99.0)
-    rspec-core (2.99.2)
-    rspec-expectations (2.99.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.99.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httparty (~> 0.0)
-  json (~> 1.0)
-  mocha (~> 1.0)
-  rake (~> 10.0)
-  rspec (~> 2.0)