sendgrid_toolkit 0.1.1 → 1.0.0

data/.gitignore

@@ -1,2 +1,3 @@
 pkg/
-doc/
+doc/
+.idea/*

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/VERSION

@@ -1 +1 @@
-0.1.1
+1.0.0

data/lib/sendgrid_toolkit.rb

@@ -1,9 +1,13 @@
 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"

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,31 @@
+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
+      response.each do |unsubscribe|
+        unsubscribe['created'] = Time.parse(unsubscribe['created']) if unsubscribe.has_key?('created')
+      end
+      response
+    end
+
+    def delete(options = {})
+      response = api_post(module_name, 'delete', options)
+      raise EmailDoesNotExist if response['message'].include?('does not exist')
+      response
+    end
+
+    def module_name
+      self.class.to_s.split("::").last.downcase
+    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

@@ -4,4 +4,5 @@ module SendgridToolkit
   class NoAPIUserSpecified < StandardError; end
   class UnsubscribeEmailAlreadyExists < StandardError; end
   class UnsubscribeEmailDoesNotExist < StandardError; end
+  class EmailDoesNotExist < 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/sendgrid_toolkit.gemspec

@@ -5,29 +5,37 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sendgrid_toolkit}
-  s.version = "0.1.1"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robby Grossman"]
-  s.date = %q{2010-03-07}
+  s.date = %q{2010-09-10}
   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.rdoc"
+    "README.md"
   ]
   s.files = [
     ".gitignore",
-     "README.rdoc",
+     "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",
@@ -36,11 +44,15 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/freerobby/sendgrid_toolkit}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby wrapper and utility library for communicating with the Sendgrid API}
   s.test_files = [
     "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",
@@ -51,7 +63,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/lib/sendgrid_toolkit/bounces_spec.rb

@@ -0,0 +1,46 @@
+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
+  end
+
+end

data/spec/lib/sendgrid_toolkit/common_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../../helper")
+
+describe SendgridToolkit::Common do
+
+  before do
+    class FakeClass
+      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
+
+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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sendgrid_toolkit
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
-  - 0
-  - 1
   - 1
-  version: 0.1.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Robby Grossman
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 -05:00
+date: 2010-09-10 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -25,20 +26,28 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
 - .gitignore
-- README.rdoc
+- 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
@@ -53,29 +62,37 @@ 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.3.6
+rubygems_version: 1.3.7
 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/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

data/README.rdoc

@@ -1,103 +0,0 @@
-= 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.
-
-If authentication fails during an API request, SendgridToolkit throws AuthenticationFailed.
-
-== 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).