acw 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f83ffb21109941cf55bca7475d4efcea6864dba7e5f60e7db3b00cea5fe935
-  data.tar.gz: 26469ac00550599f941d1b33c7365d46e21c7a520c248e52ebb91896ee436e76
+  metadata.gz: c19f8b720097ef991c9c849fbb801c8d54eaf3b4b1a26129506481bc1a94c902
+  data.tar.gz: 6803935f1441129dfb7f48600d7627b0f42c665d9e48da72b83f959410cfde89
 SHA512:
-  metadata.gz: f4b5556926b458da090b34b9dec09bd4516a26bdaf0810f5956d8358c3105d9ccd5789e4cfab73436791acb4d59db16d161461886ce9fa7d5da9e55ef3c1d621
-  data.tar.gz: b2691fc0ca83aa1ecb76d5a2f98142027a505dac183536e45c7c96797b4a9cf70cf8aba331b66fc5ab1de334a47cb7c373581ab4d0b5894b918a459e25a9cab6
+  metadata.gz: 610c728226bfb1ed0caaf403e1e369faa4c6d4325fb375cf3cbcd3f5caa629a715eb65619d4bcd2b0f947499f4734c3e93b6739d4d4de8eb7bd2bc74e9654389
+  data.tar.gz: a84c1ef728d660d40062bd12260dd6ef261fa34d1e62275b315b1b50db6ab789968072c74cdea01cd6f8a79ebd9128b3a6ed5d55f0ce4430dcb80570e94c0baf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acw (1.3.0)
+    acw (1.3.1)
       excon (>= 0.73.0)
 
 GEM

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-> ### Initialize client
+### Initialize client
 
 ```ruby
 client = Acw::Client.new({
@@ -29,13 +29,13 @@ client = Acw::Client.new({
 })
 ```
 
-> ### Connection details
+### Connection details
 
 ```ruby
 client.connection
 ```
 
-> ### Create contact - [Api Reference](https://developers.activecampaign.com/reference#create-a-contact-new)
+### Create contact - [Api Reference](https://developers.activecampaign.com/reference#create-a-contact-new)
 
 ```ruby
 client.create_contact({
@@ -46,24 +46,36 @@ client.create_contact({
 })
 ```
 
-> ### Sync contact (Create or Update) - [Api Reference](https://developers.activecampaign.com/reference#create-or-update-contact-new)
+### Sync contact (Create or Update) - [Api Reference](https://developers.activecampaign.com/reference#create-or-update-contact-new)
 
 ```ruby
 client.sync_contact({
+  contact: {
     email:     'contact@email.com',
     firstName: 'first',
     lastName:  'last',
-    phone:     '12312312'
+    phone:     '12312312',
+    fieldValues: [
+      {
+        field: '1',
+        value: 'My Value'
+      },
+      {
+        field: '2',
+        value: 'My second value'
+      }
+    ]   
+  }
 })
 ```
 
-> ### Retrieve contact - [Api Reference](https://developers.activecampaign.com/reference#get-contact)
+### Retrieve contact - [Api Reference](https://developers.activecampaign.com/reference#get-contact)
 
 ```ruby
 client.retrieve_contact("contact_id")
 ```
 
-> ### Retrieve contact by email
+### Retrieve contact by email
 
 This will return an array of contacts.
 
@@ -71,13 +83,13 @@ This will return an array of contacts.
 client.retrieve_contact_by_email("email")
 ```
 
-> ### Retrieve lists - [Api Reference](https://developers.activecampaign.com/reference#retrieve-all-lists)
+### Retrieve lists - [Api Reference](https://developers.activecampaign.com/reference#retrieve-all-lists)
 
 ```ruby
 client.retrieve_lists
 ```
 
-> ### Create tag - [Api Reference](https://developers.activecampaign.com/reference#tags)
+### Create tag - [Api Reference](https://developers.activecampaign.com/reference#tags)
 
 ```ruby
 client.create_tag({ 
@@ -85,7 +97,7 @@ client.create_tag({
 })
 ```
 
-> ### Add a tag to contact - [Api Reference](https://developers.activecampaign.com/reference#create-contact-tag)
+### Add a tag to contact - [Api Reference](https://developers.activecampaign.com/reference#create-contact-tag)
 
 It generates a relationship called contactTag containing an id.
 
@@ -95,7 +107,7 @@ client.add_contact_tag({
 })
 ```
 
-> ### Remove a tag to contact - [Api Reference](https://developers.activecampaign.com/reference#delete-contact-tag)
+### Remove a tag to contact - [Api Reference](https://developers.activecampaign.com/reference#delete-contact-tag)
 
 To remove a tag from contact just remove the relationship between them.
 
@@ -103,7 +115,7 @@ To remove a tag from contact just remove the relationship between them.
 client.remove_contact_tag("contact_tag_id)
 ```
 
-> ### Create field value - [Api Reference](https://developers.activecampaign.com/reference#create-fieldvalue)
+### Create field value - [Api Reference](https://developers.activecampaign.com/reference#create-fieldvalue)
 
 It generates a relationship called fieldVaalue containing an id.
 
@@ -117,7 +129,7 @@ client.create_field_value(
 )
 ```
 
-> ### Update a field value - [Api Reference](https://developers.activecampaign.com/reference#update-a-custom-field-value-for-contact)
+### Update a field value - [Api Reference](https://developers.activecampaign.com/reference#update-a-custom-field-value-for-contact)
 
 It updates a relationship called fieldVaalue containing an id.
 

data/lib/acw/client.rb

@@ -3,11 +3,13 @@
 require 'excon'
 require 'cgi'
 require 'json'
+require './lib/acw/helpers'
 
 module Acw
   class Client
+    include Acw::Helpers
+
     API_VERSION = 3
-    Result = Struct.new(:success?, :error, :value)
 
     def initialize(configs = {})
       @config = configs
@@ -19,24 +21,22 @@ module Acw
       @connection ||= Excon.new(config[:url])
     end
 
-    # CONTACTS
     def create_contact(args = {})
       safe_http_call do
         params = { contact: args }
         connection.post(
           path: "/api/#{API_VERSION}/contacts",
-          headers: headers,
+          headers: headers(config[:token]),
           body: params.to_json
         )
       end
     end
 
-    def sync_contact(args = {})
+    def sync_contact(params)
       safe_http_call do
-        params = { contact: args }
         connection.post(
           path: "/api/#{API_VERSION}/contact/sync",
-          headers: headers,
+          headers: headers(config[:token]),
           body: params.to_json
         )
       end
@@ -44,31 +44,38 @@ module Acw
 
     def retrieve_contact(id)
       safe_http_call do
-        connection.get(path: "/api/#{API_VERSION}/contacts/#{id}", headers: headers)
+        connection.get(
+          path: "/api/#{API_VERSION}/contacts/#{id}",
+          headers: headers(config[:token])
+        )
       end
     end
 
     def retrieve_contact_by_email(email)
       safe_http_call do
         uemail = CGI.escape email
-        connection.get(path: "/api/#{API_VERSION}/contacts?search=#{uemail}", headers: headers)
+        connection.get(
+          path: "/api/#{API_VERSION}/contacts?search=#{uemail}",
+          headers: headers(config[:token])
+        )
       end
     end
 
-    # LISTS
     def retrieve_lists
       safe_http_call do
-        connection.get(path: "/api/#{API_VERSION}/lists", headers: headers)
+        connection.get(
+          path: "/api/#{API_VERSION}/lists",
+          headers: headers(config[:token])
+        )
       end
     end
 
-    # TAGS
     def create_tag(args = {})
       safe_http_call do
         params = { tag: args }
         connection.post(
           path: "/api/#{API_VERSION}/tags",
-          headers: headers,
+          headers: headers(config[:token]),
           body: params.to_json
         )
       end
@@ -79,7 +86,7 @@ module Acw
         params = { 'contactTag': args }
         connection.post(
           path: "/api/#{API_VERSION}/contactTags",
-          headers: headers,
+          headers: headers(config[:token]),
           body: params.to_json
         )
       end
@@ -87,17 +94,19 @@ module Acw
 
     def remove_contact_tag(id)
       safe_http_call do
-        connection.delete(path: "/api/#{API_VERSION}/contactTags/#{id}", headers: headers)
+        connection.delete(
+          path: "/api/#{API_VERSION}/contactTags/#{id}",
+          headers: headers(config[:token])
+        )
       end
     end
 
-    # FIELD_VALUES
     def create_field_value(args = {})
       safe_http_call do
         params = { 'fieldValue': args }
         connection.post(
           path: "/api/#{API_VERSION}/fieldValues",
-          headers: headers,
+          headers: headers(config[:token]),
           body: params.to_json
         )
       end
@@ -108,7 +117,7 @@ module Acw
         params = { 'fieldValue': args }
         connection.put(
           path: "/api/#{API_VERSION}/fieldValues/#{id}",
-          headers: headers,
+          headers: headers(config[:token]),
           body: params.to_json
         )
       end
@@ -116,21 +125,13 @@ module Acw
 
     private
 
-    def headers
-      {
-        'Accept': 'application/json',
-        'Content-Type': 'application/json',
-        'Api-Token': config[:token]
-      }
-    end
-
     def safe_http_call
       response = yield
       raise response.body unless success_http_status(response.status)
 
-      Result.new(true, nil, JSON.parse(response.body))
+      result(true, nil, JSON.parse(response.body))
     rescue StandardError => e
-      Result.new(false, e.message, nil)
+      result(false, e.message, nil)
     end
 
     def success_http_status(status)

data/lib/acw/helpers.rb

@@ -0,0 +1,17 @@
+module Acw
+  module Helpers
+    Result = Struct.new(:success?, :error, :value)
+
+    def headers(token)
+      @headers ||= {
+        'Accept': 'application/json',
+        'Content-Type': 'application/json',
+        'Api-Token': token
+      }
+    end
+
+    def result(success, error, value)
+      Result.new(success, error, value)
+    end
+  end
+end

data/lib/acw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Acw
-  VERSION = '1.3.0'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acw
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Anchieta Júnior
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -157,6 +157,7 @@ files:
 - bin/setup
 - lib/acw.rb
 - lib/acw/client.rb
+- lib/acw/helpers.rb
 - lib/acw/version.rb
 homepage: https://github.com/anchietajunior.com/acw
 licenses: