contactology 0.0.1

data/lib/contactology/list_proxy.rb

@@ -0,0 +1,25 @@
+require 'contactology/basic_object'
+require 'contactology/list'
+
+module Contactology
+  class ListProxy < ::Contactology::BasicObject
+    attr_reader :list_id
+
+    def initialize(list_id)
+      @list_id = list_id
+    end
+
+
+    private
+
+
+    def get_list(id)
+      List.find(id)
+    end
+
+    def method_missing(method, *args, &block)
+      @list ||= get_list(list_id)
+      @list.send(method, *args, &block) if @list
+    end
+  end
+end

data/lib/contactology/parser.rb

@@ -0,0 +1,5 @@
+module Contactology
+  class Parser < HTTParty::Parser
+    SupportedFormats.merge!({'text/plain' => :json})
+  end
+end

data/lib/contactology/send_result.rb

@@ -0,0 +1,35 @@
+require 'contactology/issues'
+
+module Contactology
+  ##
+  # Contains the campaign send request results which indicate success or
+  # failure, as well as any issues found with the campaign.
+  #
+  class SendResult
+    attr_reader :issues
+
+    def initialize(response)
+      @success = response['success']
+      @issues = Issues.new(response['issues'])
+    end
+
+    ##
+    # Public: Indicates whether or not the send was successful
+    #
+    # Returns true when successful.
+    # Returns false when unsuccessful.
+    #
+    def successful?
+      !!@success
+    end
+
+    ##
+    # Public: Returns the spam score of the campaign.
+    #
+    # Returns a numeric from 0 to 100 (where higher is better).
+    #
+    def score
+      @issues.score
+    end
+  end
+end

data/lib/contactology/stash.rb

@@ -0,0 +1,29 @@
+require 'hashie/trash'
+
+module Contactology
+  ##
+  # A Stash is a 'suppressing' Hashie::Trash where keys that are not defined
+  # are simply ignored and unavailable to the local object.
+  #
+  # A Stash is useful when you need to read data from another application,
+  # but you only want a predefined subset of the returned data to become
+  # available, locally.
+  #
+  class Stash < ::Hashie::Trash
+    def []=(property, value)
+      if self.class.translations.include? property.to_sym
+        send("#{property}=", value)
+      elsif property_exists? property
+        super
+      end
+    end
+
+
+    private
+
+
+    def property_exists?(property)
+      self.class.property?(property.to_sym)
+    end
+  end
+end

data/lib/contactology/transactional_message.rb

@@ -0,0 +1,38 @@
+require 'contactology/stash'
+
+module Contactology
+  class TransactionalMessage < Contactology::Stash
+    extend API
+
+    property :campaign, :required => true
+    property :contact, :required => true
+    property :source, :required => true
+    property :replacements, :required => true
+
+    def replacements
+      self['replacements'] || Hash.new
+    end
+
+    def send_message(options = {})
+      self.class.query('Campaign_Send_Transactional', options.merge({
+        'campaignId' => campaign.id,
+        'contact' => normalize_contact(contact),
+        'source' => source,
+        'replacements' => {:_contactology => 'Contactology'}.merge(replacements),
+        :on_error => false,
+        :on_timeout => false,
+        :on_success => true
+      }))
+    end
+
+
+    private
+
+
+    def normalize_contact(contact)
+      return contact if contact.kind_of?(Hash)
+
+      { 'email' => contact.email }
+    end
+  end
+end

data/lib/contactology/version.rb

@@ -0,0 +1,3 @@
+module Contactology
+  VERSION = '0.0.1'
+end

data/spec/factories/campaigns.rb

@@ -0,0 +1,18 @@
+Factory.define :standard_campaign, :class => Contactology::Campaigns::Standard do |c|
+  c.content 'text' => 'This is a good message! {COMPANY_ADDRESS}'
+  c.name 'factory campaign'
+  c.recipients { Factory.build_via_new :list }
+  c.sender_email 'nate@envylabs.com'
+  c.sender_name 'Nate Bibler'
+  c.subject 'Factory Campaign Message'
+end
+
+Factory.define :transactional_campaign, :class => Contactology::Campaigns::Transactional do |c|
+  c.content 'text' => 'This is a good email. {COMPANY_ADDRESS}'
+  c.name 'factory campaign'
+  c.sender_email 'sender@example.com'
+  c.sender_name 'Sender Example'
+  c.subject 'Test Creation'
+  c.test_contact 'email' => 'test-contact@example.com'
+  c.test_replacements 'first_name' => 'John'
+end

data/spec/factories/contacts.rb

@@ -0,0 +1,3 @@
+Factory.define :contact, :class => Contactology::Contact do |c|
+  c.email 'factory-contact@example.com'
+end

data/spec/factories/issues.rb

@@ -0,0 +1,9 @@
+Factory.define :issue, :class => Contactology::Issue do |i|
+  i.level ''
+  i.type 'SPAM'
+  i.text 'BODY: TVD_SPACE_RATIO'
+  i.message ''
+  i.context ''
+  i.col ''
+  i.deduction 29
+end

data/spec/factories/lists.rb

@@ -0,0 +1,3 @@
+Factory.define :list, :class => Contactology::List do |l|
+  l.name 'Factory List'
+end

data/spec/factories/transactional_messages.rb

@@ -0,0 +1,5 @@
+Factory.define :transactional_message, :class => Contactology::TransactionalMessage do |m|
+  m.campaign { Factory.build_via_new :transactional_campaign }
+  m.contact { Factory.attributes_for :contact }
+  m.source 'Factory Created'
+end

data/spec/fixtures/net/campaign/destroy.yml

@@ -0,0 +1,246 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?key=%{API_KEY}&method=List_Add_Public&name=Factory%20List
+    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=6a8cdfd44b31c3d7987dd6492f075491; 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:23:53 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "46"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?key=%{API_KEY}&listId=46&method=List_Get_Info
+    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=295f4ba34b7f033e8cad0c6cf83b9b75; 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:23:57 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "{\"listId\":\"46\",\"name\":\"Factory List\",\"description\":null,\"type\":\"public\",\"optIn\":false}"
+    http_version: "1.1"
+- !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_Standard&senderEmail=nate@envylabs.com&senderName=Nate%20Bibler&subject=Factory%20Campaign%20Message&content%5Btext%5D=This%20is%20a%20good%20message!%20%7BCOMPANY_ADDRESS%7D&recipients%5Blist%5D=46
+    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=3b70f5bce9c49f9029c6ff3472b58274; 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:23:58 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "33"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignId=33&key=%{API_KEY}&method=Campaign_Get_Info
+    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=f0b1859e137c96c71fa9dacdf108536e; 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:23:59 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "{\"campaignId\":\"33\",\"campaignName\":\"factory campaign\",\"type\":\"standard\",\"contentType\":\"standard\",\"status\":\"draft\",\"recipients\":{\"list\":[\"46\"]},\"subject\":\"Factory Campaign Message\",\"senderName\":\"Nate Bibler\",\"senderEmail\":\"nate@envylabs.com\",\"recipientName\":\"\",\"replyToName\":\"\",\"replyToEmail\":null,\"content\":{\"html\":\"\",\"text\":\"This is a good message! {COMPANY_ADDRESS}\"},\"startTime\":\"2011-08-03 18:23:58\",\"authenticate\":false,\"trackReplies\":false,\"showInArchive\":false,\"viewInBrowser\":false,\"trackOpens\":true,\"trackClickThruHTML\":true,\"trackClickThruText\":true,\"googleAnalyticsName\":null,\"automaticTweet\":false,\"clickTaleName\":null,\"clickTaleCustomFields\":[\"\"],\"useCustomUrlParameters\":null,\"customUrlParameters\":null}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?key=%{API_KEY}&listId=46&method=List_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=84399ae8907f376ee7017cb061cb3b3f; 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:24:00 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=33&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=fb7cd68453b20088187ed9db9ef0a4ff; 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:24:00 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=33&key=%{API_KEY}&method=Campaign_Get_Info
+    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=518ac479af356a6ffd117517bb197180; 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:24:01 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "{\"result\":\"error\",\"message\":\"Input Error: campaignId 33 not found\",\"code\":601}"
+    http_version: "1.1"

data/spec/fixtures/net/campaign/find/failure.yml

@@ -0,0 +1,36 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: https://api.emailcampaigns.net:443/2/REST/?campaignId=123456789&key=%{API_KEY}&method=Campaign_Get_Info
+    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=891a04fa52890eb18f50ca10b699a8d1; 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:24:35 GMT
+      server: 
+      - lighttpd/1.4.28
+    body: "{\"result\":\"error\",\"message\":\"Input Error: campaignId 123456789 not found\",\"code\":601}"
+    http_version: "1.1"