esp_sdk 1.1.0 → 2.0.0.rc1

data/lib/esp/resources/user.rb

@@ -0,0 +1,46 @@
+module ESP
+  class User < ESP::Resource
+    ##
+    # The organization this user belongs to.
+    belongs_to :organization, class_name: 'ESP::Organization'
+
+    # Not Implemented. You cannot create or update a User.
+    def save
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy a User.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    ##
+    # The collection of sub organizations that belong to the user.
+    def sub_organizations
+      SubOrganization.find(:all, params: { id: sub_organization_ids })
+    end
+
+    ##
+    # The collection of teams that belong to the user.
+    def teams
+      Team.find(:all, params: { id: team_ids })
+    end
+
+    ##
+    # :singleton-method: find
+    # Find a User by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the user to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+
+    # :singleton-method: all
+    # Return a paginated User list
+
+    # :singleton-method: create
+    # Not Implemented. You cannot create a User.
+  end
+end

data/lib/esp/version.rb

@@ -0,0 +1,3 @@
+module ESP
+  VERSION = '2.0.0.rc1'
+end

data/lib/esp.rb

@@ -0,0 +1,95 @@
+module ESP
+  # Manually set the access_key_id you created from https://esp.evident.io/settings/api_keys.
+  #
+  # You can optionally set the `ESP_ACCESS_KEY_ID` environment variable.
+  def self.access_key_id=(access_key_id)
+    @access_key_id = access_key_id
+    ESP::Resource.hmac_access_id = access_key_id
+  end
+
+  # Reads the `ESP_ACCESS_KEY_ID` environment variable if ::access_key_id was not set manually.
+  def self.access_key_id
+    @access_key_id || ENV['ESP_ACCESS_KEY_ID']
+  end
+
+  # Manually set the secret_access_key you created from https://esp.evident.io/settings/api_keys.
+  #
+  # You can optionally set the `ESP_SECRET_ACCESS_KEY` environment variable.
+  def self.secret_access_key=(secret_access_key)
+    @secret_access_key = secret_access_key
+    ESP::Resource.hmac_secret_key = secret_access_key
+  end
+
+  # Reads the `ESP_SECRET_ACCESS_KEY` environment variable if ::secret_access_key was not set manually.
+  def self.secret_access_key
+    @secret_access_key || ENV['ESP_SECRET_ACCESS_KEY']
+  end
+
+  PATH = '/api/v2'.freeze
+
+  HOST = { development: "http://localhost:3000".freeze,
+           test: "http://localhost:3000".freeze,
+           production: "https://api.evident.io".freeze }.freeze # :nodoc:
+
+  # Users of the Evident.io marketplace appliance application will need to set the host for their instance.
+  #
+  # ==== Attribute
+  #
+  # * +host+ - The host for the installed appliance instance.
+  def self.host=(host)
+    @host = host
+    ESP::Resource.site = site
+  end
+
+  # The site the SDK will hit.
+  def self.site
+    "#{(@host || HOST[ESP.env.to_sym] || ENV['ESP_HOST'])}#{PATH}"
+  end
+
+  # For use in a Rails initializer to set the ::access_key_id, ::secret_access_key and ::site.
+  #
+  # ==== Example
+  #
+  #   ESP.configure do |config|
+  #     config.access_key_id = <your key>
+  #     config.secret_access_key = <your secret key>
+  #     config.host = <host of your appliance instance>
+  #   end
+  def self.configure
+    yield self
+  end
+
+  # Default environment is production which will set ::site to "https://api.evident.io/api/v2".
+  def self.env
+    @env ||= ActiveSupport::StringInquirer.new(ENV['ESP_ENV'] || ENV['RAILS_ENV'] || 'production')
+  end
+
+  autoload :Resource, File.expand_path(File.dirname(__FILE__) + '/esp/resources/resource')
+  autoload :ExternalAccount, File.expand_path(File.dirname(__FILE__) + '/esp/resources/external_account')
+  autoload :Report, File.expand_path(File.dirname(__FILE__) + '/esp/resources/report')
+  autoload :Organization, File.expand_path(File.dirname(__FILE__) + '/esp/resources/organization')
+  autoload :SubOrganization, File.expand_path(File.dirname(__FILE__) + '/esp/resources/sub_organization')
+  autoload :Team, File.expand_path(File.dirname(__FILE__) + '/esp/resources/team')
+  autoload :ContactRequest, File.expand_path(File.dirname(__FILE__) + '/esp/resources/contact_request')
+  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 :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')
+  autoload :Dashboard, File.expand_path(File.dirname(__FILE__) + '/esp/resources/dashboard')
+  autoload :CloudTrailEvent, File.expand_path(File.dirname(__FILE__) + '/esp/resources/cloud_trail_event')
+  autoload :Tag, File.expand_path(File.dirname(__FILE__) + '/esp/resources/tag')
+  autoload :Region, File.expand_path(File.dirname(__FILE__) + '/esp/resources/region')
+  autoload :Suppression, File.expand_path(File.dirname(__FILE__) + '/esp/resources/suppression')
+  class Suppression
+    autoload :UniqueIdentifier, File.expand_path(File.dirname(__FILE__) + '/esp/resources/suppression/unique_identifier')
+    autoload :Signature, File.expand_path(File.dirname(__FILE__) + '/esp/resources/suppression/signature')
+    autoload :Region, File.expand_path(File.dirname(__FILE__) + '/esp/resources/suppression/region')
+  end
+  autoload :Stat, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat')
+  autoload :StatCustomSignature, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat_custom_signature')
+  autoload :StatSignature, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat_signature')
+  autoload :StatRegion, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat_region')
+  autoload :StatService, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat_service')
+end

data/lib/esp_sdk.rb

@@ -1,47 +1,11 @@
 require 'active_support/all'
+require 'active_resource'
+require 'api_auth'
 require 'awesome_print'
-require_relative 'esp_sdk/version'
-require_relative 'esp_sdk/configure'
-require_relative 'esp_sdk/client'
-require_relative 'esp_sdk/end_points/base'
-require_relative 'esp_sdk/end_points/reports'
-require_relative 'esp_sdk/end_points/users'
-require_relative 'esp_sdk/end_points/external_accounts'
-require_relative 'esp_sdk/end_points/custom_signatures'
-require_relative 'esp_sdk/end_points/organizations'
-require_relative 'esp_sdk/end_points/sub_organizations'
-require_relative 'esp_sdk/end_points/teams'
-require_relative 'esp_sdk/end_points/signatures'
-require_relative 'esp_sdk/end_points/dashboard'
-require_relative 'esp_sdk/end_points/contact_requests'
-require_relative 'esp_sdk/end_points/services'
-require_relative 'esp_sdk/api'
-require_relative 'esp_sdk/repl'
-require_relative 'esp_sdk/exceptions'
-
-module EspSdk
-  # Default environment is production
-  def self.env
-    @env ||= (ENV['ESP_ENV'] || ENV['RAILS_ENV'] || :production).to_sym
-  end
-
-  # Production environment query method
-  def self.production?
-    env == :production
-  end
-
-  # Release environment query method
-  def self.release?
-    env == :release
-  end
-
-  # Development environment query method
-  def self.development?
-    env == :development
-  end
-
-  # Test environment query method
-  def self.test?
-    env == :test
-  end
-end
+require_relative 'esp/extensions/active_resource/paginated_collection'
+require_relative 'esp/extensions/active_resource/validations'
+require_relative 'esp/extensions/active_resource/formats/json_api_format'
+require_relative 'esp/version'
+require_relative 'esp/exceptions'
+require_relative 'esp/resources/concerns/stat_totals'
+require_relative 'esp'

data/lib/tasks/rubocop.rake

@@ -0,0 +1,2 @@
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new

data/lib/tasks/testing.rake

@@ -0,0 +1,3 @@
+# needed to include the coveralls:push rake task used in travis
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new

data/rdoc/ActiveResource/Formats.html

@@ -0,0 +1,176 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>module ActiveResource::Formats - ESPSDK</title>
+
+<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+
+
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../index.html">Home</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/esp/resources/resource.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    
+    
+    
+    
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="../README_md.html">README</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="../ActiveResource.html">ActiveResource</a>
+  
+    <li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
+  
+    <li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
+  
+    <li><a href="../ESP.html">ESP</a>
+  
+    <li><a href="../ESP/Alert.html">ESP::Alert</a>
+  
+    <li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
+  
+    <li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
+  
+    <li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
+  
+    <li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
+  
+    <li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
+  
+    <li><a href="../ESP/Organization.html">ESP::Organization</a>
+  
+    <li><a href="../ESP/Region.html">ESP::Region</a>
+  
+    <li><a href="../ESP/Report.html">ESP::Report</a>
+  
+    <li><a href="../ESP/Service.html">ESP::Service</a>
+  
+    <li><a href="../ESP/Signature.html">ESP::Signature</a>
+  
+    <li><a href="../ESP/Stat.html">ESP::Stat</a>
+  
+    <li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
+  
+    <li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
+  
+    <li><a href="../ESP/StatService.html">ESP::StatService</a>
+  
+    <li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
+  
+    <li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
+  
+    <li><a href="../ESP/Suppression.html">ESP::Suppression</a>
+  
+    <li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
+  
+    <li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
+  
+    <li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
+  
+    <li><a href="../ESP/Tag.html">ESP::Tag</a>
+  
+    <li><a href="../ESP/Team.html">ESP::Team</a>
+  
+    <li><a href="../ESP/User.html">ESP::User</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="module">module ActiveResource::Formats</h1>
+
+  <div id="description" class="description">
+    
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+