eloquant 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 541ee997c003eeaea219467537db71bd4b1649a7
-  data.tar.gz: 62d262046bd0f4b36d36757154675d0c810902ed
+  metadata.gz: 515f8ebffb63bdf249aa9b1246569c39a901db4a
+  data.tar.gz: 0f169aeaa49b9862dc6d66b69e243b8ad1fcd856
 SHA512:
-  metadata.gz: c48c5a1087d0685b280b54693c2a390ec85d59c50617632d70ed125acc04c01772d521ae7a1d0642b00c07a22199498d64d9441ddc4cbbb00807459b17aec34b
-  data.tar.gz: 466ea4b6afcd4cc0ebc18463b32201fd68c788defb160903b636f7d74934f72b0e941a3b7982be1711ead3ba7377f5af1402751d629b6f32e6f448325b2b6707
+  metadata.gz: ced9b7903ef4d19a9065fdd7028ab29feda0bfe8ba2377fe15c88eb55ffb41f9debb08c58a6e25be15000310f9bb43aac537b940d8fcd08f3619f06e98a4647f
+  data.tar.gz: 4f8eb29d5d44eba3c1eb0f62604aac08a57321ce7b08071ec3e97f7f6ad357182fde7572e4e23836a196dfda6afdf0f3833ef448c4043c39b3bca363ad775ae9

data/Gemfile.lock

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

data/README.md

@@ -115,23 +115,3 @@ Everyone interacting in the Eloquant project’s codebases, issue trackers, chat
 ## Releasing to [RubyGems](https://rubygems.org/gems/eloquant)
 
 Use the `bin/release` script to build, push, and tag this gem.
-
-### Todo
-
-- [X] See if we can do OAuth Password Credentials Grant -> Nope
-- [X] Notes on using Basic HTTP Authentication
-  - [X] `env.example`?
-- [ ] Implement endpoints
-  - [ ] Documentation on options in code and in readme
-
-## Endpoints to Implement
-
-- [ ] Accounts
-- [ ] Activities
-- [ ] Campaign Responses
-- [ ] Campaigns
-- [ ] Contacts
-- [ ] Custom Objects      - no describe
-- [ ] Events              - no describe
-- [ ] External Activities - no describe
-- [ ] Opportunities

data/bin/release

@@ -2,8 +2,6 @@
 set -euo pipefail
 IFS=$'\n\t'
 
-fail "Do it manually this time!"
-
 VERSION=$(grep VERSION lib/eloquant/version.rb | awk '{print $3}' | sed 's/"//g')
 TAG_VERSION="v$VERSION"
 

data/lib/eloquant.rb

@@ -47,12 +47,13 @@ module Eloquant
       @max_retries = options.fetch(:max_retries, 10)
       @connection  = options.fetch(:connection, nil)
       @debug       = options.fetch(:debug, true)
+      @logger      = options.fetch(:logger, nil)
       @host        = options.fetch(:host, DEFAULT_HOST_URL)
 
       @options = options
     end
 
-    %i(get post delete).each do |http_method|
+    %i(get post).each do |http_method|
       define_method(http_method) do |path, payload = {}, custom_headers = {}, &block|
         set_host_url_if_default
 

data/lib/eloquant/concerns/accounts.rb

@@ -1,67 +1,38 @@
 module Eloquant
   module Accounts
     def describe_accounts
-      get("/api/bulk/2.0/accounts/fields")
+      describe_endpoint(accounts)
     end
 
-    def describe_accounts_csv(params = {})
-      get("/api/bulk/2.0/accounts/fields", params, csv_custom_headers)
+    def describe_accounts_csv
+      describe_endpoint_csv(accounts)
     end
 
-    def create_bulk_account_export(params = {})
-      response   = create_account_export(params)
-      export_uri = response[:uri]
-
-      status_response = enqueue_export(export_uri)
-      sync_uri        = status_response[:uri]
-
-      status = status_response[:status]
-
-      while status != "success"
-        sleep(10)
-
-        status_response = check_export_status(sync_uri)
-        status          = status_response[:status]
-      end
-
-      sync_uri
+    def number_of_accounts
+      count_endpoint(accounts)
     end
 
-    def get_export_data(sync_uri, offset: nil)
-      params = {}
-      params[:offset] = offset if offset
+    def get_account(eloqua_external_id, depth: :complete)
+      params = {
+        search: "CompanyIDExt='#{eloqua_external_id}'",
+        depth: depth,
+      }
 
-      get("/api/bulk/2.0#{sync_uri}/data", params)
+      get("/api/rest/1.0/data/accounts", params)
     end
 
-    def list_account_exports
-      get("/api/bulk/2.0/accounts/exports")
+    def create_bulk_account_export(params = {})
+      create_bulk_export(accounts, params)
     end
 
-    def delete_account_export(id:)
-      delete("/api/bulk/2.0/accounts/exports/#{id}")
+    def list_account_exports
+      list_bulk_exports(accounts)
     end
 
     private
 
-      # Need a `name` and a `fields` list
-      def create_account_export(name: "Eloquant Account Export", fields: {})
-        params = {
-          name:   name,
-          fields: fields,
-        }
-
-        json_post("/api/bulk/2.0/accounts/exports", params)
-      end
-
-      def enqueue_export(export_uri)
-        params = { syncedInstanceUri: export_uri }
-
-        json_post("/api/bulk/2.0/syncs", params)
-      end
-
-      def check_export_status(sync_uri)
-        get("/api/bulk/2.0#{sync_uri}")
+      def accounts
+        "accounts"
       end
   end
 end

data/lib/eloquant/concerns/activities.rb

@@ -1,11 +1,31 @@
 module Eloquant
   module Activities
     def describe_activities
-      get("/api/bulk/2.0/activities/fields")
+      describe_endpoint(activities)
     end
 
-    def describe_activities_csv(params = {})
-      get("/api/bulk/2.0/activities/fields", params, csv_custom_headers)
+    def describe_activities_csv
+      describe_endpoint_csv(activities)
     end
+
+    # Filter is the name of the activity type
+    def create_bulk_activity_export(fields:, filter:)
+      params = {
+        fields: fields,
+        filter: filter,
+      }
+
+      create_bulk_export(activities, params)
+    end
+
+    def list_activity_exports
+      list_bulk_exports(activities)
+    end
+
+    private
+
+      def activities
+        "activities"
+      end
   end
 end

data/lib/eloquant/concerns/campaign_responses.rb

@@ -1,11 +1,17 @@
 module Eloquant
   module CampaignResponses
     def describe_campaign_responses
-      get("/api/bulk/2.0/campaignResponses/fields")
+      describe_endpoint(campaign_responses)
     end
 
-    def describe_campaign_responses_csv(params = {})
-      get("/api/bulk/2.0/campaignResponses/fields", params, csv_custom_headers)
+    def describe_campaign_responses_csv
+      describe_endpoint_csv(campaign_responses)
     end
+
+    private
+
+      def campaign_responses
+        "campaignResponses"
+      end
   end
 end

data/lib/eloquant/concerns/campaigns.rb

@@ -1,11 +1,30 @@
 module Eloquant
   module Campaigns
     def describe_campaigns
-      get("/api/bulk/2.0/campaigns/fields")
+      describe_endpoint(campaigns)
     end
 
-    def describe_campaigns_csv(params = {})
-      get("/api/bulk/2.0/campaigns/fields", params, csv_custom_headers)
+    def describe_campaigns_csv
+      describe_endpoint_csv(campaigns)
     end
+
+    def number_of_campaigns
+      get_campaigns(count: 1).try(:[], :total)
+    end
+
+    def get_campaigns(page: nil, depth: :minimal, count: nil)
+      params = {}
+      params[:page]  = page  if !page.nil?
+      params[:depth] = depth if !depth.nil?
+      params[:count] = count if !count.nil?
+
+      get("/api/rest/2.0/assets/campaigns", params)
+    end
+
+    private
+
+      def campaigns
+        "campaigns"
+      end
   end
 end

data/lib/eloquant/concerns/connection.rb

@@ -23,7 +23,7 @@ module Eloquant
                       ::Faraday::Error::TimeoutError,
                       ::Faraday::ConnectionFailed]
 
-        conn.response :logger if @debug
+        conn.response :logger, @logger if @debug && @logger
         conn.response :eloquant, content_type: /\bjson$/
 
         conn.options.timeout      = @options[:read_timeout] if @options.key?(:read_timeout)

data/lib/eloquant/concerns/contacts.rb

@@ -1,11 +1,38 @@
 module Eloquant
   module Contacts
     def describe_contacts
-      get("/api/bulk/2.0/contacts/fields")
+      describe_endpoint(contacts)
     end
 
-    def describe_contacts_csv(params = {})
-      get("/api/bulk/2.0/contacts/fields", params, csv_custom_headers)
+    def describe_contacts_csv
+      describe_endpoint_csv(contacts)
     end
+
+    def number_of_contacts
+      count_endpoint(contacts)
+    end
+
+    def get_contact(eloqua_external_id)
+      params = {
+        search: "ContactIDExt='#{eloqua_external_id}'",
+        depth:  "complete",
+      }
+
+      get("/api/rest/1.0/data/contacts", params)
+    end
+
+    def create_bulk_contact_export(params = {})
+      create_bulk_export(contacts, params)
+    end
+
+    def list_contact_exports
+      list_bulk_exports(contacts)
+    end
+
+    private
+
+      def contacts
+        "contacts"
+      end
   end
 end

data/lib/eloquant/concerns/helpers.rb

@@ -11,5 +11,72 @@ module Eloquant
     def json_post(path, params)
       post(path, JSON.generate(params), json_custom_headers)
     end
+
+    def count_endpoint(endpoint)
+      get("/api/rest/1.0/data/#{endpoint}", count: 1).try(:[], :total)
+    end
+
+    def describe_endpoint(endpoint)
+      get("/api/bulk/2.0/#{endpoint}/fields")
+    end
+
+    def describe_endpoint_csv(endpoint, params = {})
+      get("/api/bulk/2.0/#{endpoint}/fields", params, csv_custom_headers)
+    end
+
+    def create_bulk_export(endpoint, params)
+      response = initialize_bulk_export(endpoint, params)
+
+      if response.has_key?(:failures)
+        fail Eloquant::Errors::BulkExportCreationError.new(response[:failures])
+      end
+
+      export_uri = response[:uri]
+
+      status_response = enqueue_export(export_uri)
+      sync_uri        = status_response[:uri]
+
+      status = status_response[:status]
+
+      while status != "success"
+        sleep(10)
+
+        status_response = check_export_status(sync_uri)
+        status          = status_response[:status]
+      end
+
+      sync_uri
+    end
+
+    def initialize_bulk_export(endpoint, name: nil, fields: {}, filter: nil)
+      params = {
+        name:   name || "Eloquant #{endpoint.capitalize} Bulk Export",
+        fields: fields,
+      }
+      params[:filter] = filter if !filter.nil?
+
+      json_post("/api/bulk/2.0/#{endpoint}/exports", params)
+    end
+
+    def enqueue_export(export_uri)
+      params = { syncedInstanceUri: export_uri }
+
+      json_post("/api/bulk/2.0/syncs", params)
+    end
+
+    def check_export_status(sync_uri)
+      get("/api/bulk/2.0#{sync_uri}")
+    end
+
+    def get_export_data(sync_uri, offset: nil)
+      params = {}
+      params[:offset] = offset if offset
+
+      get("/api/bulk/2.0#{sync_uri}/data", params)
+    end
+
+    def list_bulk_exports(endpoint)
+      get("/api/bulk/2.0/#{endpoint}/exports")
+    end
   end
 end

data/lib/eloquant/concerns/opportunities.rb

@@ -1,11 +1,17 @@
 module Eloquant
   module Opportunities
     def describe_opportunities
-      get("/api/bulk/2.0/opportunities/fields")
+      describe_endpoint(opportunities)
     end
 
-    def describe_opportunities_csv(params = {})
-      get("/api/bulk/2.0/opportunities/fields", params, csv_custom_headers)
+    def describe_opportunities_csv
+      describe_endpoint_csv(opportunities)
     end
+
+    private
+
+      def opportunities
+        "opportunities"
+      end
   end
 end

data/lib/eloquant/errors.rb

@@ -1,5 +1,5 @@
 module Eloquant
-  class Errors
+  module Errors
     class Error < StandardError
     end
 
@@ -10,6 +10,7 @@ module Eloquant
     Unknown            = create_class
     EmptyResponse      = create_class
     AuthorizationError = create_class
+    BulkExportCreationError = create_class
 
     RESPONSE_CODE_TO_ERROR = {}.freeze
 

data/lib/eloquant/version.rb

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

metadata

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