sendgrid-web 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c66be35eba75ec8a6cfdb0bdf918e2bbe63d3b
-  data.tar.gz: d4713a455c5db0915922186a916f271914940092
+  metadata.gz: c25529f42cb3b382076bbf57b48be5ae98991bee
+  data.tar.gz: 91ceedecf727a38be051799fe81932900357d661
 SHA512:
-  metadata.gz: f8aaf092ef851396f5c829f77fa6d7016d94659674ccba3990a31bb29a468f0d05efb6002d8e03cfddd339f732efc988d335a64f72e6def1a65fc741f1af221c
-  data.tar.gz: 51d40f45c36b90c05a3a151a879d96fa07aa649d57692e5de93ce9501dcc98f116bc245dd9fae048a66542403bbe81aefe9b94212d40fba756599393b98f8015
+  metadata.gz: 1a26f04093ebc8c51137300f121a3afa0eab6d5edb51dc99f5fc921d855e0c41136a1b6b692911be75e577243a6875cd56530b292d03ba02e9e16a5bf2e149f0
+  data.tar.gz: 8a56c673cd34b2d4e7cbc535a28097198080af2efb61047f46bec2e332704426df89ccf2661ea60620c5554755f7ce04b19945fb609c655c5238582863497e9b

data/README.md

@@ -1,6 +1,10 @@
 # Sendgrid::Web
 
-TODO: Write a gem description
+Developed as a means to communicate effectively with the [Sendgrid Web API]
+whilst utilising new Ruby 2.0.0 features. The aim is to become the go-to
+library for interacting with Sendgrid via their web API.
+
+[Sendgrid Web API]: http://sendgrid.com/docs/API_Reference/Web_API/
 
 ## Installation
 
@@ -10,20 +14,60 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install sendgrid-web
+    gem install sendgrid-web
 
 ## Usage
 
-TODO: Write usage instructions here
+First you will need to configure the client:
+
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'your sendgrid username'
+      config.password = 'your sendgrid password'
+    end
+
+Now you can create client instances based on the api module you
+want to access:
+
+    client = Sendgrid::Web::Bounces.new
+    client.get # get list of bounces
+    client.delete(email: 'foobar@example.com') # delete all bounces for foobar
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Provide working specs for new features
+4. Document changes (if changing public interface)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## License
+
+```
+The MIT License (MIT)
+
+Copyright (c) 2013 Darren Coxall
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```

data/lib/sendgrid-web.rb

@@ -0,0 +1 @@
+require 'sendgrid/web'

data/lib/sendgrid/web.rb

@@ -1,13 +1,17 @@
-require 'faraday'
-require 'typhoeus'
-require 'typhoeus/adapters/faraday'
-require 'sendgrid/web/version'
+require 'oj'
+require 'httparty'
 
 module Sendgrid
   module Web
-    autoload :Configurator, 'sendgrid/web/configurator'
-    autoload :Client, 'sendgrid/web/client'
-    autoload :Blocks, 'sendgrid/web/blocks'
-    autoload :Bounces, 'sendgrid/web/bounces'
+    autoload :VERSION,        'sendgrid/web/version'
+    autoload :Configurator,   'sendgrid/web/configurator'
+    autoload :Client,         'sendgrid/web/client'
+    autoload :Blocks,         'sendgrid/web/blocks'
+    autoload :Bounces,        'sendgrid/web/bounces'
+    autoload :FilterCommands, 'sendgrid/web/filter_commands'
+    autoload :InvalidEmails,  'sendgrid/web/invalid_emails'
+    autoload :Mail,           'sendgrid/web/mail'
+    autoload :Credentials,    'sendgrid/web/credentials'
+    autoload :Response,       'sendgrid/web/response'
   end
 end

data/lib/sendgrid/web/blocks.rb

@@ -1,12 +1,48 @@
 class Sendgrid::Web::Blocks < Sendgrid::Web::Client
 
-  def get
-    connection.post('blocks.get.json', default_params)
+  # Retrieves a list of all blocked email addresses along with the
+  # reason why they are blocked.
+  #
+  # @param date [Integer] Retrieve the timestamp of the Block records.
+  # @param days [Integer] Number of days in the past for which to
+  #   retrieve blocks (includes today)
+  # @param start_date [DateTime] The start of the date range for which
+  #   to retrieve blocks.
+  # @param end_date [DateTime] The end of the date range for which to
+  #   retrieve blocks.
+  # @param limit [Integer] Optional field to limit the number of
+  #   results returned.
+  # @param offset [Integer] Optional beginning point in the list to
+  #   retrieve from.
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  # @note All parameters are optional
+  def get(
+    date: nil, days: nil, start_date: nil,
+    end_date: nil, limit: nil, offset: nil)
+    res = connection.post(
+      '/api/blocks.get.json',
+      default_params(
+        date: date,
+        days: days,
+        start_date: start_date,
+        end_date: end_date,
+        limit: limit,
+        offset: offset))
+    craft_response(res)
   end
 
+  # Deletes all blocks associated with the provided email
+  #
+  # @param email [String] Email block address to remove
+  # @return [Sendgrid::Web::Response] The sendgrid response
   def delete(email: nil)
-    raise ArgumentError.new('Missing required `email` option') if email.nil?
-    connection.post('blocks.delete.json', default_params.merge(email: email))
+    if email.nil?
+      raise ArgumentError.new('Missing required `email` option')
+    end
+    res = connection.post(
+      '/api/blocks.delete.json',
+      default_params(email: email))
+    craft_response(res)
   end
 
 end

data/lib/sendgrid/web/bounces.rb

@@ -1,16 +1,64 @@
 class Sendgrid::Web::Bounces < Sendgrid::Web::Client
 
-  def get
-    connection.post('bounces.get.json', default_params)
+  # Retrieve a list of bounces with addresses and response codes,
+  # optionally with dates.
+  #
+  # @param date [Integer] Retrieve the timestamp of the bounce
+  #   records.
+  # @param days [Integer] Number of days in the past for which to
+  #   retrieve bounces (includes today)
+  # @param start_date [DateTime] The start of the date range for which to
+  #   retrieve bounces.
+  # @param end_date [DateTime] The end of the date range for which to
+  #   retrieve bounces.
+  # @param limit [Integer] Optional field to limit the number of
+  #   results returned.
+  # @param offset [Integer] Optional beginning point in the list to
+  #   retrieve from.
+  # @param type [String] Choose the type of bounce to search for. Can
+  #   be either +hard+ or +soft+.
+  # @param email [String] Optional email addresses to search for.
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  # @note All parameters are optional
+  def get(
+    date: nil, days: nil, start_date: nil,
+    end_date: nil, limit: nil, offset: nil,
+    type: nil, email: nil)
+    res = connection.post(
+      '/api/bounces.get.json',
+      default_params(
+        date: date,
+        days: days,
+        start_date: start_date,
+        end_date: end_date,
+        limit: limit,
+        offset: offset,
+        type: type,
+        email: email))
+    craft_response(res)
   end
 
-  def delete(start_date: nil, end_date: nil, type: nil, email: nil)
-    connection.post('bounces.delete.json',
-      default_params.merge(
+  # Delete an address from the Bounce list.
+  #
+  # @param start_date [DateTime] Optional date to start deleting from.
+  # @param end_date [DateTime] Optional date to end deleting from.
+  # @param type [String] Choose the type of bounce to be removed. Can
+  #   be either +hard+ or +soft+.
+  # @param email [String] Email bounce address to remove.
+  # @return [Sendgrid::Web::Response] The sendgrid response
+  # @note All parameters are optional
+  # @note If no parameters are specified the ENTIRE list will be
+  #   deleted.
+  def delete(
+    start_date: nil, end_date: nil, type: nil,
+    email: nil)
+    res = connection.post('/api/bounces.delete.json',
+      default_params(
         start_date: start_date,
         end_date: end_date,
         type: type,
         email: email))
+    craft_response(res)
   end
 
 end

data/lib/sendgrid/web/client.rb

@@ -1,33 +1,67 @@
 class Sendgrid::Web::Client
+
+  # Sets the global configuration object shared between all clients.
+  # You can use it like so:
+  #
+  #   Sendgrid::Web::Client.configure do |config|
+  #     config.username = 'foo'
+  #     config.password = 'bar'
+  #   end
+  #
+  # @return [Sendgrid::Web::Configurator]
   def self.configure(&block)
     @@config = Sendgrid::Web::Configurator.new(&block)
   end
 
+  # Retrieve the current global configuration object and if none
+  # exists, then create an empty one.
+  #
+  # @see #config
   def self.config
-    @@config
+    @@config ||= Sendgrid::Web::Configurator.new
   end
 
+  # Returns the configured +root_url+.
+  def self.base_uri
+    config.root_url
+  end
+
+  # Retrieve the current global configuration object and if none
+  # exists, then create an empty one.
+  #
+  # @see .config
   def config
     @@config ||= Sendgrid::Web::Configurator.new
   end
 
   private
 
+  class API
+    include ::HTTParty
+    base_uri Sendgrid::Web::Client.config.root_url
+  end
+
   def config=(configurator)
     @@config = configurator
   end
 
   def connection
-    @connection ||= Faraday.new(:url => config.root_url) do |faraday|
-      faraday.request :url_encoded
-      faraday.adapter :typhoeus
-    end
+    @connection = API
   end
 
-  def default_params
-    {
-      api_user: config.username,
-      api_key:  config.password
+  def default_params(additions = {})
+    defaults = {
+      query: {
+        api_user: config.username,
+        api_key:  config.password
+      }
     }
+    defaults[:query].merge!(additions)
+    defaults
+  end
+
+  def craft_response(response)
+    Sendgrid::Web::Response.new(response.code, response.body)
   end
+
 end

data/lib/sendgrid/web/configurator.rb

@@ -2,7 +2,7 @@ class Sendgrid::Web::Configurator
   attr_accessor :username, :password, :root_url
 
   def initialize(&block)
-    self.root_url = 'https://sendgrid.com/api/'
+    self.root_url = 'https://sendgrid.com'
     yield self if block_given?
   end
 end

data/lib/sendgrid/web/credentials.rb

@@ -0,0 +1,80 @@
+class Sendgrid::Web::Credentials < Sendgrid::Web::Client
+
+  # Retrieve a list of all credentials, or permissions for a specific
+  # credential.
+  #
+  # @param username [String] If a username is supplied, the API
+  #   returns the JSON permissions for that user.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note All parameters are optional
+  def get(username: nil)
+    res = connection.post(
+      '/api/credentials/get.json',
+      default_params(username: username))
+    craft_response(res)
+  end
+
+  # This API call allows user to add a new set of credentials to their
+  # account.
+  #
+  # @param username [String] Enter a username for the new account.
+  # @param password [String] Enter a password for the new account.
+  # @param permissions [Hash] There are three key names: +email+ for
+  #   access to SMTP, +api+ for programmatic access, and +web+ for
+  #   administration. The values for each are a bit, +0+ for off or
+  #   +1+ for on.
+  #
+  #   The following example allows the specified username/password to
+  #   log into the dashboard, but not send email or have access to any
+  #   of the APIs:
+  #
+  #     { email: 0, web: 1, api: 0 }
+  #
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note Requires +username+ and +password+.
+  def add(username: nil, password: nil, permissions: nil)
+    raise ArgumentError.new('Missing required `username` option') if username.nil?
+    raise ArgumentError.new('Missing required `password` option') if password.nil?
+    res = connection.post(
+      '/api/credentials/add.json',
+      default_params(
+        username: username,
+        password: password,
+        permissions: permissions))
+    craft_response(res)
+  end
+
+  # Update/edit a users credentials and permissions.
+  #
+  # @param username [String] The existing users username.
+  # @param password [String] Optionally update the password.
+  # @param permissions [Hash] Optionally update the permissions.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note Only +username+ is required.
+  # @see #add
+  def edit(username: nil, password: nil, permissions: nil)
+    raise ArgumentError.new('Missing required `username` option') if username.nil?
+    res = connection.post(
+      '/api/credentials/edit.json',
+      default_params(
+        username: username,
+        password: password,
+        permissions: permissions))
+    craft_response(res)
+  end
+
+  # Remove an individuals credentials.
+  #
+  # @param username [String] The credential to remove.
+  # @return [Sendgrid::Web::Response] the Sendgrid response.
+  # @note +username+ is required.
+  def delete(username: nil)
+    raise ArgumentError.new('Missing required `username` option') if username.nil?
+    res = connection.post(
+      '/api/credentials/delete.json',
+      default_params(
+        username: username))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/filter_commands.rb

@@ -0,0 +1,67 @@
+class Sendgrid::Web::FilterCommands < Sendgrid::Web::Client
+
+  # List all of the available apps.
+  #
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note The name entry is used in all the other API calls to
+  #   identify the app.
+  def get_available
+    res = connection.post(
+      '/api/filter.getavailable.json',
+      default_params)
+    craft_response(res)
+  end
+
+  # Activate an app.
+  #
+  # @param name [String] The app in which to activate.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note +name+ is required.
+  def activate_app(name: nil)
+    raise ArgumentError.new('Missing required `name` option') if name.nil?
+    res = connection.post(
+      '/api/filter.activate.json',
+      default_params(name: name))
+    craft_response(res)
+  end
+
+  # Deactivate an app.
+  #
+  # @param name [String] The app in which to deactivate.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note +name+ is required.
+  def deactivate_app(name: nil)
+    raise ArgumentError.new('Missing required `name` option') if name.nil?
+    res = connection.post(
+      '/api/filter.deactivate.json',
+      default_params(name: name))
+    craft_response(res)
+  end
+
+  # Update an apps settings.
+  #
+  # @param name [String] The app in which to update.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note Other options are dependant on the app in question.
+  def setup_app(options = {})
+    raise ArgumentError.new('Missing required `name` option') if options[:name].nil?
+    res = connection.post(
+      '/api/filter.setup.json',
+      default_params(options))
+    craft_response(res)
+  end
+
+  # Retrieve the settings of an app.
+  #
+  # @param name [String] The app in which to retrieve.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note +name+ is required.
+  def get_settings(name: nil)
+    raise ArgumentError.new('Missing required `name` option') if name.nil?
+    res = connection.post(
+      '/api/filter.getsettings.json',
+      default_params(name: name))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/invalid_emails.rb

@@ -0,0 +1,51 @@
+class Sendgrid::Web::InvalidEmails < Sendgrid::Web::Client
+
+  # Retrieve a list of invalid emails with addresses and response
+  # codes, optionally with dates.
+  #
+  # @param date [Integer] Retrieve the timestamp of the invalid email
+  #   records.
+  # @param days [Integer] Number of days in the past for which to
+  #   retrieve invalid emails (includes today).
+  # @param start_date [DateTime] The start of the date range for which
+  #   to retrieve invalid emails.
+  # @param end_date [DateTime] The end of the date range for which to
+  #   retrieve invalid emails.
+  # @param limit [Integer] Optional field to limit the number of
+  #   results returned.
+  # @param offset [Integer] Optional beginning point in the list to
+  #   retrieve from.
+  # @param email [String] Optional email addresses to search for.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note All parameters are optional.
+  def get(
+    date: nil, days: nil, start_date: nil,
+    end_date: nil, limit: nil, offset: nil,
+    email: nil)
+    res = connection.post(
+      '/api/invalidemails.get.json',
+      default_params(
+        date: date,
+        days: days,
+        start_date: start_date,
+        end_date: end_date,
+        limit: limit,
+        offset: offset,
+        email: email))
+    craft_response(res)
+  end
+
+  # Delete an address from the Invalid Email list.
+  #
+  # @param email [String] Email address to remove.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note +email+ parameter is required.
+  def delete(email: nil)
+    raise ArgumentError.new('Missing required `email` option') if email.nil?
+    res = connection.post(
+      '/api/invalidemails.delete.json',
+      default_params(email: email))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/mail.rb

@@ -0,0 +1,63 @@
+class Sendgrid::Web::Mail < Sendgrid::Web::Client
+
+  # Send an email.
+  #
+  # @param to [String|Array<String>] This can also be passed in as an
+  #   array, to send to multiple locations. Note that recipients
+  #   passed in this parameter will be visible as part of the message.
+  # @param to_name [String|Array<String>] Give a name to the
+  #   recipient.
+  # @param x_smtpapi [Hash] see
+  #   {http://sendgrid.com/docs/API_Reference/SMTP_API/index.html X-SMTP API}
+  #   for details.
+  # @param subject [String] The subject of your email.
+  # @param text [String] The actual content of your email message.
+  # @param html [String] The actual content of your email message.
+  # @param from [String] This is where the email will appear to
+  #   originate from for your recipient.
+  # @param bcc [String|Array<String>] This can also be passed in as an
+  #   array of email addresses for multiple recipients.
+  # @param from_name [String] This is name appended to the from email
+  #  field.
+  # @param reply_to [String] Append a reply-to field to your email
+  #   message.
+  # @param date [DateTime] Specify the date header of your email.
+  # @param files [Array] Files to be attached. The file contents must
+  #   be part of the multipart HTTP POST.
+  # @param content [Hash] Content IDs of the files to be used as
+  #   inline images. Content IDs should match the cid’s used in the
+  #   HTML markup.
+  # @param headers [Hash] Each key represents a header name and the
+  #   value the header value.
+  # @return [Sendgrid::Web::Response] The Sendgrid response.
+  # @note The required parameters are: +from+, +text+/+html+,
+  #   +subject+ and +to+.
+  def send(
+    to: nil, to_name: nil, x_smtpapi: nil,
+    subject: nil, text: nil, html: nil,
+    from: nil, bcc: nil, from_name: nil,
+    reply_to: nil, date: nil, files: nil,
+    content: nil, headers: nil)
+    options = {
+      'to' => to, 'toname' => to_name, 'x-smtpapi' => x_smtpapi,
+      'subject' => subject, 'text' => text, 'html' => html,
+      'from' => from, 'bcc' => bcc, 'fromname' => from_name,
+      'replyto' => reply_to, 'date' => date, 'files' => files,
+      'content' => content, 'headers' => headers }
+    %w{ subject to }.each do |required_option|
+      if options[required_option].nil?
+        raise ArgumentError.new(
+          "Missing required `#{required_option}` option")
+      end
+    end
+    if options['text'].nil? && options['html'].nil?
+      raise ArgumentError.new(
+        'Missing required `text` or `html` option')
+    end
+    res = connection.post(
+      '/api/mail.send.json',
+      default_params(options))
+    craft_response(res)
+  end
+
+end

data/lib/sendgrid/web/response.rb

@@ -0,0 +1,27 @@
+class Sendgrid::Web::Response
+
+  attr_reader :status_code, :raw_body, :parsed_body
+
+  def initialize(status_code, body)
+    @status_code = status_code.to_i
+    @raw_body = body.to_s
+    @parsed_body = ::Oj.safe_load(raw_body)
+  end
+
+  # Checks if the Sengrid response contained errors.
+  #
+  # @return [bool] True if there were errors found.
+  def errors?
+    !parsed_body.nil? &&
+    parsed_body.is_a?(Hash) &&
+    parsed_body.has_key?('errors')
+  end
+
+  # Fetches an array of error messages from the response.
+  #
+  # @return [Array<String>] A list of any error messages.
+  def error_messages
+    errors? ? parsed_body['errors'] : []
+  end
+
+end

data/lib/sendgrid/web/version.rb

@@ -1,5 +1,5 @@
 module Sendgrid
   module Web
-    VERSION = "0.0.1"
+    VERSION = "0.0.5"
   end
 end

data/sendgrid-web.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "typhoeus", ">= 0.6.3"
-  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "httparty", ">= 0.11.0"
+  spec.add_runtime_dependency "oj", "~> 2.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/sendgrid/web/blocks_spec.rb

@@ -9,42 +9,29 @@ describe Sendgrid::Web::Blocks do
   end
 
   describe '#get' do
-    let(:test_connection) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('blocks.get.json') { [200, {}, 'sent blocks.get'] }
+    it_behaves_like('a sendgrid response', '/api/blocks.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "status": "4.0.0",
+            "created": "2012-09-02 00:12:12",
+            "reason": "550 Access denied...04d52d35b93501d500a9bca895ddad5cddd1a9f8486c89ace8c5e959398198cd49cd58288c9d11313975284d852811... (throttled)",
+            "email": "example@juno.com"
+          }
+        ]'
       end
     end
-
-    before do
-      subject.stub(:connection).and_return(test_connection)
-    end
-
-    it 'makes a json request to /blocks.get.json' do
-      test_connection.should_receive(:post).
-        with('blocks.get.json',
-             hash_including(api_user: 'foo', api_key: 'bar')).
-        and_call_original
-      subject.get
-    end
   end
 
   describe '#delete' do
-    let(:test_connection) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('blocks.delete.json') { [200, {}, 'sent blocks.delete'] }
+    it_behaves_like('a sendgrid response', '/api/blocks.delete.json') do
+      let(:action) { subject.delete(email: 'foobar@example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
       end
     end
-
-    before do
-      subject.stub(:connection).and_return(test_connection)
-    end
-
-    it 'makes a json request to /blocks.delete.json' do
-      test_connection.should_receive(:post).
-        with('blocks.delete.json',
-             hash_including(api_user: 'foo', api_key: 'bar', email: 'foobar@example.com')).
-        and_call_original
-      subject.delete(email: 'foobar@example.com')
-    end
   end
 end

data/spec/sendgrid/web/bounces_spec.rb

@@ -9,42 +9,29 @@ describe Sendgrid::Web::Bounces do
   end
 
   describe '#get' do
-    let(:test_connection) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('bounces.get.json') { [200, {}, 'sent bounces.get'] }
+    it_behaves_like('a sendgrid response', '/api/bounces.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "status": "4.0.0",
+            "created": "2011-09-16 22:02:19",
+            "reason": "Unable to resolve MX host sendgrid.ne",
+            "email": "esting@sendgrid.ne"
+          }
+        ]'
       end
     end
-
-    before do
-      subject.stub(:connection).and_return(test_connection)
-    end
-
-    it 'makes a json request to /bounces.get.json' do
-      test_connection.should_receive(:post).
-        with('bounces.get.json',
-             hash_including(api_user: 'foo', api_key: 'bar')).
-        and_call_original
-      subject.get
-    end
   end
 
   describe '#delete' do
-    let(:test_connection) do
-      Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.post('bounces.delete.json') { [200, {}, 'sent bounces.delete'] }
+    it_behaves_like('a sendgrid response', '/api/bounces.delete.json') do
+      let(:action) { subject.delete }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
       end
     end
-
-    before do
-      subject.stub(:connection).and_return(test_connection)
-    end
-
-    it 'makes a json request to /bounces.delete.json' do
-      test_connection.should_receive(:post).
-        with('bounces.delete.json',
-             hash_including(api_user: 'foo', api_key: 'bar', email: 'foobar@example.com')).
-        and_call_original
-      subject.delete(email: 'foobar@example.com')
-    end
   end
 end

data/spec/sendgrid/web/configurator_spec.rb

@@ -14,7 +14,7 @@ describe Sendgrid::Web::Configurator do
   end
 
   it 'sets a default root_url for sendgrid' do
-    subject.root_url.should eql('https://sendgrid.com/api/')
+    subject.root_url.should eql('https://sendgrid.com')
   end
 
   it 'can overwrite the api root_url' do

data/spec/sendgrid/web/credentials_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Credentials do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/credentials/get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "id": 4,
+            "name": "johnsmith",
+            "permissions": {
+              "email": 0,
+              "api": 1
+            }
+          }
+        ]'
+      end
+    end
+  end
+
+  describe '#add' do
+    it_behaves_like('a sendgrid response', '/api/credentials/add.json') do
+      let(:action) { subject.add(username: 'foobar', password: 'foobar') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#edit' do
+    it_behaves_like('a sendgrid response', '/api/credentials/edit.json') do
+      let(:action) { subject.edit(username: 'foobar') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#delete' do
+    it_behaves_like('a sendgrid response', '/api/credentials/delete.json') do
+      let(:action) { subject.delete(username: 'foobar') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/filter_commands_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::FilterCommands do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get_available' do
+    it_behaves_like('a sendgrid response', '/api/filter.getavailable.json') do
+      let(:action) { subject.get_available }
+      let(:response) do
+        '[
+          {
+            "name": "twitter",
+            "title": "Twitter",
+            "description": "This plugin allows you to send an email message to twitter",
+            "activated": false
+          }
+        ]'
+      end
+    end
+  end
+
+  describe '#activate_app' do
+    it_behaves_like('a sendgrid response', '/api/filter.activate.json') do
+      let(:action) { subject.activate_app(name: 'twitter') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#deactivate_app' do
+    it_behaves_like('a sendgrid response', '/api/filter.deactivate.json') do
+      let(:action) { subject.deactivate_app(name: 'twitter') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#setup_app' do
+    it_behaves_like('a sendgrid response', '/api/filter.setup.json') do
+      let(:action) { subject.setup_app(name: 'twitter', username: 'foo', password: 'bar') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+
+  describe '#get_settings' do
+    it_behaves_like('a sendgrid response', '/api/filter.getsettings.json') do
+      let(:action) { subject.get_settings(name: 'twitter') }
+      let(:response) do
+        '{
+          "message": "success",
+          "settings": [
+            {
+              "field_name": "field_value"
+            }
+          ]
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/invalid_emails_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::InvalidEmails do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like('a sendgrid response', '/api/invalidemails.get.json') do
+      let(:action) { subject.get }
+      let(:response) do
+        '[
+          {
+            "reason": "Known bad domain",
+            "created": "2011-06-06 16:11:57",
+            "email": "test@example.com"
+          }
+        ]'
+      end
+    end
+  end
+
+  describe '#delete' do
+    it_behaves_like('a sendgrid response', '/api/invalidemails.delete.json') do
+      let(:action) { subject.delete(email: 'foobar@example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/mail_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Mail do
+  before(:all) do
+    Sendgrid::Web::Client.configure do |config|
+      config.username = 'foo'
+      config.password = 'bar'
+    end
+  end
+
+  describe '#send' do
+    it_behaves_like('a sendgrid response', '/api/mail.send.json') do
+      let(:action) { subject.send(
+        to: 'foobar@example.com',
+        subject: 'Test Email',
+        text: 'Sent using `sendgrid-web`',
+        from: 'test@example.com') }
+      let(:response) do
+        '{
+          "message": "success"
+        }'
+      end
+    end
+  end
+end

data/spec/sendgrid/web/response_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Sendgrid::Web::Response do
+
+  let(:valid_body) do
+    '[{
+      "username": "sampleuser@example.com",
+      "email": "sampleemail@example.com",
+      "active": "true",
+      "first_name": "john",
+      "last_name": "doe",
+      "address": "555 any street",
+      "city": "any city",
+      "state": "CA",
+      "zip": "91234",
+      "country": "US",
+      "phone": "555-555-5555",
+      "website": "example.com"
+    }]'
+  end
+
+  let(:error_body) do
+    '{
+      "message": "error",
+      "errors": [
+        "error message one",
+        "error message two"
+      ]
+    }'
+  end
+
+  let(:body) { valid_body }
+  let(:status_code) { '200' }
+  let(:response) { Sendgrid::Web::Response.new(status_code, body) }
+
+  subject { response }
+
+  it 'stores the response body' do
+    subject.raw_body.should eql(body)
+  end
+
+  it 'stores the response status' do
+    subject.status_code.should eql(status_code.to_i)
+  end
+
+  describe '#errors?' do
+    subject { response.errors? }
+
+    context 'when sendgrid returns a json error' do
+      let(:body) { error_body }
+      it { should be_true }
+    end
+
+    context 'when sendgrid returns a valid result' do
+      let(:body) { valid_body }
+      it { should be_false }
+    end
+  end
+
+  describe '#error_messages' do
+    subject { response.error_messages }
+
+    context 'when sendgrid returns a json error' do
+      let(:body) { error_body }
+      it { should eql(['error message one', 'error message two']) }
+    end
+
+    context 'when sendgrid returns a valid result' do
+      let(:body) { valid_body }
+      it { should be_empty }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -7,7 +7,11 @@ require 'sendgrid/web'
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
 RSpec.configure do |config|
+
+  Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus

data/spec/support/shared_sendgrid_response.rb

@@ -0,0 +1,25 @@
+shared_examples "a sendgrid response" do |path|
+  let(:test_connection) { double(:connection) }
+
+  before do
+    test_connection.stub(:post).
+      with(path, anything).
+      and_return(double(:response, code: 200, body: response))
+    subject.stub(:connection).and_return(test_connection)
+  end
+
+  it "makes a json request to #{path}" do
+    params = double(:parameters)
+    subject.stub(:default_params) { params }
+    test_connection.should_receive(:post).
+      with(path, params)
+    action
+  end
+
+  it 'returns a Sendgrid::Web::Response' do
+    result = action
+    result.should be_instance_of(Sendgrid::Web::Response)
+    result.status_code.should eql(200)
+    result.raw_body.should eql(response)
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-web
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Darren Coxall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,18 +95,30 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/sendgrid-web.rb
 - lib/sendgrid/web.rb
 - lib/sendgrid/web/blocks.rb
 - lib/sendgrid/web/bounces.rb
 - lib/sendgrid/web/client.rb
 - lib/sendgrid/web/configurator.rb
+- lib/sendgrid/web/credentials.rb
+- lib/sendgrid/web/filter_commands.rb
+- lib/sendgrid/web/invalid_emails.rb
+- lib/sendgrid/web/mail.rb
+- lib/sendgrid/web/response.rb
 - lib/sendgrid/web/version.rb
 - sendgrid-web.gemspec
 - spec/sendgrid/web/blocks_spec.rb
 - spec/sendgrid/web/bounces_spec.rb
 - spec/sendgrid/web/client_spec.rb
 - spec/sendgrid/web/configurator_spec.rb
+- spec/sendgrid/web/credentials_spec.rb
+- spec/sendgrid/web/filter_commands_spec.rb
+- spec/sendgrid/web/invalid_emails_spec.rb
+- spec/sendgrid/web/mail_spec.rb
+- spec/sendgrid/web/response_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_sendgrid_response.rb
 homepage: https://github.com/FreakyDazio/sendgrid-web
 licenses:
 - MIT
@@ -136,4 +148,10 @@ test_files:
 - spec/sendgrid/web/bounces_spec.rb
 - spec/sendgrid/web/client_spec.rb
 - spec/sendgrid/web/configurator_spec.rb
+- spec/sendgrid/web/credentials_spec.rb
+- spec/sendgrid/web/filter_commands_spec.rb
+- spec/sendgrid/web/invalid_emails_spec.rb
+- spec/sendgrid/web/mail_spec.rb
+- spec/sendgrid/web/response_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_sendgrid_response.rb