parity-sendgrid-api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7667aa5a9c1bbc7db7e2d0b1dac3d61a20798195
+  data.tar.gz: b0cb8c9b31b18db1915b317783d065d3ae0de5bc
+SHA512:
+  metadata.gz: c6db8b6ee18cc0cb47c2e7670217b5350ce4e2b3424a11afd2b8445799321dd2d99b44ebab807a7a964eec29ab55e3ab9af9555170fa93258036584fcbc83c85
+  data.tar.gz: cecb3a41646d40e3f8110c405def712cdc8840378abac7f9722bfbb8f83105dcf1858c13cbba773322f22df0e682d3c3cd2720e96d3cb372167574f448f479b7

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc
+vendor/*
+coverage/*
+doc/*

data/.rspec

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

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,6 @@
+--no-private
+--protected
+--markup markdown
+-
+LICENSE
+README.md

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem "bundler", "~> 1.6.2"
+  gem "rake", "~> 10.3.2"
+  gem "yard", "~> 0.8.7.4"
+  gem "redcarpet", "~> 3.1.2"
+end
+
+group :test do
+  gem "rspec", "~> 2.14.1"
+  gem "coveralls", "~> 0.7.0", :require => false
+  gem "simplecov", "~> 0.8.2", :require => false
+  gem "webmock", "~> 1.18.0"
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    sendgrid-api (0.0.4)
+      faraday (~> 0.9.0)
+      json (~> 1.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    json (1.8.1)
+    mime-types (2.0)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    rake (10.3.2)
+    redcarpet (3.1.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (1.0.3)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.12.0)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6.2)
+  coveralls (~> 0.7.0)
+  rake (~> 10.3.2)
+  redcarpet (~> 3.1.2)
+  rspec (~> 2.14.1)
+  sendgrid-api!
+  simplecov (~> 0.8.2)
+  webmock (~> 1.18.0)
+  yard (~> 0.8.7.4)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Renato Neves
+
+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,261 @@
+# 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
+
+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:
+
+```ruby
+gem 'sendgrid-api'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sendgrid-api
+```
+
+## Configuration
+
+```ruby
+client = Sendgrid::API::Client.new('YOUR_USER', 'YOUR_KEY')
+```
+
+## Web API
+
+### Profile
+
+```ruby
+# create a profile object
+profile = Sendgrid::API::Entities::Profile.new(:first_name => 'Your first name',
+                                               :last_name => 'Your last name')
+# get your profile
+profile = client.profile.get
+# modify your profile
+response = client.profile.set(profile)
+```
+
+### Mail
+
+```ruby
+# send basic text email
+response = client.mail.send(:to => 'johndoe@example.com',
+                            :from => 'brian@example.com',
+                            :subject => 'test using sendgrid api',
+                            :text => 'this is a test')
+# set SMTP API headers
+x_smtpapi = {:category => ['sendgrid-api test']}
+response = client.mail.send(:to => 'johndoe@example.com',
+                            :from => 'brian@example.com',
+                            :subject => 'test using sendgrid api',
+                            :text => 'this is a test',
+                            :x_smtpapi => x_smtpapi)
+# send files attached
+text = StringIO.new("This is my file content")
+file = Faraday::UploadIO.new(text, 'plain/text', 'sample.txt')
+response = client.mail.send(:to => 'johndoe@example.com',
+                            :from => 'brian@example.com',
+                            :subject => 'test using sendgrid api',
+                            :text => 'this is a test',
+                            :files => {'sample.txt' => file})
+```
+
+### Statistics
+
+```ruby
+# get advanced statistics
+stats = client.stats.advanced(:start_date => '2013-01-01', :data_type => 'global')
+```
+
+## Marketing Email API
+
+### Lists
+
+```ruby
+# create a list object
+list = Sendgrid::API::Entities::List.new(:list => 'sendgrid-api list test')
+# add a new list
+response = client.lists.add(list)
+# edit an existing list
+response = client.lists.edit(list, 'new name')
+# get an existing list
+selected_list = client.lists.get(list)
+# get all lists
+all_lists = client.lists.get
+# delete a list
+response = client.lists.delete(list)
+```
+
+### Emails
+
+```ruby
+# create email objects
+email1 = Sendgrid::API::Entities::Email.new(
+            :email => 'johndoe@example.com',
+            :name => 'John Doe'
+         )
+email2 = Sendgrid::API::Entities::Email.new(
+            :email => 'brian@example.com',
+            :name => 'Brian'
+         )
+emails = [email1, email2]
+listname = 'sendgrid-api list test'
+# add emails to a list
+response = client.emails.add(listname, emails)
+# get all emails from a list
+all_emails = client.emails.get(listname)
+# get a specific email from a list
+selected_emails = client.emails.get(listname, email1)
+# delete an email from a list
+response = client.emails.delete(listname, email1)
+```
+
+### Sender Adresses
+
+```ruby
+# create sender address object
+address = Sendgrid::API::Entities::SenderAddress.new(
+            :identity => 'sendgrid-api sender address test',
+            :name     => 'Sendgrid',
+            :email    => 'contact@sendgrid.com',
+            :address  => '1065 N Pacificenter Drive, Suite 425',
+            :city     => 'Anaheim',
+            :state    => 'CA',
+            :zip      => '92806',
+            :country  => 'US'
+          )
+# add a sender address
+response = client.sender_addresses.add(address)
+# edit a sender address
+address.city = 'Pleasanton'
+response = client.sender_addresses.edit(address, 'new identity')
+# get all sender addresses
+addresses = client.sender_addresses.list
+# get a sender address
+address = client.sender_addresses.get(address)
+# delete a sender address
+response = client.sender_addresses.delete(address)
+```
+
+### Marketing Emails
+
+```ruby
+# create marketing email object
+marketing_email = Sendgrid::API::Entities::MarketingEmail.new(
+                    :identity => 'sendgrid-api sender address test',
+                    :name     => 'sendgrid-api marketing email test',
+                    :subject  => 'My Marketing Email Test',
+                    :text     => 'My text',
+                    :html     => 'My HTML'
+                  )
+# add a marketing email
+response = client.marketing_emails.add(marketing_email)
+# edit a marketing email
+marketing_email.html = 'My new HTML'
+response = client.marketing_emails.edit(marketing_email, 'new name')
+# get a marketing email
+newsletter = client.marketing_emails.get(marketing_email)
+# get all marketing emails
+newsletters = client.marketing_emails.list
+# delete a marketing email
+response = client.marketing_emails.delete(marketing_email)
+```
+
+### Categories
+
+```ruby
+# create category object
+category = Sendgrid::API::Entities::Category.new(:category => 'sendgrid-api test')
+marketing_email = 'sendgrid-api marketing email test'
+# add category
+response = client.categories.create(category)
+# add category to a marketing email
+response = client.categories.add(marketing_email, category)
+# remove category from a marketing email
+response = client.categories.remove(marketing_email, category)
+# get all categories
+categories = client.categories.list
+```
+
+### Recipients
+
+```ruby
+listname = 'sendgrid-api list test'
+marketing_email = 'sendgrid-api marketing email test'
+# assign a recipient list to a marketing email
+response = client.recipients.add(listname, marketing_email)
+# get all lists assigned to a marketing email
+lists = client.recipients.get(marketing_email)
+# delete an assigned list from a marketing email
+response = client.recipients.delete(listname, marketing_email)
+```
+
+### Schedule
+
+```ruby
+marketing_email = 'sendgrid-api marketing email test'
+# schedule a delivery time for a marketing email
+response = client.schedule.add(marketing_email) # imediately
+response = client.schedule.add(marketing_email, :after => 20) # 20 minutes from now
+response = client.schedule.add(marketing_email, :at => (Time.now + 10*60)) # 10 minutes from now
+# retrieve the scheduled delivery time for a marketing email
+schedule = client.schedule.get(marketing_email)
+# cancel a scheduled delivery time for a marketing email
+response = client.schedule.delete(marketing_email)
+```
+
+## Tests
+
+This gem has offline and online tests written using RSpec. Offline tests use Webmock to stub HTTP requests, while online tests performs the requests to Sendgrid to ensure all the calls and responses are correctly.
+
+The online tests are written in a way that they don't change the state of the objects already existing on SendGrid account. It means if something is added, it's removed at the end of the test. If something is changed, it's changed back after the test finishes. If it's necessary to remove something, it's added before the test starts.
+
+Use the SENDGRID_USER and SENDGRID_KEY environment variables to authenticate the online tests.
+
+To run all tests (both offline and online):
+```bash
+$ ALL=1 SENDGRID_USER=your_user SENDGRID_KEY=your_key bundle exec rake spec
+```
+
+To run only online tests:
+```bash
+$ SENDGRID_USER=your_user SENDGRID_KEY=your_key bundle exec rake spec[online]
+```
+
+To run only offline tests (default):
+```bash
+$ bundle exec rake spec
+```
+
+## 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 - 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

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

data/lib/sendgrid/api.rb

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

data/lib/sendgrid/api/client.rb

@@ -0,0 +1,43 @@
+require 'sendgrid/api/rest/resource'
+require 'sendgrid/api/web/profile'
+require 'sendgrid/api/web/stats'
+require 'sendgrid/api/web/mail'
+require 'sendgrid/api/newsletter/lists'
+require 'sendgrid/api/newsletter/emails'
+require 'sendgrid/api/newsletter/sender_addresses'
+require 'sendgrid/api/newsletter/categories'
+require 'sendgrid/api/newsletter/marketing_emails'
+require 'sendgrid/api/newsletter/recipients'
+require 'sendgrid/api/newsletter/schedule'
+
+module Sendgrid
+  module API
+    class Client
+
+      include Web::Profile
+      include Web::Stats
+      include Web::Mail
+      include Newsletter::Lists
+      include Newsletter::Emails
+      include Newsletter::SenderAddresses
+      include Newsletter::Categories
+      include Newsletter::MarketingEmails
+      include Newsletter::Recipients
+      include Newsletter::Schedule
+
+      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