Merge pull request #25 from untitledstartup/gmartini/BAN-8680-add-bulk-remove-tag-from-subscriber

Gmartini/ban 8680 add bulk remove tag from subscriber

Author: gmartinimighty

lib/convertkit.rb

@@ -19,9 +19,11 @@
 require 'convertkit/resources/sequence_response'
 require 'convertkit/resources/sequences'
 require 'convertkit/resources/subscriber_response'
+require 'convertkit/resources/subscriber_bulk_add_tag_response'
 require 'convertkit/resources/subscriber_bulk_create_response'
 require 'convertkit/resources/subscriber_bulk_create_failure_response'
-require 'convertkit/resources/subscriber_bulk_tag_response'
+require 'convertkit/resources/subscriber_bulk_remove_tag_response'
+require 'convertkit/resources/subscriber_bulk_tag_failure_response'
 require 'convertkit/resources/subscribers'
 require 'convertkit/resources/subscribers_response'
 require 'convertkit/resources/subscription_response'

…esources/subscriber_bulk_tag_response.rb …rces/subscriber_bulk_add_tag_response.rblib/convertkit/resources/subscriber_bulk_tag_response.rb renamed to lib/convertkit/resources/subscriber_bulk_add_tag_response.rb lib/convertkit/resources/subscriber_bulk_tag_response.rb renamed to lib/convertkit/resources/subscriber_bulk_add_tag_response.rb

@@ -1,6 +1,6 @@
 module ConvertKit
   module Resources
-    class SubscriberBulkTagResponse
+    class SubscriberBulkAddTagResponse
       attr_accessor :subscribers, :failures
 
       def initialize(response)
@@ -9,7 +9,7 @@ def initialize(response)
         end
 
         @failures = response['failures'].map do |failure|
-          ConvertKit::Resources::SubscriberBulkCreateFailureResponse.new(failure)
+          ConvertKit::Resources::SubscriberBulkTagFailureResponse.new(failure)
         end
       end
     end

lib/convertkit/resources/subscriber_bulk_remove_tag_response.rb

@@ -0,0 +1,13 @@
+module ConvertKit
+  module Resources
+    class SubscriberBulkRemoveTagResponse
+      attr_accessor :failures
+
+      def initialize(response)
+        @failures = response['failures'].map do |failure|
+          ConvertKit::Resources::SubscriberBulkTagFailureResponse.new(failure)
+        end
+      end
+    end
+  end
+end

lib/convertkit/resources/subscriber_bulk_tag_failure_response.rb

@@ -0,0 +1,12 @@
+module ConvertKit
+  module Resources
+    class SubscriberBulkTagFailureResponse
+      attr_accessor :subscriber, :errors
+
+      def initialize(response)
+        @subscriber = SubscriberResponse.new(response['subscriber']) if response['subscriber']
+        @errors = response['errors']
+      end
+    end
+  end
+end

lib/convertkit/resources/tags.rb

@@ -97,16 +97,28 @@ def subscriptions(tag_id, options = {})
         SubscriptionsResponse.new(response)
       end
 
-      # Bulk tag subscribers
+      # Bulk add tag to subscribers
       # @param [Array<Hash>] taggings
       # @option taggings [String] :tag_id
       # @option taggings [String] :subscriber_id
-      def bulk_tag_subscribers(taggings = [])
+      def bulk_add_to_subscribers(taggings = [])
         raise ArgumentError, 'taggings must be an array' unless taggings.is_a?(Array)
 
         response = @client.post("bulk/#{PATH}/subscribers", { taggings: taggings })
 
-        ConvertKit::Resources::SubscriberBulkTagResponse.new(response)
+        ConvertKit::Resources::SubscriberBulkAddTagResponse.new(response)
+      end
+
+      # Bulk remove tag from subscribers
+      # @param [Array<Hash>] taggings
+      # @option taggings [String] :tag_id
+      # @option taggings [String] :subscriber_id
+      def bulk_remove_from_subscribers(taggings = [])
+        raise ArgumentError, 'taggings must be an array' unless taggings.is_a?(Array)
+
+        response = @client.delete("bulk/#{PATH}/subscribers", { taggings: taggings })
+
+        ConvertKit::Resources::SubscriberBulkRemoveTagResponse.new(response)
       end
     end
   end

spec/lib/convertkit/resources/tags_spec.rb

@@ -143,7 +143,7 @@
     end
   end
 
-  describe '#bulk_tag_subscribers' do
+  describe '#bulk_add_to_subscribers' do
     let(:tags) { ConvertKit::Resources::Tags.new(client) }
     let(:taggings) { [{'tag_id' => 1, 'subscriber_id' => 1}] }
     let(:response) do
@@ -163,9 +163,81 @@
       it 'tags listed subscribers' do
         expect(client).to receive(:post).with('bulk/tags/subscribers', {taggings: taggings}).and_return(response)
 
-        tags_response = tags.bulk_tag_subscribers(taggings)
+        tags_response = tags.bulk_add_to_subscribers(taggings)
         validate_tagged_subscribers(tags_response, response)
       end
     end
+
+    # Failures are not well documented in the API documentation
+    context 'with failures' do
+      let(:response) do
+        {
+          'subscribers' => [],
+          'failures' => [{
+            'subscriber' => {
+              'id' => 1,
+              'first_name' => 'foo',
+              'email_address' => 'foo@bar.com',
+              'created_at' => '2023-08-09T04:30:00Z',
+            },
+            'errors' => ['Test error message']
+          }]
+        }
+      end
+
+      it 'return failures with subscriber and error message' do
+        expect(client).to receive(:post).with('bulk/tags/subscribers', {taggings: taggings}).and_return(response)
+
+        tags_response = tags.bulk_add_to_subscribers(taggings)
+        expect(tags_response.failures.count).to eq(1)
+        expect(tags_response.failures.first.subscriber.id).to eq(1)
+        expect(tags_response.failures.first.errors.first).to eq('Test error message')
+      end
+    end
+  end
+
+  describe '#bulk_remove_from_subscribers' do
+    let(:tags) { ConvertKit::Resources::Tags.new(client) }
+    let(:taggings) { [{'tag_id' => 1, 'subscriber_id' => 1}] }
+    let(:response) do
+      {
+        'failures' => []
+      }
+    end
+
+    context 'with taggings provided' do
+      it 'return no failures' do
+        expect(client).to receive(:delete).with('bulk/tags/subscribers', {taggings: taggings}).and_return(response)
+
+        tags_response = tags.bulk_remove_from_subscribers(taggings)
+        expect(tags_response.failures).to be_empty
+      end
+    end
+
+    # Failures are not well documented in the API documentation
+    context 'with failures' do
+      let(:response) do
+        {
+          'failures' => [{
+            'subscriber' => {
+              'id' => 1,
+              'first_name' => 'foo',
+              'email_address' => 'foo@bar.com',
+              'created_at' => '2023-08-09T04:30:00Z',
+            },
+            'errors' => ['Test error message']
+          }]
+        }
+      end
+
+      it 'return failures with subscriber and error message' do
+        expect(client).to receive(:delete).with('bulk/tags/subscribers', {taggings: taggings}).and_return(response)
+
+        tags_response = tags.bulk_remove_from_subscribers(taggings)
+        expect(tags_response.failures.count).to eq(1)
+        expect(tags_response.failures.first.subscriber.id).to eq(1)
+        expect(tags_response.failures.first.errors.first).to eq('Test error message')
+      end
+    end
   end
 end