logstash-input-salesforce 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 77f802703ee0eb2ff6336f54b62ad2ea687e24c0
-  data.tar.gz: 715f8fa4e5ef752e8fa809c5df990c004f0e0f3b
+SHA256:
+  metadata.gz: c517539792d623bd6a6f0d61045e388e02b93273cc038e9441b251d1c0ada4aa
+  data.tar.gz: 12ab6014d439c453bccbb8cb7dc6c8850a6edf4dd7e2cc11746a356f35d93747
 SHA512:
-  metadata.gz: fc097212f81fcdf366eaa7af896708de61029ef087a3ebd61976cdd93ace2a86f9286b7ba44c49a86cc3a8a980625f8f29c5de016b199f26717c5fcaa40141f2
-  data.tar.gz: 236488208822e14dcadcdfb3bb70c9310e1fe7dd7c6a88fd325f071ca0b05cf3d551ca37f5315de33a0a3004b813d5bb8588a7d5ae2f4ca3bbc181f15e3b2486
+  metadata.gz: 96b862ee7597ad5872071349197a45df5b18551a4fe1c7a639a0cb6fd05c43252e9a91015d321820988f23f4623366ccb6b29302f78b40dfea4058903c92bfe8
+  data.tar.gz: 6574a59e90ec7958059e627cb818d3c640788c0b1f092304eb52f324d2d3fe83afcd06fe96ae3724286308bfe79c4a9acc641a214c92c3706932d782f7a1519f

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-gemspec
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,199 @@
+:plugin: salesforce
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Salesforce input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This Logstash input plugin allows you to query Salesforce using SOQL and puts the results
+into Logstash, one row per event. You can configure it to pull entire sObjects or only
+specific fields.
+
+NOTE: This input plugin will stop after all the results of the query are processed and will
+need to be re-run to fetch new results. It does not utilize the streaming API.
+
+In order to use this plugin, you will need to create a new SFDC Application using
+oauth. More details can be found here:
+https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
+
+You will also need a username, password, and security token for your salesforce instance.
+More details for generating a token can be found here:
+https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
+
+In addition to specifying an sObject, you can also supply a list of API fields
+that will be used in the SOQL query.
+
+==== Example
+This example prints all the Salesforce Opportunities to standard out
+
+[source,ruby]
+----------------------------------
+input {
+  salesforce {
+    client_id => 'OAUTH CLIENT ID FROM YOUR SFDC APP'
+    client_secret => 'OAUTH CLIENT SECRET FROM YOUR SFDC APP'
+    username => 'email@example.com'
+    password => 'super-secret'
+    security_token => 'SECURITY TOKEN FOR THIS USER'
+    sfdc_object_name => 'Opportunity'
+  }
+}
+
+output {
+  stdout {
+    codec => rubydebug
+  }
+}
+----------------------------------
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Salesforce Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-api_version>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-client_id>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-client_secret>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-password>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-security_token>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-sfdc_fields>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-sfdc_filters>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sfdc_object_name>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-to_underscores>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-use_test_sandbox>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-username>> |<<string,string>>|Yes
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-api_version"]
+===== `api_version` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+By default, this uses the default Restforce API version.
+To override this, set this to something like "32.0" for example
+
+[id="plugins-{type}s-{plugin}-client_id"]
+===== `client_id` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Consumer Key for authentication. You must set up a new SFDC
+connected app with oath to use this output. More information
+can be found here:
+https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
+
+[id="plugins-{type}s-{plugin}-client_secret"]
+===== `client_secret` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Consumer Secret from your oauth enabled connected app
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The password used to login to sfdc
+
+[id="plugins-{type}s-{plugin}-security_token"]
+===== `security_token` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The security token for this account. For more information about
+generting a security token, see:
+https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
+
+[id="plugins-{type}s-{plugin}-sfdc_fields"]
+===== `sfdc_fields` 
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+These are the field names to return in the Salesforce query
+If this is empty, all fields are returned.
+
+[id="plugins-{type}s-{plugin}-sfdc_filters"]
+===== `sfdc_filters` 
+
+  * Value type is <<string,string>>
+  * Default value is `""`
+
+These options will be added to the WHERE clause in the
+SOQL statement. Additional fields can be filtered on by
+adding field1 = value1 AND field2 = value2 AND...
+
+[id="plugins-{type}s-{plugin}-sfdc_object_name"]
+===== `sfdc_object_name` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The name of the salesforce object you are creating or updating
+
+[id="plugins-{type}s-{plugin}-to_underscores"]
+===== `to_underscores` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Setting this to true will convert SFDC's NamedFields__c to named_fields__c
+
+[id="plugins-{type}s-{plugin}-use_test_sandbox"]
+===== `use_test_sandbox` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Set this to true to connect to a sandbox sfdc instance
+logging in through test.salesforce.com
+
+[id="plugins-{type}s-{plugin}-username"]
+===== `username` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+A valid salesforce user name, usually your email address.
+Used for authentication and will be the user all objects
+are created or modified by
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-salesforce.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-input-salesforce'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   s.licenses = ['Apache License (2.0)']
   s.summary = "Pulls objects from Salesforce into Logstash"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
    # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-salesforce
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Russ Savage
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-02-02 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.6
-description: This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
+  gem is not a stand-alone program
 email: russ@elastic.co
 executables: []
 extensions: []
@@ -140,6 +142,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/salesforce.rb
 - logstash-input-salesforce.gemspec
 - spec/fixtures/vcr_cassettes/describe_lead_object.yml
@@ -168,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key:
 specification_version: 4
 summary: Pulls objects from Salesforce into Logstash