contactology 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/contactology.yml

data/.infinity_test

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+infinity_test do
+  notifications :growl
+  use :rubies => %w(1.9.2-p180 1.8.7-p334), :gemset => 'contactology', :test_framework => :rspec
+
+  before_run do
+    clear :terminal
+  end
+
+  heuristics do
+    add('lib/') do |file|
+      run :all => :tests
+    end
+  end
+end

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--tty

data/.rvmrc

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@contactology"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s ".rvm/hooks/after_use" ]]
+  then
+    . ".rvm/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment 'ruby-1.8.7-p334@contactology'."
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+

data/.watchr

@@ -0,0 +1,36 @@
+def run_spec(file)
+  unless File.exist?(file)
+    puts "#{file} does not exist"
+    return
+  end
+
+  puts "Running #{file}"
+  system "bundle exec rspec --format documentation #{file}"
+  puts
+end
+
+def run_all_specs
+  puts "Running all specs"
+  system "bundle exec rspec spec/"
+  puts
+end
+
+
+watch("spec/.*_spec\.rb") do |match|
+  run_spec match[0]
+end
+
+watch("lib/(.*)\.rb") do |match|
+  run_spec %{spec/models/#{match[1]}_spec.rb}
+end
+
+watch("spec/(spec_helper|support/.*)\.rb$") do |match|
+  run_all_specs
+end
+
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts
+  run_all_specs
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'webmock', :git => 'https://github.com/bblimke/webmock.git', :ref => 'af4c05480571905be786fc35b8b9703c3ea7fe6c'
+end

data/Rakefile

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

data/contactology.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'contactology/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'contactology'
+  s.version     = Contactology::VERSION
+  s.authors     = ['Nathaniel Bibler']
+  s.email       = ['git@nathanielbibler.com']
+  s.homepage    = 'https://github.com/nbibler/contactology'
+  s.summary     = %q{A Ruby interface to the Contactology email marketing API}
+  s.description = %q{This library provides Ruby calls to interact with the Contactology email marketing API}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'hashie', '~> 1.1'
+  s.add_dependency 'httparty'
+
+  s.add_development_dependency 'vcr', '~> 1.5'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'infinity_test'
+  s.add_development_dependency 'factory_girl', '~> 2.0'
+  s.add_development_dependency 'rack', '~> 1.2'
+  s.add_development_dependency 'watchr'
+end

data/lib/contactology.rb

@@ -0,0 +1,125 @@
+require 'contactology/version'
+require 'contactology/errors'
+require 'contactology/campaigns/standard'
+require 'contactology/campaigns/transactional'
+require 'contactology/contact'
+require 'contactology/transactional_message'
+require 'contactology/configuration'
+require 'contactology/list'
+require 'contactology/list_proxy'
+
+##
+# This library provides an interface to the
+# Contactology[http://www.contactology.com/] v2, "REST-based"
+# {email marketing API}[http://www.contactology.com/email-marketing-api/].
+#
+# Example usage:
+#
+#   require 'contactology'
+#
+#   Contactology.configuration do |config|
+#     config.key = 'aBcDeFg12345'
+#   end
+#
+#   list = Contactology::List.find(4)
+#   # => #<Contactology::List:0x000... @list_id="4" @name="test list" ...>
+#
+#   list.subscribe('joe@example.local')
+#   # => true
+#
+#   contact = Contactology::Contact.find('joe@example.local')
+#   # => #<Contactology::Contact:0x000... @email="joe@example.local" ...>
+#
+#   contact.lists
+#   # => [#<Contactology::List:0x000... @list_id="4" ...>]
+#
+module Contactology
+  ##
+  # Public: Primary accessor for reading or manipulating the default
+  # configuration.
+  #
+  # Examples
+  # 
+  #   Contactology.configuration do |config|
+  #     config.key = 'newkey'
+  #   end
+  #
+  #   Contactology.configuration
+  #   # => #<Contactology::Configuration:0x000...>
+  #
+  # Returns the default Contactology::Configuration instance.
+  #
+  def self.configuration
+    @@_configuration ||= Contactology::Configuration.new
+    yield @@_configuration if block_given?
+    @@_configuration
+  end
+
+  ##
+  # Public: Explicitly sets the default configuration by replacing it with the
+  # instance given.
+  #
+  # configuration - A Contactology::Configuration instance.
+  #
+  # Examples
+  #
+  #   Contactology.configuration = Contactology::Configuration.new
+  #   # => #<Contactology::Configuration:0x000...>
+  #
+  # Returns nothing.
+  # Raises ArgumentError unless given a Contactology::Configuration instance.
+  #
+  def self.configuration=(configuration)
+    raise ArgumentError, 'Expected a Contactology::Configuration instance' unless configuration.kind_of?(Configuration)
+    @@_configuration = configuration
+  end
+
+  ##
+  # Public: Alias to Contactology.configuration.
+  #
+  # Returns the default Contactology::Configuration instance.
+  #
+  def self.configure(&block)
+    configuration(&block)
+  end
+
+  ##
+  # Public: Shorthand reader of the default configuration's endpoint.
+  #
+  # Returns the String endpoint from the default configuration.
+  #
+  def self.endpoint
+    configuration.endpoint
+  end
+
+  ##
+  # Public: Shorthand writer to the default configuration's endpoint.
+  #
+  # endpoint = The String to use for the API endpoint.
+  #
+  # Returns nothing.
+  #
+  def self.endpoint=(endpoint)
+    configuration.endpoint = endpoint
+  end
+
+  ##
+  # Public: Shorthand reader of the default configuration's key.
+  #
+  # Returns the String key from the default configuration.
+  #
+  def self.key
+    configuration.key
+  end
+
+  ##
+  # Public: Shortand writer to the default configuration's key.
+  #
+  # key - The String to use for the API key.
+  #
+  # Returns nothing.
+  #
+  def self.key=(key)
+    configuration.key = key
+  end
+end

data/lib/contactology/api.rb

@@ -0,0 +1,80 @@
+require 'httparty'
+require 'contactology/parser'
+
+module Contactology::API
+  def query(method, attributes = {})
+    configuration = extract_configuration!(attributes)
+    handlers = extract_handlers!(attributes)
+    remove_empty_values!(attributes)
+
+    response = HTTParty.get(configuration.endpoint, {
+      :query => {:key => configuration.key, :method => method}.merge(attributes),
+      :headers => request_headers,
+      :parser => request_parser
+    })
+
+    handle_query_response(response, handlers)
+  rescue Timeout::Error
+    call_response_handler(handlers[:on_timeout], nil)
+  end
+
+  def request_headers
+      { 'Accept' => 'application/json', 'User-Agent' => user_agent_string }
+  end
+
+
+  protected
+
+
+  def call_response_handler(handler, response)
+    unless handler.nil?
+      case handler
+      when Proc
+        handler.call(response)
+      when NilClass
+        response
+      else
+        handler
+      end
+    end
+  end
+
+  def extract_configuration!(hash)
+    hash.delete(:configuration) || Contactology.configuration
+  end
+
+  def extract_handlers!(hash)
+    handlers = {}
+    [:on_timeout, :on_success, :on_error].each { |key| handlers[key] = hash.delete(key) }
+    handlers
+  end
+
+  def handle_query_response(response, handlers)
+    case
+    when response.code == 200
+      if response.parsed_response.kind_of?(Hash) &&
+        (response['result'] == 'error' || response['success'].kind_of?(FalseClass))
+        call_response_handler(handlers[:on_error], response)
+      else
+        call_response_handler(handlers[:on_success], response)
+      end
+    else
+      call_response_handler(handlers[:on_error], response)
+    end
+  end
+
+  def remove_empty_values!(hash)
+    hash.each_pair do |k,v|
+      hash.delete(k) if v.nil?
+      remove_empty_values!(v) if v.kind_of?(Hash)
+    end
+  end
+
+  def request_parser
+    Contactology::Parser
+  end
+
+  def user_agent_string
+    "contactology/#{Contactology::VERSION} (Rubygems; Ruby #{RUBY_VERSION} #{RUBY_PLATFORM})"
+  end
+end

data/lib/contactology/basic_object.rb

@@ -0,0 +1,21 @@
+module Contactology
+  if defined? ::BasicObject
+    # A class with no predefined methods that behaves similarly to Builder's
+    # BlankSlate. Used for proxy classes.
+    class BasicObject < ::BasicObject
+      undef_method :==
+      undef_method :equal?
+
+      # Let ActiveSupport::BasicObject at least raise exceptions.
+      def raise(*args)
+        ::Object.send(:raise, *args)
+      end
+    end
+  else
+    class BasicObject #:nodoc:
+      instance_methods.each do |m|
+        undef_method(m) if m.to_s !~ /(?:^__|^nil\?$|^send$|^object_id$)/
+      end
+    end
+  end
+end

data/lib/contactology/campaign.rb

@@ -0,0 +1,127 @@
+require 'contactology/stash'
+require 'contactology/api' 
+require 'contactology/send_result'
+
+module Contactology
+  ##
+  # Campaigns represent mailing objects on Contactology.  These objects may be
+  # "standard," meaning that they go out to a List, or "transactional," meaning
+  # that they're generated per recipient and used multiple times.
+  #
+  class Campaign < Contactology::Stash
+    autoload :Preview, 'contactology/campaign/preview'
+
+    extend API
+
+    property :content
+    property :content_type, :from => :contentType
+    property :id, :from => :campaignId
+    property :name, :from => :campaignName
+    property :recipient_name, :from => :recipientName
+    property :recipients
+    property :reply_to_email, :from => :replyToEmail
+    property :reply_to_name, :from => :replyToName
+    property :sender_email, :from => :senderEmail
+    property :sender_name, :from => :senderName
+    property :status
+    property :subject
+    property :type
+    property :start_time, :from => :startTime
+    property :authenticate
+    property :track_replies, :from => :trackReplies
+    property :show_in_archive, :from => :showInArchive
+    property :view_in_browser, :from => :viewInBrowser
+    property :track_opens, :from => :trackOpens
+    property :track_click_thru_html, :from => :trackClickThruHTML
+    property :track_click_thru_text, :from => :trackClickThruText
+    property :google_analytics_name, :from => :googleAnalyticsName
+    property :automatic_tweet, :from => :automaticTweet
+    property :click_tale_name, :from => :clickTaleName
+    property :click_tale_custom_fields, :from => :clickTaleCustomFields
+    property :custom_fields, :from => :customFields
+
+
+    ##
+    # Public: Creates a new Campaign on Contactology. This method should not
+    # be directly called, but instead called through the Standard or
+    # Transactional campaign classes.
+    #
+    # Returns a campaign instance when successful.
+    # Returns false when unsuccessful.
+    #
+    def self.create(attributes, options = {})
+      campaign = new(attributes)
+      campaign.save(options) ? campaign : false
+    end
+
+    ##
+    # Public: Load the campaign details for a given Contactology Campaign ID.
+    #
+    # Returns a Contactology::Campaign instance when found.
+    # Returns nil for an unrecognized ID or network error.
+    #
+    def self.find(id, options = {})
+      query('Campaign_Get_Info', options.merge({
+        'campaignId' => id,
+        :on_success => Proc.new { |response|
+          Campaign.new(response) if response.kind_of?(Hash)
+        }
+      }))
+    end
+
+    def self.find_by_name(name, options = {})
+      query('Campaign_Find', options.merge({
+        'searchParameters' => {
+          'campaignName' => name
+        },
+        :on_success => Proc.new { |response|
+          Campaign.new(response.values.first) unless response.nil?
+        }
+      }))
+    end
+
+
+    ##
+    # Public: Removes the Campaign from Contactology.
+    #
+    # Returns true when successful.
+    # Returns false when unsuccessful or for a network error.
+    #
+    def destroy(options = {})
+      self.class.query('Campaign_Delete', options.merge({
+        'campaignId' => id,
+        :on_timeout => false,
+        :on_error => false,
+        :on_success => Proc.new { |response| response }
+      }))
+    end
+
+    ##
+    # Private: This method should be overridden by subclasses of Campaign.
+    #
+    # Raises NotImplementedError.
+    #
+    def save(options = {})
+      raise NotImplementedError
+    end
+
+    ##
+    # Public: Creates the instance on Contactology or raises an exception.
+    #
+    # Returns the campaign instance when successful.
+    # Raises InvalidObjectError when unsuccessful.
+    #
+    def save!(options = {})
+      save(options) || raise(InvalidObjectError)
+    end
+
+    def preview(options = {})
+      self.class.query('Campaign_Preview', options.merge({
+        'campaignId' => id,
+        :on_error => false,
+        :on_timeout => false,
+        :on_success => Proc.new { |response| Preview.new(response) }
+      }))
+    end
+  end
+end