expresspigeon-ruby 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1091b71d05e2b52d8834c3e156b4a7abb1a7d581
-  data.tar.gz: 0c6c20dfb96132e211cc05090d51f83170da212c
+  metadata.gz: 294edf79278fdc87552d25a9ea25245f0c77d760
+  data.tar.gz: f7ed25d8e26eb73b7e66044352c724a51e488472
 SHA512:
-  metadata.gz: 63fbab303fa8bed86310e7c50208090e3466546d7f4fe782ac8dd66ac9acb89fad1d4b82dbad2e42846387316b66d6a59226752ce968d09166d5bb2c9e066d9f
-  data.tar.gz: b3da497b86385ec668d652dc543b48ddbc7937ddf8e93866f83ec1b02ee24cd34b1cf239487ac5f170641f47597c7fd27c2a5e5b844a760cf10cb29578587855
+  metadata.gz: 02494b9f8a07d6ea1f16fd437a5aa0982d0ceb2e2fc839254c795aa899d377b514511b96bd67ee7fe8171a05680e0ccc6dd4e6590b1b29813802c6deb22de7ca
+  data.tar.gz: de2c151ea4f6903598beebd48070c45d2f065922862e02fae85db9b630e21e9499c47220107a3ff3203fb55427baa4fb32ec91fab54d50ee6bc23f9d2657d94f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    expresspigeon-ruby (0.0.6)
+    expresspigeon-ruby (0.0.8)
       rest-client (~> 1.8)
 
 GEM

data/README.md

@@ -53,7 +53,7 @@ puts MESSAGES.report message_response.id
      'jane@doe.com',                             #reply_to
      "Jane Doe",                                 #from_name
      "Want to get out for a dinner?",            #subject
-     {first_name: 'Igor', eye_color: 'blue'},    #merge_fields
+     {first_name: 'John', main_course: 'stake'}, #merge_fields
      false,                                      #view_online
      true,                                       #click_tracking
      true,                                       #suppress_address

data/lib/expresspigeon-ruby.rb

@@ -58,11 +58,16 @@ module ExpressPigeon
         resp = Net::HTTP.start(uri.host, uri.port, :use_ssl => USE_SSL) do |http|
           http.request req
         end
-        parsed = JSON.parse(resp.body)
-        if parsed.kind_of? Hash
-          MetaResponse.new parsed
+
+        if resp.content_type == 'application/json'
+          parsed = JSON.parse(resp.body)
+          if parsed.kind_of? Hash
+            MetaResponse.new parsed
+          else
+            parsed
+          end
         else
-          parsed
+          resp.body
         end
       end
     end
@@ -103,7 +108,7 @@ module ExpressPigeon
       Messages.new
     end
 
-    def self.auto_responders
+    def self.autoresponders
       AutoResponders.new
     end
 

data/lib/expresspigeon-ruby/auto_responders.rb

@@ -12,10 +12,8 @@ module ExpressPigeon
     #
     # Returns an array of autoresponders.
     #
-    # Docs: https://expresspigeon.com/api#auto_responders_get_all
-    #
     def all
-      get endpoint
+      get @endpoint
     end
 
     # Start for a contact
@@ -25,10 +23,9 @@ module ExpressPigeon
     # :param auto_responder_id: autoresponder id to be started for a contact
     # :param email:             contact email
     #
-    # Docs: https://expresspigeon.com/api#auto_responders_start
     #
     def start(auto_responder_id, email)
-      post "#{endpoint}/#{auto_responder_id}/start", email: email
+      post "#{@endpoint}/#{auto_responder_id}/start", email: email
     end
 
     # Stop for a contact
@@ -41,7 +38,45 @@ module ExpressPigeon
     # Docs: https://expresspigeon.com/api#auto_responders_stop
     #
     def stop(auto_responder_id, email)
-      post "#{endpoint}/#{auto_responder_id}/stop", email: email
+      post "#{@endpoint}/#{auto_responder_id}/stop", email: email
+    end
+
+    # Reports for a single responder
+    #
+    # :param auto_responder_id: autoresponder id to be stopped for a contact
+    # :param email:             contact email
+    #
+    def report(auto_responder_id)
+      get "#{@endpoint}/#{auto_responder_id}"
+    end
+
+
+    # Reports bounces for autoresponder part
+    #
+    # :param auto_responder_id: autoresponder id to be stopped for a contact
+    # :param auto_responder_part_id: id of the autoresponder part in questions
+    #
+    def bounced(auto_responder_id, autoresponder_part_id)
+      get "#{@endpoint}/#{auto_responder_id}/#{autoresponder_part_id}/bounced"
+    end
+
+    # Reports unsubscribed for autoresponder part
+    #
+    # :param auto_responder_id: autoresponder id to be stopped for a contact
+    # :param auto_responder_part_id: id of the autoresponder part in questions
+    #
+    def unsubscribed(auto_responder_id, autoresponder_part_id)
+      get "#{@endpoint}/#{auto_responder_id}/#{autoresponder_part_id}/unsubscribed"
+    end
+
+
+    # Get spam reports for autoresponder part
+    #
+    # :param auto_responder_id: autoresponder id to be stopped for a contact
+    # :param auto_responder_part_id: id of the autoresponder part in questions
+    #
+    def spam(auto_responder_id, autoresponder_part_id)
+      get "#{@endpoint}/#{auto_responder_id}/#{autoresponder_part_id}/spam"
     end
   end
 end

data/lib/expresspigeon-ruby/campaigns.rb

@@ -14,6 +14,14 @@ module ExpressPigeon
       get "#{@endpoint}/#{campaign_id}"
     end
 
+    def opened(campaign_id)
+      get "#{@endpoint}/#{campaign_id}/opened"
+    end
+
+    def clicked(campaign_id)
+      get "#{@endpoint}/#{campaign_id}/clicked"
+    end
+
     def bounced(campaign_id)
       get "#{@endpoint}/#{campaign_id}/bounced"
     end

data/lib/expresspigeon-ruby/contacts.rb

@@ -11,6 +11,7 @@ module ExpressPigeon
     end
 
 
+
     # JSON document represents a contact to be created or updated.
     # The email field is required.
     # When updating a contact, list_id is optional,

data/lib/expresspigeon-ruby/lists.rb

@@ -33,6 +33,13 @@ module ExpressPigeon
     end
 
 
+    #
+    #:returns: status of upload
+    #
+    def upload_status(list_id)
+      get "#{@endpoint}/upload_status/#{list_id}"
+    end
+
     ##
     # Removes a list with a given id. A list must be enabled and has no dependent subscriptions and/or scheduled campaigns.
     #

data/lib/expresspigeon-ruby/messages.rb

@@ -19,18 +19,20 @@ module ExpressPigeon
     # * +click_tracking+ - enable/disable click tracking (and URL rewriting)
     # * +suppress_address+ - enable/disable display of physical address at the bottom of newsletter.
     # * +attachments+ - array of file paths  to attach to email. Size limit: 1k per attachment, maximum 3 attachments.
+    # * +headers+ - hash with headers to include into the message. The header 'Sender' will override a standard behavior of the platform.
     def send_message(template_id, to, reply_to, from_name, subject, merge_fields = nil, view_online = false,
-                     click_tracking = true, suppress_address = false, attachments = nil)
+                                            click_tracking = true, suppress_address = false, attachments = nil, headers = nil)
       if attachments
           upload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking,
-                                                                                    suppress_address, attachments)
+                                                                                    suppress_address, attachments, headers)
         else
           post @endpoint, params = {template_id: template_id, to: to, reply_to: reply_to, from: from_name,
                                     subject: subject, merge_fields: merge_fields, view_online: view_online,
-                                    click_tracking: click_tracking, suppress_address: suppress_address}
+                                    click_tracking: click_tracking, suppress_address: suppress_address, headers: headers}
       end
     end
 
+
     # Retrieve report for a single message.
     #
     # * +message_id+ - ID of a message sent previously
@@ -84,10 +86,10 @@ module ExpressPigeon
     # * +click_tracking+ - enable/disable click tracking (and URL rewriting)
     # * +suppress_address+ - enable/disable display of physical address at the bottom of newsletter.
     # * +attachments+ - array of file paths  to attach to email. Size limit: 1k per attachment, maximum 3 attachments.
-    def upload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking, suppress_address, attachments)
+    def upload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking, suppress_address, attachments, headers)
       path = "#{@root ? @root : ROOT}/#{@endpoint}"
       begin
-        payload = prepare_payload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking, suppress_address, attachments)
+        payload = prepare_payload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking, suppress_address, attachments, headers)
         request = RestClient::Request.new(
             :method => :post,
             :headers => {:'X-auth-key' => get_auth_key},
@@ -108,7 +110,7 @@ module ExpressPigeon
     end
 
 
-    def prepare_payload(template_id, to, reply_to, from, subject, merge_fields, view_online, click_tracking, suppress_address, attachments)
+    def prepare_payload(template_id, to, reply_to, from, subject, merge_fields, view_online, click_tracking, suppress_address, attachments, headers)
       payload = { multipart: true }
       payload[:template_id] = template_id
       payload[:to] = to
@@ -116,6 +118,7 @@ module ExpressPigeon
       payload[:subject] = subject
       payload[:from] = from
       payload[:merge_fields] = merge_fields.to_json
+      payload[:headers] = headers.to_json
       payload[:view_online] = view_online
       payload[:click_tracking] = click_tracking
       payload[:suppress_address] = suppress_address

data/lib/expresspigeon-ruby/version.rb

@@ -1,5 +1,5 @@
 module Expresspigeon
   module API
-    VERSION = "0.0.8"
+    VERSION = "0.0.9"
   end
 end

data/spec/autoresponders_spec.rb

@@ -0,0 +1,46 @@
+require './lib/expresspigeon-ruby'
+require 'pigeon_helper'
+
+describe 'autoresponders integration test' do
+
+  include PigeonSpecHelper
+
+  it 'should return all autoresponders' do
+    res = ExpressPigeon::API.autoresponders.all
+    res.class.should == Array
+    res.size.should > 0
+    puts res
+  end
+
+  it 'should start autoresponder by id' do
+    res = ExpressPigeon::API.autoresponders.start 672, 'igor@polevoy.org'
+    puts res
+  end
+
+  it 'should stop autoresponder by id' do
+    res = ExpressPigeon::API.autoresponders.stop 672, 'igor@polevoy.org'
+    puts res
+  end
+
+  it 'should get single report' do
+    res = ExpressPigeon::API.autoresponders.report 672
+    puts res
+  end
+
+  it 'should get bounces for autoresponder part' do
+    res = ExpressPigeon::API.autoresponders.bounced 672, 746
+    puts res
+  end
+
+  it 'should get spam for autoresponder part' do
+    res = ExpressPigeon::API.autoresponders.spam 672, 746
+    puts res
+  end
+
+  it 'should get unsubscribed for autoresponder part' do
+    res = ExpressPigeon::API.autoresponders.unsubscribed 672, 746
+    puts res
+  end
+
+end
+

data/spec/campaigns_spec.rb

@@ -6,55 +6,55 @@ describe 'campaigns integration test' do
   include PigeonSpecHelper
 
   it 'should return more than 0 campaign ids' do
-    res = PIGEON.campaigns.all
+    res = ExpressPigeon::API.campaigns.all
     res.class.should == Array
     res.size.should > 0
   end
 
   it 'cannot send with missing parameters' do
-    res = PIGEON.campaigns.send(:template_id => 15233, :name => 'API Test campaign',
-                                :from_name => 'Igor Polevoy', :reply_to => 'igor@polevoy.org',
-                                :subject => 'API test', :google_analytics => true)
+    res = ExpressPigeon::API.campaigns.send(:template_id => 15233, :name => 'API Test campaign',
+                                          :from_name => 'Igor Polevoy', :reply_to => 'igor@polevoy.org',
+                                          :subject => 'API test', :google_analytics => true)
     validate_response res, 400, 'error', /required parameters: list_id, template_id, name, from_name, reply_to, subject, google_analytics/
   end
 
   it 'cannot send with bad reply_to' do
-    res = PIGEON.campaigns.send(:list_id => -1, :template_id => -1, :name => 'My Campaign', :from_name => 'John', :reply_to => 'j',
-                                :subject => 'Hi', :google_analytics => false)
+    res = ExpressPigeon::API.campaigns.send(:list_id => -1, :template_id => -1, :name => 'My Campaign', :from_name => 'John', :reply_to => 'j',
+                                          :subject => 'Hi', :google_analytics => false)
     validate_response res, 400, 'error', /reply_to should be valid email address/
   end
 
   it 'cannot send with non-existing template' do
-    res = PIGEON.campaigns.send(:list_id => -1, :template_id => -1, :name => 'My Campaign', :from_name => 'John',
-                                :reply_to => 'j@j.j',
-                                :subject => 'Hi', :google_analytics => false)
+    res = ExpressPigeon::API.campaigns.send(:list_id => -1, :template_id => -1, :name => 'My Campaign', :from_name => 'John',
+                                          :reply_to => 'j@j.j',
+                                          :subject => 'Hi', :google_analytics => false)
     validate_response res, 400, 'error', /template=-1 is not found/
   end
 
   it 'cannot send to non-existing list' do
-    res = PIGEON.campaigns.send(:list_id => -1, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
-                                :reply_to => 'j@j.j',
-                                :subject => 'Hi', :google_analytics => false)
+    res = ExpressPigeon::API.campaigns.send(:list_id => -1, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
+                                          :reply_to => 'j@j.j',
+                                          :subject => 'Hi', :google_analytics => false)
     validate_response res, 400, 'error', /list=-1 is not found/
   end
 
   it 'cannot send to disabled list' do
-    res = PIGEON.campaigns.send(:list_id => LIST_ID, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
-                                :reply_to => 'j@j.j',
-                                :subject => 'Hi', :google_analytics => false)
+    res = ExpressPigeon::API.campaigns.send(:list_id => LIST_ID, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
+                                          :reply_to => 'j@j.j',
+                                          :subject => 'Hi', :google_analytics => false)
     validate_response res, 400, 'error', /list=#{DISABLED_LIST} is disabled/
   end
 
   it 'should create new list, add contact and send successful campaign' do
 
-    list_resp = PIGEON.lists.create('My list', 'John', API_USER)
+    list_resp = ExpressPigeon::API.lists.create('My list', 'John', API_USER)
     list_id = list_resp.list.id
-    PIGEON.contacts.upsert(list_id, {:email => API_USER})
-    resp = PIGEON.campaigns.send(:list_id => list_id, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
-                                 :reply_to => API_USER,
-                                 :subject => 'Hi', :google_analytics => false)
+    ExpressPigeon::API.contacts.upsert(list_id, {:email => API_USER})
+    resp = ExpressPigeon::API.campaigns.send(:list_id => list_id, :template_id => TEMPLATE_ID, :name => 'My Campaign', :from_name => 'John',
+                                           :reply_to => API_USER,
+                                           :subject => 'Hi', :google_analytics => false)
     validate_response resp, 200, 'success', /new campaign created successfully/
-    report = PIGEON.campaigns.report(resp.campaign_id)
+    report = ExpressPigeon::API.campaigns.report(resp.campaign_id)
     (report.delivered == 0 or report.delivered == 1).should be_true
     report.clicked.should eq 0
     report.opened.should eq 0
@@ -62,45 +62,45 @@ describe 'campaigns integration test' do
     (report.in_transit == 0 or report.in_transit == 1).should be_true
     report.unsubscribed.should eq 0
     report.bounced.should eq 0
-    bounced = PIGEON.campaigns.bounced(resp.campaign_id)
-    unsubscribed = PIGEON.campaigns.unsubscribed(resp.campaign_id)
-    spam = PIGEON.campaigns.spam(resp.campaign_id)
+    bounced = ExpressPigeon::API.campaigns.bounced(resp.campaign_id)
+    unsubscribed = ExpressPigeon::API.campaigns.unsubscribed(resp.campaign_id)
+    spam = ExpressPigeon::API.campaigns.spam(resp.campaign_id)
 
     bounced.size.should eq 0
     unsubscribed.size.should eq 0
     spam.size.should eq 0
 
-    resp = PIGEON.contacts.delete(API_USER)
+    resp = ExpressPigeon::API.contacts.delete(API_USER)
     validate_response resp, 200, 'success', /contact=non@non.non deleted successfully/
 
-    resp = PIGEON.contacts.find_by_email(API_USER)
+    resp = ExpressPigeon::API.contacts.find_by_email(API_USER)
     validate_response resp, 404, 'error', /contact=non@non.non not found/
 
-    resp = PIGEON.lists.delete(list_id)
+    resp = ExpressPigeon::API.lists.delete(list_id)
     validate_response resp, 200, 'success', /deleted successfully/
   end
 
 
   it 'cannot send campaign if scheduling with bad date' do
 
-    list_resp = PIGEON.lists.create "My list", "John", API_USER
-    resp = PIGEON.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
+    list_resp = ExpressPigeon::API.lists.create "My list", "John", API_USER
+    resp = ExpressPigeon::API.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
 
-                                     :from_name => 'John',
-                                     :reply_to => API_USER, :subject => 'Hi',
-                                     :google_analytics => false, :schedule_for => "2013-05-28"
+                                               :from_name => 'John',
+                                               :reply_to => API_USER, :subject => 'Hi',
+                                               :google_analytics => false, :schedule_for => "2013-05-28"
 
     validate_response resp, 400, 'error', /schedule_for is not in ISO date format, example: 2013-05-28T17:19:50.779/
-    resp = PIGEON.lists.delete(list_resp.list.id)
+    resp = ExpressPigeon::API.lists.delete(list_resp.list.id)
     validate_response resp, 200, 'success', /deleted successfully/
   end
 
   it 'should not schedule campaign with date in the past' do
-    list_resp = PIGEON.lists.create('My list', 'John', API_USER)
-    resp = PIGEON.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
-                                     :from_name => 'John',
-                                     :reply_to => API_USER, :subject => 'Hi',
-                                     :google_analytics => false, :schedule_for => '2010-05-28T17:19:50.779+0300'
+    list_resp = ExpressPigeon::API.lists.create('My list', 'John', API_USER)
+    resp = ExpressPigeon::API.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
+                                               :from_name => 'John',
+                                               :reply_to => API_USER, :subject => 'Hi',
+                                               :google_analytics => false, :schedule_for => '2010-05-28T17:19:50.779+0300'
 
     validate_response resp, 400, 'error', /schedule_for should be in the future/
   end
@@ -108,26 +108,48 @@ describe 'campaigns integration test' do
 
 
   it 'should delete scheduled campaign' do
-    list_resp = PIGEON.lists.create('My list', 'John', API_USER)
-    resp = PIGEON.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
-                                     :from_name => 'John',
-                                     :reply_to => API_USER, :subject => 'Hi',
-                                     :google_analytics => false, :schedule_for => '2030-05-28T17:19:50.779+0300'
+    list_resp = ExpressPigeon::API.lists.create('My list', 'John', API_USER)
+    resp = ExpressPigeon::API.campaigns.schedule :list_id => list_resp.list.id, :template_id => TEMPLATE_ID, :name => 'My Campaign',
+                                               :from_name => 'John',
+                                               :reply_to => API_USER, :subject => 'Hi',
+                                               :google_analytics => false, :schedule_for => '2030-05-28T17:19:50.779+0300'
 
     validate_response resp, 200, 'success', /new campaign created successfully/
     campaign_id = resp.campaign_id
-    resp = PIGEON.campaigns.delete campaign_id
+    resp = ExpressPigeon::API.campaigns.delete campaign_id
     resp.message.should eq "campaign #{campaign_id} was deleted"
   end
 
 
   # This test uses account ep.api.tester@expresspigeon.com and expects two specific campaign there.
   it 'should list campaigns from account' do
-    campaigns = PIGEON.campaigns.all
+    campaigns = ExpressPigeon::API.campaigns.all
     campaigns.size.should eq 4
-    campaigns = PIGEON.campaigns.all from_id: 53853
+    campaigns = ExpressPigeon::API.campaigns.all from_id: 53853
     campaigns.size.should eq 3
   end
 
+
+  it 'should get opened from campaign' do
+    opened = ExpressPigeon::API.campaigns.opened 441663
+
+    puts opened
+
+  end
+
+  it 'should get clicked from campaign' do
+    clicked = ExpressPigeon::API.campaigns.clicked 441663
+
+    puts clicked
+
+  end
+
+  it 'should get unsubs from campaign' do
+    unsubscribed = ExpressPigeon::API.campaigns.unsubscribed 441663
+
+    puts unsubscribed
+
+  end
+
 end
 

data/spec/contacts_spec.rb

@@ -6,24 +6,24 @@ describe 'contacts integration test' do
   include PigeonSpecHelper
 
   it 'should not create contact without contact data' do
-    resp = PIGEON.contacts.upsert(-1, {})
+    resp = ExpressPigeon::API.contacts.upsert(-1, {})
     validate_response resp, 400, 'error', /email is required/
   end
 
   it 'should not create contact without email' do
-    resp = PIGEON.contacts.upsert -1, :email => '', :first_name => 'Marylin', :last_name => 'Monroe'
+    resp = ExpressPigeon::API.contacts.upsert -1, :email => '', :first_name => 'Marylin', :last_name => 'Monroe'
     validate_response resp, 400, 'error', /email is required/
   end
 
   it 'should not add contact with too many custom fields' do
     custom_fields = {}
     (1..25).each { |n| custom_fields["custom_field_#{n}"] = n }
-    resp = PIGEON.contacts.upsert -1,  :email => "mary@e.e", :custom_fields => custom_fields
+    resp = ExpressPigeon::API.contacts.upsert -1, :email => "mary@e.e", :custom_fields => custom_fields
     validate_response resp, 400, 'error', /You cannot create more than 20 custom fields. Use one of the 'custom_fields'./
   end
 
   it 'should not create new contact without list_id' do
-    resp = PIGEON.contacts.upsert '', :email => 'ee@e.e', :first_name => 'Marylin', :last_name => 'Monroe'
+    resp = ExpressPigeon::API.contacts.upsert '', :email => 'ee@e.e', :first_name => 'Marylin', :last_name => 'Monroe'
     # TODO: this is a pretty crappy message from API https://redmine.expresspigeon.com/issues/5479
     validate_response resp, 400, 'error', /failed to convert: '' to Long/
   end
@@ -34,21 +34,21 @@ describe 'contacts integration test' do
   # end
 
   it 'cannot upsert into non-existent_list' do
-    resp = PIGEON.contacts.upsert -123, :email => "e@e.e"
+    resp = ExpressPigeon::API.contacts.upsert -123, :email => "e@e.e"
     # TODO: uncomment after: https://redmine.expresspigeon.com/issues/5478
     validate_response resp, 404, 'error', /contact=e@e.e not found/
   end
 
   it 'creates list with contacts' do
-    list_response = PIGEON.lists.create 'My List', 'John Doe', 'john@doe.com'
+    list_response = ExpressPigeon::API.lists.create 'My List', 'John Doe', 'john@doe.com'
     list_id = list_response.list.id
-    resp = PIGEON.contacts.upsert list_id, email: "mary@e.e",
-                                  :custom_fields => {:custom_field_1 => "custom_value_1", }
+    resp = ExpressPigeon::API.contacts.upsert list_id, email: "mary@e.e",
+                                            :custom_fields => {:custom_field_1 => "custom_value_1", }
     validate_response resp, 200, 'success', /contacts created\/updated successfully/
 
-    resp = PIGEON.contacts.find_by_email "mary@e.e"
+    resp = ExpressPigeon::API.contacts.find_by_email "mary@e.e"
 
-    PIGEON.lists.delete(list_id)
+    ExpressPigeon::API.lists.delete(list_id)
 
     resp.custom_fields.custom_field_1 eq "custom_value_1"
     resp.email.should eq 'mary@e.e'
@@ -56,16 +56,16 @@ describe 'contacts integration test' do
   end
 
   it 'creates list non-existent custom field' do
-    list_response = PIGEON.lists.create 'My List', 'John Doe', 'a@a.a'
+    list_response = ExpressPigeon::API.lists.create 'My List', 'John Doe', 'a@a.a'
     list_id = list_response.list.id
-    resp = PIGEON.contacts.upsert(list_id, {:email => "mary@e.e", :custom_fields => {:c => "c", }})
-    PIGEON.lists.delete(list_id)
+    resp = ExpressPigeon::API.contacts.upsert(list_id, {:email => "mary@e.e", :custom_fields => {:c => "c", }})
+    ExpressPigeon::API.lists.delete(list_id)
     validate_response resp, 200, 'success', nil
   end
 
   it 'cannot export contacts from list without list_id' do
     content = ''
-    PIGEON.lists.csv "-1" do |c|
+    ExpressPigeon::API.lists.csv "-1" do |c|
       content << c
     end
     resp = JSON.parse(content)
@@ -76,7 +76,7 @@ describe 'contacts integration test' do
 
   it 'should get contacts from suppressed list' do
     content =''
-    PIGEON.lists.csv "suppress_list" do |c|
+    ExpressPigeon::API.lists.csv "suppress_list" do |c|
       content += c
     end
     resp = content.split /\n/
@@ -87,13 +87,13 @@ describe 'contacts integration test' do
   end
 
   it 'should get single contact' do
-    resp = PIGEON.contacts.find_by_email 'suppressed@e.e'
+    resp = ExpressPigeon::API.contacts.find_by_email 'suppressed@e.e'
     # TODO: have these on account before checking.
     # resp.email.should eq 'suppressed@e.e'
   end
 
   it 'should not find non existent contact' do
-    resp = PIGEON.contacts.find_by_email 'a@a.a'
+    resp = ExpressPigeon::API.contacts.find_by_email 'a@a.a'
     # TODO: have these on account before checking.
 
     # validate_response resp, 404, 'error', /contact=a@a.a not found/
@@ -103,56 +103,56 @@ describe 'contacts integration test' do
 
 
 
-    list_response = PIGEON.lists.create('My List', 'John Doe', "a@a.a")
+    list_response = ExpressPigeon::API.lists.create('My List', 'John Doe', "a@a.a")
 
     # PIGEON.contacts.find_by_email("mary@e.e").last_name.should eq 'Doe'
 
-    resp = PIGEON.contacts.upsert list_response.list.id,
-                                  :email => 'mary@e.e', :first_name => 'Mary', :last_name => 'Johns'
+    resp = ExpressPigeon::API.contacts.upsert list_response.list.id,
+                                            :email => 'mary@e.e', :first_name => 'Mary', :last_name => 'Johns'
     validate_response resp, 200, 'success', /contacts created\/updated successfully/
-    PIGEON.contacts.find_by_email("mary@e.e").last_name.should eq 'Johns'
-    PIGEON.lists.delete list_response.list.id
+    ExpressPigeon::API.contacts.find_by_email("mary@e.e").last_name.should eq 'Johns'
+    ExpressPigeon::API.lists.delete list_response.list.id
   end
 
   it 'cannot delete contact with non-existent email' do
-    res = PIGEON.contacts.delete("g@g.g")
+    res = ExpressPigeon::API.contacts.delete("g@g.g")
     validate_response res, 404, 'error', /contact=g@g.g not found/
   end
 
   it 'should not delete suppressed contact' do
-    res = PIGEON.contacts.delete("suppressed@e.e")
+    res = ExpressPigeon::API.contacts.delete("suppressed@e.e")
 
     # TODO: add this to the account at setup.
     # validate_response res, 400, 'error', /contact=suppressed@e.e is in suppress list/
   end
 
   it 'should delete single contact from all lists' do
-    list_response = PIGEON.lists.create 'My List', 'Jane Doe', 'a@a.a'
-    PIGEON.contacts.upsert list_response.list.id, :email => 'mary@e.e'
-    res = PIGEON.contacts.delete 'mary@e.e'
+    list_response = ExpressPigeon::API.lists.create 'My List', 'Jane Doe', 'a@a.a'
+    ExpressPigeon::API.contacts.upsert list_response.list.id, :email => 'mary@e.e'
+    res = ExpressPigeon::API.contacts.delete 'mary@e.e'
     validate_response res, 200, 'success', /contact=mary@e.e deleted successfully/
-    PIGEON.lists.delete list_response.list.id
+    ExpressPigeon::API.lists.delete list_response.list.id
   end
 
   it 'deletes single contact from single list' do
-    list_response = PIGEON.lists.create 'My List', 'John D.', 'a@a.a'
-    list_response_2 = PIGEON.lists.create('My List2', "Jane D.", 'a@a.a')
-    PIGEON.contacts.upsert(list_response.list.id, {:email => 'mary@e.e'})
-    PIGEON.contacts.upsert(list_response_2.list.id, {:email => 'mary@e.e'})
+    list_response = ExpressPigeon::API.lists.create 'My List', 'John D.', 'a@a.a'
+    list_response_2 = ExpressPigeon::API.lists.create('My List2', "Jane D.", 'a@a.a')
+    ExpressPigeon::API.contacts.upsert(list_response.list.id, {:email => 'mary@e.e'})
+    ExpressPigeon::API.contacts.upsert(list_response_2.list.id, {:email => 'mary@e.e'})
 
-    res = PIGEON.contacts.delete 'mary@e.e', list_response.list.id
+    res = ExpressPigeon::API.contacts.delete 'mary@e.e', list_response.list.id
 
     validate_response res, 200, 'success', /contact=mary@e.e deleted successfully/
 
     contacts_exported = ''
-    PIGEON.lists.csv list_response.list.id do |c|
+    ExpressPigeon::API.lists.csv list_response.list.id do |c|
       contacts_exported << c
     end
     contacts_exported = contacts_exported.split /\n/
     contacts_exported.size.should eq 1
 
     contacts_exported_2 = ''
-    PIGEON.lists.csv list_response_2.list.id do |c|
+    ExpressPigeon::API.lists.csv list_response_2.list.id do |c|
       contacts_exported_2 << c
     end
 
@@ -160,9 +160,9 @@ describe 'contacts integration test' do
     contacts_exported_2.size.should eq 2
     contacts_exported_2[1].should =~ /"mary@e.e"/
 
-    PIGEON.lists.delete(list_response.list.id)
-    PIGEON.lists.delete(list_response_2.list.id)
-    PIGEON.contacts.delete('mary@e.e')
+    ExpressPigeon::API.lists.delete(list_response.list.id)
+    ExpressPigeon::API.lists.delete(list_response_2.list.id)
+    ExpressPigeon::API.contacts.delete('mary@e.e')
   end
 end
 

data/spec/lists_spec.rb

@@ -6,39 +6,39 @@ describe 'lists integration test' do
   include PigeonSpecHelper
 
   it 'test_create_and_delete_new_list(self):' do
-    contact_list = PIGEON.lists.create 'Active customers', 'Bob', 'bob@acmetools.com'
+    contact_list = ExpressPigeon::API.lists.create 'Active customers', 'Bob', 'bob@acmetools.com'
     validate_response contact_list, 200, 'success', /list=#{contact_list.list.id} created\/updated successfully/
     contact_list.list.name.should eq "Active customers"
     contact_list.list.from_name.should eq "Bob"
     contact_list.list.reply_to.should eq "bob@acmetools.com"
     contact_list.list.contact_count.should eq 0
-    res = PIGEON.lists.delete contact_list.list.id
+    res = ExpressPigeon::API.lists.delete contact_list.list.id
     validate_response res, 200, 'success', /list=#{contact_list.list.id} deleted successfully/
   end
 
   it 'should update existing list' do
-    contact_list = PIGEON.lists.create("Update", "Bob", "bob@acmetools.com")
-    res = PIGEON.lists.update contact_list.list.id, :name => 'Updated Name', :from_name => 'Bob', :reply_to => 'Frank@zappa.com'
+    contact_list = ExpressPigeon::API.lists.create("Update", "Bob", "bob@acmetools.com")
+    res = ExpressPigeon::API.lists.update contact_list.list.id, :name => 'Updated Name', :from_name => 'Bob', :reply_to => 'Frank@zappa.com'
     validate_response res, 200, 'success', /list=#{res.list.id} created\/updated successfully/
     res.list.name.should eq "Updated Name"
     res.list.from_name.should eq 'Bob'
-    res = PIGEON.lists.delete(contact_list.list.id)
+    res = ExpressPigeon::API.lists.delete(contact_list.list.id)
     validate_response res, 200, 'success', /list=#{contact_list.list.id} deleted successfully/
   end
 
 
   it 'should upload contacts as CSV file' do
     list_name = "Upload_#{Kernel.rand(9999).to_s}"
-    list_resp = PIGEON.lists.create(list_name, 'Bob', 'bob@acmetools.com')
+    list_resp = ExpressPigeon::API.lists.create(list_name, 'Bob', 'bob@acmetools.com')
     begin
-      resp = PIGEON.lists.upload(list_resp.list.id, 'spec/resources/upload.csv')
+      resp = ExpressPigeon::API.lists.upload(list_resp.list.id, 'spec/resources/upload.csv')
       validate_response resp, 200, 'success', /file uploaded successfully/
-      res = PIGEON.contacts.find_by_email 'x@x.x'
+      res = ExpressPigeon::API.contacts.find_by_email 'x@x.x'
       res.lists[0]['id'].should eq list_resp.list.id
     ensure
-      res = PIGEON.lists.delete(list_resp.list.id)
+      res = ExpressPigeon::API.lists.delete(list_resp.list.id)
       validate_response res, 200, 'success', /list=#{list_resp.list.id} deleted successfully/
-      PIGEON.contacts.find_by_email('x@x.x').message.should eq 'contact=x@x.x not found'
+      ExpressPigeon::API.contacts.find_by_email('x@x.x').message.should eq 'contact=x@x.x not found'
     end
   end
 
@@ -72,11 +72,19 @@ describe 'lists integration test' do
 #        self.assertEqual(res.code, 404)
 #        self.assertEqual(res.message, "list=-1 not found")
 #
-#    def test_upload_status_without_upload_id(self):
-#        res = self.api.lists.upload_status("")
-#        self.assertEqual(res.code, 400)
-#        self.assertEqual(res.status, "error")
-#        self.assertEqual(res.message, "you must provide upload id")
+  it 'should check upload status' do
+    list_response = ExpressPigeon::API.lists.create("My List", "a@a.a", "a@a.a")
+    resp = ExpressPigeon::API.lists.upload(list_response.list.id, 'spec/resources/upload.csv')
+
+    sleep 20
+
+    begin
+      puts ExpressPigeon::API.lists.upload_status list_response.list.id
+    ensure
+      ExpressPigeon::API.lists.delete list_response.list.id
+    end
+
+  end
 #
 #    def test_enabled_list_removal(self):
 #        list_resp = self.api.lists.create("My list", "John", os.environ['EXPRESSPIGEON_API_USER'])
@@ -102,22 +110,32 @@ describe 'lists integration test' do
 #                         "could not delete list={0}, it has dependent subscriptions and/or scheduled campaigns".format(
 #                             list_resp.list.id))
 #
-#    def test_export_csv(self):
-#        list_response = self.api.lists.create("My List", "a@a.a", "a@a.a")
-#        self.api.contacts.upsert(list_response.list.id, {"email": "mary@a.a"})
-#
-#        res = self.api.lists.csv(list_response.list.id).split("\n")
-#        self.assertEquals(len(res), 2)
-#        headers = '"Email", "First name", "Last name", "City", "Phone", "Company", "Title", "Address 1", "Address 2", ' \
-#                  '"State", "Zip", "Country", "Date of birth", "custom_field_1", "custom_field_10", "custom_field_11", ' \
-#                  '"custom_field_12", "custom_field_13", "custom_field_18", "custom_field_19", "custom_field_2", ' \
-#                  '"custom_field_20", "custom_field_21", "custom_field_22", "custom_field_23", "custom_field_24", ' \
-#                  '"custom_field_3", "custom_field_4", "custom_field_5", "custom_field_6", "custom_field_7", ' \
-#                  '"custom_field_8", "custom_field_9"'
-#        self.assertEquals(res[0], headers)
-#        self.assertEquals(res[1], '"mary@a.a",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,')
-#
-#        self.api.lists.delete(list_response.list.id)
-#        self.api.contacts.delete("mary@a.a")
+   it 'should upload and download CSV' do
+     list_response = ExpressPigeon::API.lists.create("My List", "a@a.a", "a@a.a")
+     resp = ExpressPigeon::API.lists.upload(list_response.list.id, 'spec/resources/upload.csv')
+     res = ExpressPigeon::API.lists.csv(list_response.list.id)
+     ExpressPigeon::API.lists.delete list_response.list.id
+
+     count = 0
+     res.each_line do |line|
+      count = count + 1
+     end
+     count.should eq 4
+
+
+
+     # self.assertEquals(len(res), 2)
+       # headers = '"Email", "First name", "Last name", "City", "Phone", "Company", "Title", "Address 1", "Address 2", ' \
+       #           '"State", "Zip", "Country", "Date of birth", "custom_field_1", "custom_field_10", "custom_field_11", ' \
+       #           '"custom_field_12", "custom_field_13", "custom_field_18", "custom_field_19", "custom_field_2", ' \
+       #           '"custom_field_20", "custom_field_21", "custom_field_22", "custom_field_23", "custom_field_24", ' \
+       #           '"custom_field_3", "custom_field_4", "custom_field_5", "custom_field_6", "custom_field_7", ' \
+       #           '"custom_field_8", "custom_field_9"'
+       # self.assertEquals(res[0], headers)
+       # self.assertEquals(res[1], '"mary@a.a",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,')
+       #
+       # self.api.lists.delete(list_response.list.id)
+       # self.api.contacts.delete("mary@a.a")
+     end
 
 end

data/spec/messages_spec.rb

@@ -32,10 +32,10 @@ describe 'transactional messages integration test' do
 
   #TODO: complete the spec
   it 'sends a single transactional message' do
-    message_response = PIGEON.messages.send_message 115, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'], "Team ExpressPigeon", "Hi there!",
-                                                    :first_name => "Igor"
+    message_response = ExpressPigeon::API.messages.send_message 115, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'], "Team ExpressPigeon", "Hi there!",
+                                                              :first_name => "Igor"
     validate_response message_response, 200, 'success', /email queued/
-    report = PIGEON.messages.report(message_response.id)
+    report = ExpressPigeon::API.messages.report(message_response.id)
     report.id.should eq message_response.id
   end
 
@@ -90,23 +90,23 @@ describe 'transactional messages integration test' do
   #    self.assertEquals(report2.email, os.environ['EXPRESSPIGEON_API_USER'])
   #    self.assertTrue(report2.in_transit is not None)
   #
-  it 'test_sending_multiple_messages_and_get_reports_for_today(self):' do
+  it 'should send multiple messages and get reports for today' do
 
     start = Time.now.utc - 60 # one minute ago
 
-    message_response = PIGEON.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'],
-                                                    'Team EP', "Hi, there!", :first_name => "Bob"
+    message_response = ExpressPigeon::API.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'],
+                                                              'Team EP', "Hi, there!", :first_name => "Bob"
 
     validate_response message_response, 200, 'success', /email queued/
     message_response.id should_not be_nil
 
-    message_response2 = PIGEON.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'],
-                                                     'Team EP', "Hi, there!", :first_name => "Bob"
+    message_response2 = ExpressPigeon::API.messages.send_message 4905, ENV['TARGET_EMAIL'], ENV['TARGET_EMAIL'],
+                                                               'Team EP', "Hi, there!", :first_name => "Bob"
     validate_response message_response2, 200, 'success', /email queued/
     message_response2.id should_not be_nil
 
     finish = start + 120 # two minutes after start
-    reports = PIGEON.messages.reports (message_response.id - 1), start, finish
+    reports = ExpressPigeon::API.messages.reports (message_response.id - 1), start, finish
 
     reports.size.should eq 2
     reports[0]['id'].should eq message_response.id
@@ -115,6 +115,8 @@ describe 'transactional messages integration test' do
     reports[0]['email'].should eq ENV['TARGET_EMAIL']
     reports[1]['email'].should eq ENV['TARGET_EMAIL']
   end
+
+
   #
   #def __get_report_by_id__(self, message_id, start_date=None, end_date=None):
   #    reports = self.api.messages.reports() if start_date is None and end_date is None else \
@@ -124,16 +126,16 @@ describe 'transactional messages integration test' do
   #    return report[0]
 
 
-  it 'should from payload hash' do
+  it 'should prepare payload hash' do
 
-     payload = PIGEON.messages.prepare_payload(123,           #template_id
-                                               'john@doe.com',
-                                               'jane@doe.com',
-                                               'Jane Doe',
-                                               'Hello, Dolly!',
-                                               {eye_color: 'blue', body_shape:'pear'},
-                                               false, true, false,
-                                               %w(spec/resources/attachment1.txt spec/resources/attachment2.txt))
+     payload = ExpressPigeon::API.messages.prepare_payload(123, #template_id
+                                                         'john@doe.com',
+                                                         'jane@doe.com',
+                                                         'Jane Doe',
+                                                         'Hello, Dolly!',
+                                                         {eye_color: 'blue', body_shape:'pear'},
+                                                         false, true, false,
+                                                         %w(spec/resources/attachment1.txt spec/resources/attachment2.txt), {})
 
      payload[:multipart].should eq true
      payload[:template_id].should eq 123

data/spec/pigeon_helper.rb

@@ -1,5 +1,3 @@
-PIGEON = ExpressPigeon::API
-
 
 TEMPLATE_ID = ENV['TEMPLATE_ID']
 LIST_ID = ENV['LIST_ID']

data/spec/templates_spec.rb

@@ -6,10 +6,10 @@ describe 'templates integration test' do
   include PigeonSpecHelper
 
   it 'should copy template and delete template' do
-    template_response = PIGEON.templates.copy 34830, "new template", :content => "Hello Template World!"
+    template_response = ExpressPigeon::API.templates.copy 34830, "new template", :content => "Hello Template World!"
     template_response.message.should eq 'template copied successfully'
     template_id = template_response.template_id
-    delete_response = PIGEON.templates.delete template_id
+    delete_response = ExpressPigeon::API.templates.delete template_id
     delete_response.message.should eq 'template deleted successfully'
   end
 end

data/test/send.rb

@@ -0,0 +1,19 @@
+
+require_relative '../lib/expresspigeon-ruby.rb'
+
+MESSAGES = ExpressPigeon::API.messages.auth_key(ENV['AUTH_KEY'])
+
+
+puts MESSAGES.send_message(
+    390243,                                     # template_id
+    'igor@polevoy.org',                         #to
+    'igor@polevoy.org',                         #reply_to
+    "Igor Polevoy",                             #from_name
+    "Hi there! Sending with a heades",          #subject
+    {first_name: 'Igor', eye_color: 'brown'},    #merge_fields
+    false,                                      #view_online
+    true,                                       #click_tracking
+    true,                                       #suppress_address
+    {},                                         #file paths to upload as attachments
+    {Sender: 'Vasya Pupkin <vasya@polevoy.org>'}
+)

data/test/send_with_attachments.rb

@@ -3,17 +3,20 @@ require_relative '../lib/expresspigeon-ruby.rb'
 
 MESSAGES = ExpressPigeon::API.messages.auth_key(ENV['AUTH_KEY'])
 
-attachments = %W{attachments/attachment1.txt  attachments/smile.pdf attachments/example.ics}
+#attachments = %W{attachments/attachment1.txt  attachments/smile.pdf attachments/example.ics}
+#attachments = %W{/home/igor/tmp/The-Definitive-Guide-To-Mobile-Marketing-Marketo.pdf}
+attachments = %W{/home/igor/tmp/Express-Pigeon-PropertyRadar-MSA-12-13-15.pdf}
 
 puts MESSAGES.send_message(
-    1527,                                     # template_id
-    'igor@expresspigeon.com',                         #to
+    390243,                                     # template_id
+    'igor@polevoy.org',                         #to
     'igor@polevoy.org',                         #reply_to
     "Igor Polevoy",                             #from_name
-    "Hi there! Two attachments and a calendar - Ruby",                                #subject
+    "Hi there! Attachments and header",         #subject
     {first_name: 'Igor', eye_color: 'blue'},    #merge_fields
     false,                                      #view_online
     true,                                       #click_tracking
     true,                                       #suppress_address
-    attachments                                 #file paths to upload as attachments
+    attachments,                                 #file paths to upload as attachments
+    {Sender: 'Vasya Pupkin <vasya@polevoy.org>'}
 )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expresspigeon-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - ipolevoy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -63,6 +63,7 @@ files:
 - lib/expresspigeon-ruby/meta_response.rb
 - lib/expresspigeon-ruby/templates.rb
 - lib/expresspigeon-ruby/version.rb
+- spec/autoresponders_spec.rb
 - spec/campaigns_spec.rb
 - spec/contacts_spec.rb
 - spec/lists_spec.rb
@@ -73,6 +74,7 @@ files:
 - test/README
 - test/attachments/example.ics
 - test/attachments/smile.pdf
+- test/send.rb
 - test/send_with_attachments.rb
 homepage: https://github.com/expresspigeon/expresspigeon-ruby
 licenses:
@@ -99,6 +101,7 @@ signing_key:
 specification_version: 4
 summary: ExpressPigeon API Ruby Wrapper
 test_files:
+- spec/autoresponders_spec.rb
 - spec/campaigns_spec.rb
 - spec/contacts_spec.rb
 - spec/lists_spec.rb
@@ -109,4 +112,5 @@ test_files:
 - test/README
 - test/attachments/example.ics
 - test/attachments/smile.pdf
+- test/send.rb
 - test/send_with_attachments.rb