sendgrid-ruby 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dedc1735da8ee2a09e97d3555e92b63fd631526
+  data.tar.gz: 29028865ccff1abe7dec82a570942229b7489c9a
+SHA512:
+  metadata.gz: 7ea857ca795888f80c853713d7a5ceb145d11d387f0a03e389b9e762ca089b576c68c7c5ed48e79d9c154d60296108e88df746dc2db81e778ea328c2228fe754
+  data.tar.gz: 77f7f2b3f6db200b02b3faff9e3434f7a219de75f326ec03838436589008be37c13f8e8f646c2217cf1343f9fa3f93437dbc647421084b48bcccc87db4f8c66f

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,12 @@
+notification :gntp
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SendGrid Inc.
+
+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,97 @@
+# SendGrid::Ruby
+
+This Gem allows you to quickly and easily send emails through SendGrid's Web API using native Ruby.
+
+You can read our official documentation on the Web API's Mail feature [here](https://sendgrid.com/docs/API_Reference/Web_API/mail.html).
+
+
+## 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
+
+## Usage
+
+Create a new client with your SendGrid Username and Password.
+
+```ruby
+require 'sendgrid-ruby'
+
+client = SendGrid::Client.new(api_user: 'SENDGRID_USERNAME', api_key: 'SENDGRID_PASSWORD')
+```
+
+Create a new Mail object and send:
+```ruby
+mail = SendGrid::Mail.new do |m|
+  m.to = 'test@sendgrid.com'
+  m.from = 'taco@cat.limo'
+  m.subject = 'Hello world!'
+  m.text = 'I heard you like pineapple.'
+end
+
+puts client.send(mail) 
+# {"message":"success"}
+```
+
+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>'))
+	
+	# {"message":"success"}
+```
+
+#### Available Params
+
+```ruby
+params = {
+	:to,
+	:to_name,
+	:from,
+	:from_name,
+	:subject,
+	:text,
+	:html,
+	:cc,
+	:bcc,
+	:reply_to,
+	:date,
+	:smtpapi,
+	:attachments
+}
+```
+
+#### 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:
+
+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)
+```
+Or use the one that we create and expose:
+```ruby
+mail = SendGrid::Mail.new
+mail.smtpapi.add_substitution('keep', ['secret'])
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sendgrid-ruby/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 a new Pull Request
+
+***Hit up [@rbin](http://twitter.com/rbin) or [@eddiezane](http://twitter.com/eddiezane) on Twitter with any issues.***

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task default: :spec

data/lib/sendgrid-ruby.rb

@@ -0,0 +1,41 @@
+require_relative 'sendgrid/exceptions'
+require_relative 'sendgrid/mail'
+require_relative 'sendgrid/version'
+
+require 'rest-client'
+
+module SendGrid
+  class Client
+    attr_reader :api_user, :api_key, :host, :endpoint
+
+    def initialize(params)
+      @api_user   = params.fetch(:api_user)
+      @api_key    = params.fetch(:api_key)
+      @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')
+    end
+
+    def send(mail)
+      payload = mail.to_h.merge({api_user: @api_user, api_key: @api_key})
+      @conn[@endpoint].post(payload, {user_agent: @user_agent}) do |response, request, result|
+        case response.code.to_s
+        when /2\d\d/
+          response
+        when /4\d\d|5\d\d/
+          raise SendGrid::Exception.new(response)
+        else
+          # TODO: What will reach this?
+          "DEFAULT #{response.code} #{response}"
+        end
+      end
+    end
+
+    private
+
+    def create_conn
+      @conn = RestClient::Resource.new(@host)
+    end
+  end
+end

data/lib/sendgrid/exceptions.rb

@@ -0,0 +1,7 @@
+module SendGrid
+  class Exception < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+end

data/lib/sendgrid/mail.rb

@@ -0,0 +1,60 @@
+require 'json'
+require 'smtpapi'
+
+module SendGrid
+  class Mail
+    attr_accessor :to, :to_name, :from, :from_name, :subject, :text, :html, :cc, 
+      :bcc, :reply_to, :date, :smtpapi, :attachments
+
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+      @headers     ||= {}
+      @attachments ||= []
+      @smtpapi     ||= Smtpapi::Header.new
+      yield self if block_given?
+    end
+
+    def add_to(to_email)
+      @smtpapi.add_to to_email
+    end
+
+    def add_attachment(path, name = nil)
+      file   = File.new(path)
+      name ||= File.basename(file)
+      @attachments << {file: file, name: name}
+    end
+
+    def to_h
+      payload = {
+        :from        => @from,
+        :fromname    => @from_name,
+        :subject     => @subject,
+        :to          => @to,
+        :toname      => @to_name,
+        :date        => @date,
+        :replyto     => @reply_to,
+        :cc          => @cc,
+        :bcc         => @bcc,
+        :text        => @text,
+        :html        => @html,
+        :'x-smtpapi' => @smtpapi.to_json,
+        :files       => ({} unless @attachments.empty?)
+      }.reject {|k,v| v.nil?}
+
+      # smtpapi fixer
+      if @to.nil? and not @smtpapi.to.empty?
+        payload[:to] = payload[:from]
+      end
+
+      unless @attachments.empty?
+        @attachments.each do |file|
+          payload[:files][file[:name]] = file[:file]
+        end
+      end
+
+      payload
+    end
+  end
+end

data/lib/sendgrid/version.rb

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

data/sendgrid-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sendgrid/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'sendgrid-ruby'
+  spec.version     = SendGrid::VERSION
+  spec.authors     = ['Robin Johnson', 'Eddie Zaneski']
+  spec.email       = 'community@sendgrid.com'
+  spec.summary     = 'Official SendGrid Gem'
+  spec.description = 'Interact with SendGrids API in Native Ruby'
+  spec.homepage    = 'http://github.com/sendgrid/sendgrid-ruby'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'smtpapi'
+  spec.add_dependency 'rest-client'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+end

data/test.rb

@@ -0,0 +1,7 @@
+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)

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: sendgrid-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Robin Johnson
+- Eddie Zaneski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: smtpapi
+  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: rest-client
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Interact with SendGrids API in Native Ruby
+email: community@sendgrid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sendgrid-ruby.rb
+- lib/sendgrid/exceptions.rb
+- lib/sendgrid/mail.rb
+- lib/sendgrid/version.rb
+- sendgrid-ruby.gemspec
+- test.rb
+homepage: http://github.com/sendgrid/sendgrid-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Official SendGrid Gem
+test_files:
+- test.rb