sendgrid_toolkit 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+doc/

data/README.rdoc

@@ -0,0 +1,101 @@
+= SendgridToolkit - a Ruby wrapper for the Sendgrid Web API
+
+The Statistics and Unsubscribe APIs are fully supported.
+
+This allows you to:
+* manage your unsubscribed users
+* view API-supported email statistics.
+
+Support for Sendgrid's other Web APIs is coming soon.
+
+SendgridToolkit provides one class for each Web API module.
+
+=== A note about authentication
+Each class is initialized with +api_user+ and +api_key+ parameters. +api_user+ is your sendgrid account email address, and +api_key+ is your sendgrid password.
+
+If you don't supply +api_user+ or +api_key+, SendgridToolkit will look for the SMTP_USERNAME or SMTP_PASSWORD environment variables. If they are not found, SendgridToolkit will throw +NoAPIKeySpecified+ or +NoAPIUserSpecified+, depending on what you omitted.
+
+== Unsubscribes Class
+
+Instantiate the Unsubscribes object:
+  unsubscribes = SendgridToolkit::Unsubscribes.new(api_user, api_key)
+
+=== Listing Unsubscribes
+You can see everybody who has unsubscribed from your emails with:
+  listing = unsubscribes.retrieve
++listing+ will be an array of hashes, each of which has an +email+ key.
+
+If you want the timestamp for when each user unsubscribed, use:
+  listing = unsubscribes.retrieve_with_timestamps
+Each hash in +listing+ will now contain a +created+ key, which holds a Ruby Time object.
+
+=== Adding Unsubscribes
+To manually unsubscribe a user from your sendgrid emails, use:
+  unsubscribes.add :email => "email@to.unsubscribe"
+
+SendgridToolkit will throw +UnsubscribeEmailAlreadyExists+ if the email you specified is already on the list
+
+=== Deleting Unsubscribes
+To remove a user from your unsubscribe list, use:
+  unsubscribes.delete :email => "email@that_is.unsubscribed"
+
+SendgridToolkit will throw +UnsubscribeEmailDoesNotExist+ if the email you specified is not on the list
+
+== Statistics Class
+
+Instantiate the Statistics object:
+  statistics = SendgridToolkit::Statistics.new(api_user, api_key)
+
+=== Retrieve statistics
+To retrieve statistics, use:
+  stats = statistics.retrieve
++stats+ will be an array of hashes, each of which contains the following keys:
+* +date+: The date to which the statistics in this hash refer to
+* +requests+: The number of emails you sent
+* +bounces+: The number of users who opened your email but did not click on your links
+* +clicks+: The number of users who clicked on a link in your email
+* +opens+: The number of users who opened your email
+* +spamreports+: The number of users who have reported your emails as spam
++stats+ may also contain some keys that Sendgrid does not officially document, such as: +delivered+, +invalid_email+, +repeat_bounces+, +repeat_spamreports+, +repeat_unsubscribes+ and +unsubscribes+
+
+To narrow your retrieval to the past 5 days, you would use:
+  stats = statistics.retrieve :days => 5
+
+To narrow your retrieval to emails within the last month but before one week ago, you would use:
+  stats = statistics.retrieve :start_date => 1.month.ago, :end_date => 1.week.ago
+
+To narrow your search to a particular category (applicable only if you use this Sendgrid feature), you would use:
+  stats = statistics.retrieve :category => "NameOfYourCategory"
+Note: You may combine a category query with other options, i.e.:
+  stats = statistics.retrieve :category => "NameOfYourCategory", :days => 5
+
+=== Retrieve aggregate (all-time) statistics
+To receive your all-time statistics, use:
+  stats = statistics.retrieve_aggregate
++stats+ will be a single hash containing all of the aforementioned keys except +date+.
+
+=== List your categories
+If you use Sendgrid's category feature, you can get a listing of your categories with:
+  cats = statistics.list_categories
++cats+ is an array of hashes, each of which has a +category+ key that holds the name of a category.
+
+= Behind the Scenes
+Things you may want to know:
+
+1. API requests are made and responses are received in JSON.
+
+2. All requests are made as POSTs unless noted otherwise (Sendgrid's examples are via GET, but they support POST)
+
+3. Each class takes a final options parameter in the form of a hash. You may use this parameter to pass additional options to the Sendgrid API. For example, let's say you are using the unsubscribes function:
+  unsubscribes = SendgridToolkit::Unsubscribes.new(api_user, api_key)
+  listing = unsubscribes.retrieve
+If Sendgrid were to add a +only_verified+ option to this API call, you could call:
+  listing = unsubscribes.retrieve :only_verified => true
+to make use of it.
+
+= Testing
+In addition to unit tests, SendgridToolkit comes with a suite of "webconnect" tests that will actually hit Sendgrid's servers and perform various actions for purposes of real-world testing. In order to use these tests, you must:
+1. Create a test account with sendgrid and store the credentials in TEST_SMTP_USERNAME and TEST_SMTP_PASSWORD environment variables. This is so that actions are performed on a test account and not your real sendgrid account. If you forget, don't worry -- the tests will fail but they will not fall back on the account that uses SMTP_USERNAME and SMTP_PASSWORD.
+2. Change "xit" it "it" on the tests you wish to run.
+
+Running "spec spec" out of the box will run the standard suite of tests (all network access is stubbed out).

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "sendgrid_toolkit"
+    gemspec.summary = "A Ruby wrapper and utility library for communicating with the Sendgrid API"
+    gemspec.description = "A Ruby wrapper and utility library for communicating with the Sendgrid API"
+    gemspec.email = "robby@freerobby.com"
+    gemspec.homepage = "http://github.com/freerobby/sendgrid_toolkit"
+    gemspec.authors = ["Robby Grossman"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler must be installed. Use 'sudo gem install jeweler'."
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each {|ext| load ext}

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sendgrid_toolkit/abstract_sendgrid_client.rb

@@ -0,0 +1,22 @@
+module SendgridToolkit
+  class AbstractSendgridClient
+    
+    def initialize(api_user = nil, api_key = nil)
+      @api_user = (api_user.nil?) ? ENV['SMTP_USERNAME'] : api_user
+      @api_key = (api_key.nil?) ? ENV['SMTP_PASSWORD'] : api_key
+      
+      raise SendgridToolkit::NoAPIUserSpecified if @api_user.blank?
+      raise SendgridToolkit::NoAPIKeySpecified if @api_key.blank?
+    end
+    
+    protected
+    
+    def api_post(module_name, action_name, opts = {})
+      HTTParty.post("https://#{BASE_URI}/#{module_name}.#{action_name}.json?", :query => get_credentials.merge(opts), :format => :json)
+    end
+    
+    def get_credentials
+      {:api_user => @api_user, :api_key => @api_key}
+    end
+  end
+end

data/lib/sendgrid_toolkit/sendgrid_error.rb

@@ -0,0 +1,6 @@
+module SendgridToolkit
+  class NoAPIKeySpecified < StandardError; end
+  class NoAPIUserSpecified < StandardError; end
+  class UnsubscribeEmailAlreadyExists < StandardError; end
+  class UnsubscribeEmailDoesNotExist < StandardError; end
+end

data/lib/sendgrid_toolkit/statistics.rb

@@ -0,0 +1,23 @@
+module SendgridToolkit
+  class Statistics < AbstractSendgridClient
+    def retrieve(options = {})
+      response = api_post('stats', 'get', options)
+      response
+    end
+    
+    def retrieve_aggregate(options = {})
+      options.merge! :aggregate => 1
+      response = retrieve options
+      %w(bounces clicks delivered invalid_email opens repeat_bounces repeat_spamreports repeat_unsubscribes requests spamreports unsubscribes).each do |int_field|
+        response[int_field] = response[int_field].to_i if response.has_key?(int_field)
+      end
+      response
+    end
+    
+    def list_categories(options = {})
+      options.merge! :list => true
+      response = retrieve options
+      response
+    end
+  end
+end

data/lib/sendgrid_toolkit/unsubscribes.rb

@@ -0,0 +1,29 @@
+module SendgridToolkit
+  class Unsubscribes < AbstractSendgridClient
+    def add(options = {})
+      response = api_post('unsubscribes', 'add', options)
+      raise UnsubscribeEmailAlreadyExists if response['message'].include?('already exists')
+      response
+    end
+    
+    def delete(options = {})
+      response = api_post('unsubscribes', 'delete', options)
+      raise UnsubscribeEmailDoesNotExist if response['message'].include?('does not exist')
+      response
+    end
+    
+    def retrieve(options = {})
+      response = api_post('unsubscribes', 'get', options)
+      response
+    end
+    
+    def retrieve_with_timestamps(options = {})
+      options.merge! :date => 1
+      response = retrieve options
+      response.each do |unsubscribe|
+        unsubscribe['created'] = Time.parse(unsubscribe['created']) if unsubscribe.has_key?('created')
+      end
+      response
+    end
+  end
+end

data/lib/sendgrid_toolkit.rb

@@ -0,0 +1,10 @@
+require 'httparty'
+
+require 'sendgrid_toolkit/abstract_sendgrid_client'
+require 'sendgrid_toolkit/sendgrid_error'
+require 'sendgrid_toolkit/statistics'
+require 'sendgrid_toolkit/unsubscribes'
+
+module SendgridToolkit
+  BASE_URI = "sendgrid.com/api"
+end

data/spec/helper.rb

@@ -0,0 +1,13 @@
+require 'fakeweb'
+require 'sendgrid_toolkit'
+require 'spec'
+
+FakeWeb.allow_net_connect = false
+
+def backup_env
+  @env_backup = Hash.new
+  ENV.keys.each {|key| @env_backup[key] = ENV[key]}
+end
+def restore_env
+  @env_backup.keys.each {|key| ENV[key] = @env_backup[key]}
+end

data/spec/lib/sendgrid_toolkit/abstract_sendgrid_client_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::AbstractSendgridClient do
+  before do
+    backup_env
+  end
+  after do
+    restore_env
+  end
+  
+  describe "#initialize" do
+    it "stores api credentials when passed in" do
+      ENV['SMTP_USERNAME'] = "env_username"
+      ENV['SMTP_PASSWORD'] = "env_apikey"
+      
+      @obj = SendgridToolkit::AbstractSendgridClient.new("username", "apikey")
+      @obj.instance_variable_get("@api_user").should == "username"
+      @obj.instance_variable_get("@api_key").should == "apikey"
+    end
+    it "resorts to environment variables when no credentials specified" do
+      ENV['SMTP_USERNAME'] = "env_username"
+      ENV['SMTP_PASSWORD'] = "env_apikey"
+      
+      @obj = SendgridToolkit::AbstractSendgridClient.new()
+      @obj.instance_variable_get("@api_user").should == "env_username"
+      @obj.instance_variable_get("@api_key").should == "env_apikey"
+    end
+    it "throws error when no credentials are found" do
+      ENV['SMTP_USERNAME'] = nil
+      ENV['SMTP_PASSWORD'] = nil
+      
+      lambda {
+        @obj = SendgridToolkit::AbstractSendgridClient.new()
+      }.should raise_error SendgridToolkit::NoAPIUserSpecified
+      
+      lambda {
+        @obj = SendgridToolkit::AbstractSendgridClient.new(nil, "password")
+      }.should raise_error SendgridToolkit::NoAPIUserSpecified
+      
+      lambda {
+        @obj = SendgridToolkit::AbstractSendgridClient.new("user", nil)
+      }.should raise_error SendgridToolkit::NoAPIKeySpecified
+    end
+  end
+end

data/spec/lib/sendgrid_toolkit/statistics_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::Statistics do
+  before do
+    FakeWeb.clean_registry
+    @obj = SendgridToolkit::Statistics.new("fakeuser", "fakepass")
+  end
+  
+  describe "#retrieve" do
+    it "parses daily totals" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/stats\.get\.json\?|, :body => '[{"date":"2009-06-20","requests":12342,"bounces":12,"clicks":10223,"opens":9992,"spamreports":5},{"date":"2009-06-21","requests":32342,"bounces":10,"clicks":14323,"opens":10995,"spamreports":7},{"date":"2009-06-22","requests":52342,"bounces":11,"clicks":19223,"opens":12992,"spamreports":2}]')
+      stats = @obj.retrieve
+      stats.each do |stat|
+        %w(bounces clicks delivered invalid_email opens repeat_bounces repeat_spamreports repeat_unsubscribes requests spamreports unsubscribes).each do |int|
+          stat[int].kind_of?(Integer).should == true if stat.has_key?(int) # We support all fields presently returned, but we are only testing what sendgrid officially documents
+        end
+        stat['date'].kind_of?(Date).should == true
+      end
+    end
+  end
+  
+  describe "#retrieve_aggregate" do
+    it "parses aggregate statistics" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/stats\.get\.json\?.*aggregate=1|, :body => '{"requests":12342,"bounces":12,"clicks":10223,"opens":9992,"spamreports":5}')
+      stats = @obj.retrieve_aggregate
+      %w(bounces clicks delivered invalid_email opens repeat_bounces repeat_spamreports repeat_unsubscribes requests spamreports unsubscribes).each do |int|
+        stats[int].kind_of?(Integer).should == true if stats.has_key?(int) # We support all fields presently returned, but we are only testing what sendgrid officially documents
+      end
+    end
+  end
+  
+  describe "#list_categories" do
+    it "parses categories list" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/stats\.get\.json\?.*list=true|, :body => '[{"category":"categoryA"},{"category":"categoryB"},{"category":"categoryC"}]')
+      cats = @obj.list_categories
+      cats[0]['category'].should == 'categoryA'
+      cats[1]['category'].should == 'categoryB'
+      cats[2]['category'].should == 'categoryC'
+    end
+  end
+end

data/spec/lib/sendgrid_toolkit/unsubscribes_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::Unsubscribes do
+  before do
+    FakeWeb.clean_registry
+    @obj = SendgridToolkit::Unsubscribes.new("fakeuser", "fakepass")
+  end
+  
+  describe "#retrieve" do
+    it "returns array of unsubscribed email addresses" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/unsubscribes\.get\.json\?|, :body => '[{"email":"user@domain.com"},{"email":"user2@domain2.com"},{"email":"user3@domain2.com"}]')
+      emails = @obj.retrieve
+      emails[0]['email'].should == "user@domain.com"
+      emails[1]['email'].should == "user2@domain2.com"
+      emails[2]['email'].should == "user3@domain2.com"
+    end
+  end
+  describe "#retrieve_with_timestamps" do
+    it "parses timestamps" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/unsubscribes\.get\.json\?.*date=1|, :body => '[{"email":"user@domain.com","created":"2010-03-03 11:00:00"},{"email":"user2@domain2.com","created":"2010-03-04 21:00:00"},{"email":"user3@domain2.com","created":"2010-03-05 23:00:00"}]')
+      emails = @obj.retrieve_with_timestamps
+      0.upto(2) do |index|
+        emails[index]['created'].kind_of?(Time).should == true
+      end
+      emails[0]['created'].asctime.should == "Wed Mar  3 11:00:00 2010"
+      emails[1]['created'].asctime.should == "Thu Mar  4 21:00:00 2010"
+      emails[2]['created'].asctime.should == "Fri Mar  5 23:00:00 2010"
+    end
+  end
+  
+  describe "#add" do
+    it "raises no errors on success" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/unsubscribes\.add\.json\?.*email=.+|, :body => '{"message":"success"}')
+      lambda {
+        @obj.add :email => "user@domain.com"
+      }.should_not raise_error
+    end
+    it "raises error when email already exists" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/unsubscribes\.add\.json\?.*email=.+|, :body => '{"message":"Unsubscribe email address already exists"}')
+      lambda {
+        @obj.add :email => "user@domain.com"
+      }.should raise_error SendgridToolkit::UnsubscribeEmailAlreadyExists
+    end
+  end
+  
+  describe "#delete" do
+    it "raises no errors on success" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/unsubscribes\.delete\.json\?.*email=.+|, :body => '{"message":"success"}')
+      lambda {
+        @obj.delete :email => "user@domain.com"
+      }.should_not raise_error
+    end
+    it "raises error when email address does not exist" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/unsubscribes\.delete\.json\?.*email=.+|, :body => '{"message":"Email does not exist"}')
+      lambda {
+        @obj.delete :email => "user@domain.com"
+      }.should raise_error SendgridToolkit::UnsubscribeEmailDoesNotExist
+    end
+  end
+end

data/spec/lib/sendgrid_toolkit_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../helper")
+
+describe SendgridToolkit do
+end

data/spec/webconnect/sendgrid_toolkit_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../helper")
+
+FakeWeb.allow_net_connect = true
+
+describe SendgridToolkit do
+  before :all do
+    FakeWeb.clean_registry
+    FakeWeb.allow_net_connect = true
+  end
+  after :all do
+    FakeWeb.allow_net_connect = false
+  end
+  
+  before do
+    backup_env
+    
+    # Don't let SendgridToolkit fall back to SMTP_USERNAME and SMTP_PASSWORD
+    ENV['SMTP_USERNAME'] = ENV['TEST_SMTP_USERNAME'].blank? ? "fakeuser" : ENV['TEST_SMTP_USERNAME']
+    ENV['SMTP_PASSWORD'] = ENV['TEST_SMTP_PASSWORD'].blank? ? "fakepass" : ENV['TEST_SMTP_PASSWORD']
+  end
+  after do
+    restore_env
+  end
+  
+  describe "statistics i/o" do
+    before do
+      @obj = SendgridToolkit::Statistics.new
+    end
+    xit "retrieves statistics by day" do
+      stats = @obj.retrieve
+      stats.count.should > 0
+      day_stats = stats.first
+      %w(date requests bounces clicks opens spamreports).each do |k|
+        day_stats.has_key?(k).should == true
+      end
+    end
+    xit "retrieves aggregate statistics" do
+      stats = @obj.retrieve_aggregate
+      %w(requests bounces clicks opens spamreports).each do |k|
+        stats.has_key?(k).should == true
+      end
+    end
+  end
+  
+  describe "unsubscribes i/o" do
+    before do
+      @obj = SendgridToolkit::Unsubscribes.new
+      unsubscribes = @obj.retrieve
+      unsubscribes.each do |u|
+        @obj.delete u['email']
+      end
+    end
+    xit "adds, retrieves and deletes email addresses properly" do
+      @obj.add "user@domain.com"
+      @obj.add "user2@domain.com"
+      unsubs = @obj.retrieve_with_timestamps
+      emails = unsubs.map {|h| h['email']}
+      emails.include?('user@domain.com').should == true
+      emails.include?('user2@domain.com').should == true
+      @obj.delete 'user@domain.com'
+      @obj.delete 'user2@domain.com'
+      @obj.retrieve.count.should == 0
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: sendgrid_toolkit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Robby Grossman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-07 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A Ruby wrapper and utility library for communicating with the Sendgrid API
+email: robby@freerobby.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sendgrid_toolkit.rb
+- lib/sendgrid_toolkit/abstract_sendgrid_client.rb
+- lib/sendgrid_toolkit/sendgrid_error.rb
+- lib/sendgrid_toolkit/statistics.rb
+- lib/sendgrid_toolkit/unsubscribes.rb
+- spec/helper.rb
+- spec/lib/sendgrid_toolkit/abstract_sendgrid_client_spec.rb
+- spec/lib/sendgrid_toolkit/statistics_spec.rb
+- spec/lib/sendgrid_toolkit/unsubscribes_spec.rb
+- spec/lib/sendgrid_toolkit_spec.rb
+- spec/webconnect/sendgrid_toolkit_spec.rb
+has_rdoc: true
+homepage: http://github.com/freerobby/sendgrid_toolkit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper and utility library for communicating with the Sendgrid API
+test_files: 
+- spec/helper.rb
+- spec/lib/sendgrid_toolkit/abstract_sendgrid_client_spec.rb
+- spec/lib/sendgrid_toolkit/statistics_spec.rb
+- spec/lib/sendgrid_toolkit/unsubscribes_spec.rb
+- spec/lib/sendgrid_toolkit_spec.rb
+- spec/webconnect/sendgrid_toolkit_spec.rb