newslettre 0.0.1

data/features/recipients.feature

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

data/features/step_definitions/recipients_steps.rb

@@ -0,0 +1,63 @@
+Given /^there is no Newsletter named '([^']+)'$/ do |name|
+  begin
+    Newslettre::Letter.new(newslettre).delete name
+  rescue Newslettre::Client::ClientFailure
+    nil
+  end
+end
+
+Given /^there is no '([^']+)' Recipient List$/ do |list|
+  begin
+    Newslettre::Lists.new(newslettre).delete list
+  rescue Newslettre::Client::ClientFailure
+    nil
+  end
+end
+
+Given /^there is no identity named '([^']+)'$/ do |identity|
+  begin
+    Newslettre::Identity.new(newslettre).delete identity
+  rescue Newslettre::Client::ClientFailure
+    nil
+  end
+end
+
+Given /^I add the '([^']+)' Identity$/ do |identity|
+  Newslettre::Identity.new(newslettre).add identity, NEWSLETTRE_CONFIG['identity']
+end
+
+Given /^I add a Newsletter named '([^']+)' written by '([^']+)'$/ do |name, identity|
+  Newslettre::Letter.new(newslettre).add name,
+    :identity => identity,
+    :subject => name,
+    :text => "Super Cool!",
+    :html => "<h1>meow</h1>"
+end
+
+Given /^I add a Recipient List named '([^']+)'$/ do |list|
+  Newslettre::Lists.new(newslettre).add list
+end
+
+When /^I add '([^']+)' to '([^']+)'$/ do |list, name|
+  recipients = Newslettre::Letter::Recipients.new name, newslettre
+
+  recipients.add list
+end
+
+When /^I remove '([^']+)' from '([^']+)'$/ do |list, name|
+  recipients = Newslettre::Letter::Recipients.new name, newslettre
+
+  recipients.delete list
+end
+
+Then /^'([^']+)' will be notified when '([^']+)' is delivered$/ do |list, name|
+  recipients = Newslettre::Letter::Recipients.new name, newslettre
+  lists = recipients.get
+  lists.should =~ [{ "list" => list }]
+end
+
+Then /^no one will be notified when '([^']+)' is delivered$/ do |name|
+  recipients = Newslettre::Letter::Recipients.new name, newslettre
+  lists = recipients.get
+  lists.should be_empty
+end

data/features/support/env.rb

@@ -0,0 +1,25 @@
+NEWSLETTRE_CONFIG = YAML.load_file File.dirname(__FILE__) + "/../../config/newslettre.yml"
+
+require 'vcr'
+require 'newslettre'
+
+VCR.config do |c|
+  c.stub_with :webmock
+  c.cassette_library_dir = 'features/cassettes'
+  c.filter_sensitive_data('<<USERNAME>>') { NEWSLETTRE_CONFIG['sendgrid']['username'] }
+  c.filter_sensitive_data('<<PASSWORD>>') { NEWSLETTRE_CONFIG['sendgrid']['password'] }
+  c.default_cassette_options = { :record => :once }
+end
+
+VCR.cucumber_tags do |t|
+  t.tags '@sendgrid_adding_recipients', '@sendgrid_removing_recipients'
+end
+
+class OuterWorld
+  def newslettre
+    @newslettre ||= Newslettre::Client.new(:email => NEWSLETTRE_CONFIG['sendgrid']['username'],
+                           :password => NEWSLETTRE_CONFIG['sendgrid']['password'])
+  end
+end
+
+World { OuterWorld.new }

data/lib/newslettre.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+
+module Newslettre
+  autoload :Client, 'newslettre/client'
+  autoload :APIModule, 'newslettre/api_module'
+  autoload :Letter, 'newslettre/letter'
+  autoload :Identity, 'newslettre/identity'
+  autoload :Lists, 'newslettre/lists'
+end

data/lib/newslettre/api_module.rb

@@ -0,0 +1,17 @@
+class Newslettre::APIModule
+  attr_reader :client
+
+  def initialize client
+    @client = client
+  end
+
+  protected
+
+  def api_prefix
+    "/#{self.class.name.split(/::/).last.downcase}"
+  end
+
+  def request method, data = {}
+    self.client.send method, data, { :prefix => api_prefix }
+  end
+end

data/lib/newslettre/client.rb

@@ -0,0 +1,49 @@
+class Newslettre::Client
+  include HTTParty
+  format :json
+  attr_reader :email, :password, :format
+
+
+  def initialize options = {}
+    self.class.base_uri "https://sendgrid.com/api/newsletter"
+    @email = options.delete :email
+    @password = options.delete :password
+    @format = "json"
+  end
+
+
+  def url
+    @url ||= self.class.default_options[:base_uri]
+  end
+
+  %w{get list add delete edit}.each do |m|
+    define_method m do |*args|
+      params, options = args
+      params ||= {}
+      options ||= {}
+      response = self.class.post url_for(m, options), :query => params.merge(credentials)
+      raise ClientFailure if response.code > 399 and response.code < 500
+      raise EndpointFailure if response.code > 499
+      response
+    end
+  end
+
+  alias_method :post, :add
+  alias_method :put, :edit
+
+  class ClientFailure < StandardError; end
+  class EndpointFailure < StandardError; end
+
+  protected
+
+  def credentials
+    {
+      :api_user => email,
+      :api_key => password
+    }
+  end
+
+  def url_for path, options = {}
+    "#{options[:prefix]}/#{path}.#{format}"
+  end
+end

data/lib/newslettre/identity.rb

@@ -0,0 +1,21 @@
+class Newslettre::Identity < Newslettre::APIModule
+  def list
+    request 'list'
+  end
+
+  def get id
+    request 'get', :identity => id
+  end
+
+  def add id, data = {}
+    request 'add', data.merge(:identity => id)
+  end
+
+  def edit id, data = {}
+    request 'edit', data.merge(:identity => id)
+  end
+
+  def delete id
+    request 'delete', :identity => id
+  end
+end

data/lib/newslettre/letter.rb

@@ -0,0 +1,48 @@
+class Newslettre::Letter < Newslettre::APIModule
+  def list
+    request 'list'
+  end
+
+  def add name, data = {}
+    request 'add', data.merge(:name => name)
+  end
+
+  def get name
+    request 'get', :name => name
+  end
+
+  def delete name
+    request 'delete', :name => name
+  end
+
+  def edit name, data = {}
+    request 'edit', data
+  end
+
+  class Recipients < Newslettre::APIModule
+    attr_reader :letter
+
+    def initialize letter, client
+      @letter = letter
+      @client = client
+    end
+
+    def add list
+      request 'add', { :list => list, :name => letter }
+    end
+
+    def get
+      request 'get', { :name => letter }
+    end
+
+    def delete list
+      request 'delete', { :list => list, :name => letter }
+    end
+  end
+
+  protected
+
+  def api_prefix
+    nil
+  end
+end

data/lib/newslettre/lists.rb

@@ -0,0 +1,49 @@
+class Newslettre::Lists < Newslettre::APIModule
+  def add list, data = {}
+    request 'add', data.merge(:list => list)
+  end
+
+  def get list = nil
+    if list.nil?
+      request 'get'
+    else
+      request('get', :list => list).first
+    end
+  end
+  alias_method :list, :get
+
+  def edit list, data = {}
+    request 'edit', data.merge(:list => list)
+  end
+
+  def delete list
+    request 'delete', :list => list
+  end
+
+  class Email < Newslettre::APIModule
+    attr_reader :list
+
+    def initialize list, client
+      @client = client
+      @list = list
+    end
+
+    def add *recipients
+      request 'add', :list => list, :data => recipients.map{|r| JSON.dump(r) }
+    end
+
+    def get *recipients
+      request 'get', :list => list, :email => recipients
+    end
+
+    def delete *recipients
+      request 'delete', :list => list, :email => recipients
+    end
+
+    protected
+
+    def api_prefix
+      "/lists/email"
+    end
+  end
+end

data/lib/newslettre/version.rb

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

data/newslettre.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "newslettre/version"
+
+Gem::Specification.new do |s|
+  s.name        = "newslettre"
+  s.version     = Newslettre::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Lennart Melzer"]
+  s.email       = ["l@melzer.it"]
+  s.homepage    = ""
+  s.summary     = %q{Sendgrid Newsletter API Client}
+  s.description = %q{Create and Manage Newsletters using the Sendgrid API}
+
+  s.rubyforge_project = "newslettre"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "httparty", "~> 0.8"
+
+  s.add_development_dependency "rake", "~> 0.9"
+  s.add_development_dependency "rspec", "~> 2"
+  s.add_development_dependency "webmock", "~> 1.7"
+  s.add_development_dependency "vcr", "~> 1.11"
+  s.add_development_dependency "cucumber", "~> 1"
+end

data/spec/cassettes/Newslettre/Newslettre_Identity.yml

@@ -0,0 +1,24 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/list.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:26:55 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '[{"identity": "da9febf06480f7bb88264fc907f75995"}]'
+    http_version: '1.1'

data/spec/cassettes/Newslettre/Newslettre_Identity/with_a_new_identity.yml

@@ -0,0 +1,72 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/add.json?address=Oranienstra%C3%9Fe%206&api_key=<<PASSWORD>>&api_user=<<USERNAME>>&city=Berlin&country=DE&email=<<USERNAME>>&identity=test-identity&name=Mathias%20Fiedler&state=B&zip=10997
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:26:56 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/get.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&identity=test-identity
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:26:57 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"city": "Berlin", "name": "Mathias Fiedler", "zip": "10997", "country":
+      "DE", "state": "B", "address": "Oranienstra\u00dfe 6", "email": "<<USERNAME>>",
+      "identity": "test-identity"}'
+    http_version: '1.1'
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://sendgrid.com:443/api/newsletter/identity/delete.json?api_key=<<PASSWORD>>&api_user=<<USERNAME>>&identity=test-identity
+    body: !!null 
+    headers: !!null 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/0.7.65
+      date:
+      - Tue, 20 Sep 2011 14:26:58 GMT
+      content-type:
+      - text/html
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+    body: ! '{"message": "success"}'
+    http_version: '1.1'