acw 1.1.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dda66f075833c1878fa3bd2f35a27d92eaf0a9290ee519b131997b90fd00bc29
-  data.tar.gz: 445c24100e91284c7bb62be7a66b8a8040f9f99c6c565d4e743e08f49229d781
+  metadata.gz: 5056bbd39cf081f2341a38dd4468f6679d4d519e98aba42d11408ec8913dcb66
+  data.tar.gz: 4edc0ad34248773e7c1820c8d6022780a517b4995cb4fa5787a4ca3ddcb4ba40
 SHA512:
-  metadata.gz: 1b793e49061b1dd95860830c270a9d91ba22c8a14a3e976b3c36904d37516054feee0ef47378ad6f6cd58f1604ef3f9f8087d6a817cb603b16606ad1a2deda98
-  data.tar.gz: 52c0e6116c71b98fbefea9be9da18a9baf75f8bba7b104a7239cd92f3e739f2898edd08d4dbf0351bb447deedb37385d96b81b6c9378c9cd9ff7cc1a3f20e8ed
+  metadata.gz: 999c8b63d60bd4918fada14a8a75135c5e9a152a61faa4a68c06da850b4d168fa8d618e80332ab90e72413b199de81d36ed61938734a51deef075776e2d539e9
+  data.tar.gz: 745760bf88da723f83e72736cbe9946d316ca01f0f2b48778ec43f04167d2240b54f79fc577ea8ecabad4fcd262b0a02b7d62156be0e28f47aecf1f0a3f78f0b

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/Gemfile.lock

@@ -1,24 +1,46 @@
 PATH
   remote: .
   specs:
-    acw (1.1.2)
-      faraday (>= 1.0)
+    acw (1.3.3)
+      excon (>= 0.73.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    backport (1.1.2)
+    benchmark (0.1.1)
+    coderay (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (1.2.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+    e2mmap (0.1.0)
+    excon (0.78.1)
     hashdiff (1.0.1)
-    multipart-post (2.1.1)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.4)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (2.0.3)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -32,13 +54,42 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    ruby2_keywords (0.0.2)
+    rubocop (1.7.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
+    solargraph (0.40.1)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 2.3)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
     vcr (5.1.0)
     webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
@@ -46,8 +97,11 @@ PLATFORMS
 DEPENDENCIES
   acw!
   bundler (~> 2.0)
+  pry (~> 0.13.1)
   rake (~> 12.3.3)
   rspec (~> 3.0)
+  rubocop (~> 1.7)
+  solargraph (~> 0.40)
   vcr (~> 5.1)
   webmock (~> 3.8)
 

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
+### 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)
+### 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
+### 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
+### Retrieve lists - [Api Reference](https://developers.activecampaign.com/reference#retrieve-all-lists)
 
 ```ruby
 client.retrieve_lists
 ```
 
-> ### Create tag
+### 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
+### 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
+### 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,6 +115,44 @@ 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)
+
+It generates a relationship called fieldVaalue containing an id.
+
+```ruby
+client.create_field_value(
+  {
+    contact: 572218,
+    field: 2,
+    value: 'field_value'
+  }
+)
+```
+
+### 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.
+
+```ruby
+client.update_field_value(
+  803_383,
+  {
+    contact: 572218,
+    field: 2,
+    value: 'new_field_value_put'
+  }
+)
+```
+
+## Testing with your Api-Token
+
+You can disable vcr in specs with these commands in your tests and create a new context for you.
+
+```
+WebMock.allow_net_connect!
+VCR.turn_off!
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/acw.gemspec

@@ -28,11 +28,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '>= 1.0'
+  # spec.add_dependency 'faraday', '>= 1.0'
+  spec.add_dependency 'excon', '>= 0.73.0'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake",    "~> 12.3.3"
   spec.add_development_dependency "rspec",   "~> 3.0"
   spec.add_development_dependency "vcr",     "~> 5.1"
   spec.add_development_dependency "webmock", "~> 3.8"
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'solargraph', '~> 0.40'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
 end

data/lib/acw.rb

@@ -1,5 +1,8 @@
-require "acw/version"
-require "acw/client"
+# frozen_string_literal: true
+
+require 'acw/version'
+require 'acw/helpers'
+require 'acw/client'
 
 module Acw
   module_function

data/lib/acw/client.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-require 'faraday'
+require 'excon'
 require 'cgi'
 require 'json'
 
 module Acw
   class Client
-    Result = Struct.new(:success?, :error, :value)
+    include Acw::Helpers
+
+    API_VERSION = 3
 
     def initialize(configs = {})
       @config = configs
@@ -15,67 +17,120 @@ module Acw
     attr_reader :config
 
     def connection
-      @connection ||= Faraday.new(url: config[:url]) do |faraday|
-        faraday.headers['Accept'] = 'application/json'
-        faraday.headers['Content-Type'] = 'application/json'
-        faraday.headers['Api-Token'] = config[:token]
-        faraday
-      end
+      @connection ||= Excon.new(config[:url])
     end
 
-    # CONTACTS
-    def create_contact(args={})
+    def create_contact(args = {})
       safe_http_call do
         params = { contact: args }
-        connection.post('contacts', params.to_json)
+        connection.post(
+          path: "/api/#{API_VERSION}/contacts",
+          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('contact/sync', params.to_json)
+        connection.post(
+          path: "/api/#{API_VERSION}/contact/sync",
+          headers: headers(config[:token]),
+          body: params.to_json
+        )
       end
     end
 
     def retrieve_contact(id)
       safe_http_call do
-        connection.get("contacts/#{id}")
+        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("contacts?search=#{uemail}")
+        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('lists')
+        connection.get(
+          path: "/api/#{API_VERSION}/lists",
+          headers: headers(config[:token])
+        )
+      end
+    end
+
+    def contact_list_subscription(args = {})
+      safe_http_call do
+        args[:status] = (args[:status] == 'subscribe' ? 1 : 2)
+        params = { contactList: args }
+        connection.post(
+          path: "/api/#{API_VERSION}/contactLists",
+          headers: headers(config[:token]),
+          body: params.to_json
+        )
       end
     end
 
-    # TAGS
     def create_tag(args = {})
       safe_http_call do
-        params = { 'tag': args }
-        connection.post('tags', params.to_json)
+        params = { tag: args }
+        connection.post(
+          path: "/api/#{API_VERSION}/tags",
+          headers: headers(config[:token]),
+          body: params.to_json
+        )
       end
     end
 
     def add_contact_tag(args = {})
       safe_http_call do
         params = { 'contactTag': args }
-        connection.post('contactTags', params.to_json)
+        connection.post(
+          path: "/api/#{API_VERSION}/contactTags",
+          headers: headers(config[:token]),
+          body: params.to_json
+        )
       end
     end
 
     def remove_contact_tag(id)
       safe_http_call do
-        connection.delete("contactTags/#{id}")
+        connection.delete(
+          path: "/api/#{API_VERSION}/contactTags/#{id}",
+          headers: headers(config[:token])
+        )
+      end
+    end
+
+    def create_field_value(args = {})
+      safe_http_call do
+        params = { 'fieldValue': args }
+        connection.post(
+          path: "/api/#{API_VERSION}/fieldValues",
+          headers: headers(config[:token]),
+          body: params.to_json
+        )
+      end
+    end
+
+    def update_field_value(id, args = {})
+      safe_http_call do
+        params = { 'fieldValue': args }
+        connection.put(
+          path: "/api/#{API_VERSION}/fieldValues/#{id}",
+          headers: headers(config[:token]),
+          body: params.to_json
+        )
       end
     end
 
@@ -85,13 +140,13 @@ module Acw
       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)
-      [200, 201].include?(status)
+      [200, 201, 202].include?(status)
     end
   end
 end

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.1.2'
+  VERSION = '1.3.3'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acw
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Anchieta Júnior
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-24 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.73.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.73.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 description: Active Campaign Wrapper.
 email:
 - santosjr87@gmail.com
@@ -104,6 +146,7 @@ files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -114,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: