sendgrid4r 1.8.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a3b5f08893c6357875c03762c4a6a674f812cf1
-  data.tar.gz: 4b6f9b1a2661a880d52625c6286b30829c6dff63
+  metadata.gz: e26da8c2d562f33c4745134539a4cd52eab206a7
+  data.tar.gz: 5625dabfb3c35a7caa4cd56245c2cca645498633
 SHA512:
-  metadata.gz: 586c11ea85418575c8e5a3421cacbe5f85f1f7d9521040006f38e8549e1c3b5fee1f014d032491877b8261b696c3ad1b71015bf353afd7ea348d2284a92028b9
-  data.tar.gz: 89c62cbb80bf983d366e737c75bacdf42ff4b837a395fcb89717097d67811f282aef6ebb3e5196336ddf63702920ae7bf93fed698bd61c60f3c422411439aa63
+  metadata.gz: 9590d767b8b961ddb477e403426fd552191f801c4ffbefb92854c245469f10c3a328ae9a580575b5b44b439e894cb18afdd44b649ed40c8fd5f83eecee6fb9b4
+  data.tar.gz: b51a20b262ca15afd06406514ef0d7355a8c19c41e007a8a1e55eee2ed5e441e6bd0b5f1ba13753182533d963a642903aebaab0dfc983f6b76e8463fe250cffe

data/.rubocop.yml

@@ -9,7 +9,7 @@ MethodLength:
 
 # Change limitation of module length
 ModuleLength:
-  Max: 300
+  Max: 600
 
 # Change limitation of the number of params
 ParameterLists:
@@ -18,8 +18,12 @@ ParameterLists:
 
 # Change limitation of AbcSize
 AbcSize:
-  Max: 21
+  Max: 22
 
 # Change numeric literals
 NumericLiterals:
   MinDigits: 20
+
+# Disable force module and class style
+ClassAndModuleChildren:
+  Enabled: false

data/README.md

@@ -4,6 +4,7 @@ This gem allows you to quickly and easily access to SendGrid Web API v3 for Ruby
 See [api reference](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) for more detail
 
 [![Build Status](https://travis-ci.org/awwa/sendgrid4r.svg?branch=master)](https://travis-ci.org/awwa/sendgrid4r)
+[![Gem Version](https://badge.fury.io/rb/sendgrid4r.svg)](https://badge.fury.io/rb/sendgrid4r)
 
 # [Documentation](https://github.com/awwa/sendgrid4r/wiki)
 

data/lib/sendgrid4r/factory/campaign_factory.rb

@@ -10,16 +10,29 @@ module SendGrid4r
         segment_ids: nil, categories: nil, suppression_group_id: nil,
         custom_unsubscribe_url: nil, ip_pool: nil, html_content: nil,
         plain_content: nil)
-        segment = SendGrid4r::REST::Campaigns::Campaigns::Campaign.new(
+        campaign = REST::MarketingCampaigns::Campaign.new(
           nil, title, subject, sender_id, list_ids, segment_ids, categories,
           suppression_group_id, custom_unsubscribe_url, ip_pool, html_content,
           plain_content, nil, nil
         )
-        hash = segment.to_h
-        segment.to_h.each do |key, value|
-          hash.delete(key) if value.nil?
+        campaign.to_h.reject { |_key, value| value.nil? }
+      end
+
+      def create_sender(
+        nickname:, from:, reply_to:, address:, address_2:, city:, state:,
+        zip:, country:
+      )
+        REST::MarketingCampaigns::Sender.new(
+          nil, nickname, nil, nil, address, address_2,
+          city, state, zip, country, nil, nil, nil, nil
+        ).tap do |sender|
+          sender.from = from
+          sender.reply_to = reply_to
         end
-        hash
+      end
+
+      def create_address(email:, name:)
+        REST::MarketingCampaigns::Address.new(email, name)
       end
     end
   end

data/lib/sendgrid4r/factory/condition_factory.rb

@@ -7,7 +7,7 @@ module SendGrid4r
     #
     class ConditionFactory
       def create(field:, value:, operator:, and_or:)
-        SendGrid4r::REST::Contacts::Segments::Condition.new(
+        REST::MarketingCampaigns::Contacts::Segments::Condition.new(
           field,
           value,
           operator,

data/lib/sendgrid4r/factory/mail_factory.rb

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r
+  module Factory
+    #
+    # SendGrid Web API v3 MailFactory implementation
+    #
+    module MailFactory
+      def self.create_params(
+        personalizations:, from:, subject:, content:
+      )
+        SendGrid4r::REST::Mail::Params.new(
+          nil, nil, nil, nil, nil, nil, nil, nil, nil, nil,
+          nil, nil, nil, nil, nil, nil, nil
+        ).tap do |params|
+          params.personalizations = personalizations
+          params.from = from
+          params.content = content
+          params.subject = subject
+        end
+      end
+
+      def self.create_address(email:, name: nil)
+        SendGrid4r::REST::Mail::Address.new(email, name)
+      end
+
+      def self.create_personalization(to:)
+        SendGrid4r::REST::Mail::Personalization.new(
+          nil, nil, nil, nil, nil, nil, nil, nil
+        ).tap do |personalization|
+          personalization.to = to
+        end
+      end
+
+      def self.create_attachment(content:, filename:)
+        SendGrid4r::REST::Mail::Attachment.new(
+          nil, nil, nil, nil, nil
+        ).tap do |attachment|
+          attachment.content = content
+          attachment.filename = filename
+        end
+      end
+
+      def self.create_mail_settings
+        SendGrid4r::REST::Mail::MailSettings.new(nil, nil, nil, nil, nil)
+      end
+
+      def self.create_tracking_settings
+        SendGrid4r::REST::Mail::TrackingSettings.new(nil, nil, nil, nil)
+      end
+
+      def self.create_content(type:, value:)
+        SendGrid4r::REST::Mail::Content.new(type, value)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/factory/segment_factory.rb

@@ -7,17 +7,14 @@ module SendGrid4r
     #
     class SegmentFactory
       def create(name: nil, list_id: nil, conditions:)
-        segment = SendGrid4r::REST::Contacts::Segments::Segment.new(
+        segment = REST::MarketingCampaigns::Contacts::Segments::Segment.new(
           nil,
           name,
           list_id,
           conditions,
           nil
         )
-        hash = segment.to_h
-        hash.delete(:id)
-        hash.delete(:list_id) if list_id.nil?
-        hash
+        segment.to_h.reject { |_key, value| value.nil? }
       end
     end
   end

data/lib/sendgrid4r/factory/version_factory.rb

@@ -9,7 +9,7 @@ module SendGrid4r
       def create(
         name:, subject: '<%subject%>',
         html_content: '<%body%>', plain_content: '<%body%>', active: 1)
-        SendGrid4r::REST::Templates::Versions::Version.new(
+        REST::TransactionalTemplates::Versions::Version.new(
           nil,
           nil,
           nil,

data/lib/sendgrid4r/rest/api.rb

@@ -1,53 +1,52 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    #
-    # SendGrid Web API v3
-    #
-    module API
-      include SendGrid4r::REST::Templates
-      include SendGrid4r::REST::Templates::Versions
-      include SendGrid4r::REST::Sm
-      include SendGrid4r::REST::Sm::Groups
-      include SendGrid4r::REST::Sm::Suppressions
-      include SendGrid4r::REST::Sm::GlobalUnsubscribes
-      include SendGrid4r::REST::Settings
-      include SendGrid4r::REST::Settings::EnforcedTls
-      include SendGrid4r::REST::Settings::Mail
-      include SendGrid4r::REST::Settings::Partner
-      include SendGrid4r::REST::Settings::Tracking
-      include SendGrid4r::REST::Ips::Addresses
-      include SendGrid4r::REST::Ips::Warmup
-      include SendGrid4r::REST::Ips::Pools
-      include SendGrid4r::REST::Categories::Categories
-      include SendGrid4r::REST::Stats::Global
-      include SendGrid4r::REST::Stats::Category
-      include SendGrid4r::REST::Stats::Subuser
-      include SendGrid4r::REST::Stats::Advanced
-      include SendGrid4r::REST::Stats::Parse
-      include SendGrid4r::REST::Contacts::CustomFields
-      include SendGrid4r::REST::Contacts::Lists
-      include SendGrid4r::REST::Contacts::Recipients
-      include SendGrid4r::REST::Contacts::ReservedFields
-      include SendGrid4r::REST::Contacts::Segments
-      include SendGrid4r::REST::Campaigns::Campaigns
-      include SendGrid4r::REST::ApiKeys
-      include SendGrid4r::REST::ApiKeys::Permissions
-      include SendGrid4r::REST::Subusers
-      include SendGrid4r::REST::EmailActivity
-      include SendGrid4r::REST::Whitelabel::Domains
-      include SendGrid4r::REST::Whitelabel::Ips
-      include SendGrid4r::REST::Whitelabel::Links
-      include SendGrid4r::REST::Users
-      include SendGrid4r::REST::Bounces
-      include SendGrid4r::REST::Blocks
-      include SendGrid4r::REST::InvalidEmails
-      include SendGrid4r::REST::SpamReports
-      include SendGrid4r::REST::CancelScheduledSends
-      include SendGrid4r::REST::Webhooks::Event
-      include SendGrid4r::REST::Webhooks::Parse
-      include SendGrid4r::REST::IpAccessManagement
-    end
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3
+  #
+  module API
+    include SendGrid4r::REST::TransactionalTemplates
+    include SendGrid4r::REST::TransactionalTemplates::Versions
+    include SendGrid4r::REST::Sm
+    include SendGrid4r::REST::Sm::Groups
+    include SendGrid4r::REST::Sm::Suppressions
+    include SendGrid4r::REST::Sm::GlobalUnsubscribes
+    include SendGrid4r::REST::Settings
+    include SendGrid4r::REST::Settings::EnforcedTls
+    include SendGrid4r::REST::Settings::Mail
+    include SendGrid4r::REST::Settings::Partner
+    include SendGrid4r::REST::Settings::Tracking
+    include SendGrid4r::REST::Ips::Addresses
+    include SendGrid4r::REST::Ips::Warmup
+    include SendGrid4r::REST::Ips::Pools
+    include SendGrid4r::REST::Categories
+    include SendGrid4r::REST::Stats::Global
+    include SendGrid4r::REST::Stats::Category
+    include SendGrid4r::REST::Stats::Subuser
+    include SendGrid4r::REST::Stats::Advanced
+    include SendGrid4r::REST::Stats::Parse
+    include SendGrid4r::REST::MarketingCampaigns
+    include SendGrid4r::REST::MarketingCampaigns::Contacts::CustomFields
+    include SendGrid4r::REST::MarketingCampaigns::Contacts::Lists
+    include SendGrid4r::REST::MarketingCampaigns::Contacts::Recipients
+    include SendGrid4r::REST::MarketingCampaigns::Contacts::ReservedFields
+    include SendGrid4r::REST::MarketingCampaigns::Contacts::Segments
+    include SendGrid4r::REST::ApiKeysManagement
+    include SendGrid4r::REST::ApiKeysManagement::Permissions
+    include SendGrid4r::REST::Subusers
+    include SendGrid4r::REST::EmailActivity
+    include SendGrid4r::REST::Whitelabel::Domains
+    include SendGrid4r::REST::Whitelabel::Ips
+    include SendGrid4r::REST::Whitelabel::Links
+    include SendGrid4r::REST::Users
+    include SendGrid4r::REST::Bounces
+    include SendGrid4r::REST::Blocks
+    include SendGrid4r::REST::InvalidEmails
+    include SendGrid4r::REST::SpamReports
+    include SendGrid4r::REST::CancelScheduledSends
+    include SendGrid4r::REST::Webhooks::Event
+    include SendGrid4r::REST::Webhooks::Parse
+    include SendGrid4r::REST::IpAccessManagement
+    include SendGrid4r::REST::Mail
   end
 end

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

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 ApiKeysManagement
+  #
+  module ApiKeysManagement
+    include Request
+
+    ApiKeys = Struct.new(:result)
+    ApiKey = Struct.new(:name, :api_key_id, :api_key, :scopes)
+
+    def self.url(api_key_id = nil)
+      url = "#{BASE_URL}/api_keys"
+      url = "#{url}/#{api_key_id}" unless api_key_id.nil?
+      url
+    end
+
+    def self.create_api_keys(resp)
+      return resp if resp.nil?
+      api_keys = resp['result'].map do |api_key|
+        ApiKeysManagement.create_api_key(api_key)
+      end
+      ApiKeys.new(api_keys)
+    end
+
+    def self.create_api_key(resp)
+      return resp if resp.nil?
+      ApiKey.new(
+        resp['name'],
+        resp['api_key_id'],
+        resp['api_key'],
+        resp['scopes']
+      )
+    end
+
+    def get_api_keys(&block)
+      resp = get(@auth, ApiKeysManagement.url, &block)
+      ApiKeysManagement.create_api_keys(resp)
+    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)
+    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)
+    end
+
+    def delete_api_key(api_key_id:, &block)
+      delete(@auth, ApiKeysManagement.url(api_key_id), &block)
+    end
+
+    def patch_api_key(api_key_id:, name:, &block)
+      params = { name: name }
+      endpoint = ApiKeysManagement.url(api_key_id)
+      resp = patch(@auth, endpoint, params, &block)
+      ApiKeysManagement.create_api_key(resp)
+    end
+
+    def put_api_key(api_key_id:, name:, scopes:, &block)
+      params = {}
+      params[:name] = name unless name.nil?
+      params[:scopes] = scopes unless scopes.nil?
+      endpoint = ApiKeysManagement.url(api_key_id)
+      resp = put(@auth, endpoint, params, &block)
+      ApiKeysManagement.create_api_key(resp)
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 ApiKeysManagement
+  #
+  module ApiKeysManagement
+    #
+    # SendGrid Web API v3 ApiKeysManagement Permissions
+    #
+    module Permissions
+      include Request
+
+      Permissions = Struct.new(:scopes)
+
+      def self.url
+        "#{BASE_URL}/scopes"
+      end
+
+      def self.create_permissions(resp)
+        return resp if resp.nil?
+        Permissions.new(resp['scopes'])
+      end
+
+      def get_permissions(&block)
+        resp = get(@auth, ApiKeysManagement::Permissions.url, &block)
+        ApiKeysManagement::Permissions.create_permissions(resp)
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/blocks.rb

@@ -1,80 +1,61 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    #
-    # SendGrid Web API v3 Blocks
-    #
-    module Blocks
-      include SendGrid4r::REST::Request
-
-      Block = Struct.new(
-        :created, :email, :reason, :status
-      )
-
-      def self.url(email = nil)
-        url = "#{BASE_URL}/suppression/blocks"
-        url = "#{url}/#{email}" unless email.nil?
-        url
-      end
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Blocks
+  #
+  module Blocks
+    include Request
+
+    Block = Struct.new(:created, :email, :reason, :status)
+
+    def self.url(email = nil)
+      url = "#{BASE_URL}/suppression/blocks"
+      url = "#{url}/#{email}" unless email.nil?
+      url
+    end
 
-      def self.create_blocks(resp)
-        return resp if resp.nil?
-        blocks = []
-        resp.each do |block|
-          blocks.push(SendGrid4r::REST::Blocks.create_block(block))
-        end
-        blocks
-      end
+    def self.create_blocks(resp)
+      return resp if resp.nil?
+      resp.map { |block| Blocks.create_block(block) }
+    end
 
-      def self.create_block(resp)
-        return resp if resp.nil?
-        created = Time.at(resp['created']) unless resp['created'].nil?
-        Block.new(
-          created,
-          resp['email'],
-          resp['reason'],
-          resp['status']
-        )
-      end
+    def self.create_block(resp)
+      return resp if resp.nil?
+      created = Time.at(resp['created']) unless resp['created'].nil?
+      Block.new(created, resp['email'], resp['reason'], resp['status'])
+    end
 
-      def get_blocks(
-        start_time: nil, end_time: nil, limit: nil, offset: nil, &block
-      )
-        params = {}
-        params['start_time'] = start_time.to_i unless start_time.nil?
-        params['end_time'] = end_time.to_i unless end_time.nil?
-        params['limit'] = limit.to_i unless limit.nil?
-        params['offset'] = offset.to_i unless offset.nil?
-        resp = get(@auth, SendGrid4r::REST::Blocks.url, params, &block)
-        SendGrid4r::REST::Blocks.create_blocks(resp)
-      end
+    def get_blocks(
+      start_time: nil, end_time: nil, limit: nil, offset: nil, &block
+    )
+      params = {}
+      params[:start_time] = start_time.to_i unless start_time.nil?
+      params[:end_time] = end_time.to_i unless end_time.nil?
+      params[:limit] = limit.to_i unless limit.nil?
+      params[:offset] = offset.to_i unless offset.nil?
+      resp = get(@auth, Blocks.url, params, &block)
+      Blocks.create_blocks(resp)
+    end
 
-      def delete_blocks(delete_all: nil, emails: nil, &block)
-        endpoint = SendGrid4r::REST::Blocks.url
-        payload = {}
-        if delete_all == true
-          payload['delete_all'] = delete_all
-        else
-          payload['emails'] = emails
-        end
-        delete(@auth, endpoint, nil, payload, &block)
+    def delete_blocks(delete_all: nil, emails: nil, &block)
+      if delete_all
+        payload = { delete_all: delete_all }
+      else
+        payload = { emails: emails }
       end
+      delete(@auth, Blocks.url, nil, payload, &block)
+    end
 
-      def get_block(email:, &block)
-        endpoint = SendGrid4r::REST::Blocks.url(email)
-        params = {}
-        params['email'] = email
-        resp = get(@auth, endpoint, params, &block)
-        SendGrid4r::REST::Blocks.create_blocks(resp)
-      end
+    def get_block(email:, &block)
+      params = { email: email }
+      resp = get(@auth, Blocks.url(email), params, &block)
+      Blocks.create_blocks(resp)
+    end
 
-      def delete_block(email:, &block)
-        endpoint = SendGrid4r::REST::Blocks.url(email)
-        params = {}
-        params['email'] = email
-        delete(@auth, endpoint, params, &block)
-      end
+    def delete_block(email:, &block)
+      params = { email: email }
+      delete(@auth, Blocks.url(email), params, &block)
     end
   end
 end

data/lib/sendgrid4r/rest/bounces.rb

@@ -1,76 +1,57 @@
 # -*- encoding: utf-8 -*-
 
-module SendGrid4r
-  module REST
-    #
-    # SendGrid Web API v3 Subusers
-    #
-    module Bounces
-      include SendGrid4r::REST::Request
-
-      Bounce = Struct.new(
-        :created, :email, :reason, :status
-      )
-
-      def self.url(email = nil)
-        url = "#{BASE_URL}/suppression/bounces"
-        url = "#{url}/#{email}" unless email.nil?
-        url
-      end
+module SendGrid4r::REST
+  #
+  # SendGrid Web API v3 Subusers
+  #
+  module Bounces
+    include Request
+
+    Bounce = Struct.new(:created, :email, :reason, :status)
+
+    def self.url(email = nil)
+      url = "#{BASE_URL}/suppression/bounces"
+      url = "#{url}/#{email}" unless email.nil?
+      url
+    end
 
-      def self.create_bounces(resp)
-        return resp if resp.nil?
-        bounces = []
-        resp.each do |bounce|
-          bounces.push(SendGrid4r::REST::Bounces.create_bounce(bounce))
-        end
-        bounces
-      end
+    def self.create_bounces(resp)
+      return resp if resp.nil?
+      resp.map { |bounce| Bounces.create_bounce(bounce) }
+    end
 
-      def self.create_bounce(resp)
-        return resp if resp.nil?
-        created = Time.at(resp['created']) unless resp['created'].nil?
-        Bounce.new(
-          created,
-          resp['email'],
-          resp['reason'],
-          resp['status']
-        )
-      end
+    def self.create_bounce(resp)
+      return resp if resp.nil?
+      created = Time.at(resp['created']) unless resp['created'].nil?
+      Bounce.new(created, resp['email'], resp['reason'], resp['status'])
+    end
 
-      def get_bounces(start_time: nil, end_time: nil, &block)
-        params = {}
-        params['start_time'] = start_time.to_i unless start_time.nil?
-        params['end_time'] = end_time.to_i unless end_time.nil?
-        resp = get(@auth, SendGrid4r::REST::Bounces.url, params, &block)
-        SendGrid4r::REST::Bounces.create_bounces(resp)
-      end
+    def get_bounces(start_time: nil, end_time: nil, &block)
+      params = {}
+      params[:start_time] = start_time.to_i unless start_time.nil?
+      params[:end_time] = end_time.to_i unless end_time.nil?
+      resp = get(@auth, Bounces.url, params, &block)
+      Bounces.create_bounces(resp)
+    end
 
-      def delete_bounces(delete_all: nil, emails: nil, &block)
-        endpoint = SendGrid4r::REST::Bounces.url
-        payload = {}
-        if delete_all == true
-          payload['delete_all'] = delete_all
-        else
-          payload['emails'] = emails
-        end
-        delete(@auth, endpoint, nil, payload, &block)
+    def delete_bounces(delete_all: nil, emails: nil, &block)
+      if delete_all
+        payload = { delete_all: delete_all }
+      else
+        payload = { emails: emails }
       end
+      delete(@auth, Bounces.url, nil, payload, &block)
+    end
 
-      def get_bounce(email:, &block)
-        endpoint = SendGrid4r::REST::Bounces.url(email)
-        params = {}
-        params['email'] = email
-        resp = get(@auth, endpoint, params, &block)
-        SendGrid4r::REST::Bounces.create_bounces(resp)
-      end
+    def get_bounce(email:, &block)
+      params = { email: email }
+      resp = get(@auth, Bounces.url(email), params, &block)
+      Bounces.create_bounces(resp)
+    end
 
-      def delete_bounce(email:, &block)
-        endpoint = SendGrid4r::REST::Bounces.url(email)
-        params = {}
-        params['email'] = email
-        delete(@auth, endpoint, params, &block)
-      end
+    def delete_bounce(email:, &block)
+      params = { email: email }
+      delete(@auth, Bounces.url(email), params, &block)
     end
   end
 end