parity-sendgrid-api 0.0.4

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

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Web
+      module Profile
+        describe Services do
+
+          subject { service }
+          let(:service) { described_class.new(resource) }
+          let(:resource) { REST::Resource.new(user, key) }
+          let(:user) { 'my_user' }
+          let(:key) { 'my_key' }
+          let(:sg_mock) { Sendgrid::Mock.new(user, key) }
+
+          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
+                stub_post.to_return(:body => fixture('profile.json'))
+              end
+
+              it 'performs the request' do
+                subject
+                sg_mock.a_post(url).should have_been_made
+              end
+
+              it { should be_instance_of Entities::Profile }
+
+              its(:username) { should == 'sendgrid' }
+              its(:email) { should == 'contact@sendgrid.com' }
+              its(:active) { should == 'true' }
+              its(:first_name) { should == 'Jim' }
+              its(:last_name) { should == 'Franklin' }
+              its(:address) { should == '1065 N Pacificenter Drive, Suite 425' }
+              its(:address2) { should == '' }
+              its(:city) { should == 'Anaheim' }
+              its(:state) { should == 'CA' }
+              its(:zip) { should == '92806' }
+              its(:country) { should == 'US' }
+              its(:phone) { should == '123456789' }
+              its(:website) { should == 'http://www.sendgrid.com' }
+              its(:website_access) { should == 'true' }
+            end
+
+            context 'when permission failed' do
+              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
+              it_behaves_like 'a success response'
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'an unauthorized response'
+            end
+          end
+
+          describe 'online tests', :online => true do
+            include_examples 'online tests'
+
+            context 'when credentials are valid' do
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              describe '#get' do
+                it 'gets profile' do
+                  subject.get.should be_instance_of(Entities::Profile)
+                end
+              end
+
+              describe '#set' do
+                it 'updates profile' do
+                  profile = subject.get
+                  subject.set(profile).success?.should be_true
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#get' do
+                it 'raises error' do
+                  expect { subject.get }.to raise_error(REST::Errors::Unauthorized)
+                end
+              end
+
+              describe '#set' do
+                let(:profile) { Entities::Profile.new(:first_name => 'Brian', :last_name => 'O\'Neill') }
+
+                it 'raises error' do
+                  expect { subject.set(profile) }.to raise_error(REST::Errors::Unauthorized)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Web
+      module Stats
+        describe Services do
+
+          subject { service }
+          let(:service) { described_class.new(resource) }
+          let(:resource) { REST::Resource.new(user, key) }
+          let(:user) { 'my_user' }
+          let(:key) { 'my_key' }
+          let(:sg_mock) { Sendgrid::Mock.new(user, key) }
+
+          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
+                stub_post.to_return(:body => fixture('stats.json'))
+              end
+
+              it 'performs the request' do
+                subject
+                sg_mock.a_post(url).should have_been_made
+              end
+
+              it { should_not be_empty }
+
+              describe 'first result' do
+                subject { service.advanced.first }
+
+                its(:delivered) { should == 4792 }
+                its(:unique_open) { should == 308 }
+                its(:spamreport) { should == 3 }
+                its(:unique_click) { should == 11 }
+                its(:drop) { should == 57 }
+                its(:request) { should == 5359 }
+                its(:bounce) { should == 622 }
+                its(:deferred) { should == 1975 }
+                its(:processed) { should == 5302 }
+                its(:date) { should == '2013-06-18' }
+                its(:open) { pending('debugs open method') }
+                its(:click) { should == 11 }
+                its(:blocked) { should == 29 }
+              end
+            end
+
+            context 'when permission failed' do
+              it_behaves_like 'a forbidden response'
+            end
+          end
+
+          describe 'online tests', :online => true do
+            include_examples 'online tests'
+
+            context 'when credentials are valid' do
+              let(:resource) { REST::Resource.new(env_user, env_key) }
+
+              describe '#advanced' do
+                context 'with required params' do
+                  # 90 days from now
+                  let(:start_date) { (Time.now - (90*24*60*60)).strftime("%Y-%m-%d") }
+
+                  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 'raises error' do
+                    expect { subject.advanced }.to raise_error(REST::Errors::BadRequest)
+                  end
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#advanced' do
+                it 'raises error' do
+                  expect { subject.advanced }.to raise_error(REST::Errors::Forbidden)
+                end
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/spec/"
+end
+
+require 'sendgrid/api'
+require 'rspec'
+require 'webmock/rspec'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.filter_run_excluding :online => true unless ENV['ALL']
+end
+
+disable_http

data/spec/support/helpers.rb

@@ -0,0 +1,23 @@
+def fixture_path
+  File.expand_path("../../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def enable_http
+  WebMock.allow_net_connect!
+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

@@ -0,0 +1,30 @@
+module Sendgrid
+  class Mock
+    include WebMock::API
+
+    def initialize(user, key)
+      @user = user
+      @key = key
+    end
+
+    def stub_post(path, params = {})
+      stub_request(:post, uri(path)).
+        with(:body => params.merge(authentication_params))
+    end
+
+    def a_post(path, params = {})
+      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
+      { :api_key => @key, :api_user => @user }
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+shared_examples 'online tests' do
+  before do
+    enable_http
+  end
+  after do
+    disable_http
+  end
+
+  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