Adds settings module to help users manage settings

Author: kernkw

Gemfile

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

README.md

@@ -81,6 +81,27 @@ puts response.status_code
 puts response.body
 puts response.headers
 ```
+## Manage Account Settings
+
+```ruby
+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
+
+# Update bcc settings
+response = settings.update_bcc(enabled: true, email: "email@example.com")
+puts response.status_code
+puts response.body
+puts response.headers
+```
 
 ## General v3 Web API Usage
 

examples/settings/settings.rb

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

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/settings/settings'

lib/sendgrid/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/settings/settings) (make sure you have set your environment variable to include your SENDGRID_API_KEY).
+
+```bash
+ruby examples/settings/settings.rb
+```
+
+## Usage
+
+- See the [example](https://github.com/sendgrid/sendgrid-ruby/tree/master/examples/settings/settings) for a complete working example.
+- [Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/Settings/index.html)

lib/sendgrid/settings/mail_settings.rb

@@ -0,0 +1,13 @@
+module SendGrid
+  class MailSettings
+    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

lib/sendgrid/settings/partner_settings.rb

@@ -0,0 +1,13 @@
+module SendGrid
+  class PartnerSettings
+    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

lib/sendgrid/settings/settings.rb

@@ -0,0 +1,28 @@
+require_relative 'mail_settings'
+require_relative 'partner_settings'
+require_relative 'tracking_settings'
+require_relative 'user_settings'
+
+module SendGrid
+  class Settings
+    attr_accessor :sendgrid_client
+
+    SETTING_TYPES = [SendGrid::MailSettings, SendGrid::TrackingSettings,
+                     SendGrid::PartnerSettings, SendGrid::UserSettings]
+
+    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

lib/sendgrid/settings/tracking_settings.rb

@@ -0,0 +1,24 @@
+module SendGrid
+  class TrackingSettings
+    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

lib/sendgrid/settings/user_settings.rb

@@ -0,0 +1,13 @@
+module SendGrid
+  class UserSettings
+    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