active-campaign-simple 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e985487ca78df3e1c59d3ab2797a88b166c84a05f4624e22584827619ff531c6
-  data.tar.gz: 6bd4487f7ec7b4056c721d01f2d7e74bb069ffc53fc130915bd9cd9db9c3deb3
+  metadata.gz: be042a9f260af0ab936c9f9e176b775d3883ecf6961dcdddd03c00a1b9930ac3
+  data.tar.gz: 67b23cdbe1ce295350c4e8287b1bfd89d87bdb91a58812f46bc4abedece0fc7f
 SHA512:
-  metadata.gz: 7816983565ec399b90bb211f551ac7a5d3ca43519dc00c98b6958fc93e184fd22d3b7cfdcc9eedcc3757bed63fbc1000183079c8f18b0577ee5a1d4302bd8f7b
-  data.tar.gz: d916285c529751f1636e3225958f4f09cb162f4ebd6ae0b0ef5471b0a3899137776a8da748682b82097357e808bf1e4e1ae04be07a6b758f3dd84b672769a2f7
+  metadata.gz: 96882a3456a7d0e1a2d7b9cd30b80a6539121b99eead4cca788d9effdab21b05b27c18d8789ef59e87df4e71f60a9bc20afffca790edd093335d830e301be003
+  data.tar.gz: 91f85433ba0183095a36ad378bc6b76d26b0ff8575ce8c453ecbc7f0de07eb6f3b1a9e45c6b0858ff4f8f1fffdaac6389ee00501ab7a8977f5a4703c654ec87a

data/README.md

@@ -3,7 +3,7 @@ Simple Ruby REST wrapper for the Active Campaign API
 
 
 ## <a name="info">Info</a>
-This is a very simple wrapper around the REST ActiveCampaign API. You will still need to provide the path and the payload for each request. Eventually I will grow this out to be more convenient. Right now this just provides some conveniences and an easy way to configure the API and not much more... hence the name active-campaign-simple :)
+This is a very simple wrapper around the REST ActiveCampaign API. You will still need to provide the path and the payload for each request. Eventually I will grow this out to be more convenient, if needed. Right now, this just provides some conveniences and an easy way to configure the API and not much more... hence the name active-campaign-simple :)
 
 Use the public API as a guide for paths (urls) and payload info: https://developers.activecampaign.com/
 
@@ -31,46 +31,45 @@ end
 ActiveCampaign.get('/contacts')
 
 # Get a contact
-ActiveCampaign.get('/contacts' + id)
+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)
+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 ActiveCampaignAPIError(error)
+      end
+    end
+
+  end
+end

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

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

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

@@ -1,10 +1,12 @@
 require 'rest-client'
+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
@@ -27,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,
@@ -45,9 +53,10 @@ module ActiveCampaign
       opts.merge!( { payload: payload.to_json }) unless payload.empty?
       resp = RestClient::Request.execute(opts)
     rescue RestClient::ExceptionWithResponse => err
-      # log error?
+      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.0'.freeze unless defined?(::ActiveCampaign::VERSION)
-end
+  VERSION = '0.3.0'.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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nathan Leavitt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,6 +53,9 @@ files:
 - lib/active-campaign-simple.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
@@ -75,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.0.0
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Simple Ruby REST wrapper for the ActiveCampaign API