active_campaign_wrapper 0.1.0

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/active_campaign_wrapper.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_campaign_wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_campaign_wrapper'
+  spec.version       = ActiveCampaignWrapper::VERSION
+  spec.authors       = ['Anmol Yousaf']
+  spec.email         = ['anmolyousaf94@gmail.com']
+
+  spec.summary       = %q{REST API for ActiveCampaign}
+  spec.description   = %q{ActiveCampaign REST API}
+  spec.homepage      = 'https://github.com/anmol-yousaf/active_campaign_wrapper'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/anmol-yousaf/active_campaign_wrapper'
+  spec.metadata['changelog_uri'] = 'https://github.com/anmol-yousaf/active_campaign_wrapper'
+
+  # 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 'activesupport', '>= 5.2.4.3'
+  spec.add_dependency 'httparty', '>= 0.14'
+
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'pry', '~> 0.14.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rspec-json_expectations', '~> 1.2'
+  spec.add_development_dependency 'rubocop', '~> 1.11.0'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'vcr', '~> 6.0.0'
+  spec.add_development_dependency 'webmock', '~> 3.12.1'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_campaign_wrapper"
+
+# 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/active_campaign_wrapper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'active_campaign_wrapper/version'
+require 'active_campaign_wrapper/client'
+
+module ActiveCampaignWrapper
+  API_VERSION = 3
+
+  class << self
+    attr_accessor :api_token, :endpoint_url
+
+    def config
+      yield self
+    end
+  end
+
+  class Error < StandardError; end
+
+  class AuthorizationError < StandardError; end
+end

data/lib/active_campaign_wrapper/api/contact/arguments.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Api
+    module Contact
+      module Arguments
+        SNAKE_CASED = {
+          bulk_import: %i[
+            first_name
+            last_name
+            customer_acct_name
+            detailed_results
+          ]
+        }.freeze
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/api/custom_field/arguments.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Api
+    module CustomField
+      module Arguments
+        SNAKE_CASED = {
+          create: %i[
+            show_in_list
+          ]
+        }.freeze
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/api/list/arguments.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Api
+    module List
+      module Arguments
+        SNAKE_CASED = {
+          create: %i[
+            sender_url
+            sender_reminder
+            send_last_broadcast
+            subscription_notify
+            unsubscription_notify
+          ]
+        }.freeze
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/client.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'active_campaign_wrapper/configuration'
+
+require 'active_campaign_wrapper/core/tag_gateway'
+require 'active_campaign_wrapper/core/contact_gateway'
+require 'active_campaign_wrapper/core/email_activity_gateway'
+require 'active_campaign_wrapper/core/list_gateway'
+require 'active_campaign_wrapper/core/custom_field_gateway'
+require 'active_campaign_wrapper/core/custom_field_option_gateway'
+require 'active_campaign_wrapper/core/custom_field_value_gateway'
+require 'active_campaign_wrapper/core/contact_tag_gateway'
+require 'active_campaign_wrapper/core/contact_automation_gateway'
+require 'active_campaign_wrapper/core/contact_score_value_gateway'
+
+require 'active_campaign_wrapper/api/contact/arguments'
+require 'active_campaign_wrapper/api/list/arguments'
+require 'active_campaign_wrapper/api/custom_field/arguments'
+
+module ActiveCampaignWrapper
+  class Client
+    include Core
+
+    attr_reader :config
+
+    def initialize(endpoint_url: nil, api_token: nil)
+      @config = Configuration.new(
+        endpoint_url: endpoint_url,
+        api_token: api_token
+      )
+    end
+
+    def tags
+      TagGateway.new(self)
+    end
+
+    def contacts
+      ContactGateway.new(self)
+    end
+
+    def email_activities
+      EmailActivityGateway.new(self)
+    end
+
+    def contact_tags
+      ContactTagGateway.new(self)
+    end
+
+    def contact_score_values
+      ContactScoreValueGateway.new(self)
+    end
+
+    def contact_automations
+      ContactAutomationGateway.new(self)
+    end
+
+    def custom_fields
+      CustomFieldGateway.new(self)
+    end
+
+    def custom_field_options
+      CustomFieldOptionGateway.new(self)
+    end
+
+    def custom_field_values
+      CustomFieldValueGateway.new(self)
+    end
+
+    def lists
+      ListGateway.new(self)
+    end
+  end
+end

data/lib/active_campaign_wrapper/configuration.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'active_campaign_wrapper/helpers'
+
+module ActiveCampaignWrapper
+  class Configuration
+    include HTTParty
+    include Helpers
+
+    attr_accessor :endpoint_url, :api_token
+
+    format :json
+
+    def initialize(endpoint_url: nil, api_token: nil)
+      @endpoint_url = endpoint_url.presence || ActiveCampaignWrapper.endpoint_url
+      @api_token = api_token.presence || ActiveCampaignWrapper.api_token
+
+      self.class.base_uri "#{@endpoint_url}/api/#{ActiveCampaignWrapper::API_VERSION}"
+      self.class.default_options.merge! headers: { api_token: @api_token }
+    end
+
+    def post(*args)
+      safe_http_call do
+        self.class.post(*args)
+      end
+    end
+
+    def patch(*args)
+      safe_http_call do
+        self.class.patch(*args)
+      end
+    end
+
+    def put(*args)
+      safe_http_call do
+        self.class.put(*args)
+      end
+    end
+
+    def delete(*args)
+      safe_http_call do
+        self.class.delete(*args)
+      end
+    end
+
+    def get(*args)
+      safe_http_call do
+        self.class.get(*args)
+      end
+    end
+
+    private
+
+    def safe_http_call
+      response = yield
+      normalize_response(response)
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/contact_automation_gateway.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class ContactAutomationGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(contact_id, **params)
+        @config.get("/contacts/#{contact_id}/contactAutomations", query: params)
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/contact_gateway.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class ContactGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(**params)
+        @config.get('/contacts', query: params)
+      end
+
+      def create(params)
+        params = { contact: params }
+        @config.post(
+          '/contacts',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def sync(params)
+        params = { contact: params }
+        @config.post(
+          '/contact/sync',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def update_list_status(params)
+        params = { contact_list: params }
+        @config.post(
+          '/contactLists',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def bulk_import(params)
+        @config.post(
+          '/import/bulk_import',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(
+            params,
+            ActiveCampaignWrapper::Api::Contact::Arguments::SNAKE_CASED[:bulk_import]
+          )
+        )
+      end
+
+      def delete(contact_id)
+        @config.delete("/contacts/#{contact_id}")
+      end
+
+      def update(contact_id, params)
+        params = { contact: params }
+        @config.put(
+          "/contacts/#{contact_id}",
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def find(contact_id)
+        @config.get("/contacts/#{contact_id}")
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/contact_score_value_gateway.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class ContactScoreValueGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(contact_id, **params)
+        @config.get("/contacts/#{contact_id}/scoreValues", query: params)
+      end
+    end
+  end
+end

data/lib/active_campaign_wrapper/core/contact_tag_gateway.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ActiveCampaignWrapper
+  module Core
+    class ContactTagGateway
+      def initialize(client)
+        @client = client
+        @config = client.config
+      end
+
+      def all(contact_id, **params)
+        @config.get("/contacts/#{contact_id}/contactTags", query: params)
+      end
+
+      def create(params)
+        params = { contact_tag: params }
+        @config.post(
+          '/contactTags',
+          body: ActiveCampaignWrapper::Helpers.normalize_body(params)
+        )
+      end
+
+      def delete(contact_tag_id)
+        @config.delete("/contactTags/#{contact_tag_id}")
+      end
+
+      def find(contact_tag_id)
+        @config.get("/contactTags/#{contact_tag_id}")
+      end
+    end
+  end
+end