esp_sdk 1.1.0 → 2.0.0.rc1

data/bin/esp_repl

@@ -1,60 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.push 'lib'
-require 'optparse'
-require 'esp_sdk'
-
-options = {}
-opt_parser = OptionParser.new do |opt|
-  opt.on('-f', '--file FILE') do |file|
-    options[:signature] = File.read(file)
-    case File.extname(file)
-    when '.rb'
-      options[:language] = 'ruby'
-    when '.js'
-      options[:language] = 'javascript'
-    else
-      fail StandardError, 'Unkown extension type must be one of .rb or .js'
-    end
-  end
-
-  opt.on('--external_account_id EXTERNAL_ACCOUNT_ID') do |external_account_id|
-    options[:external_account_id] = external_account_id
-  end
-
-  opt.on('--region REGION') do |region|
-    options[:region] = region
-  end
-
-  opt.on('--password PASSWORD') do |password|
-    options[:password] = password
-  end
-
-  opt.on('--email EMAIL') do |email|
-    options[:email] = email
-  end
-
-  opt.on('-c') do
-    options[:console] = true
-  end
-end
-
-opt_parser.parse!
-repl = EspSdk::Repl.new(options)
-
-if options[:console]
-  require 'artii'
-  require 'pry'
-  AwesomePrint.pry!
-  Pry.config.prompt = proc { 'ESP::REPL > ' }
-  artii = Artii::Base.new(font: 'slant')
-  print <<-banner
-#{artii.asciify('E.S.P')}
-Evident Security Platform REPL #{EspSdk::VERSION}
-Copyright (c) 2013-#{Time.now.year} Evident Security, All Rights Reserved.
-http://www.evident.io
-banner
-  Pry.start repl
-else
-  ap repl.eval
-end

data/lib/esp_sdk/api.rb

@@ -1,33 +0,0 @@
-module EspSdk
-  class Api
-    attr_reader :end_points, :config
-
-    def initialize(options = {})
-      options[:email] ||= options_errors(:email)
-      options_errors(:password) if options[:token].blank? && options[:password].blank?
-      @config     = Configure.new(options)
-      @end_points = []
-      define_methods
-    end
-
-    private
-
-    def define_methods
-      end_points = EspSdk::EndPoints.constants - [:Base]
-
-      end_points.each do |end_point|
-        name = end_point.to_s.underscore
-        define_singleton_method name do
-          return instance_variable_get(:"@#{name}") if instance_variable_get(:"@#{name}").present?
-          instance_variable_set(:"@#{name}", EspSdk::EndPoints.const_get(end_point).new(config))
-        end
-
-        @end_points << send(name)
-      end
-    end
-
-    def options_errors(option)
-      ENV["ESP_#{option.upcase}"] || fail(EspSdk::MissingAttribute, "Missing required #{option}") # rubocop:disable all
-    end
-  end
-end

data/lib/esp_sdk/client.rb

@@ -1,62 +0,0 @@
-require 'rest_client'
-require_relative 'extensions/rest_client/request'
-
-module EspSdk
-  # Client class for our endpoints. Every endpoint gets its own client.
-  class Client
-    attr_reader :config, :errors
-
-    def initialize(config)
-      @config  = config
-    end
-
-    def connect(url, type = :get, payload = {})
-      payload = { payload_key => payload } if payload.present?
-
-      begin
-        if type == :get || type == :delete
-          if payload.present?
-            response = RestClient.send(type, url, headers.merge(params: payload))
-          else
-            response = RestClient.send(type, url, headers)
-          end
-        else
-          # The rest of our actions will require a payload
-          fail MissingAttribute, 'Missing required attributes' if payload.blank?
-          response = RestClient.send(type, url, payload, headers)
-        end
-      rescue RestClient::Unauthorized => e
-        fail EspSdk::Unauthorized, 'Unauthorized request'
-      rescue RestClient::UnprocessableEntity => e
-        response = e.response
-        body     = JSON.load(response.body) if response.body.present?
-        check_errors(body)
-      end
-
-      response
-    end
-
-    private
-
-    def headers
-      @headers ||= { 'Authorization' => @config.token, 'Authorization-Email' => @config.email, 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
-    end
-
-    def payload_key
-      @payload_key ||= self.class.to_s.demodulize.singularize.underscore
-    end
-
-    def check_errors(body)
-      @errors  = body['errors'] if body.present? && body.is_a?(Hash) && body['errors'].present?
-      return unless @errors.present?
-
-      if @errors.select { |error| error.to_s.include?('Token has expired') }.present?
-        fail TokenExpired, 'Token has expired'
-      elsif (error = @errors.select { |error| error.to_s.include?('Record not found') }[0]).present?
-        fail RecordNotFound, error
-      else
-        fail EspSdk::Exception, "#{@errors.join('. ')}"
-      end
-    end
-  end
-end

data/lib/esp_sdk/configure.rb

@@ -1,40 +0,0 @@
-module EspSdk
-  class Configure
-    attr_accessor :token, :email, :version, :token_expires_at, :end_point, :domain
-
-    def initialize(options)
-      self.email = options[:email]
-      self.version = options[:version] || 'v1'
-      self.domain = options[:domain]
-      self.token = options[:password] || options[:token]
-      self.end_point = options[:password].present? ? 'new' : 'valid'
-      token_setup
-    end
-
-    def url(endpoint)
-      "#{domain}/api/#{version}/#{endpoint}"
-    end
-
-    def domain
-      return @domain if @domain.present?
-      if EspSdk.production?
-        self.domain = 'https://api.evident.io'
-      elsif EspSdk.release?
-        self.domain = 'https://api-rel.evident.io'
-      else
-        self.domain = 'http://0.0.0.0:3000'
-      end
-    end
-
-    private
-
-    def token_setup
-      client     = Client.new(self)
-      response   = client.connect(url("token/#{end_point}"))
-      user       = JSON.load(response.body)
-      self.token = user['authentication_token']
-      self.token_expires_at = user['token_expires_at'].to_s.to_datetime.utc ||
-        1.hour.from_now.to_datetime.utc
-    end
-  end
-end

data/lib/esp_sdk/end_points/base.rb

@@ -1,102 +0,0 @@
-require 'json'
-
-module EspSdk
-  module EndPoints
-    class Base < EspSdk::Client
-      attr_reader :current_page, :current_record
-
-      def next_page
-        return list if current_page.blank?
-
-        if @page_links['next'].present?
-          response = connect(@page_links['next'], :get)
-          pagination_links(response)
-          self.current_page = JSON.load(response.body)
-        else
-          @current_page
-        end
-      end
-
-      def prev_page
-        return list if current_page.blank?
-
-        if @page_links['prev'].present?
-          response      = connect(@page_links['prev'], :get)
-          pagination_links(response)
-          self.current_page = JSON.load(response.body)
-        else
-          @current_page
-        end
-      end
-
-      # Get a pageable list of records
-      def list
-        response = connect(base_url, :get)
-        pagination_links(response)
-        self.current_page = JSON.load(response.body)
-      end
-
-      # Get a single record
-      def show(params = {})
-        validate_id(params)
-        submit(id_url(params.delete(:id)), :get)
-      end
-
-      # Update a single record
-      def update(params = {})
-        validate_id(params)
-        submit(id_url(params.delete(:id)), :patch, params)
-      end
-
-      # Destroy a single record
-      def destroy(params = {})
-        validate_id(params)
-        submit(id_url(params.delete(:id)), :delete)
-      end
-
-      # Create a new record
-      def create(params = {})
-        submit(base_url, :post, params)
-      end
-
-      private
-
-      def validate_id(params)
-        fail MissingAttribute, 'Missing required attribute id' if params[:id].blank?
-      end
-
-      def id_url(id)
-        "#{base_url}/#{id}"
-      end
-
-      def base_url
-        config.url(self.class.to_s.demodulize.underscore)
-      end
-
-      def submit(url, type, options = {})
-        response         = connect(url, type, options)
-        @current_record  = ActiveSupport::HashWithIndifferentAccess.new(JSON.load(response.body))
-      end
-
-      # Converts the link header into a hash of links
-      #
-      # "<http://test.host/api/v1/custom_signatures?page=2>; rel=\"last\", <http://test.host/api/v1/custom_signatures?page=2>; rel=\"next\""
-      # => { "last" => "http://test.host/api/v1/custom_signatures?page=2",
-      #      "next" => "http://test.host/api/v1/custom_signatures?page=2" }
-      def pagination_links(response)
-        @page_links = ActiveSupport::HashWithIndifferentAccess.new(JSON.load(response.headers[:link]))
-      rescue JSON::ParserError
-        @page_links = ActiveSupport::HashWithIndifferentAccess.new.tap do |page_links|
-          response.headers[:link].to_s.split(',').each  do |link|
-            /<(?<link>.*)>; rel="(?<key>\w*)"/ =~ link
-            page_links[key] = link
-          end
-        end
-      end
-
-      def current_page=(values)
-        @current_page = values.map(&:with_indifferent_access)
-      end
-    end
-  end
-end

data/lib/esp_sdk/end_points/contact_requests.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class ContactRequests < Base
-    end
-  end
-end

data/lib/esp_sdk/end_points/custom_signatures.rb

@@ -1,41 +0,0 @@
-module EspSdk
-  module EndPoints
-    class CustomSignatures < Base
-      def run(params = {})
-        validate_run_params(valid_run_params, params.keys)
-        submit(run_url, :post, params)
-      end
-
-      def run_raw(params = {})
-        validate_run_params(valid_run_raw_params, params.keys)
-        submit(run_url, :post, params)
-      end
-
-      private
-
-      def run_url
-        "#{base_url}/run"
-      end
-
-      def valid_run_params
-        [:id, :regions, :external_account_id, :language]
-      end
-
-      def valid_run_raw_params
-        [:signature, :regions, :external_account_id, :language]
-      end
-
-      def validate_run_params(valid_params, keys)
-        # Check that all the valid params are present
-        valid_params.each do |param|
-          fail MissingAttribute, "Missing required attribute #{param}" unless keys.include?(param)
-        end
-
-        # Check for invalid params
-        keys.each do |key|
-          fail UnknownAttribute, "Unknown attribute #{key}" unless valid_params.include?(key)
-        end
-      end
-    end
-  end
-end

data/lib/esp_sdk/end_points/dashboard.rb

@@ -1,35 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Dashboard < Base
-      def list
-        response = connect(base_url, :get)
-        @current_page = JSON.load(response.body).with_indifferent_access
-      end
-
-      def timewarp(params = {})
-        validate_timewarp_params(params.keys)
-        submit(timewarp_url, :post, params)
-      end
-
-      private
-
-      def timewarp_url
-        "#{base_url}/timewarp"
-      end
-
-      def validate_timewarp_params(keys)
-        valid_timewarp_params = [:time]
-
-        # Check that all the valid params are present
-        valid_timewarp_params.each do |param|
-          fail MissingAttribute, "Missing required attribute #{param}" unless keys.include?(param)
-        end
-
-        # Check for invalid params
-        keys.each do |key|
-          fail UnknownAttribute, "Unknown attribute #{key}" unless valid_timewarp_params.include?(key)
-        end
-      end
-    end
-  end
-end

data/lib/esp_sdk/end_points/external_accounts.rb

@@ -1,9 +0,0 @@
-module EspSdk
-  module EndPoints
-    class ExternalAccounts < Base
-      def generate_external_id
-        SecureRandom.uuid
-      end
-    end
-  end
-end

data/lib/esp_sdk/end_points/organizations.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Organizations < Base
-    end
-  end
-end

data/lib/esp_sdk/end_points/reports.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Reports < Base
-    end
-  end
-end

data/lib/esp_sdk/end_points/services.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Services < Base
-    end
-  end
-end

data/lib/esp_sdk/end_points/signatures.rb

@@ -1,39 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Signatures < Base
-      def run(params = {})
-        validate_run_params(params)
-        submit(run_url, :post, params)
-      end
-
-      def names
-        submit(name_url, :get)
-      end
-
-      private
-
-      def run_url
-        "#{base_url}/run"
-      end
-
-      def name_url
-        "#{base_url}/signature_names"
-      end
-
-      def validate_run_params(options)
-        valid_params = [:signature_name, :regions, :external_account_id]
-        keys         = options.keys
-
-        # Check that all the valid params are present
-        valid_params.each do |param|
-          fail EspSdk::MissingAttribute, "Missing required attribute #{param}" unless keys.include?(param)
-        end
-
-        # Check for invalid params
-        keys.each do |key|
-          fail EspSdk::UnknownAttribute, "Unknown attribute #{key}" unless valid_params.include?(key)
-        end
-      end
-    end
-  end
-end

data/lib/esp_sdk/end_points/sub_organizations.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class SubOrganizations < Base
-    end
-  end
-end

data/lib/esp_sdk/end_points/teams.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Teams < Base
-    end
-  end
-end

data/lib/esp_sdk/end_points/users.rb

@@ -1,6 +0,0 @@
-module EspSdk
-  module EndPoints
-    class Users < Base
-    end
-  end
-end

data/lib/esp_sdk/exceptions.rb

@@ -1,8 +0,0 @@
-module EspSdk
-  class MissingAttribute < StandardError; end
-  class UnknownAttribute < StandardError; end
-  class TokenExpired     < StandardError; end
-  class RecordNotFound   < StandardError; end
-  class Exception        < StandardError; end
-  class Unauthorized     < StandardError; end
-end

data/lib/esp_sdk/extensions/rest_client/request.rb

@@ -1,9 +0,0 @@
-module RestClient
-  class Request
-    # Override execute to always use SSLv23
-    def self.execute(args, &block)
-      args.merge!(ssl_version: 'SSLv23')
-      new(args).execute(& block)
-    end
-  end
-end

data/lib/esp_sdk/repl.rb

@@ -1,61 +0,0 @@
-module EspSdk
-  # Current context in the ESP REPL
-  class Repl
-    attr_reader :client, :options, :results
-
-    def initialize(options = {})
-      @options   = options
-      @client    = EspSdk::Api.new(@options)
-    end
-
-    # Override eval to delegate to the scripting eval
-    def eval
-      @results = client.custom_signatures.run_raw(
-      signature: @options[:signature],
-      language: @options[:language],
-      regions: Array(@options[:region]),
-      external_account_id: @options[:external_account_id])
-    end
-
-    def signature
-      @options[:signature]
-    end
-
-    def set_signature(signature, language = :javascript)
-      @options[:signature] = signature
-      @options[:language]  = language
-      true
-    end
-
-    def region
-      @options[:region]
-    end
-
-    def set_region(region)
-      @options[:region] = region
-    end
-
-    def external_account_id
-      @options[:external_account_id]
-    end
-
-    def set_external_account_id(id)
-      @options[:external_account_id] = id
-    end
-
-    # Used to reset the client
-    def reload!
-      @client = EspSdk::Api.new(@options)
-      'Reloaded!'
-    end
-
-    # Delegate to @client
-    def method_missing(meth, *args, &block)
-      if client.respond_to?(meth)
-        client.send(meth, *args, &block)
-      else
-        super
-      end
-    end
-  end
-end

data/lib/esp_sdk/version.rb

@@ -1,3 +0,0 @@
-module EspSdk
-  VERSION = '1.1.0'
-end

data/test/esp_sdk/api_test.rb

@@ -1,36 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
-
-class ApiTest < ActiveSupport::TestCase
-  context 'Api' do
-    context '#initalize' do
-      should 'raise a MissingAttribute error for a missing email' do
-        e = assert_raises EspSdk::MissingAttribute do
-          EspSdk::Api.new()
-        end
-
-        assert_equal 'Missing required email', e.message
-      end
-      should 'raise a MissingAttribute error for a missing token and password' do
-        e = assert_raises EspSdk::MissingAttribute do
-          EspSdk::Api.new(email: 'test@evident.io')
-        end
-
-        assert_equal 'Missing required password', e.message
-      end
-
-      should 'define our endpoint methods and add them to the end_points array' do
-        # Stub the token setup for our configuration object
-        EspSdk::Configure.any_instance.expects(:token_setup).returns(nil).at_least_once
-        api = EspSdk::Api.new(email: 'test@evident.io', password: 'password')
-        end_points = (EspSdk::EndPoints.constants - [:Base]).map(&:to_s).map(&:underscore)
-        methods = api.singleton_methods.map(&:to_s)
-
-        assert_equal end_points.count, api.end_points.count
-
-        methods.each do |method|
-          assert_includes end_points, method
-        end
-      end
-    end
-  end
-end