emarsys-broadcast 0.1.0

data/lib/emarsys/broadcast/validation.rb

@@ -0,0 +1,14 @@
+module Emarsys
+  module Broadcast
+    module Validation
+      def string_present? value
+        !value.to_s.strip.empty?
+      end
+
+      def within_range? value, range
+        raise ArgumentError, 'range is required' if range.nil? || !range.is_a?(::Range)
+        range.include? value
+      end
+    end
+  end
+end

data/lib/emarsys/broadcast/validation_error.rb

@@ -0,0 +1,11 @@
+module Emarsys
+  module Broadcast
+    class ValidationError < StandardError
+      attr_reader :errors
+      def initialize(message, errors)
+        super(message)
+        @errors = errors
+      end
+    end
+  end
+end

data/lib/emarsys/broadcast/version.rb

@@ -0,0 +1,5 @@
+module Emarsys
+  module Broadcast
+    VERSION = "0.1.0"
+  end
+end

data/lib/emarsys/broadcast/xml_builder.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+module Emarsys
+  module Broadcast
+    class XmlBuilder
+      include Validation
+
+      def import_xml(remote_path)
+        xml = Nokogiri::XML::Builder.new do |xml|
+          xml.importRequest {
+            xml.filePath remote_path
+          }
+        end
+        xml.to_xml
+      end
+
+      def sender_xml(sender)
+        xml = Nokogiri::XML::Builder.new do |xml|
+          xml.sender {
+            xml.name sender.name
+            xml.address sender.address
+          }
+        end
+        xml.to_xml
+      end
+
+      private 
+
+      def validate_options(options)
+        raise ArgumentError, 'options can not be nil' unless options
+        raise ArgumentError, 'name is required' unless string_present? options[:name]
+      end
+ 
+    end
+  end
+end

data/lib/emarsys/broadcast.rb

@@ -0,0 +1,18 @@
+require 'active_model'
+require 'emarsys/broadcast/version'
+require 'emarsys/broadcast/email'
+require 'emarsys/broadcast/validation'
+require 'emarsys/broadcast/configuration'
+require 'emarsys/broadcast/sftp'
+require 'emarsys/broadcast/http'
+require 'emarsys/broadcast/validation_error'
+require 'emarsys/broadcast/batch'
+require 'emarsys/broadcast/sender'
+require 'emarsys/broadcast/batch_xml_builder'
+require 'emarsys/broadcast/xml_builder'
+require 'emarsys/broadcast/api'
+
+module Emarsys
+  module Broadcast
+  end
+end

data/spec/api_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::API do
+  before(:each){create_valid_config}
+  after(:each){restore_default_config}
+  let(:config){create_valid_config}
+  describe 'initialize' do
+    context 'when configured properly' do
+
+      it 'should initialize a new instance of API' do
+        api = Emarsys::Broadcast::API.new
+        expect(api).not_to be_nil
+      end
+
+      it 'should instantiate sftp' do
+        Emarsys::Broadcast::SFTP.should_receive(:new).with(config)
+        api = Emarsys::Broadcast::API.new
+      end
+
+      it 'should instantiate http' do
+        Emarsys::Broadcast::HTTP.should_receive(:new).with(config)
+        api = Emarsys::Broadcast::API.new
+      end
+    end
+  end
+
+  describe '#send_batch' do
+    let(:api){Emarsys::Broadcast::API.new}
+    let(:minimal_batch){create_minimal_batch}
+
+    it 'should raise ValidationError if passed invalid batch' do
+      expect {
+        invalid_batch = Emarsys::Broadcast::Batch.new
+        api.send_batch(invalid_batch)
+      }.to raise_error Emarsys::Broadcast::ValidationError
+    end
+  end
+end

data/spec/batch_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::Batch do
+  it 'should initialize a new instance of batch' do
+    expect(Emarsys::Broadcast::Batch.new).not_to be_nil
+  end
+end

data/spec/batch_xml_builder_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::BatchXmlBuilder do
+  let(:batch_builder){batch_builder = Emarsys::Broadcast::BatchXmlBuilder.new}
+  let(:minimal_batch){create_minimal_batch}
+  let(:minimal_html_batch){create_minimal_html_batch}
+  describe 'initialize' do
+    it 'should create a new instance of BatchXmlBuilder' do
+      expect(batch_builder).not_to be_nil
+    end
+  end
+
+  describe '#build' do
+    # these tests fail on jruby Nokogiri
+    # it 'should return a valid Emarsys Xml XML string' do
+    #   actual_xml = batch_builder.build(minimal_batch).chomp
+    #   fixture_path = File.dirname(__FILE__) + '/fixtures/minimal_batch.xml'
+    #   expected_xml = File.read(fixture_path)
+    #   expect(actual_xml).to eq expected_xml
+    # end
+
+    # it 'should properly escape the body of the Emarsys Xml XML string' do
+    #   actual_xml = batch_builder.build(minimal_html_batch).chomp
+    #   fixture_path = File.dirname(__FILE__) + '/fixtures/minimal_escaped_batch.xml'
+    #   expected_xml = File.read(fixture_path)
+    #   expect(actual_xml).to eq expected_xml
+    # end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::Configuration do
+
+  after(:each){restore_default_config}
+
+  describe 'configure' do
+
+    it 'should return instance of configuration when configured' do
+      configuration = Emarsys::Broadcast::configure {}
+      expect(configuration).not_to be_nil
+      expect(configuration).to be_an_instance_of Emarsys::Broadcast::Configuration
+    end
+
+
+    describe 'when sftp_host is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.sftp_host = 'some_host'
+        end
+      end
+
+      it 'returns sftp_host' do
+        expect(Emarsys::Broadcast.configuration.sftp_host).to eq 'some_host'
+      end
+    end
+
+    describe 'when sftp_host is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to e3.emarsys.net' do
+        expect(Emarsys::Broadcast.configuration.sftp_host).to eq 'e3.emarsys.net'
+      end
+    end
+
+    describe 'when sftp_user is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.sftp_user = 'some_user'
+        end
+      end
+
+      it 'returns sftp_user' do
+        expect(Emarsys::Broadcast.configuration.sftp_user).to eq 'some_user'
+      end
+    end
+
+    describe 'when sftp_user is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to nil' do
+        expect(Emarsys::Broadcast.configuration.sftp_user).to be_nil
+      end
+    end
+
+    describe 'when sftp_password is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.sftp_password = 'some_password'
+        end
+      end
+
+      it 'returns sftp_password' do
+        expect(Emarsys::Broadcast.configuration.sftp_password).to eq 'some_password'
+      end
+    end
+
+    describe 'when sftp_password is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to nil' do
+        expect(Emarsys::Broadcast.configuration.sftp_password).to be_nil
+      end
+    end
+
+    describe 'when sftp_port is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.sftp_port = 2222
+        end
+      end
+
+      it 'returns sftp_port' do
+        expect(Emarsys::Broadcast.configuration.sftp_port).to eq 2222
+      end
+    end
+
+    describe 'when sftp_port is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to 22' do
+        expect(Emarsys::Broadcast.configuration.sftp_port).to eq 22
+      end
+    end
+
+    describe 'when api_host is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.api_host = 'some_host'
+        end
+      end
+
+      it 'returns api_host' do
+        expect(Emarsys::Broadcast.configuration.api_host).to eq 'some_host'
+      end
+    end
+
+    describe 'when api_host is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to e3.emarsys.net' do
+        expect(Emarsys::Broadcast.configuration.api_host).to eq 'e3.emarsys.net'
+      end
+    end
+
+    describe 'when api_user is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.api_user = 'some_user'
+        end
+      end
+
+      it 'returns api_user' do
+        expect(Emarsys::Broadcast.configuration.api_user).to eq 'some_user'
+      end
+    end
+
+    describe 'when api_user is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to nil' do
+        expect(Emarsys::Broadcast.configuration.api_user).to be_nil
+      end
+    end
+
+    describe 'when api_password is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.api_password = 'some_password'
+        end
+      end
+
+      it 'returns api_password' do
+        expect(Emarsys::Broadcast.configuration.api_password).to eq 'some_password'
+      end
+    end
+
+    describe 'when api_password is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to nil' do
+        expect(Emarsys::Broadcast.configuration.api_password).to be_nil
+      end
+    end
+
+    describe 'when api_port is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.api_port = 8080
+        end
+      end
+
+      it 'returns api_port' do
+        expect(Emarsys::Broadcast.configuration.api_port).to eq 8080
+      end
+    end
+
+    describe 'when api_port is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to 80' do
+        expect(Emarsys::Broadcast.configuration.api_port).to eq 80
+      end
+    end
+
+      describe 'when sender is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.sender = 'sender'
+        end
+      end
+
+      it 'returns sender' do
+        expect(Emarsys::Broadcast.configuration.sender).to eq 'sender'
+      end
+    end
+
+    describe 'when sender is not set' do
+      before do 
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to nil' do
+        expect(Emarsys::Broadcast.configuration.sender).to be_nil
+      end
+    end
+  end
+
+end

data/spec/email_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::Email do
+  it 'should validate valid email' do
+    expect(Emarsys::Broadcast::Email::validate 'winston.smith-1984@big.brother.ru').to be_true
+    expect(Emarsys::Broadcast::Email::validate 'abc@example.com').to be_true
+  end
+  it 'should not validate invalid email' do
+    expect(Emarsys::Broadcast::Email::validate 'some invalid@email').to be_false
+  end
+end

data/spec/fixtures/minimal_batch.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<batch><name>batch_name</name><runDate>2013-12-31T00:00:00-0800</runDate><properties><property key="Sender">sender_id</property><property key="Language">en</property><property key="Encoding">UTF-8</property><property key="Domain">e3.emarsys.net</property></properties><subject>subject</subject><html>body</html></batch>

data/spec/fixtures/minimal_escaped_batch.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<batch><name>batch_name</name><runDate>2013-12-31T00:00:00-0800</runDate><properties><property key="Sender">sender_id</property><property key="Language">en</property><property key="Encoding">UTF-8</property><property key="Domain">e3.emarsys.net</property></properties><subject>subject</subject><html>&lt;h1&gt;hello&lt;/h1&gt;</html></batch>

data/spec/fixtures/xml_builder_import.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0"?>
+<importRequest>
+  <filePath>batch_name</filePath>
+</importRequest>

data/spec/http_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::HTTP do
+  let(:config){create_valid_config}
+  let(:http){Emarsys::Broadcast::HTTP.new config}
+end

data/spec/sftp_spec.rb

@@ -0,0 +1,99 @@
+require 'net/sftp'
+require 'spec_helper'
+
+describe Emarsys::Broadcast::SFTP do
+
+  describe 'initialize' do
+    after(:each){restore_default_config}
+    it 'should create a new instance of SFTP from valid configuration' do
+      config = Emarsys::Broadcast::configure do |c|
+        c.sftp_host = 'localhost'
+        c.sftp_user = 'user'
+        c.sftp_password = 'password'
+      end
+
+      sftp = Emarsys::Broadcast::SFTP.new config
+      expect(sftp).not_to be_nil
+    end
+
+    context 'invalid sftp configuration' do
+      it 'should raise ConfigurationError when config is nil (was never configured)' do
+        expect{Emarsys::Broadcast::SFTP.new(nil)}.to raise_error Emarsys::Broadcast::ConfigurationError
+      end
+
+      it 'should raise ConfigurationError when no sftp_user is configured' do
+        config = Emarsys::Broadcast::configure do |c|
+          c.sftp_host = 'host'
+          c.sftp_password = 'password'
+        end
+        expect{Emarsys::Broadcast::SFTP.new(config)}.to raise_error Emarsys::Broadcast::ConfigurationError
+      end
+
+      it 'should raise ConfigurationError when no sftp_password is configured' do
+        config = Emarsys::Broadcast::configure do |c|
+          c.sftp_host = 'host'
+          c.sftp_user = 'user'
+        end
+        expect{Emarsys::Broadcast::SFTP.new(config)}.to raise_error Emarsys::Broadcast::ConfigurationError
+      end
+
+      it 'should raise ConfigurationError when sftp_port is nil' do
+        config = Emarsys::Broadcast::configure do |c|
+          c.sftp_host = 'host'
+          c.sftp_user = 'user'
+          c.sftp_password = 'password'
+          c.sftp_port = nil
+        end
+        expect{Emarsys::Broadcast::SFTP.new(config)}.to raise_error Emarsys::Broadcast::ConfigurationError
+      end
+
+      it 'should raise ConfigurationError when sftp_port is not Integer' do
+        config = Emarsys::Broadcast::configure do |c|
+          c.sftp_host = 'host'
+          c.sftp_user = 'user'
+          c.sftp_password = 'password'
+          c.sftp_port = 'blaster'
+        end
+        expect{Emarsys::Broadcast::SFTP.new(config)}.to raise_error Emarsys::Broadcast::ConfigurationError
+      end
+
+      it 'should raise ConfigurationError when  sftp_port is outside the valid range (1..65536)' do
+        config = Emarsys::Broadcast::configure do |c|
+          c.sftp_host = 'host'
+          c.sftp_user = 'user'
+          c.sftp_password = 'password'
+          c.sftp_port = 999999
+        end
+        expect{Emarsys::Broadcast::SFTP.new(config)}.to raise_error Emarsys::Broadcast::ConfigurationError
+      end
+    end
+  end
+
+  context 'initialized' do
+    let(:config) do
+      config = Emarsys::Broadcast::configure do |c|
+        c.sftp_host = 'host'
+        c.sftp_user = 'user'
+        c.sftp_password = 'password'
+      end
+    end
+
+    let(:sftp) do
+      Emarsys::Broadcast::SFTP.new config
+    end
+
+    describe '#upload_file' do
+      it 'should call Net::SFTP.start with sftp configuration values' do
+        Net::SFTP.should_receive(:start).with(config.sftp_host, config.sftp_user, password: config.sftp_password)
+        sftp.upload_file('local_file', 'remote_file')
+      end
+
+      it 'should take an instance of SFTP as a block argument and call #upload! on it with file paths' do
+        mock_session = mock('session')
+        Net::SFTP.stub(:start).and_yield mock_session
+        mock_session.should_receive(:upload!).with('local_file', 'remote_file')
+        sftp.upload_file('local_file', 'remote_file')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+require 'bundler/setup'
+require 'emarsys/broadcast'
+require 'timecop'
+
+
+def restore_default_config
+  Emarsys::Broadcast.configuration = nil
+  Emarsys::Broadcast.configure {}
+end
+
+def create_valid_config
+  Emarsys::Broadcast::configure do |c|
+    c.sftp_host = 'a'
+    c.sftp_user = 'a'
+    c.sftp_password = 'a'
+
+    c.api_user = 'a'
+    c.api_password = 'a'
+
+    c.sender = spec_sender
+  end
+end
+
+def create_full_batch
+  batch = Emarsys::Broadcast::Batch.new
+  batch.name="test_batch_#{Time.now.to_i}"
+  batch.subject = 'די שטאַט פון ישראל'
+  batch.body_html = '<h1>די שטאט ווערט שוין דערמאנט אין תנ"ך. לויט געוויסע איז אליעזר (עבד אברהם) פון דמשק. דוד המלך, האט מלחמה געהאלטן און איינגענומען דמשק. און שפעטער מלכי ישראל. דאס איז שוין 3,000 יאר צוריק.<i>!</i></h1>'
+  batch.sender = 'פייַןבאָכער@gmail.com'
+  batch.sender_domain = 'google.com'
+  batch.send_time = Time.now + 1000000
+  batch
+end
+
+def create_minimal_batch
+  batch = Emarsys::Broadcast::Batch.new
+  batch.name="batch_name"
+  batch.subject = 'subject'
+  batch.body_html = 'body'
+  batch.send_time = spec_time
+  batch.sender_id = 'sender_id'
+  batch.sender_domain = 'e3.emarsys.net'
+  batch
+end
+
+def create_minimal_html_batch
+  batch = Emarsys::Broadcast::Batch.new
+  batch.name="batch_name"
+  batch.subject = 'subject'
+  batch.body_html = '<h1>hello</h1>'
+  batch.send_time = spec_time
+  batch.sender_id = 'sender_id'
+  batch.sender_domain = 'e3.emarsys.net'
+  batch
+end
+
+def spec_time
+  Time.new(2013, 12, 31, 0, 0, 0, "-08:00")
+end
+
+def spec_sender
+  'abc@example.com'
+end
+

data/spec/validation_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::Validation do 
+  class Test
+    include Emarsys::Broadcast::Validation
+  end
+  let(:test){Test.new}
+  describe '#string_present?' do
+
+    it 'should return true if string not nil or empty' do
+      expect(test.string_present? 'hello').to be_true
+    end
+
+    it 'should return false if string is nil' do
+      expect(test.string_present? nil).to be_false
+    end
+
+    it 'should return false if string is empty' do
+      expect(test.string_present? '').to be_false
+    end
+
+    it 'should return false if string is all spaces' do
+      expect(test.string_present? '   ').to be_false
+    end
+  end
+
+  describe '#within_range?' do
+    it 'should return true if integer is within range' do
+      expect(test.within_range? 99, 1..100).to be_true
+    end
+
+    it 'should return false if integer is not within range' do
+      expect(test.within_range? 101, 1..100).to be_false
+    end
+
+    it 'should return false if integer is nil' do
+      expect(test.within_range? nil, 1..100).to be_false
+    end
+
+    it 'should raise ArgumentError is range is nil' do
+      expect{test.within_range?(99, nil)}.to raise_error ArgumentError
+    end
+
+    it 'should raise ArgumentError is range is not a Range' do
+      expect{test.within_range?(99, [])}.to raise_error ArgumentError
+    end
+  end
+  
+end

data/spec/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Emarsys::Broadcast::VERSION do
+  it 'should return version' do
+    expect(Emarsys::Broadcast::VERSION).to_not be_nil
+  end
+end

data/spec/xml_builder_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+describe Emarsys::Broadcast::XmlBuilder do
+  let(:valid_options){options = {name: 'batch_name'}}
+  let(:xml_builder){Emarsys::Broadcast::XmlBuilder.new(valid_options)}
+end