xednese 0.0.1 → 0.1.0

data/lib/xednese/messages.rb

@@ -2,10 +2,15 @@ class Esendex
   class Messages
     PAGE_COUNT = 25
 
+    # @see Esendex#messages
+    # @api private
     def initialize(credentials)
       @credentials = credentials
     end
 
+    # @return [Enumerable<Responses::MessageHeader>] an Enumerable that iterates
+    #   over all sent messages. Requests are made for fixed size pages when
+    #   required.
     def sent
       Seq::Paged.new do |page|
         params = {
@@ -19,6 +24,25 @@ class Esendex
       end
     end
 
+    # @return [Enumerable<Responses::MessageHeader>] an Enumerable that iterates
+    #   over all received messages. Requests are made for fixed size pages when
+    #   required.
+    def received
+      Seq::Paged.new do |page|
+        params = {
+          startIndex: PAGE_COUNT * page,
+          count: PAGE_COUNT
+        }
+
+        Client.get(@credentials, "v1.0/inbox/messages", params) do |status, data|
+          Responses::MessageHeaders.deserialise(data).message_headers
+        end
+      end
+    end
+
+    # @param id [String] the id of the message to get
+    # @return [Responses::MessageHeader] the MessageHeader specified by the id
+    #   given
     def get(id)
       Client.get(@credentials, "v1.0/messageheaders/#{id}") do |status, data|
         Responses::MessageHeader.deserialise(data)

data/lib/xednese/requests/account.rb

@@ -0,0 +1,17 @@
+class Esendex
+  module Requests
+    class Account
+      def initialize(args)
+        @args = args
+      end
+
+      def serialise
+        Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
+          xml.account(xmlns: 'http://api.esendex.com/ns/') {
+            xml.label @args[:label]
+          }
+        end.to_xml
+      end
+    end
+  end
+end

data/lib/xednese/requests/batch.rb

@@ -0,0 +1,17 @@
+class Esendex
+  module Requests
+    class Batch
+      def initialize(args)
+        @args = args
+      end
+
+      def serialise
+        Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
+          xml.messagebatch(xmlns: 'http://api.esendex.com/ns/') {
+            xml.name @args[:name]
+          }
+        end.to_xml
+      end
+    end
+  end
+end

data/lib/xednese/requests/messages.rb

@@ -6,7 +6,7 @@ class Esendex
       end
 
       def serialise
-        Nokogiri::XML::Builder.new(:encoding => 'utf-8') do |xml|
+        Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
           xml.messages {
             xml.accountreference @args[:account_reference]
 

data/lib/xednese/responses/batch.rb

@@ -0,0 +1,20 @@
+class Esendex
+  module Responses
+    class Batch
+      extend Serialisable
+
+      root 'messagebatch'
+
+      attribute :id, 'id'
+
+      element :created_at, 'createdat'
+      element :batch_size, 'batchsize', :to_i
+      element :persisted_batch_size, 'persistedbatchsize', :to_i
+      element :account_reference, 'accountreference'
+      element :created_by, 'createdby'
+      element :name, 'name'
+
+      element :status, Status
+    end
+  end
+end

data/lib/xednese/responses/batches.rb

@@ -0,0 +1,15 @@
+class Esendex
+  module Responses
+    class Batches
+      extend Serialisable
+
+      root 'messagebatches'
+
+      attribute :start_index, 'startindex', :to_i
+      attribute :count,       'count',      :to_i
+      attribute :total_count, 'totalcount', :to_i
+
+      elements :batches, Batch
+    end
+  end
+end

data/lib/xednese/responses/status.rb

@@ -0,0 +1,22 @@
+class Esendex
+  module Responses
+    class Status
+      extend Serialisable
+
+      root 'status'
+
+      element :acknowledged, 'acknowledged', :to_i
+      element :authorisation_failed, 'authorisationfailed', :to_i
+      element :connecting, 'connecting', :to_i
+      element :delivered, 'delivered', :to_i
+      element :failed, 'failed', :to_i
+      element :partially_delivered, 'partiallydelivered', :to_i
+      element :rejected, 'rejected', :to_i
+      element :scheduled, 'scheduled', :to_i
+      element :sent, 'sent', :to_i
+      element :submitted, 'submitted', :to_i
+      element :validity_period_expired, 'validityperiodexpired', :to_i
+      element :cancelled, 'cancelled', :to_i
+    end
+  end
+end

data/lib/xednese/users.rb

@@ -1,15 +1,10 @@
 class Esendex
   class Users
+
+    # @see Esendex#users
+    # @api private
     def initialize(credentials)
       @credentials = credentials
     end
-
-    def username
-      @credentials.username
-    end
-
-    def password
-      @credentials.password
-    end
   end
 end

data/lib/xednese/version.rb

@@ -1,3 +1,3 @@
 class Esendex
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/scenarios/accounts/getting_all_accounts.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+describe 'getting all of my accounts' do
+  let(:username) { String.generate }
+  let(:password) { String.generate }
+  subject { Esendex.new(username, password) }
+
+  let(:accounts) { (0..100).map { Account.generate } }
+
+  let(:response_body) {
+    <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<accounts xmlns="http://api.esendex.com/ns/">
+  #{accounts.map {|a| a.to_xml(true) }.join("\n")}
+</accounts>
+EOS
+  }
+
+  before {
+    stub_request(:get, "https://#{username}:#{password}@api.esendex.com/v1.0/accounts?")
+      .with(headers: {"User-Agent" => Esendex::Client::USER_AGENT})
+      .to_return(status: 200, body: response_body)
+  }
+
+  it 'returns an Enumerable that iterates over my accounts' do
+    subject.accounts.entries.zip(accounts) do |returned, expected|
+      returned.id.must_equal expected.id
+      returned.reference.must_equal expected.reference
+      returned.label.must_equal expected.label
+      returned.address.must_equal expected.address
+      returned.type.must_equal expected.type
+      returned.messages_remaining.must_equal expected.messagesremaining
+      returned.expires_on.must_equal expected.expireson
+      returned.role.must_equal expected.role
+    end
+  end
+end

data/scenarios/accounts/getting_an_account.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+describe 'getting an account' do
+  let(:username) { String.generate }
+  let(:password) { String.generate }
+  subject { Esendex.new(username, password) }
+
+  let(:account) { Account.generate }
+  let(:response_body) { account.to_xml }
+
+  before {
+    stub_request(:get, "https://#{username}:#{password}@api.esendex.com/v1.0/accounts/#{account.id}?")
+      .with(headers: {"User-Agent" => Esendex::Client::USER_AGENT})
+      .to_return(status: 200, body: response_body)
+  }
+
+  it 'returns an Enumerable that iterates over my accounts' do
+    returned = subject.accounts.get(account.id)
+
+    returned.id.must_equal account.id
+    returned.reference.must_equal account.reference
+    returned.label.must_equal account.label
+    returned.address.must_equal account.address
+    returned.type.must_equal account.type
+    returned.messages_remaining.must_equal account.messagesremaining
+    returned.expires_on.must_equal account.expireson
+    returned.role.must_equal account.role
+  end
+end

data/scenarios/helper.rb

@@ -0,0 +1,113 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'webmock/minitest'
+require 'xednese'
+
+class String
+  def self.generate(length = 25)
+    chs = ('a'..'z').to_a + ('0'..'9').to_a + ('A'..'Z').to_a
+    (0..length).map { chs[rand(chs.size)] }.join('')
+  end
+
+  def pad(with, to)
+    (with * (to - size)) + self
+  end
+end
+
+class Uri
+  def self.generate
+    "https://#{String.generate(3)}.#{String.generate(15)}.com/#{String.generate(10)}"
+  end
+end
+
+class AccountReference
+  def self.generate
+    "EX" + rand(1e6).to_s.pad("0", 6)
+  end
+end
+
+class Guid
+  def self.generate
+    SecureRandom.uuid
+  end
+end
+
+class PhoneNumber
+  def self.generate
+    "44" + rand(1e9).to_s.pad("0", 9)
+  end
+end
+
+class Int
+  def self.generate(max = 1e6)
+    rand(max)
+  end
+end
+
+class Time
+  def self.generate
+    Time.at(628232400 + Int.generate(1e12))
+  end
+
+  def format
+    strftime("%FT%Tz")
+  end
+end
+
+class Account
+  def self.generate
+    new id: Guid.generate,
+        uri: Uri.generate,
+        reference: AccountReference.generate,
+        label: String.generate,
+        address: PhoneNumber.generate,
+        type: String.generate,
+        messagesremaining: Int.generate,
+        expireson: Time.generate.format,
+        role: String.generate,
+        settingsuri: Uri.generate
+  end
+
+  def initialize(hsh)
+    @hsh = hsh
+  end
+
+  def to_xml(partial = false)
+    if partial
+      <<EOS
+<account id="#{id}" uri="#{uri}">
+  <reference>#{reference}</reference>
+  <label>#{label}</label>
+  <address>#{address}</address>
+  <type>#{type}</type>
+  <messagesremaining>#{messagesremaining}</messagesremaining>
+  <expireson>#{expireson}</expireson>
+  <role>#{role}</role>
+  <settings uri="#{settingsuri}" />
+</account>
+EOS
+    else
+      <<EOS
+<?xml version="1.0" encoding="utf-8"?>
+<account id="#{id}" uri="#{uri}" xmlns="http://api.esendex.com/ns/">
+  <reference>#{reference}</reference>
+  <label>#{label}</label>
+  <address>#{address}</address>
+  <type>#{type}</type>
+  <messagesremaining>#{messagesremaining}</messagesremaining>
+  <expireson>#{expireson}</expireson>
+  <role>#{role}</role>
+  <settings uri="#{settingsuri}" />
+</account>
+EOS
+    end
+  end
+
+  def method_missing(sym, *args)
+    if @hsh.has_key?(sym)
+      return @hsh[sym]
+    end
+
+    super
+  end
+end

data/spec/helper.rb

@@ -2,12 +2,12 @@ require 'minitest/autorun'
 require 'minitest/pride'
 require 'mocha/mini_test'
 
-require_relative '../lib/xednese'
+require 'xednese'
 
 def dummy_esendex
-  Esendex.new('what', 'when', 'really?')
+  Esendex.new('what', 'when')
 end
 
 def dummy_credentials
-  Esendex::Credentials.new('user', 'pass', 'what?')
+  Esendex::Credentials.new('user', 'pass')
 end

data/spec/xednese/{dispatcher_spec.rb → account/dispatcher_spec.rb}

@@ -1,8 +1,9 @@
-require_relative '../helper'
+require 'helper'
 
-describe Esendex::Dispatcher do
+describe Esendex::Account::Dispatcher do
+  let(:reference)   { mock }
   let(:credentials) { dummy_credentials }
-  subject { Esendex::Dispatcher.new(credentials) }
+  subject { Esendex::Account::Dispatcher.new(credentials, reference) }
 
   describe '.send' do
     let(:body) { 'Hey I am message' }
@@ -13,7 +14,7 @@ describe Esendex::Dispatcher do
 
     before {
       args = {
-        account_reference: credentials.account_reference,
+        account_reference: reference,
         messages: [{ to: to, body: body }]
       }
 

data/spec/xednese/account/messages_spec.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+describe Esendex::Account::Messages do
+  let(:credentials) { dummy_credentials }
+  let(:reference)   { "EX00000" }
+  subject { Esendex::Account::Messages.new(credentials, reference) }
+
+  describe '#sent' do
+    let(:xml) { "Hey I'm xml" }
+    let(:first_message) { Object.new }
+    let(:parsed_messages) { stub(message_headers: [first_message]) }
+
+    before {
+      Esendex::Client
+        .expects(:get)
+        .with(credentials, 'v1.0/messageheaders',
+              startIndex: 0, count: 25, accountReference: reference)
+        .yields(200, xml)
+        .returns(parsed_messages.message_headers)
+
+      Esendex::Responses::MessageHeaders
+        .expects(:deserialise)
+        .with(xml)
+        .returns(parsed_messages)
+    }
+
+    it 'returns the messages sent by the user on the account' do
+      sent = subject.sent
+      sent.first.must_equal first_message
+    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/#{reference}/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.received
+      received.first.must_equal first_message
+    end
+  end
+end