send_with_us 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb22ce6f21aba1a56300d9053b3dcfd32f6a86e8
-  data.tar.gz: c76b1a8d8164876606ad0e557eee35b44feb7f83
+  metadata.gz: a57e3e4b0f5abe4f4cabc867fbc17337be2ba10c
+  data.tar.gz: 17a35935697a76d5d537172ac6038c50565078b5
 SHA512:
-  metadata.gz: 99ec0c8f81778add459db53d53aa9ca44a88f4f68aa2e980eceee9968352dd51f6c19e5361df9873ec3159c4719545d450f2595d78bbe7a6f594ff871c69019f
-  data.tar.gz: d1772d7fef1f93635b7e4dbd386bba5194dca363a4f9e2c261cb6e5cee6ded9928d35c71c5ec37631a0e36d6296a411b7fe8139eedbc2826ee8ff8dc3db80852
+  metadata.gz: 046333ff32245579376b1710560c53da4a69376516f62db4580311489d0eb48584982c13cfa2adcfc1663e510f2bbed343aaff2cd012cd5d468e5adc08180bdd
+  data.tar.gz: d36dca29256262b28888455194397b411d3ed93de23557a3c3164e311a11e75ea9cface3e69a74d39efa96a6efa002099e17f55a418e8c69d5ea6031aae39ea9

data/README.md

@@ -8,68 +8,113 @@ Ruby bindings for sending email via the sendwithus API.
 
 ## Installation
 
-    gem install send_with_us
+```bash
+gem install send_with_us
+```
 
 or with Bundler:
 
-    gem 'send_with_us'
-    bundle install
+```bash
+gem 'send_with_us'
+bundle install
+```
 
 ## Usage
 
 ### General
 
 For any Ruby project:
-
-    require 'rubygems'
-    require 'send_with_us'
-
-    begin
-      obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )
-
-      # with only required params
-      result = obj.send_with(
+```ruby
+require 'rubygems'
+require 'send_with_us'
+
+begin
+    obj = SendWithUs::Api.new( api_key: 'YOUR API KEY', debug: true )
+
+    # only required params
+    result = obj.send_with(
+        'EMAIL_ID',
+        { address: "user@email.com" })
+    puts result
+    
+    # with all optional params
+    result = obj.send_with(
         'email_id',
-        { address: "user@email.com" },
-        { company_name: 'TestCo' })
-      puts result
-      
-      # with all optional params
-      result = obj.send_with(
+        { name: 'Matt', address: 'recipient@testco.com' },
+        { company_name: 'TestCo' },
+        { name: 'Company',
+            address: 'company@testco.com',
+            reply_to: 'info@testco.com' })
+    puts result
+    
+    # COMING SOON
+    # cc/bb support is coming soon, here's a taste test
+    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}"
-    end
+            address: 'company@testco.com',
+            reply_to: 'info@testco.com' },
+        [
+            { name: 'CC',
+                address: 'cc@testco.com' }
+        ],
+        [
+            { name: 'BCC',
+                address: 'bcc@testco.com' },
+            { name: 'BCC2',
+                address: 'bcc2@test.com' }
+        ])
+    puts result
+rescue Exception => e
+    puts "Error - #{e.class.name}: #{e.message}"
+end
+```
 
 ### Rails
 
 For a Rails app, create `send_with_us.rb` in `/config/initializers/`
 with the following:
 
-    SendWithUs::Api.configure do |config|
-      config.api_key = 'YOUR API KEY'
-      config.debug = true
-    end
+```ruby
+SendWithUs::Api.configure do |config|
+    config.api_key = 'YOUR API KEY'
+    config.debug = true
+end
+```
 
 In your application code where you want to send an email:
 
-    begin
-      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}"
-    end
+```ruby
+begin
+    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}"
+end
+```
 
 ## Errors
 
 The following errors may be generated:
 
-    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
+```ruby
+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
+```
+
+## Internal
+Build gem with
+
+```bash
+gem build send_with_us.gemspec
+```
+
+Publish gem with
+
+```bash
+gem publish send_with_us-VERSION.gem
+```
+

data/lib/send_with_us/api.rb

@@ -20,12 +20,21 @@ module SendWithUs
       @configuration = SendWithUs::Config.new(settings)
     end
 
-    def send_with(email_id, to, data = {}, from = {})
+    def send_with(email_id, to, data = {}, from = {}, cc={}, bcc={})
+      payload = { email_id: email_id, recipient: to, 
+        email_data: data }
+
       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
+        payload[:sender] = from
+      end
+      if cc.any?
+        payload[:cc] = cc
       end
+      if bcc.any?
+        payload[:bcc] = bcc
+      end
+
+      payload = payload.to_json
       SendWithUs::ApiRequest.new(@configuration).send_with(payload)
     end
 

data/lib/send_with_us/api_request.rb

@@ -14,6 +14,7 @@ module SendWithUs
       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?
@@ -38,6 +39,7 @@ module SendWithUs
       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?

data/lib/send_with_us/config.rb

@@ -1,3 +1,5 @@
+require_relative 'version'
+
 module SendWithUs
   class Config
     attr_accessor :settings
@@ -15,7 +17,8 @@ module SendWithUs
         host:         source.host,
         port:         source.port,
         api_version:  '1_0',
-        debug:        true
+        debug:        true,
+        client_stub:  "ruby-#{VERSION}"
       }
     end
 

data/lib/send_with_us/version.rb

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

data/send_with_us.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["us@sendwithus.com"]
   gem.description   = %q{SendWithUs.com Ruby Client}
   gem.summary       = %q{SendWithUs.com Ruby Client}
-  gem.homepage      = "http://www.sendwithus.com"
+  gem.homepage      = "https://github.com/sendwithus/sendwithus_ruby"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: send_with_us
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matt Harris
@@ -9,48 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   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
   prerelease: false
   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
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: SendWithUs.com Ruby Client
@@ -79,7 +79,7 @@ files:
 - test/lib/send_with_us/config_test.rb
 - test/lib/send_with_us/version_test.rb
 - test/test_helper.rb
-homepage: http://www.sendwithus.com
+homepage: https://github.com/sendwithus/sendwithus_ruby
 licenses: []
 metadata: {}
 post_install_message: 
@@ -88,17 +88,17 @@ require_paths:
 - lib
 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: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: SendWithUs.com Ruby Client