acw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fe596f7097c6a3355323c283784d3b2103314fee7084c87c83f21ea99976ddc
+  data.tar.gz: 0c0a32b7357d07c05814285bd69619a4492618eb7fd2634e0a18f9a76d8d243e
+SHA512:
+  metadata.gz: 66457311e161a8a3256bf3c55948ad5fc531883309ba07e438c1139fe929306b1d7e72bed58066614fc993813930a1a3469b11b6b4be6a51098b3e01e1c3e926
+  data.tar.gz: 0f705d80498efc7e37c463874710e8d20d6c753150afda75a36e9de87e3e6cb4f2d0ce47a4aff8549d08f75465151df493ce914a3bf1cc8c47c2422862baea26

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install:
+  - gem update --system
+  - gem install bundler -v 2.0.2
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in acw.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    acw (0.1.0)
+      faraday (>= 1.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.4)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    vcr (5.1.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acw!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 5.1)
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Anchieta Júnior
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# Acw
+
+This is a very simple wrapper of the Active Campaign Api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acw'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acw
+
+## Usage
+
+> ### Initialize client
+
+```ruby
+client = Acw::Client.new({
+    url:   'your-url',
+    token: 'your-token'
+})
+```
+
+> ### Connection details
+
+```ruby
+client = Acw::Client.new({
+    url:   'your-url',
+    token: 'your-token'
+})
+
+client.connection
+```
+
+> ### Create contact
+
+```ruby
+client.create_contact({
+    email:     'contact@email.com',
+    firstName: 'first',
+    lastName:  'last',
+    phone:     '12312312'
+})
+```
+
+> ### Sync contact (Create or Update)
+
+```ruby
+client.sync_contact({
+    email:     'contact@email.com',
+    firstName: 'first',
+    lastName:  'last',
+    phone:     '12312312'
+})
+```
+
+> ### Retrieve contact
+
+```ruby
+client.retrieve_contact("contact_id")
+```
+
+> ### Retrieve contact by email
+
+This will return an array of contacts.
+
+```ruby
+client.retrieve_contact_by_email("email")
+```
+
+> ### Retrieve lists
+
+```ruby
+client.retrieve_lists
+```
+
+> ### Create tag
+
+```ruby
+client.create_tag({ 
+    tag: "tag_name", tagType: "tag_type"  
+})
+```
+
+> ### Add a tag to contact
+
+It generates a relationship called contactTag containing an id.
+
+```ruby
+client.add_contact_tag({ 
+    contact: "contact_id", tag: "tag_id"
+})
+```
+
+> ### Remove a tag to contact
+
+To remove a tag from contact just remove the relationship between them.
+
+```ruby
+client.remove_contact_tag("contact_tag_id)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/acw.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "acw/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "acw"
+  spec.version       = Acw::VERSION
+  spec.authors       = ["Anchieta Júnior"]
+  spec.email         = ["santosjr87@gmail.com"]
+
+  spec.summary       = %q{Active Campaign Wrapper.}
+  spec.description   = %q{Active Campaign Wrapper.}
+  spec.homepage      = "https://github.com/anchietajunior.com/acw"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/anchietajunior.com/acw"
+  spec.metadata["changelog_uri"] = "https://github.com/anchietajunior.com/acw"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '>= 1.0', '< 3.0'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "vcr",     "~> 5.1"
+  spec.add_development_dependency "webmock", "~> 3.8"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acw"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/acw/client.rb

@@ -0,0 +1,95 @@
+require 'faraday'
+require 'cgi'
+require 'json'
+
+module Acw
+  class Client
+
+    Result = Struct.new(:success?, :error, :value)
+
+    def initialize(configs = {})
+      @config = configs
+    end
+
+    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
+    end
+
+    #CONTACTS
+    def create_contact(args={})
+      safe_http_call do
+        params = { contact: args }
+        connection.post("contacts", params.to_json)
+      end
+    end
+
+    def sync_contact(args={})
+      safe_http_call do
+        params = { contact: args }
+        connection.post("contact/sync", params.to_json)
+      end
+    end
+
+    def retrieve_contact(id)
+      safe_http_call do
+        connection.get("contacts/#{id}")
+      end
+    end
+
+    def retrieve_contact_by_email(email)
+      safe_http_call do
+        uemail = CGI.escape email
+        connection.get("contacts?search=#{uemail}")
+      end
+    end
+
+    #LISTS
+    def retrieve_lists
+      safe_http_call do
+        connection.get("lists")
+      end
+    end
+
+    #TAGS
+    def create_tag(args={})
+      safe_http_call do
+        params = {"tag": args}
+        connection.post("tags", params.to_json)
+      end
+    end
+    
+    def add_contact_tag(args={})
+      safe_http_call do
+        params = {"contactTag": args}
+        connection.post("contactTags", params.to_json)
+      end
+    end
+    
+    def remove_contact_tag(id)
+      safe_http_call do
+        connection.delete("contactTags/#{id}")
+      end
+    end
+
+    private
+
+    def safe_http_call
+      response = yield
+      raise response.body unless success_http_status(response.status)
+      Result.new(true, nil, JSON.parse(response.body))
+    rescue StandardError => e
+      Result.new(false, e.message, nil)
+    end
+
+    def success_http_status(status)
+      status == 200 || status == 201
+    end
+  end
+end

data/lib/acw/version.rb

@@ -0,0 +1,3 @@
+module Acw
+  VERSION = "0.1.0"
+end

data/lib/acw.rb

@@ -0,0 +1,14 @@
+require "acw/version"
+require "acw/client"
+
+module Acw
+  module_function
+ 
+  def self.hi
+    p "Hi"
+  end
+
+  def self.client
+    p "hello"
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: acw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anchieta Júnior
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Active Campaign Wrapper.
+email:
+- santosjr87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- acw.gemspec
+- bin/console
+- bin/setup
+- lib/acw.rb
+- lib/acw/client.rb
+- lib/acw/version.rb
+homepage: https://github.com/anchietajunior.com/acw
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/anchietajunior.com/acw
+  source_code_uri: https://github.com/anchietajunior.com/acw
+  changelog_uri: https://github.com/anchietajunior.com/acw
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Active Campaign Wrapper.
+test_files: []