mailstro 0.0.3 → 0.0.4

data/lib/mailstro/configuration.rb

@@ -1,22 +1,14 @@
 module Mailstro
-  class ConfigurationError < StandardError; end
-
   class Configuration
+    attr_accessor :api_endpoint
     attr_accessor :api_key
-    attr_accessor :endpoint
-    attr_accessor :use_ssl
-    attr_accessor :api_version
 
     def initialize
-      @use_ssl      = true
-      @endpoint     = 'api.mailstroapp.com'
-      @api_version  = 1
+      @api_endpoint = 'https://api.mailstroapp.com/v1'
     end
 
     def validate!
-      if api_key.nil?
-        raise ConfigurationError, "api_key not provided"
-      end
+      raise Error::ConfigurationError, "api_key not provided" if api_key.nil?
     end
   end
 end

data/lib/mailstro/delivery.rb

@@ -1,57 +1,21 @@
 module Mailstro
-  class Delivery
-    require 'net/http'
-    require 'openssl'
-
-    attr_reader :template, :payload
-
-    def self.deliver(template, recipient, payload)
-      new(template, recipient, payload).deliver
-    end
-
-    def initialize(template, recipient, payload)
-      @template  = template
-      @recipient = recipient
-      @payload   = payload
-    end
-
-    def deliver
-      http             = Net::HTTP.new(endpoint_uri.host, endpoint_uri.port)
-      http.use_ssl     = endpoint_uri.scheme == "https"
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-      request      = Net::HTTP::Post.new(endpoint_uri.request_uri, { 'Content-Type' =>'application/json' })
-      request.body = JSON.generate(post_data)
-
-      Response.new(http.request(request)).json_body
-    end
-
-    def recipient
-      if @recipient.is_a?(String)
-        { :email => @recipient }
-      else
-        @recipient
-      end
+  class Delivery < Resource
+    def self.deliver(template_name, contact_email, payload)
+      new(template_name, contact_email, payload).deliver
     end
 
-    private
+    attr_reader :contact_email, :template_name
 
-    def post_data
-      {
-        'template'  => template,
-        'recipient' => recipient,
-        'payload'   => payload,
-        'api_key'   => Mailstro.configuration.api_key
-      }
+    def initialize(template_name, contact_email, payload)
+      @template_name = template_name
+      @contact_email = contact_email
+      @payload       = payload
     end
 
-    def endpoint_uri
-      @endpoint_uri ||= URI.parse(endpoint)
-    end
-
-    def endpoint
-      (Mailstro.configuration.use_ssl ? "https://" : "http://") +
-        "#{Mailstro.configuration.endpoint}/v#{Mailstro.configuration.api_version}/postman"
+    def deliver
+      post("deliveries", :template_name => @template_name,
+                         :contact_email => @contact_email,
+                         :payload       => @payload)
     end
   end
 end

data/lib/mailstro/error.rb

@@ -0,0 +1,9 @@
+require 'faraday'
+
+module Mailstro
+  module Error
+    class ConfigurationError < StandardError; end
+    class AuthorisationError < Faraday::Error::ClientError; end
+    class ValidationError    < StandardError; end
+  end
+end

data/lib/mailstro/middleware/response/raise_error.rb

@@ -0,0 +1,18 @@
+module Mailstro
+  module Middleware
+    module Response
+      class RaiseError < Faraday::Response::RaiseError
+        def on_complete(env)
+          case env[:status]
+          when 401
+            raise Error::AuthorisationError.new("api_key not authorised", env)
+          when 422
+            raise Error::ValidationError.new(env[:body][:errors])
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mailstro/resource.rb

@@ -0,0 +1,38 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie/mash'
+
+require_relative 'middleware/response/raise_error'
+
+module Mailstro
+  class Resource
+    private
+
+    def params(params)
+      params.merge(:api_key => Mailstro.configuration.api_key)
+    end
+
+    def post(path, body = {})
+      connection.post(path) do |request|
+        request.headers = {
+          'Content-Type' => 'application/json'
+        }
+        request.body = params(body)
+      end.body
+    end
+
+    def connection
+      @connection ||= Faraday.new(:url => Mailstro.configuration.api_endpoint) do |faraday|
+        faraday.use Mailstro::Middleware::Response::RaiseError
+
+        faraday.request :url_encoded
+        faraday.request :json
+
+        faraday.response :mashify
+        faraday.response :json
+
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/mailstro/test.rb

@@ -12,30 +12,30 @@ module Mailstro
     end
 
     def self.enable
-      def Mailstro.deliver(template, recipient, payload = {})
-        Mailstro::Test.deliveries << Mailstro::Delivery.new(template, recipient, payload)
+      def Mailstro.deliver(template_name, contact_email, payload = {})
+        Mailstro::Test.deliveries << Mailstro::Delivery.new(template_name, contact_email, payload)
         true # insert response here
       end
 
-      def Mailstro.has_delivered?(template)
-        Mailstro::Test.has_delivered?(template)
+      def Mailstro.has_delivered?(template_name)
+        Mailstro::Test.has_delivered?(template_name)
       end
 
       @@enabled = true
     end
 
     def self.disable
-      def Mailstro.deliver(template, recipient, payload = {})
-        Mailstro::Delivery.deliver(template, recipient, payload)
+      def Mailstro.deliver(template_name, contact_email, payload = {})
+        Mailstro::Delivery.deliver(template_name, contact_email, payload)
       end
 
       @@enabled = false
     end
 
-    def self.has_delivered?(template)
-      templates = @@deliveries.map(&:template)
+    def self.has_delivered?(template_name)
+      templates = @@deliveries.map(&:template_name)
 
-      templates.include?(template)
+      templates.include?(template_name)
     end
   end
 end

data/lib/mailstro/version.rb

@@ -1,3 +1,3 @@
 module Mailstro
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/mailstro.rb

@@ -1,9 +1,11 @@
-require "mailstro/version"
-require "mailstro/configuration"
-require "mailstro/delivery"
-require "mailstro/response"
+require_relative "mailstro/version"
+require_relative "mailstro/configuration"
+require_relative "mailstro/resource"
+require_relative "mailstro/error"
+require_relative "mailstro/delivery"
 
 module Mailstro
+
   class << self
     attr_accessor :configuration
   end
@@ -14,7 +16,7 @@ module Mailstro
     configuration.validate!
   end
 
-  def self.deliver(template, recipient, payload = {})
-    Delivery.deliver(template, recipient, payload)
+  def self.deliver(template, contact_email, payload = {})
+    Delivery.deliver(template, contact_email, payload)
   end
 end

data/mailstro-ruby.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_dependency             "faraday"
+  spec.add_dependency             "faraday_middleware"
+  spec.add_dependency             "hashie"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/integration/posting_a_delivery_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe 'posting a delivery', :integration do
-  let(:template)  { :test }
-  let(:recipient) { { :email => "test@example.com" } }
-  let(:payload)   { { :greeting => "Gday!" } }
+  let(:template_name) { :test }
+  let(:contact_email) { "test@example.com" }
+  let(:payload)       { { :greeting => "Gday!" } }
 
   before do
     Mailstro.configure do |config|
@@ -12,26 +12,26 @@ describe 'posting a delivery', :integration do
   end
 
   let(:expected_body) {{
-    "api_key"   => "lolapi",
-    "template"  => "test",
-    "recipient" => { "email" => "test@example.com" },
-    "payload"   => { "greeting" => "Gday!" }
+    "api_key"       => "lolapi",
+    "template_name" => "test",
+    "contact_email" => "test@example.com",
+    "payload"       => { "greeting" => "Gday!" }
   }}
 
   it "succesfully submits a delivery to mailstro" do
-    stub_request(:post, "https://api.mailstroapp.com/v1/postman").
-    with(:body => expected_body).to_return(:status => 200, :body => fixture("postman.json"))
+    stub_request(:post, "https://api.mailstroapp.com/v1/deliveries").
+    with(:body => expected_body).to_return(:status => 200, :body => fixture("deliveries.json"))
 
-    response = Mailstro.deliver(template, recipient, payload)
+    response = Mailstro.deliver(template_name, contact_email, payload)
     response['ok'].should == true
   end
 
   it "raises an error if the api key is not authorized" do
-    stub_request(:post, "https://api.mailstroapp.com/v1/postman").
+    stub_request(:post, "https://api.mailstroapp.com/v1/deliveries").
       to_return(:status => 401)
 
     expect do
-      Mailstro.deliver(template, recipient, payload)
-    end.to raise_error(Mailstro::AuthorisationError, "api_key not authorised")
+      Mailstro.deliver(template_name, contact_email, payload)
+    end.to raise_error(Mailstro::Error::AuthorisationError, "api_key not authorised")
   end
 end

data/spec/mailstro/configuration_spec.rb

@@ -3,15 +3,15 @@ require 'spec_helper'
 describe Mailstro::Configuration do
   subject(:configuration) { Mailstro::Configuration.new }
 
-  it "has a default endpoint" do
-    configuration.endpoint.should =~ /mailstro/
+  it "has a default api endpoint" do
+    configuration.api_endpoint.should == "https://api.mailstroapp.com/v1"
   end
 
   describe "#validate!" do
     it "raises an error if an api_key is nil" do
       expect {
         subject.validate!
-      }.to raise_error(Mailstro::ConfigurationError)
+      }.to raise_error(Mailstro::Error::ConfigurationError)
     end
   end
 end

data/spec/mailstro_spec.rb

@@ -10,22 +10,22 @@ describe Mailstro do
     it "allows you to pass a block to configure Mailstro" do
       Mailstro.configure do |config|
         config.api_key  = 'x'
-        config.endpoint = 'mailstro.dev'
+        config.api_endpoint = 'mailstro.dev'
       end
 
-      Mailstro.configuration.endpoint.should == 'mailstro.dev'
+      Mailstro.configuration.api_endpoint.should == 'mailstro.dev'
     end
   end
 
   describe ".delivery" do
     let(:template)  { "name" }
-    let(:recipient) { { :email => "foo@bar.com" } }
+    let(:contact)   { { :email => "foo@bar.com" } }
     let(:payload)   { { :data => "here" } }
 
     it "creates a delivery object and delivers it" do
-      Mailstro::Delivery.should_receive(:deliver).with(template, recipient, payload)
+      Mailstro::Delivery.should_receive(:deliver).with(template, contact, payload)
 
-      Mailstro.deliver(template, recipient, payload)
+      Mailstro.deliver(template, contact, payload)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailstro
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-09-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -91,16 +139,16 @@ files:
 - lib/mailstro.rb
 - lib/mailstro/configuration.rb
 - lib/mailstro/delivery.rb
-- lib/mailstro/response.rb
+- lib/mailstro/error.rb
+- lib/mailstro/middleware/response/raise_error.rb
+- lib/mailstro/resource.rb
 - lib/mailstro/rspec.rb
 - lib/mailstro/test.rb
 - lib/mailstro/version.rb
 - mailstro-ruby.gemspec
-- spec/fixtures/postman.json
+- spec/fixtures/deliveries.json
 - spec/integration/posting_a_delivery_spec.rb
 - spec/mailstro/configuration_spec.rb
-- spec/mailstro/delivery_spec.rb
-- spec/mailstro/response_spec.rb
 - spec/mailstro/test_spec.rb
 - spec/mailstro/version_spec.rb
 - spec/mailstro_spec.rb
@@ -133,11 +181,9 @@ signing_key:
 specification_version: 3
 summary: Ruby notifier for mailstro.co
 test_files:
-- spec/fixtures/postman.json
+- spec/fixtures/deliveries.json
 - spec/integration/posting_a_delivery_spec.rb
 - spec/mailstro/configuration_spec.rb
-- spec/mailstro/delivery_spec.rb
-- spec/mailstro/response_spec.rb
 - spec/mailstro/test_spec.rb
 - spec/mailstro/version_spec.rb
 - spec/mailstro_spec.rb

data/lib/mailstro/response.rb

@@ -1,17 +0,0 @@
-module Mailstro
-  class AuthorisationError < StandardError; end
-
-  class Response
-    require 'json'
-
-    def initialize(raw)
-      @raw = raw
-    end
-
-    def json_body
-      raise AuthorisationError.new("api_key not authorised") if @raw.code.to_i == 401
-
-      JSON.parse(@raw.body)
-    end
-  end
-end

data/spec/mailstro/delivery_spec.rb

@@ -1,65 +0,0 @@
-require "spec_helper"
-
-describe Mailstro::Delivery do
-  let(:template)  { "name" }
-  let(:recipient) { { :email => "foo@bar.com" } }
-  let(:payload)   { { :data => "here" } }
-
-  describe '.deliver' do
-    let(:delivery) { double }
-
-    it "creates an instance and delivers it" do
-      Mailstro::Delivery.should_receive(:new).with(template, recipient, payload).and_return(delivery)
-      delivery.should_receive(:deliver)
-
-      Mailstro::Delivery.deliver(template, recipient, payload)
-    end
-  end
-
-  describe "#delivery" do
-    let(:delivery)      { Mailstro::Delivery.new(template, recipient, payload) }
-    let(:request)       { double.as_null_object }
-    let(:response)      { double(:body => '{ "status": "OK" }').as_null_object }
-    let(:http)          { double(:request => response).as_null_object }
-    let(:configuration) { double(:use_ssl => true, :endpoint => 'foo.com', :api_version => '2', :api_key => '1234') }
-
-    before do
-      Mailstro.stub(:configuration => configuration)
-      Net::HTTP.should_receive(:new).with('foo.com', 443).and_return(http)
-      Net::HTTP::Post.should_receive(:new).with('/v2/postman', { "Content-Type"=>"application/json" }).and_return(request)
-    end
-
-    it "sends a json payload to the mailstro server" do
-      http.should_receive(:request).with(request).and_return(response)
-
-      delivery.deliver
-    end
-
-    it "generates the correct payload" do
-      expected_form_data = {
-        'template'  => 'name',
-        'recipient' => { 'email' => 'foo@bar.com' },
-        'payload'   => { 'data' => 'here' },
-        'api_key'   => '1234'
-      }
-
-      request.should_receive(:body=) do |body|
-        parsed_body = JSON.parse(body)
-        parsed_body.should == expected_form_data
-      end
-
-      delivery.deliver
-    end
-
-    it "parses the JSON response" do
-      delivery.deliver['status'].should == 'OK'
-    end
-  end
-
-  describe "#recipient" do
-    it "handles short and long versions" do
-      Mailstro::Delivery.new(nil, 'a@a.com', nil).recipient.should               == { :email => 'a@a.com' }
-      Mailstro::Delivery.new(nil, { :email => 'a@a.com' }, nil).recipient.should == { :email => 'a@a.com' }
-    end
-  end
-end

data/spec/mailstro/response_spec.rb

@@ -1,27 +0,0 @@
-require "spec_helper"
-
-describe Mailstro::Response do
-  let(:http_response) { double(:code => http_status, :body => http_body) }
-  let(:http_status)   { 200 }
-  let(:http_body)     { '{ "status": "OK" }' }
-
-  subject(:response) { Mailstro::Response.new(http_response) }
-
-  describe "#json_body" do
-    context "when successful" do
-      it "returns the html body as JSON" do
-        response.json_body['status'].should == 'OK'
-      end
-    end
-
-    context "when authentication fails" do
-      let(:http_status) { 401 }
-
-      it "raises an error to alert the user" do
-        expect {
-          response.json_body
-        }.to raise_error(Mailstro::AuthorisationError)
-      end
-    end
-  end
-end