send_with_us 0.0.6 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb22ce6f21aba1a56300d9053b3dcfd32f6a86e8
+  data.tar.gz: c76b1a8d8164876606ad0e557eee35b44feb7f83
+SHA512:
+  metadata.gz: 99ec0c8f81778add459db53d53aa9ca44a88f4f68aa2e980eceee9968352dd51f6c19e5361df9873ec3159c4719545d450f2595d78bbe7a6f594ff871c69019f
+  data.tar.gz: d1772d7fef1f93635b7e4dbd386bba5194dca363a4f9e2c261cb6e5cee6ded9928d35c71c5ec37631a0e36d6296a411b7fe8139eedbc2826ee8ff8dc3db80852

data/CHANGELOG.md

@@ -1,7 +1,7 @@
+1.0.0 - Updated for v1_0 of SWU api. Added emails endpoint.
 0.0.4 - Rewritten to be more gem-like
       - Accepts configuration via a Rails-style initializer
       - Test coverage
 0.0.3 - No idea
 0.0.2 - Full json post body
-0.0.1 - First Version
-
+0.0.1 - First Version

data/README.md

@@ -26,7 +26,22 @@ For any Ruby project:
 
     begin
       obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )
-      result = obj.send_with('email_id', 'recipient@testco.com', { company_name: 'TestCo' })
+
+      # with only required params
+      result = obj.send_with(
+        'email_id',
+        { address: "user@email.com" },
+        { company_name: 'TestCo' })
+      puts result
+      
+      # with all optional params
+      result = obj.send_with(
+        'email_id',
+        { name: 'Matt', address: 'recipient@testco.com' },
+        { company_name: 'TestCo' },
+        { name: 'Company',
+          address: 'company@testco.com',
+          reply_to: 'info@testco.com' })
       puts result
     rescue Exception => e
       puts "Error - #{e.class.name}: #{e.message}"
@@ -45,7 +60,7 @@ with the following:
 In your application code where you want to send an email:
 
     begin
-      result = SendWithUs::Api.new.send_with('email_id', 'recipient@testco.com', { company_name: 'TestCo' })
+      result = SendWithUs::Api.new.send_with('email_id', { address: 'recipient@testco.com' }, { company_name: 'TestCo' })
       puts result
     rescue Exception => e
       puts "Error - #{e.class.name}: #{e.message}"
@@ -55,6 +70,6 @@ In your application code where you want to send an email:
 
 The following errors may be generated:
 
-    SendWithUs::ApiInvalidEndpoint - the target URI is probably incorrect
+    SendWithUs::ApiInvalidEndpoint - the target URI is probably incorrect or email_id is invalid
     SendWithUs::ApiConnectionRefused - the target URI is probably incorrect
     SendWithUs::ApiUnknownError - an unhandled HTTP error occurred

data/lib/send_with_us/api.rb

@@ -20,11 +20,19 @@ module SendWithUs
       @configuration = SendWithUs::Config.new(settings)
     end
 
-    def send_with(email_id, to, data = {})
-      payload = { email_id: email_id, email_to: to, email_data: data }.to_json
+    def send_with(email_id, to, data = {}, from = {})
+      if from.any?
+        payload = { email_id: email_id, recipient: to, sender: from, email_data: data }.to_json
+      else
+        payload = { email_id: email_id, recipient: to, email_data: data }.to_json
+      end
       SendWithUs::ApiRequest.new(@configuration).send_with(payload)
     end
 
+    def emails()
+      SendWithUs::ApiRequest.new(@configuration).get(:emails)
+    end
+
   end
 
 end

data/lib/send_with_us/api_request.rb

@@ -21,6 +21,30 @@ module SendWithUs
 
       @response = http.request(request, payload)
 
+      case @response
+      when Net::HTTPNotFound then
+        raise SendWithUs::ApiInvalidEndpoint, path
+      when Net::HTTPSuccess then
+        puts @response.body if @configuration.debug
+        @response
+      else
+        raise SendWithUs::ApiUnknownError
+      end
+    rescue Errno::ECONNREFUSED
+      raise SendWithUs::ApiConnectionRefused
+    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)
+
+      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

data/lib/send_with_us/config.rb

@@ -1,7 +1,7 @@
 module SendWithUs
   class Config
     attr_accessor :settings
-    #attr_writer :url, :api_key, :protocol, :host, :port, :api_verstion, :debug
+    #attr_writer :url, :api_key, :protocol, :host, :port, :api_version, :debug
 
     DEFAULT_URL = 'https://beta.sendwithus.com'
 
@@ -14,7 +14,7 @@ module SendWithUs
         protocol:     source.scheme,
         host:         source.host,
         port:         source.port,
-        api_version:  0,
+        api_version:  '1_0',
         debug:        true
       }
     end

data/lib/send_with_us/version.rb

@@ -1,3 +1,3 @@
 module SendWithUs
-  VERSION = '0.0.6'
+  VERSION = '1.0.0'
 end

data/test/lib/send_with_us/api_request_test.rb

@@ -3,9 +3,9 @@ require_relative '../../test_helper'
 class TestApiRequest < MiniTest::Unit::TestCase
 
   def build_objects
-    @payload  = {}
-    @config   = SendWithUs::Config.new( api_version: 3, api_key: 'TEST_KEY', debug: false )
-    @request  = SendWithUs::ApiRequest.new(@config)
+    @payload = {}
+    @config  = SendWithUs::Config.new( api_version: '1_0', api_key: 'THIS_IS_A_TEST_API_KEY', debug: false )
+    @request = SendWithUs::ApiRequest.new(@config)
   end
 
   def test_payload
@@ -32,9 +32,15 @@ class TestApiRequest < MiniTest::Unit::TestCase
     assert_raises( SendWithUs::ApiConnectionRefused ) { @request.send_with(@payload) }
   end
 
+  def test_emails
+    build_objects
+    Net::HTTP.any_instance.stubs(:request).returns(Net::HTTPSuccess.new(1.0, 200, "OK"))
+    assert_instance_of( Net::HTTPSuccess, @request.get(:emails) )
+  end
+
   def test_request_path
     build_objects
-    assert_equal( true, @request.send(:request_path, :send) == '/api/v3/send' )
+    assert_equal( true, @request.send(:request_path, :send) == '/api/v1_0/send' )
   end
 
 end

metadata

@@ -1,75 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: send_with_us
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 6
-  version: 0.0.6
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Matt Harris
 - Chris Cummer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SendWithUs.com Ruby Client
-email: 
+email:
 - us@sendwithus.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.md
@@ -91,38 +81,28 @@ files:
 - test/test_helper.rb
 homepage: http://www.sendwithus.com
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SendWithUs.com Ruby Client
-test_files: 
+test_files:
 - test/lib/send_with_us/api_request_test.rb
 - test/lib/send_with_us/api_test.rb
 - test/lib/send_with_us/config_test.rb