esp_sdk 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee71a8ce107cfd0be1c552e60e32ea3637c21eaa
-  data.tar.gz: f4087d8db9e1affb4f96a1eceae43ba3211673bf
+  metadata.gz: 978cdf444e38c28c557b064ded697801588861b4
+  data.tar.gz: 002224323463cc5a0e8bd1a3199e578b35f076ba
 SHA512:
-  metadata.gz: b3f490d1f67a732b9b85daf1036d69af6b8295238ce9eb255b41f4fd10172106663e7e3bd7c7f45c7d0c12219b1a34bf68690bd0c12285c1cd25198fcf26aacd
-  data.tar.gz: 9ece944bf4867f36e4df3457e12c739b15d79dd0ebc729d9b5d2d47955e941b6b3e2042ef88a0fd9eec9fc35d77f052c113342bbbd06c346d1549dfcffb89f93
+  metadata.gz: 3cc050b808ce01966cb03aaa4919983c6fcc1126f618e463d9dce523d2d4e52eb7e1e48190b4728cefd13668d1f7eb6b8f9e4d379ffeae11d16775bb81a70f34
+  data.tar.gz: 424feda1ed42cc94e87203a9fa662a113ebcce8932209212c0048a738ddf23f7ecb1e03cf962ad758ea62dbbe88959a7785ceacd7b7f9a67f8bd9cf93942df2c

data/CHANGELOG.md

@@ -1,13 +1,24 @@
 ## Unreleased
+### Added
+- Users create/update/destroy support
+- Role all/find support
+
+### Fixed
+- Fix merge error when calling next_page on Stat.latest_for_teams
+- Fix incorrect page parameter on next_page for other endpoints
 
 ## 2.6.0 - 2016-10-17
-### Changed
+### Added
 - 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
+
+### Changed
 - Switch from RDoc to Yard. #37
 
+### Fixed
+- API now returns nested included relation data elements correctly. #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. #36
+
 ## 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.6.0)
+    esp_sdk (2.7.0)
       activeresource (~> 4.0.0)
       api-auth (~> 2.0.0)
       rack

data/lib/esp/resources/dashboard.rb

@@ -14,8 +14,13 @@ module ESP
     # Regular ARELlike methods are disabled.
     #
     # @return [void]
-    def self.where(*)
-      fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled.  Use the .recent method.'
+    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
     end
 
     # Not Implemented. You cannot create or update a Dashboard.
@@ -38,7 +43,7 @@ module ESP
     # @return [ESP::Dashboard]
     def self.recent
       # call find_every directly since find is overridden/not implemented
-      find_every from: "#{prefix}dashboard/recent.#{format.extension}"
+      where from: "#{prefix}dashboard/recent"
     end
   end
 end

data/lib/esp/resources/region.rb

@@ -1,13 +1,13 @@
 module ESP
   class Region < ESP::Resource
-    # Not Implemented. You cannot create or update a CloudTrailEvent.
+    # Not Implemented. You cannot create or update a Region.
     #
     # @return [void]
     def save
       fail ESP::NotImplementedError
     end
 
-    # Not Implemented. You cannot destroy a an CloudTrailEvent.
+    # Not Implemented. You cannot destroy a Region.
     #
     # @return [void]
     def destroy

data/lib/esp/resources/resource.rb

@@ -25,7 +25,7 @@ module ESP
     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}"
-      clauses = { params: clauses }
+      clauses = { params: clauses }.with_indifferent_access
       arrange_options(clauses)
       prefix_options, query_options = split_options(clauses)
       instantiate_collection((format.decode(connection.put("#{from}.json", clauses[:params].to_json).body) || []), query_options, prefix_options).tap do |collection|

data/lib/esp/resources/role.rb

@@ -0,0 +1,37 @@
+module ESP
+  class Role < ESP::Resource
+    # Not Implemented. You cannot create or update a Role.
+    #
+    # @return [void]
+    def save
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy a Role.
+    #
+    # @return [void]
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot search for a Role.
+    #
+    # @return [void]
+    def self.where(*)
+      fail ESP::NotImplementedError
+    end
+
+    # @!method self.find(id)
+    #   Find a Region by id
+    #
+    #   *call-seq* -> +super.find(id)+
+    #
+    #   @param id [Integer, Numeric, #to_i] Required ID of the region to retrieve.
+    #   @return [ESP::Region]
+
+    # @!method self.all
+    #   Return a paginated list.
+    #
+    #   @return [ActiveResource::PaginatedCollection<ESP::Region>]
+  end
+end

data/lib/esp/resources/stat.rb

@@ -30,8 +30,13 @@ module ESP
     # Not Implemented. You cannot search for a Stat.
     #
     # @return [void]
-    def self.where(*)
-      fail ESP::NotImplementedError
+    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
     end
 
     # Not Implemented. You cannot search for a Stat.
@@ -82,7 +87,7 @@ module ESP
     # @return [ActiveResource::PaginatedCollection<ESP::Stat>]
     def self.latest_for_teams
       # call find_every directly since find is overriden/not implemented
-      find_every(from: :latest_for_teams)
+      where(from: "#{prefix}stats/latest_for_teams")
     end
 
     # @!group 'total' rollup methods

data/lib/esp/resources/user.rb

@@ -5,19 +5,10 @@ module ESP
     # @return [ESP::Organization]
     belongs_to :organization, class_name: 'ESP::Organization'
 
-    # Not Implemented. You cannot create or update a User.
+    # The role assigned to this user.
     #
-    # @return [void]
-    def save
-      fail ESP::NotImplementedError
-    end
-
-    # Not Implemented. You cannot destroy a User.
-    #
-    # @return [void]
-    def destroy
-      fail ESP::NotImplementedError
-    end
+    # @return [ESP::Role]
+    belongs_to :role, class_name: 'ESP::Role'
 
     # The collection of sub organizations that belong to the user.
     #
@@ -67,9 +58,33 @@ module ESP
     #
     #   @return [ActiveResource::PaginatedCollection<ESP::User>]
 
-    # @!method self.create
-    #   Not Implemented. You cannot create a User.
+    # @!method self.create(attributes = {})
+    #   Create a User.
+    #   *call-seq* -> +super.create(attributes={})+
+    #
+    #   @param attributes [Hash] Required hash of user attributes.
+    #     ===== Valid Attributes
+    #
+    #     See {API documentation}[http://api-docs.evident.io?ruby#user-create] for valid arguments
+    #   @return [ESP::User]
+    #   @example
+    #     user = ESP::User.create(first_name: 'John', last_name: 'Doe', email: "test@email.com")
+
+    # @!method save
+    #   Create and update a User.
+    #
+    #   ===== Valid Attributes
+    #
+    #   See {API documentation}[http://api-docs.evident.io?ruby#user-create] for valid arguments
+    #
+    #   @return [Boolean]
+    #   @example
+    #     user = ESP::User.new(first_name: 'John', last_name: 'Doe', email: "test@email.com")
+    #     user.save
+
+    # @!method destroy
+    #   Delete a User.
     #
-    #   @return [void]
+    #   @return [self]
   end
 end

data/lib/esp/version.rb

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

data/lib/esp.rb

@@ -124,6 +124,7 @@ module ESP
   autoload :Metadata, File.expand_path(File.dirname(__FILE__) + '/esp/resources/metadata')
   autoload :Tag, File.expand_path(File.dirname(__FILE__) + '/esp/resources/tag')
   autoload :Region, File.expand_path(File.dirname(__FILE__) + '/esp/resources/region')
+  autoload :Role, File.expand_path(File.dirname(__FILE__) + '/esp/resources/role')
   autoload :Suppression, File.expand_path(File.dirname(__FILE__) + '/esp/resources/suppression')
   autoload :Stat, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat')
   autoload :StatCustomSignature, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat_custom_signature')

data/test/esp/extensions/active_resource/formats/json_api_format_test.rb

@@ -9,7 +9,7 @@ module ActiveResource
             should 'parse nested objects correctly' do
               json        = json(:dashboard)
               parsed_json = JSON.parse(json)
-              stub_request(:get, %r{dashboard/recent.json*}).to_return(body: json_list(:dashboard, 1))
+              stub_request(:put, %r{dashboard/recent*}).to_return(body: json_list(:dashboard, 1))
 
               dashboard = ESP::Dashboard.recent
 

data/test/esp/integration/role_integration_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP::Integration
+  class RoleTest < ESP::Integration::TestCase
+    context ESP::Role do
+      context 'live calls' do
+        setup do
+          @role = ESP::Role.last
+          fail "Live DB does not have any roles.  Add a role and run tests again." if @role.blank?
+        end
+
+        context '#CRUD' do
+          should 'be able to read' do
+            assert_not_nil @role
+
+            role = ESP::Role.find(@role.id)
+
+            assert_not_nil role
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/integration/user_integration_test.rb

@@ -41,6 +41,14 @@ module ESP::Integration
           end
         end
 
+        context '#role' do
+          should 'return an role' do
+            role = @user.role
+
+            assert_equal @user.role_id, role.id
+          end
+        end
+
         context '.where' do
           should 'return user objects' do
             users = ESP::User.where(id_eq: @user.id)
@@ -48,6 +56,31 @@ module ESP::Integration
             assert_equal ESP::User, users.resource_class
           end
         end
+
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            user = ESP::User.new(first_name: 'Bob', last_name: 'Belcher', email: 'burgerboss@gmail.com', organization_id: 1)
+
+            assert_predicate user, :new?
+
+            user.save
+
+            refute_predicate user, :new?
+
+            user.first_name = 'Gene'
+            user.save
+
+            assert_nothing_raised do
+              ESP::User.find(user.id)
+            end
+
+            user.destroy
+
+            assert_raises ActiveResource::ResourceNotFound do
+              ESP::User.find(user.id)
+            end
+          end
+        end
       end
     end
   end

data/test/esp/resources/dashboard_test.rb

@@ -47,13 +47,26 @@ module ESP
 
       context '.recent' do
         should 'call the api and return an array of dashboard objects' do
-          stubbed_dashboard = stub_request(:get, %r{dashboard/recent.json*}).to_return(body: json_list(:dashboard, 2))
+          stubbed_dashboard = stub_request(:put, %r{dashboard/recent*}).to_return(body: json_list(:dashboard, 2))
 
           dashboard = ESP::Dashboard.recent
 
           assert_requested(stubbed_dashboard)
           assert_equal ESP::Dashboard, dashboard.resource_class
         end
+
+        context 'next_page' do
+          should 'request page 2 when multiple dashboards' do
+            stub_dashboard = stub_request(:put, %r{dashboard/recent*}).with(body: {}.to_json).to_return(body: json_list(:dashboard, 25))
+            stub_dashboard2 = stub_request(:put, %r{dashboard/recent*}).with(body: { filter: {}, page: { number: '2', size: '20' } }.to_json).to_return(body: json_list(:stat, 2))
+
+            dashboard = ESP::Dashboard.recent
+            dashboard.next_page
+
+            assert_requested(stub_dashboard)
+            assert_requested(stub_dashboard2)
+          end
+        end
       end
     end
   end

data/test/esp/resources/resource_test.rb

@@ -149,6 +149,17 @@ module ESP
 
             assert_equal '/api/v2/teams.json', teams.from
           end
+
+          should 'request next_page with page parameters' do
+            get_request = stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 25))
+            next_page_request = stub_request(:put, /teams.json*/).with(body: { filter: {}, page: { number: '2', size: '20' } }.to_json).to_return(body: json_list(:team, 25))
+
+            teams = ESP::Team.all
+            teams.next_page
+
+            assert_requested(get_request)
+            assert_requested(next_page_request)
+          end
         end
 
         context '.where' do

data/test/esp/resources/role_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class RoleTest < ActiveSupport::TestCase
+    context ESP::Role do
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Role.create(name: 'test')
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          role = build(:role)
+          assert_raises ESP::NotImplementedError do
+            role.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          role = build(:role)
+          assert_raises ESP::NotImplementedError do
+            role.destroy
+          end
+        end
+      end
+
+      context '.find' do
+        should 'call the show api and return a role if searching by id' do
+          stub_role = stub_request(:get, %r{roles/5.json*}).to_return(body: json(:role))
+
+          role = ESP::Role.find(5)
+
+          assert_requested(stub_role)
+          assert_equal ESP::Role, role.class
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/stat_test.rb

@@ -122,13 +122,26 @@ module ESP
 
       context '.latest_for_teams' do
         should 'call the api and return a collection of stats' do
-          stub_stat = stub_request(:get, %r{stats/latest_for_teams.json*}).to_return(body: json_list(:stat, 2))
+          stub_stat = stub_request(:put, %r{stats/latest_for_teams*}).to_return(body: json_list(:stat, 2))
 
           stats = ESP::Stat.latest_for_teams
 
           assert_requested(stub_stat)
           assert_equal ESP::Stat, stats.resource_class
         end
+
+        context 'next_page' do
+          should 'request page 2 when multiple stats' do
+            stub_stat = stub_request(:put, %r{stats/latest_for_teams*}).with(body: {}.to_json).to_return(body: json_list(:stat, 25))
+            stub_stat2 = stub_request(:put, %r{stats/latest_for_teams*}).with(body: { filter: {}, page: { number: '2', size: '20' } }.to_json).to_return(body: json_list(:stat, 2))
+
+            stats = ESP::Stat.latest_for_teams
+            stats.next_page
+
+            assert_requested(stub_stat)
+            assert_requested(stub_stat2)
+          end
+        end
       end
     end
   end

data/test/esp/resources/suppression_test.rb

@@ -6,25 +6,25 @@ module ESP
       context '#create' do
         should 'not be implemented' do
           assert_raises ESP::NotImplementedError do
-            ESP::User.create(name: 'test')
+            ESP::Suppression.create(reason: 'test')
           end
         end
       end
 
       context '#update' do
         should 'not be implemented' do
-          u = build(:user)
+          s = build(:suppression)
           assert_raises ESP::NotImplementedError do
-            u.save
+            s.save
           end
         end
       end
 
       context '#destroy' do
         should 'not be implemented' do
-          u = build(:user)
+          s = build(:suppression)
           assert_raises ESP::NotImplementedError do
-            u.destroy
+            s.destroy
           end
         end
       end

data/test/esp/resources/user_test.rb

@@ -3,32 +3,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 module ESP
   class UserTest < ActiveSupport::TestCase
     context ESP::User do
-      context '#create' do
-        should 'not be implemented' do
-          assert_raises ESP::NotImplementedError do
-            ESP::User.create(name: 'test')
-          end
-        end
-      end
-
-      context '#update' do
-        should 'not be implemented' do
-          u = build(:user)
-          assert_raises ESP::NotImplementedError do
-            u.save
-          end
-        end
-      end
-
-      context '#destroy' do
-        should 'not be implemented' do
-          u = build(:user)
-          assert_raises ESP::NotImplementedError do
-            u.destroy
-          end
-        end
-      end
-
       context '#organization' do
         should 'call the api' do
           u = build(:user, organization_id: 1)
@@ -91,6 +65,17 @@ module ESP
           assert_not_requested(:put, /teams.json*/)
         end
       end
+
+      context '#role' do
+        should 'call the api' do
+          u = build(:user, role_id: 1)
+          stub_role = stub_request(:get, %r{roles/#{u.role_id}.json*}).to_return(body: json(:role))
+
+          u.role
+
+          assert_requested(stub_role)
+        end
+      end
     end
   end
 end

data/test/factories/roles.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :role, class: 'ESP::Role' do
+    skip_create
+
+    sequence(:id) { |n| n }
+    type "roles"
+    name "customer"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esp_sdk
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Evident.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -357,6 +357,7 @@ files:
 - lib/esp/resources/report.rb
 - lib/esp/resources/reports/export/integration.rb
 - lib/esp/resources/resource.rb
+- lib/esp/resources/role.rb
 - lib/esp/resources/scan_interval.rb
 - lib/esp/resources/service.rb
 - lib/esp/resources/signature.rb
@@ -400,6 +401,7 @@ files:
 - test/esp/integration/report_export_integration_integration_test.rb
 - test/esp/integration/report_integration_test.rb
 - test/esp/integration/resource_integration_test.rb
+- test/esp/integration/role_integration_test.rb
 - test/esp/integration/scan_interval_integration_test.rb
 - test/esp/integration/service_integration_test.rb
 - test/esp/integration/signature_integration_test.rb
@@ -432,6 +434,7 @@ files:
 - test/esp/resources/report_test.rb
 - test/esp/resources/reports/export/integration_test.rb
 - test/esp/resources/resource_test.rb
+- test/esp/resources/role_test.rb
 - test/esp/resources/scan_interval_test.rb
 - test/esp/resources/service_test.rb
 - test/esp/resources/signature_test.rb
@@ -463,6 +466,7 @@ files:
 - test/factories/organizations.rb
 - test/factories/regions.rb
 - test/factories/reports.rb
+- test/factories/roles.rb
 - test/factories/scan_intervals.rb
 - test/factories/services.rb
 - test/factories/signatures.rb
@@ -502,7 +506,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: SDK for interacting with the ESP API.
@@ -530,6 +534,7 @@ test_files:
 - test/esp/integration/report_export_integration_integration_test.rb
 - test/esp/integration/report_integration_test.rb
 - test/esp/integration/resource_integration_test.rb
+- test/esp/integration/role_integration_test.rb
 - test/esp/integration/scan_interval_integration_test.rb
 - test/esp/integration/service_integration_test.rb
 - test/esp/integration/signature_integration_test.rb
@@ -562,6 +567,7 @@ test_files:
 - test/esp/resources/report_test.rb
 - test/esp/resources/reports/export/integration_test.rb
 - test/esp/resources/resource_test.rb
+- test/esp/resources/role_test.rb
 - test/esp/resources/scan_interval_test.rb
 - test/esp/resources/service_test.rb
 - test/esp/resources/signature_test.rb
@@ -593,6 +599,7 @@ test_files:
 - test/factories/organizations.rb
 - test/factories/regions.rb
 - test/factories/reports.rb
+- test/factories/roles.rb
 - test/factories/scan_intervals.rb
 - test/factories/services.rb
 - test/factories/signatures.rb