sendgrid-api 0.0.2 → 0.0.3

data/.gitignore

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

data/.yardopts

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

data/Gemfile

@@ -3,6 +3,8 @@ source 'https://rubygems.org'
 group :development do
   gem "bundler", "~> 1.3"
   gem "rake"
+  gem "yard"
+  gem "redcarpet"
 end
 
 group :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sendgrid-api (0.0.2)
+    sendgrid-api (0.0.3)
       faraday (~> 0.8.8)
       json (~> 1.8.0)
 
@@ -25,6 +25,7 @@ GEM
     multi_json (1.8.0)
     multipart-post (1.2.0)
     rake (10.1.0)
+    redcarpet (3.0.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.14.1)
@@ -47,6 +48,7 @@ GEM
     webmock (1.15.0)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
+    yard (0.8.7.2)
 
 PLATFORMS
   ruby
@@ -55,7 +57,9 @@ DEPENDENCIES
   bundler (~> 1.3)
   coveralls (~> 0.7.0)
   rake
+  redcarpet
   rspec (~> 2.14.1)
   sendgrid-api!
   simplecov (~> 0.7.1)
   webmock (~> 1.15.0)
+  yard

data/README.md

@@ -12,8 +12,6 @@ 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]
@@ -24,15 +22,21 @@ Check which SendGrid APIs are currently being covered by this gem:
 
 Add this line to your application's Gemfile:
 
-    gem 'sendgrid-api'
+```ruby
+gem 'sendgrid-api'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install sendgrid-api
+```bash
+$ gem install sendgrid-api
+```
 
 ## Configuration
 
@@ -40,28 +44,212 @@ Or install it yourself as:
 client = Sendgrid::API::Client.new('YOUR_USER', 'YOUR_KEY')
 ```
 
-## Usage Examples
+## Web API
 
-**Get your SendGrid Profile**
+### 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)
 ```
 
-**Modify your SendGrid Profile**
+### Mail
 
 ```ruby
-profile = Sendgrid::API::Entities::Profile.new(:first_name => 'Your first name',
-                                               :last_name => 'Your last name')
-response = client.profile.set(profile)
+# 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})
 ```
 
-**Get Advanced Statistics**
+### 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:

data/Rakefile

@@ -1,9 +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/client.rb

@@ -1,6 +1,14 @@
 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
@@ -8,6 +16,14 @@ module Sendgrid
 
       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
 

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

@@ -0,0 +1,13 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Category < Entity
+
+        attribute :category
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class Email < Entity
+
+        attribute :email, :name
+
+      end
+    end
+  end
+end

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

@@ -11,8 +11,8 @@ module Sendgrid
           @attributes = sanitize_attributes(attributes)
         end
 
-        def to_json
-          as_json.to_json
+        def to_json(*a)
+          as_json.to_json(*a)
         end
 
         def as_json

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

@@ -0,0 +1,30 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class List < Entity
+
+        attribute :list
+
+        class << self
+
+          # Convert the object to an Entities::List.
+          #
+          # @param object [String, Entities::List] A list name or Entities::List object
+          # @return [Entities::List] An Entities::List object
+          def from_object(object)
+            case object
+            when ::String
+              new(:list => object)
+            when self
+              object
+            end
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'sendgrid/api/entities/entity'
+
+module Sendgrid
+  module API
+    module Entities
+      class MarketingEmail < Entity
+
+        # required attributes to create
+        attribute :identity, :name, :subject, :text, :html
+
+        # other attributes
+        attribute :can_edit, :content_preview, :date_schedule, 
+                  :is_deleted, :is_split, :is_winner, :newsletter_id, 
+                  :nl_type, :timezone_id, :total_recipients,
+                  :type, :winner_sending_time
+
+      end
+    end
+  end
+end