send_with_us 0.0.6

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# vim stuff
+*.swp
+*.swo
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+    - "1.9.3"

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+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
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in send_with_us.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    send_with_us (0.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    i18n (0.6.1)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  rake
+  send_with_us!
+  shoulda

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Matt Harris
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# sendwithus_ruby
+
+Ruby bindings for sending email via the sendwithus API.
+
+[sendwithus.com](http://sendwithus.com)
+
+[![Build Status](https://api.travis-ci.org/sendwithus/sendwithus_ruby.png)](https://travis-ci.org/sendwithus/sendwithus_ruby)
+
+## Installation
+
+    gem install send_with_us
+
+or with Bundler:
+
+    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 )
+      result = obj.send_with('email_id', 'recipient@testco.com', { company_name: 'TestCo' })
+      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
+
+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' })
+      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
+    SendWithUs::ApiConnectionRefused - the target URI is probably incorrect
+    SendWithUs::ApiUnknownError - an unhandled HTTP error occurred

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/send_with_us'
+  t.test_files = FileList['test/lib/send_with_us/*_test.rb']
+  t.verbose = true
+end
+task default: :test

data/lib/send_with_us.rb

@@ -0,0 +1,13 @@
+module SendWithUs
+end
+
+require 'rubygems'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+require 'send_with_us/api'
+require 'send_with_us/api_request'
+require 'send_with_us/config'
+require 'send_with_us/version'

data/lib/send_with_us/api.rb

@@ -0,0 +1,30 @@
+module SendWithUs
+
+  class Api
+    attr_reader :configuration
+
+    # ------------------------------ Class Methods ------------------------------
+
+    def self.configuration
+      @configuration ||= SendWithUs::Config.new
+    end
+
+    def self.configure
+      yield self.configuration if block_given?
+    end
+
+    # ------------------------------ Instance Methods ------------------------------
+
+    def initialize(options = {})
+      settings = SendWithUs::Api.configuration.settings.merge(options)
+      @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
+      SendWithUs::ApiRequest.new(@configuration).send_with(payload)
+    end
+
+  end
+
+end

data/lib/send_with_us/api_request.rb

@@ -0,0 +1,48 @@
+module SendWithUs
+  class ApiInvalidEndpoint < StandardError; end
+  class ApiConnectionRefused < StandardError; end
+  class ApiUnknownError < StandardError; end
+
+  class ApiRequest
+    attr_reader :response
+
+    def initialize(configuration)
+      @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)
+
+      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::HTTPSuccess
+        puts @response.body if @configuration.debug
+        @response
+      else
+        raise SendWithUs::ApiUnknownError
+      end
+    rescue Errno::ECONNREFUSED
+      raise SendWithUs::ApiConnectionRefused
+    end
+
+    private
+
+      def request_path(end_point)
+        "/api/v#{@configuration.api_version}/#{end_point}"
+      end
+
+      def use_ssl?
+        @configuration.protocol == 'https'
+      end
+
+  end
+end

data/lib/send_with_us/config.rb

@@ -0,0 +1,49 @@
+module SendWithUs
+  class Config
+    attr_accessor :settings
+    #attr_writer :url, :api_key, :protocol, :host, :port, :api_verstion, :debug
+
+    DEFAULT_URL = 'https://beta.sendwithus.com'
+
+    def self.defaults
+      source = URI.parse(DEFAULT_URL)
+
+      {
+        url: DEFAULT_URL,
+        api_key:      nil,
+        protocol:     source.scheme,
+        host:         source.host,
+        port:         source.port,
+        api_version:  0,
+        debug:        true
+      }
+    end
+
+    def initialize(options={})
+      @settings = SendWithUs::Config.defaults.merge(options)
+    end
+
+    def method_missing(meth, *args, &block)
+      meth_str = meth.to_s
+
+      if meth_str.include?('=')
+        # If this is a write attempt, see if we can write to that key
+        meth_sym = meth_str.gsub('=', '').to_sym
+        has?(meth_sym) ? @settings[meth_sym] = args[0] : super
+      else
+        # It's a read attempt, see if that key exists
+        has?(meth) ? @settings[meth] : super
+      end
+    end
+
+    def respond_to_missing?(meth, include_private = false)
+      has?(meth) || super
+    end
+
+    private
+
+      def has?(key)
+        @settings.has_key?(key)
+      end
+  end
+end

data/lib/send_with_us/version.rb

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

data/send_with_us.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'send_with_us/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "send_with_us"
+  gem.version       = SendWithUs::VERSION
+  gem.authors       = ["Matt Harris", "Chris Cummer"]
+  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.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'shoulda'
+  gem.add_development_dependency 'mocha'
+end

data/test/lib/send_with_us/api_request_test.rb

@@ -0,0 +1,40 @@
+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)
+  end
+
+  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) )
+  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) }
+  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) }
+  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) }
+  end
+
+  def test_request_path
+    build_objects
+    assert_equal( true, @request.send(:request_path, :send) == '/api/v3/send' )
+  end
+
+end

data/test/lib/send_with_us/api_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../test_helper'
+
+describe SendWithUs::Api do
+
+  describe '.configuration with initializer' do
+    before do
+      @initializer_api_key = 'CONFIG_TEST'
+      SendWithUs::Api.configure { |config| config.api_key = @initializer_api_key }
+    end
+
+    it('configs') { SendWithUs::Api.new.configuration.api_key.must_equal @initializer_api_key }
+  end
+
+  describe '.configuration with custom' do
+    before do
+      @initializer_api_key = 'CONFIG_TEST'
+      @custom_api_key = 'STUFF_AND_THINGS'
+      SendWithUs::Api.configure { |config| config.api_key = @initializer_api_key }
+    end
+
+    it('configs') { SendWithUs::Api.new( api_key: @custom_api_key ).configuration.api_key.must_equal @custom_api_key }
+  end
+
+end

data/test/lib/send_with_us/config_test.rb

@@ -0,0 +1,22 @@
+require_relative '../../test_helper'
+
+class TestConfig < MiniTest::Unit::TestCase
+
+  def test_class_defaults
+    assert_equal( false, SendWithUs::Config.defaults.empty? )
+    assert_equal( 'https', SendWithUs::Config.defaults[:protocol] )
+  end
+
+  def test_config_unmerged
+    assert_equal( 'https', SendWithUs::Config.new.protocol )
+    assert_equal( true, SendWithUs::Config.new.respond_to?(:protocol) )
+    assert_raises( NoMethodError ) { SendWithUs::Config.new.widget }
+  end
+
+  def test_config_merged
+    assert_equal( 'proto', SendWithUs::Config.new({ protocol: 'proto'}).protocol )
+    assert_equal( true, SendWithUs::Config.new.respond_to?(:protocol) )
+    assert_raises( NoMethodError ) { SendWithUs::Config.new({ protocol: 'proto'}).widget }
+  end
+
+end

data/test/lib/send_with_us/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+
+class TestVersion < MiniTest::Unit::TestCase
+
+  def test_version
+    assert_equal( false, SendWithUs::VERSION.nil? )
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require File.expand_path('../../lib/send_with_us.rb', __FILE__)
+
+require 'rubygems'
+require 'bundler'
+require 'mocha'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'send_with_us'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: send_with_us
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
+platform: ruby
+authors: 
+- Matt Harris
+- Chris Cummer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-08 00:00:00 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"
+  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"
+  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"
+  type: :development
+  version_requirements: *id003
+description: SendWithUs.com Ruby Client
+email: 
+- us@sendwithus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/send_with_us.rb
+- lib/send_with_us/api.rb
+- lib/send_with_us/api_request.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/config_test.rb
+- test/lib/send_with_us/version_test.rb
+- test/test_helper.rb
+homepage: http://www.sendwithus.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+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/config_test.rb
+- test/lib/send_with_us/version_test.rb
+- test/test_helper.rb