emarsys-broadcast 0.1.0 → 0.1.1

data/README.md

@@ -1,7 +1,5 @@
-# Emarsys::Broadcast
+# Emarsys::Broadcast a ruby wrapper for Emarsys batch mailing API
 
-Ruby wrapper for Emarsys batch mailing API
-==========================================
 [![Build Status](https://travis-ci.org/Valve/emarsys-broadcast-ruby.png)](https://travis-ci.org/Valve/emarsys-broadcast-ruby)
 [![Code Climate](https://codeclimate.com/github/Valve/emarsys-broadcast-ruby.png)](https://codeclimate.com/github/Valve/emarsys-broadcast-ruby)
 
@@ -55,34 +53,6 @@ api.send_batch(batch)
 
 This will synchronously send the batch email to all recipients found in CSV file.
 
-### Moving batch properties to configuration
-
-If you find yourself using same batch attributes over and over again, for example `recipients_path`, 
-you can move those values into configuration:
-
-```ruby
-Emarsys::Broadcast::configure do |c|
-  c.api_user = your_api_user
-  c.api_password = your_api_password
-
-  c.sftp_user = your_sftp_user
-  c.sftp_password = your_sftp_password
-
-  c.sender = 'sender_id'
-  c.sender_domain = 'mail.your.company.com'
-  c.recipients_path = '/path/to/hyour/csv/with/emails'
-end
-
-# now you can omit these attributes when constructing a batch:
-batch = Emarsys::Broadcast::Batch.new
-batch.name = 'newsletter_2013_06_01'
-batch.subject = 'June 2013 company news'
-batch.body_html = '<h1>Dear 朋友!</h1>'
-
-# send your batch as above, via api
-```
-
-
 ### Creating batch from hash
 
 If you like, you can construct your batch from a hash, like follows:
@@ -91,21 +61,39 @@ If you like, you can construct your batch from a hash, like follows:
 batch = Emarsys::Broadcast::Batch.new name: 'name', subject: 'subject', body_html: '<h1>html body</h1>'
 ```
 
-### Batch name requirements
+### Required batch attributes
+
+#### Batch#name
 
 Batch name must be a valid identifier, i.e. start with a letter and contain letters, digits and underscores.
 Emarsys requires every batch to have a unique name, but you don't have to maintain the uniqueness, because
 this library internally appends a timestamp to each batch name before submitting it to Emarsys.
 
-### Batch subject requirements
+#### Batch#subject
 
 Batch subject must be a string with a maximum length of 255 characters
 
-### Batch body html 
+#### Batch#sender
+
+Valid email, registed with Emarsys.
+
+Emarsys maintains a list of allowed sender emails, and restricts
+sending emails from arbitrary email. If you want to use an email as a 
+sender, refer to 
+
+#### Batch#body_html 
 
 Batch body html can be any HTML text, no restrictions
 
-### Batch body in plain text
+#### Batch#recipients_path
+
+Absolute path to CSV file with recipients data.
+
+_Can be set once via configuration_
+
+### Optional batch attributes
+
+#### Batch#body_text
 
 It is possible to supply the body contents in plain text, this will broaden compatibility, 
 because some email clients don't support HTML and will download textual version instead.
@@ -118,6 +106,52 @@ batch.body_html = '<h1>Dear 朋友!</h1>'
 batch.body_text = 'Dear 朋友'
 ```
 
+#### Batch#send_time
+
+You can set the batch send time using this optional attribute. If you don't set it
+it will be scheduled for immediate sending.
+
+
+#### Batch.import_delay_hours
+
+Time in hours which is allowed for import to be delayed after batch import. Defaults to 1 hour.
+
+
+### Moving batch properties to configuration
+
+If you find yourself using same batch attributes over and over again,
+you can move these attributes into configuration:
+
+```ruby
+Emarsys::Broadcast::configure do |c|
+  c.api_user = your_api_user
+  c.api_password = your_api_password
+
+  c.sftp_user = your_sftp_user
+  c.sftp_password = your_sftp_password
+
+  c.sender = 'sender_id'
+  c.sender_domain = 'mail.your.company.com'
+  c.recipients_path = '/path/to/hyour/csv/with/emails'
+end
+
+# now you can omit these attributes when constructing a batch:
+batch = Emarsys::Broadcast::Batch.new
+batch.name = 'newsletter_2013_06_01'
+batch.subject = 'June 2013 company news'
+batch.body_html = '<h1>Dear 朋友!</h1>'
+
+# send your batch as above, via api
+```
+
+#### List of configurable attributes
+* sender (required attribute)
+* sender_domain (required attribute)
+* recipients_path (required attribute)
+* import_delay_hours (optional attribute) see more [here](#)
+
+
+
 ### Batch validation
 
 Emarsys::Broadcast uses ActiveModel for validating plain ruby objects, so you have all the methods for 
@@ -149,6 +183,18 @@ rescue Emarsys::Broadcast::ValidationException => ex
 end
 ```
 
+### Scheduling batches
+
+By default a new batch is scheduled for immediate sending, but you can set the `send_time`
+
+```ruby
+# Assuming using ActiveSupport and want to schedule a batch to be sent in 10 days
+batch.send_time = Time.zone.now + 10.days
+# .. more attributes
+
+api.send_batch batch
+```
+
 ### CSV file requirements
 
 The recipients must be placed in a `UTF-8` CSV file.
@@ -177,12 +223,11 @@ Having additional columns allows you to customize your body_html, for example:
 <h1>Hi, $$FIRST_NAME$$</h1>
 ```
 
-### Batch sender_id requirements
+### Working with senders
 
-Emarsys requires that API users maintain a list of possible senders, and restricts
-sending emails from arbitrary sender.
+#### Adding a new sender
 
-To use any `sender_id` in your batch, create it first:
+Adding a sender is required before you can start using its email address as a Batch#sender attribute
 
 ```ruby 
 # assuming you have API configured already
@@ -195,12 +240,10 @@ api.create_sender sender
 Once you upload a sender, you can use its ID in any batch:
 
 ```ruby
-batch.sender_id = 'primary_newsletter_sender'
+batch.sender = 'news@company.com'
 # more attributes
 ```
 
-### Working with senders
-
 #### Getting a full list of senders
 
 ```ruby
@@ -214,23 +257,12 @@ api.get_senders
 api.get_sender('news@mycompany.ru')
 ```
 
-#### Find if a sender exists by email
+#### Finding if a sender exists by email
 
 ```ruby
 api.sender_exists? 'news@mycompany.ru'
 ```
 
-### Scheduling batches
-
-By default a new batch is scheduled for immediate sending, but you can set the `send_time`
-
-```ruby
-# Assuming using ActiveSupport and want to schedule a batch to be sent in 10 days
-batch.send_time = Time.zone.now + 10.days
-# .. more attributes
-
-api.send_batch batch
-```
 
 ### Compatibility
 

data/emarsys-broadcast.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "net-sftp"
-  spec.add_dependency "nokogiri"
+  spec.add_dependency "nokogiri", "1.5.6"
   spec.add_dependency "activemodel", "~> 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/emarsys/broadcast/api.rb

@@ -61,6 +61,7 @@ module Emarsys
         batch.send_time ||= Time.now
         batch.sender ||= @config.sender
         batch.sender_domain ||= @config.sender_domain
+        batch.import_delay_hours ||= @config.import_delay_hours
         batch
       end
 

data/lib/emarsys/broadcast/batch.rb

@@ -7,12 +7,13 @@ module Emarsys
         :name, 
         :subject,
         :body_html,
-        :body_text,
         :recipients_path,
+        :body_text,
         :send_time,
         :sender,
         :sender_domain,
-        :sender_id
+        :sender_id,
+        :import_delay_hours
 
         validates :name, :subject, :body_html, :recipients_path, :sender, :sender_domain, presence: true
         validates :name, format: {with: /^[^\d\W]\w*\z/i, message: 'must start with a letter and contain only letters, numbers and underscores'}

data/lib/emarsys/broadcast/batch_xml_builder.rb

@@ -14,6 +14,7 @@ module Emarsys
               xml.property(key: :Language){xml.text 'en'}
               xml.property(key: :Encoding){xml.text 'UTF-8'}
               xml.property(key: :Domain){xml.text batch.sender_domain}
+              xml.property(key: :ImportDelay){xml.text batch.import_delay_hours}
             }
             xml.subject batch.subject
             xml.html batch.body_html

data/lib/emarsys/broadcast/configuration.rb

@@ -17,7 +17,9 @@ module Emarsys
         :api_timeout,
         :sender,
         :sender_domain,
-        :recipients_path
+        :recipients_path,
+        # https://e3.emarsys.net/bmapi/v2/doc/Properties.html#ImportDelay
+        :import_delay_hours
 
 
       def initialize
@@ -27,6 +29,7 @@ module Emarsys
         @api_base_path = '/bmapi/v2'
         @api_port = 80
         @api_timeout = 600 #10 minutes
+        @import_delay_hours = 1
       end
     end
 

data/lib/emarsys/broadcast/version.rb

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

data/spec/configuration_spec.rb

@@ -189,7 +189,7 @@ describe Emarsys::Broadcast::Configuration do
       end
     end
 
-      describe 'when sender is set' do
+    describe 'when sender is set' do
       before do
         Emarsys::Broadcast::configure do |c|
           c.sender = 'sender'
@@ -210,6 +210,28 @@ describe Emarsys::Broadcast::Configuration do
         expect(Emarsys::Broadcast.configuration.sender).to be_nil
       end
     end
+
+    describe 'when import_delay_hours is set' do
+      before do
+        Emarsys::Broadcast::configure do |c|
+          c.import_delay_hours = 12
+        end
+      end
+
+      it 'returns import_delay_hours' do
+        expect(Emarsys::Broadcast.configuration.import_delay_hours).to eq 12
+      end
+    end
+
+    describe 'when import_delay_hours is not set' do
+      before do
+        Emarsys::Broadcast::configure {}
+      end
+
+      it 'defaults to 1 hour' do
+        expect(Emarsys::Broadcast.configuration.import_delay_hours).to eq 1
+      end 
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: emarsys-broadcast
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-sftp
@@ -32,17 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement