email_center_api 0.0.1 → 0.0.2

data/lib/email_center_api/base.rb

@@ -1,40 +0,0 @@
-module EmailCenterApi
-  class Base
-    include HTTParty
-    default_timeout 10
-
-    def to_i
-      id
-    end
-
-    def self.get(*args, &block)
-      base_uri EmailCenterApi.endpoint
-      basic_auth EmailCenterApi.username, EmailCenterApi.password
-      super(*args, &block)
-    end
-
-    def self.post(*args, &block)
-      base_uri EmailCenterApi.endpoint
-      basic_auth EmailCenterApi.username, EmailCenterApi.password
-      super(*args, &block)
-    end
-
-    def self.raise_errors(response)
-      if response['msg']
-        raise "Api Error: #{response['msg']}"
-      else
-        raise "Email Center Api: General Error!"
-      end
-    end
-
-    def self.get_with_retry(*args, &block)
-      retries = 0
-      begin
-        get(*args, &block)
-      rescue Timeout::Error
-        raise if (self.retries += 1) > 3
-        retry
-      end
-    end
-  end
-end

data/lib/email_center_api/configuration.rb

@@ -1,32 +0,0 @@
-module EmailCenterApi
-  module Configuration
-    VALID_CONNECTION_KEYS = [:endpoint].freeze
-    VALID_OPTIONS_KEYS    = [:username, :password].freeze
-    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
-
-    DEFAULT_USERNAME    = 'test'
-    DEFAULT_PASSWORD    = 'test'
-    DEFAULT_ENDPOINT     = 'https://maxemail.emailcenteruk.com/api/json/'
-    # Build accessor methods for every config options so we can do this, for example:
-    #   EmailCenterApi.endpoint = 'https://maxemail.emailcenteruk.com/api/json/'
-    attr_accessor *VALID_CONFIG_KEYS
-
-    # Make sure we have the default values set when we get 'extended'
-    def self.extended(base)
-      base.reset
-    end
-
-    #Configure the gem with a configure block
-    def configure
-      yield self
-    end
-
-    def reset
-      self.username = DEFAULT_USERNAME
-      self.password = DEFAULT_PASSWORD
-      self.endpoint = DEFAULT_ENDPOINT
-    end
-
-  end # Configuration
-end
-

data/lib/email_center_api/list.rb

@@ -1,90 +0,0 @@
-module EmailCenterApi
-  class List < EmailCenterApi::Base
-    attr_accessor :name, :created_ts, :list_total, :folder_id, :type, :id, :status, :update_ts
-
-    def initialize(name, created_ts, list_total, folder_id, type, id, status, update_ts)
-      self.name = name
-      self.created_ts = created_ts
-      self.list_total = list_total.to_i
-      self.folder_id = folder_id.to_i
-      self.type = type
-      self.id = id.to_i
-      self.status = status
-      self.update_ts = update_ts
-    end
-
-    def insert_recipient(options)
-      self.class.insert_recipient(id, options)
-    end
-
-    def delete_recipient(recipient)
-      self.class.delete_recipient(id,recipient.to_i)
-    end
-
-    def recipients
-      response = self.class.get_with_retry("/list", :query => {:method => "fetchRecipients", "listId" => id, :limit => 100, :start => 0, :sort => "email_address", :dir => "ASC", :filter => ["email_address"]})
-      recipients = []
-      if response.success?
-        response['records'].each do |record|
-          recipients << EmailCenterApi::Recipient.new(record['recipient_id'],record['email_address'],record['update_ts'])
-        end
-      else
-        raise_errors(response)
-      end
-      recipients
-    end
-
-    def self.find(list_id)
-      response = get_with_retry("/list?method=find&listId=#{list_id}")
-      if response.success?
-        self.new(response['name'], response['created_ts'], response['list_total'], response['folder_id'],
-             response['type'], response['list_id'], response['status'], response['update_ts'])
-      else
-        raise_errors(response)
-      end
-    end
-
-    def self.all
-      response = get_with_retry("/list?method=fetchAll")
-      if response.success?
-        lists = []
-        response.each do |list|
-          lists << self.new(list['name'], list['created_ts'], list['list_total'], list['folder_id'],
-                        list['type'], list['list_id'], list['status'], list['update_ts'])
-        end
-        lists
-      else
-        raise response.response
-      end
-    end
-
-    def self.find_by_name(name)
-      lists = all.collect {|list| list if list.name == name}.compact
-      if lists.empty?
-        raise "Api Error: No list named #{name} was found"
-      else
-        lists.first
-      end
-    end
-
-    def self.insert_recipient(list_id, options)
-      body = { :method => "insertRecipient", :listId => list_id, :data => options }
-      response = post("/list", {:body => body })
-      if response.success?
-        Recipient.new(response['recipient_id'],response['email_address'],response['update_ts'])
-      else
-        raise_errors(response)
-      end
-    end
-
-    def self.delete_recipient(list_id, recipient_id)
-      body = { :method => "deleteRecipient", :listId => list_id, :recipientId => recipient_id }
-      response = post("/list", { :body => body })
-      if response.success?
-        response
-      else
-        raise_errors(response)
-      end
-    end
-  end
-end

data/lib/email_center_api/recipient.rb

@@ -1,62 +0,0 @@
-module EmailCenterApi
-  class Recipient < EmailCenterApi::Base
-    attr_accessor :id, :email_address, :domain_name, :updated_at
-
-    def initialize(id,email_address, updated_at)
-     self.id = id.to_i
-     self.email_address = email_address
-     self.updated_at = updated_at
-    end
-
-    def lists
-      lists = self.class.get_with_retry("/recipient?method=fetchLists&recipientId=#{id}")
-      if lists.success?
-        lists.collect{ |list| list if list['subscribed'] == "1" }.compact.collect do |list|
-          List.find(list['list_id'])
-        end
-      else
-        raise_errors(lists)
-      end
-    end
-
-    def unsubscribed?
-      !unsubscribed_from.empty?
-    end
-
-    def unsubscribed_from
-      lists = self.class.get_with_retry("/recipient", :query => { :method => "fetchLists", "recipientId" => id })
-      if lists.success?
-        lists.collect{ |list| list if list['subscribed'] == "0" }.compact.collect do |list|
-          List.find(list['list_id'])
-        end
-      else
-        raise_errors(lists)
-      end
-    end
-
-    def self.find(id)
-      recipient = get_with_retry("/recipient?method=find&recipientId=#{id}")
-      if recipient.success?
-        self.new(recipient['recipient_id'],recipient['email_address'],recipient['update_ts'])
-      else
-        raise_errors(recipient)
-      end
-    end
-
-    def self.find_by_email(email_address)
-      id = get_with_retry("/recipient", :query => {:method => "findByEmailAddress", "emailAddress" => email_address })
-      if id.success?
-        recipient = get_with_retry("/recipient?method=find&recipientId=#{id.body}")
-        if recipient.success?
-          self.new(recipient['recipient_id'],recipient['email_address'],recipient['update_ts'])
-        else
-          raise_errors(recipient)
-        end
-      else
-        raise_errors(id)
-      end
-    end
-
-
-  end
-end

data/spec/configuration_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe 'configuration' do
-  after(:each) do
-    EmailCenterApi.reset
-  end
-
-  EmailCenterApi::Configuration::VALID_CONFIG_KEYS.each do |key|
-    describe ".#{key}" do
-      it 'should return the default value' do
-        EmailCenterApi.send(key).should == EmailCenterApi::Configuration.const_get("DEFAULT_#{key.to_s.upcase}")
-      end
-    end
-  end
-
-  describe '.configure' do
-    EmailCenterApi::Configuration::VALID_CONFIG_KEYS.each do |key|
-      it "should set the #{key}" do
-        EmailCenterApi.configure do |config|
-          config.send("#{key}=", key)
-        end
-        EmailCenterApi.send(key).should == key
-      end
-    end
-  end
-
-
-end

data/spec/list_spec.rb

@@ -1,119 +0,0 @@
-require 'spec_helper'
-
-describe EmailCenterApi::List do
-  describe ".find" do
-      it "returns the list with the right id" do
-      EmailCenterApi::List.find(4).id.should == 4
-    end
-
-    it "Throws an exception if the list is not found" do
-      expect { EmailCenterApi::List.find(10) }.to raise_error "Api Error: Unable to find requested list"
-    end
-  end
-
-  describe ".all" do
-    it "returns an array" do
-      EmailCenterApi::List.all.class.should == Array
-    end
-
-    it "should have the correct number of elements" do
-      EmailCenterApi::List.all.size.should == 11
-    end
-
-    it "has List objects as elements in the array" do
-      EmailCenterApi::List.all.first.class.should == EmailCenterApi::List
-    end
-
-    it "sets up the list objects with the correct attributes" do
-      EmailCenterApi::List.all.first.id.should == 19
-      EmailCenterApi::List.all.first.status.should == "available"
-    end
-  end
-
-  describe ".find_by_name" do
-    it "should return the correct named list" do
-      EmailCenterApi::List.find_by_name("Master Unsubscribe List").id.should == 4
-    end
-
-    it "should throw an error if the list dosn't exist" do
-      expect { EmailCenterApi::List.find_by_name("Stupid Monkey List") }.to raise_error
-    end
-  end
-
-  describe ".insert_recipient" do
-    time = "#{Time.now}"
-    email = "james@example.com"
-    id = 123456
-    FakeWeb.register_uri(:post, "https://test:test@maxemail.emailcenteruk.com/api/json/list", :body => "{\"recipient_id\":\"#{id}\",\"email_address\":\"#{email}\",\"subscribed\":\"0\",\"update_ts\":\"#{time}\"}", :content_type => "application/json; charset=utf-8")
-    options = { :email => email, :subscribed => "0" }
-
-    it "hits the api with the correct post request" do
-      EmailCenterApi::Base.stub_chain(:post, :success?).and_return(true)
-      EmailCenterApi::Base.stub_chain(:post, :[]).and_return(1)
-      EmailCenterApi::Base.should_receive(:post).with("/list", {:body=>{:data=> options, :listId=>25, :method=>"insertRecipient"}})
-      EmailCenterApi::List.insert_recipient(25, options)
-    end
-
-    it "returns a recipient object" do
-      EmailCenterApi::List.insert_recipient(25, options).class.should == EmailCenterApi::Recipient
-     end
-
-    it "returns a recipient with the right attributes" do
-      EmailCenterApi::List.insert_recipient(25, options).id.should == id
-      EmailCenterApi::List.insert_recipient(25, options).email_address.should == email
-      EmailCenterApi::List.insert_recipient(25, options).updated_at.should == time
-    end
-
-    describe "an instance method .insert_recipient" do
-      list = EmailCenterApi::List.new("A List", Time.now.to_s, 123, 14, "Sometype", 25, "A Status", Time.now.to_s)
-      it "works in a similar way" do
-        list.insert_recipient(options).class.should == EmailCenterApi::Recipient
-        list.insert_recipient(options).id.should == id
-        list.insert_recipient(options).email_address.should == email
-        list.insert_recipient(options).updated_at.should == time
-      end
-    end
-  end
-
-  describe ".delete_recipient" do
-    it "hits the api with the correct post request" do
-      EmailCenterApi::Base.stub_chain(:post, :success?).and_return(true)
-      EmailCenterApi::Base.should_receive(:post).with("/list", {:body=>{:recipientId=> 1234, :listId=>25, :method=>"deleteRecipient"}})
-      EmailCenterApi::List.delete_recipient(25,1234)
-    end
-
-    it "returns true if the recipient was removed from the list" do
-      FakeWeb.register_uri(:post, "https://test:test@maxemail.emailcenteruk.com/api/json/list", :body => "true", :content_type => "application/json; charset=utf-8")
-      EmailCenterApi::List.delete_recipient(25,1234)
-    end
-
-    it "throws an error if the recipient dosn't exist on the list" do
-      FakeWeb.register_uri(:post, "https://test:test@maxemail.emailcenteruk.com/api/json/list", :body => "{\"success\":false,\"msg\":\"Unable to find requested list recipient\",\"code\":0,\"errors\":[]}", :content_type => "application/json; charset=utf-8", :status => 400)
-      expect { EmailCenterApi::List.delete_recipient(25,1234) }.to raise_error "Api Error: Unable to find requested list recipient"
-    end
-
-    it "has an instance method that accepts a recipient object" do
-      list = EmailCenterApi::List.new("A List", Time.now.to_s, 123, 14, "Sometype", 25, "A Status", Time.now.to_s)
-      EmailCenterApi::Base.stub_chain(:post, :success?).and_return(true)
-      EmailCenterApi::Base.should_receive(:post).with("/list", {:body=>{:recipientId=> 1234, :listId=>25, :method=>"deleteRecipient"}})
-      recipient = EmailCenterApi::Recipient.new(1234,"something@whatever.com",Time.now.to_s)
-      list.delete_recipient(recipient)
-    end
-  end
-
-  describe ".recipients" do
-    id = rand(10000)
-    id2 = rand(10000)
-    recipients = "{\"list_total\":\"2\",\"count\":2,\"offset\":\"0\",\"limit\":\"100\",\"sort\":\"email_address\",\"dir\":\"ASC\",\"records\":[{\"record_type\":\"campaign\",\"subscribed\":\"0\",\"unsubscribe_method\":\"manual\",\"update_ts\":\"2012-09-11 16:43:10\",\"recipient_id\":\"#{id}\",\"email_address\":\"testing@exam41313ple123245.com\",\"Default.Date of Birth\":null,\"Default.EmailAddress\":null,\"Default.First Name\":null,\"Default.Gender\":null,\"Default.Last Name\":null,\"Default.Location\":null,\"Reviews.Country\":null,\"Reviews.product_image\":null,\"Reviews.purchase_date\":null,\"Reviews.questionnaire_no\":null,\"Reviews.questionnaire_short\":null,\"Reviews.questionnaire_yes\":null,\"Reviews.retailer_from\":null,\"Reviews.retailer_image\":null,\"Reviews.retailer_name\":null,\"Reviews.retailer_privacy_link\":null,\"Reviews.retailer_product_name\":null,\"Reviews.retailer_terms_conditions\":null,\"Reviews.retailer_website\":null,\"Reviews.subject\":null,\"Reviews.tracking_image\":null,\"Reviews.unsubscribe_link\":null,\"Reviews.variant\":null,\"Sent.FirstReview\":null},{\"record_type\":\"campaign\",\"subscribed\":\"1\",\"unsubscribe_method\":null,\"update_ts\":\"2012-09-11 16:26:09\",\"recipient_id\":\"#{id2}\",\"email_address\":\"testing@example.com\",\"Default.Date of Birth\":null,\"Default.EmailAddress\":null,\"Default.First Name\":null,\"Default.Gender\":null,\"Default.Last Name\":null,\"Default.Location\":null,\"Reviews.Country\":null,\"Reviews.product_image\":null,\"Reviews.purchase_date\":null,\"Reviews.questionnaire_no\":null,\"Reviews.questionnaire_short\":null,\"Reviews.questionnaire_yes\":null,\"Reviews.retailer_from\":null,\"Reviews.retailer_image\":null,\"Reviews.retailer_name\":null,\"Reviews.retailer_privacy_link\":null,\"Reviews.retailer_product_name\":null,\"Reviews.retailer_terms_conditions\":null,\"Reviews.retailer_website\":null,\"Reviews.subject\":null,\"Reviews.tracking_image\":null,\"Reviews.unsubscribe_link\":null,\"Reviews.variant\":null,\"Sent.FirstReview\":null}]}"
-    FakeWeb.register_uri(:get, "https://test:test@maxemail.emailcenteruk.com/api/json/list?dir=ASC&filter[]=email_address&limit=100&listId=25&start=0&method=fetchRecipients&sort=email_address", :body => recipients, :content_type => "application/json; charset=utf-8")
-    list = EmailCenterApi::List.new("A List", Time.now.to_s, 123, 14, "Sometype", 25, "A Status", Time.now.to_s)
-
-    it "returns an array of the recipients in the list" do
-      list.recipients.first.class.should == EmailCenterApi::Recipient
-      list.recipients.first.id.should == id
-      list.recipients.last.id.should == id2
-      list.recipients.first.email_address.should == "testing@exam41313ple123245.com"
-    end
-
-  end
-end

data/spec/recipient_spec.rb

@@ -1,56 +0,0 @@
-require 'spec_helper'
-
-describe EmailCenterApi::Recipient do
-  describe ".find" do
-    it 'returns a recipient with the correct id' do
-      EmailCenterApi::Recipient.find(1234).id.should == 1234
-    end
-
-    it 'returns a recipient with the correct params' do
-      EmailCenterApi::Recipient.find(1234).email_address.should == "test@example.co.uk"
-      EmailCenterApi::Recipient.find(1234).updated_at.should == "2012-01-21 07:15:13"
-    end
-
-    it 'rases an error if the id is not found' do
-      expect { EmailCenterApi::Recipient.find(5678) }.to raise_error "Api Error: Unable to find selected recipient"
-    end
-  end
-
-  describe ".unsubscribed_from" do
-    it "returns all the lists where subscribed == 0" do
-      EmailCenterApi::Recipient.find(1234).unsubscribed_from.first.id.should == 25
-    end
-  end
-
-  describe ".unsubscribed?" do
-    it "returns true if the recipient is unsubscribed from somthing" do
-      EmailCenterApi::Recipient.find(1234).unsubscribed?.should == true
-    end
-
-    it "returns false if the recipient is not unsubscribed from anything" do
-      EmailCenterApi::Recipient.find(2345).unsubscribed?.should == false
-    end
-  end
-
-  describe ".lists" do
-    it "returns all the lists where subscribed == 1" do
-      EmailCenterApi::Recipient.find(1234).lists.first.id.should == 26
-    end
-  end
-
-  describe ".find" do
-    it "finds the recipient with the given id" do
-      EmailCenterApi::Recipient.find(1234).id.should == 1234
-    end
-
-    it "creates the objects with the correct params" do
-      EmailCenterApi::Recipient.find(1234).email_address.should == "test@example.co.uk"
-    end
-  end
-
-  describe ".find_by_email" do
-    it "finds the correct recipient" do
-      EmailCenterApi::Recipient.find_by_email("test@example.co.uk").id.should == 1234
-    end
-  end
-end