expresspigeon-ruby 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3531f1f4bb4e7b172a5529c14fb7ff4135fae0f
-  data.tar.gz: 7656345b121e756d514a4827815d917d4f9015a3
+  metadata.gz: 740eda4d7d4f1e572ce3d256f24f5b076b891d00
+  data.tar.gz: 5a7c7f792fedced6f59fda76d4f8a40cfd162a7f
 SHA512:
-  metadata.gz: e523bae70bab3fb65377dd6336bba0542ad8ac0780b62e240187bd1153f277aefca9b55c6992fcb45f54515642311f775b14e1d4ca310bbb8a76da85599dfddd
-  data.tar.gz: a7b7c9626ea4a95469d8b3b9ab6a07c647c1a5fa50c5cbab530fab6a4f4e249a6544283467a0b1b03c516cba41b56a49768bb3b4c8cbd814558693567fa689c8
+  metadata.gz: af4c0be7a36f27623981947e6b2e7c9cb9fcc72024d84fa3dab1a81b2c29c8d2596aca5bf4a9b5a652e0ee5936b323ad37d22152616ec015a346ff417dcdd5b0
+  data.tar.gz: f52d89c356545ef134463f3ddd89b3fb6536f065ee28c251c110d9d1f7b3d13b49f047f1f2981378f7a0223c5369dd350e8adcf69fb0bbbe4bdfcbb7a219413d

data/.gitignore

@@ -3,7 +3,12 @@
 .idea/
 
 
-rspec.sh
+scripts/*
+
 set_env
 
 *.txt
+
+test/*
+
+expresspigeon-ruby-*.gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    expresspigeon-ruby (0.0.5)
-      rest-client (~> 1.8.0)
+    expresspigeon-ruby (0.1.1)
+      rest-client (~> 2.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -14,10 +14,10 @@ GEM
       domain_name (~> 0.5)
     mime-types (2.99.3)
     netrc (0.11.0)
-    rest-client (1.8.0)
+    rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)

data/README.md

@@ -1,6 +1,6 @@
 # Expresspigeon::Ruby
 
-This is a Ruby library for convenince access to [ExpressPigeon API](https://expresspigeon.com/api).
+This is a Ruby library for convenient access to [ExpressPigeon API](https://expresspigeon.com/api).
 
 ## Installation
 
@@ -16,11 +16,10 @@ Or install it yourself as:
 
     $ gem install expresspigeon-ruby
 
-## Usage
+## Sending a simple message
 
 Sending a transactional message is easy: 
 
-
 ```ruby
 MESSAGES = ExpressPigeon::API.messages.auth_key 'XXX'
 message_response = MESSAGES.send_message 115,                 # template ID
@@ -40,6 +39,50 @@ sleep 5
 puts MESSAGES.report message_response.id
 ```
 
+## Sending a message with attachments
+
+```ruby
+ MESSAGES = ExpressPigeon::API.messages.auth_key(ENV['AUTH_KEY'])
+
+ attachments = %W{attachments/attachment1.txt  attachments/smile.pdf attachments/example.ics}
+
+ puts MESSAGES.send_message(
+     123,                                        # template_id
+     'john@doe.com',                             #to
+     'jane@doe.com',                             #reply_to
+     "Jane Doe",                                 #from
+     "Want to get out for a dinner?",            #subject
+     {first_name: 'John', main_course: 'stake'}, #merge_fields
+     false,                                      #view_online
+     true,                                       #click_tracking
+     true,                                       #suppress_address
+     attachments                                 #file paths to upload as attachments
+ )
+
+```
+
+## Sending a message with all required and optional arguments
+
+```ruby
+
+MESSAGES = ExpressPigeon::API.messages.auth_key(ENV['AUTH_KEY'])
+
+attachments = %W{attachments/attachment1.txt attachments/calendar.ics}
+
+puts MESSAGES.send_msg 123, 'john@doe.com', 'jane@doe.com',
+                       'Jane Doe', 'A simple test subject',
+                       merge_fields: { first_name: "John" },
+                       view_online: false,
+                       click_tracking: true,
+                       suppress_address: false,
+                       attachments: attachments,
+                       headers: { Xtest: "test" },
+                       reply_name: "Jane S. Doe",
+                       from_address: "jane+123@doe.com" 
+
+```
+
+The first five arguments are mandatory, while the rest are optional. 
 
 ## Contributing
 

data/expresspigeon-ruby.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'rest-client', '~> 1.8.0'
-
+  gem.add_runtime_dependency 'rest-client', '~> 2.0.2'
   gem.add_development_dependency "rspec", "~> 2.6"
+  gem.licenses = ['MIT']
 end

data/lib/expresspigeon-ruby.rb

@@ -8,7 +8,9 @@ require 'rest_client'
 module ExpressPigeon
 
   AUTH_KEY = ENV['EXPRESSPIGEON_AUTH_KEY']
-  ROOT = 'https://api.expresspigeon.com/'
+
+  # EXPRESSPIGEON_ROOT env var is used to point to testenv
+  ROOT =  ENV.has_key?('EXPRESSPIGEON_ROOT') ? ENV['EXPRESSPIGEON_ROOT'] : 'https://api.expresspigeon.com/'
   USE_SSL = true
 
   module API
@@ -76,11 +78,16 @@ module ExpressPigeon
         ) 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
@@ -121,7 +128,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

@@ -7,19 +7,57 @@ module ExpressPigeon
       @endpoint = 'messages'
     end
 
-    def send_message(template_id, to, reply_to, from_name, subject, merge_fields = nil, view_online = false, click_tracking = true)
-      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}
+    # Sends a single transactional message.
+    #
+    # For more information on arguments, see: [https://expresspigeon.com/kb/transactional-send].
+    #
+    def send_message(template_id, to, reply_to, from, subject, merge_fields = nil, view_online = false,
+                                            click_tracking = true, suppress_address = false, attachments = nil, headers = nil)
+      if attachments
+          upload(template_id, to, reply_to, from, subject, merge_fields, view_online, click_tracking,
+                                                                                    suppress_address, attachments, headers, nil, nil)
+        else
+          post @endpoint, params = {template_id: template_id, to: to, reply_to: reply_to, from: from,
+                                    subject: subject, merge_fields: merge_fields, view_online: view_online,
+                                    click_tracking: click_tracking, suppress_address: suppress_address, headers: headers}
+      end
     end
 
+
+    # Sends a single transactional message.
+    #
+    # For more information on arguments, see: [https://expresspigeon.com/kb/transactional-send].
+
+    # This method allows to specify different 'reply_to', 'reply_name', 'from' and 'from_address' values.
+    #
+    def send_msg(template_id, to, reply_to, from, subject, optional = {})
+
+      if optional[:attachments]
+        upload(template_id, to, reply_to, from, subject, optional[:merge_fields], optional[:view_online], optional[:click_tracking],
+               optional[:suppress_address], optional[:attachments], optional[:headers], optional[:reply_name], optional[:from_address])
+      else
+        params =  optional ? optional.clone : {}
+        params[:template_id] =  template_id
+        params[:to] =  to
+        params[:reply_to] =  reply_to
+        params[:from] =  from
+        params[:subject] =  subject
+
+        post @endpoint, params
+      end
+    end
+
+    # Retrieve report for a single message.
+    #
+    # * +message_id+ - ID of a message sent previously
     def report(message_id)
       get "#{@endpoint}/#{message_id}"
     end
 
+    # Report for a group of messages in a given time period.
     #
-    #
-    # start_date is instance of Time
-    # end_date is instance of Time
+    # * +start_date+ is instance of Time
+    # * +end_date+ is instance of Time
     def reports(from_id, start_date = nil, end_date = nil)
       params = []
 
@@ -46,7 +84,75 @@ module ExpressPigeon
       end
 
       get query
+    end
+
+
+    # Sends a transactional message with attachments using ExpressPigeon Rest API.
+    # This method  is not used directly, instead use +send_message()+ or +send_msg()+
+    #
+    # * +template_id+ - ID of a template to use for sending
+    # * +to+ - destination email address
+    # * +reply_to+ - return email address
+    # * +from+ - name of sender
+    # * +subject+ - subject of email
+    # * +merge fields+ - hash with dynamic values to merge into a template
+    # * +view_online+ - generate "view online" link in the template
+    # * +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.
+    # * +headers+ - hash of headers to add to SMTP message
+    # * +reply_name+ - reply name to use in the +reply-to+ header.
+    # * +from_name+ - name to use in the +from+ header
+    #
+    def upload(template_id, to, reply_to, from, subject, merge_fields, view_online, click_tracking, suppress_address, attachments, headers, reply_name, from_address)
+      path = "#{@root ? @root : ROOT}/#{@endpoint}"
+      begin
+        payload = prepare_payload(template_id, to, reply_to, from, subject, merge_fields, view_online, click_tracking, suppress_address, attachments, headers, reply_name, from_address)
+        request = RestClient::Request.new(
+            :method => :post,
+            :headers => {:'X-auth-key' => get_auth_key},
+            :url => path,
+            :payload => payload)
+        resp = request.execute
+        res = resp.body
+      rescue RestClient::ExceptionWithResponse => err
+        res = err.response
+      end
+
+      parsed = JSON.parse(res)
+      if parsed.kind_of? Hash
+        MetaResponse.new parsed
+      else
+        parsed
+      end
+    end
+
+
+    def prepare_payload(template_id, to, reply_to, from, subject, merge_fields, view_online, click_tracking, suppress_address, attachments, headers,
+                        reply_name, from_address)
+      payload = { multipart: true }
+      payload[:template_id] = template_id
+      payload[:to] = to
+      payload[:reply_to] = reply_to
+      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
+      payload[:reply_name] = reply_name
+      payload[:from_address] = from_address
 
+      attachments.each { |attachment|
+        if File.file?(attachment)
+          file = File.basename(attachment)
+          payload[file] = File.new attachment
+        else
+          raise "File #{attachment} does not exist"
+        end
+      }
+      payload
     end
   end
 end

data/lib/expresspigeon-ruby/meta_response.rb

@@ -15,7 +15,7 @@ module ExpressPigeon
       @delegate[m.to_s]
     end
 
-    def respond_to?(m)
+    def respond_to?(m,  include_all = false)
       @delegate.key?(m.to_s)
     end
 

data/lib/expresspigeon-ruby/version.rb

@@ -1,5 +1,5 @@
 module Expresspigeon
   module API
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   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
+