dynect_email 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Shopify
+
+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,56 @@
+# DynectEmail
+
+A Ruby library for interacting with DynECT Email Delivery API.
+
+[DynECT Email](http://dyn.com/enterprise-email/dynect-email)
+[DynECT Email API](https://dynectemail.tenderapp.com/help/kb/api/introduction-to-dynect-email-deliverys-api)
+
+## Installation
+
+### From Git
+
+You can check out the latest source from git:
+
+    git clone git://github.com/Shopify/dynect_email.git
+
+## Usage Example
+
+```ruby
+require 'rubygems'
+require 'dynect_email'
+
+# Set your API key
+DynectEmail.api_key = "your-api-key"
+
+# Add a sender to your account
+DynectEmail.add_sender("myemail@example.com")
+
+# Add a sub account with username, password, company, phone
+response = DynectEmail.add_account("myemail@example.com", "secretpassword", "Shopify", "1231231231")
+
+# response hash includes the api key for the account that was created
+# Add a sender to the sub account
+DynectEmail.add_sender("myemail@example.com", response['apikey'])
+
+# Set headers
+DynectEmail.set_headers({:xheader1 => "X-Sample1", :xheader2 => "X-Sample2"})
+
+# Remove sender
+DynectEmail.remove_sender("myemail@example.com")
+
+# Remove account
+DynectEmail.remove_account("myemail@example.com")
+```
+
+Check out the [API docs](https://dynectemail.tenderapp.com/help/kb/api/introduction-to-dynect-email-deliverys-api) for more information on what parameters are available.
+
+## Contributing
+
+1. Fork the [official repository](https://github.com/Shopify/dynect_email).
+2. Make your changes in a topic branch.
+3. Send a pull request.
+
+Notes:
+
+* Contributions without tests won't be accepted.
+* Please don't update the Gem version.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Test DynectEmail'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/dynect_email.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dynect_email/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dynect_email"
+  s.version     = DynectEmail::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Duff"]
+  s.email       = ["john.duff@shopify.com"]
+  s.homepage    = "https://github.com/Shopify/dynect_email"
+  s.summary     = %q{Integrate with the DynECT Email API.}
+  s.description = %q{Provides integration with the DynECT Email API.}
+
+  s.rubyforge_project = "dynect_email"
+
+  s.add_runtime_dependency("httparty")
+  s.add_development_dependency("fakeweb")
+  s.add_development_dependency("mocha")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/dynect_email.rb

@@ -0,0 +1,46 @@
+require 'httparty'
+require 'ostruct'
+module DynectEmail
+  class Error < StandardError; end
+
+  include HTTParty
+  base_uri 'http://emailapi.dynect.net/rest/json'
+  class << self
+    attr_accessor :api_key
+  end
+
+  def self.add_sender(email, apikey=nil)
+    post_data("/senders", {:emailaddress => email}, apikey)
+  end
+
+  def self.remove_sender(email, apikey=nil)
+    post_data("/senders/delete", {:emailaddress => email}, apikey)
+  end
+
+  def self.add_account(username, password, company, phone, options={})
+    post_data("/accounts", options.merge({:username => username, :password => password, :companyname => company, :phone => phone}))
+  end
+
+  def self.remove_account(username)
+    post_data("/accounts/delete", :username => username)
+  end
+
+  # {:xheader1 => "X-header", xheader2 => ....}
+  def self.set_headers(headers, apikey=nil)
+    post_data("/accounts/xheaders", headers, apikey)
+  end
+
+  private
+  def self.handle_response(response)
+    message = response['response']['message']
+    raise DynectEmail::Error, message unless message == 'OK'
+    response['response']['data']
+  end
+
+  def self.post_data(url, options={}, apikey=nil)
+    options.merge!(:apikey => apikey || DynectEmail.api_key)
+    result = post(url, :body => options)
+
+    handle_response(result)
+  end
+end

data/lib/dynect_email/version.rb

@@ -0,0 +1,3 @@
+module DynectEmail
+  VERSION = "0.0.1"
+end

data/test/dynect_email_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+class DynectEmailTest < Test::Unit::TestCase
+
+  def setup
+    DynectEmail.api_key = "12345"
+  end
+
+  def teardown
+    FakeWeb.allow_net_connect = false
+  end
+
+  def test_missing_or_invalid_api_key
+    DynectEmail.api_key = ""
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/senders", :body => load_fixture('missing_or_invalid_api_key'), :status => 451, :content_type => "text/json")
+
+    DynectEmail.api_key = ""
+    error = assert_raise DynectEmail::Error do
+      result = DynectEmail.add_sender("test@example.com")
+    end
+
+    assert_equal "Missing or Invalid API Key", error.message
+  end
+
+  def test_missing_or_invalid_field
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/accounts", :body => load_fixture('missing_or_invalid_fields'), :status => 451, :content_type => "text/json")
+
+    error = assert_raise DynectEmail::Error do
+      DynectEmail.add_account("test@example.com", "test", nil, nil)
+    end
+
+    assert_equal "Missing or Invalid Required Fields", error.message
+  end
+
+  def test_add_account
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/accounts", :body => load_fixture('ok'), :status => 200, :content_type => "text/json")
+
+    response = DynectEmail.add_account("test@example.com", "test", "Shopify", "1231231234")
+
+    assert_equal "1234", response['apikey']
+  end
+
+  def test_add_account_sends_correct_parameters
+    DynectEmail.expects(:post).with("/accounts", :body => {:username => "test@example.com", :password => "test", :companyname => "Shopify", :phone => "1231231234", :apikey => "12345"})
+    DynectEmail.expects(:handle_response)
+
+    DynectEmail.add_account("test@example.com", "test", "Shopify", "1231231234")
+  end
+
+  def test_add_sender
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/senders", :body => load_fixture('ok'), :status => 200, :content_type => "text/json")
+
+    assert_nothing_raised do
+      DynectEmail.add_sender("test@example.com")
+    end
+  end
+
+  def test_add_sender_sends_correct_parameters
+    DynectEmail.expects(:post).with("/senders", :body => {:emailaddress => "test@example.com", :apikey => "12345"})
+    DynectEmail.expects(:handle_response)
+
+    DynectEmail.add_sender("test@example.com")
+  end
+
+  def test_add_sender_duplicate
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/senders", :body => load_fixture('object_already_exists'), :status => 453, :content_type => "text/json")
+
+    error = assert_raise DynectEmail::Error do
+      DynectEmail.add_sender("test@example.com")
+    end
+
+    assert_equal "Object Already Exists", error.message
+  end
+
+  def test_add_sender_with_apikey
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/senders", :body => load_fixture('ok'), :status => 200, :content_type => "text/json")
+
+    assert_nothing_raised do
+      DynectEmail.add_sender("test@example.com", "123")
+    end
+  end
+
+  def test_add_sender_with_api_key_sends_correct_parameters
+    DynectEmail.expects(:post).with("/senders", :body => {:emailaddress => "test@example.com", :apikey => "123"})
+    DynectEmail.expects(:handle_response)
+
+    DynectEmail.add_sender("test@example.com", "123")
+  end
+
+  def test_remove_sender
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/senders/delete", :body => load_fixture('ok'), :status => 200, :content_type => "text/json")
+
+    assert_nothing_raised do
+      DynectEmail.remove_sender("test@example.com")
+    end
+  end
+
+  def test_remove_sender_sends_correct_parameters
+    DynectEmail.expects(:post).with("/senders/delete", :body => {:emailaddress => "test@example.com", :apikey => "12345"})
+    DynectEmail.expects(:handle_response)
+
+    DynectEmail.remove_sender("test@example.com")
+  end
+
+  def test_remove_account
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/accounts/delete", :body => load_fixture('ok'), :status => 200, :content_type => "text/json")
+
+    assert_nothing_raised do
+      DynectEmail.remove_account("test@example.com")
+    end
+  end
+
+  def test_remove_account_sends_correct_parameters
+    DynectEmail.expects(:post).with("/accounts/delete", :body => {:username => "test@example.com", :apikey => "12345"})
+    DynectEmail.expects(:handle_response)
+
+    DynectEmail.remove_account("test@example.com")
+  end
+
+  def test_set_headers
+    FakeWeb.register_uri(:post, "http://emailapi.dynect.net/rest/json/accounts/xheaders", :body => load_fixture('ok'), :status => 200, :content_type => "text/json")
+
+    assert_nothing_raised do
+      DynectEmail.set_headers({:xheader1 => "X-Sample1", :xheader2 => "X-Sample2"})
+    end
+  end
+
+  def test_set_headers_sends_correct_parameters
+    DynectEmail.expects(:post).with("/accounts/xheaders", :body => {:xheader1 => "X-Sample1", :xheader2 => "X-Sample2", :apikey => "12345"})
+    DynectEmail.expects(:handle_response)
+
+    DynectEmail.set_headers({:xheader1 => "X-Sample1", :xheader2 => "X-Sample2"})
+  end
+end

data/test/fixtures/missing_or_invalid_api_key.json

@@ -0,0 +1 @@
+{"response":{"status":453,"message":"Missing or Invalid API Key","data":{}}}

data/test/fixtures/missing_or_invalid_fields.json

@@ -0,0 +1 @@
+{"response":{"status":452,"message":"Missing or Invalid Required Fields","data":["The company name can not be blank.","The phone number can not be blank."]}}

data/test/fixtures/object_already_exists.json

@@ -0,0 +1 @@
+{"response":{"status":451,"message":"Object Already Exists","data":{}}}

data/test/fixtures/ok.json

@@ -0,0 +1 @@
+{"response":{"status":200,"message":"OK","data":{"apikey":"1234"}}}

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'fakeweb'
+require 'mocha'
+require 'lib/dynect_email'
+
+FakeWeb.allow_net_connect = false
+
+class Test::Unit::TestCase
+
+  def load_fixture(name)
+    File.read(File.dirname(__FILE__) + "/fixtures/#{name}.json")
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: dynect_email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Duff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2156801220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156801220
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2156800780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156800780
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2156800360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156800360
+description: Provides integration with the DynECT Email API.
+email:
+- john.duff@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- dynect_email.gemspec
+- lib/dynect_email.rb
+- lib/dynect_email/version.rb
+- test/dynect_email_test.rb
+- test/fixtures/missing_or_invalid_api_key.json
+- test/fixtures/missing_or_invalid_fields.json
+- test/fixtures/object_already_exists.json
+- test/fixtures/ok.json
+- test/test_helper.rb
+homepage: https://github.com/Shopify/dynect_email
+licenses: []
+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: dynect_email
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Integrate with the DynECT Email API.
+test_files:
+- test/dynect_email_test.rb
+- test/fixtures/missing_or_invalid_api_key.json
+- test/fixtures/missing_or_invalid_fields.json
+- test/fixtures/object_already_exists.json
+- test/fixtures/ok.json
+- test/test_helper.rb