sendgrid4r 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58d9fe109c54eb51bf889602332007cf01cee0b0
-  data.tar.gz: 432030e7df5cdd4bac8c6c37aa2c851d4c812d62
+  metadata.gz: 5d7f4961aa315c9383c28064b91f827b5649cca5
+  data.tar.gz: 97bcf08a8000e314ac46d0641078112bb83eeb2e
 SHA512:
-  metadata.gz: d1bf3eb32ea9f95972cf026a6aace7671e57f33c85e49a678b662dd8aca66b96a3b98ff5587404acf50cb8d613f086cb8f5886631383423ba95c09bb8c2236e6
-  data.tar.gz: 6d0eb5696b42f4e81074a061f4029fdeb7aee8e18351c094b6d62c8d0b8a61a5aa9c52dc28e98cf199e0bce94607bff729305fafbbbb93a2b683e6002935983a
+  metadata.gz: 764e730d5f55c68eb2b1d9269b16b50419040f023ffc1e316842fa83607ea4f9f2333a72027318b136f8c0571a741b544a7d3840b6ced14c38172658b30b3c8d
+  data.tar.gz: ccf33b5cb94663a33d54b49cf21b5fed12f4a180ce208b6f78c2938a227907518d57770c7c4da73fcc9a6e0a46ad33341127f41c14180f9de6beb1b65455446f

data/.rubocop.yml

@@ -10,7 +10,7 @@ MethodLength:
 # Change limitation of the number of params
 ParameterLists:
   Max: 8
-  CountKeywordArgs: true
+  CountKeywordArgs: false
 
 # Change limitation of AbcSize
 AbcSize:

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - "2.1"
+  - "2.2"
 before_script:
   - bundle install
 script:

data/lib/client.rb

@@ -6,6 +6,7 @@ require 'sendgrid4r/rest/api'
 require 'sendgrid4r/factory/version_factory'
 require 'sendgrid4r/factory/condition_factory'
 require 'sendgrid4r/factory/segment_factory'
+require 'sendgrid4r/factory/campaign_factory'
 
 module SendGrid4r
   #

data/lib/sendgrid4r/factory/campaign_factory.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+module SendGrid4r
+  module Factory
+    #
+    # SendGrid Web API v3 Campaign Factory Class implementation
+    #
+    class CampaignFactory
+      def create(title: nil, subject: nil, sender_id: nil, list_ids: nil,
+        segment_ids: nil, categories: nil, suppression_group_id: nil,
+        html_content: nil, plain_content: nil)
+        segment = SendGrid4r::REST::Campaigns::Campaigns::Campaign.new(
+          nil, title, subject, sender_id, list_ids, segment_ids, categories,
+          suppression_group_id, html_content, plain_content, nil, nil
+        )
+        hash = segment.to_h
+        segment.to_h.each do |key, value|
+          hash.delete(key) if value.nil?
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/sendgrid4r/factory/segment_factory.rb

@@ -7,14 +7,18 @@ module SendGrid4r
     # SendGrid Web API v3 Segment Factory Class implementation
     #
     class SegmentFactory
-      def create(name:, conditions:)
-        SendGrid4r::REST::Contacts::Segments::Segment.new(
+      def create(name: nil, list_id: nil, conditions:)
+        segment = SendGrid4r::REST::Contacts::Segments::Segment.new(
           nil,
           name,
-          nil,
+          list_id,
           conditions,
           nil
-        ).to_h
+        )
+        hash = segment.to_h
+        hash.delete(:id)
+        hash.delete(:list_id) if list_id.nil?
+        hash
       end
     end
   end

data/lib/sendgrid4r/rest/api.rb

@@ -27,6 +27,7 @@ require 'sendgrid4r/rest/contacts/lists'
 require 'sendgrid4r/rest/contacts/recipients'
 require 'sendgrid4r/rest/contacts/reserved_fields'
 require 'sendgrid4r/rest/contacts/segments'
+require 'sendgrid4r/rest/campaigns/campaigns'
 require 'sendgrid4r/rest/api_keys/api_keys'
 require 'sendgrid4r/rest/subusers/subusers'
 require 'sendgrid4r/rest/email_activity/email_activity'
@@ -66,6 +67,7 @@ module SendGrid4r
       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::Subusers
       include SendGrid4r::REST::EmailActivity

data/lib/sendgrid4r/rest/campaigns/campaigns.rb

@@ -0,0 +1,128 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'sendgrid4r/rest/request'
+
+module SendGrid4r
+  module REST
+    module Campaigns
+      #
+      # SendGrid Web API v3 Campaigns - Campaigns
+      #
+      module Campaigns
+        include SendGrid4r::REST::Request
+
+        Campaign = Struct.new(
+          :id, :title, :subject, :sender_id, :list_ids, :segment_ids,
+          :categories, :suppression_group_id, :html_content,
+          :plain_content, :send_at, :status
+        )
+
+        Campaigns = Struct.new(:result)
+
+        def self.create_campaign(resp)
+          return resp if resp.nil?
+          send_at = Time.at(resp['send_at']) unless resp['send_at'].nil?
+          Campaign.new(
+            resp['id'], resp['title'], resp['subject'], resp['sender_id'],
+            resp['list_ids'], resp['segment_ids'], resp['categories'],
+            resp['suppression_group_id'], resp['html_content'],
+            resp['plain_content'], send_at, resp['status']
+          )
+        end
+
+        def self.create_campaigns(resp)
+          return resp if resp.nil?
+          result = []
+          resp['result'].each do |campaign|
+            result.push(
+              SendGrid4r::REST::Campaigns::Campaigns.create_campaign(campaign)
+            )
+          end
+          Campaigns.new(result)
+        end
+
+        def self.url(campaign_id = nil)
+          url = "#{BASE_URL}/campaigns"
+          url = "#{url}/#{campaign_id}" unless campaign_id.nil?
+          url
+        end
+
+        def post_campaign(params:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url
+          resp = post(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def get_campaigns(&block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaigns(resp)
+        end
+
+        def get_campaign(campaign_id:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def delete_campaign(campaign_id:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          delete(@auth, endpoint, &block)
+        end
+
+        def patch_campaign(campaign_id:, params:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          resp = patch(@auth, endpoint, params.to_h, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def send_campaign(campaign_id:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          endpoint = "#{endpoint}/schedules/now"
+          resp = post(@auth, endpoint, nil, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def schedule_campaign(campaign_id:, send_at:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          endpoint = "#{endpoint}/schedules"
+          payload = {}
+          payload['send_at'] = send_at.to_i
+          resp = post(@auth, endpoint, payload, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def reschedule_campaign(campaign_id:, send_at:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          endpoint = "#{endpoint}/schedules"
+          payload = {}
+          payload['send_at'] = send_at.to_i
+          resp = patch(@auth, endpoint, payload, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def get_schedule_time_campaign(campaign_id:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          endpoint = "#{endpoint}/schedules"
+          resp = get(@auth, endpoint, &block)
+          SendGrid4r::REST::Campaigns::Campaigns.create_campaign(resp)
+        end
+
+        def unschedule_campaign(campaign_id:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          endpoint = "#{endpoint}/schedules"
+          delete(@auth, endpoint, &block)
+        end
+
+        def test_campaign(campaign_id:, to:, &block)
+          endpoint = SendGrid4r::REST::Campaigns::Campaigns.url(campaign_id)
+          endpoint = "#{endpoint}/schedules/test"
+          payload = {}
+          payload['to'] = to
+          post(@auth, endpoint, payload, &block)
+        end
+      end
+    end
+  end
+end

data/lib/sendgrid4r/rest/contacts/lists.rb

@@ -77,14 +77,16 @@ module SendGrid4r
         # no bodies returned
         def post_recipients_to_list(list_id:, recipients:, &block)
           url = SendGrid4r::REST::Contacts::Lists.url(list_id)
-          endpoint = "#{url}/recipients_batch"
+          endpoint = "#{url}/recipients"
           post(@auth, endpoint, recipients, &block)
         end
 
-        def get_recipients_from_list(list_id:, limit: nil, offset: nil, &block)
+        def get_recipients_from_list(
+          list_id:, page: nil, page_size: nil, &block
+        )
           params = {}
-          params['limit'] = limit unless limit.nil?
-          params['offset'] = offset unless offset.nil?
+          params['page'] = page unless page.nil?
+          params['page_size'] = page_size unless page_size.nil?
           endpoint = SendGrid4r::REST::Contacts::Lists.recipients_url(list_id)
           resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
@@ -105,7 +107,7 @@ module SendGrid4r
         end
 
         def delete_lists(list_ids:, &block)
-          endpoint = "#{BASE_URL}/contactdb/lists_batch"
+          endpoint = "#{BASE_URL}/contactdb/lists"
           delete(@auth, endpoint, nil, list_ids, &block)
         end
       end

data/lib/sendgrid4r/rest/contacts/recipients.rb

@@ -44,7 +44,7 @@ module SendGrid4r
             resp['last_clicked'],
             resp['last_emailed'],
             resp['last_name'],
-            resp['last_opend'],
+            resp['last_opened'],
             Time.at(resp['updated_at'])
           )
         end
@@ -66,40 +66,28 @@ module SendGrid4r
           url
         end
 
-        def post_recipient(params:, &block)
+        def post_recipients(params:, &block)
           endpoint = SendGrid4r::REST::Contacts::Recipients.url
           resp = post(@auth, endpoint, params, &block)
-          SendGrid4r::REST::Contacts::Recipients.create_recipient(resp)
+          SendGrid4r::REST::Contacts::Recipients.create_result(resp)
         end
 
-        def delete_recipients(emails:, &block)
+        def patch_recipients(params:, &block)
           endpoint = SendGrid4r::REST::Contacts::Recipients.url
-          delete(@auth, endpoint, nil, emails, &block)
+          resp = patch(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Contacts::Recipients.create_result(resp)
         end
 
-        def get_recipients(limit: nil, offset: nil, &block)
-          params = {}
-          params['limit'] = limit unless limit.nil?
-          params['offset'] = offset unless offset.nil?
+        def delete_recipients(recipient_ids:, &block)
           endpoint = SendGrid4r::REST::Contacts::Recipients.url
-          resp = get(@auth, endpoint, params, &block)
-          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
-        end
-
-        def get_recipients_by_id(recipient_ids:, &block)
-          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/batch"
-          resp = get(@auth, endpoint, nil, recipient_ids, &block)
-          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
-        end
-
-        def get_recipients_count(&block)
-          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/count"
-          resp = get(@auth, endpoint, &block)
-          resp['recipient_count'] unless resp.nil?
+          delete(@auth, endpoint, nil, recipient_ids, &block)
         end
 
-        def search_recipients(params:, &block)
-          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/search"
+        def get_recipients(page: nil, page_size: nil, &block)
+          params = {}
+          params['page_size'] = page_size unless page_size.nil?
+          params['page'] = page unless page.nil?
+          endpoint = SendGrid4r::REST::Contacts::Recipients.url
           resp = get(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
@@ -124,13 +112,19 @@ module SendGrid4r
           SendGrid4r::REST::Contacts::Lists.create_lists(resp)
         end
 
-        def post_recipients(recipients:, &block)
-          endpoint = "#{BASE_URL}/contactdb/recipients_batch"
-          resp = post(@auth, endpoint, recipients, &block)
-          SendGrid4r::REST::Contacts::Recipients.create_result(resp)
+        def get_recipients_count(&block)
+          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/count"
+          resp = get(@auth, endpoint, &block)
+          resp['recipient_count'] unless resp.nil?
+        end
+
+        def search_recipients(params:, &block)
+          endpoint = "#{SendGrid4r::REST::Contacts::Recipients.url}/search"
+          resp = get(@auth, endpoint, params, &block)
+          SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
 
-        ResultAddMultiple = Struct.new(
+        Result = Struct.new(
           :error_count,
           :error_indices,
           :new_count,
@@ -148,7 +142,7 @@ module SendGrid4r
           resp['persisted_recipients'].each do |value|
             persisted_recipients.push(value)
           end
-          ResultAddMultiple.new(
+          Result.new(
             resp['error_count'],
             error_indices,
             resp['new_count'],

data/lib/sendgrid4r/rest/contacts/segments.rb

@@ -78,9 +78,9 @@ module SendGrid4r
           SendGrid4r::REST::Contacts::Segments.create_segment(resp)
         end
 
-        def put_segment(segment_id:, params:, &block)
+        def patch_segment(segment_id:, params:, &block)
           endpoint = SendGrid4r::REST::Contacts::Segments.url(segment_id)
-          resp = put(@auth, endpoint, params, &block)
+          resp = patch(@auth, endpoint, params, &block)
           SendGrid4r::REST::Contacts::Segments.create_segment(resp)
         end
 
@@ -89,14 +89,9 @@ module SendGrid4r
           delete(@auth, endpoint, &block)
         end
 
-        def get_recipients_from_segment(
-          segment_id:, limit: nil, offset: nil, &block
-        )
-          params = {}
-          params['limit'] = limit unless limit.nil?
-          params['offset'] = offset unless offset.nil?
+        def get_recipients_on_segment(segment_id:, &block)
           url = SendGrid4r::REST::Contacts::Segments.url(segment_id)
-          resp = get(@auth, "#{url}/recipients", params, &block)
+          resp = get(@auth, "#{url}/recipients", nil, &block)
           SendGrid4r::REST::Contacts::Recipients.create_recipients(resp)
         end
       end

data/lib/sendgrid4r/rest/request.rb

@@ -53,6 +53,9 @@ module SendGrid4r
         args[:url] = process_url_params(endpoint, params)
         headers = {}
         headers[:content_type] = :json
+        # Added for Campaign API
+        headers['Accept-Encoding'] = 'plain'
+        #
         if !auth.api_key.nil?
           headers[:authorization] = "Bearer #{auth.api_key}"
         else

data/lib/sendgrid4r/version.rb

@@ -2,5 +2,5 @@
 # SendGrid API v3 wrapper implementation.
 #
 module SendGrid4r
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/client_spec.rb

@@ -183,25 +183,38 @@ describe SendGrid4r::Client do
         expect(@client.respond_to?('delete_recipient_from_list')).to eq(true)
         expect(@client.respond_to?('delete_lists')).to eq(true)
         # Recipients
-        expect(@client.respond_to?('post_recipient')).to eq(true)
+        expect(@client.respond_to?('post_recipients')).to eq(true)
+        expect(@client.respond_to?('patch_recipients')).to eq(true)
         expect(@client.respond_to?('delete_recipients')).to eq(true)
         expect(@client.respond_to?('get_recipients')).to eq(true)
-        expect(@client.respond_to?('get_recipients_by_id')).to eq(true)
-        expect(@client.respond_to?('get_recipients_count')).to eq(true)
-        expect(@client.respond_to?('search_recipients')).to eq(true)
         expect(@client.respond_to?('get_recipient')).to eq(true)
         expect(@client.respond_to?('delete_recipient')).to eq(true)
         expect(@client.respond_to?('get_lists_recipient_belong')).to eq(true)
-        expect(@client.respond_to?('post_recipients')).to eq(true)
+        expect(@client.respond_to?('get_recipients_count')).to eq(true)
+        expect(@client.respond_to?('search_recipients')).to eq(true)
         # ReservedFields
         expect(@client.respond_to?('get_reserved_fields')).to eq(true)
         # Segments
         expect(@client.respond_to?('post_segment')).to eq(true)
         expect(@client.respond_to?('get_segments')).to eq(true)
         expect(@client.respond_to?('get_segment')).to eq(true)
-        expect(@client.respond_to?('put_segment')).to eq(true)
+        expect(@client.respond_to?('patch_segment')).to eq(true)
         expect(@client.respond_to?('delete_segment')).to eq(true)
-        expect(@client.respond_to?('get_recipients_from_segment')).to eq(true)
+        expect(@client.respond_to?('get_recipients_on_segment')).to eq(true)
+
+        # Campaigns
+        expect(@client.respond_to?('post_campaign')).to eq(true)
+        expect(@client.respond_to?('get_campaigns')).to eq(true)
+        expect(@client.respond_to?('get_campaign')).to eq(true)
+        expect(@client.respond_to?('delete_campaign')).to eq(true)
+        expect(@client.respond_to?('patch_campaign')).to eq(true)
+        expect(@client.respond_to?('send_campaign')).to eq(true)
+        expect(@client.respond_to?('schedule_campaign')).to eq(true)
+        expect(@client.respond_to?('schedule_campaign')).to eq(true)
+        expect(@client.respond_to?('reschedule_campaign')).to eq(true)
+        expect(@client.respond_to?('get_schedule_time_campaign')).to eq(true)
+        expect(@client.respond_to?('unschedule_campaign')).to eq(true)
+        expect(@client.respond_to?('test_campaign')).to eq(true)
 
         # Whitelabel
         # Domains
@@ -245,7 +258,7 @@ describe SendGrid4r::Client do
 
     describe 'VERSION' do
       it 'returns VERSION value' do
-        expect(SendGrid4r::VERSION).to eq('1.1.0')
+        expect(SendGrid4r::VERSION).to eq('1.2.0')
       end
     end
   end

data/spec/factory/campaign_factory_spec.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe SendGrid4r::Factory::CampaignFactory do
+  describe 'unit test', :ut do
+    before do
+      Dotenv.load
+      @campaign_factory = SendGrid4r::Factory::CampaignFactory.new
+    end
+
+    it 'specify all params' do
+      campaign = @campaign_factory.create(
+        title: 'March Newsletter',
+        subject: 'New Products for Spring!',
+        sender_id: 124451,
+        list_ids: [110, 124],
+        segment_ids: [110],
+        categories: ['spring line'],
+        suppression_group_id: 42,
+        html_content: '<html><head><title></title></head><body>'\
+          '<p>Check out our spring line!</p></body></html>',
+        plain_content: 'Check out our spring line!'
+      )
+      @expect = {}
+      @expect[:title] = 'March Newsletter'
+      @expect[:subject] = 'New Products for Spring!'
+      @expect[:sender_id] = 124451
+      @expect[:list_ids] = [110, 124]
+      @expect[:segment_ids] = [110]
+      @expect[:categories] = ['spring line']
+      @expect[:suppression_group_id] = 42
+      @expect[:html_content] = '<html><head><title></title></head><body>'\
+        '<p>Check out our spring line!</p></body></html>'
+      @expect[:plain_content] = 'Check out our spring line!'
+      expect(campaign).to eq(@expect)
+    end
+  end
+end

data/spec/factory/segment_factory_spec.rb

@@ -13,9 +13,7 @@ describe SendGrid4r::Factory::SegmentFactory do
         operator: 'eq',
         and_or: '')
       @expect = {}
-      @expect[:id] = nil
       @expect[:name] = 'Last Name Miller'
-      @expect[:list_id] = nil
       @expect[:conditions] = [@condition]
       @expect[:recipient_count] = nil
     end