sendgrid4r 1.11.0 → 1.12.0

data/lib/sendgrid4r/cli/webhooks/event.rb

@@ -0,0 +1,53 @@
+module SendGrid4r::CLI
+  module Webhooks
+    #
+    # SendGrid Web API v3 Webhooks Event
+    #
+    class Event < SgThor
+      desc 'get', 'Get Event Webhook Settings'
+      def get
+        puts @client.get_settings_event_notification
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'enable', 'Enable Event Webhook Settings'
+      option :url
+      option :group_resubscribe, type: :boolean
+      option :delivered, type: :boolean
+      option :group_unsubscribe, type: :boolean
+      option :spam_report, type: :boolean
+      option :bounce, type: :boolean
+      option :deferred, type: :boolean
+      option :unsubscribe, type: :boolean
+      option :processed, type: :boolean
+      option :open, type: :boolean
+      option :click, type: :boolean
+      option :dropped, type: :boolean
+      def enable
+        params = parameterise(options)
+        params[:enabled] = true
+        event = SendGrid4r::Factory::EventFactory.create(params)
+        puts @client.patch_settings_event_notification(params: event)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'disable', 'Disable Event Webhook Settings'
+      def disable
+        params = { enabled: false }
+        puts @client.patch_settings_event_notification(params: params)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'test', 'Sends a fake event notification post to the provided URL'
+      option :url
+      def test
+        puts @client.test_settings_event_notification(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module SendGrid4r::CLI
+  module Webhooks
+    #
+    # SendGrid Web API v3 Webhook Parse
+    #
+    class Parse < SgThor
+      desc 'get', 'Get Parse Webhook Settings'
+      def get
+        puts @client.get_parse_settings
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/webhooks/webhook.rb

@@ -0,0 +1,14 @@
+module SendGrid4r::CLI
+  module Webhooks
+    #
+    # SendGrid Web API v3 Webhooks Webhook
+    #
+    class Webhook < SgThor
+      desc('event SUBCOMMAND ...ARGS', 'Manage event webhook settings')
+      subcommand('event', Event)
+
+      desc('parse SUBCOMMAND ...ARGS', 'Manage parse webhook settings')
+      subcommand('parse', Parse)
+    end
+  end
+end

data/lib/sendgrid4r/cli/whitelabel/domain.rb

@@ -0,0 +1,117 @@
+module SendGrid4r::CLI
+  module Whitelabel
+    #
+    # SendGrid Web API v3 Whitelabel Domain
+    #
+    class Domain < SgThor
+      desc 'list', 'List all Domain whitelabels'
+      option :limit
+      option :offset
+      option :exclude_subusers
+      option :username
+      option :domain
+      def list
+        puts @client.get_wl_domains(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create a domain whitelabel'
+      option :domain, require: true
+      option :subdomain, require: true
+      option :automatic_security, type: :boolean
+      option :custom_spf, type: :boolean
+      option :default, type: :boolean
+      def create
+        puts @client.post_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Retrieve a domain whitelabel'
+      option :id, require: true
+      def get
+        puts @client.get_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'update', 'Update a domain whitelabel'
+      option :id, require: true
+      option :custom_spf, type: :boolean
+      option :default, type: :boolean
+      def update
+        puts @client.patch_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete a domain whitelabel'
+      option :id, require: true
+      def delete
+        puts @client.delete_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'default', 'Default a domain'
+      option :domain
+      def default
+        puts @client.get_default_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'add_ip', 'Add an IP to a Domain'
+      option :id, require: true
+      option :ip, require: true
+      def add_ip
+        puts @client.add_ip_to_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'remove_ip', 'Remove an IP from a Domain'
+      option :id, require: true
+      option :ip, require: true
+      def remove_ip
+        puts @client.remove_ip_from_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'validate', 'Validate a Domain'
+      option :id, require: true
+      def validate
+        puts @client.validate_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'list_associated', 'List Associated Domain'
+      option :username, require: true
+      def list_associated
+        puts @client.get_associated_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'disassociate', 'Disassociate Domain'
+      option :username, require: true
+      def disassociate
+        puts @client.disassociate_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'associate', 'Associate Domain'
+      option :id, require: true
+      option :username, require: true
+      def associate
+        puts @client.associate_wl_domain(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/whitelabel/ip.rb

@@ -0,0 +1,52 @@
+module SendGrid4r::CLI
+  module Whitelabel
+    #
+    # SendGrid Web API v3 Whitelabel Ip
+    #
+    class Ip < SgThor
+      desc 'list', 'List all IP whitelabels'
+      option :ip
+      option :limit, type: :numeric
+      option :offset, type: :numeric
+      def list
+        puts @client.get_wl_ips(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create an IP whitelabel'
+      option :ip, require: true
+      option :domain, require: true
+      option :subdomain, require: true
+      def create
+        puts @client.post_wl_ip(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Retrieve an IP whitelabel'
+      option :id, require: true
+      def get
+        puts @client.get_wl_ip(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete an IP whitelabel'
+      option :id, require: true
+      def delete
+        puts @client.delete_wl_ip(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'validate', 'Validate IP whitelabel'
+      option :id, require: true
+      def validate
+        puts @client.validate_wl_ip(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/whitelabel/link.rb

@@ -0,0 +1,96 @@
+module SendGrid4r::CLI
+  module Whitelabel
+    #
+    # SendGrid Web API v3 Whitelabel Link
+    #
+    class Link < SgThor
+      desc 'list', 'List all Link whitelabels'
+      option :limit
+      option :offset
+      option :exclude_subusers
+      option :username
+      option :domain
+      def list
+        puts @client.get_wl_links(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create a link whitelabel'
+      option :domain, require: true
+      option :subdomain, require: true
+      option :default, type: :boolean
+      def create
+        puts @client.post_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Retrieve a link whitelabel'
+      option :id, require: true
+      def get
+        puts @client.get_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'update', 'Update a link whitelabel'
+      option :id, require: true
+      option :default, type: :boolean, require: true
+      def update
+        puts @client.patch_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete a link whitelabel'
+      option :id, require: true
+      def delete
+        puts @client.delete_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'default', 'Default a link whitelabel'
+      option :domain
+      def default
+        puts @client.get_default_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'validate', 'Validate a link whitelabel'
+      option :id, require: true
+      def validate
+        puts @client.validate_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'list_associated', 'List Associated link'
+      option :username, require: true
+      def list_associated
+        puts @client.get_associated_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'disassociate', 'Disassociate link'
+      option :username, require: true
+      def disassociate
+        puts @client.disassociate_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'associate', 'Associate link'
+      option :id, require: true
+      option :username, require: true
+      def associate
+        puts @client.associate_wl_link(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/whitelabel/whitelabel.rb

@@ -0,0 +1,17 @@
+module SendGrid4r::CLI
+  module Whitelabel
+    #
+    # SendGrid Web API v3 Whitelabel
+    #
+    class Whitelabel < SgThor
+      desc('domain SUBCOMMAND ...ARGS', 'Manage domain whitelabel settings')
+      subcommand('domain', Domain)
+
+      desc('link SUBCOMMAND ...ARGS', 'Manage link whitelabel settings')
+      subcommand('link', Link)
+
+      desc('ip SUBCOMMAND ...ARGS', 'Manage IP whitelabel settings')
+      subcommand('ip', Ip)
+    end
+  end
+end

data/lib/sendgrid4r/client.rb

@@ -7,10 +7,13 @@ module SendGrid4r
   class Client
     include SendGrid4r::REST::API
 
+    attr_accessor :raw_resp
+
     def initialize(
-      username: nil, password: nil, api_key: nil
+      username: nil, password: nil, api_key: nil, raw_response: false
     )
       @auth = Auth.new(username: username, password: password, api_key: api_key)
+      @raw_resp = raw_response
     end
   end
 end

data/lib/sendgrid4r/factory/campaign_factory.rb

@@ -32,7 +32,7 @@ module SendGrid4r
       end
 
       def create_address(email:, name:)
-        REST::MarketingCampaigns::Address.new(email, name)
+        REST::MarketingCampaigns::Address.new(email, name).to_h
       end
     end
   end

data/lib/sendgrid4r/factory/condition_factory.rb

@@ -6,12 +6,12 @@ module SendGrid4r
     # SendGrid Web API v3 Condition Factory Class implementation
     #
     class ConditionFactory
-      def create(field:, value:, operator:, and_or:)
+      def create(field:, value:, operator:, and_or: nil)
         REST::MarketingCampaigns::Contacts::Segments::Condition.new(
           field,
           value,
           operator,
-          and_or
+          and_or.nil? ? '' : and_or
         ).to_h
       end
     end

data/lib/sendgrid4r/factory/event_factory.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r
+  module Factory
+    #
+    # SendGrid Web API v3 Event Factory Class implementation
+    #
+    module EventFactory
+      def self.create(enabled:, url: nil, group_resubscribe: nil,
+        delivered: nil, group_unsubscribe: nil, spam_report: nil,
+        bounce: nil, deferred: nil, unsubscribe: nil, processed: nil,
+        open: nil, click: nil, dropped: nil)
+        REST::Webhooks::Event::EventNotification.new(
+          enabled, url, group_resubscribe, delivered,
+          group_unsubscribe, spam_report, bounce, deferred,
+          unsubscribe, processed, open, click, dropped
+        )
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/api_keys_management/api_keys.rb

@@ -36,20 +36,20 @@ module SendGrid4r::REST
 
     def get_api_keys(&block)
       resp = get(@auth, ApiKeysManagement.url, &block)
-      ApiKeysManagement.create_api_keys(resp)
+      finish(resp, @raw_resp) { |r| ApiKeysManagement.create_api_keys(r) }
     end
 
     def post_api_key(name:, scopes: nil, &block)
       params = { name: name }
       params[:scopes] = scopes unless scopes.nil?
       resp = post(@auth, ApiKeysManagement.url, params, &block)
-      ApiKeysManagement.create_api_key(resp)
+      finish(resp, @raw_resp) { |r| ApiKeysManagement.create_api_key(r) }
     end
 
     def get_api_key(api_key_id:, &block)
       endpoint = ApiKeysManagement.url(api_key_id)
       resp = get(@auth, endpoint, &block)
-      ApiKeysManagement.create_api_key(resp)
+      finish(resp, @raw_resp) { |r| ApiKeysManagement.create_api_key(r) }
     end
 
     def delete_api_key(api_key_id:, &block)
@@ -60,7 +60,7 @@ module SendGrid4r::REST
       params = { name: name }
       endpoint = ApiKeysManagement.url(api_key_id)
       resp = patch(@auth, endpoint, params, &block)
-      ApiKeysManagement.create_api_key(resp)
+      finish(resp, @raw_resp) { |r| ApiKeysManagement.create_api_key(r) }
     end
 
     def put_api_key(api_key_id:, name:, scopes:, &block)
@@ -69,7 +69,7 @@ module SendGrid4r::REST
       params[:scopes] = scopes unless scopes.nil?
       endpoint = ApiKeysManagement.url(api_key_id)
       resp = put(@auth, endpoint, params, &block)
-      ApiKeysManagement.create_api_key(resp)
+      finish(resp, @raw_resp) { |r| ApiKeysManagement.create_api_key(r) }
     end
   end
 end