eloquant 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 515f8ebffb63bdf249aa9b1246569c39a901db4a
-  data.tar.gz: 0f169aeaa49b9862dc6d66b69e243b8ad1fcd856
+  metadata.gz: 9be01050edfaa7699d98c2bd6badb3a3e552aa36
+  data.tar.gz: d16c760546f02c76dd96c5d61f9567ef98327f94
 SHA512:
-  metadata.gz: ced9b7903ef4d19a9065fdd7028ab29feda0bfe8ba2377fe15c88eb55ffb41f9debb08c58a6e25be15000310f9bb43aac537b940d8fcd08f3619f06e98a4647f
-  data.tar.gz: 4f8eb29d5d44eba3c1eb0f62604aac08a57321ce7b08071ec3e97f7f6ad357182fde7572e4e23836a196dfda6afdf0f3833ef448c4043c39b3bca363ad775ae9
+  metadata.gz: afbaa37d04ca159876e2f3926f7ddb5733d893d231656191eea22d0470811ba0ed022b738be6b367ecbf2b35dc76e99e5cbb3580ad7883048762ba2ab475b65f
+  data.tar.gz: 8e29967797a07893f6f360b8a7caa44c9c96181544b32911b6b47ae09f62c2277b1dbe3d7a44c7ab023afd89cd09641b82b9e187ac0e2eedc56f19ac4a5a6f0b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eloquant (1.0.0)
+    eloquant (2.0.0)
       faraday_middleware (> 0.9.0, < 0.11.0)
 
 GEM

data/README.md

@@ -35,12 +35,16 @@ ELOQUA_PASSWORD='password'
 
 ---------
 
-### Available Endpoints
+## Available Endpoints
+
+### [Application API](https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/Developers/RESTAPI/REST-API.htm) (Rest API)
 
 #### Accounts
 
 - `describe_accounts` - Return the list of fields for an Account
 - `describe_accounts_csv` - Return the list of fields for an Account as a CSV formatted string
+- `number_of_accounts` - Return the number of Accounts in the Eloqua database
+- `get_account(eloqua_external_id)` - Query for a single Account given an Account's External ID (`CompanyIDExt`)
 
 #### Activities
 
@@ -56,28 +60,159 @@ ELOQUA_PASSWORD='password'
 
 - `describe_campaigns` - Return the list of fields for a Campaign
 - `describe_campaigns_csv` - Return the list of fields for a Campaign as a CSV formatted string
+- `number_of_campaigns` - Return the number of Campaigns in the Eloqua database
+- `get_campaigns(page:, depth:, count:)` - Return Campaigns given the parameters
 
 #### Contacts
 
 - `describe_contacts` - Return the list of fields for a Contact
 - `describe_contacts_csv` - Return the list of fields for a Contact as a CSV formatted string
+- `number_of_contacts` - Return the number of Contacts in the Eloqua database
+- `get_contact(eloqua_external_id)` - Query for a single Contact given a Contact's External ID (`ContactIDExt`)
+
+#### Opportunities
 
-#### Custom Objects
+- `describe_opportunities` - Return the list of fields for an Opportunity
+- `describe_opportunities_csv` - Return the list of fields for an Opportunity as a CSV formatted string
 
-- No describe is available for Custom Objects
+### [Bulk API](https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/Developers/BulkAPI/bulk-API.htm)
 
-#### Events
+The Bulk API works a little differently than the REST API. [This post](https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/Developers/BulkAPI/Tutorials/Export.htm)
+does a fantastic job of explaining it.
 
-- No describe is available for Events
+First, it works by creating an "export" in Eloqua given a set of parameters.
+The parameters are as follows:
 
-#### External Activities
+- `name` (required) - The name of your export
+- `fields` (required) - A hash containing the field mappings from a custom name to an Eloqua attribute
+  - Ex:
+```ruby
+fields = {
+  # Custom Name       => "Name in Eloqua"
+  :contact_id         => "{{Contact.Id}}",
+  :contact_first_name => "{{Contact.FirstName}}",
+  :contact_last_name  => "{{Contact.LastName}}",
+  :contact_created_at => "{{Contact.CreatedAt}}",
+}
+```
+- `filter` (optional for most, required for Activities) - The [filters](https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/Developers/BulkAPI/Tutorials/Filtering.htm?cshid=BulkFiltering) are used to narrow down your result
+  - Ex: Activities require a filter based on the Activity Type.
+```ruby
+# All Web Visit Activities
+filter = "'{{Activity.Type}}' = 'WebVisit'"
+# All Email Send Activities after Jan 1, 2018
+filter = "'{{Activity.Type}}' = 'EmailSend' AND '{{Activity.CreatedAt}}' >= '2018-01-01'"
+```
 
-- No describe is available for External Activities
+Each of the Bulk API endpoints take these three named parameters.
 
-#### Opportunities
+After creating a bulk export, the URI of the sync from Eloqua is returned. You
+can use this URI to query for the data.
 
-- `describe_opportunities` - Return the list of fields for an Opportunity
-- `describe_opportunities_csv` - Return the list of fields for an Opportunity as a CSV formatted string
+```ruby
+# Example 1: Get all of the Form Submit activities in a given time frame
+client.create_bulk_activity_export(
+  name: "Eloquant Bulk Activity Export Example",
+  filter: "'{{Activity.Type}}' = 'FormSubmit'",
+  fields: {
+    id:            "{{Activity.Id}}",
+    activity_date: "{{Activity.CreatedAt}}",
+    contact_id:    "{{Activity.Contact.Id}}",
+  },
+)
+#=> "/syncs/2010234"
+sync_uri = "/syncs/2010234"
+
+client.get_export_data(sync_uri)
+#=> {
+#    :totalResults => 49997,
+#    :limit        => 1000,
+#    :offset       => 0,
+#    :count        => 1000,
+#    :hasMore      => true,
+#    :items        => [
+#      {
+#        :id            => "1",
+#        :activity_date => "2018-11-02 13:25:26.203",
+#        :contact_id    => "438294"
+#      },
+#      {
+#        :id            => "2",
+#        :activity_date => "2018-11-02 13:25:26.203",
+#        :contact_id    => "982340"
+#      },
+#      ...
+#    ]
+#  }
+
+# To get the next 1,000 results
+client.get_export_data(sync_uri, offset: 1000)
+#=> {
+#    :totalResults => 49997,
+#    :limit        => 1000,
+#    :offset       => 1000,
+#    :count        => 1000,
+#    :hasMore      => true,
+#    :items        => [
+#      {
+#        :id            => "1001",
+#        :activity_date => "2018-11-02 1:22:34.213",
+#        :contact_id    => "138573"
+#      },
+#      {
+#        :id            => "1002",
+#        :activity_date => "2018-11-02 15.24.12.323",
+#        :contact_id    => "943209"
+#      },
+#      ...
+#    ]
+#  }
+
+# To get the last of the results. Note the `count` and `hasMore` keys in response
+client.get_export_data(sync_uri, offset: 49000)
+#=> {
+#    :totalResults => 49997,
+#    :limit        => 1000,
+#    :offset       => 49000,
+#    :count        => 997,
+#    :hasMore      => false,
+#    :items        => [
+#      ...
+#      {
+#        :id            => "49996",
+#        :activity_date => "2018-11-02 13:25:26.203",
+#        :contact_id    => "123456"
+#      },
+#      {
+#        :id            => "49997",
+#        :activity_date => "2018-11-02 13:25:26.203",
+#        :contact_id    => "098439"
+#      }
+#    ]
+#  }
+```
+- `totalResults` shows how many items in the database matched your query
+- `limit` shows the number of items this response is limited to return
+- `offset` shows the offset in which items in the query are paged through
+  - An offset of 0 would return results 1 - 1,000. An offset of 1,000 would
+    return results 1,001 - 2000
+- `count` shows the number of items returned in this response
+- `hasMore` is a boolean denoting if there are more results to page through
+
+#### Accounts
+
+- `create_bulk_account_export(params)` - Create a bulk Account export with the input parameters defined above
+- `list_account_exports` - List the created Account exports from Eloqua
+
+#### Activities
+
+- `create_bulk_activity_export(params)` - Create a bulk Activity export with the input parameters defined above
+- `list_activity_exports` - List the created Activity exports from Eloqua
+
+#### Contacts
+
+- `create_bulk_contact_export(params)` - Create a bulk Contact export with the input parameters defined above
+- `list_contact_exports` - List the created Contact exports from Eloqua
 
 -----------
 

data/lib/eloquant/concerns/activities.rb

@@ -9,12 +9,7 @@ module Eloquant
     end
 
     # Filter is the name of the activity type
-    def create_bulk_activity_export(fields:, filter:)
-      params = {
-        fields: fields,
-        filter: filter,
-      }
-
+    def create_bulk_activity_export(params = {})
       create_bulk_export(activities, params)
     end
 

data/lib/eloquant/version.rb

@@ -1,3 +1,3 @@
 module Eloquant
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eloquant
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jason Stumbaugh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware