send_with_us 1.6.0 → 1.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6f051528f2e3214a82b3447fc0d3965dd614848
+  data.tar.gz: f743aa1c6a72b8bddb178722c0d55978700283dd
+SHA512:
+  metadata.gz: 493cfbea63a120844f4f3bfa6eb72653a618b20bae54e8e71a7f13a8393249db77dc62812fa733240024fd08a8d4510c73b617da6b360e8caa3182d64772d3a4
+  data.tar.gz: 068ec297df720fe877cd2b71090f62ac6e5199e7c61baee8f4e5d8f72c458243520428930096eef364f7affc32ebf174d09ba6b406d081426ad1c307636638ab

data/README.md

@@ -30,11 +30,12 @@ bundle install
 - **from** - *hash* - From name/address/reply\_to
 - **cc** - *array* - array of CC addresses
 - **bcc** - *array* - array of BCC addresses
-- **files** - *array* - array of files to attach
+- **files** - *array* - array of files to attach, as strings or hashes (see below)
 - **esp\_account** - *string* - ESP account used to send email
 - **version\_name** - *string* - version of template to send
 - **headers** - *hash* - custom email headers **NOTE** only supported by some ESPs
 
+
 For any Ruby project:
 ```ruby
 require 'rubygems'
@@ -54,9 +55,12 @@ begin
         'template_id',
         { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
-        { name: 'Company',
-            address: 'company@example.com',
-            reply_to: 'info@example.com' },
+        {
+          name: 'Company',
+          address: 'company@example.com',
+          reply_to: 'info@example.com'
+        },
+        ['path/to/attachment.txt'],
 		'esp_MYESPACCOUNT',
 		'v2') # version name
     puts result
@@ -91,11 +95,17 @@ begin
             reply_to: 'info@example.com' },
         [],
         [],
-        ['path/to/file.txt'])
+        [
+          'path/to/file.txt',
+          { filename: 'customfilename.txt', attachment: 'path/to/file.txt' },
+          { filename: 'anotherfile.txt', attachment: File.open('path/to/file.txt') },
+          { filename: 'unpersistedattachment.txt', attachment: StringIO.new("raw data") }
+        ]
+    )
     puts result
 
     # Set ESP account
-    # See: https://help.sendwithus.com/support/solutions/articles/1000088976-set-up-and-use-multiple
+    # See: https://help.sendwithus.com/support/solurtions/articles/1000088976-set-up-and-use-multiple
     result = obj.send_with(
         'template_id',
         { name: 'Matt', address: 'recipient@example.com' },
@@ -117,7 +127,7 @@ end
 
 - **email\_id** - *string* - Template ID being rendered
 - **version\_id** - *string* - Version ID to render (optional)
-- **data** - *hash* - Email data to render the template with
+- **data** - *hash* - Email data to render the template with (optional)
 
 ```ruby
 require 'rubygems'

data/lib/send_with_us.rb

@@ -7,6 +7,7 @@ require 'net/https'
 require 'uri'
 require 'json'
 
+require 'send_with_us/attachment'
 require 'send_with_us/api'
 require 'send_with_us/api_request'
 require 'send_with_us/config'

data/lib/send_with_us/api.rb

@@ -51,14 +51,17 @@ module SendWithUs
         payload[:headers] = headers
       end
 
-      files.each do |path|
-        file = open(path).read
-        id = File.basename(path)
-        data = Base64.encode64(file)
-        if payload[:files].nil?
-          payload[:files] = []
+      if files.any?
+        payload[:files] = []
+
+        files.each do |file_data|
+          if file_data.is_a?(String)
+            attachment = SendWithUs::Attachment.new(file_data)
+          else
+            attachment = SendWithUs::Attachment.new(file_data[:attachment], file_data[:filename])
+          end
+          payload[:files] << { id: attachment.filename, data: attachment.encoded_data }
         end
-        payload[:files] << {id: id, data: data}
       end
 
       payload = payload.to_json

data/lib/send_with_us/attachment.rb

@@ -0,0 +1,16 @@
+module SendWithUs
+  class Attachment
+    def initialize attachment, filename = nil
+      @attachment, @filename = attachment, filename
+    end
+
+    def filename
+      @filename ||= @attachment.is_a?(String) ? File.basename(@attachment) : nil
+    end
+
+    def encoded_data
+      file_data = @attachment.respond_to?(:read) ? @attachment : open(@attachment)
+      Base64.encode64(file_data.read)
+    end
+  end
+end

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/test/lib/send_with_us/attachment_test.rb

@@ -0,0 +1,71 @@
+require_relative '../../test_helper'
+
+class TestAttachment < MiniTest::Unit::TestCase
+  describe "#filename" do
+    describe "when a filename is explicitly declared" do
+      before do
+        @attachment = SendWithUs::Attachment.new(
+          StringIO.new("some data"),
+          "rawr.txt"
+        )
+      end
+
+      it "returns the explicit filename" do
+        assert_equal "rawr.txt", @attachment.filename
+      end
+    end
+
+    describe "when a filename is implied from a path" do
+      before do
+        @attachment = SendWithUs::Attachment.new(
+          "this/is/a/path.txt"
+        )
+      end
+
+      it "returns the basename of the path" do
+        assert_equal "path.txt", @attachment.filename
+      end
+    end
+
+    describe "when a filename is absent" do
+      before do
+        @attachment = SendWithUs::Attachment.new(
+          StringIO.new("")
+        )
+      end
+
+      it "returns nil" do
+        assert_nil @attachment.filename
+      end
+    end
+  end
+
+  describe "#encoded_data" do
+    describe "when the attachment is an IO object" do
+      before do
+        @attachment = SendWithUs::Attachment.new(
+          StringIO.new("test text")
+        )
+      end
+
+      it "returns the base 64'd content of the object" do
+        assert_equal Base64.encode64("test text"), @attachment.encoded_data
+      end
+    end
+
+    describe "when the attachment is not an IO object" do
+      before do
+        @attachment = SendWithUs::Attachment.new(
+          "path/to/file.txt"
+        )
+        @attachment.expects(:open).
+          with("path/to/file.txt").
+          returns(StringIO.new("test text"))
+      end
+
+      it "returns the base 64'd content of the file/url in question" do
+        assert_equal Base64.encode64("test text"), @attachment.encoded_data
+      end
+    end
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 1.6.0
-  prerelease: 
+  version: 1.7.0
 platform: ruby
 authors:
 - Matt Harris
@@ -11,54 +10,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-17 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: SendWithUs.com Ruby Client
@@ -79,42 +72,44 @@ files:
 - lib/send_with_us.rb
 - lib/send_with_us/api.rb
 - lib/send_with_us/api_request.rb
+- lib/send_with_us/attachment.rb
 - lib/send_with_us/config.rb
 - lib/send_with_us/version.rb
 - send_with_us.gemspec
 - test/lib/send_with_us/api_request_test.rb
 - test/lib/send_with_us/api_test.rb
+- test/lib/send_with_us/attachment_test.rb
 - test/lib/send_with_us/config_test.rb
 - test/lib/send_with_us/version_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sendwithus/sendwithus_ruby
 licenses:
 - Apache-2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SendWithUs.com Ruby Client
 test_files:
 - test/lib/send_with_us/api_request_test.rb
 - test/lib/send_with_us/api_test.rb
+- test/lib/send_with_us/attachment_test.rb
 - test/lib/send_with_us/config_test.rb
 - test/lib/send_with_us/version_test.rb
 - test/test_helper.rb