mailstro 0.0.10 → 0.1.0

data/Readme.md

@@ -1,6 +1,6 @@
 # Mailstro Client for Ruby
 
-TODO: Write a gem description
+A quick and easy way to send emails from your ruby application.
 
 ## Installation
 
@@ -21,19 +21,29 @@ TODO: Write a gem description
     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
     ```
 
+    By default, mailstro operates in test mode. This ensures accidental emails are not sent
+    in development or staging environments.
+
+    In rails apps, put this code to a new file at `config/environments/production.rb`
+
+    ```ruby
+    # Enable production mode, and start sending real emails.
+    Mailstro.configure do |config|
+      config.enabled = true
+    end
+    ```
+
 ## Usage
 
 Sending a basic email.
 
 ```ruby
-Mailstro.deliver(:welcome
+Mailstro.deliver(:welcome,
   :to => 'shanon@mailstroapp.com',
   :data => {
     :coupon_code => 'THANKS01'
@@ -52,7 +62,7 @@ require 'mailsto/rspec'
 Verify emails are being sent with simple matchers.
 
 ```ruby
-Mailstro.deliver(:welcome
+Mailstro.deliver(:welcome,
   :to => 'shanon@mailstroapp.com'
 )
 

data/lib/mailstro.rb

@@ -1,15 +1,16 @@
 require 'faraday'
 
-require_relative "mailstro/version"
-require_relative "mailstro/configuration"
-require_relative "mailstro/error"
-require_relative "mailstro/resource"
-require_relative "mailstro/delivery"
+require_relative 'mailstro/version'
+require_relative 'mailstro/configuration'
+require_relative 'mailstro/error'
+require_relative 'mailstro/resource'
+require_relative 'mailstro/delivery'
+require_relative 'mailstro/test_strategy'
 
-module Mailstro
 
-  # Allows us to remove default behaviour during testing.
-  class RealStrategy
+module Mailstro
+  # We want this disabled by default to avoid accidental emails.
+  class ProductionStrategy
     class << self
       def deliver(email_name, options)
         Delivery.new(email_name, options).deliver
@@ -21,7 +22,7 @@ module Mailstro
     attr_accessor :configuration, :strategy
   end
 
-  @strategy      = RealStrategy
+  @strategy      = TestStrategy
   @configuration = Configuration.new
 
   def self.configure

data/lib/mailstro/configuration.rb

@@ -2,11 +2,20 @@ module Mailstro
   class Configuration
     attr_accessor :api_endpoint
     attr_accessor :api_key
+    attr_accessor :enabled
 
     def initialize
       @api_endpoint = 'https://api.mailstroapp.com/v1'
     end
 
+    def enabled=(value)
+      if value
+        Mailstro.strategy = ProductionStrategy
+      else
+        Mailstro.strategy = TestStrategy
+      end
+    end
+
     def validate!
       raise Error::ConfigurationError, "api_key not provided" if api_key.nil?
     end

data/lib/mailstro/error.rb

@@ -3,5 +3,6 @@ module Mailstro
     class ConfigurationError < StandardError; end
     class AuthorisationError < Faraday::Error::ClientError; end
     class ValidationError    < StandardError; end
+    class MailstroError      < StandardError; end
   end
 end

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

@@ -8,6 +8,8 @@ module Mailstro
             raise Error::AuthorisationError.new("api_key not authorised", env)
           when 422
             raise Error::ValidationError.new(env[:body][:errors])
+          when 500
+            raise Error::MailstroError.new(env[:body])
           else
             super
           end

data/lib/mailstro/rspec.rb

@@ -1,10 +1,4 @@
-require 'mailstro/test_strategy'
-
 RSpec.configure do |config|
-  config.before(:suite) do
-    Mailstro::TestStrategy.enable
-  end
-
   config.after(:each) do
     Mailstro::TestStrategy.clear
   end

data/lib/mailstro/version.rb

@@ -1,3 +1,3 @@
 module Mailstro
-  VERSION = "0.0.10"
+  VERSION = "0.1.0"
 end

data/spec/integration/delivery_spec.rb

@@ -8,6 +8,7 @@ describe 'posting a delivery', :integration do
   before do
     Mailstro.configure do |config|
       config.api_key = 'lolapi'
+      config.enabled = true
     end
   end
 

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ Dir[SPEC_PATH.join("support/**/*.rb")].each { |f| require f }
 RSpec.configure do |config|
   config.after(:each) do
     Mailstro::TestStrategy.clear
-    Mailstro.strategy = Mailstro::RealStrategy
+    Mailstro.strategy = Mailstro::ProductionStrategy
   end
 
   config.order = "random"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailstro
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-05 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday