active_campaign 0.0.12 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ef07b98e74c5fb735346d1892c8bd3a8b0a6ad3
-  data.tar.gz: 0d77124c85dab81705442adfc9af3fab78530b0e
+  metadata.gz: b1cbb2b00815af672e7667806db753a74683784e
+  data.tar.gz: 2ff0355c2990923bd87f48b9f2be58ec7e9ef2f4
 SHA512:
-  metadata.gz: 0c91bafde1b49f1ab0ffee41ab454fb39c0a33f835d1766ef9069055b531df8aeaa9bcbee485b9a9c7f3082590306c2983ad60fc8cda5f0bd135c9057f200b33
-  data.tar.gz: e72487eff7c555c95e7d23474aa60983c5e6b56f79ec237d2f8bde2e56a63675da0d3f845de6cf18430030ff171e2be69435c64a4c4ee743b8a52e350d155c0e
+  metadata.gz: cfda3378d4504362d91b75106ef2cc9a5f4b69d8f4713a2cb5a985b733145bb7bb0da56d6c80c012111eea9a6b9cb1004ee9650b78895d2a1bc226c7de5fffdf
+  data.tar.gz: 05e9bce0b4936f1286819901cc3d4fcfe6dd669c0d06452f268af4912ce47c1c4c487ef8e9978c9538bf5effcc653b8b3b13ba23e99702f8b7a43d3b542f76a0

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -1,3 +1,29 @@
 source 'https://rubygems.org'
 
+gem 'jruby-openssl', :platforms => :jruby
+gem 'rake'
+
+group :development do
+  gem 'awesome_print', :require => 'ap'
+  gem 'guard-rspec', '~> 2.5.1'
+  gem 'hirb-unicode'
+  gem 'pry'
+  gem 'redcarpet'
+  gem 'wirb'
+  gem 'wirble'
+  gem 'yard'
+end
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'json', '~> 1.7', :platforms => [:ruby_18, :jruby]
+  gem 'netrc', '~> 0.7.7'
+  gem 'rb-fsevent', '~> 0.9'
+  gem 'rspec', '~> 2.13.0'
+  gem 'simplecov', :require => false
+  gem 'test-queue', '~> 0.1.3'
+  gem 'vcr', '~> 2.4.0'
+  gem 'webmock', '~> 1.9.0'
+end
+
 gemspec

data/active_campaign.gemspec

@@ -18,15 +18,10 @@ Gem::Specification.new do |spec|
   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"
-  spec.add_dependency 'rake'
-
-  spec.add_development_dependency 'json', '~> 1.7'
-  spec.add_development_dependency 'rspec', '>= 2.14'
-  spec.add_development_dependency 'webmock'
+  spec.add_dependency "faraday", ">= 0.8.8"
+  spec.add_dependency "activesupport", ">= 4.0.0"
+  spec.add_dependency "uri_template"
+  spec.add_dependency "hashie"
+  spec.add_dependency "oj"
+  spec.add_development_dependency 'bundler', '~> 1.0'
 end

data/lib/active_campaign.rb

@@ -1,31 +1,40 @@
-require 'rubygems'
 require 'active_support/core_ext'
-require "active_campaign/version"
-require 'active_campaign/configuration'
-require 'active_campaign/error'
 require 'active_campaign/client'
+require 'active_campaign/default'
 
 module ActiveCampaign
 
-  extend Configuration
-
   class << self
+    include ActiveCampaign::Configurable
 
-    # Alias for ActiveCampaign::Client.new
+    # API client based on configured options {Configurable}
     #
-    # @return [ActiveCampaign::Client]
-    def new(options={})
-      ActiveCampaign::Client.new(options)
-    end
+    # @return [ActiveCampaign::Client] API wrapper
+    def client
+      unless defined?(@client) && @client.same_options?(options)
+        @client = 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)
+      @client
     end
 
-    def respond_to?(method, include_private=false)
-      new.respond_to?(method, include_private) || super(method, include_private)
+    # @private
+    def respond_to_missing?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private)
+    end if RUBY_VERSION >= "1.9"
+
+    # @private
+    def respond_to?(method_name, include_private=false)
+      client.respond_to?(method_name, include_private) || super
+    end if RUBY_VERSION < "1.9"
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
     end
   end
+
+  ActiveCampaign.setup
 end

data/lib/active_campaign/arguments.rb

@@ -0,0 +1,14 @@
+module ActiveCampaign
+
+  # Extracts options from method arguments
+  # @private
+  class Arguments < Array
+    attr_reader :options
+
+    def initialize(args)
+      @options = args.last.is_a?(::Hash) ? args.pop : {}
+      super(args)
+    end
+
+  end
+end

data/lib/active_campaign/authentication.rb

@@ -0,0 +1,68 @@
+module ActiveCampaign
+
+  # Authentication methods for {ActiveCampaign::Client}
+  module Authentication
+
+    # Indicates if the client was supplied  Basic Auth
+    # username and password
+    #
+    # @see http://developer.github.com/v3/#authentication
+    # @return [Boolean]
+    def basic_authenticated?
+      @login && @password
+    end
+
+    # Indicates if the client was supplied an OAuth
+    # access token
+    #
+    # @see http://developer.github.com/v3/#authentication
+    # @return [Boolean]
+    def token_authenticated?
+      !!@access_token
+    end
+
+    # Indicates if the client was supplied an OAuth
+    # access token or Basic Auth username and password
+    #
+    # @see http://developer.github.com/v3/#authentication
+    # @return [Boolean]
+    def user_authenticated?
+      basic_authenticated? || token_authenticated?
+    end
+
+    # Indicates if the client has OAuth Application
+    # client_id and secret credentials to make anonymous
+    # requests at a higher rate limit
+    #
+    # @see http://developer.github.com/v3/#unauthenticated-rate-limited-requests
+    # @return Boolean
+    def application_authenticated?
+      !!application_authentication
+    end
+
+    private
+
+    def application_authentication
+      if @client_id && @client_secret
+        {
+          :client_id     => @client_id,
+          :client_secret => @client_secret
+        }
+      end
+    end
+
+    def login_from_netrc
+      return unless netrc?
+
+      require 'netrc'
+      info = Netrc.read netrc_file
+      netrc_host = URI.parse(api_endpoint).host
+      creds = info[netrc_host]
+      self.login = creds.shift
+      self.password = creds.shift
+    rescue LoadError
+      warn "Please install netrc gem for .netrc support"
+    end
+
+  end
+end

data/lib/active_campaign/client.rb

@@ -1,27 +1,214 @@
-require 'active_campaign/connection'
-require 'active_campaign/request'
-
-
+require 'faraday'
+require 'uri_template'
+require 'active_campaign/arguments'
+require 'active_campaign/authentication'
+require 'active_campaign/configurable'
 require 'active_campaign/client/contacts'
 require 'active_campaign/client/lists'
 require 'active_campaign/client/campaigns'
 
 module ActiveCampaign
   class Client
-    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+    include ActiveCampaign::Configurable
+    include ActiveCampaign::Authentication
+    include ActiveCampaign::Client::Contacts
+    include ActiveCampaign::Client::Lists
+    include ActiveCampaign::Client::Campaigns
+
+    NO_BODY = Set.new([:get, :head])
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new [:accept]
 
-    def initialize(options={})
-      options = ActiveCampaign.options.merge(options)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      ActiveCampaign::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] ||
+          ActiveCampaign.instance_variable_get(:"@#{key}"))
       end
     end
 
-    include ActiveCampaign::Connection
-    include ActiveCampaign::Request
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
 
-    include ActiveCampaign::Client::Contacts
-    include ActiveCampaign::Client::Lists
-    include ActiveCampaign::Client::Campaigns
+    # Text representation of the client, masking tokens and passwords
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      # mask password
+      inspected = inspected.gsub! @password, "*******" if @password
+      # Only show last 4 of token, secret
+      if @access_token
+        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
+      end
+      if @client_secret
+        inspected = inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}"
+      end
+
+      inspected
+    end
+
+      # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(api_method, options = {})
+      request :get, api_method, parse_query_and_convenience_headers(options)
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(api_method, options = {})
+      request :post, api_method, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(api_method, options = {})
+      request :put, api_method, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(api_method, options = {})
+      request :patch, api_method, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(api_method, options = {})
+      request :delete, api_method, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(api_method, options = {})
+      request :head, api_method, parse_query_and_convenience_headers(options)
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response
+    end
+
+    private
+
+      def request(method, api_method, data)
+        options = {}
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+
+        options[:query].merge!({
+          api_key: api_key,
+          api_action: api_method.to_s,
+          api_output: api_output
+        })
+
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+
+        @last_response = response = process_request(
+          method, URI.encode(api_path), data, options
+        )
+
+        response
+      end
+
+      def connection
+        @conn ||= Faraday.new do |builder|
+
+          builder.request  :url_encoded
+
+          builder.response :mashify
+          builder.response :json_normalizer
+          builder.response :parse_json #, content_type: /\bjson$/
+
+          if debug
+            builder.use :debugger
+            builder.use :instrumentation
+          end
+
+          builder.adapter  Faraday.default_adapter
+          builder.url_prefix = api_endpoint
+        end
+        # @conn.url_prefix api_endpoint
+        @conn
+      end
+
+
+      def process_request(method, url, data = {}, options = {})
+        if NO_BODY.include?(method)
+          options ||= data
+          data      = nil
+        end
+        options ||= {}
+        url = expand_url(url, options[:uri])
+
+        res = connection.send method, url do |req|
+          req.body = data if data
+          if params = options[:query]
+            req.params.update params
+          end
+          if headers = options[:headers]
+            req.headers.update headers
+          end
+        end
+        res.body
+      end
+
+      # Executes the request, checking if it was successful
+      #
+      # @return [Boolean] True on success, false otherwise
+      def boolean_from_response(method, path, options = {})
+        request(method, path, options)
+        @last_response.status == 204
+      rescue ActiveCampaign::NotFound
+        false
+      end
+
+      def parse_query_and_convenience_headers(options)
+        headers = options.fetch(:headers, {})
+        CONVENIENCE_HEADERS.each do |h|
+          if header = options.delete(h)
+            headers[h] = header
+          end
+        end
+        query = options.delete(:query)
+        opts = {:query => options}
+        opts[:query].merge!(query) if query && query.is_a?(Hash)
+        opts[:headers] = headers unless headers.empty?
+
+        opts
+      end
+      def expand_url(url, options = nil)
+        tpl = url.respond_to?(:expand) ? url : URITemplate.new(url.to_s)
+        expand = tpl.method(:expand)
+        options ? expand.call(options) : expand.call
+      end
   end
 end

data/lib/active_campaign/configurable.rb

@@ -0,0 +1,84 @@
+module ActiveCampaign
+
+  # Configuration options for {Client}, defaulting to values
+  # in {Default}
+  module Configurable
+
+    # @!attribute connection_options
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Hash] Configure connection options for Faraday
+    # @!attribute middleware
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Faraday::Builder] Configure middleware for Faraday
+    # @!attribute per_page
+    #   @return [String] Configure page size for paginated results. API default: 30
+    # @!attribute user_agent
+    #   @return [String] Configure User-Agent header for requests.
+    # @!attribute web_endpoint
+    #   @return [String] Base URL for web URLs. default: https://github.com/
+
+    attr_accessor :api_url, :api_key, :api_output, :api_path, :api_action,
+      :list_id, :api_endpoint, :proxy, :user_agent,
+      :debug, :per_page, :connection_options,
+      :api_endpoint, :auto_paginate,
+      :default_media_type, :connection_options,
+      :middleware, :user_agent, :web_endpoint
+
+    attr_writer :client_secret, :password
+
+    class << self
+
+      # List of configurable keys for {ActiveCampaign::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :api_key,
+          :api_path,
+          :api_output,
+          :api_endpoint,
+          :user_agent,
+          :debug,
+          :per_page,
+          :connection_options,
+          :auto_paginate,
+          :default_media_type,
+          :connection_options,
+          :middleware,
+          :user_agent,
+          :web_endpoint
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      ActiveCampaign::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", ActiveCampaign::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    def api_endpoint
+      File.join(@api_endpoint, "")
+    end
+
+    # Base URL for generated web URLs
+    #
+    # @return [String] Default: https://www.activecampaign.com/
+    def web_endpoint
+      File.join(@web_endpoint, "")
+    end
+
+    private
+
+      def options
+        Hash[ActiveCampaign::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+      end
+  end
+end