Merge pull request #13 from DripEmail/add_batch_operations

Added subscriber and event batch methods

Author: derrickreimer

README.md

@@ -6,7 +6,7 @@ A Ruby toolkit for the [Drip](https://www.getdrip.com/) API.
 
 Add this line to your application's Gemfile:
 
-    gem 'drip-ruby', :require => 'drip' 
+    gem 'drip-ruby', :require => 'drip'
 
 And then execute:
 
@@ -46,12 +46,14 @@ as methods on the client object. The following methods are currently available:
 | Action                     | Method                                               |
 | :------------------------- | :--------------------------------------------------- |
 | Create/update a subscriber | `#create_or_update_subscriber(email, options = {})`  |
+| Create/update a batch of subscribers | `#create_or_update_subscribers(subscribers)` |
 | Fetch a subscriber         | `#subscriber(id_or_email)`                           |
 | Subscribe to a campaign    | `#subscribe(email, campaign_id, options = {})`       |
 | Unsubscribe                | `#unsubscribe(id_or_email, options = {})`            |
 | Apply a tag                | `#apply_tag(email, tag)`                             |
 | Remove a tag               | `#remove_tag(email, tag)`                            |
 | Track an event             | `#track_event(email, action, properties = {})`       |
+| Track a batch of events    | `#track_events(events)`                              |
 
 
 **Note:** We do not have complete API coverage yet. If we are missing an API method

lib/drip/client/events.rb

@@ -15,6 +15,20 @@ def track_event(email, action, properties = {})
         data = { "email" => email, "action" => action, "properties" => properties }
         post "#{account_id}/events", generate_resource("events", data)
       end
+
+      # Public: Track a collection of events all at once.
+      #
+      # events - Required. An Array of between 1 and 1000 Hashes of event data.
+      #          - email      - Required. The String email address of the subscriber.
+      #          - action     - Required. The String event action.
+      #          - properties - Optional. A Hash of event properties.
+      #
+      # Returns a Drip::Response.
+      # See https://www.getdrip.com/docs/rest-api#event_batches
+      def track_events(events)
+        url = "#{account_id}/events/batches"
+        post url, generate_resource("batches", { "events" => events })
+      end
     end
   end
 end

lib/drip/client/subscribers.rb

@@ -33,6 +33,26 @@ def create_or_update_subscriber(email, options = {})
         post "#{account_id}/subscribers", generate_resource("subscribers", data)
       end
 
+      # Public: Create or update a collection of subscribers.
+      #
+      # subscribers - Required. An Array of between 1 and 1000 Hashes of subscriber data.
+      #               - email         - Required. The String subscriber email address.
+      #               - new_email     - Optional. A new email address for the subscriber.
+      #                                 If provided and a subscriber with the email above
+      #                                 does not exist, this address will be used to
+      #                                 create a new subscriber.
+      #               - time_zone     - Optional. The subscriber's time zone (in Olsen
+      #                                 format). Defaults to Etc/UTC.
+      #               - custom_fields - Optional. A Hash of custom field data.
+      #               - tags          - Optional. An Array of tags.
+      #
+      # Returns a Drip::Response
+      # See https://www.getdrip.com/docs/rest-api#subscriber_batches
+      def create_or_update_subscribers(subscribers)
+        url = "#{account_id}/subscribers/batches"
+        post url, generate_resource("batches", { "subscribers" => subscribers })
+      end
+
       # Public: Unsubscribe a subscriber globally or from a specific campaign.
       #
       # id_or_email - Required. The String id or email address of the subscriber.

test/drip/client/events_test.rb

@@ -39,4 +39,32 @@ def setup
       assert_equal expected, @client.track_event(@email, @action, @properties)
     end
   end
+
+  context "#track_events" do
+    setup do
+      @events = [
+        {
+          :email => "derrick@getdrip.com",
+          :action => "subscribed"
+        },
+        {
+          :email => "darin@getdrip.com",
+          :action => "unsubscribed"
+        }
+      ]
+
+      @payload = { "batches" => [ { "events" => @events } ] }.to_json
+      @response_status = 201
+      @response_body = stub
+
+      @stubs.post "12345/events/batches", @payload do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the right request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.track_events(@events)
+    end
+  end
 end

test/drip/client/subscribers_test.rb

@@ -50,6 +50,34 @@ def setup
     end
   end
 
+  context "#create_or_update_subscribers" do
+    setup do
+      @subscribers = [
+        {
+          :email => "derrick@getdrip.com",
+          :time_zone => "America/Los_Angeles"
+        },
+        {
+          :email => "darin@getdrip.com",
+          :time_zone => "America/Los_Angeles"
+        }
+      ]
+
+      @payload = { "batches" => [ { "subscribers" => @subscribers } ] }.to_json
+      @response_status = 201
+      @response_body = stub
+
+      @stubs.post "12345/subscribers/batches", @payload do
+        [@response_status, {}, @response_body]
+      end
+    end
+
+    should "send the right request" do
+      expected = Drip::Response.new(@response_status, @response_body)
+      assert_equal expected, @client.create_or_update_subscribers(@subscribers)
+    end
+  end
+
   context "#subscribe" do
     setup do
       @email = "derrick@getdrip.com"