contactology 0.0.1

data/spec/fixtures/net/transactional_message/send_message/failure.yml

@@ -0,0 +1,176 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignName=factory%20campaign&key=%{API_KEY}&method=Campaign_Create_Transactional&senderEmail=sender@example.com&senderName=Sender%20Example&subject=Test%20Creation&content%5Btext%5D=This%20is%20a%20good%20email.%20%7BCOMPANY_ADDRESS%7D&testContact%5Bemail%5D=test-contact@example.com&testReplacements%5Bfirst_name%5D=John
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=a7ab7567f3ff2131b7dec2c6026d5f48; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:42:25 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "41"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignId=41&key=%{API_KEY}&method=Campaign_Delete
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=e3d590776569a8ee5778463d527b6cee; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:42:37 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?email=factory-contact@example.com&key=%{API_KEY}&method=Contact_Add&optionalParameters%5BupdateCustomFields%5D=true
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=b621ce46effde38db4e184f9d7696854; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:42:37 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignId=41&key=%{API_KEY}&method=Campaign_Send_Transactional&source=Factory%20Created&contact%5Bemail%5D=factory-contact@example.com&contact%5Bstatus%5D=active&replacements%5B_contactology%5D=Contactology
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=5b0f14e37596fa1d352c4c0d30bac45f; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:42:44 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "{\"result\":\"error\",\"message\":\"Input Error: Campaign 41 has the wrong status\",\"code\":601}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?email=factory-contact@example.com&key=%{API_KEY}&method=Contact_Delete
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=cff8d4a314315bf7b97448e78c3b5cf5; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:42:45 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"

data/spec/fixtures/net/transactional_message/send_message/success.yml

@@ -0,0 +1,176 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignName=factory%20campaign&key=%{API_KEY}&method=Campaign_Create_Transactional&senderEmail=sender@example.com&senderName=Sender%20Example&subject=Test%20Creation&content%5Btext%5D=This%20is%20a%20good%20email.%20%7BCOMPANY_ADDRESS%7D&testContact%5Bemail%5D=test-contact@example.com&testReplacements%5Bfirst_name%5D=John
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=a3d028b280a6a685b1edadf81226c508; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:40:52 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "40"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?email=factory-contact@example.com&key=%{API_KEY}&method=Contact_Add&optionalParameters%5BupdateCustomFields%5D=true
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=e60ade78606994be673baa8f8461a3e0; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:40:53 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignId=40&key=%{API_KEY}&method=Campaign_Send_Transactional&source=Factory%20Created&contact%5Bemail%5D=factory-contact@example.com&contact%5Bstatus%5D=active&replacements%5B_contactology%5D=Contactology
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=9a509e6a963052da2f2fbde75b0386a0; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:40:42 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?email=factory-contact@example.com&key=%{API_KEY}&method=Contact_Delete
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=15422e85f610e927b0b4df605d54bcf5; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:40:54 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignId=40&key=%{API_KEY}&method=Campaign_Delete
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      user-agent: 
+      - contactology/0.0.1 (Rubygems; Ruby 1.9.2 x86_64-darwin10.7.1)
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      x-powered-by: 
+      - PHP/5.2.10
+      set-cookie: 
+      - PHPSESSID=11e73c367ff0d2ed1cf4a04e495af4c3; path=/
+      expires: 
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control: 
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma: 
+      - no-cache
+      content-type: 
+      - text/plain;charset=UTF-8
+      transfer-encoding: 
+      - chunked
+      date: 
+      - Wed, 03 Aug 2011 18:40:55 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "true"
+    http_version: "1.1"

data/spec/models/contactology/api_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+class APIClient
+  extend Contactology::API
+
+  def self.go!
+    query('call', {
+      :on_timeout => 'timed out',
+      :on_error => Proc.new { |response| response['result'] },
+      :on_success => Proc.new { |response| 'successful' if response.kind_of?(TrueClass) }
+    })
+  end
+end
+
+class APIError
+  def self.call(env)
+    [200, {'Content-type' => 'text/plain'}, ["{\"result\":\"error\",\"message\":\"Input error: no contact found with that email\",\"code\":601}"]]
+  end
+end
+
+class APISuccess
+  def self.call(env)
+    [200, {'Content-type' => 'text/plain'}, ['true']]
+  end
+end
+
+describe Contactology::API do
+  context 'handlers' do
+    it 'executes the on_success handler for a successful response' do
+      WebMock.stub_request(:get, /.*/).to_rack(APISuccess)
+      APIClient.go!.should == 'successful'
+    end
+
+    it 'executes the on_error handler for an unsuccessful response' do
+      WebMock.stub_request(:get, /.*/).to_rack(APIError)
+      APIClient.go!.should == 'error'
+    end
+
+    it 'executes the on_timeout handler for connection timeout' do
+      WebMock.stub_request(:get, /.*/).to_timeout
+      APIClient.go!.should == 'timed out'
+    end
+  end
+
+  context '#request_headers' do
+    subject { APIClient.request_headers }
+
+    its(['Accept']) { should == 'application/json' }
+    its(['User-Agent']) { should match %r{^contactology/#{Regexp.escape(Contactology::VERSION)} \(Rubygems; Ruby #{Regexp.escape(RUBY_VERSION)} #{Regexp.escape(RUBY_PLATFORM)}\)$} }
+  end
+end

data/spec/models/contactology/campaign_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Contactology::Campaign do
+  context '.create' do
+    it 'raises a NotImplementedError' do
+      expect { Contactology::Campaign.create({}) }.to raise_error(NotImplementedError)
+    end
+  end
+
+  context '.find' do
+    context 'for a known campaign' do
+      use_vcr_cassette 'campaign/find/success'
+      let(:list) { Factory :list }
+      let(:campaign) { Factory :standard_campaign, :recipients => list }
+      subject { Contactology::Campaign.find campaign.id }
+      after(:each) { list.destroy; campaign.destroy }
+
+      it { should be_instance_of Contactology::Campaign }
+    end
+
+    context 'for an unknown campaign' do
+      use_vcr_cassette 'campaign/find/failure'
+      subject { Contactology::Campaign.find 123456789 }
+
+      it { should be_nil }
+    end
+  end
+
+  context '.find_by_name' do
+    context 'for a known campaign' do
+      use_vcr_cassette 'campaign/find_by_name/success'
+      let(:list) { Factory :list }
+      let(:campaign) { Factory :standard_campaign, :recipients => list, :name => 'test-find-by-name' }
+      after(:each) { list.destroy; campaign.destroy }
+      subject { Contactology::Campaign.find_by_name campaign.name }
+
+      it { should be_instance_of Contactology::Campaign }
+      its(:name) { should == campaign.name }
+    end
+
+    context 'for an unknown campaign' do
+      use_vcr_cassette 'campaign/find_by_name/failure'
+      subject { Contactology::Campaign.find_by_name 'unknown' }
+
+      it { should be_nil }
+    end
+  end
+
+  context '#destroy' do
+    use_vcr_cassette 'campaign/destroy'
+    let(:list) { Factory :list }
+    let(:campaign) { Factory :standard_campaign, :recipients => list }
+
+    subject { list.destroy; campaign.destroy }
+
+    it 'removes the campaign from Contactology' do
+      expect { subject }.to change { Contactology::Campaign.find campaign.id }.to(nil)
+    end
+
+    it { should be_true }
+  end
+
+  context '#preview' do
+    use_vcr_cassette 'campaign/preview', :record => :new_episodes
+    let(:campaign) { Factory :transactional_campaign }
+    after(:each) { campaign.destroy }
+
+    subject { campaign.preview }
+
+    it { should be_kind_of Contactology::Campaign::Preview }
+    its(:text) { should_not be_nil }
+    its(:html) { should_not be_nil }
+    its(:links) { should be_kind_of Enumerable }
+  end
+end