drip-ruby 3.2.0 → 3.4.2

data/test/drip/client/subscribers_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../../test_helper.rb'
 
 class Drip::Client::SubscribersTest < Drip::TestCase
@@ -82,6 +84,12 @@ class Drip::Client::SubscribersTest < Drip::TestCase
       assert_equal expected, @client.create_or_update_subscriber(id: 123456)
       assert_requested :post, "https://api.getdrip.com/v2/12345/subscribers", body: '{"subscribers":[{"id":123456}]}', times: 1
     end
+
+    should "allow request with bigcommerce_subscriber_id keyword argument" do
+      expected = Drip::Response.new(@response_status, JSON.parse(@response_body))
+      assert_equal expected, @client.create_or_update_subscriber(external_ids: { "bigcommerce_subscriber_id" => "2" })
+      assert_requested :post, "https://api.getdrip.com/v2/12345/subscribers", body: '{"subscribers":[{"external_ids":{"bigcommerce_subscriber_id":"2"}}]}', times: 1
+    end
   end
 
   context "#create_or_update_subscribers" do

data/test/drip/client/tags_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../../test_helper.rb'
 
 class Drip::Client::TagsTest < Drip::TestCase

data/test/drip/client/users_test.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+class Drip::Client::UsersTest < Drip::TestCase
+  def setup
+    @client = Drip::Client.new { |c| c.account_id = "12345" }
+  end
+
+  context "#user" do
+    setup do
+      @response_status = 200
+      @response_body = "{}"
+
+      stub_request(:get, "https://api.getdrip.com/v2/user").
+        to_return(status: @response_status, body: @response_body, headers: {})
+    end
+
+    should "send the right request" do
+      expected = Drip::Response.new(@response_status, JSON.parse(@response_body))
+      assert_equal expected, @client.user
+    end
+  end
+end

data/test/drip/client/webhooks_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../../test_helper.rb'
 
 class Drip::Client::WebhooksTest < Drip::TestCase

data/test/drip/client/workflow_triggers_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../../test_helper.rb'
 
 class Drip::Client::WorkflowTriggersTest < Drip::TestCase

data/test/drip/client/workflows_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../../test_helper.rb'
 
 class Drip::Client::WorkflowsTest < Drip::TestCase

data/test/drip/client_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../test_helper.rb'
 require "base64"
 
@@ -19,11 +21,6 @@ class Drip::ClientTest < Drip::TestCase
       assert_equal "aaaa", client.url_prefix
     end
 
-    should "have default url prefix" do
-      client = Drip::Client.new
-      assert_equal "https://api.getdrip.com/v2/", client.url_prefix
-    end
-
     should "accept access token" do
       client = Drip::Client.new do |config|
         config.access_token = "aaaa"
@@ -55,36 +52,12 @@ class Drip::ClientTest < Drip::TestCase
       assert_equal 20, client.http_open_timeout
       assert_equal 25, client.http_timeout
     end
-  end
-
-  context "#generate_resource" do
-    setup do
-      @key = "subscribers"
-      @data = { "email" => "foo" }
-      @client = Drip::Client.new
-    end
-
-    should "return a JSON API payload" do
-      assert_equal({ @key => [@data] }, @client.generate_resource(@key, @data))
-    end
-  end
-
-  context "given a personal api key" do
-    setup do
-      @key = "aaaa"
-      @client = Drip::Client.new do |config|
-        config.api_key = @key
-      end
-    end
 
-    should "use Basic authentication" do
-      stub_request(:get, "https://api.getdrip.com/v2/testpath").
-        to_return(status: 200, body: "", headers: {})
-
-      @client.get("testpath")
-
-      header = "Basic #{Base64.encode64(@key + ':')}".strip
-      assert_requested :get, "https://api.getdrip.com/v2/testpath", headers: { 'Authorization' => header }
+    should "accept options after initialization" do
+      # Deprecated
+      client = Drip::Client.new
+      assert_output(nil, /^\[DEPRECATED\] Setting configuration/) { client.account_id = "12345" }
+      assert_equal "12345", client.account_id
     end
   end
 
@@ -98,6 +71,7 @@ class Drip::ClientTest < Drip::TestCase
 
     should "return objects" do
       stub_request(:get, "https://api.getdrip.com/v2/12345/subscribers/jdoe%40example.com").
+        with(headers: { "Content-Type" => "application/vnd.api+json" }).
         to_return(status: 200, body: "{\"links\":{\"subscribers.account\":\"https://api.getdrip.com/v2/accounts/{subscribers.account}\"},\"subscribers\":[{\"id\":\"randomid\",\"href\":\"https://api.getdrip.com/v2/1234/subscribers/randomid\",\"status\":\"active\",\"email\":\"jdoe@example.com\",\"time_zone\":null,\"utc_offset\":0,\"visitor_uuid\":null,\"custom_fields\":{\"first_name\":\"John\"},\"tags\":[\"customer\"],\"created_at\":\"2018-06-04T21:29:49Z\",\"ip_address\":null,\"user_agent\":null,\"lifetime_value\":null,\"original_referrer\":null,\"landing_url\":null,\"prospect\":null,\"base_lead_score\":null,\"eu_consent\":\"unknown\",\"lead_score\":null,\"user_id\":\"123\",\"links\":{\"account\":\"1234\"}}]}")
 
       response = @client.subscriber('jdoe@example.com')
@@ -120,85 +94,48 @@ class Drip::ClientTest < Drip::TestCase
       @client = Drip::Client.new do |config|
         config.api_key = @key
         config.url_prefix = @url_prefix
+        config.account_id = "12345"
       end
     end
 
-    should "connect to alternate prefix" do
-      stub_request(:get, "https://api.example.com/v9001/testpath").
+    should "connect to alternate prefix with prepended v2" do
+      stub_request(:get, "https://api.example.com/v9001/v2/12345/subscribers/blah").
         to_return(status: 200, body: "", headers: {})
-      @client.get("testpath")
+      @client.subscriber("blah")
 
-      assert_requested :get, "https://api.example.com/v9001/testpath"
+      assert_requested :get, "https://api.example.com/v9001/v2/12345/subscribers/blah"
     end
   end
 
-  context "given a OAuth access token" do
-    setup do
-      @key = "aaaa"
-      @client = Drip::Client.new do |config|
-        config.access_token = @key
-      end
-    end
-
-    should "use Bearer token authentication" do
-      stub_request(:get, "https://api.getdrip.com/v2/testpath").
-        to_return(status: 200, body: "", headers: {})
-      @client.get("testpath")
-      header = "Bearer #{@key}"
-      assert_requested :get, "https://api.getdrip.com/v2/testpath", headers: { 'Authorization' => header }
+  context "#generate_resource" do
+    # Deprecated
+    should "return a resource and note deprecation" do
+      client = Drip::Client.new
+      resource = nil
+      assert_output(nil, /^\[DEPRECATED\] Drip\:\:Client\#generate_resource is deprecated/) { resource = client.generate_resource("hello", {}) }
+      assert_equal({ "hello" => [{}] }, resource)
     end
   end
 
-  context "given a redirecting url" do
-    setup do
-      @client = Drip::Client.new
+  context "#content_type" do
+    # Deprecated
+    should "return default content type and print warning" do
+      client = Drip::Client.new
+      content_type = nil
+      assert_output(nil, /^\[DEPRECATED\] Drip\:\:Client\#content_type is deprecated/) { content_type = client.content_type }
+      assert_equal "application/vnd.api+json", content_type
     end
+  end
 
-    should "follow redirect" do
+  context "#get et all" do
+    # Deprecated
+    should "delegate with v2 and print deprecation warning" do
       stub_request(:get, "https://api.getdrip.com/v2/testpath").
-        to_return(status: 301, body: "", headers: { "Location" => "https://api.example.com/mytestpath" })
-      stub_request(:get, "https://api.example.com/mytestpath").
         to_return(status: 200, body: "{}")
-      response = @client.get("testpath")
-      assert_requested :get, "https://api.getdrip.com/v2/testpath"
-      assert_requested :get, "https://api.example.com/mytestpath"
-      assert_equal({}, response.body)
-    end
 
-    should "not follow too many redirects" do
-      stub_request(:get, "https://api.getdrip.com/v2/testpath").
-        to_return(status: 301, body: "", headers: { "Location" => "https://api.example.com/mytestpath" })
-      stub_request(:get, "https://api.example.com/mytestpath").
-        to_return(status: 302, body: "", headers: { "Location" => "https://api.getdrip.com/v2/testpath" })
-      assert_raises(Drip::TooManyRedirectsError) { @client.get("testpath") }
-      assert_requested :get, "https://api.getdrip.com/v2/testpath", times: 5
-      assert_requested :get, "https://api.example.com/mytestpath", times: 5
-    end
-  end
-
-  context "given a get request" do
-    setup do
-      @client = Drip::Client.new
-      @response = mock
-      @response.stubs(:code).returns('200')
-      @response.stubs(:body).returns('{}')
-
-      @http = mock
-      @http.expects(:request).returns(@response)
-
-      @request = mock
-      @request.stubs(:[]=)
-      @request.stubs(:basic_auth)
-    end
-
-    should "encode query and not set body" do
-      Net::HTTP::Get.expects(:new).returns(@request)
-      Net::HTTP.expects(:start).yields(@http).returns(@response)
-
-      @request.expects(:body=).never
-      URI.expects(:encode_www_form).once
-
-      response = @client.get("testpath")
+      client = Drip::Client.new
+      response = nil
+      assert_output(nil, /^\[DEPRECATED\] Drip\:\:Client\#get please use the API endpoint specific methods/) { response = client.get("testpath") }
       assert_equal({}, response.body)
     end
   end

data/test/drip/collection_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Drip::CollectionTest < Drip::TestCase
@@ -42,6 +44,19 @@ class Drip::CollectionTest < Drip::TestCase
     end
   end
 
+  context ".collection_name" do
+    should "return default value" do
+      assert_equal "resources", Drip::Collection.collection_name
+    end
+  end
+
+  context ".resource_name" do
+    should "return default value" do
+      assert_equal "resource", Drip::Collection.resource_name
+    end
+  end
+
+  # :nocov:
   class TestCollection < Drip::Collection
     def self.collection_name
       "subscribers"
@@ -51,4 +66,5 @@ class Drip::CollectionTest < Drip::TestCase
       "subscriber"
     end
   end
+  # :nocov:
 end

data/test/drip/collections/account_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/accounts"
+
+class Drip::AccountsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "account", Drip::Accounts.resource_name
+  end
+end

data/test/drip/collections/broadcasts_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/broadcasts"
+
+class Drip::BroadcastsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "broadcast", Drip::Broadcasts.resource_name
+  end
+end

data/test/drip/collections/campaign_subscriptions_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/campaign_subscriptions"
+
+class Drip::CampaignSubscriptionsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "campaign_subscription", Drip::CampaignSubscriptions.resource_name
+  end
+end

data/test/drip/collections/campaigns_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/campaigns"
+
+class Drip::CampaignsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "campaign", Drip::Campaigns.resource_name
+  end
+end

data/test/drip/collections/errors_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/errors"
+
+class Drip::ErrorsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "error", Drip::Errors.resource_name
+  end
+end

data/test/drip/collections/orders_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/orders"
+
+class Drip::OrdersTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "order", Drip::Orders.resource_name
+  end
+end

data/test/drip/collections/purchases_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/purchases"
+
+class Drip::PurchasesTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "purchase", Drip::Purchases.resource_name
+  end
+end

data/test/drip/collections/tags_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/tags"
+
+class Drip::TagsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "tag", Drip::Tags.resource_name
+  end
+end

data/test/drip/collections/webhooks_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/webhooks"
+
+class Drip::WebhooksTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "webhook", Drip::Webhooks.resource_name
+  end
+end

data/test/drip/collections/workflow_triggers_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/workflow_triggers"
+
+class Drip::WorkflowTriggersTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "workflow_trigger", Drip::WorkflowTriggers.resource_name
+  end
+end

data/test/drip/collections/workflows_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+require "drip/collections/workflows"
+
+class Drip::WorkflowsTest < Drip::TestCase
+  should "have a resource name" do
+    assert_equal "workflow", Drip::Workflows.resource_name
+  end
+end

data/test/drip/collections_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Drip::CollectionsTest < Drip::TestCase

data/test/drip/request_test.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../test_helper.rb'
+require "drip/request"
+
+class Drip::RequestTest < Drip::TestCase
+  context "basic data" do
+    should "pass through data" do
+      request = Drip::Request.new(:get, "https://www.example.com/blah", { hello: "world" }, "application/vnd.visio")
+      assert_equal :get, request.http_verb
+      assert_equal "https://www.example.com/blah", request.url
+      assert_equal({ hello: "world" }, request.options)
+      assert_equal "application/vnd.visio", request.content_type
+    end
+  end
+
+  context "#verb_klass" do
+    context "when a supported verb" do
+      setup do
+        @subject = Drip::Request.new(:get, "https://www.example.com/blah", { hello: "world" }, "application/vnd.visio")
+      end
+
+      should "return a useful http class" do
+        assert_equal Net::HTTP::Get, @subject.verb_klass
+      end
+    end
+
+    context "when an unsupported verb" do
+      setup do
+        @subject = Drip::Request.new(:garbage, "https://www.example.com/blah", { hello: "world" }, "application/vnd.visio")
+      end
+
+      should "return nil" do
+        assert_nil @subject.verb_klass
+      end
+    end
+  end
+
+  context "#body" do
+    context "when HTTP GET" do
+      setup do
+        @subject = Drip::Request.new(:get, "https://www.example.com/blah", { hello: "world" }, "application/vnd.visio")
+      end
+
+      should "return nil" do
+        assert_nil @subject.body
+      end
+    end
+
+    context "when HTTP POST" do
+      setup do
+        @subject = Drip::Request.new(:post, "https://www.example.com/blah", { hello: "world" }, "application/vnd.visio")
+      end
+
+      should "return JSON" do
+        assert_equal '{"hello":"world"}', @subject.body
+      end
+    end
+  end
+end