sendgrid-api 0.0.1 → 0.0.2

data/spec/sendgrid/api/version_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
 module Sendgrid
-  describe Api do
+  describe API do
 
     it 'has a non-null VERSION constant' do
-      Api::VERSION.should_not be_nil
+      API::VERSION.should_not be_nil
     end
 
   end

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

@@ -0,0 +1,126 @@
+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' }
+
+            context 'when request is successfull' do
+              before do
+                sg_mock.stub_post(url).to_return(:body => fixture('profile.json'))
+              end
+
+              subject { service.get }
+
+              it 'should perform 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
+              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
+            end
+          end
+
+          describe '#set' do
+            let(:url) { 'profile.set.json' }
+            let(:profile) { Entities::Profile.new(:first_name => 'Brian', :last_name => 'O\'Neill') }
+
+            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 }
+            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
+            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 'should get profile' do
+                  subject.get.should be_instance_of(Entities::Profile)
+                end
+              end
+
+              describe '#set' do
+                it 'should update 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 'should raise 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 'should raise 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,100 @@
+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' }
+
+            context 'when request is successfull' do
+              before do
+                sg_mock.stub_post(url).to_return(:body => fixture('stats.json'))
+              end
+
+              subject { service.advanced }
+
+              it 'should perform 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('should debug 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
+            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 'should get 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
+                    expect { subject.advanced }.to raise_error(REST::Errors::BadRequest)
+                  end
+                end
+              end
+            end
+
+            context 'when credentials are invalid' do
+              describe '#advanced' do
+                it 'should raise 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

@@ -1,2 +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,15 @@
+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

data/spec/support/mock.rb

@@ -0,0 +1,26 @@
+module Sendgrid
+  class Mock
+    include WebMock::API
+
+    def initialize(user, key)
+      @user = user
+      @key = key
+    end
+
+    def stub_post(path, params = {})
+      stub_request(:post, Sendgrid::API::REST::Resource::ENDPOINT + '/' + path).
+        with(:body => params.merge(authentication_params))
+    end
+
+    def a_post(path, params = {})
+      a_request(:post, Sendgrid::API::REST::Resource::ENDPOINT + '/' + path).
+        with(:body => params.merge(authentication_params))
+    end
+
+    private
+
+    def authentication_params
+      { :api_key => @key, :api_user => @user }
+    end
+  end
+end

data/spec/support/shared_examples.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,30 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
-dependencies: []
+date: 2013-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70097569981620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *70097569981620
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70097569981060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70097569981060
 description: A Ruby interface to the SendGrid API
 email:
 - renatosnrg@gmail.com
@@ -20,16 +42,49 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/sendgrid/api.rb
+- lib/sendgrid/api/client.rb
+- lib/sendgrid/api/entities/entity.rb
+- lib/sendgrid/api/entities/profile.rb
+- lib/sendgrid/api/entities/response.rb
+- lib/sendgrid/api/entities/stats.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/profile.rb
+- lib/sendgrid/api/web/stats.rb
 - sendgrid-api.gemspec
+- spec/fixtures/forbidden.json
+- spec/fixtures/profile.json
+- spec/fixtures/stats.json
+- spec/fixtures/success.json
+- spec/fixtures/unauthorized.json
+- spec/sendgrid/api/client_spec.rb
+- spec/sendgrid/api/entities/entity_spec.rb
+- spec/sendgrid/api/entities/profile_spec.rb
+- spec/sendgrid/api/entities/response_spec.rb
+- spec/sendgrid/api/entities/stats_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/profile_spec.rb
+- spec/sendgrid/api/web/stats_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/mock.rb
+- spec/support/shared_examples.rb
 homepage: ''
 licenses:
 - MIT
@@ -43,18 +98,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3235194297472111754
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3235194297472111754
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.16
@@ -62,5 +111,25 @@ signing_key:
 specification_version: 3
 summary: A Ruby interface to the SendGrid API
 test_files:
+- spec/fixtures/forbidden.json
+- spec/fixtures/profile.json
+- spec/fixtures/stats.json
+- spec/fixtures/success.json
+- spec/fixtures/unauthorized.json
+- spec/sendgrid/api/client_spec.rb
+- spec/sendgrid/api/entities/entity_spec.rb
+- spec/sendgrid/api/entities/profile_spec.rb
+- spec/sendgrid/api/entities/response_spec.rb
+- spec/sendgrid/api/entities/stats_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/profile_spec.rb
+- spec/sendgrid/api/web/stats_spec.rb
 - spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/mock.rb
+- spec/support/shared_examples.rb