esp_sdk 1.0.0

data/test/esp_sdk/configure_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class ConfigureTest < ActiveSupport::TestCase
+  context 'Configure' do
+    setup do
+      # Stub the setup token method
+      EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
+      @config = EspSdk::Configure.new({email: 'test@test.com', token: 'token'})
+    end
+
+    context '#initialize' do
+      should 'set a default version of v1' do
+        assert_equal 'v1', @config.version
+      end
+    end
+
+    context '#uri' do
+      should 'return the production URI when the environment is production' do
+        EspSdk.expects(:production?).returns(true)
+        assert_equal 'https://api.evident.io/api', @config.uri
+      end
+
+      should 'return the release URI when the environment is release' do
+        EspSdk.expects(:production?).returns(false)
+        EspSdk.expects(:release?).returns(true)
+        assert_equal 'https://api-rel.evident.io/api', @config.uri
+      end
+
+      should 'return the development URI when the environment is not release or production' do
+        EspSdk.expects(:production?).returns(false)
+        EspSdk.expects(:release?).returns(false)
+        assert_equal 'http://0.0.0.0:3001/api', @config.uri
+      end
+    end
+
+    context '#token_setup' do
+      setup { EspSdk::Configure.any_instance.unstub(:token_setup) }
+
+      should 'should set the token and token and expires at' do
+        FakeWeb.register_uri(:get, /api\/v1\/token\/new/,
+                             :body => { authentication_token: 'token',
+                                        token_expires_at: 1.hour.from_now }.to_json)
+        @config.send(:token_setup, { password: 'password1234' })
+        assert_not_nil @config.token
+        assert_not_nil @config.token_expires_at
+      end
+    end
+  end
+end

data/test/esp_sdk/end_points/base_test.rb

@@ -0,0 +1,175 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class BaseTest < ActiveSupport::TestCase
+  context 'Base' do
+    setup do
+      # Stub the token setup for our configuration object
+      EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
+      @config = EspSdk::Configure.new(email: 'test@evident.io')
+      @base   = EspSdk::EndPoints::Base.new(@config)
+    end
+
+    context '#next_page' do
+      setup do
+        # Setup fakeweb
+        FakeWeb.register_uri(:get, /api\/v1\/base/,
+                             :body => { stub: 'Stub' }.to_json)
+      end
+
+      should 'call list if @current_page is blank' do
+        @base.expects(:list)
+        @base.next_page
+      end
+
+      should "return the current page if @page_links['links']' are blank" do
+        @base.expects(:current_page)
+        @base.next_page
+      end
+    end
+
+    context '#prev_page' do
+      setup do
+        # Setup fakeweb
+        FakeWeb.register_uri(:get, /api\/v1\/base/,
+                             :body => { stub: 'Stub' }.to_json)
+      end
+
+      should 'call list if @current_page is blank' do
+        @base.expects(:list)
+        @base.prev_page
+      end
+
+      should "return the current page if @page_links['links']' are blank" do
+        @base.expects(:current_page)
+        @base.prev_page
+      end
+    end
+
+    context '#list' do
+      setup do
+        # Setup fakeweb
+         FakeWeb.register_uri(:get, /api\/v1\/base/,
+                             :body => { stub: 'Stub' }.to_json)
+      end
+
+      should 'set the current page and setup link pagination' do
+        @base.expects(:pagination_links)
+        response = @base.list
+        assert response.key?('stub')
+        assert_equal response, @base.current_page
+      end
+    end
+
+    context '#show' do
+      setup do
+        # Setup fakeweb
+        FakeWeb.register_uri(:get, /api\/v1\/base\/1/,
+                             :body => { stub: 'Stub' }.to_json)
+      end
+
+      should 'call validate id and return the stub response, and set the current_record' do
+        payload = { id: 1 }
+        @base.expects(:validate_id).with(payload)
+        response = @base.show(payload)
+        assert response.key?('stub')
+        assert_equal response, @base.current_record
+      end
+    end
+
+    context '#update' do
+      setup do
+        # Setup fakeweb
+        FakeWeb.register_uri(:get, /api\/v1\/base\/1/,
+                             :body => { stub: 'Stub' }.to_json)
+      end
+
+      should 'call validate id and return the stub response, and set the current_record' do
+        payload = { id: 1, name: 'Test' }
+        @base.expects(:validate_id).with(payload)
+        response = @base.show(payload)
+        assert response.key?('stub')
+        assert_equal response, @base.current_record
+      end
+    end
+
+    context '#destroy' do
+      setup do
+        # Setup fakeweb
+        FakeWeb.register_uri(:get, /api\/v1\/base\/1/,
+                             :body => { success: 'Stub has been destroyed' }.to_json)
+      end
+
+      should 'call validate id and return the stub response, and set the current_record' do
+        payload = { id: 1 }
+        @base.expects(:validate_id).with(payload)
+        response = @base.show(payload)
+        assert response.key?('success')
+        assert_equal response, @base.current_record
+      end
+    end
+
+    context '#validate_id' do
+      should 'return nil when an ID is present' do
+        assert_nil @base.send(:validate_id, { id: 1 })
+      end
+
+      should 'raise EspSdk::MissingAttribute for a missing id' do
+        e = assert_raises EspSdk::MissingAttribute do
+          @base.send(:validate_id, {})
+        end
+
+        assert_equal 'Missing required attribute id', e.message
+      end
+    end
+
+    context '#id_url' do
+      should 'return a valid id url for the test environment' do
+        # Test through a different endpoint to get a valid URL
+        EspSdk.instance_variable_set(:@env, :development)
+        external_account = EspSdk::EndPoints::ExternalAccounts.new(@config)
+        assert_equal 'http://0.0.0.0:3001/api/v1/external_accounts/1', external_account.send(:id_url, 1)
+      end
+
+      should 'return a valid id url for the release environment' do
+        EspSdk.instance_variable_set(:@env, :release)
+        config = EspSdk::Configure.new(email: 'test@evident.io')
+        # Test through a different endpoint to get a valid URL
+        external_account = EspSdk::EndPoints::ExternalAccounts.new(config)
+        assert_equal 'https://api-rel.evident.io/api/v1/external_accounts/1', external_account.send(:id_url, 1)
+      end
+
+      should 'return a valid id url for the production environment' do
+        EspSdk.instance_variable_set(:@env, :production)
+        config = EspSdk::Configure.new(email: 'test@evident.io')
+        # Test through a different endpoint to get a valid URL
+        external_account = EspSdk::EndPoints::ExternalAccounts.new(config)
+        assert_equal 'https://api.evident.io/api/v1/external_accounts/1', external_account.send(:id_url, 1)
+      end
+    end
+
+    context '#base_url' do
+      should 'return a valid base url for the development environment' do
+        # Test through a different endpoint to get a valid URL
+        EspSdk.instance_variable_set(:@env, :development)
+        external_account = EspSdk::EndPoints::ExternalAccounts.new(@config)
+        assert_equal 'http://0.0.0.0:3001/api/v1/external_accounts', external_account.send(:base_url)
+      end
+
+      should 'return a valid base url for the release environment' do
+        EspSdk.expects(:release?).returns(true)
+        config = EspSdk::Configure.new(email: 'test@evident.io')
+        # Test through a different endpoint to get a valid URL
+        external_account = EspSdk::EndPoints::ExternalAccounts.new(config)
+        assert_equal 'https://api-rel.evident.io/api/v1/external_accounts', external_account.send(:base_url)
+      end
+
+      should 'return a valid base url for the production environment' do
+        EspSdk.expects(:production?).returns(true)
+        config = EspSdk::Configure.new(email: 'test@evident.io')
+        # Test through a different endpoint to get a valid URL
+        external_account = EspSdk::EndPoints::ExternalAccounts.new(config)
+        assert_equal 'https://api.evident.io/api/v1/external_accounts', external_account.send(:base_url)
+      end
+    end
+  end
+end

data/test/esp_sdk/end_points/custom_signatures_test.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class CustomSignaturesTest < ActiveSupport::TestCase
+  context 'CustomSignatures' do
+    setup do
+      # Stub the token setup for our configuration object
+      EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
+      @config = EspSdk::Configure.new(email: 'test@evident.io')
+      @custom_signatures = EspSdk::EndPoints::CustomSignatures.new(@config)
+    end
+
+    context '#run' do
+      should 'call validate_run_params and submit' do
+        params = { id: 1, regiond: [:us_east_1], external_account_id: 1 }
+        valid_params = @custom_signatures.send(:valid_run_params)
+        @custom_signatures.expects(:validate_run_params).with(valid_params, params.keys)
+        run_url = @custom_signatures.send(:run_url)
+        @custom_signatures.expects(:submit).with(run_url, :post, params)
+        @custom_signatures.run(params)
+      end
+    end
+
+    context '#run_raw' do
+      should 'call validate_run_params and submit' do
+        params = { signature: 'test', regiond: [:us_east_1], external_account_id: 1 }
+        valid_params = @custom_signatures.send(:valid_run_raw_params)
+        @custom_signatures.expects(:validate_run_params).with(valid_params, params.keys)
+        run_url = @custom_signatures.send(:run_url)
+        @custom_signatures.expects(:submit).with(run_url, :post, params)
+        @custom_signatures.run_raw(params)
+      end
+    end
+
+    context '#run_url' do
+      should 'have the correct run_url for development environment' do
+        EspSdk.instance_variable_set(:@env, :development)
+        assert_equal 'http://0.0.0.0:3001/api/v1/custom_signatures/run', @custom_signatures.send(:run_url)
+      end
+
+      should 'have the correct run_url for the release environment' do
+        EspSdk.instance_variable_set(:@env, :release)
+        assert_equal 'https://api-rel.evident.io/api/v1/custom_signatures/run', @custom_signatures.send(:run_url)
+      end
+
+      should 'have the correct run_url for the production environment' do
+        EspSdk.instance_variable_set(:@env, :production)
+        assert_equal 'https://api.evident.io/api/v1/custom_signatures/run', @custom_signatures.send(:run_url)
+      end
+    end
+
+    context '#valid_run_params' do
+      should 'have the correct keys' do
+        valid_params = @custom_signatures.send(:valid_run_params)
+
+        [:id, :regions, :external_account_id].each do |key|
+          assert_includes valid_params, key
+        end
+      end
+    end
+
+    context '#valid_run_raw_params' do
+      should 'have the correct keys' do
+        valid_params = @custom_signatures.send(:valid_run_raw_params)
+        [:signature, :regions, :external_account_id].each do |key|
+          assert_includes valid_params, key
+        end
+      end
+    end
+
+    context '#validate_run_params' do
+      setup { @valid_params = @custom_signatures.send(:valid_run_params) }
+      should 'raise an error for a missing param' do
+        e = assert_raises EspSdk::MissingAttribute do
+          @custom_signatures.send(:validate_run_params, @valid_params, { id: 1, regions: [:us_east_1] })
+        end
+
+        assert_equal 'Missing required attribute external_account_id', e.message
+      end
+
+      should 'raise an error for an unknown attribute' do
+        e = assert_raises EspSdk::UnknownAttribute do
+          @custom_signatures.send(:validate_run_params, @valid_params, { id: 1, regions: [:us_east_1],
+                                                                      external_account_id: 1, bad_param: 1}.keys)
+        end
+
+        assert_equal 'Unknown attribute bad_param', e.message
+      end
+    end
+  end
+end

data/test/esp_sdk/end_points/dashboard_test.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class DashboardTest < ActiveSupport::TestCase
+  context 'Dashboard' do
+    setup do
+      # Stub the token setup for our configuration object
+      EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
+      @config = EspSdk::Configure.new(email: 'test@evident.io')
+      @dashboard = EspSdk::EndPoints::Dashboard.new(@config)
+    end
+
+    context '#timewarp' do
+      should 'call validate_timewarp_params and submit' do
+        params = { time: 1.hour.ago.to_i }
+        url    = @dashboard.send(:timewarp_url)
+        @dashboard.expects(:validate_timewarp_params).with(params.keys)
+        @dashboard.expects(:submit).with(url, :post, params)
+        @dashboard.timewarp(params)
+      end
+    end
+
+    context '#timewarp_url' do
+      should 'have the correct run_url for development environment' do
+        EspSdk.instance_variable_set(:@env, :development)
+        assert_equal 'http://0.0.0.0:3001/api/v1/dashboard/timewarp', @dashboard.send(:timewarp_url)
+      end
+
+      should 'have the correct run_url for the release environment' do
+        EspSdk.instance_variable_set(:@env, :release)
+        assert_equal 'https://api-rel.evident.io/api/v1/dashboard/timewarp', @dashboard.send(:timewarp_url)
+      end
+
+      should 'have the correct run_url for the production environment' do
+        EspSdk.instance_variable_set(:@env, :production)
+        assert_equal 'https://api.evident.io/api/v1/dashboard/timewarp', @dashboard.send(:timewarp_url)
+      end
+    end
+
+    context '#validate_timewarp_params' do
+      should 'raise a MissingAttribute error for missing the time attribute' do
+        e = assert_raises EspSdk::MissingAttribute do
+          @dashboard.send(:validate_timewarp_params, [])
+        end
+        assert_equal 'Missing required attribute time', e.message
+      end
+
+      should 'raise a UnknownAttribute for an invalid attribute' do
+        e = assert_raises EspSdk::UnknownAttribute do
+          @dashboard.send(:validate_timewarp_params, [:time, :invalid])
+        end
+        assert_equal 'Unknown attribute invalid', e.message
+      end
+    end
+  end
+end

data/test/esp_sdk/end_points/external_accounts_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class ExternalAccountsTest < ActiveSupport::TestCase
+  context 'ExternalAccounts' do
+    setup do
+      # Stub the token setup for our configuration object
+      EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
+      @config = EspSdk::Configure.new(email: 'test@evident.io')
+      @external_accounts = EspSdk::EndPoints::ExternalAccounts.new(@config)
+    end
+
+
+    context '#generate_external_id' do
+      should 'call SecureRandom.uuid' do
+        SecureRandom.expects(:uuid)
+        @external_accounts.generate_external_id
+      end
+    end
+  end
+end

data/test/esp_sdk/end_points/signatures_test.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+class SignaturesTest < ActiveSupport::TestCase
+  context 'Signatures' do
+    setup do
+      # Stub the token setup for our configuration object
+      EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
+      @config = EspSdk::Configure.new(email: 'test@evident.io')
+      @signatures = EspSdk::EndPoints::Signatures.new(@config)
+    end
+
+    context '#run' do
+      should 'call validate_run_params and submit' do
+        params = { signature_name: 'test', regions: [:us_east_1], external_account_id: 1 }
+        run_url = @signatures.send(:run_url)
+        @signatures.expects(:validate_run_params).with(params)
+        @signatures.expects(:submit).with(run_url, :post, params)
+        @signatures.run(params)
+      end
+    end
+
+    context '#names' do
+      should 'call submit' do
+        name_url = @signatures.send(:name_url)
+        @signatures.expects(:submit).with(name_url, :get)
+        @signatures.names
+      end
+    end
+
+    context '#run_url' do
+      should 'have the correct run_url for development environment' do
+        EspSdk.instance_variable_set(:@env, :development)
+        assert_equal 'http://0.0.0.0:3001/api/v1/signatures/run', @signatures.send(:run_url)
+      end
+
+      should 'have the correct run_url for the release environment' do
+        EspSdk.instance_variable_set(:@env, :release)
+        assert_equal 'https://api-rel.evident.io/api/v1/signatures/run', @signatures.send(:run_url)
+      end
+
+      should 'have the correct run_url for the production environment' do
+        EspSdk.instance_variable_set(:@env, :production)
+        assert_equal 'https://api.evident.io/api/v1/signatures/run', @signatures.send(:run_url)
+      end
+    end
+
+    context '#name_url' do
+      should 'have the correct run_url for development environment' do
+        EspSdk.instance_variable_set(:@env, :development)
+        assert_equal 'http://0.0.0.0:3001/api/v1/signatures/signature_names', @signatures.send(:name_url)
+      end
+
+      should 'have the correct run_url for the release environment' do
+        EspSdk.instance_variable_set(:@env, :release)
+        assert_equal 'https://api-rel.evident.io/api/v1/signatures/signature_names', @signatures.send(:name_url)
+      end
+
+      should 'have the correct run_url for the production environment' do
+        EspSdk.instance_variable_set(:@env, :production)
+        assert_equal 'https://api.evident.io/api/v1/signatures/signature_names', @signatures.send(:name_url)
+      end
+    end
+
+    context '#validate_run_params' do
+      should 'raise an error for a missing param' do
+        e = assert_raises EspSdk::MissingAttribute do
+          @signatures.send(:validate_run_params, { signature_name: 'test', regions: [:us_east_1] })
+        end
+
+        assert_equal 'Missing required attribute external_account_id', e.message
+      end
+
+      should 'raise an error for an unknown attribute' do
+        e = assert_raises EspSdk::UnknownAttribute do
+          @signatures.send(:validate_run_params, { signature_name: 'test', regions: [:us_east_1],
+                                                                         external_account_id: 1, bad_param: 1})
+        end
+
+        assert_equal 'Unknown attribute bad_param', e.message
+      end
+    end
+  end
+end

data/test/esp_sdk/exceptions_test.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class ExceptionsTest < ActiveSupport::TestCase
+  context 'Exceptions' do
+    context 'MissingAttribute' do
+      should 'be a StandardError' do
+        assert EspSdk::MissingAttribute.new.is_a?(StandardError)
+      end
+    end
+
+    context 'UnknownAttribute' do
+      should 'be a StandardError' do
+        assert EspSdk::UnknownAttribute.new.is_a?(StandardError)
+      end
+    end
+
+    context 'TokenExpired' do
+      should 'be a StandardError' do
+        assert EspSdk::TokenExpired.new.is_a?(StandardError)
+      end
+    end
+
+    context 'RecordNotFound' do
+      should 'be a StandardError' do
+        assert EspSdk::RecordNotFound.new.is_a?(StandardError)
+      end
+    end
+
+    context 'Exception' do
+      should 'be a StandardError' do
+        assert EspSdk::Exception.new.is_a?(StandardError)
+      end
+    end
+  end
+end

data/test/esp_sdk_test.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class EspSdkTest < ActiveSupport::TestCase
+  context 'EspSdk' do
+    context '#env' do
+      setup do
+        EspSdk.instance_variable_set(:@env, nil)
+        ENV['ESP_ENV'] = nil
+      end
+
+      should 'return :production when ENV is not set' do
+        ENV.expects(:[]).returns(nil).at_least_once
+        assert_equal :production, EspSdk.env
+      end
+
+      should 'return :release when ENV[ESP_ENV] is set to release' do
+        ENV.expects(:[]).returns('release').at_least_once
+        assert_equal :release, EspSdk.env
+      end
+    end
+
+    context '#production?' do
+      should 'return true when the environment is :production' do
+        EspSdk.expects(:env).returns(:production)
+        assert EspSdk.production?
+      end
+
+      should 'return false when the environment is not :production' do
+        EspSdk.expects(:env).returns(:release)
+        refute EspSdk.production?
+      end
+    end
+
+    context '#release?' do
+      should 'return true when the environment is :release' do
+        EspSdk.expects(:env).returns(:release)
+        assert EspSdk.release?
+      end
+
+      should 'return false when the environment is not :release' do
+        EspSdk.expects(:env).returns(:test)
+        refute EspSdk.release?
+      end
+    end
+
+    context '#development?' do
+      should 'return true when the environment is :development' do
+        EspSdk.expects(:env).returns(:development)
+        assert EspSdk.development?
+      end
+
+      should 'return false when the environment is not :development' do
+        EspSdk.expects(:env).returns(:test)
+        refute EspSdk.development?
+      end
+    end
+
+    context '#test?' do
+      should 'return true when the environment is :test' do
+        EspSdk.expects(:env).returns(:test)
+        assert EspSdk.test?
+      end
+
+      should 'return false when the environment is not :test' do
+        EspSdk.expects(:env).returns(:production)
+        refute EspSdk.test?
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+ENV['ESP_ENV'] = 'test'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'esp_sdk'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'shoulda'
+require 'mocha'
+require 'fakeweb'
+require 'awesome_print'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+class ActiveSupport::TestCase
+  setup do
+    # Clear stubs
+    FakeWeb.clean_registry
+  end
+end