mailchimp 0.0.1.alpha

data/lib/mailchimp/mandrill.rb

@@ -0,0 +1,61 @@
+if defined?(ActionMailer)
+  require File.join(File.dirname(__FILE__), 'handlers', 'mandrill_delivery_handler')
+end
+
+module Mailchimp
+  class Mandrill
+    include HTTParty
+    default_timeout 30
+
+    attr_accessor :api_key, :timeout, :options
+
+    def initialize(api_key = nil, extra_params = {})
+      @api_key = api_key || ENV['MAILCHIMP_API_KEY'] || self.class.api_key
+      @default_params = {
+        :key => @api_key,
+        :options => {
+          :track_opens => true, 
+          :track_clicks => true
+        }
+      }.merge(extra_params)
+    end
+
+    def api_key=(value)
+      @api_key = value
+      @default_params = @default_params.merge({:key => @api_key})
+    end
+
+    def base_api_url
+      "http://mandrillapp.com/api/1.0/"
+    end
+
+    def call(method, params = {})
+      url = "#{base_api_url}#{method}"
+      params = @default_params.merge(params)
+      response = self.class.post(url, :body => params, :timeout => @timeout)
+
+      begin
+        response = JSON.parse(response.body)
+      rescue
+        response = response.body
+      end
+      response
+    end
+
+    def method_missing(method, *args)
+      match = method.to_s.match(/([a-z]*)_([a-z]*)_?([a-z]*)/)
+      method = "#{match[1]}/#{match[2]}#{match[3] == '' ? "" : "-"+match[3]}"
+      args = {} unless args.length > 0
+      args = args[0] if (args.class.to_s == "Array")
+      call(method, args)
+    end
+
+    class << self
+      attr_accessor :api_key
+
+      def method_missing(sym, *args, &block)
+        new(self.api_key).send(sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/mailchimp/sts.rb

@@ -0,0 +1,61 @@
+if defined?(ActionMailer)
+  require File.join(File.dirname(__FILE__), 'handlers', 'sts_delivery_handler')
+end
+
+module Mailchimp
+  class STS
+    include HTTParty
+    default_timeout 30
+
+    attr_accessor :api_key, :timeout, :options
+
+    def initialize(api_key = nil, extra_params = {})
+      @api_key = api_key || ENV['MAILCHIMP_API_KEY'] || self.class.api_key
+      @default_params = {
+        :apikey => @api_key,
+        :options => {
+          :track_opens => true, 
+          :track_clicks => true
+        }
+      }.merge(extra_params)
+    end
+
+    def api_key=(value)
+      @api_key = value
+      @default_params = @default_params.merge({:apikey => @api_key})
+    end
+
+    def base_api_url
+      dc = (@api_key == '' || @api_key == nil) ? '' : "#{@api_key.split("-").last}."
+      "https://#{dc}sts.mailchimp.com/1.0/"
+    end
+
+    def call(method, params = {})
+      url = "#{base_api_url}#{method}"
+      params = @default_params.merge(params)
+      response = self.class.post(url, :body => params, :timeout => @timeout)
+
+      begin
+        response = JSON.parse(response.body)
+      rescue
+        response = response.body
+      end
+      response
+    end
+
+    def method_missing(method, *args)
+      method = method.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } #Thanks for the gsub, Rails
+      args = {} unless args.length > 0
+      args = args[0] if (args.class.to_s == "Array")
+      call(method, args)
+    end
+
+    class << self
+      attr_accessor :api_key
+
+      def method_missing(sym, *args, &block)
+        new(self.api_key).send(sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/mailchimp/version.rb

@@ -0,0 +1,3 @@
+module Mailchimp
+  VERSION = "0.0.1.alpha"
+end

data/lib/mailchimp.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+require 'json'
+require 'cgi'
+
+require "mailchimp/ext/httparty"
+
+require "mailchimp/version"
+require "mailchimp/api"
+require "mailchimp/sts"
+require "mailchimp/mandrill"
+
+module Mailchimp
+end

data/mailchimp.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mailchimp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mailchimp"
+  s.version     = Mailchimp::VERSION
+  s.authors     = ["Chris Kelly"]
+  s.email       = ["chris@highgroove.com"]
+  s.homepage    = ""
+  s.summary     = %q{Mailchimp APIs in Ruby}
+  s.description = %q{This provides Ruby access to (eventually) all of Mailchimp's APIs}
+
+  s.rubyforge_project = "mailchimp"
+
+  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('httparty')
+  
+  s.add_development_dependency('ruby-debug19')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('shoulda')
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('cover_me')
+  s.add_development_dependency('fakeweb')
+end

data/test/integration/api_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class ApiIntegrationTest < Test::Unit::TestCase
+  
+  should "send request to Mailchimp API" do
+    FakeWeb.register_uri(
+      :post,
+      'https://us1.api.mailchimp.com/1.3/?method=ping',
+      body: "Everything's Chimpy!".to_json
+    )
+    expected_request = {"apikey"=>"abc123-us1"}
+    
+    m = Mailchimp::API.new('abc123-us1')
+    assert_equal "Everything's Chimpy!", m.ping
+    assert_equal expected_request, JSON.parse(URI::decode(FakeWeb.last_request.body))
+  end
+
+end

data/test/integration/mandrill_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class MandrillIntegrationTest < Test::Unit::TestCase
+  
+  should "send request to Mandrill API" do
+    FakeWeb.register_uri(
+      :post,
+      'http://mandrillapp.com/api/1.0/users/ping',
+      body: "PONG!"
+    )
+    expected_request = "key=abc123-us1&options[track_opens]=true&options[track_clicks]=true"
+    
+    m = Mailchimp::Mandrill.new('abc123-us1')
+    assert_equal "PONG!", m.users_ping
+    assert_equal expected_request, URI::decode(FakeWeb.last_request.body)
+  end
+
+end

data/test/integration/sts_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class STSIntegrationTest < Test::Unit::TestCase
+  
+  should "send request to STS API" do
+    FakeWeb.register_uri(
+      :post,
+      'https://us1.sts.mailchimp.com/1.0/Ping',
+      body: "Everything's Chimpy!"
+    )
+    expected_request = "apikey=abc123-us1&options[track_opens]=true&options[track_clicks]=true"
+    
+    m = Mailchimp::STS.new('abc123-us1')
+    assert_equal "Everything's Chimpy!", m.ping
+    assert_equal expected_request, URI::decode(FakeWeb.last_request.body)
+  end
+
+end

data/test/lib/api_test.rb

@@ -0,0 +1,191 @@
+require 'test_helper'
+
+class ApiTest < Test::Unit::TestCase
+
+  context "attributes" do
+
+    setup do
+      @api_key = "123-us1"
+    end
+
+    should "have no API by default" do
+      @api = Mailchimp::API.new
+      assert_equal(nil, @api.api_key)
+    end
+
+    should "set an API key in constructor" do
+      @api = Mailchimp::API.new(@api_key)
+      assert_equal(@api_key, @api.api_key)
+    end
+
+    should "set an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
+      ENV['MAILCHIMP_API_KEY'] = @api_key
+      @api = Mailchimp::API.new
+      assert_equal(@api_key, @api.api_key)
+      ENV.delete('MAILCHIMP_API_KEY')
+    end
+
+    should "set an API key via setter" do
+      @api = Mailchimp::API.new
+      @api.api_key = @api_key
+      assert_equal(@api_key, @api.api_key)
+    end
+
+    should "set timeout and get" do
+      @api = Mailchimp::API.new
+      timeout = 30
+      @api.timeout = timeout
+      assert_equal(timeout, @api.timeout)
+    end
+  end
+
+  context "build api url" do
+    setup do
+      @api = Mailchimp::API.new
+      @url = "https://api.mailchimp.com/1.3/?method=sayHello"
+    end
+
+    should "handle empty api key" do
+      expect_post(@url, {"apikey" => nil})
+      @api.say_hello
+    end
+
+    should "handle malformed api key" do
+      @api_key = "123"
+      @api.api_key = @api_key
+      expect_post(@url, {"apikey" => @api_key})
+      @api.say_hello
+    end
+
+    should "handle timeout" do
+      expect_post(@url, {"apikey" => nil}, 120)
+      @api.timeout=120
+      @api.say_hello
+    end
+
+    should "handle api key with dc" do
+      @api_key = "TESTKEY-us1"
+      @api.api_key = @api_key
+      expect_post("https://us1.api.mailchimp.com/1.3/?method=sayHello", {"apikey" => @api_key})
+      @api.say_hello
+    end
+  end
+
+  context "build api body" do
+    setup do
+      @key = "TESTKEY-us1"
+      @api = Mailchimp::API.new(@key)
+      @url = "https://us1.api.mailchimp.com/1.3/?method=sayHello"
+      @body = {"apikey" => @key}
+    end
+
+    should "escape string parameters" do
+      @message = "simon says"
+      expect_post(@url, @body.merge("message" => CGI::escape(@message)))
+      @api.say_hello(:message => @message)
+    end
+
+    should "escape string parameters in an array" do
+      expect_post(@url, @body.merge("messages" => ["simon+says", "do+this"]))
+      @api.say_hello(:messages => ["simon says", "do this"])
+    end
+
+    should "escape string parameters in a hash" do
+      expect_post(@url, @body.merge("messages" => {"simon+says" => "do+this"}))
+      @api.say_hello(:messages => {"simon says" => "do this"})
+    end
+
+    should "escape nested string parameters" do
+      expect_post(@url, @body.merge("messages" => {"simon+says" => ["do+this", "and+this"]}))
+      @api.say_hello(:messages => {"simon says" => ["do this", "and this"]})
+    end
+
+    should "pass through non string parameters" do
+      expect_post(@url, @body.merge("fee" => 99))
+      @api.say_hello(:fee => 99)
+    end
+  end
+
+  context "API instances" do
+    setup do
+      @key = "TESTKEY-us1"
+      @api = Mailchimp::API.new(@key)
+      @url = "https://us1.api.mailchimp.com/1.3/?method=sayHello"
+      @body = {"apikey" => @key}
+      @returns = Struct.new(:body).new(["array", "entries"].to_json)
+    end
+
+    should "produce a good exporter" do
+      @exporter = @api.get_exporter
+      assert_equal(@exporter.api_key, @api.api_key)
+    end
+
+    should "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
+      Mailchimp::API.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
+      assert_nothing_raised do
+        result = @api.say_hello
+      end
+
+      ap result
+    end
+
+    should "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
+      @api.throws_exceptions = true
+      Mailchimp::API.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
+      assert_raise RuntimeError do
+        @api.say_hello
+      end
+    end
+  end
+
+  context "export API" do
+    setup do
+      @key = "TESTKEY-us1"
+      @api = Mailchimp::APIExport.new(@key)
+      @url = "http://us1.api.mailchimp.com/export/1.0/"
+      @body = {:apikey => @key, :id => "listid"}
+      @returns = Struct.new(:body).new(["array", "entries"].to_json)
+    end
+
+    should "handle api key with dc" do
+      @api_key = "TESTKEY-us2"
+      @api = Mailchimp::APIExport.new(@api_key)
+
+      params = {:body => @body, :timeout => nil}
+    
+      url = @url.gsub('us1', 'us2') + "sayHello/"
+      Mailchimp::APIExport.expects(:post).with(url, params).returns(@returns)
+      @api.say_hello(@body)
+    end
+
+    should "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
+      Mailchimp::APIExport.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
+
+      assert_nothing_raised do
+        @api.say_hello(@body)
+      end
+    end
+
+    should "throw exception if configured to and the Export API replies with a JSON hash containing a key called 'error'" do
+      @api.throws_exceptions = true
+      params = {:body => @body, :timeout => nil}
+      Mailchimp::APIExport.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things', 'code' => '123'}.to_json))
+
+      assert_raise RuntimeError do
+        @api.say_hello(@body)
+      end
+    end
+
+  end
+
+  private
+
+  def expect_post(expected_url, expected_body, expected_timeout=nil)
+    Mailchimp::API.expects(:post).with do |url, opts|
+      url == expected_url &&
+      JSON.parse(URI::decode(opts[:body])) == expected_body &&
+      opts[:timeout] == expected_timeout
+    end.returns(Struct.new(:body).new("") )
+  end
+
+end

data/test/lib/mandrill_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class MandrillTest < Test::Unit::TestCase
+  
+  DEFAULT_OPTIONS= {:options=>{:track_opens=>true, :track_clicks=>true}}
+
+  context "attributes" do
+
+    setup do
+      @api_key = "123-us1"
+    end
+
+    should "have no API by default" do
+      @api = Mailchimp::Mandrill.new
+      assert_equal(nil, @api.api_key)
+    end
+
+    should "set an API key in constructor" do
+      @api = Mailchimp::Mandrill.new(@api_key)
+      assert_equal(@api_key, @api.api_key)
+    end
+
+    should "set an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
+      ENV['MAILCHIMP_API_KEY'] = @api_key
+      @api = Mailchimp::Mandrill.new
+      assert_equal(@api_key, @api.api_key)
+      ENV.delete('MAILCHIMP_API_KEY')
+    end
+
+    should "set an API key via setter" do
+      @api = Mailchimp::Mandrill.new
+      @api.api_key = @api_key
+      assert_equal(@api_key, @api.api_key)
+    end
+
+    should "set timeout and get" do
+      @api = Mailchimp::Mandrill.new
+      timeout = 30
+      @api.timeout = timeout
+      assert_equal(timeout, @api.timeout)
+    end
+  end
+
+  context "build api url" do
+    setup do
+      @api = Mailchimp::Mandrill.new
+      @url = "http://mandrillapp.com/api/1.0/users/ping"
+    end
+  
+    should "handle empty api key" do
+      expect_post(@url, DEFAULT_OPTIONS.merge(:key => nil))
+      @api.users_ping
+    end
+  
+    should "handle malformed api key" do
+      @api_key = "123"
+      @api.api_key = @api_key
+      expect_post(@url, DEFAULT_OPTIONS.merge(:key => @api_key))
+      @api.users_ping
+    end
+      
+    should "handle timeout" do
+      expect_post(@url, DEFAULT_OPTIONS.merge(:key => nil), 120)
+      @api.timeout = 120
+      @api.users_ping
+    end
+  end
+  
+  private
+  
+  def expect_post(expected_url, expected_body, expected_timeout=nil)
+    Mailchimp::Mandrill.expects(:post).with do |url, opts|
+      url == expected_url &&
+      opts[:body] == expected_body &&
+      opts[:timeout] == expected_timeout
+    end.returns(Struct.new(:body).new("") )
+  end
+end

data/test/lib/sts_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class STSTest < Test::Unit::TestCase
+  
+  DEFAULT_OPTIONS= {:options=>{:track_opens=>true, :track_clicks=>true}}
+
+  context "attributes" do
+
+    setup do
+      @api_key = "123-us1"
+    end
+
+    should "have no API by default" do
+      @api = Mailchimp::STS.new
+      assert_equal(nil, @api.api_key)
+    end
+
+    should "set an API key in constructor" do
+      @api = Mailchimp::STS.new(@api_key)
+      assert_equal(@api_key, @api.api_key)
+    end
+
+    should "set an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
+      ENV['MAILCHIMP_API_KEY'] = @api_key
+      @api = Mailchimp::STS.new
+      assert_equal(@api_key, @api.api_key)
+      ENV.delete('MAILCHIMP_API_KEY')
+    end
+
+    should "set an API key via setter" do
+      @api = Mailchimp::STS.new
+      @api.api_key = @api_key
+      assert_equal(@api_key, @api.api_key)
+    end
+
+    should "set timeout and get" do
+      @api = Mailchimp::STS.new
+      timeout = 30
+      @api.timeout = timeout
+      assert_equal(timeout, @api.timeout)
+    end
+  end
+
+  context "build api url" do
+    setup do
+      @api = Mailchimp::STS.new
+      @url = "https://sts.mailchimp.com/1.0/Ping"
+    end
+  
+    should "handle empty api key" do
+      expect_post(@url, DEFAULT_OPTIONS.merge(:apikey => nil))
+      @api.ping
+    end
+  
+    should "handle api key" do
+      @api_key = "123-us1"
+      @api.api_key = @api_key
+      expect_post("https://us1.sts.mailchimp.com/1.0/Ping", DEFAULT_OPTIONS.merge(:apikey => @api_key))
+      @api.ping
+    end
+      
+    should "handle timeout" do
+      expect_post(@url, DEFAULT_OPTIONS.merge(:apikey => nil), 120)
+      @api.timeout = 120
+      @api.ping
+    end
+  end
+  
+  private
+  
+  def expect_post(expected_url, expected_body, expected_timeout=nil)
+    Mailchimp::STS.expects(:post).with do |url, opts|
+      url == expected_url &&
+      opts[:body] == expected_body &&
+      opts[:timeout] == expected_timeout
+    end.returns(Struct.new(:body).new("") )
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+require 'cover_me'
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mailchimp'
+
+FakeWeb.allow_net_connect = false