sendgrid_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de1314e5105ecfc087659fd6ceedc9c61ec51545
+  data.tar.gz: eedb261cf51d403b09dfbdfc5edd64fba1a878d3
+SHA512:
+  metadata.gz: 67a3bc99c2bffbc1df7ea30f78983ac6c79266b57f3b3ecd9d68073b412fdf3985ea69b0b3ffad6682313ee07de68cc97a59bba324439de6e881a8ae912a9f6c
+  data.tar.gz: bb1c2b20b7ca2484704bc2b042a1cc3461be145419c48d37a3749d262a23205ebf1880f520e21c3d43bacefed6c1084939d068506d45a344b8909fa81ae8e0dd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+before_script:
+  - bundle install
+script:
+  - rake test

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sendgrid_ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014 SendGrid JP
+
+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,347 @@
+# sendgrid_ruby
+
+This gem allows you to quickly and easily send emails through SendGrid using Ruby.
+
+[![Build Status](https://travis-ci.org/SendGridJP/sendgrid-ruby.svg?branch=master)](https://travis-ci.org/SendGridJP/sendgrid-ruby)
+
+```Ruby
+email = SendgridRuby::Email.new
+email.add_to('foo@bar.com')
+.add_to('dude@bar.com')
+.set_from(me@bar.com)
+.set_subject("Subject goes here")
+.set_text("Hello World!")
+.set_html("<strong>Hello World!</strong><br />")
+
+sendgrid = SendgridRuby::Sendgrid.new('username', 'password')
+sendgrid.send(email)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sendgrid_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sendgrid_ruby
+
+## Example App
+
+There is a [sendgridjp-ruby-example app](https://github.com/sendgridjp/sendgridjp-ruby-example) to help jumpstart your development.
+
+## Usage
+
+To begin using this gem, initialize the SendGrid object with your SendGrid credentials.
+
+```Ruby
+sendgrid = SendgridRuby::Sendgrid.new('username', 'password')
+```
+
+Create a new SendGrid Email object and add your message details.
+
+```Ruby
+mail = SendgirdRuby::Email.new
+mail.add_to('foo@bar.com')
+    .setFrom('me@bar.com')
+    .setSubject('Subject goes here')
+    .setText('Hello World!')
+    .setHtml('<strong>Hello World!</strong>')
+```
+
+Send it. 
+
+```Ruby
+response = sendgrid.send(mail)
+```
+
+### add_to
+
+You can add one or multiple TO addresses using `add_to`.
+
+```Ruby
+mail = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    .add_to('another@another.com')
+sendgrid.send(mail)
+```
+
+### set_tos
+
+If you prefer, you can add multiple TO addresses as an array using the `set_tos` method. This will unset any previous `add_to`s you appended.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+emails = ["foo@bar.com", "another@another.com", "other@other.com"]
+mail.set_tos(emails)
+sendgrid.send(mail)
+```
+
+### get_tos
+
+Sometimes you might find yourself wanting to list the currently set Tos. You can do that with `get_tos`.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+mail.get_tos
+```
+
+### remove_to 
+
+You might also find yourself wanting to remove a single TO from your set list of TOs. You can do that with `remove_to`. You can pass a string or regex to the remove_to method.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+mail.remove_to('foo@bar.com')
+```
+
+### set_from
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.set_from('foo@bar.com')
+sendgrid.send(mail)
+```
+
+### set_from_name
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.set_from('foo@bar.com')
+mail.set_from_name('Foo Bar')
+mail.set_from('other@example.com')
+mail.set_from_name('Other Guy')
+sendgrid.send($mail)
+```
+
+### set_reply_to
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.set_reply_to('foo@bar.com')
+sendgrid.send(mail)
+```
+
+### Bcc
+
+Use multiple `add_to`s as a superior alternative to `set_bcc`.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    .add_to('someotheraddress@bar.com')
+    .add_to('another@another.com')
+       ...
+```
+
+### set_subject
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.set_subject('This is a subject')
+sendgrid.send(mail)
+```
+
+### set_text
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.set_text('This is some text')
+sendgrid.send(mail)
+```
+
+### set_html
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.set_html('<h1>This is an html email</h1>')
+sendgrid.send(mail)
+```
+
+### Categories ###
+
+Categories are used to group email statistics provided by SendGrid.
+
+To use a category, simply set the category name.  Note: there is a maximum of 10 categories per email.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    ...
+    .add_category("Category 1")
+    .add_category("Category 2")
+```
+
+### Attachments ###
+
+Attachments are currently file based only.
+
+File attachments are limited to 7 MB per file.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    ...
+    .add_attachment("../path/to/file.txt")
+```
+
+If you use the multiple add_to, each user will receive a personalized email showing **only* their email. This is more friendly and more personal.
+
+So just remember, when thinking 'bcc', instead use multiple `addTo`s.
+
+### From-Name and Reply-To
+
+There are two handy helper methods for setting the From-Name and Reply-To for a
+message
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    .set_reply_to('someone.else@example.com')
+    .set_from_name('John Doe')
+    ...
+```
+
+### Substitutions ###
+
+Substitutions can be used to customize multi-recipient emails, and tailor them for the user
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('john@somewhere.com')
+    .add_to("harry@somewhere.com")
+    .add_to("Bob@somewhere.com")
+    ...
+    .set_html("Hey name, we've seen that you've been gone for a while")
+    .add_substitution("name", ["John", "Harry", "Bob"])
+```
+
+### Sections ###
+
+Sections can be used to further customize messages for the end users. A section is only useful in conjunction with a substition value.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('john@somewhere.com')
+    .add_to("harry@somewhere.com")
+    .add_to("Bob@somewhere.com")
+    ...
+    .set_html("Hey name, you work at place")
+    .add_substitution("name", ["John", "Harry", "Bob"])
+    .add_substitution("place", ["office", "office", "home"])
+    .add_section("office", "an office")
+    .add_section("home", "your house")
+```
+
+### Unique Arguments ###
+
+Unique Arguments are used for tracking purposes
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    ...
+    .add_unique_arg("Customer", "Someone")
+    .add_unique_arg("location", "Somewhere")
+    .set_unique_args({'cow' => 'chicken'})
+```
+
+### Filter Settings ###
+
+Filter Settings are used to enable and disable apps, and to pass parameters to those apps.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    ...
+    .add_filter("gravatar", "enable", 1)
+    .add_filter("footer", "enable", 1)
+    .add_filter("footer", "text/plain", "Here is a plain text footer")
+    .add_filter("footer", "text/html", "<p style='color:red;'>Here is an HTML footer</p>")
+```
+
+### Headers ###
+
+You can add standard email message headers as necessary.
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    ...
+    .add_header('X-Sent-Using', 'SendGrid-API')
+    .add_header('X-Transport', 'web')
+```
+
+### Output debug log ###
+
+You can output the log for debug to $stderr
+
+```Ruby
+mail   = SendgridRuby::Email.new
+mail.add_to('foo@bar.com')
+    ...
+    .add_header('X-Sent-Using', 'SendGrid-API')
+    .add_header('X-Transport', 'web')
+
+sendgrid = SendgridRuby::Sendgrid.new(sendgrid_username, sendgrid_password)
+sendgrid.debug_output = true
+sendgrid.send(mail)
+```
+
+### Sending to 1,000s of emails in one batch
+
+Sometimes you might want to send 1,000s of emails in one request. You can do that. It is recommended you break each batch up in 1,000 increements. So if you need to send to 5,000 emails, then you'd break this into a loop of 1,000 emails at a time.
+
+```Ruby
+sendgrid = SendgridRuby::Sendgrid.new(sendgrid_username, sendgrid_password)
+mail   = SendgridRuby::Email.new
+
+recipients = ["alpha@mailinator.com", "beta@mailinator.com", "zeta@mailinator.com"]
+names      = ["Alpha", "Beta", "Zeta"]
+
+email.set_from("from@mailinator.com")
+    .set_subject('[sendgrid-ruby-batch-email]')
+    .set_tos($recipients)
+    .add_substitution("name", $names)
+    .set_text("Hey name, we have an email for you")
+    .set_html("<h1>Hey name, we have an email for you</h1>")
+
+result = sendgrid.send(mail)
+```
+
+### Ignoring SSL certificate verification
+
+You can optionally ignore verification of SSL certificate when using the Web API.
+
+```Ruby
+options = {"turn_off_ssl_verification" => true}
+sendgrid  = SendgridRuby::Sendgrid.new(SENDGRID_USERNAME, SENDGRID_PASSWORD, options)
+
+mail    = SendgridRuby::Email.new
+...
+result  = sendgrid.send(email)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/sendgrid/fork )
+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
+
+## Running Test
+
+The existing tests in the `test` directory can be run using unit test.
+
+````bash
+rake test
+```
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/sendgrid_ruby/*.rb','test/*.rb']
+  #t.test_files = FileList['test/*/*.rb']
+  t.verbose = true
+end
+
+