sendgrid-api 0.0.2 → 0.0.3

data/spec/sendgrid/api/web/profile_spec.rb

@@ -15,15 +15,15 @@ module Sendgrid
 
           describe '#get' do
             let(:url) { 'profile.get.json' }
+            let(:stub_post) { sg_mock.stub_post(url) }
+            subject { service.get }
 
             context 'when request is successfull' do
               before do
-                sg_mock.stub_post(url).to_return(:body => fixture('profile.json'))
+                stub_post.to_return(:body => fixture('profile.json'))
               end
 
-              subject { service.get }
-
-              it 'should perform the request' do
+              it 'performs the request' do
                 subject
                 sg_mock.a_post(url).should have_been_made
               end
@@ -47,38 +47,22 @@ module Sendgrid
             end
 
             context 'when permission failed' do
-              before do
-                sg_mock.stub_post(url).to_return(:body => fixture('unauthorized.json'))
-              end
-
-              it 'should raise error' do
-                expect { service.get }.to raise_error(REST::Errors::Unauthorized)
-              end
+              it_behaves_like 'an unauthorized response'
             end
           end
 
           describe '#set' do
             let(:url) { 'profile.set.json' }
             let(:profile) { Entities::Profile.new(:first_name => 'Brian', :last_name => 'O\'Neill') }
+            let(:stub_post) { sg_mock.stub_post(url, profile.as_json) }
+            subject { service.set(profile) }
 
             context 'when request is successfull' do
-              before do
-                sg_mock.stub_post(url, profile.as_json).to_return(:body => fixture('success.json'))
-              end
-
-              subject { service.set(profile) }
-
-              its(:success?) { should be_true }
+              it_behaves_like 'a success response'
             end
 
             context 'when permission failed' do
-              before do
-                sg_mock.stub_post(url, profile.as_json).to_return(:body => fixture('unauthorized.json'))
-              end
-
-              it 'should raise error' do
-                expect { service.set(profile) }.to raise_error(REST::Errors::Unauthorized)
-              end
+              it_behaves_like 'an unauthorized response'
             end
           end
 
@@ -89,13 +73,13 @@ module Sendgrid
               let(:resource) { REST::Resource.new(env_user, env_key) }
 
               describe '#get' do
-                it 'should get profile' do
+                it 'gets profile' do
                   subject.get.should be_instance_of(Entities::Profile)
                 end
               end
 
               describe '#set' do
-                it 'should update profile' do
+                it 'updates profile' do
                   profile = subject.get
                   subject.set(profile).success?.should be_true
                 end
@@ -104,7 +88,7 @@ module Sendgrid
 
             context 'when credentials are invalid' do
               describe '#get' do
-                it 'should raise error' do
+                it 'raises error' do
                   expect { subject.get }.to raise_error(REST::Errors::Unauthorized)
                 end
               end
@@ -112,7 +96,7 @@ module Sendgrid
               describe '#set' do
                 let(:profile) { Entities::Profile.new(:first_name => 'Brian', :last_name => 'O\'Neill') }
 
-                it 'should raise error' do
+                it 'raises error' do
                   expect { subject.set(profile) }.to raise_error(REST::Errors::Unauthorized)
                 end
               end

data/spec/sendgrid/api/web/stats_spec.rb

@@ -15,15 +15,15 @@ module Sendgrid
 
           describe '#advanced' do
             let(:url) { 'stats.getAdvanced.json' }
+            let(:stub_post) { sg_mock.stub_post(url) }
+            subject { service.advanced }
 
             context 'when request is successfull' do
               before do
-                sg_mock.stub_post(url).to_return(:body => fixture('stats.json'))
+                stub_post.to_return(:body => fixture('stats.json'))
               end
 
-              subject { service.advanced }
-
-              it 'should perform the request' do
+              it 'performs the request' do
                 subject
                 sg_mock.a_post(url).should have_been_made
               end
@@ -43,20 +43,14 @@ module Sendgrid
                 its(:deferred) { should == 1975 }
                 its(:processed) { should == 5302 }
                 its(:date) { should == '2013-06-18' }
-                its(:open) { pending('should debug open method') }
+                its(:open) { pending('debugs open method') }
                 its(:click) { should == 11 }
                 its(:blocked) { should == 29 }
               end
             end
 
             context 'when permission failed' do
-              before do
-                sg_mock.stub_post(url).to_return(:body => fixture('forbidden.json'), :status => 403)
-              end
-
-              it 'should raise error' do
-                expect { service.advanced }.to raise_error(REST::Errors::Forbidden)
-              end
+              it_behaves_like 'a forbidden response'
             end
           end
 
@@ -71,13 +65,13 @@ module Sendgrid
                   # 90 days from now
                   let(:start_date) { (Time.now - (90*24*60*60)).strftime("%Y-%m-%d") }
 
-                  it 'should get stats' do
+                  it 'gets stats' do
                     subject.advanced(:start_date => start_date, :data_type => :global).should_not be_empty
                   end
                 end
 
                 context 'without required params' do
-                  it 'should raise error' do
+                  it 'raises error' do
                     expect { subject.advanced }.to raise_error(REST::Errors::BadRequest)
                   end
                 end
@@ -86,7 +80,7 @@ module Sendgrid
 
             context 'when credentials are invalid' do
               describe '#advanced' do
-                it 'should raise error' do
+                it 'raises error' do
                   expect { subject.advanced }.to raise_error(REST::Errors::Forbidden)
                 end
               end

data/spec/support/helpers.rb

@@ -12,4 +12,12 @@ end
 
 def disable_http
   WebMock.disable_net_connect!(:allow => 'coveralls.io')
+end
+
+def sample_file(options = {})
+  name = options[:name] || 'sample.txt'
+  type = options[:type] || 'plain/text'
+  content = options[:content] || 'This is my file content'
+  stream = StringIO.new(content)
+  Faraday::UploadIO.new(stream, type, name)
 end

data/spec/support/mock.rb

@@ -8,15 +8,19 @@ module Sendgrid
     end
 
     def stub_post(path, params = {})
-      stub_request(:post, Sendgrid::API::REST::Resource::ENDPOINT + '/' + path).
+      stub_request(:post, uri(path)).
         with(:body => params.merge(authentication_params))
     end
 
     def a_post(path, params = {})
-      a_request(:post, Sendgrid::API::REST::Resource::ENDPOINT + '/' + path).
+      a_request(:post, uri(path)).
         with(:body => params.merge(authentication_params))
     end
 
+    def uri(path)
+      Sendgrid::API::REST::Resource::ENDPOINT + '/' + path
+    end
+
     private
 
     def authentication_params

data/spec/support/online.rb

@@ -0,0 +1,114 @@
+class Online
+
+  attr_reader :client
+
+  def initialize(user, key)
+    @client = Sendgrid::API::Client.new(user, key)
+  end
+
+  def sender_address_example
+    Sendgrid::API::Entities::SenderAddress.new(
+      :identity => 'sendgrid-api sender address test',
+      :name     => 'Sendgrid',
+      :email    => 'contact@sendgrid.com',
+      :address  => '1065 N Pacificenter Drive, Suite 425',
+      :city     => 'Anaheim',
+      :state    => 'CA',
+      :zip      => '92806',
+      :country  => 'US'
+    )
+  end
+
+  def marketing_email_example
+    identity = sender_address_example.identity
+    Sendgrid::API::Entities::MarketingEmail.new(
+      :identity => identity, 
+      :name     => 'sendgrid-api marketing email test', 
+      :subject  => 'My Marketing Email Test', 
+      :text     => 'My text', 
+      :html     => 'My HTML'
+    )
+  end
+
+  def category_example
+    Sendgrid::API::Entities::Category.new(
+      :category => 'sendgrid-api test'
+    )
+  end
+
+  def list_example
+    Sendgrid::API::Entities::List.new(
+      :list => 'sendgrid-api list test'
+    )
+  end
+
+  def emails_example
+    [
+      Sendgrid::API::Entities::Email.new(:email => 'john@example.com', :name => 'John'),
+      Sendgrid::API::Entities::Email.new(:email => 'brian@example.com', :name => 'Brian')
+    ]
+  end
+
+  def add_marketing_email
+    client.sender_addresses.add(sender_address_example)
+    client.marketing_emails.add(marketing_email_example)
+  end
+
+  def delete_marketing_email
+    client.marketing_emails.delete(marketing_email_example)
+    client.sender_addresses.delete(sender_address_example)
+  end
+
+  def add_list
+    client.lists.add(list_example)
+    client.emails.add(list_example, emails_example)
+  end
+
+  def delete_list
+    client.lists.delete(list_example)
+  end
+
+  def add_recipient_list
+    check_completed do
+      begin
+        client.recipients.add(list_example, marketing_email_example).success? 
+      rescue Sendgrid::API::REST::Errors::UnprocessableEntity
+        false
+      end
+    end
+  end
+
+  def add_marketing_email_with_list
+    add_marketing_email
+    add_list
+    add_recipient_list
+  end
+
+  def delete_marketing_email_with_list
+    delete_marketing_email
+    delete_list
+  end
+
+  private
+
+  # Check if some operation is completed or not.
+  #
+  # @see http://support.sendgrid.com/hc/en-us/articles/200185208-SendGrid-Web-API-may-return-successful-but-doesn-t-mean-it-has-completed
+  # @param timeout [Fixnum] The maximum number of seconds to check the operation status. Default: 60 seconds.
+  # @param delay [Fixnum] The number of seconds between each check. Default: 3 seconds.
+  # @param &block [Block] The given block should return true if completed, otherwise false.
+  # @return [Bool] The operation status
+  def check_completed(timeout = 60, delay = 3)
+    start = Time.now
+    response = nil
+    loop do
+      response = yield
+      duration = Time.now - start
+      # puts "Checking operation - status: #{response.inspect} - duration: #{duration} seconds"
+      break if response || (duration > timeout)
+      sleep delay
+    end
+    response
+  end
+
+end

data/spec/support/shared_examples.rb

@@ -8,4 +8,97 @@ shared_examples 'online tests' do
 
   let(:env_user)  { ENV['SENDGRID_USER'] }
   let(:env_key)   { ENV['SENDGRID_KEY'] }
+end
+
+shared_examples 'a success response' do
+  before do
+    stub_post.to_return(:body => fixture('success.json'))
+  end
+  its(:success?) { should be_true }
+end
+
+shared_examples 'an unauthorized response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/unauthorized.json'), :status => 401)
+  end
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+  end
+end
+
+shared_examples 'a forbidden response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/forbidden.json'), :status => 403)
+  end
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::Forbidden)
+  end
+end
+
+shared_examples 'an invalid fields response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/invalid_fields.json'), :status => 400)
+  end
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::BadRequest)
+  end
+end
+
+shared_examples 'a does not exist response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/does_not_exist.json'), :status => 401)
+  end
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+  end
+end
+
+shared_examples 'an already exists response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/already_exists.json'))
+  end
+
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::UnprocessableEntity)
+  end
+end
+
+shared_examples 'an already exists unauthorized response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/already_exists.json'), :status => 401)
+  end
+
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+  end
+end
+
+shared_examples 'a database error response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/database_error.json'), :status => 500)
+  end
+
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::Unknown)
+  end
+end
+
+shared_examples 'a not scheduled response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/bad_request.json'), :status => 401)
+  end
+
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::Unauthorized)
+  end
+end
+
+shared_examples 'a bad request response' do
+  before do
+    stub_post.to_return(:body => fixture('errors/bad_request.json'), :status => 400)
+  end
+
+  it 'raises an error' do
+    expect { subject }.to raise_error(Sendgrid::API::REST::Errors::BadRequest)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70097569981620 !ruby/object:Gem::Requirement
+  requirement: &70315414007340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.8
   type: :runtime
   prerelease: false
-  version_requirements: *70097569981620
+  version_requirements: *70315414007340
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70097569981060 !ruby/object:Gem::Requirement
+  requirement: &70315414004160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 1.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70097569981060
+  version_requirements: *70315414004160
 description: A Ruby interface to the SendGrid API
 email:
 - renatosnrg@gmail.com
@@ -43,6 +43,7 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- .yardopts
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -50,40 +51,91 @@ files:
 - Rakefile
 - lib/sendgrid/api.rb
 - lib/sendgrid/api/client.rb
+- lib/sendgrid/api/entities/category.rb
+- lib/sendgrid/api/entities/email.rb
 - lib/sendgrid/api/entities/entity.rb
+- lib/sendgrid/api/entities/list.rb
+- lib/sendgrid/api/entities/marketing_email.rb
 - lib/sendgrid/api/entities/profile.rb
 - lib/sendgrid/api/entities/response.rb
+- lib/sendgrid/api/entities/response_insert.rb
+- lib/sendgrid/api/entities/response_remove.rb
+- lib/sendgrid/api/entities/schedule.rb
+- lib/sendgrid/api/entities/sender_address.rb
 - lib/sendgrid/api/entities/stats.rb
+- lib/sendgrid/api/newsletter/categories.rb
+- lib/sendgrid/api/newsletter/emails.rb
+- lib/sendgrid/api/newsletter/lists.rb
+- lib/sendgrid/api/newsletter/marketing_emails.rb
+- lib/sendgrid/api/newsletter/recipients.rb
+- lib/sendgrid/api/newsletter/schedule.rb
+- lib/sendgrid/api/newsletter/sender_addresses.rb
+- lib/sendgrid/api/newsletter/utils.rb
 - lib/sendgrid/api/rest/errors/error.rb
 - lib/sendgrid/api/rest/resource.rb
 - lib/sendgrid/api/rest/response/parse_error.rb
 - lib/sendgrid/api/rest/response/parse_json.rb
 - lib/sendgrid/api/service.rb
 - lib/sendgrid/api/version.rb
+- lib/sendgrid/api/web/mail.rb
 - lib/sendgrid/api/web/profile.rb
 - lib/sendgrid/api/web/stats.rb
 - sendgrid-api.gemspec
-- spec/fixtures/forbidden.json
+- spec/fixtures/categories.json
+- spec/fixtures/emails/email.json
+- spec/fixtures/emails/emails.json
+- spec/fixtures/errors/already_exists.json
+- spec/fixtures/errors/bad_request.json
+- spec/fixtures/errors/database_error.json
+- spec/fixtures/errors/does_not_exist.json
+- spec/fixtures/errors/forbidden.json
+- spec/fixtures/errors/invalid_fields.json
+- spec/fixtures/errors/not_scheduled.json
+- spec/fixtures/errors/unauthorized.json
+- spec/fixtures/lists/list.json
+- spec/fixtures/lists/lists.json
+- spec/fixtures/marketing_emails/marketing_email.json
+- spec/fixtures/marketing_emails/marketing_emails.json
 - spec/fixtures/profile.json
+- spec/fixtures/recipients.json
+- spec/fixtures/schedule.json
+- spec/fixtures/sender_addresses/sender_address.json
+- spec/fixtures/sender_addresses/sender_addresses.json
 - spec/fixtures/stats.json
 - spec/fixtures/success.json
-- spec/fixtures/unauthorized.json
 - spec/sendgrid/api/client_spec.rb
+- spec/sendgrid/api/entities/category_spec.rb
+- spec/sendgrid/api/entities/email_spec.rb
 - spec/sendgrid/api/entities/entity_spec.rb
+- spec/sendgrid/api/entities/list_spec.rb
+- spec/sendgrid/api/entities/marketing_email_spec.rb
 - spec/sendgrid/api/entities/profile_spec.rb
+- spec/sendgrid/api/entities/response_insert_spec.rb
+- spec/sendgrid/api/entities/response_remove_spec.rb
 - spec/sendgrid/api/entities/response_spec.rb
+- spec/sendgrid/api/entities/schedule_spec.rb
+- spec/sendgrid/api/entities/sender_address_spec.rb
 - spec/sendgrid/api/entities/stats_spec.rb
+- spec/sendgrid/api/newsletter/categories_spec.rb
+- spec/sendgrid/api/newsletter/emails_spec.rb
+- spec/sendgrid/api/newsletter/lists_spec.rb
+- spec/sendgrid/api/newsletter/marketing_emails_spec.rb
+- spec/sendgrid/api/newsletter/recipients_spec.rb
+- spec/sendgrid/api/newsletter/schedule_spec.rb
+- spec/sendgrid/api/newsletter/sender_addresses_spec.rb
 - spec/sendgrid/api/rest/errors/error_spec.rb
 - spec/sendgrid/api/rest/resource_spec.rb
 - spec/sendgrid/api/rest/response/parse_error_spec.rb
 - spec/sendgrid/api/rest/response/parse_json_spec.rb
 - spec/sendgrid/api/service_spec.rb
 - spec/sendgrid/api/version_spec.rb
+- spec/sendgrid/api/web/mail_spec.rb
 - spec/sendgrid/api/web/profile_spec.rb
 - spec/sendgrid/api/web/stats_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/mock.rb
+- spec/support/online.rb
 - spec/support/shared_examples.rb
 homepage: ''
 licenses:
@@ -111,25 +163,59 @@ signing_key:
 specification_version: 3
 summary: A Ruby interface to the SendGrid API
 test_files:
-- spec/fixtures/forbidden.json
+- spec/fixtures/categories.json
+- spec/fixtures/emails/email.json
+- spec/fixtures/emails/emails.json
+- spec/fixtures/errors/already_exists.json
+- spec/fixtures/errors/bad_request.json
+- spec/fixtures/errors/database_error.json
+- spec/fixtures/errors/does_not_exist.json
+- spec/fixtures/errors/forbidden.json
+- spec/fixtures/errors/invalid_fields.json
+- spec/fixtures/errors/not_scheduled.json
+- spec/fixtures/errors/unauthorized.json
+- spec/fixtures/lists/list.json
+- spec/fixtures/lists/lists.json
+- spec/fixtures/marketing_emails/marketing_email.json
+- spec/fixtures/marketing_emails/marketing_emails.json
 - spec/fixtures/profile.json
+- spec/fixtures/recipients.json
+- spec/fixtures/schedule.json
+- spec/fixtures/sender_addresses/sender_address.json
+- spec/fixtures/sender_addresses/sender_addresses.json
 - spec/fixtures/stats.json
 - spec/fixtures/success.json
-- spec/fixtures/unauthorized.json
 - spec/sendgrid/api/client_spec.rb
+- spec/sendgrid/api/entities/category_spec.rb
+- spec/sendgrid/api/entities/email_spec.rb
 - spec/sendgrid/api/entities/entity_spec.rb
+- spec/sendgrid/api/entities/list_spec.rb
+- spec/sendgrid/api/entities/marketing_email_spec.rb
 - spec/sendgrid/api/entities/profile_spec.rb
+- spec/sendgrid/api/entities/response_insert_spec.rb
+- spec/sendgrid/api/entities/response_remove_spec.rb
 - spec/sendgrid/api/entities/response_spec.rb
+- spec/sendgrid/api/entities/schedule_spec.rb
+- spec/sendgrid/api/entities/sender_address_spec.rb
 - spec/sendgrid/api/entities/stats_spec.rb
+- spec/sendgrid/api/newsletter/categories_spec.rb
+- spec/sendgrid/api/newsletter/emails_spec.rb
+- spec/sendgrid/api/newsletter/lists_spec.rb
+- spec/sendgrid/api/newsletter/marketing_emails_spec.rb
+- spec/sendgrid/api/newsletter/recipients_spec.rb
+- spec/sendgrid/api/newsletter/schedule_spec.rb
+- spec/sendgrid/api/newsletter/sender_addresses_spec.rb
 - spec/sendgrid/api/rest/errors/error_spec.rb
 - spec/sendgrid/api/rest/resource_spec.rb
 - spec/sendgrid/api/rest/response/parse_error_spec.rb
 - spec/sendgrid/api/rest/response/parse_json_spec.rb
 - spec/sendgrid/api/service_spec.rb
 - spec/sendgrid/api/version_spec.rb
+- spec/sendgrid/api/web/mail_spec.rb
 - spec/sendgrid/api/web/profile_spec.rb
 - spec/sendgrid/api/web/stats_spec.rb
 - spec/spec_helper.rb
 - spec/support/helpers.rb
 - spec/support/mock.rb
+- spec/support/online.rb
 - spec/support/shared_examples.rb