drip-ruby 3.2.0 → 3.4.2

data/lib/drip/client/accounts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Accounts
@@ -6,7 +8,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#accounts
       def accounts
-        get "accounts"
+        make_json_api_request :get, "v2/accounts"
       end
 
       # Public: Fetch an account.
@@ -16,7 +18,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#accounts
       def account(id)
-        get "accounts/#{id}"
+        make_json_api_request :get, "v2/accounts/#{id}"
       end
     end
   end

data/lib/drip/client/broadcasts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Broadcasts
@@ -12,7 +14,7 @@ module Drip
       # Returns a Drip::Response
       # See https://www.getdrip.com/docs/rest-api#broadcasts
       def broadcasts(options = {})
-        get "#{account_id}/broadcasts", options
+        make_json_api_request :get, "v2/#{account_id}/broadcasts", options
       end
 
       # Public: Fetch a broadcast.
@@ -22,7 +24,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#broadcasts
       def broadcast(id)
-        get "#{account_id}/broadcasts/#{id}"
+        make_json_api_request :get, "v2/#{account_id}/broadcasts/#{id}"
       end
     end
   end

data/lib/drip/client/campaign_subscriptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module CampaignSubscriptions
@@ -8,7 +10,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs.rest-api#campaign_subscriptions
       def campaign_subscriptions(subscriber_id)
-        get "#{account_id}/subscribers/#{subscriber_id}/campaign_subscriptions"
+        make_json_api_request :get, "v2/#{account_id}/subscribers/#{subscriber_id}/campaign_subscriptions"
       end
     end
   end

data/lib/drip/client/campaigns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Campaigns
@@ -14,7 +16,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs.rest-api#campaigns
       def campaigns(options = {})
-        get "#{account_id}/campaigns", options
+        make_json_api_request :get, "v2/#{account_id}/campaigns", options
       end
 
       # Public: Fetch a campaign.
@@ -24,7 +26,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#campaigns
       def campaign(id)
-        get "#{account_id}/campaigns/#{id}"
+        make_json_api_request :get, "v2/#{account_id}/campaigns/#{id}"
       end
 
       # Public: Activate a campaign.
@@ -34,7 +36,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#campaigns
       def activate_campaign(id)
-        post "#{account_id}/campaigns/#{id}/activate"
+        make_json_api_request :post, "v2/#{account_id}/campaigns/#{id}/activate"
       end
 
       # Public: Pause a campaign.
@@ -44,7 +46,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#campaigns
       def pause_campaign(id)
-        post "#{account_id}/campaigns/#{id}/pause"
+        make_json_api_request :post, "v2/#{account_id}/campaigns/#{id}/pause"
       end
 
       # Public: List everyone subscribed to a campaign.
@@ -68,7 +70,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#campaigns
       def campaign_subscribers(id, options = {})
-        get "#{account_id}/campaigns/#{id}/subscribers", options
+        make_json_api_request :get, "v2/#{account_id}/campaigns/#{id}/subscribers", options
       end
     end
   end

data/lib/drip/client/configuration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Drip
+  class Client
+    class Configuration
+      DEFAULT_URL_PREFIX = "https://api.getdrip.com/"
+      private_constant :DEFAULT_URL_PREFIX
+
+      CONFIGURATION_FIELDS = %i[access_token api_key account_id url_prefix http_open_timeout http_timeout].freeze
+
+      attr_accessor(*CONFIGURATION_FIELDS)
+
+      def initialize(**options)
+        remainder = options.keys - CONFIGURATION_FIELDS
+        raise ArgumentError, "unknown keyword#{'s' if remainder.size > 1}: #{remainder.join(', ')}" unless remainder.empty?
+
+        # Initialize this variable to suppress Ruby warning.
+        @url_prefix = nil
+
+        options.each do |k, v|
+          public_send("#{k}=", v)
+        end
+      end
+
+      def url_prefix
+        @url_prefix || DEFAULT_URL_PREFIX
+      end
+    end
+  end
+end

data/lib/drip/client/conversions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Conversions
@@ -10,7 +12,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#conversions
       def conversions(options = {})
-        get "#{account_id}/goals", options
+        make_json_api_request :get, "v2/#{account_id}/goals", options
       end
 
       # Public: Fetch a conversion.
@@ -20,7 +22,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#conversions
       def conversion(id)
-        get "#{account_id}/goals/#{id}"
+        make_json_api_request :get, "v2/#{account_id}/goals/#{id}"
       end
     end
   end

data/lib/drip/client/custom_fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module CustomFields
@@ -6,7 +8,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#custom_fields
       def custom_fields
-        get "#{account_id}/custom_field_identifiers"
+        make_json_api_request :get, "v2/#{account_id}/custom_field_identifiers"
       end
     end
   end

data/lib/drip/client/events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Events
@@ -14,7 +16,7 @@ module Drip
       # See https://www.getdrip.com/docs/rest-api#record_event
       def track_event(email, action, properties = {}, options = {})
         data = options.merge({ "email" => email, "action" => action, "properties" => properties })
-        post "#{account_id}/events", generate_resource("events", data)
+        make_json_api_request :post, "v2/#{account_id}/events", private_generate_resource("events", data)
       end
 
       # Public: Track a collection of events all at once.
@@ -27,8 +29,8 @@ module Drip
       # 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 })
+        url = "v2/#{account_id}/events/batches"
+        make_json_api_request :post, url, private_generate_resource("batches", { "events" => events })
       end
 
       # Public: Fetch all custom event actions.
@@ -41,7 +43,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#events
       def event_actions(options = {})
-        get "#{account_id}/event_actions", options
+        make_json_api_request :get, "v2/#{account_id}/event_actions", options
       end
     end
   end

data/lib/drip/client/forms.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Forms
@@ -6,7 +8,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#forms
       def forms
-        get "#{account_id}/forms"
+        make_json_api_request :get, "v2/#{account_id}/forms"
       end
 
       # Public: Fetch a form.
@@ -16,7 +18,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#forms
       def form(id)
-        get "#{account_id}/forms/#{id}"
+        make_json_api_request :get, "v2/#{account_id}/forms/#{id}"
       end
     end
   end

data/lib/drip/client/http_client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Drip
+  class Client
+    class HTTPClient
+      REDIRECT_LIMIT = 10
+      private_constant :REDIRECT_LIMIT
+
+      def initialize(config)
+        @config = config
+      end
+
+      def make_request(drip_request, redirected_url: nil, step: 0)
+        raise TooManyRedirectsError, 'too many HTTP redirects' if step >= REDIRECT_LIMIT
+
+        uri = redirected_url || drip_request.url.tap do |orig_url|
+          next if drip_request.http_verb != :get
+
+          orig_url.query = URI.encode_www_form(drip_request.options)
+        end
+
+        response = Net::HTTP.start(uri.host, uri.port, connection_options(uri.scheme)) do |http|
+          request = drip_request.verb_klass.new uri
+          request.body = drip_request.body
+
+          add_standard_headers(request)
+          request['Content-Type'] = drip_request.content_type
+
+          http.request request
+        end
+
+        return make_request(drip_request, redirected_url: URI(response["Location"]), step: step + 1) if response.is_a?(Net::HTTPRedirection)
+
+        response
+      end
+
+    private
+
+      def add_standard_headers(request)
+        request['User-Agent'] = "Drip Ruby v#{Drip::VERSION}"
+        request['Accept'] = "*/*"
+
+        if @config.access_token
+          request['Authorization'] = "Bearer #{@config.access_token}"
+        else
+          request.basic_auth @config.api_key, ""
+        end
+
+        request
+      end
+
+      def connection_options(uri_scheme)
+        options = { use_ssl: uri_scheme == "https" }
+
+        if @config.http_open_timeout
+          options[:open_timeout] = @config.http_open_timeout
+          options[:ssl_timeout] = @config.http_open_timeout
+        end
+
+        options[:read_timeout] = @config.http_timeout if @config.http_timeout
+
+        options
+      end
+    end
+  end
+end

data/lib/drip/client/orders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Drip
   class Client
     module Orders
@@ -11,7 +13,7 @@ module Drip
       # See https://developer.drip.com/#orders
       def create_or_update_order(email, options = {})
         data = options.merge(email: email)
-        post "#{account_id}/orders", generate_resource("orders", data)
+        make_json_api_request :post, "v2/#{account_id}/orders", private_generate_resource("orders", data)
       end
 
       # Public: Create or update a batch of orders.
@@ -21,7 +23,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://developer.drip.com/#create-or-update-a-batch-of-orders
       def create_or_update_orders(orders)
-        post "#{account_id}/orders/batches", generate_resource("batches", { "orders" => orders })
+        make_json_api_request :post, "v2/#{account_id}/orders/batches", private_generate_resource("batches", { "orders" => orders })
       end
 
       # Public: Create or update a refund.
@@ -38,7 +40,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://developer.drip.com/#create-or-update-a-refund
       def create_or_update_refund(options)
-        post "#{account_id}/refunds", generate_resource("refunds", options)
+        make_json_api_request :post, "v2/#{account_id}/refunds", private_generate_resource("refunds", options)
       end
     end
   end

data/lib/drip/client/shopper_activity.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Drip
+  class Client
+    module ShopperActivity
+      # Public: Create a cart activity event.
+      #
+      # options    - Required. A Hash of additional cart options. Refer to the
+      #                       Drip API docs for the required schema.
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#cart-activity
+      def create_cart_activity_event(data = {})
+        raise ArgumentError, 'email:, person_id:, or :visitor_uuid parameter required' if !data.key?(:email) && !data.key?(:person_id) && !data.key?(:visitor_uuid)
+
+        %i[provider action cart_id cart_url].each do |key|
+          raise ArgumentError, "#{key}: parameter required" unless data.key?(key)
+        end
+
+        data[:occurred_at] = Time.now.iso8601 unless data.key?(:occurred_at)
+        make_json_request :post, "v3/#{account_id}/shopper_activity/cart", data
+      end
+
+      # Public: Create an order activity event.
+      #
+      # options    - Required. A Hash of additional order options. Refer to the
+      #                       Drip API docs for the required schema.
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#order-activity
+      def create_order_activity_event(data = {})
+        raise ArgumentError, 'email: or person_id: parameter required' if !data.key?(:email) && !data.key?(:person_id)
+
+        %i[provider action order_id].each do |key|
+          raise ArgumentError, "#{key}: parameter required" unless data.key?(key)
+        end
+
+        data[:occurred_at] = Time.now.iso8601 unless data.key?(:occurred_at)
+        make_json_request :post, "v3/#{account_id}/shopper_activity/order", data
+      end
+
+      # Public: Create a batch of order activity events.
+      #
+      # records    - Required. An array of hashes containing orders attributes.
+      #                       Refer to the Drip API docs for the required schema.
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#create-or-update-a-batch-of-orders
+      def create_order_activity_events(records = [])
+        records.each_with_index do |record, i|
+          raise ArgumentError, "email: or person_id: parameter required in record #{i}" if !record.key?(:email) && !record.key?(:person_id)
+
+          %i[provider action order_id].each do |key|
+            raise ArgumentError, "#{key}: parameter required in record #{i}" unless record.key?(key)
+          end
+
+          record[:occurred_at] = Time.now.iso8601 unless record.key?(:occurred_at)
+        end
+
+        make_json_request :post, "v3/#{account_id}/shopper_activity/order/batch", { orders: records }
+      end
+
+      # Public: Create a product activity event.
+      #
+      # options    - Required. A Hash of additional product options. Refer to the
+      #                       Drip API docs for the required schema.
+      #
+      # Returns a Drip::Response.
+      # See https://developer.drip.com/#product-activity
+      def create_product_activity_event(data = {})
+        %i[provider action product_id name price].each do |key|
+          raise ArgumentError, "#{key}: parameter required" unless data.key?(key)
+        end
+
+        data[:occurred_at] = Time.now.iso8601 unless data.key?(:occurred_at)
+        make_json_request :post, "v3/#{account_id}/shopper_activity/product", data
+      end
+    end
+  end
+end

data/lib/drip/client/subscribers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "cgi"
 
 module Drip
@@ -16,7 +18,7 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#list_subscribers
       def subscribers(options = {})
-        get "#{account_id}/subscribers", options
+        make_json_api_request :get, "v2/#{account_id}/subscribers", options
       end
 
       # Public: Fetch a subscriber.
@@ -26,15 +28,17 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#fetch_subscriber
       def subscriber(id_or_email)
-        get "#{account_id}/subscribers/#{CGI.escape id_or_email}"
+        make_json_api_request :get, "v2/#{account_id}/subscribers/#{CGI.escape id_or_email}"
       end
 
       # Public: Create or update a subscriber.
       #
       # email   - Optional. The String subscriber email address. (Deprecated in favor of a hash argument)
       # options - A Hash of options.
-      #           - email         - Required (or id). Lookup the subscriber by email.
-      #           - id            - Required (or email). Lookup the subscriber by Drip ID.
+      #           - email         - Required (or id, or bigcommerce_subscriber_id).
+      #                             Lookup the subscriber by email.
+      #           - id            - Required (or email, or bigcommerce_subscriber_id).
+      #                             Lookup the subscriber by Drip ID.
       #           - 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
@@ -43,6 +47,9 @@ module Drip
       #                             format). Defaults to Etc/UTC.
       #           - custom_fields - Optional. A Hash of custom field data.
       #           - tags          - Optional. An Array of tags.
+      #           - external_ids  - Optional. A hash of relevant ids for other integrations.
+      #                             For unsubscribing BigCommerce subscribers, a bigcommerce_subscriber_id
+      #                             can be provided in external_ids rather than email or id as the required field.
       #
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#create_or_update_subscriber
@@ -50,8 +57,8 @@ module Drip
         data = {}
         data[:email] = args[0] if args[0].is_a? String
         data.merge!(args.last) if args.last.is_a? Hash
-        raise ArgumentError, 'email: or id: parameter required' if !data.key?(:email) && !data.key?(:id)
-        post "#{account_id}/subscribers", generate_resource("subscribers", data)
+        raise ArgumentError, 'email: or id: or bigcommerce_subscriber_id: parameter required' if missing_subscriber_identifier(data)
+        make_json_api_request :post, "v2/#{account_id}/subscribers", private_generate_resource("subscribers", data)
       end
 
       # Public: Create or update a collection of subscribers.
@@ -70,8 +77,8 @@ module Drip
       # 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 })
+        url = "v2/#{account_id}/subscribers/batches"
+        make_json_api_request :post, url, private_generate_resource("batches", { "subscribers" => subscribers })
       end
 
       # Public: Unsubscribe a collection of subscribers.
@@ -82,8 +89,8 @@ module Drip
       # Returns a Drip::Response
       # See https://www.getdrip.com/docs/rest-api#subscriber_batches
       def unsubscribe_subscribers(subscribers)
-        url = "#{account_id}/unsubscribes/batches"
-        post url, generate_resource("batches", { "subscribers" => subscribers })
+        url = "v2/#{account_id}/unsubscribes/batches"
+        make_json_api_request :post, url, private_generate_resource("batches", { "subscribers" => subscribers })
       end
 
       # Public: Unsubscribe a subscriber globally or from a specific campaign.
@@ -96,9 +103,9 @@ module Drip
       # Returns a Drip::Response.
       # See https://www.getdrip.com/docs/rest-api#unsubscribe
       def unsubscribe(id_or_email, options = {})
-        url = "#{account_id}/subscribers/#{CGI.escape id_or_email}/remove"
+        url = "v2/#{account_id}/subscribers/#{CGI.escape id_or_email}/remove"
         url += options[:campaign_id] ? "?campaign_id=#{options[:campaign_id]}" : ""
-        post url
+        make_json_api_request :post, url
       end
 
       # Public: Subscribe to a campaign.
@@ -126,8 +133,8 @@ module Drip
       # See https://www.getdrip.com/docs/rest-api#subscribe
       def subscribe(email, campaign_id, options = {})
         data = options.merge("email" => email)
-        url = "#{account_id}/campaigns/#{campaign_id}/subscribers"
-        post url, generate_resource("subscribers", data)
+        url = "v2/#{account_id}/campaigns/#{campaign_id}/subscribers"
+        make_json_api_request :post, url, private_generate_resource("subscribers", data)
       end
 
       # Public: Delete a subscriber.
@@ -137,7 +144,7 @@ module Drip
       # Returns No Content.
       # See https://www.getdrip.com/docs/rest-api#fdelete_subscriber
       def delete_subscriber(id_or_email)
-        delete "#{account_id}/subscribers/#{CGI.escape id_or_email}"
+        make_json_api_request :delete, "v2/#{account_id}/subscribers/#{CGI.escape id_or_email}"
       end
 
       # Public: Unsubscribe a subscriber from all mailings.
@@ -147,8 +154,15 @@ module Drip
       # Returns No Content.
       # See https://www.getdrip.com/docs/rest-api#fdelete_subscriber
       def unsubscribe_from_all(id_or_email)
-        post "#{account_id}/subscribers/#{CGI.escape id_or_email}/unsubscribe_all"
+        make_json_api_request :post, "v2/#{account_id}/subscribers/#{CGI.escape id_or_email}/unsubscribe_all"
       end
     end
+
+  private
+
+    def missing_subscriber_identifier(data)
+      external_ids = data[:external_ids] || {}
+      !data.key?(:email) && !data.key?(:id) && !external_ids.key?("bigcommerce_subscriber_id")
+    end
   end
 end