logstash-input-salesforce 3.0.0 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47a63d3cff425c4e10d0f7119750322258f68ca4
-  data.tar.gz: 4a2b000a1a49d360d6dd0fda9fd2aabfeb251857
+SHA256:
+  metadata.gz: f249029cd28ff6a4b4896dfefc61ab504823e21493afb21f5cb6953e08348e49
+  data.tar.gz: a8db9b840145bd8e4bf9c6ac3f72ed1d8e4e3858ffcf5bf8d4b4ed2a5e7ea781
 SHA512:
-  metadata.gz: 7ba9fb5664acee8ea30ec49707baeb3015aa07b4372c0540eeea4ccf3d442b9a36d606bf2132276b7fbe0f84aebdadf5e1939411ffb274d0ca9180e98c851fe0
-  data.tar.gz: 38d6a7cedb833cd932d369daf4ac01ba5ef59bb22dfcdbdd92579ec91f8910b1fd4d0478b7190b3632aa7ad9c7e8adf3fd09ca730b971da05dd7b679ea250263
+  metadata.gz: d5d8a0b7ff36740ba86c94cf41118800e26dde3fbb4305090975858969c50fba88a87b88b5a1769abb8afb67683a5779d77c145f60f9c01c7e8f3bd07459246c
+  data.tar.gz: 5c2b23c18e940f939b07149f1236d4a9feb36f632dcb5b56d965357d4ec67ccdfaaf6e13f3f285c74f4613c6e6212f0754bc96e01632aa303130429828ff3250

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 3.0.6
+  - Make sure 'recent' restforce dependency is used (to help dependency resolution)
+
+## 3.0.5
+  - Docs: Set the default_codec doc attribute.
+
+## 3.0.4
+  - Update gemspec summary
+
+## 3.0.3
+  - Fix some documentation issues
+
+# 3.0.1
+  - Correctly format time from salesforce events
+
 # 3.0.0
   - Update dependency of logstash-core-plugin-api to ">= 1.60", "<= 2.99" (for logstash 5.x compatibility)
   - Update event api to .set and .get accessors
@@ -9,6 +24,6 @@
   - New dependency requirements for logstash-core for the 5.0 release
 
 ## 2.0.0
- - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
  - Dependency on logstash-core update to 2.0

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/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/docs/index.asciidoc

@@ -0,0 +1,202 @@
+:plugin: salesforce
+:type: input
+:default_codec: plain
+
+///////////////////////////////////////////
+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}s-{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[]
+
+:default_codec!: