esp_sdk 2.7.0 → 2.8.0

data/Rakefile

@@ -1,12 +1,13 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 load 'lib/tasks/rubocop.rake'
-load 'lib/tasks/testing.rake'
 require 'rdoc/task'
 
 Rake::TestTask.new do |task|
   task.libs << 'test'
   task.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb'] - FileList["test/esp/integration/**/*_test.rb"]
+  task.verbose    = false
+  task.warning    = false
 end
 
 namespace "test" do

data/esp_sdk.gemspec

@@ -3,7 +3,7 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'esp/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'esp_sdk'
   spec.version       = ESP::VERSION
   spec.authors       = ['Evident.io']
@@ -26,19 +26,18 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'minitest-reporters'
   spec.add_development_dependency 'shoulda'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'bourne'
   spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'aws-sdk'
   spec.add_development_dependency 'rdiscount'
+  spec.add_development_dependency 'bundler-audit'
 
   spec.add_dependency 'activeresource', '~> 4.0.0'
-  spec.add_dependency 'api-auth', '~> 2.0.0'
+  spec.add_dependency 'api-auth', '~> 2.0'
   spec.add_dependency 'rack'
 end

data/lib/esp/aws_clients.rb

@@ -35,8 +35,8 @@ module ESP
       ESP_OWNER_ID.fetch(ESP.env, "762160981991")
     end
 
-    def trust_policy(external_account_id) # rubocop:disable Metrics/MethodLength
-      <<TRUST_POLICY
+    def trust_policy(external_account_id)
+      <<-TRUST_POLICY.gsub(/^\s*/, '')
   {
     "Version": "2012-10-17",
     "Statement": [

data/lib/esp/commands/add_external_account.rb

@@ -1,6 +1,6 @@
 require 'optparse'
 
-ARGV.clone.options do |opts|
+ARGV.clone.options do |opts| # rubocop:disable Metrics/BlockLength
   opts.banner = "Usage: esp add_external_account"
 
   opts.separator ""

data/lib/esp/commands/commands_tasks.rb

@@ -8,7 +8,7 @@ module ESP
   class CommandsTasks
     attr_reader :argv
 
-    HELP_MESSAGE = <<-EOT
+    HELP_MESSAGE = <<-EOT.freeze
 Usage: esp COMMAND [environment] [ARGS]
 
 The ESP commands are:
@@ -18,7 +18,7 @@ The ESP commands are:
 All commands can be run with -h (or --help) for more information.
     EOT
 
-    COMMAND_WHITELIST = %w(console add_external_account version help)
+    COMMAND_WHITELIST = %w(console add_external_account version help).freeze
 
     def initialize(argv)
       @argv = argv

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

@@ -4,9 +4,9 @@ module ActiveResource
   # @private
   class ConnectionError
     def initialize(response)
-      @response = if response.respond_to?(:response)
-                    message = decoded_errors(response.response.body)
-                    Struct.new(:body, :code, :message).new(response.response.body, response.code, message)
+      @response = if response.respond_to?(:body)
+                    message = decoded_errors(response.body)
+                    Struct.new(:body, :code, :message).new(response.body, response.code, message)
                   else
                     response
                   end
@@ -15,7 +15,7 @@ module ActiveResource
     private
 
     def decoded_errors(json)
-      Array((Hash(ActiveSupport::JSON.decode(json)))['errors'].map { |e| e['title'] }).join(" ")
+      Array(Hash(ActiveSupport::JSON.decode(json))['errors'].map { |e| e['title'] }).join(" ")
     rescue
       []
     end
@@ -43,9 +43,7 @@ module ActiveResource
         Formats.remove_root(parse_json_api(ActiveSupport::JSON.decode(json)))
       end
 
-      private
-
-      def self.parse_json_api(elements)
+      def parse_json_api(elements)
         included = elements.delete('included')
         elements.tap do |e|
           Array.wrap(e.fetch('data', {})).each do |object|
@@ -53,16 +51,18 @@ module ActiveResource
           end
         end
       end
+      private_class_method :parse_json_api
 
-      def self.parse_object!(object, included = nil)
+      def parse_object!(object, included = nil)
         return object unless object.respond_to?(:each)
         merge_attributes!(object)
         parse_elements(object)
         parse_relationships!(object, included)
         object
       end
+      private_class_method :parse_object!
 
-      def self.parse_elements(object)
+      def parse_elements(object)
         object.each_value do |value|
           if value.is_a? Hash
             parse_object!(value)
@@ -71,20 +71,23 @@ module ActiveResource
           end
         end
       end
+      private_class_method :parse_elements
 
-      def self.parse_relationships!(object, included)
+      def parse_relationships!(object, included)
         object.fetch('relationships', {}).each do |assoc, details|
           extract_foreign_keys!(object, assoc, details)
           merge_included_objects!(object, assoc, details['data'], included)
         end
       end
+      private_class_method :parse_relationships!
 
-      def self.merge_attributes!(object)
+      def merge_attributes!(object)
         return unless object.is_a? Hash
         object.merge! object.delete('attributes') unless object['attributes'].blank?
       end
+      private_class_method :merge_attributes!
 
-      def self.extract_foreign_keys!(object, assoc, assoc_details)
+      def extract_foreign_keys!(object, assoc, assoc_details)
         data = assoc_details['data']
         related_link = assoc_details.fetch('links', {}).fetch('related', {})
         if data.present?
@@ -93,16 +96,18 @@ module ActiveResource
           parse_related_link(object, assoc, related_link)
         end
       end
+      private_class_method :extract_foreign_keys!
 
-      def self.parse_data(object, assoc, data)
+      def parse_data(object, assoc, data)
         if data.is_a? Array
           object["#{assoc.singularize}_ids"] = data.map { |d| d['id'] }
         else
           object["#{assoc}_id"] = data['id']
         end
       end
+      private_class_method :parse_data
 
-      def self.parse_related_link(object, assoc, related_link)
+      def parse_related_link(object, assoc, related_link)
         # parse the url to get the id if the data node is not returned
         related_link.scan(%r{/(\d+)\.json$}) do |id|
           object["#{assoc}_id"] = id.first
@@ -111,8 +116,9 @@ module ActiveResource
         uri = URI.parse(related_link)
         object["#{assoc.singularize}_ids"] = Rack::Utils.parse_nested_query(CGI.unescape(uri.query)).fetch('filter', {}).fetch('id_in', []) if uri.query.present?
       end
+      private_class_method :parse_related_link
 
-      def self.merge_included_objects!(object, assoc, data, included)
+      def merge_included_objects!(object, assoc, data, included)
         return if included.blank?
         object[assoc] = case data
                         when Array
@@ -121,14 +127,16 @@ module ActiveResource
                           merge_nested_included_objects(object, [data], included).first
                         end
       end
+      private_class_method :merge_included_objects!
 
-      def self.merge_nested_included_objects(object, data, included)
+      def merge_nested_included_objects(object, data, included)
         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)
         assocs.map { |i| parse_object!(i, assoc_included) }
       end
+      private_class_method :merge_nested_included_objects
     end
   end
 end

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

@@ -27,7 +27,7 @@ module ActiveResource
     private
 
     def decoded_errors(json)
-      Array((Hash(ActiveSupport::JSON.decode(json)))['errors'])
+      Array(Hash(ActiveSupport::JSON.decode(json))['errors'])
     rescue
       []
     end

data/lib/esp/resources/alert.rb

@@ -133,12 +133,13 @@ module ESP
       suppress(Suppression::UniqueIdentifier, reason)
     end
 
-    private
-
     # Overridden because alerts does not use ransack for searching
     def self.filters(params)
       { filter: params }
     end
+    private_class_method :filters
+
+    private
 
     def suppress(klass, reason)
       fail ArgumentError, "You must specify the reason.".freeze unless reason.present?

data/lib/esp/resources/custom_signature/definition.rb

@@ -11,7 +11,7 @@ module ESP
         patch(:activate).tap do |response|
           load_attributes_from_response(response)
         end
-      rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess => error
+      rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess, ActiveResource::ForbiddenAccess => error
         load_remote_errors(error, true)
         self.code = error.response.code
         false
@@ -22,7 +22,7 @@ module ESP
         patch(:archive).tap do |response|
           load_attributes_from_response(response)
         end
-      rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess => error
+      rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess, ActiveResource::ForbiddenAccess => error
         load_remote_errors(error, true)
         self.code = error.response.code
         false

data/lib/esp/resources/dashboard.rb

@@ -16,11 +16,8 @@ module ESP
     # @return [void]
     def self.where(attrs)
       # when calling `recent.next_page` it will come into here
-      if attrs[:from].to_s.include?('recent')
-        super
-      else
-        fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled.  Use the .recent method.'
-      end
+      return super if attrs[:from].to_s.include?('recent')
+      fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled.  Use the .recent method.'
     end
 
     # Not Implemented. You cannot create or update a Dashboard.

data/lib/esp/resources/resource.rb

@@ -1,30 +1,30 @@
 module ESP
   # @private
   class Resource < ActiveResource::Base
-    self.site = ESP.site
-    self.proxy = ESP.http_proxy
+    self.site   = ESP.site
+    self.proxy  = ESP.http_proxy
     self.format = ActiveResource::Formats::JsonAPIFormat
     with_api_auth(ESP.access_key_id, ESP.secret_access_key)
     headers["Content-Type"] = format.mime_type
-    headers["User-Agent"] = "Ruby SDK #{ESP::VERSION}"
+    headers["User-Agent"]   = "Ruby SDK #{ESP::VERSION}"
 
     self.collection_parser = ActiveResource::PaginatedCollection
 
     # List of predicates that can be used for searching
-    PREDICATES = %w(sorts m eq eq_any eq_all not_eq not_eq_any not_eq_all matches matches_any matches_all does_not_match does_not_match_any does_not_match_all lt lt_any lt_all lteq lteq_any lteq_all gt gt_any gt_all gteq gteq_any gteq_all in in_any in_all not_in not_in_any not_in_all cont cont_any cont_all not_cont not_cont_any not_cont_all start start_any start_all not_start not_start_any not_start_all end end_any end_all not_end not_end_any not_end_all true false present blank null not_null).join('|').freeze
+    PREDICATES             = %w(sorts m eq eq_any eq_all not_eq not_eq_any not_eq_all matches matches_any matches_all does_not_match does_not_match_any does_not_match_all lt lt_any lt_all lteq lteq_any lteq_all gt gt_any gt_all gteq gteq_any gteq_all in in_any in_all not_in not_in_any not_in_all cont cont_any cont_all not_cont not_cont_any not_cont_all start start_any start_all not_start not_start_any not_start_all end end_any end_all not_end not_end_any not_end_all true false present blank null not_null).join('|').freeze
 
     # Pass a json api compliant hash to the api.
     def serializable_hash(*)
-      h = attributes.extract!('included')
-      h['data'] = { 'type' => self.class.to_s.underscore.sub('esp/', '').pluralize,
-                    'attributes' => changed_attributes.except('id', 'type', 'created_at', 'updated_at', 'relationships') }
+      h               = attributes.extract!('included')
+      h['data']       = { 'type'       => self.class.to_s.underscore.sub('esp/', '').pluralize,
+                          'attributes' => changed_attributes.except('id', 'type', 'created_at', 'updated_at', 'relationships') }
       h['data']['id'] = id if id.present?
       h
     end
 
     def self.where(clauses = {})
       fail ArgumentError, "expected a clauses Hash, got #{clauses.inspect}" unless clauses.is_a? Hash
-      from = clauses.delete(:from) || "#{prefix}#{name.demodulize.pluralize.underscore}"
+      from    = clauses.delete(:from) || "#{prefix}#{name.demodulize.pluralize.underscore}"
       clauses = { params: clauses }.with_indifferent_access
       arrange_options(clauses)
       prefix_options, query_options = split_options(clauses)
@@ -34,7 +34,7 @@ module ESP
     end
 
     def self.find(*arguments)
-      scope = arguments.slice!(0)
+      scope   = arguments.slice!(0)
       options = (arguments.slice!(0) || {}).with_indifferent_access
       arrange_options(options)
       super(scope, options).tap do |object|
@@ -63,22 +63,21 @@ module ESP
       return object unless object.is_a? ActiveResource::PaginatedCollection
       # Need to set from so paginated collection can use it for page calls.
       object.tap do |collection|
-        collection.from = options['from']
+        collection.from            = options['from']
         collection.original_params = options.fetch('params', {})
       end
     end
 
     def self.arrange_options(options)
       if options[:params].present?
-        page = options[:params][:page] ? { page: options[:params].delete(:page) } : {}
+        page    = options[:params][:page] ? { page: options[:params].delete(:page) } : {}
         include = options[:params][:include] ? { include: options[:params].delete(:include) } : {}
         options[:params].merge!(options[:params].delete(:filter)) if options[:params][:filter]
         options[:params] = filters(options[:params]).merge!(page).merge!(include)
       end
-      if options[:include].present?
-        options[:params] ||= {}
-        options[:params].merge!(options.extract!(:include))
-      end
+      return unless options[:include].present?
+      options[:params] ||= {}
+      options[:params].merge!(options.extract!(:include))
     end
   end
 end

data/lib/esp/resources/stat.rb

@@ -32,11 +32,8 @@ module ESP
     # @return [void]
     def self.where(attrs)
       # when calling `latest_for_teams.next_page` it will come into here
-      if attrs[:from].to_s.include?('latest_for_teams')
-        super
-      else
-        fail ESP::NotImplementedError
-      end
+      return super if attrs[:from].to_s.include?('latest_for_teams')
+      fail ESP::NotImplementedError
     end
 
     # Not Implemented. You cannot search for a Stat.

data/lib/esp/resources/suppression.rb

@@ -98,7 +98,7 @@ module ESP
       patch(:deactivate).tap do |response|
         load_attributes_from_response(response)
       end
-    rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess => error
+    rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::UnauthorizedAccess, ActiveResource::ForbiddenAccess => error
       load_remote_errors(error, true)
       self.code = error.response.code
       false

data/lib/esp/version.rb

@@ -1,3 +1,3 @@
 module ESP
-  VERSION = '2.7.0'.freeze
+  VERSION = '2.8.0'.freeze
 end

data/test/esp/integration/custom_signature_definition_integration_test.rb

@@ -53,7 +53,11 @@ module ESP::Integration
           should 'activate definition' do
             custom_signature = ESP::CustomSignature.last
             fail 'Missing custom signature' if custom_signature.blank?
-            definition = ESP::CustomSignature::Definition.create(custom_signature_id: custom_signature.id)
+            definition = custom_signature.definitions.last
+
+            if definition.blank? || definition.status != 'editable'
+              definition = ESP::CustomSignature::Definition.create(custom_signature_id: custom_signature.id)
+            end
 
             assert_equal 'editable', definition.status
 
@@ -67,6 +71,16 @@ module ESP::Integration
           should 'be able to create, update and destroy' do
             custom_signature = ESP::CustomSignature.last
             fail 'Missing custom signature' if custom_signature.blank?
+            old_definition = custom_signature.definitions.last
+
+            if old_definition.present? && old_definition.status == 'editable'
+              old_definition.destroy
+
+              assert_raises ActiveResource::ResourceNotFound do
+                ESP::CustomSignature::Definition.find(old_definition.id)
+              end
+            end
+
             definition = ESP::CustomSignature::Definition.new(custom_signature_id: custom_signature.id)
 
             assert_predicate definition, :new?

data/test/esp/integration/custom_signature_integration_test.rb

@@ -36,7 +36,9 @@ module ESP::Integration
 
         context '#CRUD' do
           should 'be able to create, update and destroy' do
-            custom_signature = ESP::CustomSignature.new(@custom_signature.attributes)
+            team = ESP::Team.last
+            assert_predicate team, :present?
+            custom_signature = ESP::CustomSignature.new(@custom_signature.attributes.merge(team_ids: [team.id]))
 
             assert_predicate custom_signature, :new?
 

data/test/esp/integration/custom_signature_result_alert_integration_test.rb

@@ -6,7 +6,7 @@ module ESP::Integration
       context 'live calls' do
         context '#for_result' do
           should 'return alerts' do
-            result = ESP::CustomSignature::Result.first
+            result = ESP::CustomSignature::Result.first(params: { sorts: 'id' })
             fail 'Missing result' if result.blank?
 
             alerts = ESP::CustomSignature::Result::Alert.for_result(result.id)
@@ -17,7 +17,7 @@ module ESP::Integration
 
         context '#custom_signature' do
           should 'return a custom_signature' do
-            result = ESP::CustomSignature::Result.first
+            result = ESP::CustomSignature::Result.first(params: { sorts: 'id' })
             fail 'Missing result' if result.blank?
             alert = ESP::CustomSignature::Result::Alert.for_result(result.id).first
 
@@ -30,7 +30,7 @@ module ESP::Integration
 
         context '#external_account' do
           should 'return a external_account' do
-            result = ESP::CustomSignature::Result.first
+            result = ESP::CustomSignature::Result.first(params: { sorts: 'id' })
             fail 'Missing result' if result.blank?
             alert = ESP::CustomSignature::Result::Alert.for_result(result.id).first
 
@@ -43,7 +43,7 @@ module ESP::Integration
 
         context '#region' do
           should 'return a region' do
-            result = ESP::CustomSignature::Result.first
+            result = ESP::CustomSignature::Result.first(params: { sorts: 'id' })
             fail 'Missing result' if result.blank?
             alert = ESP::CustomSignature::Result::Alert.for_result(result.id).first