active-campaign-simple 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1e11e679f32384e64051c27b84b761840e99c412c67af13d5c7a48815097689
-  data.tar.gz: 954d8b69e0e49291aa229348bf644e81be3d937a64f7fa7fed16acbd8b0b944b
+  metadata.gz: 4f14ce1acb34a9a870103f2046ea7c49f1f443f3a32d3b1b5277227fabd700ee
+  data.tar.gz: 75887c51dd6588bc2ecfc3c474b81830960b6e520a0912958459830f71890525
 SHA512:
-  metadata.gz: 0ee9eeeded8c7cfd774cfac05ef69b23464b94d7b7a1668534e98434a13dde533fb95d326904be87c1cc8c7270b3fbe03fd3f1047c1a17fbbc9bc28ed757d633
-  data.tar.gz: f33762ac2f49b09846f53dffeb7c703987e09c8c947b77fbd8e2d6178a52781298059bb7f8595be61b32dac25adb0dc1337daaf1f93e2a2d84818f76801b1515
+  metadata.gz: 6a1d9339f80b99a526f2298946db806c6d4733922d44783255f1e1326ac9f54c292b7e5354a2f12b3a2251806be8995092f1d9f27c90868fa8df9d64ec125597
+  data.tar.gz: 73740f17ae33f57b391f2f8c554217bf09bd7136029e8b6fa6584acaadd5926ac8c32b466dedc810b9d7fd8a79f281a743b7d00a56c3fc92de77c438d2f05bdf

data/README.md

@@ -33,44 +33,43 @@ ActiveCampaign.get('/contacts')
 # Get a contact
 ActiveCampaign.get('/contacts/' + id)
 
-# Create a new contact
+# Create (post) a new contact
 # https://developers.activecampaign.com/reference#create-a-contact-new
-payload = {
+ActiveCampaign.post('/contacts', payload: {
   contact: {
     email: 'nate@test.com',
     firstName: 'Nate',
     lastName: 'Test',
     phone: '1231231234'
   },
-  fieldValues: {
+  fieldValues: [
     {
       field: '1',
       value: 'The Value for First Field'
-    },
-    {
-      field: '6',
-      value: '2008-01-20'
     }
-  }
-}
-ActiveCampaign.post('/contacts', payload: payload)
+  ]
+})
 
-# Update a contact
-payload = {
+# Update (put) a contact
+ActiveCampaign.put('/contacts/' + id, payload: {
   contact: {
-    email: 'nate@test.com',
-  },
-  fieldValues: {
-    {
-      field: '1',
-      value: 'The Value for First Field'
-    },
+    email: 'nate@test.com'
   }
-}
-ActiveCampaign.post('/contacts/' + id, payload: payload)
+})
 
 # Delete a contact
 ActiveCampaign.delete('/contacts/' + id)
+
+# Search for a contact
+ActiveCampaign.get('/contacts', query: { email: 'test@test.com' })
+
+# Event Tracking
+# See: https://developers.activecampaign.com/reference#track-event
+# NOTE - The tracking API is different from all other calls as it changes the arguments a little to simplify.
+ActiveCampaign.track_event('event-key', 'actid', 'event-name', 'email')
+
+# or with optional eventdata
+ActiveCampaign.track_event('event-key', 'actid', 'event-name', 'email', 'eventdata')
 ```
 
 ## <a name="contributing">Contributing</a>

data/lib/active-campaign-simple/event.rb

@@ -0,0 +1,25 @@
+module ActiveCampaign
+  class Event
+
+    class << self
+      # Post event
+      def post_event(key, actid, event, email, eventdata=nil)
+        # header = { content_type: 'application/x-www-form-urlencoded' }
+        form = {
+          key: key,
+          actid: actid,
+          event: event,
+          # visit: URI.encode_www_form_component{ email: email },
+          visit: { email: email }
+        }
+        form.merge!({ eventdata: eventdata }) if eventdata
+
+        resp = RestClient.post("https://trackcmp.net/event", form)
+      rescue RestClient::ExceptionWithResponse => err
+        raise APIError, err
+      else
+        return resp.body if resp.body # Some calls respond w nothing
+      end
+    end
+  end
+end

data/lib/active-campaign-simple/exception_handler.rb

@@ -0,0 +1,20 @@
+require 'active-campaign-simple/exceptions'
+
+module ActiveCampaign
+  class ExceptionHandler
+
+    ERRORS = {
+      '404 Not Found' => ActiveCampaign::NotFoundError
+    }
+
+    def initialize(error)
+      error_class = ERRORS[error.message]
+      if error_class
+        raise error_class, error
+      else
+        raise ActiveCampaign::StandardError(error)
+      end
+    end
+
+  end
+end

data/lib/active-campaign-simple/exceptions.rb

@@ -0,0 +1,11 @@
+class ActiveCampaignAPIError < StandardError
+  def initialize(error)
+    ActiveCampaign.api_logger.error "ERROR: #{error}"
+    super(error)
+  end
+end
+
+module ActiveCampaign
+  class NotFoundError < ActiveCampaignAPIError; end
+  class StandardError < ActiveCampaignAPIError; end
+end

data/lib/active-campaign-simple/request.rb

@@ -1,11 +1,12 @@
 require 'rest-client'
-require 'active-campaign-simple/api_error'
+require 'active-campaign-simple/exception_handler'
+require 'active-campaign-simple/event'
 
 module ActiveCampaign
   module Request
     # Perform an GET request
-    def get(path)
-      request(:get, path)
+    def get(path, query: {})
+      request(:get, path, {}, query)
     end
 
     # Perform an HTTP POST request
@@ -28,15 +29,21 @@ module ActiveCampaign
       request(:delete, path)
     end
 
+    # used for tracking events
+    def track_event(key, actid, event, email, eventdata=nil)
+      Event.post_event(key, actid, event, email, eventdata)
+    end
+
     private
 
     # Perform request
-    def request(method, path, payload={})
+    def request(method, path, payload={}, query={})
       path = "/#{path}" unless path.start_with?('/')
+      path += "?#{URI::encode_www_form(query)}" unless query.empty?
       header = {
         'Api-Token': api_key,
         content_type: :json,
-        accept: :json,
+        accept: :json
       }
       opts = {
         method: method,
@@ -46,10 +53,10 @@ module ActiveCampaign
       opts.merge!( { payload: payload.to_json }) unless payload.empty?
       resp = RestClient::Request.execute(opts)
     rescue RestClient::ExceptionWithResponse => err
-      # log error?
-      raise APIError, err
+      ActiveCampaign::ExceptionHandler.new(err)
     else
       return JSON.parse(resp.body) if resp.body # Some calls respond w nothing
     end
+
   end
 end

data/lib/active-campaign-simple/version.rb

@@ -1,4 +1,4 @@
 module ActiveCampaign
   # The version of the gem
-  VERSION = '0.1.1'.freeze unless defined?(::ActiveCampaign::VERSION)
+  VERSION = '0.3.1'.freeze unless defined?(::ActiveCampaign::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active-campaign-simple
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Nathan Leavitt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -51,9 +51,11 @@ files:
 - README.md
 - active-campaign-simple.gemspec
 - lib/active-campaign-simple.rb
-- lib/active-campaign-simple/api_error.rb
 - lib/active-campaign-simple/client.rb
 - lib/active-campaign-simple/config.rb
+- lib/active-campaign-simple/event.rb
+- lib/active-campaign-simple/exception_handler.rb
+- lib/active-campaign-simple/exceptions.rb
 - lib/active-campaign-simple/logger.rb
 - lib/active-campaign-simple/request.rb
 - lib/active-campaign-simple/version.rb

data/lib/active-campaign-simple/api_error.rb

@@ -1,11 +0,0 @@
-module ActiveCampaign
-
-  class APIError < StandardError
-    def initialize(msg)
-      ActiveCampaign.api_logger.error "ERROR: #{msg}"
-      super(msg)
-    end
-  end
-
-end
-