sendgrid-ruby 1.1.6 → 6.6.2

data/lib/sendgrid/helpers/permissions/scopes.yml

@@ -0,0 +1,309 @@
+---
+:alerts:
+  :create:
+  - alerts.create
+  :delete:
+  - alerts.delete
+  :read:
+  - alerts.read
+  :update:
+  - alerts.update
+:api_keys:
+  :create:
+  - api_keys.create
+  :delete:
+  - api_keys.delete
+  :read:
+  - api_keys.read
+  :update:
+  - api_keys.update
+:asm_groups:
+  :create:
+  - asm.groups.create
+  :delete:
+  - asm.groups.delete
+  :read:
+  - asm.groups.read
+  :update:
+  - asm.groups.update
+:billing:
+  :create:
+  - billing.create
+  :delete:
+  - billing.delete
+  :read:
+  - billing.read
+  :update:
+  - billing.update
+:categories:
+  :create:
+  - categories.create
+  :delete:
+  - categories.delete
+  :read:
+  - categories.read
+  - categories.stats.read
+  - categories.stats.sums.read
+  :update:
+  - categories.update
+:credentials:
+  :create:
+  - credentials.create
+  :delete:
+  - credentials.delete
+  :read:
+  - credentials.read
+  :update:
+  - credentials.update
+:stats:
+  :create: []
+  :delete: []
+  :read:
+  - email_activity.read
+  - stats.read
+  - stats.global.read
+  - browsers.stats.read
+  - devices.stats.read
+  - geo.stats.read
+  - mailbox_providers.stats.read
+  - clients.desktop.stats.read
+  - clients.phone.stats.read
+  - clients.stats.read
+  - clients.tablet.stats.read
+  - clients.webmail.stats.read
+  :update: []
+:ips:
+  :create:
+  - ips.pools.create
+  - ips.pools.ips.create
+  - ips.warmup.create
+  :delete:
+  - ips.pools.delete
+  - ips.pools.ips.delete
+  - ips.warmup.delete
+  :read:
+  - ips.assigned.read
+  - ips.read
+  - ips.pools.read
+  - ips.pools.ips.read
+  - ips.warmup.read
+  :update:
+  - ips.pools.update
+  - ips.pools.ips.update
+  - ips.warmup.update
+:mail_settings:
+  :create: []
+  :delete: []
+  :read:
+  - mail_settings.address_whitelist.read
+  - mail_settings.bcc.read
+  - mail_settings.bounce_purge.read
+  - mail_settings.footer.read
+  - mail_settings.forward_bounce.read
+  - mail_settings.forward_spam.read
+  - mail_settings.plain_content.read
+  - mail_settings.read
+  - mail_settings.spam_check.read
+  - mail_settings.template.read
+  :update:
+  - mail_settings.address_whitelist.update
+  - mail_settings.bcc.update
+  - mail_settings.bounce_purge.update
+  - mail_settings.footer.update
+  - mail_settings.forward_bounce.update
+  - mail_settings.forward_spam.update
+  - mail_settings.plain_content.update
+  - mail_settings.spam_check.update
+  - mail_settings.template.update
+:mail:
+  :create:
+  - mail.send
+  - mail.batch.create
+  :delete:
+  - mail.batch.delete
+  :read:
+  - mail.batch.read
+  :update:
+  - mail.batch.update
+:marketing_campaigns:
+  :create:
+  - marketing_campaigns.create
+  :delete:
+  - marketing_campaigns.delete
+  :read:
+  - marketing_campaigns.read
+  :update:
+  - marketing_campaigns.update
+:partner_settings:
+  :create: []
+  :delete: []
+  :read:
+  - partner_settings.new_relic.read
+  - partner_settings.read
+  - partner_settings.sendwithus.read
+  :update:
+  - partner_settings.new_relic.update
+  - partner_settings.sendwithus.update
+:scheduled_sends:
+  :create:
+  - user.scheduled_sends.create
+  :delete:
+  - user.scheduled_sends.delete
+  :read:
+  - user.scheduled_sends.read
+  :update:
+  - user.scheduled_sends.update
+:subusers:
+  :create:
+  - subusers.create
+  - subusers.credits.create
+  - subusers.credits.remaining.create
+  - subusers.monitor.create
+  :delete:
+  - subusers.delete
+  - subusers.credits.delete
+  - subusers.credits.remaining.delete
+  - subusers.monitor.delete
+  :read:
+  - subusers.read
+  - subusers.credits.read
+  - subusers.stats.read
+  - subusers.credits.remaining.read
+  - subusers.monitor.read
+  - subusers.reputations.read
+  - subusers.stats.monthly.read
+  - subusers.stats.sums.read
+  - subusers.summary.read
+  :update:
+  - subusers.update
+  - subusers.credits.update
+  - subusers.credits.remaining.update
+  - subusers.monitor.update
+:suppression:
+  :create:
+  - suppression.create
+  - suppression.bounces.create
+  - suppression.blocks.create
+  - suppression.invalid_emails.create
+  - suppression.spam_reports.create
+  - suppression.unsubscribes.create
+  :delete:
+  - suppression.delete
+  - suppression.bounces.delete
+  - suppression.blocks.delete
+  - suppression.invalid_emails.delete
+  - suppression.spam_reports.delete
+  - suppression.unsubscribes.delete
+  :read:
+  - suppression.read
+  - suppression.bounces.read
+  - suppression.blocks.read
+  - suppression.invalid_emails.read
+  - suppression.spam_reports.read
+  - suppression.unsubscribes.read
+  :update:
+  - suppression.update
+  - suppression.bounces.update
+  - suppression.blocks.update
+  - suppression.invalid_emails.update
+  - suppression.spam_reports.update
+  - suppression.unsubscribes.update
+:teammates:
+  :create:
+  - teammates.create
+  :delete:
+  - teammates.delete
+  :read:
+  - teammates.read
+  :update:
+  - teammates.update
+:templates:
+  :create:
+  - templates.create
+  - templates.versions.activate.create
+  - templates.versions.create
+  :delete:
+  - templates.delete
+  - templates.versions.activate.delete
+  - templates.versions.delete
+  :read:
+  - templates.read
+  - templates.versions.activate.read
+  - templates.versions.read
+  :update:
+  - templates.update
+  - templates.versions.activate.update
+  - templates.versions.update
+:tracking_settings:
+  :create: []
+  :delete: []
+  :read:
+  - tracking_settings.click.read
+  - tracking_settings.google_analytics.read
+  - tracking_settings.open.read
+  - tracking_settings.read
+  - tracking_settings.subscription.read
+  :update:
+  - tracking_settings.click.update
+  - tracking_settings.google_analytics.update
+  - tracking_settings.open.update
+  - tracking_settings.subscription.update
+:user_settings:
+  :create:
+  - user.email.create
+  - user.multifactor_authentication.create
+  :delete:
+  - user.email.delete
+  - user.multifactor_authentication.delete
+  :read:
+  - user.account.read
+  - user.credits.read
+  - user.email.read
+  - user.multifactor_authentication.read
+  - user.password.read
+  - user.profile.read
+  - user.timezone.read
+  - user.settings.enforced_tls.read
+  - user.username.read
+  :update:
+  - user.email.update
+  - user.multifactor_authentication.update
+  - user.password.update
+  - user.profile.update
+  - user.settings.enforced_tls.update
+  - user.timezone.update
+  - user.username.update
+:webhooks:
+  :create:
+  - user.webhooks.event.test.create
+  - user.webhooks.parse.settings.create
+  :delete:
+  - user.webhooks.parse.settings.delete
+  :read:
+  - user.webhooks.event.settings.read
+  - user.webhooks.event.test.read
+  - user.webhooks.parse.settings.read
+  - user.webhooks.parse.stats.read
+  :update:
+  - user.webhooks.event.settings.update
+  - user.webhooks.event.test.update
+  - user.webhooks.parse.settings.update
+:whitelabel:
+  :create:
+  - whitelabel.create
+  :delete:
+  - whitelabel.delete
+  :read:
+  - whitelabel.read
+  :update:
+  - whitelabel.update
+:access_settings:
+  :create:
+  - access_settings.whitelist.create
+  :delete:
+  - access_settings.whitelist.delete
+  :read:
+  - access_settings.activity.read
+  - access_settings.whitelist.read
+  :update:
+  - access_settings.whitelist.update

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

@@ -0,0 +1,14 @@
+**This module allows you to quickly and easily build a Settings object for retrieving or updating your Twilio SendGrid Settings.**
+
+# Quick Start
+
+Run the [example](../../../../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](../../../../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].freeze
+
+    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,22 @@
+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
+
+    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/helpers/stats/email_stats.rb

@@ -0,0 +1,46 @@
+require 'json'
+
+module SendGrid
+  class EmailStats
+    def initialize(args)
+      @sendgrid_client = args[:sendgrid_client]
+    end
+
+    def by_day(start_date, end_date, categories = nil, subusers = nil)
+      get('day', start_date, end_date, categories, subusers)
+    end
+
+    def by_week(start_date, end_date, categories = nil, subusers = nil)
+      get('week', start_date, end_date, categories, subusers)
+    end
+
+    def by_month(start_date, end_date, categories = nil, subusers = nil)
+      get('month', start_date, end_date, categories, subusers)
+    end
+
+    def get(aggregated_by, start_date, end_date, categories = nil, subusers = nil)
+      params = query_params(aggregated_by, start_date, end_date, categories, subusers)
+
+      response_body = @sendgrid_client.stats.get(query_params: params).body
+      build_response(response_body)
+    end
+
+    private
+
+    def query_params(aggregated_by, start_date, end_date, categories, subusers)
+      params = {
+        aggregated_by: aggregated_by,
+        start_date: start_date,
+        end_date: end_date
+      }
+      params.merge(categories: categories) if categories
+      params.merge(subusers: subusers) if subusers
+      params
+    end
+
+    def build_response(response_body)
+      response_json = JSON.parse(response_body)
+      StatsResponse.new(response_json)
+    end
+  end
+end

data/lib/sendgrid/helpers/stats/metrics.rb

@@ -0,0 +1,33 @@
+module SendGrid
+  class Metrics
+    attr_reader :blocks, :bounce_drops,
+                :bounces, :clicks, :deferred, :delivered,
+                :invalid_emails, :opens, :processed, :requests,
+                :spam_report_drops, :spam_reports, :unique_clicks,
+                :unique_opens, :unsubscribe_drops, :unsubscribes
+
+    def initialize(args = {})
+      @date = args['date']
+      @blocks = args['blocks']
+      @bounce_drops = args['bounce_drops']
+      @bounces = args['bounces']
+      @clicks = args['clicks']
+      @deferred = args['deferred']
+      @delivered = args['delivered']
+      @invalid_emails = args['invalid_emails']
+      @opens = args['opens']
+      @processed = args['processed']
+      @requests = args['requests']
+      @spam_report_drops = args['spam_report_drops']
+      @spam_reports = args['spam_reports']
+      @unique_clicks = args['unique_clicks']
+      @unique_opens = args['unique_opens']
+      @unsubscribe_drops = args['unsubscribe_drops']
+      @unsubscribes = args['unsubscribes']
+    end
+
+    def date
+      Date.parse(@date)
+    end
+  end
+end

data/lib/sendgrid/helpers/stats/stats_response.rb

@@ -0,0 +1,29 @@
+module SendGrid
+  class StatsResponse
+    def initialize(args)
+      @errors = args['errors'] if args.is_a? Hash
+      @stats = args if args.is_a? Array
+    end
+
+    def errors
+      @errors.map do |error|
+        error['message']
+      end
+    end
+
+    def error?
+      !@errors.nil?
+    end
+
+    def metrics
+      @stats.flat_map do |stat|
+        starting_date = stat['date']
+        all_stats_for_date = stat['stats']
+
+        all_stats_for_date.map do |metric|
+          Metrics.new(metric['metrics'].merge('date' => starting_date))
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid/sendgrid.rb

@@ -0,0 +1,21 @@
+# Quickly and easily access the Twilio SendGrid API.
+module SendGrid
+  class API < BaseInterface
+    # * *Args* :
+    #   - +api_key+ -> your Twilio SendGrid API key
+    #   - +host+ -> the base URL for the API
+    #   - +request_headers+ -> any headers that you want to be globally applied
+    #   - +version+ -> the version of the API you wish to access,
+    #                  currently only "v3" is supported
+    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+    #                              in the "On-Behalf-Of" header
+    #   - +http_options+ -> http options that you want to be globally applied to each request
+    #
+    def initialize(api_key:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil, http_options: {})
+      auth = "Bearer #{api_key}"
+      host ||= 'https://api.sendgrid.com'
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser, http_options: http_options)
+    end
+  end
+end

data/lib/sendgrid/twilio_email.rb

@@ -0,0 +1,21 @@
+# Quickly and easily access the Twilio Email API.
+module TwilioEmail
+  class API < BaseInterface
+    # * *Args* :
+    #   - +username+ -> your Twilio Email API key SID or Account SID
+    #   - +password+ -> your Twilio Email API key secret or Account Auth Token
+    #   - +host+ -> the base URL for the API
+    #   - +request_headers+ -> any headers that you want to be globally applied
+    #   - +version+ -> the version of the API you wish to access,
+    #                  currently only "v3" is supported
+    #   - +impersonate_subuser+ -> the subuser to impersonate, will be passed
+    #                              in the "On-Behalf-Of" header
+    #
+    def initialize(username:, password:, host: nil, request_headers: nil, version: nil, impersonate_subuser: nil)
+      auth = "Basic #{Base64.strict_encode64("#{username}:#{password}")}"
+      host ||= 'https://email.twilio.com'
+
+      super(auth: auth, host: host, request_headers: request_headers, version: version, impersonate_subuser: impersonate_subuser)
+    end
+  end
+end

data/lib/sendgrid/version.rb

@@ -1,3 +1,3 @@
 module SendGrid
-  VERSION = '1.1.6'
+  VERSION = '6.6.2'.freeze
 end

data/lib/sendgrid-ruby.rb

@@ -1,8 +1,33 @@
-require_relative 'sendgrid/client'
-require_relative 'sendgrid/exceptions'
-require_relative 'sendgrid/recipient'
-require_relative 'sendgrid/template'
-require_relative 'sendgrid/template_mailer'
-require_relative 'sendgrid/mail'
-require_relative 'sendgrid/response'
+require_relative 'sendgrid/base_interface'
+require_relative 'sendgrid/sendgrid'
+require_relative 'sendgrid/twilio_email'
 require_relative 'sendgrid/version'
+require_relative 'sendgrid/helpers/eventwebhook/eventwebhook'
+require_relative 'sendgrid/helpers/ip_management/ip_management'
+require_relative 'sendgrid/helpers/mail/asm'
+require_relative 'sendgrid/helpers/mail/attachment'
+require_relative 'sendgrid/helpers/mail/bcc_settings'
+require_relative 'sendgrid/helpers/mail/bypass_list_management'
+require_relative 'sendgrid/helpers/mail/category'
+require_relative 'sendgrid/helpers/mail/click_tracking'
+require_relative 'sendgrid/helpers/mail/content'
+require_relative 'sendgrid/helpers/mail/custom_arg'
+require_relative 'sendgrid/helpers/mail/email'
+require_relative 'sendgrid/helpers/mail/footer'
+require_relative 'sendgrid/helpers/mail/ganalytics'
+require_relative 'sendgrid/helpers/mail/header'
+require_relative 'sendgrid/helpers/mail/mail'
+require_relative 'sendgrid/helpers/mail/mail_settings'
+require_relative 'sendgrid/helpers/mail/open_tracking'
+require_relative 'sendgrid/helpers/mail/personalization'
+require_relative 'sendgrid/helpers/mail/section'
+require_relative 'sendgrid/helpers/mail/spam_check'
+require_relative 'sendgrid/helpers/mail/subscription_tracking'
+require_relative 'sendgrid/helpers/mail/substitution'
+require_relative 'sendgrid/helpers/mail/tracking_settings'
+require_relative 'sendgrid/helpers/settings/settings'
+require_relative 'sendgrid/helpers/stats/email_stats'
+require_relative 'sendgrid/helpers/stats/stats_response'
+require_relative 'sendgrid/helpers/stats/metrics'
+require_relative 'sendgrid/helpers/permissions/scope'
+require_relative 'rack/sendgrid_webhook_verification'