sendgrid4r 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cda12931359478f468bbeded469791515cf5860
-  data.tar.gz: 97cac6512ee508361d0af538fb139ebaa50bafa5
+  metadata.gz: f63d8884d3b1ca8b9eb7091d85b912efa8bf4560
+  data.tar.gz: 3561561011662deb924811afc9b171d574b075e2
 SHA512:
-  metadata.gz: cb38ffbfc69efab257fec97f634efb9bfa8f5a7d1e36e1c8256b0fc64b3e68f2a73eaa19cf3fc8bad245c6abb865c0266a9087d39b401828ae02b1faa74f8207
-  data.tar.gz: 56fbd91625138b4f67abb5734708ca474c864d8b0d79ee986701e2952db85eb19cb9f5fe6118bb3bfba1f8e7b12052bac68f683fa7063be93ffb08421941bf69
+  metadata.gz: b9c8576c472b175ed404c66c47d2582191166e6c577fe490309c9342afb9916361b6914286ff478a177414293af4df1f9f8ab631e2ec438ba9cbc185a2f96fcd
+  data.tar.gz: 0705ed5391a47a46014cd88f26ad5101331c97576dc2535ca31ea2616bf23feb00f161304843a210d17dfa14b9a46a39c30e9a6f7441f6883709dddd16b12b67

data/.rubocop.yml

@@ -18,7 +18,7 @@ ParameterLists:
 
 # Change limitation of AbcSize
 AbcSize:
-  Max: 22
+  Max: 27
 
 # Change numeric literals
 NumericLiterals:
@@ -27,3 +27,8 @@ NumericLiterals:
 # Disable force module and class style
 ClassAndModuleChildren:
   Enabled: false
+
+# Change limitation of the class length
+ClassLength:
+  CountComments: false  # count full line comments?
+  Max: 160

data/exe/sg

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sendgrid4r'
+
+SendGrid4r::CLI::SG.start(ARGV)

data/lib/sendgrid4r/cli/api_keys/api_key.rb

@@ -0,0 +1,53 @@
+module SendGrid4r::CLI
+  module ApiKeys
+    #
+    # SendGrid Web API v3 ApiKeys ApiKey
+    #
+    class ApiKey < SgThor
+      desc 'list', 'List API keys'
+      def list
+        puts @client.get_api_keys
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'create', 'Create an API key'
+      option :name, require: true
+      option :scopes, type: :array
+      def create
+        puts @client.post_api_key(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Get an API key'
+      option :api_key_id, require: true
+      def get
+        puts @client.get_api_key(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete an API key'
+      option :api_key_id, require: true
+      def delete
+        puts @client.delete_api_key(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'update', 'Update an API key'
+      option :api_key_id, require: true
+      option :name, require: true
+      option :scopes, type: :array
+      def update
+        puts @client.put_api_key(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc('permission SUBCOMMAND ...ARGS', 'Manage permission for API key')
+      subcommand('permission', Permission)
+    end
+  end
+end

data/lib/sendgrid4r/cli/api_keys/permission.rb

@@ -0,0 +1,15 @@
+module SendGrid4r::CLI
+  module ApiKeys
+    #
+    # SendGrid Web API v3 ApiKeys Permission
+    #
+    class Permission < SgThor
+      desc 'list', 'List all available scopes for a user'
+      def list
+        puts @client.get_permissions
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/campaign/campaign.rb

@@ -0,0 +1,134 @@
+module SendGrid4r::CLI
+  module Campaign
+    #
+    # SendGrid Web API v3 Marketing Campaigns
+    #
+    class Campaign < SgThor
+      desc 'create', 'Create a campaign'
+      option :title
+      option :subject
+      option :sender_id, type: :numeric
+      option :list_ids, type: :array
+      option :segment_ids, type: :array
+      option :categories, type: :array
+      option :suppression_group_id, type: :numeric
+      option :html_content
+      option :plain_content
+      def create
+        params = SendGrid4r::Factory::CampaignFactory.new.create(
+          parameterise(options)
+        )
+        res = @client.post_campaign(params: params)
+        puts URI.decode(JSON.load(res).to_s)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'list', 'List campaigns'
+      def list
+        res = @client.get_campaigns
+        puts URI.decode(JSON.load(res).to_s)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'get', 'Get a campaign'
+      option :campaign_id, type: :numeric, require: true
+      def get
+        res = @client.get_campaign(parameterise(options))
+        puts URI.decode(JSON.load(res).to_s)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'delete', 'Delete a campaign'
+      option :campaign_id, type: :numeric, require: true
+      def delete
+        puts @client.delete_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'update', 'Update a campaign'
+      option :campaign_id, type: :numeric, require: true
+      option :title
+      option :subject
+      option :sender_id, type: :numeric
+      option :list_ids, type: :array
+      option :categories, type: :array
+      option :suppression_group_id, type: :numeric
+      option :html_content
+      option :plain_content
+      def update
+        factory = SendGrid4r::Factory::CampaignFactory.new
+        params = parameterise(options)
+        params.delete(:campaign_id)
+        campaign = factory.create(params)
+        res = @client.patch_campaign(
+          campaign_id: options[:campaign_id],
+          params: campaign
+        )
+        puts URI.decode(JSON.load(res).to_s)
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'send', 'Send a campaign'
+      option :campaign_id, type: :numeric, require: true
+      def send
+        puts @client.send_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'schedule', 'Schedule a campaign'
+      option :campaign_id, type: :numeric, require: true
+      option :send_at, type: :numeric, require: true
+      def schedule
+        puts @client.schedule_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'reschedule', 'Reschedule a campaign'
+      option :campaign_id, type: :numeric, require: true
+      option :send_at, type: :numeric, require: true
+      def reschedule
+        puts @client.reschedule_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'unschedule', 'Unschedule a campaign'
+      option :campaign_id, type: :numeric, require: true
+      def unschedule
+        puts @client.unschedule_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'time', 'View scheduled time of a campaign'
+      option :campaign_id, type: :numeric, require: true
+      def time
+        puts @client.get_schedule_time_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc 'test', 'Send a test campaign'
+      option :campaign_id, type: :numeric, require: true
+      option :to, require: true
+      def test
+        puts @client.test_campaign(parameterise(options))
+      rescue RestClient::ExceptionWithResponse => e
+        puts e.inspect
+      end
+
+      desc('sender SUBCOMMAND ...ARGS', 'Manage senders')
+      subcommand('sender', Sender)
+
+      desc('contact SUBCOMMAND ...ARGS', 'Manage contacts')
+      subcommand('contact', Contact::Contact)
+    end
+  end
+end

data/lib/sendgrid4r/cli/campaign/contact/contact.rb

@@ -0,0 +1,25 @@
+module SendGrid4r::CLI
+  module Campaign
+    module Contact
+      #
+      # SendGrid Web API v3 Marketing Campaigns - Contact
+      #
+      class Contact < SgThor
+        desc('custom SUBCOMMAND ...ARGS', 'Manage custom fields')
+        subcommand('custom', CustomField)
+
+        desc('list SUBCOMMAND ...ARGS', 'Manage lists')
+        subcommand('list', List)
+
+        desc('recipient SUBCOMMAND ...ARGS', 'Manage recipients')
+        subcommand('recipint', Recipient)
+
+        desc('reserved SUBCOMMAND ...ARGS', 'Manage reserved fields')
+        subcommand('reserved', ReservedField)
+
+        desc('segment SUBCOMMAND ...ARGS', 'Manage segments')
+        subcommand('segment', Segment)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/campaign/contact/custom_field.rb

@@ -0,0 +1,42 @@
+module SendGrid4r::CLI
+  module Campaign
+    module Contact
+      #
+      # SendGrid Web API v3 Marketing Campaigns
+      #
+      class CustomField < SgThor
+        desc 'create', 'Create a custom field'
+        option :name, require: true
+        option :type, require: true
+        def create
+          puts @client.post_custom_field(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'list', 'List custom fields'
+        def list
+          puts @client.get_custom_fields
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'get', 'Get a custom field'
+        option :custom_field_id, require: true
+        def get
+          puts @client.get_custom_field(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'delete', 'Delete a custom field'
+        option :custom_field_id, require: true
+        def delete
+          puts @client.delete_custom_field(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/campaign/contact/list.rb

@@ -0,0 +1,71 @@
+module SendGrid4r::CLI
+  module Campaign
+    module Contact
+      #
+      # SendGrid Web API v3 Marketing Campaigns - List
+      #
+      class List < SgThor
+        desc 'create', 'Create a list'
+        option :name, require: true
+        def create
+          puts @client.post_list(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'list', 'List lists'
+        def list
+          puts @client.get_lists
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'get', 'Get a list'
+        option :list_id, type: :numeric, require: true
+        def get
+          puts @client.get_list(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'rename', 'Rename a list'
+        option :list_id, type: :numeric, require: true
+        option :name
+        def rename
+          puts @client.patch_list(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'delete', 'Delete lists'
+        option :list_ids, type: :array, require: true
+        def delete
+          puts @client.delete_lists(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'recipient', 'Add, Remove, List a recipient'
+        option :list_id, type: :numeric, require: true
+        option :recipients, type: :array, desc: 'for add action'
+        option :recipient_id, desc: 'for remove action'
+        option :page, type: :numeric, desc: 'for list action'
+        option :page_size, type: :numeric, desc: 'for list action'
+        def recipient(action)
+          case action
+          when 'add'
+            puts @client.post_recipients_to_list(parameterise(options))
+          when 'remove'
+            puts @client.delete_recipient_from_list(parameterise(options))
+          when 'list'
+            puts @client.get_recipients_from_list(parameterise(options))
+          else
+            puts "error: #{action} is not supported in action parameter"
+          end
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/cli/campaign/contact/recipient.rb

@@ -0,0 +1,78 @@
+module SendGrid4r::CLI
+  module Campaign
+    module Contact
+      #
+      # SendGrid Web API v3 Marketing Campaigns - Recipient
+      #
+      class Recipient < SgThor
+        desc 'create', 'Create a recipient'
+        option :params, type: :hash, require: true
+        def create
+          puts @client.post_recipients(
+            params: [parameterise(options[:params])]
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'update', 'Update a recipient'
+        option :params, type: :hash, require: true
+        def update
+          puts @client.patch_recipients(
+            params: [parameterise(options[:params])]
+          )
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'delete', 'Delete recipients'
+        option :recipient_ids, type: :array, require: true
+        def delete
+          puts @client.delete_recipients(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'list', 'List recipients'
+        option :page
+        option :page_size
+        def list
+          puts @client.get_recipients(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'get', 'Get a recipient'
+        option :recipient_id, require: true
+        def get
+          puts @client.get_recipient(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'count', 'Get recipients count'
+        def count
+          puts @client.get_recipients_count
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'search', 'Search recipients'
+        option :params, type: :hash, require: true
+        def search
+          puts @client.search_recipients(params: options[:params])
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+
+        desc 'belong', 'List lists a recipient belongs to'
+        option :recipient_id, require: true
+        def belong
+          puts @client.get_lists_recipient_belong(parameterise(options))
+        rescue RestClient::ExceptionWithResponse => e
+          puts e.inspect
+        end
+      end
+    end
+  end
+end