newslettre 0.1.1 → 0.2.0

data/features/recipients.feature

@@ -1,20 +1,17 @@
 Feature: Managing Recipients for Newsletters
   Background:
-    Given there is no Newsletter named 'Superior Soy Beans Discount!'
-    And there is no 'Junk-food addicts' Recipient List
-    And there is no identity named 'Bourne'
+    Given there is no Newsletter named "Superior Soy Beans Discount!"
+    And there is no "Junk-food addicts" Recipient List
+    And there is no identity named "Hidden"
+    And I add the "Hidden" Identity
+    And I add a Newsletter named "Superior Soy Beans Discount!" written by "Hidden"
+    And I add a Recipient List named "Junk-food addicts"
   @sendgrid_adding_recipients
   Scenario: Adding a Recipient List to a Newsletter
-    Given I add the 'Bourne' Identity
-    And I add a Newsletter named 'Superior Soy Beans Discount!' written by 'Bourne'
-    And I add a Recipient List named 'Junk-food addicts'
-    When I add 'Junk-food addicts' to 'Superior Soy Beans Discount!'
-    Then 'Junk-food addicts' will be notified when 'Superior Soy Beans Discount!' is delivered
+    When I add "Junk-food addicts" to "Superior Soy Beans Discount!"
+    Then "Junk-food addicts" will be notified when "Superior Soy Beans Discount!" is delivered
   @sendgrid_removing_recipients
   Scenario: Removing a Recipient List from a Newsletter
-    Given I add the 'Bourne' Identity
-    And I add a Newsletter named 'Superior Soy Beans Discount!' written by 'Bourne'
-    And I add a Recipient List named 'Junk-food addicts'
-    And I add 'Junk-food addicts' to 'Superior Soy Beans Discount!'
-    When I remove 'Junk-food addicts' from 'Superior Soy Beans Discount!'
-    Then no one will be notified when 'Superior Soy Beans Discount!' is delivered
+    Given I add "Junk-food addicts" to "Superior Soy Beans Discount!"
+    When I remove "Junk-food addicts" from "Superior Soy Beans Discount!"
+    Then no one will be notified when "Superior Soy Beans Discount!" is delivered

data/features/scheduling.feature

@@ -0,0 +1,20 @@
+Feature: Scheduling
+  Background:
+    Given there is no Newsletter named "Superior Soy Beans Discount!"
+    And there is no "Junk-food addicts" Recipient List
+    And there is no identity named "Hidden"
+    And I add the "Hidden" Identity
+    And I add a Newsletter named "Superior Soy Beans Discount!" written by "Hidden"
+    And I add a Recipient List named "Junk-food addicts"
+    And "Joe" subscribes to "Junk-food addicts"
+    And I add "Junk-food addicts" to "Superior Soy Beans Discount!"
+    And "Superior Soy Beans Discount!" is not scheduled
+  @sendgrid_scheduling_newsletter
+  Scenario: Scheduling a Newsletter
+    When I schedule "Superior Soy Beans Discount!" for "tomorrow"
+    Then it should deliver "Superior Soy Beans Discount!" at "tomorrow"
+  @sendgrid_descheduling_newsletter
+  Scenario: Deschedule a Newsletter
+    Given I schedule "Superior Soy Beans Discount!" for "tomorrow"
+    When I deschedule "Superior Soy Beans Discount!"
+    Then it should not deliver "Superior Soy Beans Discount!"

data/features/step_definitions/recipients_steps.rb

@@ -1,4 +1,4 @@
-Given /^there is no Newsletter named '([^']+)'$/ do |name|
+Given /^there is no Newsletter named "([^"]+)"$/ do |name|
   begin
     newslettre.newsletters.delete name
   rescue Newslettre::API::ClientFailure
@@ -6,7 +6,7 @@ Given /^there is no Newsletter named '([^']+)'$/ do |name|
   end
 end
 
-Given /^there is no '([^']+)' Recipient List$/ do |list|
+Given /^there is no "([^"]+)" Recipient List$/ do |list|
   begin
     newslettre.lists.delete list
   rescue Newslettre::API::ClientFailure
@@ -14,7 +14,7 @@ Given /^there is no '([^']+)' Recipient List$/ do |list|
   end
 end
 
-Given /^there is no identity named '([^']+)'$/ do |identity|
+Given /^there is no identity named "([^"]+)"$/ do |identity|
   begin
     newslettre.identities.delete identity
   rescue Newslettre::API::ClientFailure
@@ -22,11 +22,11 @@ Given /^there is no identity named '([^']+)'$/ do |identity|
   end
 end
 
-Given /^I add the '([^']+)' Identity$/ do |identity|
+Given /^I add the "([^"]+)" Identity$/ do |identity|
   newslettre.identities.add identity, NEWSLETTRE_CONFIG['identity']
 end
 
-Given /^I add a Newsletter named '([^']+)' written by '([^']+)'$/ do |name, identity|
+Given /^I add a Newsletter named "([^"]+)" written by "([^"]+)"$/ do |name, identity|
   newslettre.newsletters.add name,
     :identity => identity,
     :subject => name,
@@ -34,22 +34,22 @@ Given /^I add a Newsletter named '([^']+)' written by '([^']+)'$/ do |name, iden
     :html => "<h1>meow</h1>"
 end
 
-Given /^I add a Recipient List named '([^']+)'$/ do |list|
+Given /^I add a Recipient List named "([^"]+)"$/ do |list|
   newslettre.lists.add list
 end
 
-When /^I add '([^']+)' to '([^']+)'$/ do |list, name|
+When /^I add "([^"]+)" to "([^"]+)"$/ do |list, name|
   newslettre.newsletters.get(name).recipients.add list
 end
 
-When /^I remove '([^']+)' from '([^']+)'$/ do |list, name|
+When /^I remove "([^"]+)" from "([^"]+)"$/ do |list, name|
   newslettre.newsletters.get(name).recipients.delete list
 end
 
-Then /^'([^']+)' will be notified when '([^']+)' is delivered$/ do |list, name|
+Then /^"([^"]+)" will be notified when "([^"]+)" is delivered$/ do |list, name|
   newslettre.newsletters.get(name).recipients.to_a.should =~ [{ "list" => list }]
 end
 
-Then /^no one will be notified when '([^']+)' is delivered$/ do |name|
+Then /^no one will be notified when "([^"]+)" is delivered$/ do |name|
   newslettre.newsletters.get(name).recipients.to_a.should be_empty
 end

data/features/step_definitions/scheduling_steps.rb

@@ -0,0 +1,30 @@
+Given /^"([^"]*)" subscribes to "([^"]*)"$/ do |name, list|
+  user = NEWSLETTRE_CONFIG['users'][name]
+
+  newslettre.lists.get(list).emails.add user
+end
+
+When /^I schedule "([^"]*)" for "([^"]*)"$/ do |letter, date|
+  time = Chronic.parse date
+  newslettre.newsletters.get(letter).schedule! :at => time
+end
+
+Then /^it should deliver "([^"]*)" at "([^"]*)"$/ do |letter, date|
+  newslettre.newsletters.get(letter).schedule.should == Chronic.parse(date)
+end
+
+Given /^"([^"]*)" is not scheduled$/ do |letter|
+  begin
+    newslettre.newsletters.get(letter).deschedule!
+  rescue Newslettre::API::ClientFailure
+    nil
+  end
+end
+
+When /^I deschedule "([^"]*)"$/ do |letter|
+  newslettre.newsletters.get(letter).deschedule!
+end
+
+Then /^it should not deliver "([^"]*)"$/ do |letter|
+  newslettre.newsletters.get(letter).should_not be_scheduled
+end

data/features/support/env.rb

@@ -2,6 +2,7 @@ NEWSLETTRE_CONFIG = YAML.load_file File.dirname(__FILE__) + "/../../config/newsl
 
 require 'vcr'
 require 'newslettre'
+require 'chronic'
 
 VCR.config do |c|
   c.stub_with :webmock
@@ -12,7 +13,8 @@ VCR.config do |c|
 end
 
 VCR.cucumber_tags do |t|
-  t.tags '@sendgrid_adding_recipients', '@sendgrid_removing_recipients'
+  t.tags '@sendgrid_adding_recipients', '@sendgrid_removing_recipients', '@sendgrid_scheduling_newsletter',
+    '@sendgrid_descheduling_newsletter'
 end
 
 class OuterWorld

data/lib/newslettre/api.rb

@@ -19,12 +19,12 @@ class Newslettre::API
       params ||= {}
       options ||= {}
 
-      response, status = request url_for(m, options), params
+      response, status, body = request url_for(m, options), params
 
-      raise ClientFailure if status > 399 and status < 500
-      raise EndpointFailure if status > 499
+      raise ClientFailure, body if status > 399 and status < 500
+      raise EndpointFailure, body if status > 499
 
-      respond response
+      respond body
     end
   end
 
@@ -57,11 +57,11 @@ class Newslettre::API
 
     curl.http_post(*fields)
 
-    [curl, curl.response_code]
+    [curl, curl.response_code, curl.body_str]
   end
 
-  def respond response
-    JSON.load response.body_str
+  def respond body
+    JSON.load body
   end
 
   def url_for path, options = {}

data/lib/newslettre/letter.rb

@@ -19,9 +19,35 @@ class Newslettre::Letter < Newslettre::APIModule
       data
     end
 
+    def schedule
+      scheduler.get
+    end
+
+    def deschedule!
+      scheduler.delete
+    end
+
+    def schedule! options = {}
+      scheduler.deliver options
+    end
+
+    def scheduled?
+      begin
+        !!schedule
+      rescue NotScheduledFailure
+        false
+      end
+    end
+
     def recipients
       @recipients ||= Newslettre::APIModuleProxy.new self, Recipients.new(self.name, self.api)
     end
+
+    protected
+
+    def scheduler
+      @scheduler ||= Schedule.new self.name, self.api
+    end
   end
 
   def list
@@ -44,6 +70,61 @@ class Newslettre::Letter < Newslettre::APIModule
     request 'edit', data
   end
 
+  class Schedule < Newslettre::APIModule
+    attr_reader :letter
+
+    def initialize letter, api
+      @letter = letter
+      @api = api
+    end
+
+    def deliver options = {}
+      require 'time'
+      data = { :name => letter }
+      at = options.delete :at
+      unless at.nil?
+        data[:at] = at.iso8601
+      end
+      request :add, data
+    end
+
+    def delete
+      request :delete, :name => letter
+
+      true
+    end
+
+    def get
+      require 'time'
+      begin
+        date = request(:get, :name => letter)["date"]
+      rescue Newslettre::API::ClientFailure
+        raise NotScheduledFailure, "not found"
+      end
+
+      unless date.nil? or date.size.zero?
+        parse_utc_date date
+      else
+        raise NotScheduledFailure, "invalid date"
+      end
+    end
+
+    protected
+
+    def parse_utc_date date
+      date, time = date.split(" ")
+
+      year, month, day = date.split "-"
+      hour, minute, second = time.split ":"
+
+      Time.utc year, month, day, hour, minute, second
+    end
+
+  end
+
+  class NotScheduledFailure < Newslettre::API::ClientFailure; end
+
+
   class Recipients < Newslettre::APIModule
     attr_reader :letter
 

data/lib/newslettre/version.rb

@@ -1,3 +1,3 @@
 module Newslettre
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/newslettre.gemspec

@@ -20,8 +20,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "yajl-ruby", "~> 0.8"
-  #s.add_dependency "typhoeus", "~> 0.2"
-  #s.add_dependency "faraday", "~> 0.7"
   s.add_dependency "curb", "~> 0.7"
 
   s.add_development_dependency "rake", "~> 0.9"
@@ -29,4 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "webmock", "~> 1.7"
   s.add_development_dependency "vcr", "~> 1.11"
   s.add_development_dependency "cucumber", "~> 1"
+  s.add_development_dependency "chronic", "~> 0.6"
+  s.add_development_dependency "timecop", "~> 0.3"
+  s.add_development_dependency "rspec-spies", "~> 2.0"
 end

data/spec/high_level_api_spec.rb

@@ -86,4 +86,38 @@ describe "The higher-level API" do
       end
     end
   end
+
+  context Newslettre::Letter::Schedule do
+    subject { @client }
+
+    it "should schedule a newsletter" do
+      Timecop.freeze do
+        Newslettre::Letter::Schedule.any_instance.should_receive(:deliver).with(:at => Time.now)
+        subject.newsletters.get('test-letter').schedule! :at => Time.now
+      end
+    end
+
+    it "should fetch schedule for newsletter" do
+      Newslettre::Letter::Schedule.any_instance.should_receive(:get).and_return(Time.now)
+      subject.newsletters.get('test-letter').schedule.should be_kind_of(Time)
+    end
+
+    it "should delete schedule for newsletter" do
+      Newslettre::Letter::Schedule.any_instance.should_receive(:delete).and_return(true)
+
+      subject.newsletters.get('test-letter').deschedule!.should be_true
+    end
+
+    it "should tell me 'test-letter' is not scheduled" do
+      Newslettre::API.any_instance.should_receive(:get).and_raise(Newslettre::API::ClientFailure)
+
+      subject.newsletters.get('test-letter').should_not be_scheduled
+    end
+
+    it "should tell me 'test-letter' is scheduled" do
+      Newslettre::Letter::Schedule.any_instance.should_receive(:get).and_return(Time.now)
+
+      subject.newsletters.get('test-letter').should be_scheduled
+    end
+  end
 end

data/spec/low_level_spec.rb

@@ -188,9 +188,7 @@ describe Newslettre do
       it "should create an HTML mail" do
         data = NEWSLETTRE_CONFIG['letter']
         data["html"] = File.read File.dirname(__FILE__) + "/fixtures/test-letter.html"
-        #html = <<-HTML
-        #    <!doctype html>\n<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ -->\n<!--[if lt IE 7]> <html class=\"no-js ie6 oldie\" lang=\"en\"> <![endif]-->\n<!--[if IE 7]>    <html class=\"no-js ie7 oldie\" lang=\"en\"> <![endif]-->\n<!--[if IE 8]>    <html class=\"no-js ie8 oldie\" lang=\"en\"> <![endif]-->\n<!-- Consider adding a manifest.appcache: h5bp.com/d/Offline -->\n<!--[if gt IE 8]><!--> <html class=\"no-js\" lang=\"en\"> <!--<![endif]-->\n<head>\n  <meta charset=\"utf-8\">\n\n  <!-- Use the .htaccess and remove these lines to avoid edge case issues.\n       More info: h5bp.com/b/378 -->\n  <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge,chrome=1\">\n\n  <title></title>\n  <meta name=\"description\" content=\"\">\n  <meta name=\"author\" content=\"\">\n\n  <!-- Mobile viewport optimized: j.mp/bplateviewport -->\n  <meta name=\"viewport\" content=\"width=device-width,initial-scale=1\">\n\n  <!-- Place favicon.ico and apple-touch-icon.png in the root directory: mathiasbynens.be/notes/touch-icons -->\n\n  <link rel=\"stylesheet\" href=\"css/style.css\">\n  \n  <!-- More ideas for your <head> here: h5bp.com/d/head-Tips -->\n\n  <!-- All JavaScript at the bottom, except this Modernizr build incl. Respond.js\n       Respond is a polyfill for min/max-width media queries. Modernizr enables HTML5 elements & feature detects; \n       for optimal performance, create your own custom Modernizr build: www.modernizr.com/download/ -->\n  <script src=\"js/libs/modernizr-2.0.6.min.js\"></script>\n</head>\n\n<body>\n  <header>\n\n  </header>\n  <div role=\"main\">\n\n  </div>\n  <footer>\n\n  </footer>\n\n\n  <!-- JavaScript at the bottom for fast page loading -->\n\n  <!-- Grab Google CDN's jQuery, with a protocol relative URL; fall back to local if offline -->\n  <script src=\"//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.min.js\"></script>\n  <script>window.jQuery || document.write('<script src=\"js/libs/jquery-1.6.4.min.js\"><\\/script>')</script>\n\n\n  <!-- scripts concatenated and minified via build script -->\n  <script defer src=\"js/plugins.js\"></script>\n  <script defer src=\"js/script.js\"></script>\n  <!-- end scripts -->\n\n\n  <!-- Asynchronous Google Analytics snippet. Change UA-XXXXX-X to be your site's ID.\n       mathiasbynens.be/notes/async-analytics-snippet -->\n  <script>\n    var _gaq=[['_setAccount','UA-XXXXX-X'],['_trackPageview'],['_trackPageLoadTime']];\n    (function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];\n    g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';\n    s.parentNode.insertBefore(g,s)}(document,'script'));\n  </script>\n\n  <!-- Prompt IE 6 users to install Chrome Frame. Remove this if you want to support IE 6.\n       chromium.org/developers/how-tos/chrome-frame-getting-started -->\n  <!--[if lt IE 7 ]>\n    <script defer src=\"//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js\"></script>\n    <script defer>window.attachEvent('onload',function(){CFInstall.check({mode:'overlay'})})</script>\n  <![endif]-->\n\n</body>\n</html>\n
-        #    HTML
+
         @newsletter.add 'test-html', data
 
         @newsletter.get("test-html").to_hash["html"].should_not be_empty
@@ -203,4 +201,35 @@ describe Newslettre do
 
   end
 
+  describe Newslettre::Letter::Schedule do
+    before :each do
+      @schedule = Newslettre::Letter::Schedule.new 'test-letter', @api
+    end
+
+    it "should call the API when delivering" do
+      @api.should_receive(:add).with({ :name => 'test-letter', :at => '2012-01-15T02:11:25Z'}, { :prefix => "/schedule" })
+      @schedule.deliver :at => Time.utc(2012,"jan", 15, 2, 11, 25)
+    end
+
+    it "should call the API when requesting delivery time" do
+      @api.should_receive(:get).with({ :name => 'test-letter'} , { :prefix => "/schedule" }).and_return({"date" => "2012-01-15 02:11:25"})
+      @schedule.get
+    end
+
+    context "#delete" do
+      before :each do
+        @api.stub! :delete
+      end
+
+      it "should call the API when unscheduling delivery" do
+        @schedule.delete
+        @api.should have_received(:delete).with({ :name => 'test-letter'}, { :prefix => "/schedule" })
+      end
+
+      it "should return `true`" do
+        @schedule.delete.should be_true
+      end
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require File.dirname(__FILE__) + '/../lib/newslettre'
 
 require 'vcr'
+require 'rspec-spies'
+require 'timecop'
 
 NEWSLETTRE_CONFIG = YAML.load_file File.dirname(__FILE__) + "/../config/newslettre.yml"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newslettre
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-21 00:00:00.000000000 +02:00
+date: 2011-09-23 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2153070980 !ruby/object:Gem::Requirement
+  requirement: &2152125080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *2153070980
+  version_requirements: *2152125080
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &2153067480 !ruby/object:Gem::Requirement
+  requirement: &2152123780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *2153067480
+  version_requirements: *2152123780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153055680 !ruby/object:Gem::Requirement
+  requirement: &2152122980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2153055680
+  version_requirements: *2152122980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153044700 !ruby/object:Gem::Requirement
+  requirement: &2152121980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: '2'
   type: :development
   prerelease: false
-  version_requirements: *2153044700
+  version_requirements: *2152121980
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2153031300 !ruby/object:Gem::Requirement
+  requirement: &2152121340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *2153031300
+  version_requirements: *2152121340
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &2153027260 !ruby/object:Gem::Requirement
+  requirement: &2152120560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '1.11'
   type: :development
   prerelease: false
-  version_requirements: *2153027260
+  version_requirements: *2152120560
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2153018380 !ruby/object:Gem::Requirement
+  requirement: &2152119820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,7 +88,40 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *2153018380
+  version_requirements: *2152119820
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: &2152119020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2152119020
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2152118220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: *2152118220
+- !ruby/object:Gem::Dependency
+  name: rspec-spies
+  requirement: &2152117500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152117500
 description: Create and Manage Newsletters using the Sendgrid API
 email:
 - l@melzer.it
@@ -102,7 +135,9 @@ files:
 - README.md
 - Rakefile
 - features/recipients.feature
+- features/scheduling.feature
 - features/step_definitions/recipients_steps.rb
+- features/step_definitions/scheduling_steps.rb
 - features/support/env.rb
 - lib/newslettre.rb
 - lib/newslettre/api.rb
@@ -145,7 +180,9 @@ specification_version: 3
 summary: Sendgrid Newsletter API Client
 test_files:
 - features/recipients.feature
+- features/scheduling.feature
 - features/step_definitions/recipients_steps.rb
+- features/step_definitions/scheduling_steps.rb
 - features/support/env.rb
 - spec/fixtures/test-letter.html
 - spec/high_level_api_spec.rb