sendgrid-ruby 4.3.0 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b10b6641b622b28d8cf45996bfdf23168228c0bc
-  data.tar.gz: 3dcc5c040fa1b80f0373f0971640e1f25b48cb70
+  metadata.gz: 7941bf2cff50124aed5687f12f593e1b16a44e68
+  data.tar.gz: dd7e3f37b1d6e3b69713faa243a700e18eaee3ac
 SHA512:
-  metadata.gz: de2d4c4e5a036af2b24eee9158b091562372c523d6deada337c97e561b8771afa8069245a7188148e010b38febcbc65512d850e3ee9010639351dabad7bf31df
-  data.tar.gz: 939366e0c87fada6692872757c26a5721747fb00923a2f889a8cfaa8aaf04656c83dc66ec6d16fa9109d5dfba90513a13c3bfec510bcab4bf3a336c8bd1a7430
+  metadata.gz: 0220a27ac2d35e063b6fcec73b1a4006c9b969da9943aba4901231cace2bfebba1ab6c04e9e4ff364d9461e3e6c9a1d2acf8c90f9532eea0d70d47f84bfa8702
+  data.tar.gz: 13f08e9fd6b642f13227289e9ecd82bd47aa882e2ce0f6002c07808f3d6a79f20b677fdfd5f0aad44c7ca1454e766e2e34f493b77a7c1b44437a37e5f8b4517e

data/.travis.yml

@@ -17,4 +17,8 @@ notifications:
     format: html
     notify: false
 script:
-    - rake
+    - rake test
+    - rake spec
+before_install:
+    - gem update bundler
+

data/CHANGELOG.md

@@ -1,38 +1,44 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [4.3.0] - 2016-4-17 ##
+## [4.3.1] - 2017-4-12 ##
+### Fixes
+- #160: Updated sinatra version to 2.0
+- Fixes bundler dependency issues with rails >5.0 and rack 2.0. Solves #159
+- Thanks to [gkats](https://github.com/gkats) for the pull request!
+
+## [4.3.0] - 2017-4-12 ##
 ### Added
 - #70: Adds an account settings management helper object
 - See the [helper README](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings) for details
 - Thanks to [Kyle Kern](https://github.com/kernkw) for the pull request!
 
-## [4.2.1] - 2016-4-10 ##
+## [4.2.1] - 2017-4-10 ##
 ### Fixed
 - #112: Fixes version ambiguity in gemspec
 - Thanks to [Chris McKnight](https://github.com/cmckni3) for the pull request!
 
-## [4.2.0] - 2016-4-10 ##
+## [4.2.0] - 2017-4-10 ##
 ### Added
 - #148: Set api_key to empty string 
 - This makes creating an API key for a SendGrid subuser who does not have an API key easier. See #146 for details
 - Thanks to [Adam Beck](https://github.com/Gwash3189) for the pull request!
 
-## [4.1.1] - 2016-4-6 ##
+## [4.1.1] - 2017-4-6 ##
 ### Fixed
 - #115 #134: Fix typos in initialize methods
 - Thanks to [Ben Jackson](https://github.com/benjackson84) for the pull request!
 
-## [4.1.0] - 2016-4-6 ##
+## [4.1.0] - 2017-4-6 ##
 ### Add
 - #144: Add [Inbound Email Parse Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/inbound_email.html) support
 - Thanks to [Wataru Sato](https://github.com/awwa) for the pull request!
 
-## [4.0.8] - 2016-2-17 ##
+## [4.0.8] - 2017-2-17 ##
 ### Add
 - Solves #147: Add User Agent string
 
-## [4.0.7] - 2016-1-25 ##
+## [4.0.7] - 2017-1-25 ##
 ### Fixes
 - [Pull Request #7](https://github.com/sendgrid/ruby-http-client/pull/7)
 - Fixes [issue #6](https://github.com/sendgrid/ruby-http-client/issues/6): TLS certificates not verified

data/Gemfile

@@ -1,3 +1,6 @@
 source 'http://rubygems.org'
 
 gemspec
+
+gem 'ruby_http_client'
+

data/README.md

@@ -17,7 +17,6 @@ We appreciate your continued support, thank you!
 * [Installation](#installation)
 * [Quick Start](#quick_start)
 * [Processing Inbound Email](#inbound)
-* [Account Setting Management](#account)
 * [Usage](#usage)
 * [Use Cases](#use_cases)
 * [Announcements](#announcements)
@@ -158,11 +157,6 @@ puts response.headers
 
 Please see [our helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/inbound) for utilizing our Inbound Parse webhook.
 
-<a name="account"></a>
-# Account Setting Management
-
-Please see [our helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings) for updating account settings.
-
 <a name="usage"></a>
 # Usage
 
@@ -171,6 +165,7 @@ Please see [our helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/li
 - [Example Code](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples)
 - [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
 - [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/mail) - build a request object payload for a v3 /mail/send API call.
+- [Settings Helper](https://github.com/sendgrid/sendgrid-ruby/tree/master/lib/sendgrid/helpers/settings)
 
 <a name="use_cases"></a>
 # Use Cases

data/Rakefile

@@ -1,4 +1,6 @@
 require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -6,5 +8,8 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+RSpec::Core::RakeTask.new(:spec)
+
 desc "Run tests"
-task :default => :test
+task default: [:spec, :test]
+

data/examples/helpers/settings/example.rb

@@ -0,0 +1,23 @@
+require 'sendgrid-ruby'
+include SendGrid
+
+sg_client = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']).client
+settings = SendGrid::Settings.new(sendgrid_client: sg_client)
+
+# Fetch settings
+response = settings.bcc
+puts response.status_code
+puts response.body
+puts response.headers
+
+# Turn on bcc settings
+response = settings.update_bcc(enabled: true, email: "email@example.com")
+puts response.status_code
+puts response.body
+puts response.headers
+
+# Turn off bcc settings
+response = settings.update_bcc(enabled: false)
+puts response.status_code
+puts response.body
+puts response.headers

data/lib/sendgrid-ruby.rb

@@ -1,3 +1,4 @@
 require_relative 'sendgrid/client'
 require_relative 'sendgrid/version'
-require_relative 'sendgrid/helpers/mail/mail'
+require_relative 'sendgrid/helpers/mail/mail'
+require_relative 'sendgrid/helpers/settings/settings'

data/lib/sendgrid/helpers/settings/README.md

@@ -0,0 +1,14 @@
+**This module allows you to quickly and easily build a Settings object for retreiving or updating you SendGrid Settings.**
+
+# Quick Start
+
+Run the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/helpers/settings) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
+
+```bash
+ruby examples/helpers/settings/example.rb
+```
+
+## Usage
+
+- See the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/helpers/settings) for a complete working example.
+- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Settings/index.html)

data/lib/sendgrid/helpers/settings/mail_settings_dto.rb

@@ -0,0 +1,13 @@
+module SendGrid
+  class MailSettingsDto
+    attr_reader :bcc, :address_whitelist, :bounce_purge, :footer, :forward_spam, :forward_bounce, :plain_content, :spam_check, :template
+
+    def self.fetch(sendgrid_client:, name:, query_params:)
+      sendgrid_client.mail_settings.public_send(name).get(query_params: query_params)
+    end
+
+    def self.update(sendgrid_client:, name:, request_body:)
+      sendgrid_client.mail_settings.public_send(name).patch(request_body: request_body)
+    end
+  end
+end

data/lib/sendgrid/helpers/settings/partner_settings_dto.rb

@@ -0,0 +1,13 @@
+module SendGrid
+  class PartnerSettingsDto
+    attr_reader :new_relic
+
+    def self.fetch(sendgrid_client:, name:, query_params:)
+      sendgrid_client.partner_settings.public_send(name).get(query_params: query_params)
+    end
+
+    def self.update(sendgrid_client:, name:, request_body:)
+      sendgrid_client.partner_settings.public_send(name).patch(request_body: request_body)
+    end
+  end
+end

data/lib/sendgrid/helpers/settings/settings.rb

@@ -0,0 +1,28 @@
+require_relative 'mail_settings_dto'
+require_relative 'partner_settings_dto'
+require_relative 'tracking_settings_dto'
+require_relative 'user_settings_dto'
+
+module SendGrid
+  class Settings
+    attr_accessor :sendgrid_client
+
+    SETTING_TYPES = [SendGrid::MailSettingsDto, SendGrid::TrackingSettingsDto,
+                     SendGrid::PartnerSettingsDto, SendGrid::UserSettingsDto]
+
+    def initialize(sendgrid_client:)
+      @sendgrid_client = sendgrid_client
+    end
+
+    SETTING_TYPES.each do |setting_type|
+      setting_type.instance_methods(false).each do |name|
+        define_method(name) do |**args|
+          setting_type.fetch(sendgrid_client: sendgrid_client, name: name, query_params: args)
+        end
+        define_method("update_#{name}") do |**args|
+          setting_type.update(sendgrid_client: sendgrid_client, name: name, request_body: args)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/helpers/settings/tracking_settings_dto.rb

@@ -0,0 +1,24 @@
+module SendGrid
+  class TrackingSettingsDto
+    attr_reader :open, :click, :google_analytics, :subscription
+    alias :click_tracking :click
+    alias :open_tracking :open
+    alias :subscription_tracking :subscription
+
+    def self.fetch(sendgrid_client:, name:, query_params:)
+      name = scrub_alias_names(name.to_s)
+      sendgrid_client.tracking_settings.public_send(name).get(query_params: query_params)
+    end
+
+    def self.update(sendgrid_client:, name:, request_body:)
+      name = scrub_alias_names(name.to_s)
+      sendgrid_client.tracking_settings.public_send(name).patch(request_body: request_body)
+    end
+
+    private
+
+    def self.scrub_alias_names(name)
+      name.gsub(/_tracking/, '')
+    end
+  end
+end

data/lib/sendgrid/helpers/settings/user_settings_dto.rb

@@ -0,0 +1,13 @@
+module SendGrid
+  class UserSettingsDto
+    attr_reader :enforced_tls
+
+    def self.fetch(sendgrid_client:, name:, query_params:)
+      sendgrid_client.user.settings.public_send(name).get(query_params: query_params)
+    end
+
+    def self.update(sendgrid_client:, name:, request_body:)
+      sendgrid_client.user.settings.public_send(name).patch(request_body: request_body)
+    end
+  end
+end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '4.3.0'
-end
+  VERSION = '4.3.1'
+end

data/sendgrid-ruby.gemspec

@@ -17,7 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
   spec.add_dependency 'ruby_http_client', '~> 3.0'
-  spec.add_dependency 'sinatra', '~> 1.4.7'
+  spec.add_dependency 'sinatra', '2.0.0.rc2'
   spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'faker'
   spec.add_development_dependency 'minitest', '~> 5.9'
 end

data/spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe SendGrid::MailSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:mail_settings) { SendGrid::MailSettingsDto }
+  let(:setting_name) { 'bcc' }
+  let(:setting_params) { {email: Faker::Internet.email, enabled: rand(1..100).even?} }
+
+  it { should respond_to :bcc }
+  it { should respond_to :address_whitelist }
+  it { should respond_to :bounce_purge }
+  it { should respond_to :footer }
+  it { should respond_to :forward_spam }
+  it { should respond_to :forward_bounce }
+  it { should respond_to :plain_content }
+  it { should respond_to :spam_check }
+  it { should respond_to :template }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(mail_settings.fetch(args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(mail_settings.update(args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SendGrid::PartnerSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:partner_settings) { SendGrid::PartnerSettingsDto }
+  let(:setting_name) { 'new_relic' }
+  let(:setting_params) { {license_key: 'key', enabled: rand(1..100).even?} }
+
+  it { should respond_to :new_relic }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(partner_settings.fetch(args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(partner_settings.update(args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/settings_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe SendGrid::Settings do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:settings) { SendGrid::Settings.new(sendgrid_client: sendgrid_client) }
+
+  describe '.new' do
+    it 'initializes correctly' do
+      expect(settings).to be_a SendGrid::Settings
+    end
+  end
+
+  describe '.bcc' do
+    it 'fetches bcc data' do
+      expect(settings.bcc).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update_bcc' do
+    it 'updates bcc' do
+      bcc_response = settings.update_bcc(enabled: true, email: "email@example.com")
+      expect(bcc_response).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SendGrid::TrackingSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:tracking_settings) { SendGrid::TrackingSettingsDto }
+  let(:setting_name) { 'open_tracking' }
+  let(:setting_params) { {enabled: rand(1..100).even?} }
+
+  it { should respond_to :open_tracking }
+  it { should respond_to :click_tracking }
+  it { should respond_to :google_analytics }
+  it { should respond_to :subscription_tracking }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(tracking_settings.fetch(args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(tracking_settings.update(args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/sendgrid/helpers/settings/user_settings_dto_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SendGrid::UserSettingsDto do
+  let(:sendgrid_client) { SendGrid::API.new(api_key: 'fake_key').client }
+  let(:user_settings) { SendGrid::UserSettingsDto }
+  let(:setting_name) { 'enforced_tls' }
+  let(:setting_params) { {require_tls: rand(1..100).even?} }
+
+  it { should respond_to :enforced_tls }
+
+  describe '.fetch' do
+    it 'calls get on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, query_params: {} }
+      expect(user_settings.fetch(args)).to be_a SendGrid::Response
+    end
+  end
+
+  describe '.update' do
+    it 'calls patch on sendgrid_client' do
+      args = { sendgrid_client: sendgrid_client, name: setting_name, request_body: setting_params }
+      expect(user_settings.update(args)).to be_a SendGrid::Response
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'faker'
+
+RSpec.configure do |config|
+  Dir["#{File.dirname(__FILE__)}/../lib/sendgrid-ruby.rb"].sort.each { |ext| require ext }
+
+  config.color = true
+end

data/test/sendgrid/test_sendgrid-ruby.rb

@@ -55,7 +55,7 @@ class TestAPI < MiniTest::Test
             ')
         assert_equal(test_headers, sg.request_headers)
         assert_equal("v3", sg.version)
-        assert_equal("4.3.0", SendGrid::VERSION)
+        assert_equal("4.3.1", SendGrid::VERSION)
         assert_instance_of(SendGrid::Client, sg.client)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendgrid-ruby
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.3.1
 platform: ruby
 authors:
 - Elmer Thomas
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_http_client
@@ -30,16 +30,16 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 2.0.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 2.0.0.rc2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,48 @@ dependencies:
     - - "~>"
       - !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: pry
+  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: faker
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +141,7 @@ files:
 - examples/devices/devices.rb
 - examples/geo/geo.rb
 - examples/helpers/mail/example.rb
+- examples/helpers/settings/example.rb
 - examples/ips/ips.rb
 - examples/mail/mail.rb
 - examples/mailboxproviders/mailboxproviders.rb
@@ -125,8 +168,20 @@ files:
 - lib/sendgrid/helpers/inbound/send.rb
 - lib/sendgrid/helpers/mail/README.md
 - lib/sendgrid/helpers/mail/mail.rb
+- lib/sendgrid/helpers/settings/README.md
+- lib/sendgrid/helpers/settings/mail_settings_dto.rb
+- lib/sendgrid/helpers/settings/partner_settings_dto.rb
+- lib/sendgrid/helpers/settings/settings.rb
+- lib/sendgrid/helpers/settings/tracking_settings_dto.rb
+- lib/sendgrid/helpers/settings/user_settings_dto.rb
 - lib/sendgrid/version.rb
 - sendgrid-ruby.gemspec
+- spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb
+- spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb
+- spec/sendgrid/helpers/settings/settings_spec.rb
+- spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb
+- spec/sendgrid/helpers/settings/user_settings_dto_spec.rb
+- spec/spec_helper.rb
 - test/prism.sh
 - test/sendgrid/helpers/mail/test_mail.rb
 - test/sendgrid/test_sendgrid-ruby.rb
@@ -155,6 +210,12 @@ signing_key:
 specification_version: 4
 summary: Official SendGrid Gem
 test_files:
+- spec/sendgrid/helpers/settings/mail_settings_dto_spec.rb
+- spec/sendgrid/helpers/settings/partner_settings_dto_spec.rb
+- spec/sendgrid/helpers/settings/settings_spec.rb
+- spec/sendgrid/helpers/settings/tracking_settings_dto_spec.rb
+- spec/sendgrid/helpers/settings/user_settings_dto_spec.rb
+- spec/spec_helper.rb
 - test/prism.sh
 - test/sendgrid/helpers/mail/test_mail.rb
 - test/sendgrid/test_sendgrid-ruby.rb