linodeapi 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 613ee064aa8a8581a6d3c44d7b2b654ecf006ae3
-  data.tar.gz: bc5aafb0308006830ffd6a90d1ba642a9ab7a282
+  metadata.gz: d2b6266cebf4ba879b7b79560958046dcfbeef85
+  data.tar.gz: e4f7be859b3b424d4023d228a2bf465652b27c8d
 SHA512:
-  metadata.gz: b83e57e4909a32e9aa9e1c4e876e808e6589813edb4f3b94167d3bc0b8b81f1fb35ea26e96d97221bc360a3af477d6770358b37cb67a5785564706976ac96658
-  data.tar.gz: fa56efc343ff4c6ca9aee7642e23f3a967901e5b1f35a8b6ecca8e800790a6cdf5612c33f84c66de302a0856879a772965ca686a490f77ba4221a5e27b06d76b
+  metadata.gz: 9c0400892e248bf04836685ea695ed2415dd5c38b39fd12f55028685a178d3cc6891ac99c07a6c730b2ada07c19058a86dad965bfc3ad472c19a7cb0df65586c
+  data.tar.gz: a3645671fea6219314385c06f922eb957796460beb4f864a8df72700e2210d306dd699d39c00079791fb7b3546256284d6337b386180b3f2d942642bfe3bd1a6

data/.prospectus

@@ -0,0 +1,31 @@
+require 'yaml'
+
+item do
+  expected do
+    static
+    set 'green'
+  end
+
+  actual do
+    gemnasium
+    slug 'akerl/linodeapi'
+  end
+
+  deps do
+    YAML.load(`./dev/cache_spec.rb --noop`).each do |item_name, (old, new)|
+      item do
+        name "api.spec.#{item_name}"
+
+        expected do
+          static
+          set new
+        end
+
+        actual do
+          static
+          set old
+        end
+      end
+    end
+  end
+end

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.1 / 2016-07-01
+
+* [FEATURE] Expose LinodeAPI.spec_version
+
 # 1.0.0 / 2015-01-19
 
 * [ENHANCEMENT] Stabilized API

data/dev/cache_spec.rb

@@ -1,12 +1,15 @@
 #!/usr/bin/env ruby
 
+require 'mercenary'
 require 'linodeapi'
 require 'yaml'
+require 'digest'
 
-SPEC_FILE = $ARGV.first || 'dev/spec.yml'
+SPEC_FILE = 'dev/spec.yml'.freeze
+VERSION_FILE = File.join(File.dirname(SPEC_FILE), 'version')
 
 def parse_node(node)
-  return clean_node(node) if node[:type] == :call
+  return clean_node(node.dup) if node[:type] == :call
   Hash[node[:subs].sort.map { |k, v| [k.to_s, parse_node(v)] }]
 end
 
@@ -20,6 +23,38 @@ def hash_to_array(hash)
   hash.to_a.sort.map { |x| Hash[x.first.to_s, hash_to_array(x.last)] }
 end
 
-result = parse_node(LinodeAPI.spec)
+def write_changes
+  File.open(SPEC_FILE, 'w') { |fh| fh << YAML.dump(parse_node(LinodeAPI.spec)) }
+  File.open(VERSION_FILE, 'w') { |fh| fh << LinodeAPI.spec_version }
+end
+
+def sha(string)
+  Digest::SHA256.hexdigest(string)[0..7]
+end
+
+def all_changes
+  {
+    'version' => [
+      File.read(VERSION_FILE).chomp,
+      LinodeAPI.spec_version
+    ],
+    'spec' => [
+      sha(File.read(SPEC_FILE)),
+      sha(YAML.dump(parse_node(LinodeAPI.spec)))
+    ]
+  }
+end
+
+Mercenary.program(:cache_spec) do |p|
+  p.version '0.0.1'
+  p.description 'Update cache file of api.apec'
+  p.syntax "#{$PROGRAM_NAME} [options]"
 
-File.open(SPEC_FILE, 'w') { |fh| fh << YAML.dump(result) }
+  p.option :noop, '-n', '--noop', 'No-op run (will not update the cached file'
+  p.option :quiet, '-q', '--quiet', 'Quiet mode'
+
+  p.action do |_, options|
+    puts YAML.dump(all_changes) unless options[:quiet]
+    write_changes unless options[:noop]
+  end
+end

data/dev/spec.yml

@@ -1476,117 +1476,6 @@ nodebalancer:
   - throws:
     - NOTFOUND
     - VALIDATION
-professionalservices:
-  scope:
-    create:
-    - desc: Creates a new Professional Services scope submission
-    - params:
-      - application_quantity:
-        - desc: How many separate applications or websites are involved in this migration?
-        - required: false
-        - type: :string
-      - content_management:
-        - desc: Centralized interfaces for editing, organizing, and publishing content
-        - required: false
-        - type: :string
-      - crossover:
-        - desc: These can assist in providing reliable crossover--failures of individual
-            components can be transparent to the application.
-        - required: false
-        - type: :string
-      - current_provider:
-        - desc: ''
-        - required: false
-        - type: :string
-      - customer_name:
-        - desc: ''
-        - required: false
-        - type: :string
-      - database_server:
-        - desc: Generally used by applications to provide an organized way to capture
-            and manipulate data
-        - required: false
-        - type: :string
-      - email_address:
-        - desc: ''
-        - required: false
-        - type: :string
-      - linode_datacenter:
-        - desc: Which datacenters would you like your Linodes to be deployed in?
-        - required: false
-        - type: :string
-      - linode_plan:
-        - desc: Which Linode plans would you like to deploy?
-        - required: false
-        - type: :string
-      - mail_filtering:
-        - desc: Services here manipulate recieved messages in various ways
-        - required: false
-        - type: :string
-      - mail_retrieval:
-        - desc: User mail clients connect to these to retrieve delivered mail
-        - required: false
-        - type: :string
-      - mail_transfer:
-        - desc: Mail transfer agents facilitate message transfer between servers
-        - required: false
-        - type: :string
-      - managed:
-        - desc: ''
-        - required: false
-        - type: :string
-      - monitoring:
-        - desc: Constant monitoring of your deployed systems--these can also provide
-            automatic notifications for service failures.
-        - required: false
-        - type: :string
-      - notes:
-        - desc: ''
-        - required: false
-        - type: :string
-      - phone_number:
-        - desc: ''
-        - required: false
-        - type: :string
-      - provider_access:
-        - desc: What types of server access do you have at your current provider?
-        - required: false
-        - type: :string
-      - replication:
-        - desc: Redundant services often have shared state--replication automatically
-            propagates state changes between individual components.
-        - required: false
-        - type: :string
-      - requested_service:
-        - desc: ''
-        - required: false
-        - type: :string
-      - server_quantity:
-        - desc: How many separate servers are involved in this migration?
-        - required: false
-        - type: :string
-      - system_administration:
-        - desc: Various web interfaces for performing system administration tasks
-        - required: false
-        - type: :string
-      - ticket_number:
-        - desc: ''
-        - required: false
-        - type: :string
-      - web_cache:
-        - desc: Caching mechanisms provide temporary storage for web requests--cached
-            content can generally be retrieved faster.
-        - required: false
-        - type: :string
-      - web_server:
-        - desc: These provide network protocol handling for hosting websites.
-        - required: false
-        - type: :string
-      - webmail:
-        - desc: Access and administrate mail via web interfaces
-        - required: false
-        - type: :string
-    - throws: []
 stackscript:
   create:
   - desc: Create a StackScript.
@@ -1680,7 +1569,8 @@ user:
   getapikey:
   - desc: Authenticates a Linode Manager user against their username, password, and
       two-factor token (when enabled), and then returns a new API key, which can be
-      used until it expires.  The number of active keys is limited to 20.
+      used until it expires.  The number of active keys is limited to 20.  Batch requests
+      will be rejected if they include this API action.
   - params:
     - expires:
       - desc: Number of hours the key will remain valid, between 0 and 8760. 0 means

data/dev/version

@@ -0,0 +1 @@
+3.3

data/lib/linodeapi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'httparty'
 
 ##
@@ -6,19 +7,26 @@ module LinodeAPI
   ##
   # Default API endpoint
 
-  DEFAULT_ENDPOINT = 'https://api.linode.com/'
-  SPEC_URL = 'https://api.linode.com/?api_action=api.spec'
+  DEFAULT_ENDPOINT = 'https://api.linode.com/'.freeze
+  SPEC_URL = 'https://api.linode.com/?api_action=api.spec'.freeze
 
   class << self
     def spec
-      @spec ||= { type: :group, subs: fetch_spec }
+      @spec ||= { type: :group, subs: parse_spec }
+    end
+
+    def spec_version
+      @spec_version ||= raw_spec['DATA']['VERSION'].to_s
     end
 
     private
 
-    def fetch_spec
-      raw = JSON.parse(HTTParty.get(SPEC_URL).body)['DATA']['METHODS']
-      raw.each_with_object({}) do |(method, info), spec|
+    def raw_spec
+      @raw_spec ||= JSON.parse(HTTParty.get(SPEC_URL).body)
+    end
+
+    def parse_spec
+      raw_spec['DATA']['METHODS'].each_with_object({}) do |(method, info), spec|
         name, groups = parse_method(method)
         params = parse_params(info['PARAMETERS'])
         add_call(spec, groups, name, params, info)

data/lib/linodeapi/raw.rb

@@ -25,14 +25,14 @@ module LinodeAPI
     def to_s
       'LinodeAPI::Raw object'
     end
-    alias_method :inspect, :to_s
+    alias inspect to_s
 
     private
 
     def authenticate(params = {})
       return [] unless @names.empty?
       unless (params.values_at :username, :password).all?
-        fail ArgumentError, 'You must provide either an API key or user/pass'
+        raise ArgumentError, 'You must provide either an API key or user/pass'
       end
       user.getapikey(params).api_key
     end
@@ -67,47 +67,48 @@ module LinodeAPI
       spec = @spec[:subs][method]
       method = (@names + [method.to_s]).join '.'
       options = self.class.validate method, spec[:params], params
-      options.merge! api_key: @apikey, api_action: method
+      options[:api_key] = @apikey
+      options[:api_action] = method
       error_check self.class.post('', body: options)
     end
 
     def error_check(resp)
       code = resp.code
-      fail("API threw HTTP error code #{code}") unless code == 200
+      raise("API threw HTTP error code #{code}") unless code == 200
       data = resp.parsed_response
-      fail('Invalid API response received') if data.nil?
+      raise('Invalid API response received') if data.nil?
       self.class.parse data
     end
 
-    def self.parse(resp)
-      resp['ERRORARRAY'].reject! { |x| x['ERRORCODE'].zero? }
-      unless resp['ERRORARRAY'].empty?
-        fail "API Error on #{resp['ACTION']}: #{resp['ERRORARRAY']}"
+    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
+        data = resp['DATA']
+        data.is_a?(Hash) ? clean(data) : data.map { |x| clean x }
       end
-      data = resp['DATA']
-      data.is_a?(Hash) ? clean(data) : data.map { |x| clean x }
-    end
 
-    def self.clean(object)
-      OpenStruct.new(Hash[object.map { |k, v| [k.downcase.to_sym, v] }])
-    end
+      def clean(object)
+        OpenStruct.new(Hash[object.map { |k, v| [k.downcase.to_sym, v] }])
+      end
 
-    def self.validate(method, spec, given)
-      spec.each_with_object({}) do |(param, info), options|
-        if given.include? param
-          options[param] = VALIDATION_METHODS[info[:type]].call given[param]
-        else
-          fail ArgumentError, "#{method} requires #{param}" if info[:required]
+      def validate(method, spec, given)
+        spec.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
 
-  private
-
   VALIDATION_METHODS = {
     boolean: proc { |e| !!e }, # rubocop:disable Style/DoubleNegation
     numeric: proc { |e| Integer(e) },
     string: proc(&:to_s)
-  }
+  }.freeze
 end

data/linodeapi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'linodeapi'
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   s.date        = Time.now.strftime("%Y-%m-%d")
 
   s.summary     = 'Linode API wrapper'
@@ -15,11 +15,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'httparty', '~> 0.13.1'
 
-  s.add_development_dependency 'rubocop', '~> 0.34.0'
-  s.add_development_dependency 'rake', '~> 10.4.0'
+  s.add_development_dependency 'rubocop', '~> 0.41.1'
+  s.add_development_dependency 'rake', '~> 11.2.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.3.0'
+  s.add_development_dependency 'rspec', '~> 3.5.0'
   s.add_development_dependency 'fuubar', '~> 2.0.0'
-  s.add_development_dependency 'webmock', '~> 1.22.0'
-  s.add_development_dependency 'vcr', '~> 2.9.2'
+  s.add_development_dependency 'webmock', '~> 2.1.0'
+  s.add_development_dependency 'vcr', '~> 3.0.0'
 end

data/spec/linodeapi/raw_spec.rb

@@ -42,8 +42,8 @@ describe LinodeAPI::Raw do
   end
 
   it 'accurately responds to .respond_to?' do
-    expect(subject.respond_to? :linode).to be_truthy
-    expect(subject.respond_to? :list).to be_falsey
+    expect(subject.respond_to?(:linode)).to be_truthy
+    expect(subject.respond_to?(:list)).to be_falsey
   end
 
   it 'returns arrays for list calls' do

data/spec/linodeapi_spec.rb

@@ -13,4 +13,8 @@ describe LinodeAPI do
     expect(LinodeAPI.spec[:subs]).to be_an_instance_of Hash
     expect(LinodeAPI.spec[:subs][:linode][:subs][:create][:type]).to eql :call
   end
+
+  it 'makes the spec version available' do
+    expect(LinodeAPI.spec_version).to match(/[\d.]*/)
+  end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,9 @@ end
 
 require 'rspec'
 require 'linodeapi'
+require 'webmock'
+
+WebMock.enable!
 
 require 'vcr'
 VCR.configure do |c|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linodeapi
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2016-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.0
+        version: 0.41.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.34.0
+        version: 0.41.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 11.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 11.2.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.22.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.2
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.2
+        version: 3.0.0
 description: Wraps the Linode API with multiple levels of interaction
 email: me@lesaker.org
 executables: []
@@ -129,6 +129,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".prospectus"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -139,6 +140,7 @@ files:
 - circle.yml
 - dev/cache_spec.rb
 - dev/spec.yml
+- dev/version
 - lib/linodeapi.rb
 - lib/linodeapi/raw.rb
 - linodeapi.gemspec
@@ -171,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Linode API wrapper