expresspigeon-ruby 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cd91f0bd8a97f75aa9cf79b576c06d2d4e4bb4b
-  data.tar.gz: 902c3f5e47fff7b0d002f315f772b39dab593df8
+  metadata.gz: fe5c068844c9be4409e579ec341e7adb9e793330
+  data.tar.gz: 25738ba898a979110728640539677250bd15ce80
 SHA512:
-  metadata.gz: 1c1c35b39df3bfc3b5c32e53dae6363593e307cf64c424dbf1d801998c731ea90b6750f3720637c1a4a6a55b7fd256e6d7b969f027a72e0322a7dab14140f928
-  data.tar.gz: 2b040eecc69ae9791be736b7f2cbf17cd75b97e796b052f765bc5ef4dfa8a641d6e8f95ddf6c018bcb2bc18cb415dfcd841eec46b8c08fa46369d9d9c4aa113e
+  metadata.gz: 9cce412e917134f9f04acb97e2a109992cdf767c65265df219892b23f73c0d19e6c5be77349c7d6ca9534c53853c3ebd7f0b1c7c3c38ab9b0fd5909e8d447f61
+  data.tar.gz: da1dc1d7d89ab9bc1dbcedb07c2cee5394bd3d756db5fbf5dc5b4863f9780e153d4ed5e01c4afa724f593e388cb3d06366e6dc66cb6b351a246b308e24bbcde5

data/.gitignore

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

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    expresspigeon-ruby (0.0.3)
-      rest-client (~> 1.8.0)
+    expresspigeon-ruby (0.0.6)
+      rest-client (~> 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
-    domain_name (0.5.24)
+    domain_name (0.5.20161021)
       unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
+    http-cookie (1.0.3)
       domain_name (~> 0.5)
-    mime-types (1.25.1)
-    netrc (0.7.9)
+    mime-types (2.99.3)
+    netrc (0.11.0)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
@@ -28,7 +28,7 @@ GEM
     rspec-mocks (2.14.3)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.1)
+    unf_ext (0.0.7.2)
 
 PLATFORMS
   ruby
@@ -36,3 +36,6 @@ PLATFORMS
 DEPENDENCIES
   expresspigeon-ruby!
   rspec (~> 2.6)
+
+BUNDLED WITH
+   1.13.6

data/README.md

@@ -1,6 +1,6 @@
 # Expresspigeon::Ruby
 
-TODO: Write a gem description
+This is a Ruby library for convenince access to [ExpressPigeon API](https://expresspigeon.com/api).
 
 ## Installation
 
@@ -16,7 +16,7 @@ Or install it yourself as:
 
     $ gem install expresspigeon-ruby
 
-## Usage
+## Sending a simple message
 
 Sending a transactional message is easy: 
 
@@ -40,6 +40,26 @@ 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_name
+     "Want to get out for a dinner?",            #subject
+     {first_name: 'Igor', eye_color: 'blue'},    #merge_fields
+     false,                                      #view_online
+     true,                                       #click_tracking
+     attachments                                 #file paths to upload as attachments
+ )
+
+```
 
 ## 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', '~> 1.8'
   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

data/lib/expresspigeon-ruby/messages.rb

@@ -7,19 +7,37 @@ 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 transactional message using ExpressPigeon Rest API
+    #
+    # * +template_id+ - ID of a template to use for sending
+    # * +to+ - destination email address
+    # * +reply_to+ - return email address
+    # * +from_name+ - 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)
+    # * +attachments+ - array of file paths  to attach to email. Size limit: 1k per attachment, maximum 3 attachments.
+    def send_message(template_id, to, reply_to, from_name, subject, merge_fields = nil, view_online = false, click_tracking = true, attachments = nil)
+      if attachments
+        upload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking, attachments)
+        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}
+      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 = []
 
@@ -45,9 +63,70 @@ module ExpressPigeon
         query << params.join('&')
       end
 
-      puts "calling: #{query}"
       get query
+    end
+
+
+    # Sends a transactional message with attachments using ExpressPigeon Rest API.
+    # This method  is not used directly, instead use +send_message()+
+    #
+    # * +template_id+ - ID of a template to use for sending
+    # * +to+ - destination email address
+    # * +reply_to+ - return email address
+    # * +from_name+ - 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)
+    # * +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, attachments)
+
+      path = "#{@root ? @root : ROOT}/#{@endpoint}"
+
+      puts "sending to #{path}"
+
+      begin
+        payload = prepare_payload(template_id, to, reply_to, from_name, subject, merge_fields, view_online, click_tracking, attachments)
+        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, attachments)
+      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
+      payload[:view_online] = view_online
+      payload[:click_tracking] = click_tracking
 
+      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,6 +15,10 @@ module ExpressPigeon
       @delegate[m.to_s]
     end
 
+    def respond_to?(m)
+      @delegate.key?(m.to_s)
+    end
+
     def to_s
       @delegate.to_s
     end

data/lib/expresspigeon-ruby/version.rb

@@ -1,5 +1,5 @@
 module Expresspigeon
   module API
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/spec/messages_spec.rb

@@ -124,4 +124,30 @@ describe 'transactional messages integration test' do
   #    return report[0]
 
 
+  it 'should from 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,
+                                               %w(spec/resources/attachment1.txt spec/resources/attachment2.txt))
+
+     payload[:multipart].should eq true
+     payload[:template_id].should eq 123
+     payload[:to].should eq 'john@doe.com'
+     payload[:reply_to].should eq 'jane@doe.com'
+     payload[:from].should eq 'Jane Doe'
+     payload[:subject].should eq 'Hello, Dolly!'
+     payload[:template_id].should eq 123
+     payload[:merge_fields][:eye_color].should eq 'blue'
+     payload[:merge_fields][:body_shape].should eq 'pear'
+     payload[:view_online].should eq false
+     payload[:click_tracking].should eq true
+     payload['attachment1.txt'].class.should eq File
+     File.basename(payload['attachment1.txt']).should eq 'attachment1.txt'
+     File.basename(payload['attachment2.txt']).should eq 'attachment2.txt'
+  end
 end

data/test/README

@@ -0,0 +1,5 @@
+This directory contains Ruby scripts for manual testing some features.
+
+In order to point to test envv, and set the auth_key, need to source the file called set_env 
+
+ 

data/test/attachments/example.ics

@@ -0,0 +1,32 @@
+BEGIN:VCALENDAR
+VERSION:2.0
+CALSCALE:GREGORIAN
+BEGIN:VEVENT
+SUMMARY:Access-A-Ride Pickup
+DTSTART;TZID=America/New_York:20130802T103400
+DTEND;TZID=America/New_York:20130802T110400
+LOCATION:1000 Broadway Ave.\, Brooklyn
+DESCRIPTION: Access-A-Ride trip to 900 Jay St.\, Brooklyn
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:Pickup Reminder
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+BEGIN:VEVENT
+SUMMARY:Access-A-Ride Pickup
+DTSTART;TZID=America/New_York:20250802T200000
+DTEND;TZID=America/New_York:20250802T203000
+LOCATION:900 Jay St.\, Brooklyn
+DESCRIPTION: Access-A-Ride trip to 1000 Broadway Ave.\, Brooklyn
+STATUS:CONFIRMED
+SEQUENCE:3
+BEGIN:VALARM
+TRIGGER:-PT10M
+DESCRIPTION:Pickup Reminder
+ACTION:DISPLAY
+END:VALARM
+END:VEVENT
+END:VCALENDAR

data/test/send_with_attachments.rb

@@ -0,0 +1,18 @@
+
+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}
+
+puts MESSAGES.send_message(
+    1527,                                     # template_id
+    'igor@expresspigeon.com',                         #to
+    'igor@polevoy.org',                         #reply_to
+    "Igor Polevoy",                             #from_name
+    "Hi there! Two attachments and a calendar - Ruby",                                #subject
+    {first_name: 'Igor', eye_color: 'blue'},    #merge_fields
+    false,                                      #view_online
+    true,                                       #click_tracking
+    attachments                                 #file paths to upload as attachments
+)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expresspigeon-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - ipolevoy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,8 +70,13 @@ files:
 - spec/pigeon_helper.rb
 - spec/resources/upload.csv
 - spec/templates_spec.rb
+- test/README
+- test/attachments/example.ics
+- test/attachments/smile.pdf
+- test/send_with_attachments.rb
 homepage: https://github.com/expresspigeon/expresspigeon-ruby
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -101,4 +106,7 @@ test_files:
 - spec/pigeon_helper.rb
 - spec/resources/upload.csv
 - spec/templates_spec.rb
-has_rdoc: 
+- test/README
+- test/attachments/example.ics
+- test/attachments/smile.pdf
+- test/send_with_attachments.rb