active_campaign 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c9f4c41bd412aaef640f75d80a340c63864bd63
+  data.tar.gz: 44387b1eb38a407c215b4b6df50f82250e8a599d
+SHA512:
+  metadata.gz: ee3763d8f076c080f6e2ae84adbc358a2578b96bbcdec0b0b4d258135ee5abd3ee357b62f2a17cf0b17d5c00a7dbd367ebdc26dff24d7f05b5d7caf146db1e9b
+  data.tar.gz: 55e38a282f58287e668bad9d1bcbec197680d8a630724399d7956bbac0640a72fc355c3e1e933ff3ac8fd160a44578f3a4cc5973b282570248dd69cfe2343ddc

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--order random

data/.travis.yml

@@ -0,0 +1,13 @@
+before_script:
+  - chmod 600 spec/fixtures/.netrc
+bundler_args: --without development
+language: ruby
+rvm:
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+gem 'rake'
+gem 'yard'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'guard-rspec'
+  gem 'json', '~> 1.7', :platforms => [:ruby_18, :jruby]
+  gem 'rspec', '>= 2.13'
+  gem 'simplecov', :require => false
+  gem 'webmock'
+  gem 'test-queue'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mikael Henriksson
+
+MIT License
+
+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,29 @@
+# Active::Campaign::Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active-campaign'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active-campaign
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/active_campaign.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_campaign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_campaign"
+  spec.version       = ActiveCampaign::VERSION
+  spec.authors       = ["Mikael Henriksson"]
+  spec.email         = ["mikael@zoolutions.se"]
+  spec.description   = %q{A simple ruby wrapper for the ActiveCampaign API}
+  spec.summary       = %q{See http://www.activecampaign.com/api/overview.php for more information}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httpclient",         "~> 2.3"
+  spec.add_dependency "hashie",             "~> 2.0"
+  spec.add_dependency "activesupport",      ">= 4.0.0"
+  spec.add_dependency "faraday",            "~> 0.8"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "multi_json",         "~> 1.7"
+end

data/lib/active_campaign/client/campaigns.rb

@@ -0,0 +1,45 @@
+module ActiveCampaign
+  class Client
+    module Campaigns
+      CONTACT_METHODS = %w[
+        create delete_list delete list paginator report_bounce_list
+        report_bounce_totals report_forward_list report_forward_totals
+        report_link_list report_link_totals report_open_list report_open_totals
+        report_totals report_unopen_list report_unsubscription_list
+        report_unsubscription_totals send status
+      ]
+      CONTACT_POST_METHODS = %w[create]
+
+      extend ActiveSupport::Concern
+
+      # TODO: Create proper methods with parameter validation and possible naming fixes since this is one the worst APIs I have ever worked with.
+      included do
+        CONTACT_METHODS.each do |method|
+          define_method "contact_#{method}" do |options|
+            if CONTACT_POST_METHODS.include?(method)
+              post __method__, options
+            else
+              get __method__, options
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# contact_sync - parameters
+# email             - Email of the new subscriber. Example: 'test@example.com'
+# first_name        - First name of the subscriber. Example: 'FirstName'
+# last_name         - Last name of the subscriber. Example: 'LastName'
+# ip4               - IP address of the subscriber. Example: '127.0.0.1' If not supplied, it will default to '127.0.0.1'
+# field[345,0]      - Custom field values. Example: field[345,0] = 'value'. In this example, "345" is the field ID. Leave 0 as is.
+# field[%PERS_1%,0] - 'value' (You can also use the personalization tag to specify which field you want updated)
+#               - Assign to lists. List ID goes in brackets, as well as the value.
+# status[123]       - The status for each list the subscriber is added to. Examples: 1 = active, 2 = unsubscribed
+# form              - Optional subscription Form ID, to inherit those redirection settings. Example: 1001. This will allow you to mimic adding the subscriber through a subscription form, where you can take advantage of the redirection settings.
+# noresponders[123] - Whether or not to set "do not send any future responders." Examples: 1 = yes, 0 = no.
+# sdate[123]        - Subscribe date for particular list - leave out to use current date/time. Example: '2009-12-07 06:00:00'
+# instantresponders[123]  Use only if status = 1. Whether or not to set "send instant responders." Examples: 1 = yes, 0 = no.
+# lastmessage[123]  - Whether or not to set "send the last broadcast campaign." Examples: 1 = yes, 0 = no.
+# "field[%BALANCE%,0]": "100"

data/lib/active_campaign/client/contacts.rb

@@ -0,0 +1,39 @@
+module ActiveCampaign
+  class Client
+    module Contacts
+      CONTACT_METHODS = %w[add delete_list delete edit list paginator sync view]
+      CONTACT_POST_METHODS = %w[add edit sync]
+
+      extend ActiveSupport::Concern
+
+      # TODO: Create proper methods with parameter validation and possible naming fixes since this is one the worst APIs I have ever worked with.
+      included do
+        CONTACT_METHODS.each do |method|
+          define_method "contact_#{method}" do |options|
+            if CONTACT_POST_METHODS.include?(method)
+              post __method__, options
+            else
+              get __method__, options
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# contact_sync - parameters
+# email             - Email of the new subscriber. Example: 'test@example.com'
+# first_name        - First name of the subscriber. Example: 'FirstName'
+# last_name         - Last name of the subscriber. Example: 'LastName'
+# ip4               - IP address of the subscriber. Example: '127.0.0.1' If not supplied, it will default to '127.0.0.1'
+# field[345,0]      - Custom field values. Example: field[345,0] = 'value'. In this example, "345" is the field ID. Leave 0 as is.
+# field[%PERS_1%,0] - 'value' (You can also use the personalization tag to specify which field you want updated)
+#               - Assign to lists. List ID goes in brackets, as well as the value.
+# status[123]       - The status for each list the subscriber is added to. Examples: 1 = active, 2 = unsubscribed
+# form              - Optional subscription Form ID, to inherit those redirection settings. Example: 1001. This will allow you to mimic adding the subscriber through a subscription form, where you can take advantage of the redirection settings.
+# noresponders[123] - Whether or not to set "do not send any future responders." Examples: 1 = yes, 0 = no.
+# sdate[123]        - Subscribe date for particular list - leave out to use current date/time. Example: '2009-12-07 06:00:00'
+# instantresponders[123]  Use only if status = 1. Whether or not to set "send instant responders." Examples: 1 = yes, 0 = no.
+# lastmessage[123]  - Whether or not to set "send the last broadcast campaign." Examples: 1 = yes, 0 = no.
+# "field[%BALANCE%,0]": "100"

data/lib/active_campaign/client/lists.rb

@@ -0,0 +1,23 @@
+module ActiveCampaign
+  class Client
+    module Lists
+      LIST_API_METHODS = %w[add delete_list delete edit field_add field_delete field_edit field_view list paginator view]
+      LIST_POST_METHODS = %w[add edit]
+
+      extend ActiveSupport::Concern
+
+      # TODO: Create proper methods with parameter validation and possible naming conversion since this is one the worst APIs I have ever worked with.
+      included do
+        LIST_API_METHODS.each do |method|
+          define_method "list_#{method}" do |options|
+            if LIST_POST_METHODS.include?(method)
+              post __method__, options
+            else
+              get __method__, options
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_campaign/client/messages.rb

@@ -0,0 +1,44 @@
+module ActiveCampaign
+  class Client
+    module Messages
+      CONTACT_METHODS = %w[
+        add delete_list delete edit list template_add template_delete_list
+        template_delete template_edit template_export template_import
+        template_list template_view view
+      ]
+      CONTACT_POST_METHODS = %w[add edit]
+
+      extend ActiveSupport::Concern
+
+      # TODO: Create proper methods with parameter validation and possible
+      # naming fixes since this is one the worst APIs I have ever worked with.
+      included do
+        CONTACT_METHODS.each do |method|
+          define_method "contact_#{method}" do |options|
+            if CONTACT_POST_METHODS.include?(method)
+              post __method__, options
+            else
+              get __method__, options
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# contact_sync - parameters
+# email             - Email of the new subscriber. Example: 'test@example.com'
+# first_name        - First name of the subscriber. Example: 'FirstName'
+# last_name         - Last name of the subscriber. Example: 'LastName'
+# ip4               - IP address of the subscriber. Example: '127.0.0.1' If not supplied, it will default to '127.0.0.1'
+# field[345,0]      - Custom field values. Example: field[345,0] = 'value'. In this example, "345" is the field ID. Leave 0 as is.
+# field[%PERS_1%,0] - 'value' (You can also use the personalization tag to specify which field you want updated)
+#               - Assign to lists. List ID goes in brackets, as well as the value.
+# status[123]       - The status for each list the subscriber is added to. Examples: 1 = active, 2 = unsubscribed
+# form              - Optional subscription Form ID, to inherit those redirection settings. Example: 1001. This will allow you to mimic adding the subscriber through a subscription form, where you can take advantage of the redirection settings.
+# noresponders[123] - Whether or not to set "do not send any future responders." Examples: 1 = yes, 0 = no.
+# sdate[123]        - Subscribe date for particular list - leave out to use current date/time. Example: '2009-12-07 06:00:00'
+# instantresponders[123]  Use only if status = 1. Whether or not to set "send instant responders." Examples: 1 = yes, 0 = no.
+# lastmessage[123]  - Whether or not to set "send the last broadcast campaign." Examples: 1 = yes, 0 = no.
+# "field[%BALANCE%,0]": "100"

data/lib/active_campaign/client.rb

@@ -0,0 +1,25 @@
+require 'active_campaign/connection'
+require 'active_campaign/request'
+
+
+require 'active_campaign/client/contacts'
+require 'active_campaign/client/lists'
+
+module ActiveCampaign
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = ActiveCampaign.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include ActiveCampaign::Connection
+    include ActiveCampaign::Request
+
+    include ActiveCampaign::Client::Contacts
+    include ActiveCampaign::Client::Lists
+  end
+end

data/lib/active_campaign/configuration.rb

@@ -0,0 +1,73 @@
+require 'faraday'
+require 'active_campaign/version'
+
+module ActiveCampaign
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :api_url,
+      :api_key,
+      :api_output,
+      :api_path,
+      :api_action,
+      :list_id,
+      :faraday_config_block,
+      :api_version,
+      :api_endpoint,
+      :proxy,
+      :user_agent,
+      :request_host,
+      :auto_traversal,
+      :adapter,
+      :log_requests,
+      :per_page].freeze
+
+    DEFAULT_ADAPTER             = Faraday.default_adapter
+    DEFAULT_API_VERSION         = 3
+    DEFAULT_API_ENDPOINT        = ENV["ACTIVECAMPAIGN_API_ENDPOINT"]  || "https://yourdomain.activehosted.com"
+    DEFAULT_API_PATH            = ENV["ACTIVECAMPAIGN_API_PATH"]      || "admin/api.php"
+    DEFAULT_API_OUTPUT          = ENV["ACTIVECAMPAIGN_API_OUTPUT"]    || "json"
+    DEFAULT_USER_AGENT          = "ActiveCampaign Ruby Gem #{ActiveCampaign::VERSION}".freeze
+    DEFAULT_AUTO_TRAVERSAL      = false
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def api_endpoint=(value)
+      @api_endpoint = File.join(value, "")
+    end
+
+    def api_key=(value)
+      @api_key = value.chomp
+    end
+
+    def faraday_config(&block)
+      @faraday_config_block = block
+    end
+
+    def reset
+      self.adapter         = DEFAULT_ADAPTER
+      self.api_version     = DEFAULT_API_VERSION
+      self.api_endpoint    = DEFAULT_API_ENDPOINT
+      self.api_path        = DEFAULT_API_PATH
+      self.api_output      = DEFAULT_API_OUTPUT
+      self.list_id         = nil
+      self.proxy           = nil
+      # self.url_params      = {}
+      self.request_host    = nil
+      self.user_agent      = DEFAULT_USER_AGENT
+      self.auto_traversal  = DEFAULT_AUTO_TRAVERSAL
+      self.log_requests    = false
+    end
+  end
+end

data/lib/active_campaign/connection.rb

@@ -0,0 +1,50 @@
+require 'faraday_middleware'
+require 'faraday/response/raise_active_campaign_error'
+require 'faraday/response/body_logger'
+
+module ActiveCampaign
+
+  # @private
+  module Connection
+    private
+
+    def connection(options={})
+      options = {
+        force_urlencoded: true,
+        raw:              false
+      }.merge(options)
+
+      if !proxy.nil?
+        options.merge!(proxy: proxy)
+      end
+
+      # TODO: Don't build on every request
+      connection = Faraday.new(options) do |conn|
+
+        if options[:force_urlencoded]
+          conn.request :url_encoded
+        else
+          conn.request :json
+        end
+
+
+        conn.use Faraday::Response::RaiseActiveCampaignError
+        conn.use FaradayMiddleware::FollowRedirects
+        if api_output == 'json'
+          conn.response :mashify, content_type: /\bjson$/
+          conn.response :json, content_type: /\bjson$/
+        end
+        faraday_config_block.call(conn) if faraday_config_block
+        if log_requests
+          conn.response :body_logger
+          conn.use :instrumentation
+        end
+
+        conn.adapter *adapter
+      end
+
+      connection.headers[:user_agent] = user_agent
+      connection
+    end
+  end
+end

data/lib/active_campaign/error.rb

@@ -0,0 +1,68 @@
+module ActiveCampaign
+  # Custom error class for rescuing from all ActiveCampaign errors
+  class Error < StandardError
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    def response_body
+      @response_body ||=
+        if (body = @response[:body]) && !body.empty?
+          if body.is_a?(String)
+            MultiJson.load(body, :symbolize_keys => true)
+          else
+            body
+          end
+        else
+          nil
+        end
+    end
+
+    private
+
+    def build_error_message
+      return nil  if @response.nil?
+
+      message = if response_body
+        ": #{response_body[:error] || response_body[:message] || ''}"
+      else
+        ''
+      end
+      errors = unless message.empty?
+        response_body[:errors] ?  ": #{response_body[:errors].map{|e|e[:message]}.join(', ')}" : ''
+      end
+      "#{@response[:method].to_s.upcase} #{@response[:url].to_s}: #{@response[:status]}#{message}#{errors}"
+    end
+  end
+
+  # Raised when ActiveCampaign returns a 400 HTTP status code
+  class BadRequest < Error; end
+
+  # Raised when ActiveCampaign returns a 401 HTTP status code
+  class Unauthorized < Error; end
+
+  # Raised when ActiveCampaign returns a 403 HTTP status code
+  class Forbidden < Error; end
+
+  # Raised when ActiveCampaign returns a 404 HTTP status code
+  class NotFound < Error; end
+
+  # Raised when ActiveCampaign returns a 406 HTTP status code
+  class NotAcceptable < Error; end
+
+  # Raised when ActiveCampaign returns a 422 HTTP status code
+  class UnprocessableEntity < Error; end
+
+  # Raised when ActiveCampaign returns a 500 HTTP status code
+  class InternalServerError < Error; end
+
+  # Raised when ActiveCampaign returns a 501 HTTP status code
+  class NotImplemented < Error; end
+
+  # Raised when ActiveCampaign returns a 502 HTTP status code
+  class BadGateway < Error; end
+
+  # Raised when ActiveCampaign returns a 503 HTTP status code
+  class ServiceUnavailable < Error; end
+end

data/lib/active_campaign/param_validation.rb

@@ -0,0 +1,12 @@
+module ActiveCampaign
+  module ParamValidation
+    def filter_params(allowed_keys = [], params = {})
+      params.keys.select do |k,v|
+        allowed_keys.each do |param|
+          params.include?(k) ||
+          param.match(k)
+        end
+      end
+    end
+  end
+end

data/lib/active_campaign/request.rb

@@ -0,0 +1,85 @@
+require 'multi_json'
+
+module ActiveCampaign
+  module Request
+
+    def delete(api_method, options={})
+      request(:delete, api_method, options).body
+    end
+
+    def get(api_method, options={})
+      request(:get, api_method, options).body
+    end
+
+    def patch(api_method, options={})
+      request(:patch, api_method, options).body
+    end
+
+    def post(api_method, options={})
+      request(:post, api_method, options).body
+    rescue => e
+      puts e, e.backtrace
+      binding.pry
+    end
+
+    def put(api_method, options={})
+      request(:put, api_method, options).body
+    end
+
+    private
+
+      # Executes the request, checking if it was successful
+      #
+      # @return [Boolean] True on success, false otherwise
+      def boolean_from_response(method, api_method, options={})
+       request(method, api_method, options).status == 204
+      rescue ActiveCampaign::NotFound
+        false
+      end
+
+      def path(api_method)
+        "#{api_path}?#{url_params(api_method).map{|k,v| "#{k}=#{v}" }.join('&')}"
+      end
+
+      def url_params(api_method)
+        {
+          api_key: api_key,
+          api_action: api_method,
+          api_output: api_output,
+        }
+      end
+
+      def request(method, api_method, options={})
+
+        force_urlencoded = options.delete(:force_urlencoded) || false
+        url = options.delete(:endpoint) || api_endpoint
+
+        conn_options = {
+          :force_urlencoded => force_urlencoded,
+          :url => url
+        }
+
+        response = connection(conn_options).send(method) do |request|
+          case method
+          when :get, :delete, :head
+            options.reverse_merge!(url_params(api_method))
+            request.url(api_path, options)
+          when :patch, :post, :put
+            request.url(api_path, url_params(api_method))
+            if force_urlencoded
+              request.body = options unless options.empty?
+            else
+              request.body = MultiJson.dump(options) unless options.empty?
+            end
+          end
+
+          if ActiveCampaign.request_host
+            request.headers['Host'] = ActiveCampaign.request_host
+          end
+
+        end
+        response
+      end
+
+  end
+end

data/lib/active_campaign/version.rb

@@ -0,0 +1,3 @@
+module ActiveCampaign
+  VERSION = "0.0.2"
+end

data/lib/active_campaign.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'active_support/core_ext'
+require "active_campaign/version"
+require 'active_campaign/configuration'
+require 'active_campaign/error'
+require 'active_campaign/client'
+
+
+require "pry"
+
+module ActiveCampaign
+
+  extend Configuration
+
+  class << self
+
+    # Alias for ActiveCampaign::Client.new
+    #
+    # @return [ActiveCampaign::Client]
+    def new(options={})
+      ActiveCampaign::Client.new(options)
+    end
+
+    # Delegate to ActiveCampaign::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end