eliasbaixas-sendgrid_toolkit 1.0.5

data/README.md

@@ -0,0 +1,278 @@
+SendgridToolkit
+===============
+
+SendgridToolkit is a Ruby wrapper for the Sendgrid Web API
+
+Supported Modules
+-----------------
+
+SendgridToolkit provides a class for interacting with each of the following Sendgrid API modules:
+
+  - Bounces
+  - InvalidEmails
+  - SpamReports
+  - Statistics
+  - Unsubscribes
+
+Consuming the Sendgrid API is as simple as instantiating a class and making the call:
+
+    unsubscribes = SendgridToolkit::Unsubscribes.new("username", "api_key")
+    unsubscribes.add :email => "email@to.unsubscribe"
+
+Two lines, and voila!
+
+Common actions are documented below under each module. For more details, visit the [Sendgrid Web API Documentation][2]
+
+Contributing
+------------
+
+When submitting patches, please be sure you include rspec tests!
+
+Big thanks to [James Brennan][1] for refactoring old code and writing the Bounces, InvalidEmails and SpamReports modules.
+
+Bounces Module
+--------------
+The bounces module provides access to all of your bounces.
+
+- - -
+
+Instantiate the Bounces object:
+
+    bounces = SendgridToolkit::Bounces.new(api_user, api_key)
+
+- - -
+
+Retrieve bounces:
+
+    all_bounces = bounces.retrieve
+
+`all_bounces` will be an array of hashes, each of which contains the following keys:
+
+  - `email`: the recipient's email address
+  - `status`: the status of email
+  - `reason`: the reason for the bounce, as specified by the recipient's email server
+
+- - -
+
+Get the timestamp of each bounce:
+
+    all_bounces = bounces.retrieve_with_timestamps
+
+Each hash in `all_bounces` will now contain a `created` key, which holds a Ruby Time object.
+
+- - -
+
+If you believe an email address will no longer bounce and would like Sendgrid to deliver future emails to that address, you may delete the Bounce entry:
+
+    bounces.delete :email => "email@address.of.bounce.to.delete"
+
+InvalidEmails Module
+--------------------
+
+The InvalidEmails module provides access to all of your email addresses.
+
+- - -
+
+Instantiate the InvalidEmails object:
+
+    invalid_emails_obj = SendgridToolkit::InvalidEmails.new(api_user, api_key)
+
+- - -
+
+Retrieve invalid emails:
+
+    invalid_emails = invalid_emails_obj.retrieve
+
+`invalid_emails` will be an array of hashes, each of which contains the following keys:
+
+  - `email`: the recipient's email address
+  - `reason`: the reason the email address is believed to be invalid
+
+- - -
+
+Get the timestamp that each email was determined to be invalid:
+
+    invalid_emails = invalid_emails_obj.retrieve_with_timestamps
+
+Each hash in `invalid_emails` will now contain a `created` key, which holds a Ruby Time object.
+
+- - -
+
+If you believe a once-invalid email address is now valid and would like Sendgrid to deliver future emails to that address, you may delete the InvalidEmail entry:
+
+    invalid_emails.delete :email => "email@address.of.invalid.to.delete"
+
+SpamReports Module
+------------------
+
+The SpamReports module provides access to all email addresses that have reported you for spam.
+
+- - -
+
+Instantiate the SpamReports object:
+
+    spam_reports_obj = SendgridToolkit::SpamReports.new(api_user, api_key)
+
+- - -
+
+Retrieve spam reports:
+
+    spam_reports = spam_reports_obj.retrieve
+
+`spam_reports` will be an array of hashes, each of which contains an `email` key, indicating the email address that reported you for spam.
+
+- - -
+
+Get the timestamp of each spam report:
+
+    spam_reports = spam_reports_obj.retrieve_with_timestamps
+
+Each hash in `spam_reports` will now contain a `created` key, which holds a Ruby Time object.
+
+- - -
+
+If you believe a user will no longer consider your content to be spam, you may delete the SpamReport entry:
+
+    spam_reports.delete :email => "email@address.that.called.you.a.spammer"
+
+Statistics Module
+-----------------
+The statistics module provides access to all of your email statistics.
+
+- - -
+
+Instantiate the Statistics object:
+
+    statistics = SendgridToolkit::Statistics.new(api_user, api_key)
+
+- - -
+
+Retrieve statistics:
+
+    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:
+
+    stats = statistics.retrieve :days => 5
+
+To narrow your retrieval to emails within the last month but before one week ago:
+
+    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):
+
+    stats = statistics.retrieve :category => "NameOfYourCategory"
+
+Note: You may combine a category query with other options, i.e.:
+
+    stats = statistics.retrieve :category => "NameOfYourCategory", :days => 5
+
+- - -
+
+Receive your all-time statistics:
+
+    stats = statistics.retrieve_aggregate
+
+`stats` will be a single hash containing all of the aforementioned keys except `date`.
+
+- - -
+
+If you use Sendgrid's category feature, you can list your categories:
+
+    cats = statistics.list_categories
+
+`cats` is an array of hashes, each of which has a `category` key that holds the name of a category.
+
+Unsubscribes Module
+-------------------
+The unsubscribes module manages your list of unsubscribed email addresses.
+
+- - -
+
+Instantiate the Unsubscribes object:
+
+    unsubscribes = SendgridToolkit::Unsubscribes.new(api_user, api_key)
+
+- - -
+
+List 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.
+
+- - -
+
+Get the timestamp when each user unsubscribed:
+
+    listing = unsubscribes.retrieve_with_timestamps
+
+Each hash in `listing` will now contain a `created` key, which holds a Ruby Time object.
+
+- - -
+
+Unsubscribe a user from your sendgrid email:
+
+    unsubscribes.add :email => "email@to.unsubscribe"
+
+SendgridToolkit will throw `UnsubscribeEmailAlreadyExists` if the email you specified is already on the list
+
+- - -
+
+Remove a user from your unsubscribe list:
+
+    unsubscribes.delete :email => "email@that_is.unsubscribed"
+
+SendgridToolkit will throw `UnsubscribeEmailDoesNotExist` if the email you specified is not on the list
+
+
+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.
+
+If authentication fails during an API request, SendgridToolkit throws `AuthenticationFailed`.
+
+
+In Case You're Curious...
+-------------------------
+
+API requests are made and responses are received in JSON. All requests are made as POSTs unless noted otherwise (Sendgrid's examples are via GET, but they support POST)
+
+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 limited 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).
+
+[1]: http://github.com/jamesBrennan
+[2]: http://wiki.sendgrid.com/doku.php?id=web_api

data/Rakefile

@@ -0,0 +1,22 @@
+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"]
+    
+    gemspec.add_dependency "httparty"
+    # Development dependencies: fakeweb, rake, jeweler, rspec
+  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 @@
+1.0.5

data/lib/sendgrid_toolkit.rb

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

data/lib/sendgrid_toolkit/abstract_sendgrid_client.rb

@@ -0,0 +1,38 @@
+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 = {})
+      response = HTTParty.post("https://#{BASE_URI}/#{module_name}.#{action_name}.json?", :query => get_credentials.merge(opts), :format => :json)
+      if response.code > 401
+        raise(SendgridToolkit::SendgridServerError, "The sengrid server returned an error. #{response.inspect}")
+      elsif has_error?(response) and
+          response['error'].respond_to?(:has_key?) and
+          response['error'].has_key?('code') and
+          response['error']['code'].to_i == 401
+        raise SendgridToolkit::AuthenticationFailed
+      elsif has_error?(response)
+        raise(SendgridToolkit::APIError, response['error'])
+      end
+      response
+    end
+
+    def get_credentials
+      {:api_user => @api_user, :api_key => @api_key}
+    end
+
+    private
+    def has_error?(response)
+      response.kind_of?(Hash) && response.has_key?('error')
+    end
+  end
+end

data/lib/sendgrid_toolkit/bounces.rb

@@ -0,0 +1,7 @@
+module SendgridToolkit
+
+  class Bounces < AbstractSendgridClient
+    include SendgridToolkit::Common
+  end
+
+end

data/lib/sendgrid_toolkit/common.rb

@@ -0,0 +1,43 @@
+module SendgridToolkit
+
+  module Common
+
+    def retrieve(options = {})
+      response = api_post(module_name, 'get', options)
+      response
+    end
+
+    def retrieve_with_timestamps(options = {})
+      options.merge! :date => 1
+      response = retrieve options
+      if response.is_a? Array
+        response.each do |message|
+          parse_message_time message
+        end
+      else
+        parse_message_time response
+      end
+      response
+    end
+
+    def delete(options = {})
+      response = api_post(module_name, 'delete', options)
+      if !response["message"].nil?
+        raise EmailDoesNotExist if response['message'].include?('does not exist')
+      end
+      response
+    end
+
+    def module_name
+      self.class.to_s.split("::").last.downcase
+    end
+
+    private
+
+    def parse_message_time(message)
+      message['created'] = Time.parse(message['created']) if message.has_key?('created')
+    end
+
+  end
+
+end

data/lib/sendgrid_toolkit/invalid_emails.rb

@@ -0,0 +1,7 @@
+module SendgridToolkit
+
+  class InvalidEmails < AbstractSendgridClient
+    include SendgridToolkit::Common
+  end
+
+end

data/lib/sendgrid_toolkit/sendgrid_error.rb

@@ -0,0 +1,10 @@
+module SendgridToolkit
+  class AuthenticationFailed < StandardError; end
+  class NoAPIKeySpecified < StandardError; end
+  class NoAPIUserSpecified < StandardError; end
+  class UnsubscribeEmailAlreadyExists < StandardError; end
+  class UnsubscribeEmailDoesNotExist < StandardError; end
+  class EmailDoesNotExist < StandardError; end
+  class SendgridServerError < StandardError; end
+  class APIError < StandardError; end
+end

data/lib/sendgrid_toolkit/spam_reports.rb

@@ -0,0 +1,7 @@
+module SendgridToolkit
+
+  class SpamReports < AbstractSendgridClient
+    include SendgridToolkit::Common
+  end
+
+end

data/lib/sendgrid_toolkit/statistics.rb

@@ -0,0 +1,31 @@
+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
+      if Hash === response.parsed_response
+          to_ints(response.parsed_response)
+      elsif Array === response.parsed_response
+          response.parsed_response.each {|o| to_ints(o) }
+      end
+      response
+    end
+
+    def to_ints(resp)
+      %w(bounces clicks delivered invalid_email opens repeat_bounces repeat_spamreports repeat_unsubscribes requests spamreports unsubscribes).each do |int_field|
+        resp[int_field] = resp[int_field].to_i if resp.has_key?(int_field)
+      end
+    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/sendgrid_toolkit.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{eliasbaixas-sendgrid_toolkit}
+  s.version = "1.0.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Robby Grossman}]
+  s.date = %q{2011-09-19}
+  s.description = %q{A Ruby wrapper and utility library for communicating with the Sendgrid API}
+  s.email = %q{robby@freerobby.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/sendgrid_toolkit.rb",
+    "lib/sendgrid_toolkit/abstract_sendgrid_client.rb",
+    "lib/sendgrid_toolkit/bounces.rb",
+    "lib/sendgrid_toolkit/common.rb",
+    "lib/sendgrid_toolkit/invalid_emails.rb",
+    "lib/sendgrid_toolkit/sendgrid_error.rb",
+    "lib/sendgrid_toolkit/spam_reports.rb",
+    "lib/sendgrid_toolkit/statistics.rb",
+    "lib/sendgrid_toolkit/unsubscribes.rb",
+    "sendgrid_toolkit.gemspec",
+    "spec/helper.rb",
+    "spec/lib/sendgrid_toolkit/abstract_sendgrid_client_spec.rb",
+    "spec/lib/sendgrid_toolkit/bounces_spec.rb",
+    "spec/lib/sendgrid_toolkit/common_spec.rb",
+    "spec/lib/sendgrid_toolkit/invalid_emails_spec.rb",
+    "spec/lib/sendgrid_toolkit/spam_reports_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"
+  ]
+  s.homepage = %q{http://github.com/freerobby/sendgrid_toolkit}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{A Ruby wrapper and utility library for communicating with the Sendgrid API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+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,69 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::AbstractSendgridClient do
+  before do
+    backup_env
+  end
+  after do
+    restore_env
+  end
+
+  describe "#api_post" do
+    it "throws error when authentication fails" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/profile\.get\.json\?|, :body => '{"error":{"code":401,"message":"Permission denied, wrong credentials"}}')
+      @obj = SendgridToolkit::AbstractSendgridClient.new("fakeuser", "fakepass")
+      lambda {
+        @obj.send(:api_post, "profile", "get", {})
+      }.should raise_error SendgridToolkit::AuthenticationFailed
+    end
+    it "thows error when sendgrid response is a server error" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/profile\.get\.json\?|, :body => 'A server error occured', :status => ['500', 'Internal Server Error'])
+      @obj = SendgridToolkit::AbstractSendgridClient.new("someuser", "somepass")
+      lambda {
+        @obj.send(:api_post, "profile", "get", {})
+      }.should raise_error SendgridToolkit::SendgridServerError
+    end
+    it "thows error when sendgrid response is an API error" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/stats\.get\.json\?|, :body => '{"error": "error in end_date: end date is in the future"}', :status => ['400', 'Bad Request'])
+      @obj = SendgridToolkit::AbstractSendgridClient.new("someuser", "somepass")
+      lambda {
+        @obj.send(:api_post, "stats", "get", {})
+      }.should raise_error SendgridToolkit::APIError
+    end
+  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/bounces_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::Bounces do
+  before do
+    FakeWeb.clean_registry
+    @obj = SendgridToolkit::Bounces.new("fakeuser", "fakepass")
+  end
+
+  describe "#retrieve" do
+    it "returns array of bounced emails" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/bounces\.get\.json\?|, :body => '[{"email":"email1@domain.com","status":"5.1.1","reason":"host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com"},{"email":"email2@domain2.com","status":"5.1.1","reason":"host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email2@domain2.com"}]')
+      bounces = @obj.retrieve
+      bounces[0]['email'].should == "email1@domain.com"
+      bounces[0]['status'].should == "5.1.1"
+      bounces[0]['reason'].should == "host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com"
+    end
+  end
+
+  describe "#retrieve_with_timestamps" do
+    it "parses timestamps" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/bounces\.get\.json\?.*date=1|, :body => '[{"email":"email1@domain.com","status":"5.1.1","reason":"host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email1@domain.com","created":"2009-06-01 19:41:39"},{"email":"email2@domain2.com","status":"5.1.1","reason":"host [127.0.0.1] said: 550 5.1.1 unknown or illegal user: email2@domain2.com","created":"2009-06-12 19:41:39"}]')
+      bounces = @obj.retrieve_with_timestamps
+      0.upto(1) do |index|
+        bounces[index]['created'].kind_of?(Time).should == true
+      end
+      bounces[0]['created'].asctime.should == "Mon Jun  1 19:41:39 2009"
+      bounces[1]['created'].asctime.should == "Fri Jun 12 19:41:39 2009"
+    end
+  end
+
+  describe "#delete" do
+    it "raises no errors on success" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/bounces\.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/bounces\.delete\.json\?.*email=.+|, :body => '{"message":"Email does not exist"}')
+      lambda {
+        @obj.delete :email => "user@domain.com"
+      }.should raise_error SendgridToolkit::EmailDoesNotExist
+    end
+    it "does not choke if response does not have a 'message' field" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/bounces\.delete\.json\?.*email=.+|, :body => 'An internal server error occurred. Please try again later.')
+      lambda {
+        @obj.delete :email => "user@domain.com"
+      }.should_not raise_error
+    end
+  end
+
+end

data/spec/lib/sendgrid_toolkit/common_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::Common do
+
+  before do
+    class FakeClass < SendgridToolkit::AbstractSendgridClient
+      include SendgridToolkit::Common
+    end
+    @fake_class = FakeClass.new
+  end
+
+  it "creates a module_name method that returns the class name downcased" do
+    @fake_class.module_name.should == "fakeclass"
+  end
+
+  it "does not choke if response does not have a 'message' field" do
+    FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/fakeclass\.delete\.json\?.*email=.+|, :body => 'An internal server error occurred. Please try again later.')
+    lambda {
+      @fake_class.delete :email => "user@domain.com"
+    }.should_not raise_error
+  end
+
+end

data/spec/lib/sendgrid_toolkit/invalid_emails_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::InvalidEmails do
+  before do
+    FakeWeb.clean_registry
+    @obj = SendgridToolkit::InvalidEmails.new("fakeuser", "fakepass")
+  end
+
+  describe "#retrieve" do
+    it "returns array of invalid emails" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/invalidemails\.get\.json\?|, :body => '[{"email":"isaac@hotmail.comm","reason":"Mail domain mentioned in email address is unknown"},{"email":"isaac@hotmail","reason":"Bad Syntax"},{"email":"isaac@example.com","reason":"Known bad domain"}]')
+      invalid_emails = @obj.retrieve
+      invalid_emails[0]['email'].should == "isaac@hotmail.comm"
+      invalid_emails[0]['reason'].should == "Mail domain mentioned in email address is unknown"
+      invalid_emails[1]['email'].should == "isaac@hotmail"
+      invalid_emails[1]['reason'].should == "Bad Syntax"
+      invalid_emails[2]['email'].should == "isaac@example.com"
+      invalid_emails[2]['reason'].should == "Known bad domain"
+    end
+  end
+
+  describe "#retrieve_with_timestamps" do
+    it "parses timestamps" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/invalidemails\.get\.json\?.*date=1|, :body => '[{"email":"isaac@hotmail.comm","reason":"Mail domain mentioned in email address is unknown","created":"2009-06-01 19:41:39"},{"email":"isaac@hotmail","reason":"Bad Syntax","created":"2009-06-12 19:41:39"},{"email":"isaac@example.com","reason":"Known bad domain","created":"2009-06-13 09:40:01"}]')
+      invalid_emails = @obj.retrieve_with_timestamps
+      0.upto(2) do |index|
+        invalid_emails[index]['created'].kind_of?(Time).should == true
+      end
+      invalid_emails[0]['created'].asctime.should == "Mon Jun  1 19:41:39 2009"
+      invalid_emails[1]['created'].asctime.should == "Fri Jun 12 19:41:39 2009"
+      invalid_emails[2]['created'].asctime.should == "Sat Jun 13 09:40:01 2009"
+    end
+  end
+
+  describe "#delete" do
+    it "raises no errors on success" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/invalidemails\.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/invalidemails\.delete\.json\?.*email=.+|, :body => '{"message":"Email does not exist"}')
+      lambda {
+        @obj.delete :email => "user@domain.com"
+      }.should raise_error SendgridToolkit::EmailDoesNotExist
+    end
+  end
+
+end

data/spec/lib/sendgrid_toolkit/spam_reports_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::SpamReports do
+  before do
+    FakeWeb.clean_registry
+    @obj = SendgridToolkit::SpamReports.new("fakeuser", "fakepass")
+  end
+
+  describe "#retrieve" do
+    it "returns array of bounced emails" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/spamreports\.get\.json\?|, :body => '[{"email":"email1@domain.com"},{"email":"email2@domain2.com"}]')
+      bounces = @obj.retrieve
+      bounces[0]['email'].should == "email1@domain.com"
+      bounces[1]['email'].should == "email2@domain2.com"
+    end
+  end
+
+  describe "#retrieve_with_timestamps" do
+    it "parses timestamps" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/spamreports\.get\.json\?.*date=1|, :body => '[{"email":"email1@domain.com","created":"2009-06-01 19:41:39"},{"email":"email2@domain2.com","created":"2009-06-12 19:41:39"}]')
+      bounces = @obj.retrieve_with_timestamps
+      0.upto(1) do |index|
+        bounces[index]['created'].kind_of?(Time).should == true
+      end
+      bounces[0]['created'].asctime.should == "Mon Jun  1 19:41:39 2009"
+      bounces[1]['created'].asctime.should == "Fri Jun 12 19:41:39 2009"
+    end
+  end
+
+  describe "#delete" do
+    it "raises no errors on success" do
+      FakeWeb.register_uri(:post, %r|https://sendgrid\.com/api/spamreports\.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/spamreports\.delete\.json\?.*email=.+|, :body => '{"message":"Email does not exist"}')
+      lambda {
+        @obj.delete :email => "user@domain.com"
+      }.should raise_error SendgridToolkit::EmailDoesNotExist
+    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,74 @@
+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 "abstract_sendgrid_client i/o" do
+    xit "throws authentication error when authentication fails" do
+      @obj = SendgridToolkit::AbstractSendgridClient.new("fakeuser", "fakepass")
+      lambda {
+        @obj.send(:api_post, "profile", "get", {})
+      }.should raise_error SendgridToolkit::AuthenticationFailed
+    end
+  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,100 @@
+--- !ruby/object:Gem::Specification 
+name: eliasbaixas-sendgrid_toolkit
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 5
+  version: 1.0.5
+platform: ruby
+authors: 
+- Robby Grossman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A Ruby wrapper and utility library for communicating with the Sendgrid API
+email: robby@freerobby.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- lib/sendgrid_toolkit.rb
+- lib/sendgrid_toolkit/abstract_sendgrid_client.rb
+- lib/sendgrid_toolkit/bounces.rb
+- lib/sendgrid_toolkit/common.rb
+- lib/sendgrid_toolkit/invalid_emails.rb
+- lib/sendgrid_toolkit/sendgrid_error.rb
+- lib/sendgrid_toolkit/spam_reports.rb
+- lib/sendgrid_toolkit/statistics.rb
+- lib/sendgrid_toolkit/unsubscribes.rb
+- sendgrid_toolkit.gemspec
+- spec/helper.rb
+- spec/lib/sendgrid_toolkit/abstract_sendgrid_client_spec.rb
+- spec/lib/sendgrid_toolkit/bounces_spec.rb
+- spec/lib/sendgrid_toolkit/common_spec.rb
+- spec/lib/sendgrid_toolkit/invalid_emails_spec.rb
+- spec/lib/sendgrid_toolkit/spam_reports_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
+homepage: http://github.com/freerobby/sendgrid_toolkit
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper and utility library for communicating with the Sendgrid API
+test_files: []
+