linodeapi 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2b6266cebf4ba879b7b79560958046dcfbeef85
-  data.tar.gz: e4f7be859b3b424d4023d228a2bf465652b27c8d
+  metadata.gz: 386eb467c95101a915f20e0859bf356bb8c765ed
+  data.tar.gz: 45437aba6937cb0e0a03de655948479d5938241d
 SHA512:
-  metadata.gz: 9c0400892e248bf04836685ea695ed2415dd5c38b39fd12f55028685a178d3cc6891ac99c07a6c730b2ada07c19058a86dad965bfc3ad472c19a7cb0df65586c
-  data.tar.gz: a3645671fea6219314385c06f922eb957796460beb4f864a8df72700e2210d306dd699d39c00079791fb7b3546256284d6337b386180b3f2d942642bfe3bd1a6
+  metadata.gz: 18391de6e8204d94eef64f38b28a6f5fba0e0c3f37bb948029237cdeebfbbddcd00df70e107c88450c14e6700f2c1cb9b1c257d968cd5d6b87586dd27cfff1ed
+  data.tar.gz: a01e3df48784a83b12a8cabf96e0608505c825d56a7fd4a81a7ebd330fd41d18a26ec1d7134df3b69a23cc0191c0d37e89f0e5b294c93b3f34e35df9618569f5

data/.circle-ruby

@@ -0,0 +1,3 @@
+2.4.2
+2.3.5
+2.2.8

data/.prospectus

@@ -1,31 +1,25 @@
-require 'yaml'
+Prospectus.extra_dep('file', 'prospectus_circleci')
 
-item do
-  expected do
-    static
-    set 'green'
-  end
+my_slug = 'akerl/linodeapi'
 
-  actual do
-    gemnasium
-    slug 'akerl/linodeapi'
-  end
+item do
+  noop
 
   deps do
-    YAML.load(`./dev/cache_spec.rb --noop`).each do |item_name, (old, new)|
-      item do
-        name "api.spec.#{item_name}"
+    item do
+      name 'gems'
 
-        expected do
-          static
-          set new
-        end
+      expected do
+        static
+        set 'green'
+      end
 
-        actual do
-          static
-          set old
-        end
+      actual do
+        gemnasium
+        slug my_slug
       end
     end
   end
+
+  extend ProspectusCircleci::Build.new(my_slug)
 end

data/.rubocop.yml

@@ -1,2 +1,5 @@
-Encoding:
-    Enabled: false
+inherit_gem:
+  goodcop: .rubocop.yml
+AllCops:
+  Include:
+  - 'dev/*.rb'

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-

data/README.md

@@ -3,7 +3,7 @@ linodeapi
 
 [![Gem Version](https://img.shields.io/gem/v/linodeapi.svg)](https://rubygems.org/gems/linodeapi)
 [![Dependency Status](https://img.shields.io/gemnasium/akerl/linodeapi.svg)](https://gemnasium.com/akerl/linodeapi)
-[![Build Status](https://img.shields.io/circleci/project/akerl/linodeapi.svg)](https://circleci.com/gh/akerl/linodeapi)
+[![Build Status](https://img.shields.io/circleci/project/akerl/linodeapi/master.svg)](https://circleci.com/gh/akerl/linodeapi)
 [![Coverage Status](https://img.shields.io/codecov/c/github/akerl/linodeapi.svg)](https://codecov.io/github/akerl/linodeapi)
 [![Code Quality](https://img.shields.io/codacy/60b77ea8214241b5ac970bcdfd584587.svg)](https://www.codacy.com/app/akerl/linodeapi)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
@@ -54,6 +54,12 @@ api.linode.create
 # ArgumentError: linode.create requires planid
 ```
 
+### Retryable helper
+
+The LinodeAPI::Retryable class automatically handles 429 errors (really, any HTTP error that is accompanied by a Retry-After header).
+
+This class behaves identially to the LinodeAPI::Raw class, with 2 additional parameters at creation: `max_retries` sets the total number of requests it will attempt per call and `max_delay` sets the maximum delay between attempts. They default to 3 tries and 60 seconds, respectively.
+
 ## Installation
 
     gem install linodeapi

data/Rakefile

@@ -7,8 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run Rubocop on the gem'
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'dev/*.rb']
   task.fail_on_error = true
 end
 
-task default: [:spec, :rubocop, :build, :install]
+task default: %i[spec rubocop build install]

data/circle.yml

@@ -1,12 +1,7 @@
 dependencies:
   override:
-    - 'rvm-exec 1.9.3-p551 bundle install'
-    - 'rvm-exec 2.0.0-p645 bundle install'
-    - 'rvm-exec 2.1.6 bundle install'
-    - 'rvm-exec 2.2.2 bundle install'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i gem update --system --no-doc || exit 1 ; done'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done'
 test:
   override:
-    - 'rvm-exec 1.9.3-p551 bundle exec rake'
-    - 'rvm-exec 2.0.0-p645 bundle exec rake'
-    - 'rvm-exec 2.1.6 bundle exec rake'
-    - 'rvm-exec 2.2.2 bundle exec rake'
+  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done'

data/dev/spec.yml

@@ -686,39 +686,10 @@ linode:
     create:
     - desc: ''
     - params:
-      - fromdistributionid:
-        - desc: ''
-        - required: false
-        - type: :numeric
-      - isreadonly:
-        - desc: Enable forced read-only for this Disk
-        - required: false
-        - type: :boolean
-      - label:
-        - desc: The display label for this Disk
-        - required: true
-        - type: :string
       - linodeid:
         - desc: ''
         - required: true
         - type: :numeric
-      - rootpass:
-        - desc: ''
-        - required: false
-        - type: :string
-      - rootsshkey:
-        - desc: ''
-        - required: false
-        - type: :string
-      - size:
-        - desc: The size in MB of this Disk.
-        - required: true
-        - type: :numeric
-      - type:
-        - desc: 'The formatted type of this disk.  Valid types are: ext3, ext4, swap,
-            raw'
-        - required: true
-        - type: :string
     - throws:
       - NOTFOUND
       - VALIDATION
@@ -912,14 +883,6 @@ linode:
         - desc: ''
         - required: true
         - type: :numeric
-      - isreadonly:
-        - desc: Enable forced read-only for this Disk
-        - required: false
-        - type: :boolean
-      - label:
-        - desc: The display label for this Disk
-        - required: false
-        - type: :string
       - linodeid:
         - desc: ''
         - required: false
@@ -1016,6 +979,16 @@ linode:
         - required: false
         - type: :boolean
     - throws: []
+  kvmify:
+  - desc: Changes a Linode's hypervisor from Xen to KVM.
+  - params:
+    - linodeid:
+      - desc: The LinodeID to migrate to KVM.
+      - required: true
+      - type: :numeric
+  - throws:
+    - NOTFOUND
+    - VALIDATION
   list:
   - desc: 'Returns a list of all Linodes user has access or delete to, including some
       properties.  Status values are -1: Being Created, 0: Brand New, 1: Running,

data/lib/linodeapi.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'httparty'
 
 ##
@@ -74,4 +75,6 @@ module LinodeAPI
   end
 end
 
+require 'linodeapi/errors'
 require 'linodeapi/raw'
+require 'linodeapi/retryable'

data/lib/linodeapi/errors.rb

@@ -0,0 +1,47 @@
+module LinodeAPI
+  ##
+  # A standard HTTP error with an embedded error code
+  class HTTPError < StandardError
+    attr_reader :code
+
+    def initialize(code, msg = 'HTTP Error encountered')
+      @code = code
+      super(msg)
+    end
+  end
+
+  ##
+  # A retryable error that has exceeded its max retries
+  class RetriedHTTPError < HTTPError
+    attr_reader :retries
+
+    def initialize(code, retries, msg = nil)
+      @retries = retries
+      msg ||= "HTTP Error encountered (retried #{retries} times)"
+      super(code, msg)
+    end
+  end
+
+  ##
+  # A retryable API error with embedded code and requested delay
+  class RetryableHTTPError < HTTPError
+    attr_reader :delay
+
+    def initialize(code, delay, msg = 'Retryable HTTP Error encountered')
+      @delay = delay.to_i
+      super(code, msg)
+    end
+  end
+
+  ##
+  # An API error in the body of the HTTP response
+  class APIError < StandardError
+    attr_reader :action, :details
+
+    def initialize(resp, msg = 'API Error encountered')
+      @action = resp['ACTION']
+      @details = resp['ERRORARRAY']
+      super(msg)
+    end
+  end
+end

data/lib/linodeapi/raw.rb

@@ -9,17 +9,16 @@ module LinodeAPI
   class Raw
     include HTTParty
 
-    attr_reader :apikey, :spec, :names
-
     def initialize(params = {})
+      @options = params
       self.class.base_uri params.fetch(:endpoint, DEFAULT_ENDPOINT)
-      @names = params.fetch(:names) { [] }
-      @spec = params.fetch(:spec) { LinodeAPI.spec }
-      @apikey = params.fetch(:apikey) { authenticate(params) }
+      @options[:names] ||= []
+      @options[:spec] ||= LinodeAPI.spec
+      @options[:apikey] ||= authenticate(params)
     end
 
-    def respond_to?(method, include_private = false)
-      super || @spec[:subs].include?(method)
+    def respond_to_missing?(method, include_private = false)
+      spec[:subs].include?(method) || super
     end
 
     def to_s
@@ -27,10 +26,22 @@ module LinodeAPI
     end
     alias inspect to_s
 
+    def names
+      @names ||= @options[:names]
+    end
+
+    def spec
+      @spec ||= @options[:spec]
+    end
+
+    def apikey
+      @apikey ||= @options[:apikey]
+    end
+
     private
 
     def authenticate(params = {})
-      return [] unless @names.empty?
+      return [] unless names.empty?
       unless (params.values_at :username, :password).all?
         raise ArgumentError, 'You must provide either an API key or user/pass'
       end
@@ -39,18 +50,18 @@ module LinodeAPI
 
     def method_missing(method, *args, &block)
       return super unless respond_to? method
-      case @spec[:subs][method][:type]
+      case spec[:subs][method][:type]
       when :group then make_group method
       when :call then make_call method, *args
       end
     end
 
     def make_group(method)
-      group = Raw.new(
-        spec: @spec[:subs][method],
-        apikey: @apikey,
-        username: @username,
-        names: @names + [method]
+      group = self.class.new(
+        @options.dup.merge(
+          spec: spec[:subs][method],
+          names: names + [method]
+        )
       )
       name = "@#{method}".to_sym
       instance_variable_set name, group
@@ -64,28 +75,34 @@ module LinodeAPI
     end
 
     def call(method, params = {})
-      spec = @spec[:subs][method]
-      method = (@names + [method.to_s]).join '.'
-      options = self.class.validate method, spec[:params], params
-      options[:api_key] = @apikey
+      mspec = spec[:subs][method]
+      method = (names + [method.to_s]).join '.'
+      options = self.class.validate method, mspec[:params], params
+      options[:api_key] = apikey
       options[:api_action] = method
       error_check self.class.post('', body: options)
     end
 
     def error_check(resp)
-      code = resp.code
-      raise("API threw HTTP error code #{code}") unless code == 200
+      error = create_http_error(resp)
+      raise(error) if error
       data = resp.parsed_response
       raise('Invalid API response received') if data.nil?
       self.class.parse data
     end
 
+    def create_http_error(resp)
+      code = resp.code
+      return nil if code == 200
+      delay = resp.headers['Retry-After']
+      return RetryableHTTPError.new(code, delay) if delay
+      HTTPError.new(code)
+    end
+
     class << self
       def parse(resp)
         resp['ERRORARRAY'].reject! { |x| x['ERRORCODE'].zero? }
-        unless resp['ERRORARRAY'].empty?
-          raise "API Error on #{resp['ACTION']}: #{resp['ERRORARRAY']}"
-        end
+        raise(APIError, resp) unless resp['ERRORARRAY'].empty?
         data = resp['DATA']
         data.is_a?(Hash) ? clean(data) : data.map { |x| clean x }
       end
@@ -94,8 +111,8 @@ module LinodeAPI
         OpenStruct.new(Hash[object.map { |k, v| [k.downcase.to_sym, v] }])
       end
 
-      def validate(method, spec, given)
-        spec.each_with_object({}) do |(param, info), options|
+      def validate(method, mspec, given)
+        mspec.each_with_object({}) do |(param, info), options|
           if given.include? param
             options[param] = VALIDATION_METHODS[info[:type]].call given[param]
           elsif info[:required]

data/lib/linodeapi/retryable.rb

@@ -0,0 +1,36 @@
+module LinodeAPI
+  ##
+  # A wrapper for the Raw API that can retry retryable errors
+  class Retryable < Raw
+    def initialize(params = {})
+      super
+      @options[:max_retries] ||= 3
+      @options[:max_delay] ||= 60
+    end
+
+    private
+
+    alias single_call call
+
+    def call(*args)
+      call_with_retries(max_retries, *args)
+    end
+
+    def call_with_retries(remaining, *args)
+      single_call(*args)
+    rescue RetryableHTTPError => e
+      raise(RetriedHTTPError.new(e.code, max_retries)) if remaining < 0
+      delay = [e.delay, max_delay].min
+      sleep delay
+      call_with_retries(remaining - 1, *args)
+    end
+
+    def max_retries
+      @options[:max_retries]
+    end
+
+    def max_delay
+      @options[:max_delay]
+    end
+  end
+end

data/linodeapi.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'linodeapi'
-  s.version     = '1.0.1'
-  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.version     = '2.0.0'
+  s.date        = Time.now.strftime('%Y-%m-%d')
 
   s.summary     = 'Linode API wrapper'
-  s.description = "Wraps the Linode API with multiple levels of interaction"
+  s.description = 'Wraps the Linode API with multiple levels of interaction'
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/linodeapi'
@@ -13,13 +13,14 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split
   s.test_files  = `git ls-files spec/*`.split
 
-  s.add_dependency 'httparty', '~> 0.13.1'
+  s.add_dependency 'httparty', '~> 0.15.5'
 
-  s.add_development_dependency 'rubocop', '~> 0.41.1'
-  s.add_development_dependency 'rake', '~> 11.2.0'
+  s.add_development_dependency 'rubocop', '~> 0.50.0'
+  s.add_development_dependency 'goodcop', '~> 0.1.0'
+  s.add_development_dependency 'rake', '~> 12.1.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.5.0'
-  s.add_development_dependency 'fuubar', '~> 2.0.0'
-  s.add_development_dependency 'webmock', '~> 2.1.0'
+  s.add_development_dependency 'rspec', '~> 3.6.0'
+  s.add_development_dependency 'fuubar', '~> 2.2.0'
+  s.add_development_dependency 'webmock', '~> 3.0.0'
   s.add_development_dependency 'vcr', '~> 3.0.0'
 end

data/spec/linodeapi/raw_spec.rb

@@ -19,7 +19,7 @@ describe LinodeAPI::Raw do
     VCR.use_cassette('basic_auth_fail') do
       expect do
         LinodeAPI::Raw.new(username: 'bad', password: 'bad')
-      end.to raise_error RuntimeError
+      end.to raise_error LinodeAPI::APIError
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linodeapi
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,42 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.15.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.15.5
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.1
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.41.1
+        version: 0.50.0
+- !ruby/object:Gem::Dependency
+  name: goodcop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: 12.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.2.0
+        version: 12.1.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circle-ruby"
 - ".gitignore"
 - ".prospectus"
 - ".rspec"
@@ -142,7 +157,9 @@ files:
 - dev/spec.yml
 - dev/version
 - lib/linodeapi.rb
+- lib/linodeapi/errors.rb
 - lib/linodeapi/raw.rb
+- lib/linodeapi/retryable.rb
 - linodeapi.gemspec
 - spec/fixtures/cassettes/basic_auth.yml
 - spec/fixtures/cassettes/basic_auth_fail.yml
@@ -173,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Linode API wrapper