esp_sdk 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eec3d492b1abf2d98d6bbf35c1f88a90c5e2b602
-  data.tar.gz: f51d254cdef908e29b311ac812cf2654e14e1b8a
+  metadata.gz: 8ba33c6b2844803fe17abc39fd0f2ecfdd3c86c3
+  data.tar.gz: a9f51f6b6e0abd70064f0de21ea5b365b69b2acf
 SHA512:
-  metadata.gz: 7edfbd88ee1b306daba55f035da060d5b63eb22c4a3d37d7bc09f6d95b20c510df7756edb8b74f5f18ba1325bbc62929052e4486fb3db26304c3aceba0633981
-  data.tar.gz: 1ba56c34e806fe32835db2dc32339d3802f3b830ea3dd9021e470ceab3a223a063107fa8566ec1658883d4d4dd2759be3be3f902982f91d7148c55aea797b69c
+  metadata.gz: 15e6201640405e7dd7031147e38ff2342da257eba8ef8fd1d7a6e556f0eaf5c740c6953a2ab67522135e5cdbf57b6deed910551c302b325543d80890a3972b7b
+  data.tar.gz: 76c3758314ca2ff6121c25305fcb8151197293a3093dd115f9b13eca919b838e995b1027fee46678b5c6ea9f196c25f0115efbdf7b5f83110f7108ac2cd24dbd

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## 2.1.0 - 2015-01-15
+## 2.2.0 - 2016-03-2
+### Added
+- Added the ESP::ScanInterval object to use the new scan interval endpoint on the API
+
+## 2.1.0 - 2016-02-10
 ### Added
 - Implemented searching using `where` on many object.
 - Add external account script.  Run with `esp a`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esp_sdk (2.1.0)
+    esp_sdk (2.2.0)
       activeresource (~> 4.0.0)
       api-auth
       rack

data/README.md

@@ -206,7 +206,7 @@ The methods with a `!` suffix update the object, methods without the `!` suffix
 original object.
 
 ```ruby
-espsdk:004:0> alerts = ESP::Alert.for_report(345)
+espsdk:004:0> alerts = ESP::Alert.where(report_id: 345)
 espsdk:004:0> alerts.current_page_number # => "1"
 espsdk:004:0> page2 = alerts.next_page
 espsdk:004:0> alerts.current_page_number # => "1"
@@ -279,15 +279,6 @@ ESP::Signature.where(name_cont: 'dns')
 #=> will return signatures `where name LIKE '%dns%'`
 ```
 
-### OR Conditions
-
-You can also combine predicates for OR queries:
-
-```ruby
-ESP::Signature.where(name_or_description_cont: 'dns')
-#=> will return signatures `where name LIKE '%dns%' or description LIKE '%dns%'`
-```
-
 ### Conditions on Relationships
 
 The syntax for queries on an associated relationship is to just append the association name to the attribute:
@@ -459,7 +450,7 @@ ESP::Signature.where(identifier_null: 1)
 Lists can also be sorted by adding the `sorts` parameter with the field to sort by to the `filter` parameter.
 
 ```ruby
-ESP::Signature.where(name_cont: 'dns', sort: 'risk_level desc')
+ESP::Signature.where(name_cont: 'dns', sorts: 'risk_level desc')
 #=> will return signatures `where name LIKE '%dns%'` sorted by `risk_level` in descending order.
 ```
 

data/lib/esp/resources/external_account.rb

@@ -24,6 +24,16 @@ module ESP
       super
     end
 
+    # Returns a collection of scan_intervals for the external account
+    #
+    # ==== Example
+    #
+    #   external_account = ESP::ExternalAccount.find(345)
+    #   scan_intervals = external_account.scan_intervals
+    def scan_intervals
+      ESP::ScanInterval.for_external_account(id)
+    end
+
     # :singleton-method: where
     # Return a paginated ExternalAccount list filtered by search parameters
     #

data/lib/esp/resources/scan_interval.rb

@@ -0,0 +1,46 @@
+module ESP
+  class ScanInterval < ESP::Resource
+    ##
+    # The external account the scan interval belongs to
+    belongs_to :external_account, class_name: 'ESP::ExternalAccount'
+
+    ##
+    # The service the scan interval belongs to
+    belongs_to :service, class_name: 'ESP::Service'
+
+    # Find a Scan Interval by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the scan interval to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+    def self.find(*arguments)
+      scope = arguments.slice!(0)
+      options = (arguments.slice!(0) || {}).with_indifferent_access
+      # If the first option is a number, we are looking for a specific object.
+      # Otherwise `all` calls this with either nil, or a hash of arguments, and we need
+      # to use our custom finder to use the correct URL
+      return super(scope, options) if scope.is_a?(Numeric) || options[:from].present?
+      params = options.fetch(:params, {}).with_indifferent_access
+      external_account_id = params.delete(:external_account_id)
+      for_external_account(external_account_id)
+    end
+
+    # Returns a collection of scan_intervals for the given external_account_id
+    # Convenience method to use instead of ::find since a external_account_id is required to return alerts.
+    #
+    # ==== Parameters
+    #
+    # +external_account_id+ | Required | The ID of the external account to retrieve scan intervals for
+    #
+    # ==== Example
+    #   alerts = ESP::ScanInterval.for_external_account(54)
+    def self.for_external_account(external_account_id = nil)
+      fail ArgumentError, "You must supply an external account id." unless external_account_id.present?
+      from = "#{prefix}external_accounts/#{external_account_id}/scan_intervals.json"
+      all(from: from)
+    end
+  end
+end

data/lib/esp/version.rb

@@ -1,3 +1,3 @@
 module ESP
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

data/lib/esp.rb

@@ -92,6 +92,7 @@ module ESP
   autoload :User, File.expand_path(File.dirname(__FILE__) + '/esp/resources/user')
   autoload :Signature, File.expand_path(File.dirname(__FILE__) + '/esp/resources/signature')
   autoload :CustomSignature, File.expand_path(File.dirname(__FILE__) + '/esp/resources/custom_signature')
+  autoload :ScanInterval, File.expand_path(File.dirname(__FILE__) + '/esp/resources/scan_interval')
   autoload :Service, File.expand_path(File.dirname(__FILE__) + '/esp/resources/service')
   autoload :Alert, File.expand_path(File.dirname(__FILE__) + '/esp/resources/alert')
   autoload :RawAlert, File.expand_path(File.dirname(__FILE__) + '/esp/resources/raw_alert')

data/test/esp/resources/external_account_test.rb

@@ -36,6 +36,17 @@ module ESP
         end
       end
 
+      context '#scan_intervals' do
+        should 'call the api for the external_account and the passed in params' do
+          external_account = build(:external_account)
+          stub_request(:get, %r{external_accounts/#{external_account.id}/scan_intervals.json*}).to_return(body: json_list(:scan_interval, 2))
+
+          external_account.scan_intervals
+
+          assert_requested(:get, %r{external_accounts/#{external_account.id}/scan_intervals.json*})
+        end
+      end
+
       context '#create' do
         should "use the external_id in the params if supplied" do
           stub_request(:post, /external_accounts.json*/).to_return(body: json(:external_account))

data/test/esp/resources/scan_interval_test.rb

@@ -0,0 +1,124 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class ScanIntervalTest < ActiveSupport::TestCase
+    context ESP::ScanInterval do
+      context '#external_account' do
+        should 'call the api' do
+          scan_interval = build(:scan_interval, external_account_id: 4)
+          stub_account = stub_request(:get, %r{external_accounts/#{scan_interval.external_account_id}.json*}).to_return(body: json(:external_account))
+
+          scan_interval.external_account
+
+          assert_requested(stub_account)
+        end
+      end
+
+      context '#service' do
+        should 'call the api' do
+          scan_interval = build(:scan_interval, service_id: 4)
+          stub_service = stub_request(:get, %r{services/#{scan_interval.service_id}.json*}).to_return(body: json(:service))
+
+          scan_interval.service
+
+          assert_requested(stub_service)
+        end
+      end
+
+      context '.for_external_account' do
+        should 'throw an error if report_id is not supplied' do
+          error = assert_raises ArgumentError do
+            ESP::ScanInterval.for_external_account
+          end
+          assert_equal 'You must supply an external account id.', error.message
+        end
+
+        should 'call the api and pass params' do
+          stub_request(:get, %r{external_accounts/5/scan_intervals.json*}).to_return(body: json_list(:scan_interval, 2))
+
+          intervals = ESP::ScanInterval.for_external_account(5)
+
+          assert_requested(:get, %r{external_accounts/5/scan_intervals.json*})
+          assert_equal ESP::ScanInterval, intervals.resource_class
+        end
+      end
+
+      context '.find' do
+        should 'throw an error if external_account_id is not supplied' do
+          error = assert_raises ArgumentError do
+            ESP::ScanInterval.find(:all, params: { id: 3 })
+          end
+          assert_equal 'You must supply an external account id.', error.message
+        end
+
+        should 'call the show api and return an alert if searching by id' do
+          stub_scan_interval = stub_request(:get, %r{scan_intervals/5.json*}).to_return(body: json(:scan_interval))
+
+          scan_interval = ESP::ScanInterval.find(5)
+
+          assert_requested(stub_scan_interval)
+          assert_equal ESP::ScanInterval, scan_interval.class
+        end
+
+        should 'call the api and return scan_intervals when external_account_id is supplied' do
+          stub_scan_interval = stub_request(:get, %r{external_accounts/5/scan_intervals.json*}).to_return(body: json_list(:scan_interval, 2))
+
+          scan_interval = ESP::ScanInterval.find(:all, params: { external_account_id: 5 })
+
+          assert_requested(stub_scan_interval)
+          assert_equal ESP::ScanInterval, scan_interval.resource_class
+        end
+      end
+
+      context 'live calls' do
+        setup do
+          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
+          WebMock.allow_net_connect!
+          @external_account = ESP::ExternalAccount.last
+          @service = ESP::Service.last
+          skip "Live DB does not have any external_accounts.  Add an external_account and run tests again." if @external_account.blank?
+          skip "Live DB does not have any services.  Add an service and run tests again." if @service.blank?
+        end
+
+        teardown do
+          # destroy record incase of failure
+          @scan_interval.destroy rescue nil # rubocop:disable Style/RescueModifier
+          WebMock.disable_net_connect!
+        end
+
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            @scan_interval = ESP::ScanInterval.new(interval: 15, service_id: @service.id, external_account_id: @external_account.id)
+
+            # Create
+            assert_predicate @scan_interval, :new?
+            @scan_interval.save
+            refute_predicate @scan_interval, :new?
+
+            # Update
+            @scan_interval.interval = 30
+            @scan_interval.save
+            assert_nothing_raised do
+              ESP::ScanInterval.find(@scan_interval.id.to_i)
+            end
+
+            # Service Relationship
+            service = @scan_interval.service
+            assert_equal service.id, @service.id
+
+            # External Account Relationship
+            external_account = @scan_interval.external_account
+            assert_equal external_account.id, @external_account.id
+
+            # Destroy
+            @scan_interval.destroy
+
+            assert_raises ActiveResource::ResourceNotFound do
+              ESP::ScanInterval.find(@scan_interval.id.to_i)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/factories/scan_intervals.rb

@@ -0,0 +1,32 @@
+FactoryGirl.define do
+  factory :scan_interval, class: 'ESP::ScanInterval' do
+    skip_create
+
+    sequence(:id) { |n| n }
+    type "scan_intervals"
+    interval 15
+    created_at { Time.current }
+    updated_at { Time.current }
+    relationships do
+      { external_account: {
+        data: {
+          type: "external_accounts",
+          id: "1"
+        },
+        links: {
+          related: "http://localhost:3000/api/v2/external_accounts/1.json"
+        }
+      },
+        service: {
+          data: {
+            type: "services",
+            id: "1"
+          },
+          links: {
+            related: "http://localhost:3000/api/v2/services/1.json"
+          }
+        }
+      }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esp_sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Evident.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -337,6 +337,7 @@ files:
 - lib/esp/resources/region.rb
 - lib/esp/resources/report.rb
 - lib/esp/resources/resource.rb
+- lib/esp/resources/scan_interval.rb
 - lib/esp/resources/service.rb
 - lib/esp/resources/signature.rb
 - lib/esp/resources/stat.rb
@@ -372,6 +373,7 @@ files:
 - test/esp/resources/region_test.rb
 - test/esp/resources/report_test.rb
 - test/esp/resources/resource_test.rb
+- test/esp/resources/scan_interval_test.rb
 - test/esp/resources/service_test.rb
 - test/esp/resources/signature_test.rb
 - test/esp/resources/stat_custom_signature_test.rb
@@ -399,6 +401,7 @@ files:
 - test/factories/organizations.rb
 - test/factories/regions.rb
 - test/factories/reports.rb
+- test/factories/scan_intervals.rb
 - test/factories/services.rb
 - test/factories/signatures.rb
 - test/factories/stat_custom_signatures.rb
@@ -457,6 +460,7 @@ test_files:
 - test/esp/resources/region_test.rb
 - test/esp/resources/report_test.rb
 - test/esp/resources/resource_test.rb
+- test/esp/resources/scan_interval_test.rb
 - test/esp/resources/service_test.rb
 - test/esp/resources/signature_test.rb
 - test/esp/resources/stat_custom_signature_test.rb
@@ -484,6 +488,7 @@ test_files:
 - test/factories/organizations.rb
 - test/factories/regions.rb
 - test/factories/reports.rb
+- test/factories/scan_intervals.rb
 - test/factories/services.rb
 - test/factories/signatures.rb
 - test/factories/stat_custom_signatures.rb