sendgrid_toolkit 1.1.0 → 1.1.1

data/README.md

@@ -37,6 +37,18 @@ Contributing
 
 Big thanks to [James Brennan][1] for refactoring old code and writing the Bounces, InvalidEmails and SpamReports modules.
 
+Setting your API credentials globally
+-------------------------------------
+
+Setting your API user and key once globally for all API access:
+
+    SendgridToolkit.api_user = "bob"
+    SendgridToolkit.api_key = "x123y"
+    
+If you do this when you create individual API objects you will not need to pass the `api_user` or `api_key`
+
+    bounces = SendgridToolkit::Bounces.new
+
 Bounces Module
 --------------
 The bounces module provides access to all of your bounces.
@@ -116,13 +128,13 @@ The Mail module lets you send email via the web API.
 
 - - -
 
-Call `:send_email` (chosen to avoid conflicts with Object:send) with the standard parameters:
+Call `:send_mail` (chosen to avoid conflicts with Object:send) with the standard parameters:
 
-    SendgridToolkit::Mail.new(api_user, api_key).send_email :to => "user@domain.com", :from => "recipient@domain.com", :subject => "Some Subject", :text => "Some text"
+    SendgridToolkit::Mail.new(api_user, api_key).send_mail :to => "user@domain.com", :from => "recipient@domain.com", :subject => "Some Subject", :text => "Some text"
 
 The complete set of "x-smtpapi" options are also supported. You can use them like:
 
-  SendgridToolkit::Mail.new(api_user, api_key).send_email :to => "user@domain.com", :from => "recipient@domain.com", :subject => "Some Subject", :text => "Some text", "x-smtpapi" => {:category => "Retention"}
+  SendgridToolkit::Mail.new(api_user, api_key).send_mail :to => "user@domain.com", :from => "recipient@domain.com", :subject => "Some Subject", :text => "Some text", "x-smtpapi" => {:category => "Retention"}
 
 SpamReports Module
 ------------------

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/sendgrid_toolkit/abstract_sendgrid_client.rb

@@ -2,8 +2,8 @@ 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
+      @api_user = api_user || SendgridToolkit.api_user || ENV['SMTP_USERNAME']
+      @api_key = api_key || SendgridToolkit.api_key || ENV['SMTP_PASSWORD']
 
       raise SendgridToolkit::NoAPIUserSpecified if @api_user.nil? || @api_user.length == 0
       raise SendgridToolkit::NoAPIKeySpecified if @api_key.nil? || @api_key.length == 0

data/lib/sendgrid_toolkit.rb

@@ -12,4 +12,13 @@ require 'sendgrid_toolkit/mail'
 
 module SendgridToolkit
   BASE_URI = "sendgrid.com/api"
+  
+  class << self
+    def api_user=(v); @api_user = v; end
+    def api_user; @api_user; end
+    
+    def api_key=(v); @api_key = v; end
+    def api_key; @api_key; end
+  end
+  
 end

data/sendgrid_toolkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sendgrid_toolkit"
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robby Grossman"]
-  s.date = "2011-11-01"
+  s.date = "2012-02-16"
   s.description = "A Ruby wrapper and utility library for communicating with the Sendgrid API."
   s.email = "robby@freerobby.com"
   s.extra_rdoc_files = [

data/spec/lib/sendgrid_toolkit/abstract_sendgrid_client_spec.rb

@@ -33,6 +33,10 @@ describe SendgridToolkit::AbstractSendgridClient do
   end
 
   describe "#initialize" do
+    after(:each) do
+      SendgridToolkit.api_user = nil
+      SendgridToolkit.api_key = nil
+    end
     it "stores api credentials when passed in" do
       ENV['SMTP_USERNAME'] = "env_username"
       ENV['SMTP_PASSWORD'] = "env_apikey"
@@ -41,6 +45,17 @@ describe SendgridToolkit::AbstractSendgridClient do
       @obj.instance_variable_get("@api_user").should == "username"
       @obj.instance_variable_get("@api_key").should == "apikey"
     end
+    it "uses module level user and key if they are set" do
+      SendgridToolkit.api_user = "username"
+      SendgridToolkit.api_key = "apikey"
+      
+      SendgridToolkit.api_key.should == "apikey"
+      SendgridToolkit.api_user.should == "username"
+
+      @obj = SendgridToolkit::AbstractSendgridClient.new
+      @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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid_toolkit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2012-02-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70223621474660 !ruby/object:Gem::Requirement
+  requirement: &70179196616160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70223621474660
+  version_requirements: *70179196616160
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70223621472980 !ruby/object:Gem::Requirement
+  requirement: &70179196615120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70223621472980
+  version_requirements: *70179196615120
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70223621461680 !ruby/object:Gem::Requirement
+  requirement: &70179196614160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70223621461680
+  version_requirements: *70179196614160
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70223621460080 !ruby/object:Gem::Requirement
+  requirement: &70179196613020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70223621460080
+  version_requirements: *70179196613020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70223621457860 !ruby/object:Gem::Requirement
+  requirement: &70179196612180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70223621457860
+  version_requirements: *70179196612180
 description: A Ruby wrapper and utility library for communicating with the Sendgrid
   API.
 email: robby@freerobby.com
@@ -119,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3253025820181550713
+      hash: 4463895063541210779
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: