esp_sdk 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 985f05618a6621f6fd81b455b13b532c91712638
-  data.tar.gz: 773b7274d4889449a4264f8f19e869f4b9830798
+  metadata.gz: ee71a8ce107cfd0be1c552e60e32ea3637c21eaa
+  data.tar.gz: f4087d8db9e1affb4f96a1eceae43ba3211673bf
 SHA512:
-  metadata.gz: 54b0c9606230136eff0b3c463467be3f9eebf1986b4e603622c1efa59e680496769b7d086ae13913be912df2c12e7ac2f1e5352e39a1ba18628ffc4c9e36828a
-  data.tar.gz: c398c98653b66c5adac110c958580662fb1bba451fa0d8db98cc6f435e6d1ed0f5f79c594a768bee60232d9b9799eeff230c65961ab1c4cc43e2917bb344667e
+  metadata.gz: b3f490d1f67a732b9b85daf1036d69af6b8295238ce9eb255b41f4fd10172106663e7e3bd7c7f45c7d0c12219b1a34bf68690bd0c12285c1cd25198fcf26aacd
+  data.tar.gz: 9ece944bf4867f36e4df3457e12c739b15d79dd0ebc729d9b5d2d47955e941b6b3e2042ef88a0fd9eec9fc35d77f052c113342bbbd06c346d1549dfcffb89f93

data/.gitignore

@@ -17,5 +17,7 @@ tmp
 *.so
 *.o
 *.a
+*.swp
+*.swo
 mkmf.log
 .idea

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## Unreleased
 
+## 2.6.0 - 2016-10-17
+### Changed
+- Only send changed attributes to API #39
+- API now returns nested included relation data elements correctly.  Change test to reflect corrected response. #40
+- Calling `next_page` on queries without parameters (e.g. `ESP::ExternalAccount.all`) no longer errors. #35
+- Silently ignore `null` entires if encountered in API responses. #69
+- Switch from RDoc to Yard. #37
+
 ## 2.5.0 - 2016-07-20
 ### Added
 - Add custom signature definitions and results. Code for a custom signature is now created/updated under a definition. Running a definition for an on demand test creates a result record which will have errors and alerts when completed.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esp_sdk (2.5.0)
+    esp_sdk (2.6.0)
       activeresource (~> 4.0.0)
       api-auth (~> 2.0.0)
       rack
@@ -107,7 +107,7 @@ GEM
     rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    rdoc (4.0.0)
+    rdiscount (2.2.0.1)
     rest-client (1.7.3)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
@@ -142,6 +142,7 @@ GEM
     webmock (1.21.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+    yard (0.9.5)
 
 PLATFORMS
   ruby
@@ -161,10 +162,11 @@ DEPENDENCIES
   minitest-reporters
   mocha
   rake
-  rdoc
+  rdiscount
   rubocop
   shoulda
   webmock
+  yard
 
 BUNDLED WITH
    1.12.5

data/Guardfile

@@ -15,10 +15,12 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-guard :minitest do
+guard :minitest, all_on_start: false do
   # with Minitest::Unit
   watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^test/.+_test\.rb$})
   watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^lib/(.+)\.rb$})              { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/test_helper\.rb$})      { 'test' }
 
   # with Minitest::Spec

data/esp_sdk.gemspec

@@ -33,9 +33,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'factory_girl'
-  spec.add_development_dependency 'rdoc'
+  spec.add_development_dependency 'yard'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'aws-sdk'
+  spec.add_development_dependency 'rdiscount'
 
   spec.add_dependency 'activeresource', '~> 4.0.0'
   spec.add_dependency 'api-auth', '~> 2.0.0'

data/lib/esp/aws_clients.rb

@@ -1,6 +1,7 @@
 require 'aws-sdk'
 
-module ESP # :nodoc: all
+module ESP
+  # @private
   class AWSClients
     include ActiveModel::Validations
 

data/lib/esp/commands/commands_tasks.rb

@@ -4,7 +4,8 @@ module ESP
   #
   # Warning: This class mutates ARGV because some commands require manipulating
   # it before they are run.
-  class CommandsTasks # :nodoc:
+  # @private
+  class CommandsTasks
     attr_reader :argv
 
     HELP_MESSAGE = <<-EOT

data/lib/esp/commands/console.rb

@@ -21,7 +21,11 @@ ARGV.clone.options do |opts|
 end
 
 module ESP
+  # @private
   class Console
+    # Start a console
+    #
+    # @return [void]
     def start # rubocop:disable Metrics/MethodLength
       ARGV.clear
       IRB.setup nil

data/lib/esp/exceptions.rb

@@ -1,3 +1,4 @@
 module ESP
+  # @private
   class NotImplementedError < StandardError; end
 end

data/lib/esp/extensions/active_resource/dirty.rb

@@ -0,0 +1,51 @@
+module Dirty
+  def original_attributes
+    @original_attributes ||= {}.with_indifferent_access
+  end
+
+  def original_attributes=(attributes = {})
+    @original_attributes = attributes.dup
+  end
+
+  def changed_attributes
+    attributes.select do |key, value|
+      next if value == original_attributes[key]
+      true
+    end
+  end
+end
+
+# Set the original attributes every time we instantiate an object from the api
+# This happens on GET requests
+module InstantiateWithOriginalAttributes
+  private
+
+  def instantiate_record(record, _prefix_options = {})
+    super(record, _prefix_options = {}).tap do |object|
+      object.original_attributes = object.attributes
+    end
+  end
+end
+
+module LoadWithOriginalAttributes
+  # After sending to the API the object is reloaded with its attributes
+  # The persisted flag tells us it has been saved
+  def load(attributes, _remove_root = false, persisted = false)
+    if persisted
+      super.tap do |object|
+        object.original_attributes = object.attributes
+      end
+    else
+      super
+    end
+  end
+end
+
+class ActiveResource::Base
+  include Dirty
+  prepend LoadWithOriginalAttributes
+
+  class << self
+    prepend InstantiateWithOriginalAttributes
+  end
+end

data/lib/esp/extensions/active_resource/formats/json_api_format.rb

@@ -1,6 +1,7 @@
 require 'active_support/json'
 
-module ActiveResource # :nodoc: all
+module ActiveResource
+  # @private
   class ConnectionError
     def initialize(response)
       @response = if response.respond_to?(:response)
@@ -20,7 +21,8 @@ module ActiveResource # :nodoc: all
     end
   end
 
-  module Formats # :nodoc: all
+  # @private
+  module Formats
     module JsonAPIFormat
       module_function
 
@@ -121,7 +123,7 @@ module ActiveResource # :nodoc: all
       end
 
       def self.merge_nested_included_objects(object, data, included)
-        assocs = included.select { |i| data.include?((i.slice('type', 'id'))) }
+        assocs = included.compact.select { |i| data.include?(i.slice('type', 'id')) }
         # Remove the object from the included array to prevent an infinite loop if one of it's associations relates back to itself.
         assoc_included = included.dup
         assoc_included.delete(object)

data/lib/esp/extensions/active_resource/paginated_collection.rb

@@ -1,12 +1,18 @@
 require 'rack'
 
 module ActiveResource
-  # Provides a mean to call the Evident.io API to easily retrieve paginated data
   class PaginatedCollection < ActiveResource::Collection
-    attr_reader :next_page_params, :previous_page_params, :last_page_params #:nodoc:
-    attr_accessor :from #:nodoc:
-
-    def initialize(elements = []) #:nodoc:
+    # Internal variable used to construct queries.
+    # @return [Hash]
+    # @private
+    attr_reader :next_page_params, :previous_page_params, :last_page_params
+    # Internal variable used to construct queries.
+    # @return [Integer]
+    # @private
+    attr_accessor :from
+
+    # @private
+    def initialize(elements = [])
       # If a collection is sent without the pagination links, then elements will just be an array.
       if elements.is_a? Hash
         super(elements['data'])
@@ -16,22 +22,24 @@ module ActiveResource
       end
     end
 
-    # Returns a new PaginatedCollection with the first page of results.
+    # Returns the first page of results.
     #
-    # Returns self when on the first page and no API call is made.
+    # Returns +self+ (and no API call is made) when already on the first page.
     #
-    # ==== Example
+    # @return [PaginatedCollection, self]
+    # @example
     #   alerts.current_page_number # => 5
     #   first_page = alerts.first_page
     #   alerts.current_page_number # => 5
     #   first_page.current_page_number # => 1
     def first_page
-      previous_page? ? resource_class.where(original_params.merge(from: from, page: { number: 1 })) : self
+      previous_page? ? updated_collection(from: from, page: { number: 1 }) : self
     end
 
     # Updates the existing PaginatedCollection object with the first page of data when not on the first page.
     #
-    # ==== Example
+    # @return (see #first_page)
+    # @example
     #   alerts.current_page_number # => 5
     #   alerts.first_page!
     #   alerts.current_page_number # => 1
@@ -39,22 +47,24 @@ module ActiveResource
       first_page.tap { |page| update_self(page) }
     end
 
-    # Returns a new PaginatedCollection with the previous page of results.
+    # Returns the previous page of results.
     #
-    # Returns self when on the first page and no API call is made.
+    # Returns +self+ (and no API call is made) when already on the first page.
     #
-    # ==== Example
+    # @return [PaginatedCollection, self]
+    # @example
     #   alerts.current_page_number # => 5
     #   previous_page = alerts.previous_page
     #   alerts.current_page_number # => 5
     #   previous_page.current_page_number # => 4
     def previous_page
-      previous_page? ? resource_class.where(original_params.merge(previous_page_params.merge(from: from))) : self
+      previous_page? ? updated_collection(previous_page_params.merge(from: from)) : self
     end
 
     # Updates the existing PaginatedCollection object with the previous page of data when not on the first page.
     #
-    # ==== Example
+    # @return (see #previous_page)
+    # @example
     #   alerts.current_page_number # => 5
     #   alerts.previous_page!
     #   alerts.current_page_number # => 4
@@ -62,22 +72,24 @@ module ActiveResource
       previous_page.tap { |page| update_self(page) }
     end
 
-    # Returns a new PaginatedCollection with the next page of results.
+    # Returns the next page of results.
     #
-    # Returns self when on the last page and no API call is made.
+    # Returns +self+ (and no API call is made) when already on the last page.
     #
-    # ==== Example
+    # @return [PaginatedCollection, self]
+    # @example
     #   alerts.current_page_number # => 5
     #   next_page = alerts.next_page
     #   alerts.current_page_number # => 5
     #   next_page.current_page_number # => 6
     def next_page
-      next_page? ? resource_class.where(original_params.merge(next_page_params.merge(from: from))) : self
+      next_page? ? updated_collection(next_page_params.merge(from: from)) : self
     end
 
     # Updates the existing PaginatedCollection object with the last page of data when not on the last page.
     #
-    # ==== Example
+    # @return (see #next_page)
+    # @example
     #   alerts.current_page_number # => 5
     #   alerts.next_page!
     #   alerts.current_page_number # => 6
@@ -85,22 +97,24 @@ module ActiveResource
       next_page.tap { |page| update_self(page) }
     end
 
-    # Returns a new PaginatedCollection with the last page of results.
+    # Returns the last page of results.
     #
-    # Returns self when on the last page and no API call is made.
+    # Returns +self+ (and no API call is made)  when already on the last page.
     #
-    # ==== Example
+    # @return [PaginatedCollection, self]
+    # @example
     #   alerts.current_page_number # => 5
     #   last_page = alerts.last_page
     #   alerts.current_page_number # => 5
     #   last_page.current_page_number # => 25
     def last_page
-      !last_page? ? resource_class.where(original_params.merge(last_page_params.merge(from: from))) : self
+      !last_page? ? updated_collection(last_page_params.merge(from: from)) : self
     end
 
     # Updates the existing PaginatedCollection object with the last page of data when not on the last page.
     #
-    # ==== Example
+    # @return (see #last_page)
+    # @example
     #   alerts.current_page_number # => 5
     #   alerts.last_page!
     #   alerts.current_page_number # => 25
@@ -108,15 +122,14 @@ module ActiveResource
       last_page.tap { |page| update_self(page) }
     end
 
-    # Returns a new PaginatedCollection with the +page_number+ page of data.
-    #
-    # Returns self when +page_number+ == #current_page_number
+    # Returns the +page_number+ page of data.
     #
-    # ==== Attribute
+    # Returns +self+ when +page_number+ == +#current_page_number+
     #
-    # +page_number+ - The page number of the data wanted.  +page_number+ must be between 1 and #last_page_number.
-    #
-    # ==== Example
+    # @param page_number [Integer] The page number of the data wanted. Must be between 1 and +#last_page_number+.
+    # @return [PaginatedCollection, self]
+    # @raise [ArgumentError] if no page number or an out-of-bounds page number is supplied.
+    # @example
     #   alerts.current_page_number # => 5
     #   page = alerts.page(2)
     #   alerts.current_page_number # => 5
@@ -125,16 +138,14 @@ module ActiveResource
       fail ArgumentError, "You must supply a page number." unless page_number.present?
       fail ArgumentError, "Page number cannot be less than 1." if page_number.to_i < 1
       fail ArgumentError, "Page number cannot be greater than the last page number." if page_number.to_i > last_page_number.to_i
-      page_number.to_i != current_page_number.to_i ? resource_class.where(original_params.merge(from: from, page: { number: page_number, size: (next_page_params || previous_page_params)['page']['size'] })) : self
+      page_number.to_i != current_page_number.to_i ? updated_collection(from: from, page: { number: page_number, size: (next_page_params || previous_page_params)['page']['size'] }) : self
     end
 
     # Returns a new PaginatedCollection with the +page_number+ page of data when not already on page +page_number+.
     #
-    # ==== Attribute
-    #
-    # +page_number+ - The page number of the data wanted.  +page_number+ must be between 1 and #last_page_number.
-    #
-    # ==== Example
+    # @param (see #page)
+    # @return (see #page)
+    # @example
     #   alerts.current_page_number # => 5
     #   alerts.page!(2)
     #   alerts.current_page_number # => 2
@@ -143,42 +154,64 @@ module ActiveResource
     end
 
     # The current page number of data.
+    #
+    # @return [String]
     def current_page_number
       (previous_page_number.to_i + 1).to_s
     end
 
     # The previous page number of data.
+    #
+    # @return [String, nil]
     def previous_page_number
       Hash(previous_page_params).fetch('page', {}).fetch('number', nil)
     end
 
     # The next page number of data.
+    #
+    # @return [String, nil]
     def next_page_number
       Hash(next_page_params).fetch('page', {}).fetch('number', nil)
     end
 
     # The last page number of data.
+    #
+    # @return [String, nil]
     def last_page_number
       Hash(last_page_params).fetch('page', {}).fetch('number', nil)
     end
 
     # Returns whether or not there is a previous page of data in the collection.
+    #
+    # @return [Boolean]
     def previous_page?
       !previous_page_number.nil?
     end
 
     # Returns whether or not there is a next page of data in the collection.
+    #
+    # @return [Boolean]
     def next_page?
       !next_page_number.nil?
     end
 
     # Returns whether or not the collection is on the last page.
+    #
+    # @return [Boolean]
     def last_page?
       last_page_number.nil?
     end
 
     private
 
+    # Start a new collection.
+    #
+    # @param params [Hash]
+    # @return [PaginatedCollection]
+    def updated_collection(params)
+      resource_class.where(original_params.merge(params))
+    end
+
     def update_self(page)
       @elements = page.elements
       @next_page_params = page.next_page_params

data/lib/esp/extensions/active_resource/validations.rb

@@ -1,8 +1,9 @@
-module ActiveResource # :nodoc: all
+module ActiveResource
+  # @private
   module Validations
     # Loads the set of remote errors into the object's Errors based on the
     # content-type of the error-block received.
-    def load_remote_errors(remote_errors, save_cache = false) #:nodoc:
+    def load_remote_errors(remote_errors, save_cache = false)
       if self.class.format == ActiveResource::Formats::JsonAPIFormat
         errors.from_json_api(remote_errors.response.body, save_cache)
       elsif self.class.format == ActiveResource::Formats[:json]
@@ -11,6 +12,7 @@ module ActiveResource # :nodoc: all
     end
   end
 
+  # @private
   class Errors
     def from_json_api(json, save_cache = false)
       raw_errors = decoded_errors(json)

data/lib/esp/external_account_creator.rb

@@ -1,4 +1,5 @@
-module ESP # :nodoc: all
+module ESP
+  # @private
   class AddExternalAccountError < StandardError
     EXIT_CODES = {
       '12 characters'          => 98,
@@ -20,6 +21,7 @@ module ESP # :nodoc: all
     end
   end
 
+  # @private
   class ExternalAccountCreator
     attr_reader :aws
 
@@ -27,6 +29,7 @@ module ESP # :nodoc: all
       @aws = AWSClients.new
     end
 
+    # @return [ESP::ExternalAccount]
     def create
       fail ESP::AddExternalAccountError, aws.errors.full_messages.join(', ') unless aws.valid?