linodeapi 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 386eb467c95101a915f20e0859bf356bb8c765ed
-  data.tar.gz: 45437aba6937cb0e0a03de655948479d5938241d
+  metadata.gz: 774a92f57a045e5df6250bd6654fc773b7e7c33f
+  data.tar.gz: efb03272ff013266e9a43ed270eeafa03fb5b2a2
 SHA512:
-  metadata.gz: 18391de6e8204d94eef64f38b28a6f5fba0e0c3f37bb948029237cdeebfbbddcd00df70e107c88450c14e6700f2c1cb9b1c257d968cd5d6b87586dd27cfff1ed
-  data.tar.gz: a01e3df48784a83b12a8cabf96e0608505c825d56a7fd4a81a7ebd330fd41d18a26ec1d7134df3b69a23cc0191c0d37e89f0e5b294c93b3f34e35df9618569f5
+  metadata.gz: cced09324ac708e26276287c6a3e93fd4afd95d95dc289e33ba0e0b26941544bca779fe5118f403e5a9d6226dab9c108cdafa59a3cc2df92deb6167b089ad6a0
+  data.tar.gz: 81546c62f9d6e28601dd3e6526affffc7bbe276f2cbab82ed6a96c5d1bd53a4187b3529fea67690c45797af68552e14a3209c5300c704b91e0c34169a0d4371f

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 2.0.1 / 2017-10-03
+
+* [ENHANCEMENT] Broke out some of the parsing code into linodeapi/helpers to make it easier to read
+* [FEATURE] Support using multiple LinodeAPI::Raw instances with different endpoint URIs at the same time
+
+# 2.0.0 / 2017-10-03
+
+* [FEATURE] LinodeAPI::Retryable class that automatically retries supported errors
+* [ENHANCEMENT] Cleaned up LinodeAPI::Raw's parameter handling
+* [FEATURE] Added unique error codes to lib/linodeapi/errors.rb for API/HTTP errors
+
 # 1.0.1 / 2016-07-01
 
 * [FEATURE] Expose LinodeAPI.spec_version

data/lib/linodeapi.rb

@@ -76,5 +76,6 @@ module LinodeAPI
 end
 
 require 'linodeapi/errors'
+require 'linodeapi/helpers'
 require 'linodeapi/raw'
 require 'linodeapi/retryable'

data/lib/linodeapi/helpers.rb

@@ -0,0 +1,42 @@
+module LinodeAPI
+  ##
+  # HTTP / API parsing helpers
+  module Helpers
+    def error_check(resp)
+      error = create_http_error(resp)
+      raise(error) if error
+      data = resp.parsed_response
+      raise('Invalid API response received') if data.nil?
+      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
+
+    def parse(resp)
+      resp['ERRORARRAY'].reject! { |x| x['ERRORCODE'].zero? }
+      raise(APIError, resp) unless resp['ERRORARRAY'].empty?
+      data = resp['DATA']
+      data.is_a?(Hash) ? clean(data) : data.map { |x| clean x }
+    end
+
+    def clean(object)
+      OpenStruct.new(Hash[object.map { |k, v| [k.downcase.to_sym, v] }])
+    end
+
+    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]
+          raise ArgumentError, "#{method} requires #{param}"
+        end
+      end
+    end
+  end
+end

data/lib/linodeapi/raw.rb

@@ -8,10 +8,11 @@ module LinodeAPI
   # Raw API object
   class Raw
     include HTTParty
+    extend Helpers
 
     def initialize(params = {})
       @options = params
-      self.class.base_uri params.fetch(:endpoint, DEFAULT_ENDPOINT)
+      @options[:endpoint] ||= DEFAULT_ENDPOINT
       @options[:names] ||= []
       @options[:spec] ||= LinodeAPI.spec
       @options[:apikey] ||= authenticate(params)
@@ -38,6 +39,10 @@ module LinodeAPI
       @apikey ||= @options[:apikey]
     end
 
+    def endpoint
+      @endpoint ||= @options[:endpoint]
+    end
+
     private
 
     def authenticate(params = {})
@@ -75,51 +80,19 @@ module LinodeAPI
     end
 
     def call(method, params = {})
+      options = build_call_body(method, params)
+      self.class.error_check self.class.post(
+        '', body: options, base_uri: endpoint
+      )
+    end
+
+    def build_call_body(method, params)
       mspec = spec[:subs][method]
-      method = (names + [method.to_s]).join '.'
+      mname = (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)
-      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? }
-        raise(APIError, resp) unless resp['ERRORARRAY'].empty?
-        data = resp['DATA']
-        data.is_a?(Hash) ? clean(data) : data.map { |x| clean x }
-      end
-
-      def clean(object)
-        OpenStruct.new(Hash[object.map { |k, v| [k.downcase.to_sym, v] }])
-      end
-
-      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]
-            raise ArgumentError, "#{method} requires #{param}"
-          end
-        end
-      end
+      options[:api_action] = mname
+      options
     end
   end
 

data/linodeapi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'linodeapi'
-  s.version     = '2.0.0'
+  s.version     = '2.0.1'
   s.date        = Time.now.strftime('%Y-%m-%d')
 
   s.summary     = 'Linode API wrapper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: linodeapi
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Les Aker
@@ -158,6 +158,7 @@ files:
 - dev/version
 - lib/linodeapi.rb
 - lib/linodeapi/errors.rb
+- lib/linodeapi/helpers.rb
 - lib/linodeapi/raw.rb
 - lib/linodeapi/retryable.rb
 - linodeapi.gemspec
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Linode API wrapper