RubyGems - sendgrid-ruby - Versions diffs - 0.0.2 → 0.0.3 - Mend

sendgrid-ruby 0.0.2 → 0.0.3

Files changed (6) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dedc1735da8ee2a09e97d3555e92b63fd631526
-  data.tar.gz: 29028865ccff1abe7dec82a570942229b7489c9a
+  metadata.gz: 852d4c2923fcdcae762675d591aae678ff97664d
+  data.tar.gz: 95acbc4f1b36c036fceac5cda5eba764718021b0
 SHA512:
-  metadata.gz: 7ea857ca795888f80c853713d7a5ceb145d11d387f0a03e389b9e762ca089b576c68c7c5ed48e79d9c154d60296108e88df746dc2db81e778ea328c2228fe754
-  data.tar.gz: 77f7f2b3f6db200b02b3faff9e3434f7a219de75f326ec03838436589008be37c13f8e8f646c2217cf1343f9fa3f93437dbc647421084b48bcccc87db4f8c66f
+  metadata.gz: abd3afa7292e24ef33ea86f70515a49f9a81b40484fc3c6f88ad37b430d00f42bbb0bee6f7aa3d50384d34055afd9738d66df170772f6cc4f298219c6b89d27b
+  data.tar.gz: 9c77400d124690b7deb810e760d1f1f3dcc6c35d8cf8a908a04205eeb8738d3591d341d13361e3b78f9803ab281db61c701f7a34796124a11a7b2c2020be6b7f

data/README.md CHANGED Viewed

@@ -26,7 +26,14 @@ Create a new client with your SendGrid Username and Password.
 ```ruby
 require 'sendgrid-ruby'
+# As a hash
 client = SendGrid::Client.new(api_user: 'SENDGRID_USERNAME', api_key: 'SENDGRID_PASSWORD')
+# Or as a block
+client = SendGrid::Client.new do |c|
+  c.api_user = 'SENDGRID_USERNAME'
+  c.api_key = 'SENDGRID_PASSWORD'
+end
 ```
 Create a new Mail object and send:
@@ -69,21 +76,185 @@ params = {
 }
 ```
-#### Using the X-SMTPAPI Header
-To utilize the X-SMTPAPI header, we have directly integrated the [smtpapi-ruby](https://github.com/SendGridJP/smtpapi-ruby) gem.  To initialize, you have two options:
+#### Setting Params
+Params can be set in the usual Ruby ways, including a block or a hash.
+````ruby
+mail = SendGrid::Mail.new do |m|
+  m.to = 'rbin@sendgrid.com'
+  m.from = 'taco@rbin.codes'
+end
+client.send(SendGrid::Mail.new(to: 'rbin@sendgrid.com', from: 'taco@cat.limo'))
+````
+#### :to
+Using the **:to** param, we can pass a single email address as a string, or an array of email address strings.
+````ruby
+mail = SendGrid::Mail.new
+mail.to = 'taco@rbin.codes'
+# or
+mail.to = ['Example Dude <example@email.com>', 'john@email.com']
+# or
+mail.to = ['rbin@sendgrid.com', 'taco@cat.limo']
+````
+#### :from
+```ruby
+mail = SendGrid::Mail.new
+mail.from = 'me@sendgrid.com'
+```
+#### :cc
+As with **:to**, **:cc** can take a single string or an array of strings.
+```ruby
+mail = SendGrid::Mail.new
+mail.cc = ['robin@sendgrid.com', 'taco@cat.limo']
+```
+#### :bcc
+As with **:to** and **:cc**, **:bcc** can take a single string or an array of strings.
+```ruby
+mail = SendGrid::Mail.new
+mail.bcc = ['robin@sendgrid.com', 'taco@cat.limo']
+```
+#### :subject
+```ruby
+mail = SendGrid::Mail.new
+mail.subject = 'This is a subject string'
+```
+### Email Bodies:
+#### :text
+Using the **:text** param allows us to add plain text to our email body.
+```ruby
+mail = SendGrid::Mail.new
+mail.text = 'WHATTUP KITTY CAT!?'
+```
+#### :html
+Using the **:html** param allows us to add html content to our email body.
+```ruby
+mail = SendGrid::Mail.new
+mail.html = '<html><body>Stuff in here, yo!</body></html>'
+```
+## Using SendGrid's X-SMTPAPI Header
+To utilize the X-SMTPAPI header, we have directly integrated the [smtpapi-ruby](https://github.com/SendGridJP/smtpapi-ruby) gem.
+#### add_to
+You can directly generate an x-smtpapi add_to header instead of using to *:to* param.  ***Please note, this will override all params.***
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.add_to('me@rbin.codes')
+mail.smtpapi.add_to('eddiez@otheremail.com')
+```
+#### set_tos
+```ruby
+mail.smtpapi.set_tos(['rbin@cat.codes', 'eddie@taco.bell'])
+```
+#### add_substitution
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.add_substitution('keep', array('secret'))        # sub = {keep: ['secret']}
+mail.smtpapi.add_substitution('other', array('one', 'two'))   # sub = {keep: ['secret'], other: ['one', 'two']}
+```
+#### set_substitutions
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.set_substitutions({'keep' => 'secret'})  # sub = {keep: ['secret']}
+```
+#### add_unique_arg
-Create your own and pass it in to the initialize method:
 ```ruby
-header = Smtpapi::Header.new
-# Do things to the header
-header.add_substitution('keep', ['secret'])
-mail = SendGrid::Mail.new(smtpapi: header)
+mail = SendGrid::Mail.new
+mail.smtpapi.add_unique_arg('cat', 'dogs')
 ```
-Or use the one that we create and expose:
+#### set_unique_args
 ```ruby
 mail = SendGrid::Mail.new
-mail.smtpapi.add_substitution('keep', ['secret'])
+mail.smtpapi.set_unique_args({'cow' => 'chicken'})
+mail.smtpapi.set_unique_args({'dad' => 'proud'})
+```
+#### add_category
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.add_category('tactics') # category = ['tactics']
+mail.smtpapi.add_category('advanced') # category = ['tactics', 'advanced']
+```
+#### set_categories
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.set_categories(['tactics', 'advanced']) # category = ['tactics', 'advanced']
+```
+#### add_section
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.add_section('-charge-', 'This ship is useless.'])
+mail.smtpapi.add_section('-bomber-', 'Only for sad vikings.'])
+```
+#### set_sections
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.set_sections({'-charge-' => 'This ship is useless.'})
+```
+#### add_filter
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.add_filter('footer', 'enable', 1)
+mail.smtpapi.add_filter('footer', 'text/html', '<strong>boo</strong>')
+```
+#### set_filters
+```ruby
+mail = SendGrid::Mail.new
+filter = {
+  'footer' => {
+    'setting' => {
+      'enable' => 1,
+      "text/plain" => 'You can haz footers!'
+    }
+  }
+}
+mail.smtpapi.set_filters(filter)
 ```
 ## Contributing

data/lib/sendgrid-ruby.rb CHANGED Viewed

@@ -6,15 +6,17 @@ require 'rest-client'
 module SendGrid
   class Client
-    attr_reader :api_user, :api_key, :host, :endpoint
+    attr_accessor :api_user, :api_key, :host, :endpoint
-    def initialize(params)
-      @api_user   = params.fetch(:api_user)
-      @api_key    = params.fetch(:api_key)
+    def initialize(params = {})
+      @api_user   = params.fetch(:api_user, nil)
+      @api_key    = params.fetch(:api_key, nil)
       @host       = params.fetch(:host, 'https://api.sendgrid.com')
       @endpoint   = params.fetch(:endpoint, '/api/mail.send.json')
       @conn       = params.fetch(:conn, create_conn)
       @user_agent = params.fetch(:user_agent, 'sendgrid/' + SendGrid::VERSION + ';ruby')
+      yield self if block_given?
+      raise SendGrid::Exception.new('api_user and api_key are required') unless @api_user && @api_key
     end
     def send(mail)

data/lib/sendgrid/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Robin Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-07 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smtpapi
@@ -140,7 +140,6 @@ files:
 - lib/sendgrid/mail.rb
 - lib/sendgrid/version.rb
 - sendgrid-ruby.gemspec
-- test.rb
 homepage: http://github.com/sendgrid/sendgrid-ruby
 licenses:
 - MIT
@@ -165,5 +164,4 @@ rubygems_version: 2.4.1
 signing_key:
 specification_version: 4
 summary: Official SendGrid Gem
-test_files:
-- test.rb
+test_files: []

data/test.rb DELETED Viewed

@@ -1,7 +0,0 @@
-require './lib/sendgrid-ruby.rb'
-client = SendGrid::Client.new ENV['SENDGRID_USERNAME'], ENV['SENDGRID_PASSWORD']
-email = SendGrid::Mail.new(from: 'root@mail.doesnotscale.com', subject: 'Test', text: 'Body of sexy')
-email.add_to 'eddiezane@sendgrid.com'
-email.add_to 'rbin@sendgrid.com'
-puts client.send(email)