dotmailer 0.0.3 → 0.0.4

data/spec/dot_mailer/campaign_summary_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe DotMailer::CampaignSummary do
+  let(:client)  { double 'client' }
+  let(:account) { double 'account', :client => client }
+  let(:response) {{
+    "dateSent"     => '2013-07-30T16:01:21.603Z',
+    "numTotalSent" => '123',
+    "percentageDelivered" => '95.8'
+  }}
+
+  subject do
+    client.should_receive(:get).with("/campaigns/1/summary").and_return(response)
+    DotMailer::CampaignSummary.new(account, 1)
+  end
+
+  specify { subject.date_sent.should eq(Time.parse('2013-07-30T16:01:21.603Z')) }
+  specify { subject.num_total_sent.should eq(123) }
+  specify { subject.percentage_delivered.should eq(95.8) }
+end

data/spec/dot_mailer/client_spec.rb

@@ -56,7 +56,7 @@ describe DotMailer::Client do
       subject.get_csv api_path
 
       WebMock.should have_requested(:get, api_endpoint).with(
-        :headers => { 'Accept' => 'text/csv' }
+        :headers => { 'Accept' => 'text/comma-separated-values' }
       )
     end
 
@@ -157,4 +157,18 @@ describe DotMailer::Client do
       subject.post_csv api_path, csv
     end
   end
+
+  describe '#delete' do
+    before(:each) do
+      stub_request(:delete, api_endpoint)
+    end
+
+    it 'should DELETE the endpoint with a JSON accept header' do
+      subject.delete api_path
+
+      WebMock.should have_requested(:delete, api_endpoint).with(
+        :headers => { 'Accept' => 'application/json' }
+      )
+    end
+  end
 end

data/spec/dot_mailer/contact_import_spec.rb

@@ -15,6 +15,7 @@ describe DotMailer::ContactImport do
 
     describe '.import' do
       let(:contact_import) { double 'contact import', :start => double }
+      let(:wait_for_finish) { false }
 
       before(:each) do
         subject.stub :new => contact_import
@@ -23,17 +24,17 @@ describe DotMailer::ContactImport do
       it 'should create a new instance with the account and contacts' do
         subject.should_receive(:new).with(account, contacts)
 
-        subject.import account, contacts
+        subject.import account, contacts, wait_for_finish
       end
 
       it 'should start the new contact import' do
         contact_import.should_receive :start
 
-        subject.import account, contacts
+        subject.import account, contacts, wait_for_finish
       end
 
       it 'should return the contact import' do
-        subject.import(account, contacts).should == contact_import
+        subject.import(account, contacts, wait_for_finish).should == contact_import
       end
     end
   end
@@ -46,6 +47,7 @@ describe DotMailer::ContactImport do
     before(:each) do
       account.stub :data_fields => [double('data field', :name => 'CODE')]
     end
+    let(:wait_for_finish) { false }
 
     context 'when the contacts include a non existent data field' do
       let(:data_field_name) { 'UNKNOWN' }
@@ -57,7 +59,7 @@ describe DotMailer::ContactImport do
       end
 
       it 'should raise an UnknownDataField error with the data field name' do
-        expect { subject.start }.to raise_error(DotMailer::UnknownDataField, data_field_name)
+        expect { subject.start(wait_for_finish) }.to raise_error(DotMailer::UnknownDataField, data_field_name)
       end
     end
 
@@ -72,13 +74,23 @@ describe DotMailer::ContactImport do
     it 'should call post_csv on the client with the contacts in CSV format' do
       client.should_receive(:post_csv).with('/contacts/import', contacts_csv)
 
-      subject.start
+      subject.start(wait_for_finish)
     end
 
     it 'should set the id from the response' do
-      subject.start
+      subject.start(wait_for_finish)
       subject.id.should == id
     end
+
+    context "with a wait_for_finish request" do
+      let(:wait_for_finish) { true }
+
+      it "should call the blocking wait_for_finish method" do
+        subject.should_receive(:wait_until_finished)
+
+        subject.start wait_for_finish
+      end
+    end
   end
 
   describe '#status' do
@@ -170,4 +182,33 @@ describe DotMailer::ContactImport do
       end
     end
   end
+
+  describe '#wait_for_finish' do
+    before { subject.stub(:sleep).and_return(1) }
+
+    it "returns when finished is true" do
+      subject.should_receive(:finished?).once.and_return(true)
+
+      subject.send(:wait_until_finished)
+    end
+
+    it "returns nil when batch finished within max tries" do
+      subject.stub(:finished? => true)
+
+      subject.send(:wait_until_finished).should be_nil
+    end
+
+    it "sleeps between each call to finished" do
+      subject.stub(:finished? => true)
+      subject.should_receive(:sleep).once.with(1).and_return(true)
+
+      subject.send(:wait_until_finished)
+    end
+
+    it "raises an error when not finished within max tries" do
+      subject.should_receive(:finished?).exactly(10).times.and_return(false)
+
+      expect { subject.send(:wait_until_finished) }.to raise_error(DotMailer::ImportNotFinished)
+    end
+  end
 end

data/spec/dot_mailer/contact_spec.rb

@@ -64,7 +64,7 @@ describe DotMailer::Contact do
     end
 
     describe '.modified_since' do
-      let(:time)        { Time.parse('1st March 2013 15:30:45 +00:00') }
+      let(:time)        { Time.parse('1st March 2013 16:30:45 +01:00') }
       let(:attributes)  { double 'attributes' }
       let(:response)    { 3.times.map { attributes } }
       let(:contact)     { double 'contact' }
@@ -230,6 +230,14 @@ describe DotMailer::Contact do
     end
   end
 
+  describe '#delete' do
+    it 'should call delete on the client with the id path' do
+      client.should_receive(:delete).with("/contacts/#{id}")
+
+      subject.delete
+    end
+  end
+
   describe '#subscribed?' do
     context 'when the status is the SUBSCRIBED_STATUS' do
       let(:status) { DotMailer::SUBSCRIBED_STATUS }

data/spec/dot_mailer/from_address_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe DotMailer::FromAddress do
+  let(:id)    { double 'id' }
+  let(:email) { double 'email' }
+
+  let(:attributes) do
+    {
+      'id'    => id,
+      'email' => email
+    }
+  end
+
+  subject { DotMailer::FromAddress.new(attributes) }
+
+  its(:id)      { should == id }
+  its(:email)   { should == email}
+  its(:to_hash) { should == attributes }
+
+  describe '#==' do
+    it 'should equal a from address with the same attributes' do
+      subject.should == DotMailer::FromAddress.new(attributes)
+    end
+  end
+end

data/spec/dot_mailer/segment_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe DotMailer::Segment do
+  let(:client)  { double 'client' }
+  let(:account) { double 'account', :client => client }
+  let(:id)       { 123 }
+
+  subject do
+    DotMailer::Segment.new(account, { 'id' => id } )
+  end
+
+  describe 'Class' do
+    subject { DotMailer::Segment }
+
+    describe '.find_by_id' do
+
+      let(:response) { [
+        { "id"=>121, "name"=>"Segment A", "contacts"=>0 },
+        { "id"=>id,  "name"=>"Segment B", "contacts"=>1 }
+      ] }
+
+      let(:segment) { double 'segment' }
+
+      before(:each) do
+        subject.stub :new => segment
+        client.stub :get => response
+      end
+
+      it 'should call get on the client with the correct parameters' do
+        client.should_receive(:get).with("/segments")
+
+        subject.find_by_id(account, id)
+      end
+
+      it 'should initialize a Segement with the response' do
+        subject.should_receive(:new).with(account, response[1])
+
+        subject.find_by_id(account, id)
+      end
+
+      it 'should return the new Segement object' do
+        subject.find_by_id(account, id).should == segment
+      end
+    end
+  end
+
+  describe '.refresh!' do
+    let(:response) { double 'response' }
+    let(:segment) { double 'segment' }
+
+    before(:each) do
+      subject.stub :new => segment
+    end
+
+    it 'should call post on the client with the correct parameters' do
+      client.should_receive(:post_json).with("/segments/refresh/#{id}",{})
+
+      subject.refresh!
+    end
+  end
+
+  describe '.refresh_progress' do
+    let(:status) { double 'status'}
+    let(:response) { {"id" => id, "status" => status} }
+
+    before(:each) do
+      client.stub :get => response
+    end
+
+    it 'should call get on the client with the correct parameters' do
+      client.should_receive(:get).with("/segments/refresh/#{id}")
+
+      subject.refresh_progress
+    end
+
+    it 'should return a percentage complete' do
+      subject.refresh_progress.should == status
+    end
+  end
+end

data/spec/dot_mailer/suppression_spec.rb

@@ -22,14 +22,14 @@ describe DotMailer::Suppression do
   end
 
   its(:contact)      { should == contact }
-  its(:date_removed) { should == Time.parse('1st March 2013 15:30:45 +00:00') }
+  its(:date_removed) { should == Time.parse('1st March 2013 16:30:45 +01: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(:time)        { Time.parse('1st February 2013 16:30:45 +01:00') }
       let(:suppression) { double 'suppression' }
 
       let(:attributes) do

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
+require 'active_support/core_ext/hash/except'
+
 require 'webmock/rspec'
 
 require 'dot_mailer'

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: dotmailer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Econsultancy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-03 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -74,28 +88,39 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
+- .travis.yml
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - TODO.md
 - dotmailer.gemspec
 - lib/dot_mailer.rb
 - lib/dot_mailer/account.rb
+- lib/dot_mailer/campaign.rb
+- lib/dot_mailer/campaign_summary.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/from_address.rb
 - lib/dot_mailer/opt_in_type.rb
+- lib/dot_mailer/segment.rb
 - lib/dot_mailer/suppression.rb
 - lib/dot_mailer/version.rb
 - lib/dotmailer.rb
 - spec/dot_mailer/account_spec.rb
+- spec/dot_mailer/campaign_spec.rb
+- spec/dot_mailer/campaign_summary_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/from_address_spec.rb
 - spec/dot_mailer/opt_in_type_spec.rb
+- spec/dot_mailer/segment_spec.rb
 - spec/dot_mailer/suppression_spec.rb
 - spec/spec_helper.rb
 - spec/support/assignable_attributes_helper.rb
@@ -108,12 +133,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -121,5 +146,5 @@ rubyforge_project: dotmailer
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: ! 'A Ruby wrapper around the dotMailer REST API: https://apiconnector.com/v2/help/wadl'
+summary: 'A Ruby wrapper around the dotMailer REST API: https://apiconnector.com/v2/help/wadl'
 test_files: []