sendgrid-api 0.0.1 → 0.0.2

data/lib/sendgrid/api/rest/response/parse_error.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+require 'sendgrid/api/rest/errors/error'
+
+module Sendgrid
+  module API
+    module REST
+      module Response
+        class ParseError < Faraday::Response::Middleware
+
+          def on_complete(env)
+            error = REST::Errors::Error.from_response(env)
+            raise error unless error.nil?
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/api/rest/response/parse_json.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+require 'json'
+
+module Sendgrid
+  module API
+    module REST
+      module Response
+        class ParseJson < Faraday::Response::Middleware
+
+          def parse(body)
+            JSON.parse(body, :symbolize_names => true) if body
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/api/service.rb

@@ -0,0 +1,23 @@
+module Sendgrid
+  module API
+    class Service
+
+      attr_reader :resource
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def perform_request(entity, url, params = {})
+        entity.from_response(request(url, params))
+      end
+
+      private
+
+      def request(url, params = {})
+        resource.post(url, params)
+      end
+
+    end
+  end
+end

data/lib/sendgrid/api/version.rb

@@ -1,5 +1,5 @@
 module Sendgrid
-  module Api
-    VERSION = "0.0.1"
+  module API
+    VERSION = "0.0.2"
   end
 end

data/lib/sendgrid/api/web/profile.rb

@@ -0,0 +1,38 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/profile'
+require 'sendgrid/api/entities/response'
+
+module Sendgrid
+  module API
+    module Web
+      module Profile
+
+        def profile
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+
+          # View your SendGrid profile
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/profile.html
+          # @return profile [Profile] An Entities::Profile object.
+          def get
+            perform_request(Entities::Profile, 'profile.get.json').first
+          end
+
+          # Update your SendGrid profile
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/profile.html#-set
+          # @param profile [Profile] An Entities::Profile object.
+          # @return response [Response] An Entities::Response object.
+          def set(profile)
+            perform_request(Entities::Response, 'profile.set.json', profile.as_json)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/web/stats.rb

@@ -0,0 +1,36 @@
+require 'sendgrid/api/service'
+require 'sendgrid/api/entities/stats'
+
+module Sendgrid
+  module API
+    module Web
+      module Stats
+
+        def stats
+          Services.new(resource)
+        end
+
+        class Services < Sendgrid::API::Service
+
+          # Get Advanced Statistics
+          #
+          # @see http://sendgrid.com/docs/API_Reference/Web_API/Statistics/statistics_advanced.html
+          # @param options [Hash] A customizable set of options.
+          # @option options [String] :data_type One of the following: browsers, clients, devices, geo, global, isps. Required.
+          # @option options [Date] :start_date Date format is based on aggregated_by value (default is yyyy-mm-dd). Required.
+          # @option options [Date] :end_date Date format is based on aggregated_by value (default is yyyy-mm-dd).
+          # @option options [String] :metric One of the following (default is all): open, click, unique_open, unique_click, processed, delivered, drop, bounce, deferred, spamreport, blocked, all.
+          # @option options [String] :category Return stats for the given category.
+          # @option options [String] :aggregated_by Aggregate the data by the given period (default is day): day, week or month.
+          # @option options [String] :country Get stats for each region/state for the given country. Only US (United States) and CA (Canada) is supported at this time.
+          # @return stats [Stats] An array of Entities::Stats object.
+          def advanced(params = {})
+            perform_request(Entities::Stats, 'stats.getAdvanced.json', params)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/sendgrid-api.gemspec

@@ -5,7 +5,7 @@ require 'sendgrid/api/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "sendgrid-api"
-  spec.version       = Sendgrid::Api::VERSION
+  spec.version       = Sendgrid::API::VERSION
   spec.authors       = ["Renato Neves"]
   spec.email         = ["renatosnrg@gmail.com"]
   spec.description   = %q{A Ruby interface to the SendGrid API}
@@ -17,4 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.8.8'
+  spec.add_dependency 'json', '~> 1.8.0'
 end

data/spec/fixtures/forbidden.json

@@ -0,0 +1,3 @@
+{
+  "error":"Bad username / password"
+}

data/spec/fixtures/profile.json

@@ -0,0 +1,18 @@
+[
+  {
+    "username":"sendgrid",
+    "email":"contact@sendgrid.com",
+    "active":"true",
+    "first_name":"Jim",
+    "last_name":"Franklin",
+    "address":"1065 N Pacificenter Drive, Suite 425",
+    "address2":"",
+    "city":"Anaheim",
+    "state":"CA",
+    "zip":"92806",
+    "country":"US",
+    "phone":"123456789",
+    "website":"http:\/\/www.sendgrid.com",
+    "website_access":"true"
+  }
+]

data/spec/fixtures/stats.json

@@ -0,0 +1,50 @@
+[
+  {
+    "delivered":4792,
+    "unique_open":308,
+    "spamreport":3,
+    "unique_click":11,
+    "drop":57,
+    "request":5359,
+    "bounce":622,
+    "deferred":1975,
+    "processed":5302,
+    "date":"2013-06-18",
+    "open":481,
+    "click":11,
+    "blocked":29
+  },
+  {
+    "delivered":3,
+    "unique_open":17,
+    "unique_click":1,
+    "deferred":405,
+    "date":"2013-06-19",
+    "open":37,
+    "click":1
+  },
+  {
+    "date":"2013-06-20",
+    "deferred":381,
+    "unique_open":4,
+    "open":7,
+    "bounce":2
+  },
+  {
+    "unique_open":2,
+    "bounce":1,
+    "deferred":113,
+    "date":"2013-06-21",
+    "open":8,
+    "blocked":31
+  },
+  {
+    "date":"2013-06-23",
+    "unique_open":2,
+    "open":2
+  },
+  {
+    "date":"2013-06-24",
+    "open":1
+  }
+]

data/spec/fixtures/success.json

@@ -0,0 +1,3 @@
+{
+  "message":"success"
+}

data/spec/fixtures/unauthorized.json

@@ -0,0 +1,6 @@
+{
+  "error":{
+    "code":401,
+    "message":"Permission denied, wrong credentials"
+  }
+}

data/spec/sendgrid/api/client_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    describe Client do
+
+      subject { described_class.new(user, key) }
+      let(:user) { 'some user' }
+      let(:key) { 'some key' }
+
+      its(:user) { should == user }
+      its(:key) { should == key }
+
+      it { should respond_to(:profile) }
+      it { should respond_to(:stats) }
+
+      its(:profile) { should_not be_nil }
+      its(:stats) { should_not be_nil }
+
+    end
+  end
+end

data/spec/sendgrid/api/entities/entity_spec.rb

@@ -0,0 +1,279 @@
+require 'spec_helper'
+
+module Sendgrid
+  module API
+    module Entities
+      describe Entity do
+
+        subject { described_class }
+
+        after do
+          described_class.clear_attributes
+        end
+
+        describe '.clear_attributes' do
+          before do
+            subject.attribute :attr1
+          end
+
+          it 'should clear the attributes' do
+            subject.clear_attributes
+            subject.attributes.should be_empty
+          end
+        end
+
+        describe '.attribute' do
+          context 'when the attributes are empty' do
+            before do
+              subject.clear_attributes
+            end
+
+            it 'should set the entity attributes' do
+              subject.attribute :attr1, :attr2
+              subject.attributes.should have(2).items
+            end
+          end
+
+          context 'when the attributes are not empty' do
+            before do
+              subject.clear_attributes
+              subject.attribute :attr1
+            end
+
+            it 'should add attributes to the entity' do
+              subject.attribute :attr2
+              subject.attributes.should have(2).items
+            end
+          end
+
+          context 'when the attributes are repeated' do
+            before do
+              subject.clear_attributes
+              subject.attribute :attr1
+            end
+
+            it 'should add distinct attributes to the entity' do
+              subject.attribute :attr1, :attr2
+              subject.attributes.should have(2).items
+            end
+          end
+        end
+
+        describe '#attributes' do
+          before do
+            subject.clear_attributes
+          end
+
+          context 'without attributes' do
+            its(:attributes) { should be_empty }
+          end
+
+          context 'with attributes' do
+            before do
+              subject.attribute :attr1, :attr2
+            end
+
+            its(:attributes) { should have(2).items }
+          end
+        end
+
+        describe '.from_response' do
+          context 'when response is an array' do
+            before do
+              response.should_receive(:body).and_return([item1, item2])
+            end
+            let(:response) { double('response') }
+            let(:item1) { double('item').as_null_object }
+            let(:item2) { double('item').as_null_object }
+
+            subject { described_class.from_response(response) }
+
+            it { should have(2).items }
+            its([0]) { should be_instance_of(described_class) }
+            its([1]) { should be_instance_of(described_class) }
+          end
+
+          context 'when response is a hash' do
+            before do
+              response.should_receive(:body).and_return(item)
+            end
+            let(:response) { double('response') }
+            let(:item) { Hash.new }
+
+            subject { described_class.from_response(response) }
+
+            it { should be_instance_of(described_class) }
+          end
+
+          context 'when response is a string' do
+            before do
+              response.should_receive(:body).and_return(item)
+            end
+            let(:response) { double('response') }
+            let(:item) { 'some string' }
+
+            subject { described_class.from_response(response) }
+
+            it { should be_nil }
+          end
+
+          context 'when response is a number' do
+            before do
+              response.should_receive(:body).and_return(item)
+            end
+            let(:response) { double('response') }
+            let(:item) { 45 }
+
+            subject { described_class.from_response(response) }
+
+            it { should be_nil }
+          end
+
+          context 'when response is a nil object' do
+            before do
+              response.should_receive(:body).and_return(item)
+            end
+            let(:response) { double('response') }
+            let(:item) { nil }
+
+            subject { described_class.from_response(response) }
+
+            it { should be_nil }
+          end
+        end
+
+        describe '.new' do
+          before do
+            described_class.attribute :attr1, :attr2
+          end
+
+          context 'creating entity with no attributes' do
+            subject { entity }
+            let(:entity) { described_class.new }
+
+            it { should respond_to(:attr1) }
+            it { should respond_to(:attr2) }
+
+            its(:attr1) { should be_nil }
+            its(:attr2) { should be_nil }
+
+            it 'should raise error for invalid attributes' do
+              expect { subject.attr3 }.to raise_error(NameError)
+            end
+
+            it 'should set attr1' do
+              subject.attr1 = 'attr1 value'
+              subject.attr1.should == 'attr1 value'
+            end
+
+            it 'should set attr2' do
+              subject.attr1 = 'attr2 value'
+              subject.attr1.should == 'attr2 value'
+            end
+
+            describe '#attributes' do
+              subject { entity.attributes }
+
+              it { should be_empty }
+            end
+
+            describe '#as_json' do
+              subject { entity.as_json }
+
+              it { should be_empty }
+            end
+
+            describe '#to_json' do
+              subject { JSON.parse(entity.to_json) }
+
+              it { should be_empty }
+            end
+          end
+
+          context 'creating entity with valid attributes' do
+            subject { entity }
+            let(:entity) { described_class.new(:attr1 => attr1, :attr2 => attr2) }
+            let(:attr1) { 'attr1 value' }
+            let(:attr2) { 'attr2 value' }
+
+            it { should respond_to(:attr1) }
+            it { should respond_to(:attr2) }
+
+            its(:attr1) { should == attr1 }
+            its(:attr2) { should == attr2 }
+
+            describe '#attributes' do
+              subject { entity.attributes }
+
+              it { should have(2).items }
+              it { should include(:attr1) }
+              it { should include(:attr2) }
+              it { should_not include(:attr3) }
+            end
+
+            describe '#as_json' do
+              subject { entity.as_json }
+
+              it { should have(2).items }
+              it { should include(:attr1) }
+              it { should include(:attr2) }
+              it { should_not include(:attr3) }
+            end
+
+            describe '#to_json' do
+              subject { JSON.parse(entity.to_json) }
+
+              it { should have(2).items }
+              it { should include('attr1') }
+              it { should include('attr2') }
+              it { should_not include('attr3') }
+            end
+          end
+
+          context 'creating entity with invalid attributes' do
+            subject { entity }
+            let(:entity) { described_class.new(:attr1 => attr1, :attr2 => attr2, :attr3 => attr3) }
+            let(:attr1) { 'attr1 value' }
+            let(:attr2) { 'attr2 value' }
+            let(:attr3) { 'attr3 value' }
+
+            its(:attr1) { should == attr1 }
+            its(:attr2) { should == attr2 }
+
+            it 'should raise error for invalid attributes' do
+              expect { subject.attr3 }.to raise_error(NameError)
+            end
+
+            describe '#attributes' do
+              subject { entity.attributes }
+
+              it { should have(2).items }
+              it { should include(:attr1) }
+              it { should include(:attr2) }
+              it { should_not include(:attr3) }
+            end
+
+            describe '#as_json' do
+              subject { entity.as_json }
+
+              it { should have(2).items }
+              it { should include(:attr1) }
+              it { should include(:attr2) }
+              it { should_not include(:attr3) }
+            end
+
+            describe '#to_json' do
+              subject { JSON.parse(entity.to_json) }
+
+              it { should have(2).items }
+              it { should include('attr1') }
+              it { should include('attr2') }
+              it { should_not include('attr3') }
+            end
+          end
+        end
+
+      end
+    end
+  end
+end