send_with_us 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4af3e368512e19608207ecc65ef6a8e6cd8deb0b
-  data.tar.gz: f1f2ac7ebb7d14164f768dab256669fe5e1822da
+  metadata.gz: 1e1ccb915c665ef78694fb507017fde34ae43b83
+  data.tar.gz: 4f6b82c1110f7284652f71dcfa0eeb5957bd67b9
 SHA512:
-  metadata.gz: 5071d2e5c5c453c26802b024483e61ce3dd93a03410c8eddacf7bfa493eed1fe42c4f814386c3bc5ec3e872ba20800162e4442e1f8fab6d89ee860f19bf1ed2b
-  data.tar.gz: b5088e7f4267e46867e29bd12acc7b7583bfa159736c697caa16bf2091fa2cddaaf951e074604a195036c957c9b687c3465f8e181a869ab70bec03c0f38923ab
+  metadata.gz: 0187466927694f4dc3ee0aaabfe0f67fd7bf11fae095a857ea77af5cb6f9ca114240ab435477e4d5c1816093bfc51bd8532cc8d908470e39d90c596e1bfc5670
+  data.tar.gz: b3b1ce4aee881938c37ec44aaf1b5211509c22f9a5aa44cc11631e9f0a966c952750b871bff2c249043521a09be4e62c38f8f7e78eda6fa511458c3308c69cc0

data/README.md

@@ -34,37 +34,50 @@ begin
     # only required params
     result = obj.send_with(
         'EMAIL_ID',
-        { address: "user@email.com" })
+        { address: "user@example.com" })
     puts result
     
     # with all optional params
     result = obj.send_with(
         'email_id',
-        { name: 'Matt', address: 'recipient@testco.com' },
+        { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
         { name: 'Company',
-            address: 'company@testco.com',
-            reply_to: 'info@testco.com' })
+            address: 'company@example.com',
+            reply_to: 'info@example.com' })
     puts result
     
     # full cc/bcc support
     result = obj.send_with(
         'email_id',
-        { name: 'Matt', address: 'recipient@testco.com' },
+        { name: 'Matt', address: 'recipient@example.com' },
         { company_name: 'TestCo' },
         { name: 'Company',
-            address: 'company@testco.com',
-            reply_to: 'info@testco.com' },
+            address: 'company@example.com',
+            reply_to: 'info@example.com' },
         [
             { name: 'CC',
-                address: 'cc@testco.com' }
+                address: 'cc@example.com' }
         ],
         [
             { name: 'BCC',
-                address: 'bcc@testco.com' },
+                address: 'bcc@example.com' },
             { name: 'BCC2',
-                address: 'bcc2@test.com' }
+                address: 'bcc2@example.com' }
         ])
+
+    # Attachment support
+    result = obj.send_with(
+        'email_id',
+        { name: 'Matt', address: 'recipient@example.com' },
+        { company_name: 'TestCo' },
+        { name: 'Company',
+            address: 'company@example.com',
+            reply_to: 'info@example.com' },
+        [],
+        [],
+        ['path/to/file.txt'])
+
     puts result
 rescue => e
     puts "Error - #{e.class.name}: #{e.message}"
@@ -87,7 +100,7 @@ In your application code where you want to send an email:
 
 ```ruby
 begin
-    result = SendWithUs::Api.new.send_with('email_id', { address: 'recipient@testco.com' }, { company_name: 'TestCo' })
+    result = SendWithUs::Api.new.send_with('email_id', { address: 'recipient@example.com' }, { company_name: 'TestCo' })
     puts result
 rescue => e
     puts "Error - #{e.class.name}: #{e.message}"

data/lib/send_with_us/api.rb

@@ -29,7 +29,7 @@ module SendWithUs
         raise SendWithUs::ApiNilEmailId, 'email_id cannot be nil'
       end
 
-      payload = { email_id: email_id, recipient: to, 
+      payload = { email_id: email_id, recipient: to,
         email_data: data }
 
       if from.any?
@@ -53,7 +53,7 @@ module SendWithUs
       end
 
       payload = payload.to_json
-      SendWithUs::ApiRequest.new(@configuration).send_with(payload)
+      SendWithUs::ApiRequest.new(@configuration).post(:send, payload)
     end
 
     def drips_unsubscribe(email_address)
@@ -64,14 +64,25 @@ module SendWithUs
 
       payload = { email_address: email_address }
       payload = payload.to_json
-      
-      SendWithUs::ApiRequest.new(@configuration).drips_unsubscribe(payload)
+
+      SendWithUs::ApiRequest.new(@configuration).post(:'drips/unsubscribe', payload)
     end
 
     def emails()
       SendWithUs::ApiRequest.new(@configuration).get(:emails)
     end
 
+    def create_template(name, subject, html, text)
+      payload = {
+        name: name,
+        subject: subject,
+        html: html,
+        text: text
+      }.to_json
+
+      SendWithUs::ApiRequest.new(@configuration).post(:emails, payload)
+    end
+
   end
 
 end

data/lib/send_with_us/api_request.rb

@@ -12,93 +12,12 @@ module SendWithUs
       @configuration = configuration
     end
 
-    def send_with(payload)
-
-      path          = request_path(:send)
-      request       = Net::HTTP::Post.new(path, initheader = {'Content-Type' =>'application/json'})
-      request.add_field('X-SWU-API-KEY', @configuration.api_key)
-      request.add_field('X-SWU-API-CLIENT', @configuration.client_stub)
-
-      http          = Net::HTTP.new(@configuration.host, @configuration.port)
-      http.use_ssl  = use_ssl?
-      http.set_debug_output($stdout) if @configuration.debug
-
-      @response = http.request(request, payload)
-
-      case @response
-      when Net::HTTPNotFound then
-        raise SendWithUs::ApiInvalidEndpoint, path
-      when Net::HTTPForbidden then
-        raise SendWithUs::ApiInvalidKey, 'Invalid api key: ' + @configuration.api_key
-      when Net::HTTPBadRequest then
-        raise SendWithUs::ApiBadRequest, @response.body
-      when Net::HTTPSuccess then
-        puts @response.body if @configuration.debug
-        @response
-      else
-        raise SendWithUs::ApiUnknownError, 'An unknown error has occurred'
-      end
-    rescue Errno::ECONNREFUSED
-      raise SendWithUs::ApiConnectionRefused, 'The connection was refused'
-    end
-
-    def drips_unsubscribe(payload)
-
-      path          = request_path(:'drips/unsubscribe')
-      request       = Net::HTTP::Post.new(path, initheader = {'Content-Type' =>'application/json'})
-      request.add_field('X-SWU-API-KEY', @configuration.api_key)
-      request.add_field('X-SWU-API-CLIENT', @configuration.client_stub)
-
-      http          = Net::HTTP.new(@configuration.host, @configuration.port)
-      http.use_ssl  = use_ssl?
-      http.set_debug_output($stdout) if @configuration.debug
-
-      @response = http.request(request, payload)
-
-      case @response
-      when Net::HTTPNotFound then
-        raise SendWithUs::ApiInvalidEndpoint, path
-      when Net::HTTPForbidden then
-        raise SendWithUs::ApiInvalidKey, 'Invalid api key: ' + @configuration.api_key
-      when Net::HTTPBadRequest then
-        raise SendWithUs::ApiBadRequest, @response.body
-      when Net::HTTPSuccess then
-        puts @response.body if @configuration.debug
-        @response
-      else
-        raise SendWithUs::ApiUnknownError, 'An unknown error has occurred'
-      end
-    rescue Errno::ECONNREFUSED
-      raise SendWithUs::ApiConnectionRefused, 'The connection was refused'
+    def post(endpoint, payload)
+      request(Net::HTTP::Post, request_path(endpoint), payload)
     end
 
     def get(endpoint)
-      path = request_path(endpoint)
-      request = Net::HTTP::Get.new(path, initheader = {'Content-Type' =>'application/json'})
-      request.add_field('X-SWU-API-KEY', @configuration.api_key)
-      request.add_field('X-SWU-API-CLIENT', @configuration.client_stub)
-
-      http          = Net::HTTP.new(@configuration.host, @configuration.port)
-      http.use_ssl  = use_ssl?
-      http.set_debug_output($stdout) if @configuration.debug
-
-      @response = http.request(request)
-
-      case @response
-      when Net::HTTPNotFound then
-        raise SendWithUs::ApiInvalidEndpoint, path
-      when Net::HTTPForbidden then
-        raise SendWithUs::ApiInvalidKey, 'Invalid api key: ' + @configuration.api_key
-      when Net::HTTPBadRequest then
-        raise SendWithUs::ApiBadRequest, @response.body
-      when Net::HTTPSuccess
-        puts @response.body if @configuration.debug
-        @response
-      else
-        raise SendWithUs::ApiUnknownError, 'An unknown error has occurred'
-      end
-    rescue Errno::ECONNREFUSED
-      raise SendWithUs::ApiConnectionRefused, 'The connection was refused'
+      request(Net::HTTP::Get, request_path(endpoint))
     end
 
     private
@@ -111,5 +30,32 @@ module SendWithUs
         @configuration.protocol == 'https'
       end
 
+      def request(method_klass, path, payload=nil)
+        request = method_klass.new(path, initheader = {'Content-Type' =>'application/json'})
+        request.add_field('X-SWU-API-KEY', @configuration.api_key)
+        request.add_field('X-SWU-API-CLIENT', @configuration.client_stub)
+
+        http          = Net::HTTP.new(@configuration.host, @configuration.port)
+        http.use_ssl  = use_ssl?
+        http.set_debug_output($stdout) if @configuration.debug
+
+        @response = http.request(request, payload)
+
+        case @response
+        when Net::HTTPNotFound then
+          raise SendWithUs::ApiInvalidEndpoint, path
+        when Net::HTTPForbidden then
+          raise SendWithUs::ApiInvalidKey, 'Invalid api key: ' + @configuration.api_key
+        when Net::HTTPBadRequest then
+          raise SendWithUs::ApiBadRequest, @response.body
+        when Net::HTTPSuccess
+          puts @response.body if @configuration.debug
+          @response
+        else
+          raise SendWithUs::ApiUnknownError, 'An unknown error has occurred'
+        end
+      rescue Errno::ECONNREFUSED
+        raise SendWithUs::ApiConnectionRefused, 'The connection was refused'
+      end
   end
 end

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '1.0.5'
+  VERSION = '1.1.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -4,6 +4,7 @@ class TestApiRequest < MiniTest::Unit::TestCase
 
   def build_objects
     @payload = {}
+    @api = SendWithUs::Api.new( api_key: 'THIS_IS_A_TEST_API_KEY', debug: false)
     @config  = SendWithUs::Config.new( api_version: '1_0', api_key: 'THIS_IS_A_TEST_API_KEY', debug: false )
     @request = SendWithUs::ApiRequest.new(@config)
   end
@@ -11,31 +12,46 @@ class TestApiRequest < MiniTest::Unit::TestCase
   def test_payload
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.send_with(@payload) )
+    assert_instance_of( Net::HTTPSuccess, @request.post(:send, @payload) )
+  end
+
+  def test_attachment
+    build_objects
+    email_id = 'test_fixture_1'
+    result = @api.send_with(
+        email_id,
+        {name: 'Ruby Unit Test', address: 'matt@example.com'},
+        {name: 'sendwithus', address: 'matt@example.com'},
+        {},
+        [],
+        [],
+        ['README.md']
+    )
+    assert_instance_of( Net::HTTPOK, result )
   end
 
   def test_unsubscribe
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
-    assert_instance_of( Net::HTTPSuccess, @request.drips_unsubscribe(@payload) )
+    assert_instance_of( Net::HTTPSuccess, @request.post(:'drips/unsubscribe', @payload) )
   end
 
   def test_send_with_not_found_exception
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPNotFound.new(1.0, 404, "OK"))
-    assert_raises( SendWithUs::ApiInvalidEndpoint ) { @request.send_with(@payload) }
+    assert_raises( SendWithUs::ApiInvalidEndpoint ) { @request.post(:send, @payload) }
   end
 
   def test_send_with_unknown_exception
     build_objects
     Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPNotAcceptable.new(1.0, 406, "OK"))
-    assert_raises( SendWithUs::ApiUnknownError ) { @request.send_with(@payload) }
+    assert_raises( SendWithUs::ApiUnknownError ) { @request.post(:send, @payload) }
   end
 
   def test_send_with_connection_refused
     build_objects
     Net::HTTP.any_instance.stubs(:request).raises(Errno::ECONNREFUSED.new)
-    assert_raises( SendWithUs::ApiConnectionRefused ) { @request.send_with(@payload) }
+    assert_raises( SendWithUs::ApiConnectionRefused ) { @request.post(:send, @payload) }
   end
 
   def test_emails
@@ -48,5 +64,4 @@ class TestApiRequest < MiniTest::Unit::TestCase
     build_objects
     assert_equal( true, @request.send(:request_path, :send) == '/api/v1_0/send' )
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Matt Harris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: SendWithUs.com Ruby Client