RubyGems - sendgrid-ruby - Versions diffs - 1.0.0.alpha.1 → 1.0.2 - Mend

sendgrid-ruby 1.0.0.alpha.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml +4 -4
data/.env_sample +3 -0
data/.gitignore +2 -0
data/.travis.yml +2 -2
data/Gemfile +3 -0
data/README.md +28 -96
data/example.rb +32 -0
data/lib/{sendgrid_ruby.rb → sendgrid-ruby.rb} +0 -0
data/lib/sendgrid/client.rb +4 -5
data/lib/sendgrid/mail.rb +10 -4
data/lib/sendgrid/version.rb +1 -1
data/sendgrid-ruby.gemspec +1 -0
data/spec/lib/sendgrid/client_spec.rb +1 -1
data/spec/lib/sendgrid_spec.rb +1 -1
data/spec/spec_helper.rb +1 -1
metadata +21 -5

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151bbef80094a16705ac90105265586a3b297f72
-  data.tar.gz: 978bc5da9b1f788440e1e7e55cb821a0864571da
+  metadata.gz: fe36a0b285a30dfac2804d6f3ac46d3ee0562a67
+  data.tar.gz: 1dab6a58bc0f677a75cce07a459afa925561db3f
 SHA512:
-  metadata.gz: 6445b8feda2318bb755c4a0a448f3456610d2de94982ae223acee641e1c5a1ea4ac6177e94fd89fd46323434f71512221528f904a967738f5aed176c0634e6c7
-  data.tar.gz: 379ae309fb47ad14331bc2747b226f016a865c8671d45567ab725eef5f2fdb8db4daf305ffba6143d3070b99302472863017484f860282b052b5d32116b18f6d
+  metadata.gz: 4a21dacb775797d79fc03f3b21eef8dff075cce772e14f7a7de4c29c79deb1274ce0dc471e435bc5543d7cb2d7aa700be8528cfbc459011cc0607867ed9b45be
+  data.tar.gz: bc714d2321f8d349b6388025f0f669113f5437ebd06a336b294bbc36096e3c9d6933b5e795f30c811216979961e7da2e8d4f7ac3a5002dd6574c9367b3de95ab

data/.env_sample ADDED Viewed

@@ -0,0 +1,3 @@
+SENDGRID_USERNAME=your_sendgrid_username
+SENDGRID_PASSWORD=your_sendgrid_password
+SENDGRID_APIKEY=your_sendgrid_apikey

data/.gitignore CHANGED Viewed

@@ -11,6 +11,8 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+.env
+test.rb
 ## Specific to RubyMotion:
 .dat*

data/.travis.yml CHANGED Viewed

@@ -12,9 +12,9 @@ notifications:
       Build %{build_number}</a> on branch <i>%{branch}</i> by %{author}: <strong>%{message}</strong>
       <a href="https://github.com/sendgrid/docs/commits/%{commit}">View on GitHub</a>'
     format: html
-    notify: true
+    notify: false
 before_script:
     - bundle install
 script:
-    - rubocop --fail-level=W
+    - rubocop --fail-level=E
     - rake

data/Gemfile CHANGED Viewed

@@ -1,2 +1,5 @@
+gem 'dotenv-rails'
+gem 'smtpapi'
+gem 'rest-client'
 source 'https://rubygems.org'
 gemspec

data/README.md CHANGED Viewed

@@ -17,7 +17,7 @@ And then execute:
     $ bundle
-Or install it yourself as:
+Or install it yourself using:
     $ gem install sendgrid-ruby
@@ -36,6 +36,11 @@ client = SendGrid::Client.new do |c|
   c.api_user = 'SENDGRID_USERNAME'
   c.api_key = 'SENDGRID_PASSWORD'
 end
+# or as a block with the API key only #
+client = SendGrid::Client.new do |c|
+  c.api_key = 'SENDGRID_APIKEY'
+end
 ```
 Create a new Mail object and send:
@@ -51,7 +56,7 @@ puts client.send(mail)
 # {"message":"success"}
 ```
-You can also create a mail object with a hash:
+You can also create a Mail object with a hash:
 ```ruby
 client.send(SendGrid::Mail.new(to: 'example@example.com', from: 'taco@cat.limo', subject: 'Hello world!', text: 'Hi there!', html: '<b>Hi there!</b>'))
@@ -60,7 +65,7 @@ client.send(SendGrid::Mail.new(to: 'example@example.com', from: 'taco@cat.limo',
 #### Attachments
-Attachments can be added to a mail object with the `add_attachment` method. The first parameter is the path to the file, the second (optional) parameter is the desired name of the file. If a file name is not provided, it will use the original filename.
+Attachments can be added to a Mail object with the `add_attachment` method. The first parameter is the path to the file, the second (optional) parameter is the desired name of the file. If a file name is not provided, it will use the original filename.
 ```ruby
 mail.add_attachment('/tmp/report.pdf', 'july_report.pdf')
 ```
@@ -165,108 +170,35 @@ 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
+<blockquote>
+To utilize the X-SMTPAPI header, we have directly integrated the <a href="https://github.com/SendGridJP/smtpapi-ruby">SendGridJP/smtpapi-ruby</a> gem.
+For more information, view our <a href=https://sendgrid.com/docs/API_Reference/SMTP_API/index.html>SMTPAPI docs page</a>.
+</blockquote>
 ```ruby
-mail = SendGrid::Mail.new
-mail.smtpapi.set_substitutions({'keep' => 'secret'})  # sub = {keep: ['secret']}
-```
-#### add_unique_arg
+header = Smtpapi::Header.new
+header.add_to(['john.doe@example.com', 'jane.doe@example.com'])
+header.add_substitution('keep', ['secret'])        # sub = {keep: ['secret']}
+header.add_substitution('other', ['one', 'two'])   # sub = {keep: ['secret'], other: ['one', 'two']}
+header.add_unique_arg("unique_code", "8675309")
+header.add_category("Newsletter")
+header.add_filter('templates', 'enable', 1)	   # necessary for each time the template engine is used
+header.add_filter('templates', 'template_id', '1234-5678-9100-abcd')
+header.set_ip_pool("marketing_ip_pool")
+mail.smtpapi = header
-```ruby
-mail = SendGrid::Mail.new
-mail.smtpapi.add_unique_arg('cat', 'dogs')
 ```
+## Testing ##
-#### set_unique_args
+`bundle exec rake test`
-```ruby
-mail = SendGrid::Mail.new
-mail.smtpapi.set_unique_args({'cow' => 'chicken'})
-mail.smtpapi.set_unique_args({'dad' => 'proud'})
-```
+## Deploying ##
-#### 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)
-```
+`rake release`
-## Contributing
+## Contributing ##
 1. Fork it ( https://github.com/[my-github-username]/sendgrid-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -274,4 +206,4 @@ mail.smtpapi.set_filters(filter)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
-***Hit up [@rbin](http://twitter.com/rbin) or [@eddiezane](http://twitter.com/eddiezane) on Twitter with any issues.***
+***Hit up [@rbin](http://twitter.com/rbin) or [@sendgrid](http://twitter.com/sendgrid) on Twitter with any issues.***

data/example.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# test using: ruby example.rb
+# using ruby 2.2.2p95 (2015-04-13 revision 50295) [x86_64-darwin14]
+# attachment is sent but only a corrupted 1k file
+require_relative "lib/sendgrid-ruby.rb"
+require 'dotenv'
+Dotenv.load
+# sendgrid_username = ENV['SENDGRID_USERNAME']
+# sendgrid_password = ENV['SENDGRID_PASSWORD']
+sendgrid_apikey = ENV['SENDGRID_APIKEY']
+# client = SendGrid::Client.new(api_user: sendgrid_username, api_key: sendgrid_password)
+client = SendGrid::Client.new do |c|
+  # c.api_user = sendgrid_username
+  c.api_key = sendgrid_apikey
+end
+mail = SendGrid::Mail.new do |m|
+  m.to = 'elmer.thomas@sendgrid.com'
+  m.from = 'elmer@thinkingserious.com'
+  m.subject = 'Hello world!'
+  m.text = 'I heard you like pineapple.'
+end
+mail.add_attachment('/tmp/report.pdf', 'july_report.pdf')
+result = client.send(mail)
+puts result.code
+puts result.body
+# puts client.send(SendGrid::Mail.new(to: 'elmer.thomas@sendgrid.com', from: 'elmer@thinkingserious.com', subject: 'Hello world!', text: 'Hi there, testing from Ruby!', html: '<b>Hi there, testing from Ruby!</b>'))

data/lib/{sendgrid_ruby.rb → sendgrid-ruby.rb} RENAMED Viewed

File without changes

data/lib/sendgrid/client.rb CHANGED Viewed

@@ -24,9 +24,8 @@ module SendGrid
     def send(mail)
       res = conn.post do |req|
         payload = mail.to_h
         req.url(endpoint)
         # Check if using username + password or API key
         if api_user
           # Username + password
@@ -35,12 +34,12 @@ module SendGrid
           # API key
           req.headers['Authorization'] = "Bearer #{api_key}"
         end
         req.body = payload
       end
       fail SendGrid::Exception, res.body if raise_exceptions? && res.status != 200
       SendGrid::Response.new(code: res.status, headers: res.headers, body: res.body)
     end

data/lib/sendgrid/mail.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require 'json'
 require 'smtpapi'
+require 'mimemagic'
 module SendGrid
   class Mail
@@ -89,7 +90,8 @@ module SendGrid
     end
     def add_attachment(path, name = nil)
-      file   = File.new(path)
+      mime_type = MimeMagic.by_path(path)
+      file = Faraday::UploadIO.new(path, mime_type)
       name ||= File.basename(file)
       attachments << {file: file, name: name}
     end
@@ -121,18 +123,22 @@ module SendGrid
         :text => text,
         :html => html,
         :'x-smtpapi' => smtpapi.to_json,
-        :files => ({} unless attachments.empty?)
+        :files => ({":default"=>"0"} unless attachments.empty?)
+        # If I don't define a default value, I get a Nil error when
+        # in attachments.each do |file|
+        #:files => ({} unless attachments.empty?)
       }.reject {|_, v| v.nil? || v.empty?}
       payload.delete(:'x-smtpapi') if payload[:'x-smtpapi'] == '{}'
-      payload[:to] = payload[:from] unless payload[:to].nil? && smtpapi.to.empty?
+      payload[:to] = payload[:from] unless (not payload[:to].nil?) && smtpapi.to.empty?
       return payload if attachments.empty?
       attachments.each do |file|
         payload[:files][file[:name]] = file[:file]
       end
+      payload[:files].delete(":default")
       payload
     end
     # rubocop:enable Style/HashSyntax

data/lib/sendgrid/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '1.0.0.alpha.1'.freeze
+  VERSION = '1.0.2'
 end

data/sendgrid-ruby.gemspec CHANGED Viewed

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'smtpapi', '~> 0.1'
   spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'mimemagic'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-nc'

data/spec/lib/sendgrid/client_spec.rb CHANGED Viewed

@@ -57,7 +57,7 @@ describe 'SendGrid::Client' do
       client.send(mail)
       expect(WebMock).to have_requested(:post, 'https://api.sendgrid.com/api/mail.send.json')
-        .with(body: 'api_key=abc123&api_user=foobar')
+        .with(body: 'api_key=abc123&api_user=foobar&to=')
     end
     it 'should raise a SendGrid::Exception if status is not 200' do

data/spec/lib/sendgrid_spec.rb CHANGED Viewed

@@ -2,6 +2,6 @@ require 'spec_helper'
 describe 'SendGrid' do
   it 'should have a version' do
-    expect(SendGrid::VERSION).to eq('1.0.0.alpha.1')
+    expect(SendGrid::VERSION).to eq('1.0.2')
   end
 end

data/spec/spec_helper.rb CHANGED Viewed

	@@ -1 +1 @@
1	- require_relative '../lib/~~sendgrid_ruby~~'
1	+ require_relative '../lib/sendgrid-ruby'

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Robin Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: smtpapi
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +199,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env_sample"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -194,12 +209,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- example.rb
+- lib/sendgrid-ruby.rb
 - lib/sendgrid/client.rb
 - lib/sendgrid/exceptions.rb
 - lib/sendgrid/mail.rb
 - lib/sendgrid/response.rb
 - lib/sendgrid/version.rb
-- lib/sendgrid_ruby.rb
 - sendgrid-ruby.gemspec
 - spec/lib/sendgrid/client_spec.rb
 - spec/lib/sendgrid/mail_spec.rb
@@ -220,9 +236,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project:
 rubygems_version: 2.4.5