sendgrid4r 1.11.0 → 1.12.0

data/lib/sendgrid4r/cli/sg_thor.rb

@@ -0,0 +1,34 @@
+module SendGrid4r::CLI
+  #
+  # SendGrid Web API v3 SgThor
+  #
+  class SgThor < Thor
+    class_option :api_key, desc: 'API Key'
+    class_option :user, desc: 'SendGrid username for Basic Auth'
+    class_option :pass, desc: 'SendGrid password for Basic Auth'
+
+    def initialize(*args)
+      super
+      @client = SendGrid4r::Client.new(
+        username: options[:user], password: options[:pass],
+        api_key: options[: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
+      # remove auth info
+      params.delete(:api_key)
+      params.delete(:user)
+      params.delete(:pass)
+      # remove empty key and value
+      params.delete_if { |_k, v| v.nil? }
+      params
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+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, require: true
+      option :end_date
+      option :aggregated_by
+      option :country
+      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, require: true
+      option :end_date
+      option :aggregated_by
+      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, require: true
+      option :end_date
+      option :aggregated_by
+      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, require: true
+      option :end_date
+      option :aggregated_by
+      option :client_type, 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, require: true
+      option :end_date
+      option :aggregated_by
+      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, require: true
+      option :end_date
+      option :aggregated_by
+      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

@@ -0,0 +1,35 @@
+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, require: true
+      option :end_date
+      option :aggregated_by
+      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, require: true
+      option :end_date
+      option :sort_by_metric
+      option :sort_by_direction
+      option :limit
+      option :offset
+      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

@@ -0,0 +1,18 @@
+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, require: true
+      option :end_date
+      option :aggregated_by
+      def get
+        puts @client.get_global_stats(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module SendGrid4r::CLI
+  module Stats
+    #
+    # SendGrid Web API v3 Stats Parse
+    #
+    class Parse < SgThor
+      desc 'get', 'Gets statistics for Parse Webhook usage'
+      option :start_date, require: true
+      option :end_date
+      option :aggregated_by
+      def get
+        puts @client.get_parse_stats(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module SendGrid4r::CLI
+  module Stats
+    #
+    # SendGrid Web API v3 Stats
+    #
+    class Stats < SgThor
+      desc('advanced SUBCOMMAND ...ARGS', 'Get advanced stats')
+      subcommand('advanced', Advanced)
+
+      desc('category SUBCOMMAND ...ARGS', 'Get category stats')
+      subcommand('category', Category)
+
+      desc('global SUBCOMMAND ...ARGS', 'Get global stats')
+      subcommand('global', Global)
+
+      desc('parse SUBCOMMAND ...ARGS', 'Get parse stats')
+      subcommand('parse', Parse)
+
+      desc('subuser SUBCOMMAND ...ARGS', 'Get subuser stats')
+      subcommand('subuser', Subuser)
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+module SendGrid4r::CLI
+  module Stats
+    #
+    # SendGrid Web API v3 Stats Subuser
+    #
+    class Subuser < SgThor
+      desc 'get', 'Gets email statistics for the given subusers'
+      option :start_date, require: true
+      option :end_date
+      option :aggregated_by
+      option :subusers, type: :array, require: true
+      def get
+        puts @client.get_subusers_stats(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc(
+        'sums',
+        'Gets the total sums of each email statistic metric for all subusers'
+      )
+      option :start_date, require: true
+      option :end_date
+      option :sort_by_metric
+      option :sort_by_direction
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      def sums
+        puts @client.get_subusers_stats_sums(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc(
+        'list_monthly',
+        'Retrieve the monthly email statistics for all subusers'
+      )
+      option :date, require: true
+      option :subuser
+      option :sort_by_metric
+      option :sort_by_direction
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      def list_monthly
+        puts @client.get_subusers_stats_monthly(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc(
+        'get_monthly',
+        'Retrieve the monthly email statistics for a single subuser'
+      )
+      option :subuser_name, require: true
+      option :date, require: true
+      option :sort_by_metric
+      option :sort_by_direction
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      def get_monthly
+        puts @client.get_subuser_stats_monthly(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/subusers/monitor.rb

@@ -0,0 +1,44 @@
+module SendGrid4r::CLI
+  module Subusers
+    #
+    # SendGrid Web API v3 Subusers Monitor
+    #
+    class Monitor < SgThor
+      desc 'list', 'Retrieve monitor settings'
+      option :username, require: true
+      def list
+        puts @client.get_subuser_monitor(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create monitor settings'
+      option :username, require: true
+      option :email, require: true
+      option :frequency, type: :numeric, require: true
+      def create
+        puts @client.post_subuser_monitor(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'update', 'Update monitor settings'
+      option :username, require: true
+      option :email, require: true
+      option :frequency, type: :numeric, require: true
+      def update
+        puts @client.put_subuser_monitor(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete monitor settings'
+      option :username, require: true
+      def delete
+        puts @client.delete_subuser_monitor(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/subusers/subuser.rb

@@ -0,0 +1,77 @@
+module SendGrid4r::CLI
+  module Subusers
+    #
+    # SendGrid Web API v3 Subusers Subuser
+    #
+    class Subuser < SgThor
+      desc 'list', 'List subusers for a parent'
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      option :username
+      def list
+        puts @client.get_subusers(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create a subuser'
+      option :username, require: true
+      option :email, require: true
+      option :password, require: true
+      option :ips, type: :array, require: true
+      def create
+        puts @client.post_subuser(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'enable', 'Enable a subuser'
+      option :username, require: true
+      def enable
+        params = parameterise(options)
+        params[:disabled] = false
+        puts @client.patch_subuser(params)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'disable', 'Disable a subuser'
+      option :username, require: true
+      def disable
+        params = parameterise(options)
+        params[:disabled] = false
+        puts @client.patch_subuser(params)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete a subuser'
+      option :username, require: true
+      def delete
+        puts @client.delete_subuser(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'reputation', 'Retrieve subusers reputation'
+      option :usernames, type: :array, require: true
+      def reputation
+        puts @client.get_subuser_reputation(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'assign_ips', 'Update IPs assigned to a subuser'
+      option :username, require: true
+      option :ips, type: :array, require: true
+      def assign_ips
+        puts @client.put_subuser_assigned_ips(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc('monitor SUBCOMMAND ...ARGS', 'Manage monitor records for subuser')
+      subcommand('monitor', Monitor)
+    end
+  end
+end

data/lib/sendgrid4r/cli/suppressions/block.rb

@@ -0,0 +1,43 @@
+module SendGrid4r::CLI
+  module Suppressions
+    #
+    # SendGrid Web API v3 Suppressions Block
+    #
+    class Block < SgThor
+      desc 'list', 'List blocks'
+      option :start_time, type: :numeric
+      option :end_time, type: :numeric
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      def list
+        puts @client.get_blocks(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete blocks'
+      option :delete_all, type: :boolean
+      option :email
+      option :emails, type: :array
+      def delete
+        if options[:email]
+          puts @client.delete_block(email: options[:email])
+        else
+          puts @client.delete_blocks(
+            delete_all: options[:delete_all], emails: options[:emails]
+          )
+        end
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Get a block'
+      option :email, require: true
+      def get
+        puts @client.get_block(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end