xednese 0.0.1 → 0.1.0

data/spec/xednese/messages_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../helper'
+require 'helper'
 
 describe Esendex::Messages do
   subject { dummy_esendex }
@@ -28,6 +28,30 @@ describe Esendex::Messages do
     end
   end
 
+  describe '#received' do
+    let(:xml) { "Hey I'm xml" }
+    let(:first_message) { mock }
+    let(:parsed_messages) { stub(message_headers: [first_message]) }
+
+    before {
+      Esendex::Client
+        .expects(:get)
+        .with(credentials, "v1.0/inbox/messages", startIndex: 0, count: 25)
+        .yields(200, xml)
+        .returns(parsed_messages.message_headers)
+
+      Esendex::Responses::MessageHeaders
+        .expects(:deserialise)
+        .with(xml)
+        .returns(parsed_messages)
+    }
+
+    it 'returns the messages received by the user on the account' do
+      received = subject.messages.received
+      received.first.must_equal first_message
+    end
+  end
+
   describe '#get' do
     let(:message_id) { "guid" }
     let(:xml) { "Hey I'm xml" }

data/spec/xednese/requests/account_spec.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+describe Esendex::Requests::Account do
+  subject { Esendex::Requests::Account }
+
+  describe '#serialise' do
+    let(:label) { "what a label?" }
+
+    it 'returns an xml representation of the instance' do
+      account = subject.new(label: label)
+
+      account.serialise.must_equal <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<account xmlns="http://api.esendex.com/ns/">
+  <label>#{label}</label>
+</account>
+EOS
+    end
+  end
+end

data/spec/xednese/requests/batch_spec.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+describe Esendex::Requests::Batch do
+  subject { Esendex::Requests::Batch }
+
+  describe '#serialise' do
+    let(:new_name) { "what a name!" }
+
+    it 'returns an xml representation of the instance' do
+      batch = subject.new(name: new_name)
+
+      batch.serialise.must_equal <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<messagebatch xmlns="http://api.esendex.com/ns/">
+  <name>#{new_name}</name>
+</messagebatch>
+EOS
+    end
+  end
+end

data/spec/xednese/requests/messages_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../helper'
+require 'helper'
 
 describe Esendex::Requests::Messages do
   subject { Esendex::Requests::Messages }

data/spec/xednese/responses/account_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../helper'
+require 'helper'
 
 describe Esendex::Responses::Account do
   describe '.deserialise' do

data/spec/xednese/responses/accounts_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../helper'
+require 'helper'
 
 describe Esendex::Responses::Accounts do
   describe '.deserialise' do

data/spec/xednese/responses/batch_spec.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+describe Esendex::Responses::Batch do
+  describe '.deserialise' do
+    let(:id) { "642A01A6-A483-44F3-A2F2-A48B1D0FE141" }
+    let(:createdat) { "2012-01-01T12:00:00.000Z" }
+    let(:batchsize) { 1 }
+    let(:persistedbatchsize) { 1 }
+
+    let(:acknowledged) { 0 }
+    let(:authorisationfailed) { 0 }
+    let(:connecting) { 0 }
+    let(:delivered) { 0 }
+    let(:failed) { 0 }
+    let(:partiallydelivered) { 0 }
+    let(:rejected) { 0 }
+    let(:scheduled) { 0 }
+    let(:sent) { 0 }
+    let(:submitted) { 1 }
+    let(:validityperiodexpired) { 0 }
+    let(:cancelled) { 0 }
+
+    let(:accountreference) { "EX0000000" }
+    let(:createdby) { "user@example.com" }
+    let(:batch_name) { "hey my batch" }
+
+    let(:xml) {
+      <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<messagebatch id="#{id}"
+   uri="https://api.esendex.com/v1.1/messagebatches/#{id}"
+   xmlns="http://api.esendex.com/ns/">
+  <createdat>#{createdat}</createdat>
+  <batchsize>#{batchsize}</batchsize>
+  <persistedbatchsize>#{persistedbatchsize}</persistedbatchsize>
+  <status>
+    <acknowledged>#{acknowledged}</acknowledged>
+    <authorisationfailed>#{authorisationfailed}</authorisationfailed>
+    <connecting>#{connecting}</connecting>
+    <delivered>#{delivered}</delivered>
+    <failed>#{failed}</failed>
+    <partiallydelivered>#{partiallydelivered}</partiallydelivered>
+    <rejected>#{rejected}</rejected>
+    <scheduled>#{scheduled}</scheduled>
+    <sent>#{sent}</sent>
+    <submitted>#{submitted}</submitted>
+    <validityperiodexpired>#{validityperiodexpired}</validityperiodexpired>
+    <cancelled>#{cancelled}</cancelled>
+  </status>
+  <accountreference>#{accountreference}</accountreference>
+  <createdby>#{createdby}</createdby>
+  <name>#{batch_name}</name>
+</messagebatch>
+EOS
+    }
+
+    it 'deserialises xml into a Batch instance' do
+      batch = Esendex::Responses::Batch.deserialise(xml)
+
+      batch.id.must_equal id
+      batch.created_at.must_equal createdat
+      batch.batch_size.must_equal batchsize
+      batch.persisted_batch_size.must_equal persistedbatchsize
+
+      batch.account_reference.must_equal accountreference
+      batch.created_by.must_equal createdby
+      batch.name.must_equal batch_name
+
+      batch.status.acknowledged.must_equal acknowledged
+      batch.status.authorisation_failed.must_equal authorisationfailed
+      batch.status.connecting.must_equal connecting
+      batch.status.delivered.must_equal delivered
+      batch.status.failed.must_equal failed
+      batch.status.partially_delivered.must_equal partiallydelivered
+      batch.status.rejected.must_equal rejected
+      batch.status.scheduled.must_equal scheduled
+      batch.status.sent.must_equal sent
+      batch.status.submitted.must_equal submitted
+      batch.status.validity_period_expired.must_equal validityperiodexpired
+      batch.status.cancelled.must_equal cancelled
+    end
+  end
+end

data/spec/xednese/responses/batches_spec.rb

@@ -0,0 +1,95 @@
+require 'helper'
+
+describe Esendex::Responses::Batches do
+  describe '.deserialise' do
+    let(:startindex) { 5 }
+    let(:count)      { 2000 }
+    let(:totalcount) { 24565 }
+
+    let(:id) { "642A01A6-A483-44F3-A2F2-A48B1D0FE141" }
+    let(:createdat) { "2012-01-01T12:00:00.000Z" }
+    let(:batchsize) { 1 }
+    let(:persistedbatchsize) { 1 }
+
+    let(:acknowledged) { 0 }
+    let(:authorisationfailed) { 0 }
+    let(:connecting) { 0 }
+    let(:delivered) { 0 }
+    let(:failed) { 0 }
+    let(:partiallydelivered) { 0 }
+    let(:rejected) { 0 }
+    let(:scheduled) { 0 }
+    let(:sent) { 0 }
+    let(:submitted) { 1 }
+    let(:validityperiodexpired) { 0 }
+    let(:cancelled) { 0 }
+
+    let(:accountreference) { "EX0000000" }
+    let(:createdby) { "user@example.com" }
+    let(:batch_name) { "hey my batch" }
+
+    let(:xml) {
+      <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<messagebatches startindex="#{startindex}" count="#{count}" totalcount="#{totalcount}"
+     xmlns="http://api.esendex.com/ns/">
+  <messagebatch id="#{id}"
+     uri="https://api.esendex.com/v1.1/messagebatches/#{id}">
+    <createdat>#{createdat}</createdat>
+    <batchsize>#{batchsize}</batchsize>
+    <persistedbatchsize>#{persistedbatchsize}</persistedbatchsize>
+    <status>
+      <acknowledged>#{acknowledged}</acknowledged>
+      <authorisationfailed>#{authorisationfailed}</authorisationfailed>
+      <connecting>#{connecting}</connecting>
+      <delivered>#{delivered}</delivered>
+      <failed>#{failed}</failed>
+      <partiallydelivered>#{partiallydelivered}</partiallydelivered>
+      <rejected>#{rejected}</rejected>
+      <scheduled>#{scheduled}</scheduled>
+      <sent>#{sent}</sent>
+      <submitted>#{submitted}</submitted>
+      <validityperiodexpired>#{validityperiodexpired}</validityperiodexpired>
+      <cancelled>#{cancelled}</cancelled>
+    </status>
+    <accountreference>#{accountreference}</accountreference>
+    <createdby>#{createdby}</createdby>
+    <name>#{batch_name}</name>
+  </messagebatch>
+</messagebatches>
+EOS
+    }
+
+    it 'deserialises xml into a Batches instance' do
+      batches = Esendex::Responses::Batches.deserialise(xml)
+
+      batches.start_index.must_equal startindex
+      batches.count.must_equal count
+      batches.total_count.must_equal totalcount
+
+      batch = batches.batches.first
+
+      batch.id.must_equal id
+      batch.created_at.must_equal createdat
+      batch.batch_size.must_equal batchsize
+      batch.persisted_batch_size.must_equal persistedbatchsize
+
+      batch.account_reference.must_equal accountreference
+      batch.created_by.must_equal createdby
+      batch.name.must_equal batch_name
+
+      batch.status.acknowledged.must_equal acknowledged
+      batch.status.authorisation_failed.must_equal authorisationfailed
+      batch.status.connecting.must_equal connecting
+      batch.status.delivered.must_equal delivered
+      batch.status.failed.must_equal failed
+      batch.status.partially_delivered.must_equal partiallydelivered
+      batch.status.rejected.must_equal rejected
+      batch.status.scheduled.must_equal scheduled
+      batch.status.sent.must_equal sent
+      batch.status.submitted.must_equal submitted
+      batch.status.validity_period_expired.must_equal validityperiodexpired
+      batch.status.cancelled.must_equal cancelled
+    end
+  end
+end

data/spec/xednese/responses/message_dispatcher_headers_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../helper'
+require 'helper'
 
 describe Esendex::Responses::MessageDispatcherHeaders do
   subject { Esendex::Responses::MessageDispatcherHeaders }

data/spec/xednese/responses/message_header_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../helper'
+require 'helper'
 
 describe Esendex::Responses::MessageHeader do
   describe '.deserialise' do

data/spec/xednese/responses/message_headers_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../helper'
+require 'helper'
 
 describe Esendex::Responses::MessageHeaders do
   describe '.deserialise' do

data/spec/xednese/responses/status_spec.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+describe Esendex::Responses::Status do
+  describe '.deserialise' do
+    let(:acknowledged) { 0 }
+    let(:authorisationfailed) { 0 }
+    let(:connecting) { 0 }
+    let(:delivered) { 0 }
+    let(:failed) { 0 }
+    let(:partiallydelivered) { 0 }
+    let(:rejected) { 0 }
+    let(:scheduled) { 0 }
+    let(:sent) { 0 }
+    let(:submitted) { 1 }
+    let(:validityperiodexpired) { 0 }
+    let(:cancelled) { 0 }
+
+    let(:xml) {
+      <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<status>
+  <acknowledged>#{acknowledged}</acknowledged>
+  <authorisationfailed>#{authorisationfailed}</authorisationfailed>
+  <connecting>#{connecting}</connecting>
+  <delivered>#{delivered}</delivered>
+  <failed>#{failed}</failed>
+  <partiallydelivered>#{partiallydelivered}</partiallydelivered>
+  <rejected>#{rejected}</rejected>
+  <scheduled>#{scheduled}</scheduled>
+  <sent>#{sent}</sent>
+  <submitted>#{submitted}</submitted>
+  <validityperiodexpired>#{validityperiodexpired}</validityperiodexpired>
+  <cancelled>#{cancelled}</cancelled>
+</status>
+EOS
+    }
+
+    it 'deserialises xml into a Status instance' do
+      status = Esendex::Responses::Status.deserialise(xml)
+
+      status.acknowledged.must_equal acknowledged
+      status.authorisation_failed.must_equal authorisationfailed
+      status.connecting.must_equal connecting
+      status.delivered.must_equal delivered
+      status.failed.must_equal failed
+      status.partially_delivered.must_equal partiallydelivered
+      status.rejected.must_equal rejected
+      status.scheduled.must_equal scheduled
+      status.sent.must_equal sent
+      status.submitted.must_equal submitted
+      status.validity_period_expired.must_equal validityperiodexpired
+      status.cancelled.must_equal cancelled
+    end
+  end
+end

data/spec/xednese/users_spec.rb

@@ -1,18 +1,7 @@
-require_relative '../helper'
+require 'helper'
 
 describe Esendex::Users do
   let(:credentials) { Esendex::Credentials.new('user', 'pass', 'ref') }
   subject { Esendex::Users.new(credentials) }
 
-  describe '#username' do
-    it 'returns the username' do
-      subject.username.must_equal credentials.username
-    end
-  end
-
-  describe '#password' do
-    it 'returns the password' do
-      subject.password.must_equal credentials.password
-    end
-  end
 end

data/spec/xednese_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'helper'
+require 'helper'
 
 describe Esendex do
 
@@ -6,28 +6,68 @@ describe Esendex do
   let(:credentials) { subject.instance_variable_get(:@credentials) }
 
   describe '#account' do
-    let(:account) { Object.new }
+    describe 'when account exists' do
+      let(:reference) { mock }
+      let(:account)   { mock(reference: reference) }
+      let(:accounts)  { [stub(reference: mock),
+                         stub(reference: mock),
+                         account,
+                         stub(reference: mock)] }
+
+      before {
+        Esendex::Accounts
+          .expects(:new)
+          .with(credentials)
+          .returns(accounts)
+      }
+
+      it 'returns the Account with that reference' do
+        subject.account(reference).must_equal account
+      end
+    end
+
+    describe 'when account does not exist' do
+      let(:reference) { mock }
+      let(:accounts)  { [stub(reference: mock),
+                         stub(reference: mock),
+                         stub(reference: mock)] }
+
+      before {
+        Esendex::Accounts
+          .expects(:new)
+          .with(credentials)
+          .returns(accounts)
+      }
+
+      it 'is nil' do
+        subject.account(reference).must_equal nil
+      end
+    end
+  end
+
+  describe '#accounts' do
+    let(:accounts) { Object.new }
 
     it 'returns a new Accounts instance' do
       Esendex::Accounts
         .expects(:new)
         .with(credentials)
-        .returns(account)
+        .returns(accounts)
 
-      subject.account.must_equal account
+      subject.accounts.must_equal accounts
     end
   end
 
-  describe '#dispatcher' do
-    let(:dispatcher) { Object.new }
+  describe '#batches' do
+    let(:batches) { mock }
 
-    it 'returns a new Dispatcher instance' do
-      Esendex::Dispatcher
+    it 'returns a new Batches instance' do
+      Esendex::Batches
         .expects(:new)
         .with(credentials)
-        .returns(dispatcher)
+        .returns(batches)
 
-      subject.dispatcher.must_equal dispatcher
+      subject.batches.must_equal batches
     end
   end
 
@@ -44,7 +84,7 @@ describe Esendex do
     end
   end
 
-  describe '#user' do
+  describe '#users' do
     let(:user) { Object.new }
 
     it 'returns a new Users instance' do
@@ -53,7 +93,7 @@ describe Esendex do
         .with(credentials)
         .returns(user)
 
-      subject.user.must_equal user
+      subject.users.must_equal user
     end
   end
 end