sendgrid4r 1.13.0 → 1.14.0

data/lib/sendgrid4r/cli/ips/warmup.rb

@@ -1,39 +0,0 @@
-module SendGrid4r::CLI
-  module Ips
-    #
-    # SendGrid Web API v3 Ips Warmup
-    #
-    class Warmup < SgThor
-      desc 'list', 'List all IP addresses that are currently warming up'
-      def list
-        puts @client.get_warmup_ips
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'get', 'Get warmup status for a particular IP address'
-      option :ip, require: true
-      def get
-        puts @client.get_warmup_ip(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'start', 'Start warmup'
-      option :ip, require: true
-      def start
-        puts @client.post_warmup_ip(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'stop', 'Stop warmup'
-      option :ip, require: true
-      def stop
-        puts @client.delete_warmup_ip(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/mail.rb

@@ -1,34 +0,0 @@
-module SendGrid4r::CLI
-  #
-  # SendGrid Web API v3 Mail
-  #
-  class Mail < SgThor
-    desc 'send', 'Send mail'
-    option :to, type: :hash
-    option :from, type: :hash, require: true
-    option :content, type: :array, require: true
-    option :subject, require: true
-    def send
-      to = SendGrid4r::Factory::MailFactory.create_address(
-        parameterise(options[:to])
-      )
-      from = SendGrid4r::Factory::MailFactory.create_address(
-        parameterise(options[:from])
-      )
-      per = SendGrid4r::Factory::MailFactory.create_personalization(to: [to])
-      cont = options[:content].map do |c|
-        hash = c.split(/[:,]/).each_slice(2).map do |k, v|
-          [k.to_sym, v.nil? ? '' : v]
-        end.to_h
-        SendGrid4r::Factory::MailFactory.create_content(hash)
-      end
-      params = SendGrid4r::Factory::MailFactory.create_params(
-        personalizations: [per], from: from, content: cont,
-        subject: options[:subject]
-      )
-      puts @client.send(params: params)
-    rescue RestClient::ExceptionWithResponse => e
-      puts e.inspect
-    end
-  end
-end

data/lib/sendgrid4r/cli/settings/enforced_tls.rb

@@ -1,24 +0,0 @@
-module SendGrid4r::CLI
-  module Settings
-    #
-    # SendGrid Web API v3 Settings EnforcedTls
-    #
-    class EnforcedTls < SgThor
-      desc 'get', 'Get the current Enforced TLS settings'
-      def get
-        puts @client.get_enforced_tls
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'update', 'Change the Enforced TLS settings'
-      option :require_tls, type: :boolean
-      option :require_valid_cert, type: :boolean
-      def update
-        puts @client.patch_enforced_tls(params: parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/settings/mail.rb

@@ -1,195 +0,0 @@
-module SendGrid4r::CLI
-  module Settings
-    #
-    # SendGrid Web API v3 Settings Mail
-    #
-    class Mail < SgThor
-      desc 'list', 'List mail settings'
-      option :limit, type: :numeric
-      option :offset, type: :numeric
-      def list
-        puts @client.get_mail_settings(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'whitelist [get|enable|disable]',
-        'Get, Enable and Disable address whitelist settings'
-      )
-      option :list, type: :array
-      def whitelist(action)
-        case action
-        when 'get'
-          puts @client.get_settings_address_whitelist
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_address_whitelist(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'bcc [get|enable|disable]', 'Get, Enable and Disable bcc settings'
-      option :email
-      def bcc(action)
-        case action
-        when 'get'
-          puts @client.get_settings_bcc
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_bcc(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'bounce_purge [get|enable|disable]',
-        'Get, Enable and Disable bounce purge settings'
-      )
-      option :hard_bounces, type: :numeric
-      option :soft_bounces, type: :numeric
-      def bounce_purge(action)
-        case action
-        when 'get'
-          puts @client.get_settings_bounce_purge
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_bounce_purge(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'footer [get|enable|disable]',
-        'Get, Enable and Disable footer settings'
-      )
-      option :html_content
-      option :plain_content
-      def footer(action)
-        case action
-        when 'get'
-          puts @client.get_settings_footer
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_footer(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'forward_bounce [get|enable|disable]',
-        'Get, Enable and Disable forward bounce settings'
-      )
-      option :email
-      def forward_bounce(action)
-        case action
-        when 'get'
-          puts @client.get_settings_forward_bounce
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_forward_bounce(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'forward_spam [get|enable|disable]',
-        'Get, Enable and Disable forward spam settings'
-      )
-      option :email
-      def forward_spam(action)
-        case action
-        when 'get'
-          puts @client.get_settings_forward_spam
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_forward_spam(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'spam_check [get|enable|disable]',
-        'Get, Enable and Disable spam check settings'
-      )
-      option :url
-      option :max_score
-      def spam_check(action)
-        case action
-        when 'get'
-          puts @client.get_settings_spam_check
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_spam_check(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'template [get|enable|disable]',
-        'Get, Enable and Disable template settings'
-      )
-      option :html_content
-      def template(action)
-        case action
-        when 'get'
-          puts @client.get_settings_template
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_template(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'plain_content [get|enable|disable]',
-        'Get, Enable and Disable plain content settings'
-      )
-      def plain_content(action)
-        case action
-        when 'get'
-          puts @client.get_settings_plain_content
-        when 'enable', 'disable'
-          params = { enabled: action == 'enable' }
-          puts @client.patch_settings_plain_content(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/settings/partner.rb

@@ -1,37 +0,0 @@
-module SendGrid4r::CLI
-  module Settings
-    #
-    # SendGrid Web API v3 Settings Partner
-    #
-    class Partner < SgThor
-      desc 'list', 'List partner settings'
-      option :limit, type: :numeric
-      option :offset, type: :numeric
-      def list
-        puts @client.get_partner_settings(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'new_relic [get|enable|disable]',
-        'Get, Enable and Disable new relic settings'
-      )
-      option :license_key
-      def new_relic(action)
-        case action
-        when 'get'
-          puts @client.get_settings_new_relic
-        when 'enable', 'disabple'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_new_relic(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/settings/settings.rb

@@ -1,20 +0,0 @@
-module SendGrid4r::CLI
-  module Settings
-    #
-    # SendGrid Web API v3 Settings
-    #
-    class Settings < SgThor
-      desc('enforced_tls SUBCOMMAND ...ARGS', 'Manage enforced TLS settings')
-      subcommand('enforced_tls', EnforcedTls)
-
-      desc('mail SUBCOMMAND ...ARGS', 'Manage mail settings')
-      subcommand('mail', Mail)
-
-      desc('partner SUBCOMMAND ...ARGS', 'Manage partner settings')
-      subcommand('partner', Partner)
-
-      desc('tracking SUBCOMMAND ...ARGS', 'Manage tracking settings')
-      subcommand('tracking', Tracking)
-    end
-  end
-end

data/lib/sendgrid4r/cli/settings/tracking.rb

@@ -1,101 +0,0 @@
-module SendGrid4r::CLI
-  module Settings
-    #
-    # SendGrid Web API v3 Settings Tracking
-    #
-    class Tracking < SgThor
-      desc 'list', 'List tracking settings'
-      option :limit, type: :numeric
-      option :offset, type: :numeric
-      def list
-        puts @client.get_tracking_settings(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'click [get|enable|disable]',
-        'Get, Enable and Disable click tracking settings'
-      )
-      def click(action)
-        case action
-        when 'get'
-          puts @client.get_settings_click
-        when 'enable', 'disable'
-          params = { enabled: action == 'enable' }
-          puts @client.patch_settings_click(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'ganalytics [get|enable|disable]',
-        'Get, Enable and Disable google analytics settings'
-      )
-      option :utm_source
-      option :utm_medium
-      option :utm_term
-      option :utm_content
-      option :utm_campaign
-      def ganalytics(action)
-        case action
-        when 'get'
-          puts @client.get_settings_google_analytics
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_google_analytics(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'open [get|enable|disable]',
-        'Get, Enable and Disable open tracking settings'
-      )
-      def open(action)
-        case action
-        when 'get'
-          puts @client.get_settings_open
-        when 'enable', 'disable'
-          params = { enabled: action == 'enable' }
-          puts @client.patch_settings_open(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'subscription [get|enable|disable]',
-        'Get, Enable and Disable subscription tracking settings'
-      )
-      option :landing
-      option :url
-      option :replace
-      option :html_content
-      option :plain_content
-      def subscription(action)
-        case action
-        when 'get'
-          puts @client.get_settings_subscription
-        when 'enable', 'disable'
-          params = parameterise(options)
-          params[:enabled] = action == 'enable'
-          puts @client.patch_settings_subscription(params: params)
-        else
-          puts "error: #{action} is not supported in action parameter"
-        end
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/sg.rb

@@ -1,61 +0,0 @@
-module SendGrid4r::CLI
-  #
-  # SendGrid Web API v3 ClI
-  #
-  class SG < Thor
-    map %w(--version -v) => :print_version
-
-    desc '--version, -v', 'Print the version'
-    def print_version
-      puts SendGrid4r::VERSION
-    end
-
-    desc('alert SUBCOMMAND ...ARGS', 'Manage alert settings')
-    subcommand('alert', Alert)
-
-    desc('api_key SUBCOMMAND ...ARGS', 'Manage API keys')
-    subcommand('api_key', ApiKeys::ApiKey)
-
-    desc('campaign SUBCOMMAND ...ARGS', 'Manage Marketing Campaigns')
-    subcommand('campaign', Campaign::Campaign)
-
-    desc('cancel_schedule SUBCOMMAND ...ARGS', 'Manage canceling schedule send')
-    subcommand('cancel_schedule', CancelSchedules::CancelSchedule)
-
-    desc('ipam SUBCOMMAND ...ARGS', 'Manage ip access')
-    subcommand('ipam', Ipam::Ipam)
-
-    desc('ip SUBCOMMAND ...ARGS', 'Manage ips')
-    subcommand('ip', Ips::Ip)
-
-    desc('settings SUBCOMMAND ...ARGS', 'Manage settings')
-    subcommand('settings', Settings::Settings)
-
-    desc('stats SUBCOMMAND ...ARGS', 'Get account statistics')
-    subcommand('stats', Stats::Stats)
-
-    desc('subuser SUBCOMMAND ...ARGS', 'Manage subuser')
-    subcommand('subuser', Subusers::Subuser)
-
-    desc('suppression SUBCOMMAND ...ARGS', 'Manage suppressions')
-    subcommand('suppressions', Suppressions::Suppression)
-
-    desc('template SUBCOMMAND ...ARGS', 'Manage templates')
-    subcommand('template', Templates::Template)
-
-    desc('webhook SUBCOMMAND ...ARGS', 'Manage webhook settings')
-    subcommand('webhook', Webhooks::Webhook)
-
-    desc('whitelabel SUBCOMMAND ...ARGS', 'Manage whitelabel settings')
-    subcommand('whitelabel', Whitelabel::Whitelabel)
-
-    desc('category SUBCOMMAND ...ARGS', 'Manage categories')
-    subcommand('category', Category)
-
-    desc('mail SUBCOMMAND ...ARGS', 'Send mail')
-    subcommand('mail', Mail)
-
-    desc('user SUBCOMMAND ...ARGS', 'Manage user')
-    subcommand('user', User)
-  end
-end

data/lib/sendgrid4r/cli/sg_thor.rb

@@ -1,50 +0,0 @@
-module SendGrid4r::CLI
-  #
-  # SendGrid Web API v3 SgThor
-  #
-  class SgThor < Thor
-    ISO = 'YYYY-MM-DD'
-    UTS = 'UNIX TIMESTAMP'
-    AGG = '[day|week|month]'
-    DIR = '[desc|asc]'
-    TYP = '[date|text|number]'
-
-    class_option :api_key, aliases: '-k', desc: 'API Key for APIKey Auth'
-    class_option :user, aliases: '-u', desc: 'Username for Basic Auth'
-    class_option :pass, aliases: '-p', desc: 'Password for Basic Auth'
-    class_option(
-      :envkey,
-      aliases: '-e',
-      desc: 'Load API Key from environment variable "SG_API_KEY"',
-      banner: ''
-    )
-
-    def initialize(*args)
-      super
-      api_key = options[:api_key]
-      api_key = ENV['SG_API_KEY'] if options[:envkey]
-      @client = SendGrid4r::Client.new(
-        username: options[:user], password: options[:pass],
-        api_key: api_key, raw_response: true
-      )
-    end
-
-    protected
-
-    def parameterise(options)
-      # symbolize keys
-      params = options.each_with_object({}) do |(k, v), memo|
-        memo[k.to_s.to_sym] = v
-      end
-      params.tap do |p|
-        # remove auth info
-        p.delete(:api_key)
-        p.delete(:user)
-        p.delete(:pass)
-        p.delete(:envkey)
-        # remove empty key and value
-        p.delete_if { |_k, v| v.nil? }
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/stats/advanced.rb

@@ -1,74 +0,0 @@
-module SendGrid4r::CLI
-  module Stats
-    #
-    # SendGrid Web API v3 Stats Advanced
-    #
-    class Advanced < SgThor
-      desc 'geo', 'Gets email statistics by country and state/province'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      option :country, banner: '[US|CA]'
-      def geo
-        puts @client.get_geo_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'device', 'Gets email statistics by device type'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      def device
-        puts @client.get_devices_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'client', 'Gets email statistics by client type'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      def client
-        puts @client.get_clients_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'client_type', 'Gets email statistics for a single client type'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      option(
-        :client_type, banner: '[phone|tablet|webmail|desktop]', require: true
-      )
-      def client_type
-        puts @client.get_clients_type_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'mailbox_provider', 'Gets email statistics by mailbox provider'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      option :mailbox_providers
-      def mailbox_provider
-        puts @client.get_mailbox_providers_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc 'browser', 'Gets email statistics by browser'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      option :browsers
-      def browser
-        puts @client.get_browsers_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/stats/category.rb

@@ -1,35 +0,0 @@
-module SendGrid4r::CLI
-  module Stats
-    #
-    # SendGrid Web API v3 Stats Category
-    #
-    class Category < SgThor
-      desc 'get', 'Gets email statistics for the given categories.'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      option :categories, require: true
-      def get
-        puts @client.get_categories_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-
-      desc(
-        'sums',
-        'Gets the total sums of each email statistic metric for all categories'
-      )
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :sort_by_metric
-      option :sort_by_direction, banner: SgThor::DIR
-      option :limit, type: :numeric
-      option :offset, type: :numeric
-      def sums
-        puts @client.get_categories_stats_sums(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end

data/lib/sendgrid4r/cli/stats/global.rb

@@ -1,18 +0,0 @@
-module SendGrid4r::CLI
-  module Stats
-    #
-    # SendGrid Web API v3 Stats Global
-    #
-    class Global < SgThor
-      desc 'get', 'Gets all of your user’s email statistics.'
-      option :start_date, banner: SgThor::ISO, require: true
-      option :end_date, banner: SgThor::ISO
-      option :aggregated_by, banner: SgThor::AGG
-      def get
-        puts @client.get_global_stats(parameterise(options))
-      rescue RestClient::ExceptionWithResponse => e
-        puts e.inspect
-      end
-    end
-  end
-end