sendgrid_web 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+
+script: bundle exec rake test

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'faraday'
+
+group :test do
+  gem 'rake'
+end
+
+# Specify your gem's dependencies in sendgrid_web.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremiah Heller
+
+MIT License
+
+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/README.md

@@ -0,0 +1,72 @@
+# SendgridWeb
+
+Ruby interface for working with SendGrid's Web (HTTP) API. Read more at http://docs.sendgrid.com/documentation/api/web-api/.
+
+## Build Status [<img src="https://secure.travis-ci.org/inertialbit/sendgrid_web.png"/>](http://travis-ci.org/inertialbit/sendgrid_web)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendgrid_web'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendgrid_web
+
+## Usage
+
+Something like the following would be nice.
+
+### Configuration
+
+    SendgridWeb.configure do |config|
+      config.api_user = 'sendgrid-user'
+      config.api_key = 'sendgrid-secret'
+    end
+
+### Running Programmatically
+
+    response = SendgridWeb.unsubscribes(:get, :xml) do |request|
+      request.option :timeout => 30
+      request.option :open_timeout => 30
+      request.header 'HTTP-HEADER' => 'value'
+
+      request.with_date # special to enforce api rule of required value of 1
+
+      request.param 'start_date' => 2012-07-31
+      request.param 'email' => 'me@test.com'
+    end
+
+    if response.success?
+      # do stuff...
+    else
+      # do other stuff...
+    end
+
+### Running Manually
+
+not implemented yet!!
+
+    $ sendgrid_web get unsubscribes --with-date --days 30 --start_date 2012-07-01 --end_date 2012-07-31 --limit 20 --offset 0 --email 'blah@test.com'
+    $ sendgrid_web delete unsubscribes.xml --email 'blah@test.com'
+    $ sendgrid_web delete unsubscribes.json --after 2012-07-01 --before 2012-07-31
+    $ sendgrid_web get bounces --with-date --days-ago 30 # default is json
+
+## Todo
+
+- more tests
+- implement as Faraday middleware (support async calls)
+- CLI
+
+## 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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+load "#{File.dirname(__FILE__)}/lib/tasks/tests.rake"
+
+task :test => Rake::Task['test:sendgrid_web']

data/bin/sendgrid_web

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sendgrid_web'
+
+raise "TODO: implement CLI"

data/lib/sendgrid_web.rb

@@ -0,0 +1,62 @@
+require "sendgrid_web/version"
+require "sendgrid_web/request"
+
+##
+#
+# Module to provide thin ruby API to SendGrid Web API.
+# Uses Faraday to make requests. Currently supports synchronous calls only.
+#
+# Exposes both Sendgrid and Faraday interfaces.
+#
+module SendgridWeb
+
+  ##
+  #
+  # Primary interface. Simply call the desired module directly on SendgridWeb
+  # and pass in the verb, format and a block to set any needed parameters.
+  #
+  # Example usage:
+  #
+  #     # Make a request to SendGrid module, say Unsubscribes
+  #     # fetching a specific email.
+  #     faraday_response = SendgridWeb.unsubscribes(:get, :json) { request.param :email => 'me@test.com' }
+  #
+  #     # Send an email.
+  #     faraday_response = SendgridWeb.mail(:send, :xml) do
+  #       request.param :to => 'me@test.com', :subject => 'Tada!', :from => 'you@test.com'
+  #       request.param :text => 'sample message body'
+  #       request.param :html => '<p>sample message body</p>'
+  #     end
+  #
+  def self.method_missing(resource, verb, format=:json, &block)
+    Request.configure do |request|
+      request.verb = verb
+      request.resource = resource
+      request.format = format
+
+      yield request
+    end
+    process
+  end
+
+  class << self
+    attr_accessor :host, :scheme, :api_namespace, :api_user, :api_key
+
+    def configure
+      yield self
+    end
+  end
+
+private
+
+  def self.process
+    url = URI.join(Request.url, Request.url_action).to_s
+    Faraday.get(url, Request.params, Request.headers)
+  end
+end
+
+SendgridWeb.configure do |config|
+  config.scheme = "https"
+  config.host = "sendgrid.com"
+  config.api_namespace = "api"
+end

data/lib/sendgrid_web/request.rb

@@ -0,0 +1,46 @@
+require 'sendgrid_web/utils'
+
+begin
+  require 'faraday'
+rescue LoadError => e
+  require 'rubygems'
+  require 'faraday'
+  p "Warning: requiring rubygems since faraday failed to load on it's own."
+end
+
+module SendgridWeb
+  module Request
+    class << self
+      attr_accessor :headers, :options, :callbacks
+      include URL
+
+      ##
+      #
+      # Configure a Request. +@options+ and +@headers+ are
+      # passed through to Faraday.
+      #
+      def configure &block
+        @callbacks = {}
+        @headers = []
+        @options = []
+
+        unless SendgridWeb.api_user.nil? or SendgridWeb.api_key.nil?
+          param(:api_user => SendgridWeb.api_user)
+          param(:api_key => SendgridWeb.api_key)
+        end
+
+        yield self
+      end
+
+      def option(option)
+        @options ||= {}
+        @options.merge!(option)
+      end
+
+      def header(header)
+        @headers ||= {}
+        @headers.merge!(header)
+      end
+    end
+  end
+end

data/lib/sendgrid_web/utils.rb

@@ -0,0 +1,35 @@
+module SendgridWeb
+  ##
+  #
+  # Utility to assemble a URL for Sendgrid.
+  #
+  module URL
+    attr_accessor :url, :params, :format, :resource, :verb
+
+    def url
+      @url ||= "#{SendgridWeb.scheme}://#{SendgridWeb.host}/"
+    end
+
+    # Returns action portion of Sendgrid URL, e.g.
+    # "api/resource.verb.format"
+    def url_action
+      parts = []
+      parts << SendgridWeb.api_namespace
+      parts << [resource, verb, format].join('.')
+      parts.join('/')
+    end
+
+    # Add or overwrite a param in +@params+ hash.
+    # These are passed through to Faraday.
+    def param(param)
+      @params ||= {}
+      @params.merge!(param)
+    end
+
+    # Convenience method to add param with
+    # strict Sendgrid requirements.
+    def with_date
+      param(:date => 1)
+    end
+  end
+end

data/lib/sendgrid_web/version.rb

@@ -0,0 +1,3 @@
+module SendgridWeb
+  VERSION = "0.0.1"
+end

data/lib/tasks/tests.rake

@@ -0,0 +1,17 @@
+# run tests
+begin
+  require 'rake/testtask'
+rescue LoadError => e
+end
+
+if defined? Rake::TestTask
+  namespace :test do
+    SENDGRID_WEB_ROOT = File.expand_path(File.join(File.dirname(__FILE__), "..",".."))
+    Rake::TestTask.new(:sendgrid_web) do |t|
+      t.libs << "#{SENDGRID_WEB_ROOT}/test"
+      t.libs << "#{SENDGRID_WEB_ROOT}/lib"
+      t.pattern = "#{SENDGRID_WEB_ROOT}/test/**/*_test.rb"
+      t.verbose = true
+    end
+  end
+end

data/sendgrid_web.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendgrid_web/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sendgrid_web"
+  gem.version       = SendgridWeb::VERSION
+  gem.authors       = ["Jeremiah Heller"]
+  gem.email         = ["jeremiah@inertialbit.net"]
+  gem.description   = %q{Ruby interface for working with SendGrid's Web (HTTP) API. Read more at http://docs.sendgrid.com/documentation/api/web-api/.}
+  gem.summary       = %q{Wraps SendGrid Web API and works with rack on ruby 1.8.7, 1.9.2, 1.9.3.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("faraday", ["= 0.8.4"])
+end

data/test/integration/sendgrid_web_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'cgi'
+require 'uri'
+require 'sendgrid_web'
+
+class SendgridWebTest < Test::Unit::TestCase
+  def self.sendgrid_modules
+    [
+      {:bounces => [:get, :delete]},
+      {:blocks => [:get, :delete]},
+      {:parse => [:get, :set, :edit, :delete]},
+      {:filter => [:get, :activate, :deactivate, :setup, :getsettings]},
+      {:invalidemails => [:get, :delete]},
+      {:mail => [:send]},
+      {:profile => [:get, :set, :setUsername, :setPassword, :setEmail]},
+      {:spamreports => [:get, :delete]},
+      {:stats => [:get]},
+      {:unsubscribes => [:add, :get, :delete]}
+    ]
+  end
+
+  def normalize_query(url)
+    url.query.split('&').map{|pair| k,v = pair.split('='); {k.to_sym => CGI.unescape(v)}}
+  end
+
+  sendgrid_modules.each do |sg_module|
+    define_method "test_#{sg_module}_wrapper" do
+      sg_module.each do |sg_module_name, sg_module_actions|
+        sg_module_actions.each do |action|
+
+          email = 'me@test.com'
+          start_date = '2012-07-31'
+          api_user = 'user'
+          api_key = 'secret'
+          expected_url = URI("https://sendgrid.com/api/#{sg_module_name}.#{action}.json?api_user=#{api_user}&api_key=#{api_key}&start_date=#{start_date}&email=#{email}")
+
+          SendgridWeb.configure do |config|
+            config.api_user = api_user
+            config.api_key = api_key
+          end
+
+          response = SendgridWeb.send(sg_module_name, action, :json) do |request|
+            request.with_date # special to enforce api rule of required value of 1
+
+            request.param :start_date => start_date
+            request.param :email => email
+          end
+
+          generated_url = response.env[:url]
+
+          %w(scheme host path).each do |part|
+            assert_equal(expected_url.send(part), generated_url.send(part), "generated #{part} didn't match expected")
+          end
+
+          generated_query = normalize_query(generated_url)
+          expected_query = normalize_query(expected_url)
+
+          expected_query.each do |param|
+            assert(generated_query.include?(param), "generated query missing #{param.inspect}")
+          end
+
+        end # sg_module_actions#each
+      end # sg_module#each
+    end # define_method
+  end # sendgrid_modules#each
+end # SendgridWebTest

data/test/test_helper.rb

@@ -0,0 +1 @@
+require 'test/unit'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: sendgrid_web
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremiah Heller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.4
+description: Ruby interface for working with SendGrid's Web (HTTP) API. Read more
+  at http://docs.sendgrid.com/documentation/api/web-api/.
+email:
+- jeremiah@inertialbit.net
+executables:
+- sendgrid_web
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sendgrid_web
+- lib/sendgrid_web.rb
+- lib/sendgrid_web/request.rb
+- lib/sendgrid_web/utils.rb
+- lib/sendgrid_web/version.rb
+- lib/tasks/tests.rake
+- sendgrid_web.gemspec
+- test/integration/sendgrid_web_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2860537481081348625
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2860537481081348625
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wraps SendGrid Web API and works with rack on ruby 1.8.7, 1.9.2, 1.9.3.
+test_files:
+- test/integration/sendgrid_web_test.rb
+- test/test_helper.rb