mailstro 0.0.4 → 0.0.5

data/Readme.md

@@ -30,10 +30,20 @@ TODO: Write a gem description
 
 ## Usage
 
-To send an email with the template name `welcome` use the following:
+To send a 'welcome' email use the following:
 
 ```ruby
-Mailstro.deliver(:welcome, "test@example.com", :greeting => "Hi")
+Mailstro.deliver(:welcome, "shanon@mailstroapp.com", :greeting => "Hi")
+```
+
+To send a 'thank_you' email to a list of 'customers' use the following:
+
+```ruby
+Mailstro.list_subscribe(:customers, 'jack@mailstroapp.com')
+Mailstro.list_subscribe(:customers, 'fred@mailstroapp.com')
+Mailstro.list_unsubscribe(:customers, 'jack@mailstroapp.com')
+
+Mailstro.list_deliver(:customers, :welcome, :greeting => "Hi")
 ```
 
 ## Contributing

data/lib/mailstro/list_delivery.rb

@@ -0,0 +1,21 @@
+module Mailstro
+  class ListDelivery < Resource
+    def self.deliver(template_name, list_name, payload)
+      new(template_name, list_name, payload).deliver
+    end
+
+    attr_reader :list_name, :template_name
+
+    def initialize(template_name, list_name, payload)
+      @template_name = template_name
+      @list_name     = list_name
+      @payload       = payload
+    end
+
+    def deliver
+      post("lists/deliveries", :template_name => @template_name,
+                               :list_name     => @list_name,
+                               :payload       => @payload)
+    end
+  end
+end

data/lib/mailstro/list_subscribe.rb

@@ -0,0 +1,19 @@
+module Mailstro
+  class ListSubscribe < Resource
+    def self.subscribe(list_name, contact_email)
+      new(list_name, contact_email).deliver
+    end
+
+    attr_reader :list_name, :contact_email
+
+    def initialize(list_name, contact_email)
+      @list_name     = list_name
+      @contact_email = contact_email
+    end
+
+    def deliver
+      post("lists/subscribers", :list_name     => @list_name,
+                                :contact_email => @contact_email)
+    end
+  end
+end

data/lib/mailstro/list_unsubscribe.rb

@@ -0,0 +1,19 @@
+module Mailstro
+  class ListUnsubscribe < Resource
+    def self.unsubscribe(list_name, contact_email)
+      new(list_name, contact_email).deliver
+    end
+
+    attr_reader :list_name, :contact_email
+
+    def initialize(list_name, contact_email)
+      @list_name     = list_name
+      @contact_email = contact_email
+    end
+
+    def deliver
+      delete("lists/subscribers", :list_name     => @list_name,
+                                  :contact_email => @contact_email)
+    end
+  end
+end

data/lib/mailstro/resource.rb

@@ -21,6 +21,15 @@ module Mailstro
       end.body
     end
 
+    def delete(path, body = {})
+      connection.delete(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

data/lib/mailstro/version.rb

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

data/lib/mailstro.rb

@@ -3,9 +3,11 @@ require_relative "mailstro/configuration"
 require_relative "mailstro/resource"
 require_relative "mailstro/error"
 require_relative "mailstro/delivery"
+require_relative "mailstro/list_delivery"
+require_relative "mailstro/list_subscribe"
+require_relative "mailstro/list_unsubscribe"
 
 module Mailstro
-
   class << self
     attr_accessor :configuration
   end
@@ -16,7 +18,19 @@ module Mailstro
     configuration.validate!
   end
 
-  def self.deliver(template, contact_email, payload = {})
-    Delivery.deliver(template, contact_email, payload)
+  def self.deliver(template_name, contact_email, payload = {})
+    Delivery.deliver(template_name, contact_email, payload)
+  end
+
+  def self.list_deliver(template_name, list, payload = {})
+    ListDelivery.deliver(template_name, list, payload)
+  end
+
+  def self.list_subscribe(list_name, contact_email)
+    ListSubscribe.subscribe(list_name, contact_email)
+  end
+
+  def self.list_unsubscribe(list_name, contact_email)
+    ListUnsubscribe.unsubscribe(list_name, contact_email)
   end
 end

data/spec/fixtures/response.json

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

data/spec/integration/{posting_a_delivery_spec.rb → delivery_spec.rb}

@@ -20,10 +20,10 @@ describe 'posting a delivery', :integration do
 
   it "succesfully submits a delivery to mailstro" do
     stub_request(:post, "https://api.mailstroapp.com/v1/deliveries").
-    with(:body => expected_body).to_return(:status => 200, :body => fixture("deliveries.json"))
+      with(:body => expected_body).to_return(:status => 200, :body => fixture("response.json"))
 
     response = Mailstro.deliver(template_name, contact_email, payload)
-    response['ok'].should == true
+    response['success'].should == true
   end
 
   it "raises an error if the api key is not authorized" do

data/spec/integration/list_delivery_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'posting a list delivery', :integration do
+  let(:template_name) { :test }
+  let(:list_name)     { :customers }
+  let(:payload)       { { :message => "Are you ok?" } }
+
+  before do
+    Mailstro.configure do |config|
+      config.api_key = 'lolapi'
+    end
+  end
+
+  let(:expected_body) {{
+    "api_key"       => "lolapi",
+    "template_name" => "test",
+    "list_name"     => "customers",
+    "payload"       => { "message" => "Are you ok?" }
+  }}
+
+  it "succesfully submits a list delivery to mailstro" do
+    stub_request(:post, "https://api.mailstroapp.com/v1/lists/deliveries").
+    with(:body => expected_body).to_return(:status => 200, :body => fixture("response.json"))
+
+    response = Mailstro.list_deliver(template_name, list_name, payload)
+
+    response[:success].should == true
+  end
+end

data/spec/integration/list_subscribe_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'posting a subscription to a list', :integration do
+  let(:list_name)     { :test }
+  let(:contact_email) { "test@example.com" }
+
+  before do
+    Mailstro.configure do |config|
+      config.api_key = 'lolapi'
+    end
+  end
+
+  let(:expected_body) {{
+    "api_key"       => "lolapi",
+    "list_name"     => "test",
+    "contact_email" => "test@example.com",
+  }}
+
+  it "succesfully submits a subscription to mailstro" do
+    stub_request(:post, "https://api.mailstroapp.com/v1/lists/subscribers").
+    with(:body => expected_body).to_return(:status => 200, :body => fixture("response.json"))
+
+    response = Mailstro.list_subscribe(list_name, contact_email)
+    response['success'].should == true
+  end
+end

data/spec/integration/list_unsubscribe_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'deleting a subscription from a list', :integration do
+  let(:list_name)     { :test }
+  let(:contact_email) { "test@example.com" }
+
+  before do
+    Mailstro.configure do |config|
+      config.api_key = 'lolapi'
+    end
+  end
+
+  let(:expected_body) {{
+    "api_key"       => "lolapi",
+    "list_name"     => "test",
+    "contact_email" => "test@example.com",
+  }}
+
+  it "succesfully deletes a subscription to mailstro" do
+    stub_request(:delete, "https://api.mailstroapp.com/v1/lists/subscribers").
+    with(:body => expected_body).to_return(:status => 200, :body => fixture("response.json"))
+
+    response = Mailstro.list_unsubscribe(list_name, contact_email)
+    response['success'].should == true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailstro
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -140,14 +140,20 @@ files:
 - lib/mailstro/configuration.rb
 - lib/mailstro/delivery.rb
 - lib/mailstro/error.rb
+- lib/mailstro/list_delivery.rb
+- lib/mailstro/list_subscribe.rb
+- lib/mailstro/list_unsubscribe.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/deliveries.json
-- spec/integration/posting_a_delivery_spec.rb
+- spec/fixtures/response.json
+- spec/integration/delivery_spec.rb
+- spec/integration/list_delivery_spec.rb
+- spec/integration/list_subscribe_spec.rb
+- spec/integration/list_unsubscribe_spec.rb
 - spec/mailstro/configuration_spec.rb
 - spec/mailstro/test_spec.rb
 - spec/mailstro/version_spec.rb
@@ -181,8 +187,11 @@ signing_key:
 specification_version: 3
 summary: Ruby notifier for mailstro.co
 test_files:
-- spec/fixtures/deliveries.json
-- spec/integration/posting_a_delivery_spec.rb
+- spec/fixtures/response.json
+- spec/integration/delivery_spec.rb
+- spec/integration/list_delivery_spec.rb
+- spec/integration/list_subscribe_spec.rb
+- spec/integration/list_unsubscribe_spec.rb
 - spec/mailstro/configuration_spec.rb
 - spec/mailstro/test_spec.rb
 - spec/mailstro/version_spec.rb

data/spec/fixtures/deliveries.json

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