mailstro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfb6f6f8d8402d20a20f56153d3cab92a269f810
+  data.tar.gz: 91bebe9ce5c5c57ba696b558efaa9345f4224b1d
+SHA512:
+  metadata.gz: 442beb7b0c5cd4455dd7ea909c10b34cda4a7ef09dad54f27ffbff8f46379661fb1dc42f0df60ff4e551b39cd457d80942ad9494ecde1e6363c4753d13cdb03f
+  data.tar.gz: 7e06752aac384dd4b78e0e26db7670991cf25344e5055a4b51513d80c2e0a37bdfde9a8f5e69230baeff0e5d225e533456698ebeca83781d112bea73bade88a0

data/.env-sample

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

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env
+.rbenv-vars

data/.rspec

@@ -0,0 +1,3 @@
+--backtrace
+--color
+--format doc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Keith Pitt
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  puts "rspec no available"
+end
+
+task :default => ['spec']

data/Readme.md

@@ -0,0 +1,51 @@
+# Mailstro Client for Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+1.  Add the `mailstro` gem to your `Gemfile`
+
+    ```ruby
+    gem "mailstro"
+    ```
+
+2.  Install the gem
+
+    ```shell
+    bundle install
+    ```
+
+3.  Configure the mailstro module with your API key.
+
+    In rails apps, put this code to a new file at `config/initializers/mailstro.rb`
+
+    ```ruby
+    require 'mailstro'
+
+    Mailstro.configure do |config|
+      config.api_key = "YOUR_API_KEY_HERE"
+    end
+    ```
+
+## Usage
+
+To send an email with the template name `welcome` use the following:
+
+```ruby
+Mailstro.deliver(:welcome, :recipient => { :email => "test@example.com" }, :payload => { :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
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/mailstro/configuration.rb

@@ -0,0 +1,14 @@
+module Mailstro
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :endpoint
+    attr_accessor :use_ssl
+    attr_accessor :api_version
+
+    def initialize
+      @use_ssl      = true
+      @endpoint     = 'api.mailstro.co'
+      @api_version  = 1
+    end
+  end
+end

data/lib/mailstro/delivery.rb

@@ -0,0 +1,56 @@
+module Mailstro
+  class Delivery
+    require 'net/http'
+    require 'openssl'
+    require 'json'
+
+    attr_reader :template, :recipient, :payload
+
+    def self.deliver(*args)
+      new(*args).deliver
+    end
+
+    def initialize(template, options)
+      @template  = template
+      @recipient = options[:recipient]
+      @payload   = options[: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 = http.request(request)
+
+      # response.status
+      # response["header-here"] # All headers are lowercase
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def post_data
+      { '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
+    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"
+    end
+  end
+end

data/lib/mailstro/rspec.rb

@@ -0,0 +1,15 @@
+require 'mailstro/test'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Mailstro::Test.enable
+  end
+
+  config.after(:suite) do
+    Mailstro::Test.disable
+  end
+
+  config.before(:each) do
+    Mailstro::Test.clear_deliveries
+  end
+end

data/lib/mailstro/test.rb

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

data/lib/mailstro/version.rb

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

data/lib/mailstro.rb

@@ -0,0 +1,18 @@
+require "mailstro/version"
+require "mailstro/configuration"
+require "mailstro/delivery"
+
+module Mailstro
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.deliver(*args)
+    Delivery.deliver(*args)
+  end
+end

data/mailmask-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailstro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailstro"
+  spec.version       = Mailstro::VERSION
+  spec.authors       = ["Keith Pitt"]
+  spec.email         = ["me@keithpitt.com"]
+  spec.description   = %q{Ruby notifier for mailstro.co}
+  spec.summary       = %q{Ruby notifier for mailstro.co}
+  spec.homepage      = "http://www.mailstro.co"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/integration/delivery_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Mailstro::Delivery, :integration do
+  let(:template)  { :test }
+  let(:recipient) { { :email => "test@example.com" } }
+  let(:payload)   { { :greeting => "Gday!" } }
+
+  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']
+    end
+  end
+
+  it "succesfully submits a delivery to mailstro" do
+    pending
+    response = Mailstro.deliver(template, :recipient => recipient, :payload => payload)
+    response['ok'].should == true
+  end
+end

data/spec/mailstro/configuration_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Mailstro::Configuration do
+  subject(:configuration) { Mailstro::Configuration.new }
+
+  it "has a default endpoint" do
+    configuration.endpoint.should =~ /mailstro/
+  end
+end

data/spec/mailstro/delivery_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe Mailstro::Delivery do
+  let(:template)  { "name" }
+  let(:recipient) { { :email => "foo@bar.com" } }
+  let(:payload)   { { :data => "here" } }
+
+  describe '.delivery' 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)
+      delivery.should_receive(:deliver)
+
+      Mailstro::Delivery.deliver(template, :recipient => recipient, :payload => payload)
+    end
+  end
+
+  describe "#delivery" do
+    let(:delivery)      { Mailstro::Delivery.new(template, :recipient => recipient, :payload => 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
+end

data/spec/mailstro/test_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'mailstro/test'
+
+describe Mailstro::Test do
+  describe '.enable' do
+    before do
+      Mailstro::Test.enable
+    end
+
+    after do
+      Mailstro::Test.disable
+    end
+
+    it "doesn't send deliveries when enabled" do
+      Mailstro::Delivery.should_not_receive(:deliver).with(:template_name, {})
+
+      Mailstro.deliver(:template_name, {})
+    end
+
+    it "adds the delivery to the deliveries array" do
+      Mailstro.deliver(:template_name, {})
+
+      Mailstro::Test.deliveries.should_not be_empty
+    end
+  end
+
+  describe '.disable' do
+    it 'restores the previous behaviour of .deliver' do
+      Mailstro::Test.enable
+      Mailstro::Test.disable
+      Mailstro::Delivery.should_receive(:deliver).with(:template_name, {})
+
+      Mailstro.deliver(:template_name, {})
+    end
+  end
+
+  describe '.clear_deliveries' do
+    before do
+      Mailstro::Test.enable
+
+      Mailstro.deliver(:template_name, {})
+    end
+
+    after do
+      Mailstro::Test.disable
+    end
+
+    it 'empties out the .deliveries array' do
+      Mailstro::Test.deliveries.should_not be_empty
+      Mailstro::Test.clear_deliveries
+
+      Mailstro::Test.deliveries.should be_empty
+    end
+  end
+
+  describe '.has_delivered?' do
+    before do
+      Mailstro::Test.enable
+    end
+
+    after do
+      Mailstro::Test.disable
+    end
+
+    it 'returns true if there was a delivery matching the template name give' do
+      Mailstro.deliver(:template_name, {})
+
+      Mailstro.has_delivered?(:template => :template_name)
+    end
+  end
+end

data/spec/mailstro/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe "Mailstro::VERSION" do
+  it "returns a version number" do
+    Mailstro::VERSION.should_not be_nil
+  end
+end

data/spec/mailstro_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Mailstro do
+  describe ".configure" do
+    it "allows you to pass a block to configure Mailstro" do
+      Mailstro.configure do |config|
+        config.endpoint = 'mailstro.dev'
+      end
+
+      Mailstro.configuration.endpoint.should == 'mailstro.dev'
+    end
+  end
+
+  describe ".delivery" do
+    let(:template)  { "name" }
+    let(:recipient) { { :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 => recipient, :payload => payload)
+
+      Mailstro.deliver(template, :recipient => recipient, :payload => payload)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'mailstro'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: mailstro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Keith Pitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  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: Ruby notifier for mailstro.co
+email:
+- me@keithpitt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .env-sample
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- lib/mailstro.rb
+- lib/mailstro/configuration.rb
+- lib/mailstro/delivery.rb
+- lib/mailstro/rspec.rb
+- lib/mailstro/test.rb
+- lib/mailstro/version.rb
+- mailmask-ruby.gemspec
+- spec/integration/delivery_spec.rb
+- spec/mailstro/configuration_spec.rb
+- spec/mailstro/delivery_spec.rb
+- spec/mailstro/test_spec.rb
+- spec/mailstro/version_spec.rb
+- spec/mailstro_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.mailstro.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0
+signing_key: 
+specification_version: 4
+summary: Ruby notifier for mailstro.co
+test_files:
+- spec/integration/delivery_spec.rb
+- spec/mailstro/configuration_spec.rb
+- spec/mailstro/delivery_spec.rb
+- spec/mailstro/test_spec.rb
+- spec/mailstro/version_spec.rb
+- spec/mailstro_spec.rb
+- spec/spec_helper.rb