mailstro 0.0.2 → 0.0.3

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in mailstro-ruby.gemspec
+group :test do
+  gem 'webmock'
+end
+
 gemspec

data/Readme.md

@@ -33,15 +33,9 @@ TODO: Write a gem description
 To send an email with the template name `welcome` use the following:
 
 ```ruby
-Mailstro.deliver(:welcome, :recipient => { :email => "test@example.com" }, :payload => { :greeting => "Hi" })
+Mailstro.deliver(:welcome, "test@example.com", :greeting => "Hi")
 ```
 
-## Testing
-
-Copy the `.env-sample` file, and rename it to `.env`. Here, put in your
-Mailstro credentials. This should allow you to run the integration tests
-against your account.
-
 ## Contributing
 
 1. Fork it

data/lib/mailstro/configuration.rb

@@ -1,4 +1,6 @@
 module Mailstro
+  class ConfigurationError < StandardError; end
+
   class Configuration
     attr_accessor :api_key
     attr_accessor :endpoint
@@ -10,5 +12,11 @@ module Mailstro
       @endpoint     = 'api.mailstroapp.com'
       @api_version  = 1
     end
+
+    def validate!
+      if api_key.nil?
+        raise ConfigurationError, "api_key not provided"
+      end
+    end
   end
 end

data/lib/mailstro/delivery.rb

@@ -2,18 +2,17 @@ module Mailstro
   class Delivery
     require 'net/http'
     require 'openssl'
-    require 'json'
 
-    attr_reader :template, :recipient, :payload
+    attr_reader :template, :payload
 
-    def self.deliver(*args)
-      new(*args).deliver
+    def self.deliver(template, recipient, payload)
+      new(template, recipient, payload).deliver
     end
 
-    def initialize(template, options)
+    def initialize(template, recipient, payload)
       @template  = template
-      @recipient = options[:recipient]
-      @payload   = options[:payload]
+      @recipient = recipient
+      @payload   = payload
     end
 
     def deliver
@@ -24,24 +23,26 @@ module Mailstro
       request      = Net::HTTP::Post.new(endpoint_uri.request_uri, { 'Content-Type' =>'application/json' })
       request.body = JSON.generate(post_data)
 
-      response = http.request(request)
-
-      # response.status
-      # response["header-here"] # All headers are lowercase
+      Response.new(http.request(request)).json_body
+    end
 
-      JSON.parse(response.body)
+    def recipient
+      if @recipient.is_a?(String)
+        { :email => @recipient }
+      else
+        @recipient
+      end
     end
 
     private
 
     def post_data
-      { 'template' => template,
+      {
+        'template'  => template,
         'recipient' => recipient,
-        'api_key' => Mailstro.configuration.api_key }.tap do |payload|
-        if self.payload.kind_of?(Hash)
-          payload['payload'] = self.payload
-        end
-      end
+        'payload'   => payload,
+        'api_key'   => Mailstro.configuration.api_key
+      }
     end
 
     def endpoint_uri

data/lib/mailstro/response.rb

@@ -0,0 +1,17 @@
+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/lib/mailstro/test.rb

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

data/lib/mailstro/version.rb

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

data/lib/mailstro.rb

@@ -1,6 +1,7 @@
 require "mailstro/version"
 require "mailstro/configuration"
 require "mailstro/delivery"
+require "mailstro/response"
 
 module Mailstro
   class << self
@@ -10,9 +11,10 @@ module Mailstro
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
+    configuration.validate!
   end
 
-  def self.deliver(*args)
-    Delivery.deliver(*args)
+  def self.deliver(template, recipient, payload = {})
+    Delivery.deliver(template, recipient, payload)
   end
 end

data/{mailmask-ruby.gemspec → mailstro-ruby.gemspec}

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "dotenv"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "vcr"
 end

data/spec/fixtures/postman.json

@@ -0,0 +1 @@
+{ "ok": true }

data/spec/integration/posting_a_delivery_spec.rb

@@ -7,15 +7,31 @@ describe 'posting a delivery', :integration do
 
   before do
     Mailstro.configure do |config|
-      config.use_ssl     = ENV['MAILSTRO_USE_SSL'] == 'true'
-      config.endpoint    = ENV['MAILSTRO_ENDPOINT']
-      config.api_version = ENV['MAILSTRO_API_VERSION']
-      config.api_key     = ENV['MAILSTRO_API_KEY']
+      config.api_key = 'lolapi'
     end
   end
 
-  it "succesfully submits a delivery to mailstro", :vcr do
-    response = Mailstro.deliver(template, :recipient => recipient, :payload => payload)
+  let(:expected_body) {{
+    "api_key"   => "lolapi",
+    "template"  => "test",
+    "recipient" => { "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"))
+
+    response = Mailstro.deliver(template, recipient, 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").
+      to_return(:status => 401)
+
+    expect do
+      Mailstro.deliver(template, recipient, payload)
+    end.to raise_error(Mailstro::AuthorisationError, "api_key not authorised")
+  end
 end

data/spec/mailstro/configuration_spec.rb

@@ -6,4 +6,12 @@ describe Mailstro::Configuration do
   it "has a default endpoint" do
     configuration.endpoint.should =~ /mailstro/
   end
+
+  describe "#validate!" do
+    it "raises an error if an api_key is nil" do
+      expect {
+        subject.validate!
+      }.to raise_error(Mailstro::ConfigurationError)
+    end
+  end
 end

data/spec/mailstro/delivery_spec.rb

@@ -5,19 +5,19 @@ describe Mailstro::Delivery do
   let(:recipient) { { :email => "foo@bar.com" } }
   let(:payload)   { { :data => "here" } }
 
-  describe '.delivery' do
+  describe '.deliver' do
     let(:delivery) { double }
 
-    it "creates an instance of the Delivery and delivers it" do
-      Mailstro::Delivery.should_receive(:new).with(template, :recipient => recipient, :payload => payload).and_return(delivery)
+    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 => recipient, :payload => payload)
+      Mailstro::Delivery.deliver(template, recipient, payload)
     end
   end
 
   describe "#delivery" do
-    let(:delivery)      { Mailstro::Delivery.new(template, :recipient => recipient, :payload => payload) }
+    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 }
@@ -55,4 +55,11 @@ describe Mailstro::Delivery 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

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

data/spec/mailstro/test_spec.rb

@@ -12,13 +12,13 @@ describe Mailstro::Test do
     end
 
     it "doesn't send deliveries when enabled" do
-      Mailstro::Delivery.should_not_receive(:deliver).with(:template_name, {})
+      Mailstro::Delivery.should_not_receive(:deliver).with(:template_name, 'a@a.com', {})
 
-      Mailstro.deliver(:template_name, {})
+      Mailstro.deliver(:template_name, 'a@a.com')
     end
 
     it "adds the delivery to the deliveries array" do
-      Mailstro.deliver(:template_name, {})
+      Mailstro.deliver(:template_name, 'a@a.com')
 
       Mailstro::Test.deliveries.should_not be_empty
     end
@@ -28,9 +28,9 @@ describe Mailstro::Test do
     it 'restores the previous behaviour of .deliver' do
       Mailstro::Test.enable
       Mailstro::Test.disable
-      Mailstro::Delivery.should_receive(:deliver).with(:template_name, {})
+      Mailstro::Delivery.should_receive(:deliver).with(:template_name, 'a@a.com', {})
 
-      Mailstro.deliver(:template_name, {})
+      Mailstro.deliver(:template_name, 'a@a.com')
     end
   end
 
@@ -38,7 +38,7 @@ describe Mailstro::Test do
     before do
       Mailstro::Test.enable
 
-      Mailstro.deliver(:template_name, {})
+      Mailstro.deliver(:template_name, 'a@a.com')
     end
 
     after do
@@ -63,7 +63,7 @@ describe Mailstro::Test do
     end
 
     it 'returns true if there was a delivery matching the template name give' do
-      Mailstro.deliver(:template_name, {})
+      Mailstro.deliver(:template_name, 'a@a.com')
 
       Mailstro.has_delivered?(:template => :template_name)
     end

data/spec/mailstro_spec.rb

@@ -1,9 +1,15 @@
 require 'spec_helper'
 
 describe Mailstro do
+
+  before do
+    Mailstro.configuration = nil
+  end
+
   describe ".configure" do
     it "allows you to pass a block to configure Mailstro" do
       Mailstro.configure do |config|
+        config.api_key  = 'x'
         config.endpoint = 'mailstro.dev'
       end
 
@@ -17,9 +23,9 @@ describe Mailstro do
     let(:payload)   { { :data => "here" } }
 
     it "creates a delivery object and delivers it" do
-      Mailstro::Delivery.should_receive(:deliver).with(template, :recipient => recipient, :payload => payload)
+      Mailstro::Delivery.should_receive(:deliver).with(template, recipient, payload)
 
-      Mailstro.deliver(template, :recipient => recipient, :payload => payload)
+      Mailstro.deliver(template, recipient, payload)
     end
   end
 end

data/spec/support/fixtures.rb

@@ -0,0 +1,3 @@
+def fixture(name)
+  File.read(File.join(FIXTURES_PATH, name))
+end

data/spec/support/webmock.rb

@@ -0,0 +1 @@
+require 'webmock/rspec'

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: mailstro
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
+  prerelease: 
 platform: ruby
 authors:
 - Keith Pitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,50 +22,57 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby notifier for mailstro.co
@@ -73,7 +82,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .env-sample
 - .gitignore
 - .rspec
 - Gemfile
@@ -83,50 +91,56 @@ files:
 - lib/mailstro.rb
 - lib/mailstro/configuration.rb
 - lib/mailstro/delivery.rb
+- lib/mailstro/response.rb
 - lib/mailstro/rspec.rb
 - lib/mailstro/test.rb
 - lib/mailstro/version.rb
-- mailmask-ruby.gemspec
-- spec/fixtures/cassettes/posting_a_delivery/succesfully_submits_a_delivery_to_mailstro.yml
+- mailstro-ruby.gemspec
+- spec/fixtures/postman.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
 - spec/spec_helper.rb
-- spec/support/vcr.rb
+- spec/support/fixtures.rb
+- spec/support/webmock.rb
 homepage: http://www.mailstro.co
 licenses:
 - MIT
-metadata: {}
 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: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby notifier for mailstro.co
 test_files:
-- spec/fixtures/cassettes/posting_a_delivery/succesfully_submits_a_delivery_to_mailstro.yml
+- spec/fixtures/postman.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
 - spec/spec_helper.rb
-- spec/support/vcr.rb
+- spec/support/fixtures.rb
+- spec/support/webmock.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: bf855e15283478602f514d022748a103f567ea4d
-  data.tar.gz: a9574d49338b69186a9d3944a2b2222fa58e4fd5
-SHA512:
-  metadata.gz: 2a529d88fe60006764f3d8219b9c88b271190fab3edd704a6d501e80d3ded776ae58a1c84342c79710626f413ae6a90d619bf676eb046c81f9d72e0d88f4e72b
-  data.tar.gz: b48beeb0cd6a31fbd2bb913e325832db8235eb499a0ecf00c191b984b7154687244a855660cac1e0ceee2826b567f8b5d5c0c799366b27a27963047506f8327e

data/.env-sample

@@ -1,4 +0,0 @@
-MAILMASK_API_KEY=secret
-MAILMASK_ENDPOINT=api.mailmask.co
-MAILMASK_API_VERSION=1
-MAILMASK_USE_SSL=true

data/spec/fixtures/cassettes/posting_a_delivery/succesfully_submits_a_delivery_to_mailstro.yml

@@ -1,54 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: http://ENDPOINT/v1/postman
-    body:
-      encoding: UTF-8
-      string: '{"template":"test","recipient":{"email":"test@example.com"},"api_key":"API_KEY","payload":{"greeting":"Gday!"}}'
-    headers:
-      Content-Type:
-      - application/json
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - '*/*'
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      X-Frame-Options:
-      - SAMEORIGIN
-      X-Xss-Protection:
-      - 1; mode=block
-      X-Content-Type-Options:
-      - nosniff
-      X-Ua-Compatible:
-      - chrome=1
-      X-Xhr-Current-Location:
-      - /v1/postman
-      Content-Type:
-      - application/json; charset=utf-8
-      Etag:
-      - '"82380d1e263b6093f3c7535690fcdd75"'
-      Cache-Control:
-      - max-age=0, private, must-revalidate
-      Set-Cookie:
-      - request_method=POST; path=/
-      X-Request-Id:
-      - 7c8249cb-b3d6-4108-8a97-dba45471019a
-      X-Runtime:
-      - '0.084302'
-      Vary:
-      - Accept-Encoding
-      Connection:
-      - close
-    body:
-      encoding: UTF-8
-      string: '{"ok":true}'
-    http_version: 
-  recorded_at: Tue, 21 May 2013 10:17:29 GMT
-recorded_with: VCR 2.5.0

data/spec/support/vcr.rb

@@ -1,9 +0,0 @@
-require 'vcr'
-
-VCR.configure do |config|
-  config.cassette_library_dir = FIXTURES_PATH.join('cassettes')
-  config.hook_into :webmock
-  config.filter_sensitive_data('API_KEY') { ENV['MAILSTRO_API_KEY'] }
-  config.filter_sensitive_data('ENDPOINT') { ENV['MAILSTRO_ENDPOINT'] }
-  config.configure_rspec_metadata!
-end