sendgrid-api 0.0.1 → 0.0.2

data/.gitignore

@@ -1,2 +1,4 @@
+*.gem
 .bundle
 vendor
+coverage

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--order random

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -1,7 +1,5 @@
 source 'https://rubygems.org'
 
-gemspec
-
 group :development do
   gem "bundler", "~> 1.3"
   gem "rake"
@@ -9,4 +7,9 @@ end
 
 group :test do
   gem "rspec", "~> 2.14.1"
-end
+  gem "coveralls", "~> 0.7.0", :require => false
+  gem "simplecov", "~> 0.7.1", :require => false
+  gem "webmock", "~> 1.15.0"
+end
+
+gemspec

data/Gemfile.lock

@@ -1,13 +1,32 @@
 PATH
   remote: .
   specs:
-    sendgrid-api (0.0.1)
+    sendgrid-api (0.0.2)
+      faraday (~> 0.8.8)
+      json (~> 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.3.5)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    json (1.8.0)
+    mime-types (1.25)
+    multi_json (1.8.0)
+    multipart-post (1.2.0)
     rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -16,12 +35,27 @@ GEM
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
+    safe_yaml (0.9.7)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.11.0)
+    webmock (1.15.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.3)
+  coveralls (~> 0.7.0)
   rake
   rspec (~> 2.14.1)
   sendgrid-api!
+  simplecov (~> 0.7.1)
+  webmock (~> 1.15.0)

data/README.md

@@ -1,7 +1,25 @@
-# Sendgrid::Api
+# Sendgrid::API
+
+[![Build Status](https://secure.travis-ci.org/renatosnrg/sendgrid-api.png?branch=master)][gem]
+[![Code Climate](https://codeclimate.com/github/renatosnrg/sendgrid-api.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/renatosnrg/sendgrid-api/badge.png?branch=master)][coveralls]
+
+[gem]: http://travis-ci.org/renatosnrg/sendgrid-api
+[codeclimate]: https://codeclimate.com/github/renatosnrg/sendgrid-api
+[coveralls]: https://coveralls.io/r/renatosnrg/sendgrid-api
 
 A Ruby interface to the SendGrid API.
 
+## API Coverage
+
+The SendGrid API is being covered on demand. The next APIs to be supported are the complete [Marketing Email API](http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/index.html) and [Mail](http://sendgrid.com/docs/API_Reference/Web_API/mail.html) (Web API).
+
+Check which SendGrid APIs are currently being covered by this gem:
+
+[https://github.com/renatosnrg/sendgrid-api/wiki/SendGrid-API-Coverage][coverage]
+
+[coverage]: https://github.com/renatosnrg/sendgrid-api/wiki/SendGrid-API-Coverage
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,14 +34,40 @@ Or install it yourself as:
 
     $ gem install sendgrid-api
 
-## Usage
+## Configuration
+
+```ruby
+client = Sendgrid::API::Client.new('YOUR_USER', 'YOUR_KEY')
+```
 
-TODO
+## Usage Examples
+
+**Get your SendGrid Profile**
+
+```ruby
+profile = client.profile.get
+```
+
+**Modify your SendGrid Profile**
+
+```ruby
+profile = Sendgrid::API::Entities::Profile.new(:first_name => 'Your first name',
+                                               :last_name => 'Your last name')
+response = client.profile.set(profile)
+```
+
+**Get Advanced Statistics**
+
+```ruby
+stats = client.stats.advanced(:start_date => '2013-01-01', :data_type => 'global')
+```
 
 ## Contributing
 
+If you want to contribute to cover more APIs or improve something already implemented, follow these steps:
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes - do not forget tests (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/Rakefile

@@ -1,7 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
+  t.rspec_opts = "--tag #{task_args[:tag]}" if task_args[:tag]
+end
 
 task :default => :spec
 task :test => :spec

data/lib/sendgrid/api.rb

@@ -1,6 +1,7 @@
-require "sendgrid/api/version"
+require 'sendgrid/api/version'
+require 'sendgrid/api/client'
 
 module Sendgrid
-  module Api
+  module API
   end
 end

data/lib/sendgrid/api/client.rb

@@ -0,0 +1,27 @@
+require 'sendgrid/api/rest/resource'
+require 'sendgrid/api/web/profile'
+require 'sendgrid/api/web/stats'
+
+module Sendgrid
+  module API
+    class Client
+
+      include Web::Profile
+      include Web::Stats
+
+      attr_reader :user, :key
+
+      def initialize(user, key)
+        @user = user
+        @key = key
+      end
+
+      private
+
+      def resource
+        @resource ||= REST::Resource.new(user, key)
+      end
+
+    end
+  end
+end

data/lib/sendgrid/api/entities/entity.rb

@@ -0,0 +1,83 @@
+require 'json'
+
+module Sendgrid
+  module API
+    module Entities
+      class Entity
+
+        attr_reader :attributes
+
+        def initialize(attributes = {})
+          @attributes = sanitize_attributes(attributes)
+        end
+
+        def to_json
+          as_json.to_json
+        end
+
+        def as_json
+          attributes
+        end
+
+        def method_missing(method, *args, &block)
+          setter = method.to_s.gsub(/=$/, '').to_sym
+          if has_attribute?(method)
+            attributes[method]
+          elsif has_attribute?(setter)
+            attributes[setter] = args.first
+          else
+            super
+          end
+        end
+
+        def respond_to?(method, include_private = false)
+          super || has_attribute?(method)
+        end
+
+        private
+
+        def has_attribute?(attribute)
+          self.class.attributes.include?(attribute)
+        end
+
+        def sanitize_attributes(attributes)
+          attributes.reject { |key, value| !has_attribute?(key) }
+        end
+
+        class << self
+
+          # Instantiate the entity from API response body.
+          # Can generate multiple entities if response is an Array.
+          def from_response(response)
+            body = response.body
+            if body.is_a?(Array)
+              body.map { |item| new(item) }
+            elsif body.is_a?(Hash)
+              new(body)
+            else
+              nil
+            end
+          end
+
+          # Add attributes to the entity
+          def attribute(*args)
+            @attributes = attributes
+            @attributes += args
+            @attributes.uniq!
+          end
+
+          # Get the entity attributes
+          def attributes
+            @attributes ||= []
+          end
+
+          def clear_attributes
+            @attributes = []
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Profile < Entity
+
+        attribute :username, :email, :active, :first_name, :last_name, :address,
+                  :address2, :city, :state, :zip, :country, :phone, :website, :website_access
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/entities/response.rb

@@ -0,0 +1,21 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Response < Entity
+
+        attribute :message, :errors
+
+        def success?
+          message == 'success'
+        end
+
+        def error?
+          message == 'error'
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Stats < Entity
+
+        attribute :delivered, :request, :unique_open, :unique_click, :processed, :date, :open, :click,
+                  :blocked, :spamreport, :drop, :bounce, :deferred
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/rest/errors/error.rb

@@ -0,0 +1,60 @@
+module Sendgrid
+  module API
+    module REST
+      module Errors
+
+        class Error < StandardError
+
+          class << self
+
+            def from_response(env)
+              status_error(env) || body_error(env)
+            end
+
+            private
+
+            def status_error(env)
+              body = env[:body]
+              status = env[:status].to_i
+              if status != 200
+                message = body[:error] if body.is_a?(Hash)
+                error_class(status).new(message)
+              else
+                nil
+              end
+            end
+
+            def body_error(env)
+              body = env[:body]
+              if body.is_a?(Hash) && body.has_key?(:error)
+                status = body[:error][:code]
+                message = body[:error][:message]
+                error_class(status).new(message)
+              else
+                nil
+              end
+            end
+
+            def error_class(status)
+              Errors::CODES[status] || Errors::Unknown
+            end
+
+          end
+
+        end
+
+        class BadRequest < Error; end
+        class Unauthorized < Error; end
+        class Forbidden < Error; end
+        class Unknown < Error; end
+
+        CODES = {
+          400 => BadRequest,
+          401 => Unauthorized,
+          403 => Forbidden,
+        }.freeze
+
+      end
+    end
+  end
+end

data/lib/sendgrid/api/rest/resource.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'sendgrid/api/rest/response/parse_json'
+require 'sendgrid/api/rest/response/parse_error'
+
+module Sendgrid
+  module API
+    module REST
+      class Resource
+
+        attr_reader :user, :key
+
+        ENDPOINT = 'https://sendgrid.com/api'.freeze
+
+        def initialize(user, key)
+          @user = user
+          @key = key
+        end
+
+        def post(url, params = {})
+          request(:post, url, params)
+        end
+
+        private
+
+        def request(method, url, params = {})
+          params.merge!(authentication_params)
+          connection.send(method, url, params)
+        rescue Faraday::Error::ClientError, JSON::ParserError
+          raise Errors::Unknown
+        end
+
+        def middleware
+          @middleware ||= Faraday::Builder.new do |builder|
+            # form-encode POST params
+            builder.request :url_encoded
+            # Parse response errors
+            builder.use Response::ParseError
+            # Parse JSON response bodies
+            builder.use Response::ParseJson
+            # Set Faraday's HTTP adapter
+            builder.adapter Faraday.default_adapter
+          end
+        end
+
+        def connection
+          @connection ||= Faraday.new(ENDPOINT, :builder => middleware)
+        end
+
+        def authentication_params
+          { :api_user => @user, :api_key => @key }
+        end
+
+      end
+    end
+  end
+end