dotmailer 0.0.1 → 0.0.2

data/spec/dot_mailer/data_field_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe DotMailer::DataField do
+  describe 'Class' do
+    let(:client)  { double 'client' }
+    let(:account) { double 'account', :client => client }
+
+    subject { DotMailer::DataField }
+
+    describe '.all' do
+      let(:data_fields) {
+        [
+          {
+            'name'         => 'FIRSTNAME',
+            'type'         => 'String',
+            'visibility'   => 'Public',
+            'defaultValue' => 'John'
+          },
+          {
+            'name'         => 'CODE',
+            'type'         => 'String',
+            'visibility'   => 'Private',
+            'defaultValue' => nil
+          }
+        ]
+      }
+
+      before(:each) do
+        client.stub :get => data_fields
+      end
+
+      it 'should get the fields from the client' do
+        client.should_receive(:get).with('/data-fields')
+
+        subject.all account
+      end
+
+      it 'should return a list of DataFields from the client' do
+        subject.all(account).should == data_fields.map { |df| subject.new(df) }
+      end
+    end
+
+    describe '.create' do
+      let(:name) { 'FIRSTNAME' }
+
+      let(:data_field) do
+        {
+          'name'         => name,
+          'type'         => 'String',
+          'visibility'   => 'Public',
+          'defaultValue' => nil
+        }
+      end
+
+      before(:each) do
+        client.stub :post_json => data_field
+      end
+
+      it 'should call post_json on the client with the field' do
+        client.should_receive(:post_json).with('/data-fields', data_field)
+
+        subject.create account, name
+      end
+    end
+  end
+
+  let(:name)       { 'FIRSTNAME' }
+  let(:type)       { 'String' }
+  let(:visibility) { 'Public' }
+  let(:default)    { 'John' }
+
+  let(:attributes) do
+    {
+      'name'         => name,
+      'type'         => type,
+      'visibility'   => visibility,
+      'defaultValue' => default
+    }
+  end
+
+  subject { DotMailer::DataField.new(attributes) }
+
+  its(:name)       { should == name }
+  its(:type)       { should == type }
+  its(:visibility) { should == visibility }
+  its(:default)    { should == default }
+
+  its(:to_s) { should == 'DotMailer::DataField name: "FIRSTNAME", type: "String", visibility: "Public", default: "John"' }
+
+  its(:to_json) { should == attributes.to_json }
+
+  describe '#==' do
+    specify { subject.should == DotMailer::DataField.new(attributes) }
+  end
+
+  describe '#date?' do
+    context 'when type is "Date"' do
+      let(:type) { 'Date' }
+
+      specify { subject.should be_date }
+    end
+
+    context 'when type is not "Date"' do
+      let(:type) { 'String' }
+
+      specify { subject.should_not be_date }
+    end
+  end
+end

data/spec/dot_mailer/opt_in_type_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe DotMailer::OptInType do
+  describe 'Class' do
+    subject { DotMailer::OptInType }
+
+    describe '.exists?' do
+      context 'when the opt in type exists' do
+        let(:opt_in_type) { DotMailer::OptInType::SINGLE }
+
+        specify { subject.exists?(opt_in_type).should be_true }
+      end
+
+      context 'when the opt in type doesnt exist' do
+        let(:opt_in_type) { 'Something Random' }
+
+        specify { subject.exists?(opt_in_type).should be_false }
+      end
+    end
+  end
+end

data/spec/dot_mailer/suppression_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe DotMailer::Suppression do
+  let(:client)             { double 'client' }
+  let(:account)            { double 'account', :client => client }
+  let(:contact_attributes) { double 'contact attributes' }
+  let(:date_removed)       { '2013-03-01T15:30:45Z' }
+  let(:reason)             { double 'reason' }
+  let(:contact)            { double 'contact' }
+
+  subject do
+    DotMailer::Suppression.new(
+      account,
+      'suppressedContact' => contact_attributes,
+      'dateRemoved'       => date_removed,
+      'reason'            => reason
+    )
+  end
+
+  before(:each) do
+    DotMailer::Contact.stub(:new).with(account, contact_attributes).and_return(contact)
+  end
+
+  its(:contact)      { should == contact }
+  its(:date_removed) { should == Time.parse('1st March 2013 15:30:45 +00:00') }
+  its(:reason)       { should == reason }
+
+  describe 'Class' do
+    subject { DotMailer::Suppression }
+
+    describe '.suppressed_since' do
+      let(:time)        { Time.parse('1st February 2013 15:30:45 +00:00') }
+      let(:suppression) { double 'suppression' }
+
+      let(:attributes) do
+        {
+          'suppressedContact' => contact_attributes,
+          'dateRemoved'       => date_removed,
+          'reason'            => reason
+        }
+      end
+
+      let(:response) { 3.times.map { attributes } }
+
+      before(:each) do
+        client.stub :get => response
+        subject.stub :new => suppression
+      end
+
+      it 'should call get on the client with a path containing the time in UTC XML schema format' do
+        client.should_receive(:get).with('/contacts/suppressed-since/2013-02-01T15:30:45Z')
+
+        subject.suppressed_since(account, time)
+      end
+
+      it 'should initialize some suppressions' do
+        subject.should_receive(:new).exactly(3).times.with(account, attributes)
+
+        subject.suppressed_since(account, time)
+      end
+
+      it 'should return the suppressions' do
+        subject.suppressed_since(account, time).should == 3.times.map { suppression }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,7 +7,9 @@
 
 require 'webmock/rspec'
 
-require 'dotmailer'
+require 'dot_mailer'
+
+require 'support/assignable_attributes_helper'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -19,4 +21,6 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+
+  config.include AssignableAttributesHelper
 end

data/spec/support/assignable_attributes_helper.rb

@@ -0,0 +1,20 @@
+require 'active_support/concern'
+
+module AssignableAttributesHelper
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # A helper method for checking if an Object has an assignable attribute
+    # (i.e. that object.foo = 'bar' changes object.foo to 'bar')
+    def it_should_have_assignable_attributes(*attributes)
+      attributes.each do |attribute|
+        let(:new_value) { double 'new value' }
+
+        specify do
+          expect { subject.public_send("#{attribute}=", new_value) }.to \
+            change { subject.public_send(attribute) }.to(new_value)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dotmailer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -70,15 +86,28 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- TODO.md
 - dotmailer.gemspec
+- lib/dot_mailer.rb
+- lib/dot_mailer/account.rb
+- lib/dot_mailer/client.rb
+- lib/dot_mailer/contact.rb
+- lib/dot_mailer/contact_import.rb
+- lib/dot_mailer/data_field.rb
+- lib/dot_mailer/exceptions.rb
+- lib/dot_mailer/opt_in_type.rb
+- lib/dot_mailer/suppression.rb
+- lib/dot_mailer/version.rb
 - lib/dotmailer.rb
-- lib/dotmailer/client.rb
-- lib/dotmailer/data_field.rb
-- lib/dotmailer/exceptions.rb
-- lib/dotmailer/version.rb
-- spec/dotmailer/client_spec.rb
-- spec/dotmailer/data_field_spec.rb
+- spec/dot_mailer/account_spec.rb
+- spec/dot_mailer/client_spec.rb
+- spec/dot_mailer/contact_import_spec.rb
+- spec/dot_mailer/contact_spec.rb
+- spec/dot_mailer/data_field_spec.rb
+- spec/dot_mailer/opt_in_type_spec.rb
+- spec/dot_mailer/suppression_spec.rb
 - spec/spec_helper.rb
+- spec/support/assignable_attributes_helper.rb
 homepage: https://github.com/econsultancy/dotmailer
 licenses: []
 post_install_message: 

data/lib/dotmailer/client.rb

@@ -1,78 +0,0 @@
-require 'cgi'
-require 'json'
-require 'csv'
-require 'restclient'
-
-module Dotmailer
-  class Client
-    def initialize(api_user, api_pass)
-      self.api_user = api_user
-      self.api_pass = api_pass
-    end
-
-    def get_data_fields
-      fields = get 'data-fields'
-
-      fields.map { |attributes| DataField.new(attributes) }
-    end
-
-    def create_data_field(name, options = {})
-      options[:type]       ||= 'String'
-      options[:visibility] ||= 'Public'
-
-      post_json(
-        'data-fields',
-        'name'         => name,
-        'type'         => options[:type],
-        'visibility'   => options[:visibility],
-        'defaultValue' => options[:default]
-      )
-
-      true
-    rescue RestClient::BadRequest
-      raise DuplicateDataField
-    end
-
-    def import_contacts(headers, contacts)
-      csv = CSV.generate do |csv|
-        csv << headers
-
-        contacts.each do |contact|
-          csv << headers.map { |header| contact[header] }
-        end
-      end
-
-      post 'contacts/import', csv, :content_type => :csv
-    end
-
-    def import_status(import_id)
-      response = get "contacts/import/#{import_id}"
-
-      response['status']
-    end
-
-    private
-    attr_accessor :api_user, :api_pass
-
-    def get(path)
-      JSON.parse RestClient.get url(path), :accept => :json
-    end
-
-    def post_json(path, params)
-      post path, params.to_json, :content_type => :json
-    end
-
-    def post(path, data, options = {})
-      JSON.parse RestClient.post url(path), data, options.merge(:accept => :json)
-    end
-
-    def url(path)
-      URI::Generic.build(
-        :scheme   => 'https',
-        :userinfo => "#{CGI.escape(api_user)}:#{api_pass}",
-        :host     => 'api.dotmailer.com',
-        :path     => "/v2/#{path}"
-      ).to_s
-    end
-  end
-end

data/lib/dotmailer/exceptions.rb

@@ -1,4 +0,0 @@
-module Dotmailer
-  class DuplicateDataField < Exception
-  end
-end

data/lib/dotmailer/version.rb

@@ -1,3 +0,0 @@
-module Dotmailer
-  VERSION = "0.0.1"
-end

data/spec/dotmailer/client_spec.rb

@@ -1,159 +0,0 @@
-require 'spec_helper'
-
-describe Dotmailer::Client do
-  let(:api_user) { 'john_doe' }
-  let(:api_pass) { 's3cr3t' }
-  let(:api_base_url) { "https://#{api_user}:#{api_pass}@api.dotmailer.com" }
-
-  subject { Dotmailer::Client.new(api_user, api_pass) }
-
-  context 'data fields' do
-    let(:data_fields_endpoint) do
-      "#{api_base_url}/v2/data-fields"
-    end
-
-    describe '#get_data_fields' do
-      let(:data_fields) do
-        [
-          Dotmailer::DataField.new(
-            'name'         => 'FIRSTNAME',
-            'type'         => 'String',
-            'visibility'   => 'Public',
-            'defaultValue' => 'John'
-          ),
-          Dotmailer::DataField.new(
-            'name'         => 'CODE',
-            'type'         => 'String',
-            'visibility'   => 'Private',
-            'defaultValue' => nil
-          )
-        ]
-      end
-
-      before(:each) do
-        stub_request(:get, data_fields_endpoint).to_return(:body => data_fields.to_json)
-      end
-
-      it 'should get the fields from the data fields endpoint' do
-        subject.get_data_fields
-
-        WebMock.should have_requested(:get, data_fields_endpoint).with(
-          :headers => { 'Accept' => 'application/json' }
-        )
-      end
-
-      it 'should return the data fields from the data fields endpoint' do
-        subject.get_data_fields.should == data_fields
-      end
-    end
-
-    describe '#create_data_field' do
-      let(:name) { 'FIRSTNAME' }
-
-      let(:data_field_json) do
-        {
-          'name'         => name,
-          'type'         => 'String',
-          'visibility'   => 'Public',
-          'defaultValue' => nil
-        }.to_json
-      end
-
-      before(:each) do
-        stub_request(:post, data_fields_endpoint).to_return(:body => data_field_json)
-      end
-
-      it 'should post the field to the data fields endpoint' do
-        subject.create_data_field name
-
-        WebMock.should have_requested(:post, data_fields_endpoint).with(
-          :body    => data_field_json,
-          :headers => {
-            'Accept'       => 'application/json',
-            'Content-Type' => 'application/json'
-          }
-        )
-      end
-
-      context 'when the field doesnt exist' do
-        it 'should return true' do
-          subject.create_data_field(name).should == true
-        end
-      end
-
-      context 'when the field already exists' do
-        before(:each) do
-          stub_request(:post, data_fields_endpoint).to_return(:status => 400)
-        end
-
-        it 'should raise an error' do
-          expect { subject.create_data_field(name) }.to raise_error(Dotmailer::DuplicateDataField)
-        end
-      end
-    end
-  end
-
-  context 'contacts' do
-    describe '#import_contacts' do
-      let(:contact_import_endpoint) do
-        "#{api_base_url}/v2/contacts/import"
-      end
-
-      let(:headers) { ['Email'] }
-
-      let(:contacts) do
-        [
-          { 'Email' => 'john.doe@example.com' }
-        ]
-      end
-
-      let(:contacts_csv) { "Email\njohn.doe@example.com\n" }
-
-      let(:response) { { 'id' => '123', 'status' => 'Finished' } }
-
-      before(:each) do
-        stub_request(:post, contact_import_endpoint).to_return(:body => response.to_json)
-      end
-
-      it 'should post the contacts in CSV format to the contact import endpoint' do
-        subject.import_contacts ['Email'], contacts
-
-        WebMock.should have_requested(:post, contact_import_endpoint).with(
-          :body    => contacts_csv,
-          :headers => {
-            'Accept'       => 'application/json',
-            'Content-Type' => 'text/csv'
-          }
-        )
-      end
-    end
-
-    describe '#import_status' do
-      let(:import_id) { 123 }
-
-      let(:import_status_endpoint) do
-        "#{api_base_url}/v2/contacts/import/#{import_id}"
-      end
-
-      let(:status) { 'Finished' }
-
-      let(:response) { { 'id' => import_id, 'status' => status } }
-
-      before(:each) do
-        stub_request(:get, import_status_endpoint).to_return(:body => response.to_json )
-      end
-
-      it 'should get the import status from the import status endpoint' do
-        subject.import_status import_id
-
-        WebMock.should have_requested(:get, import_status_endpoint).with(
-          :headers => { 'Accept' => 'application/json' }
-        )
-      end
-
-      it 'should return the status from the import status endpoint' do
-        subject.import_status(import_id).should == status
-      end
-    end
-  end
-end