drip-ruby 3.4.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 187036a01190c508e9f62cdb1f0b3feed1f1f48f57b401abbb94f4c76e47f72b
-  data.tar.gz: 5f346605646162e11440de3094602e279d615595d3e3cd6ede2b3739a3893d35
+  metadata.gz: a315464f308426c87063f971108b2861cc7f6beacf9320fdf16af17bed73fc16
+  data.tar.gz: 70cd96e4f9ea7a463f73ae83990e8cfda6519563bbcaec9b4942d1862d7613b8
 SHA512:
-  metadata.gz: 84d6861c2a98a80e42c385a84b8a09cca7f556029778acd9bd1e8bcc468b2fb85a09ebb3f4c6192ee9069617e3cb1c57ab26996cc5b04fc843db68144c7b583e
-  data.tar.gz: 454de61b3f91e50a7f2948b6698c8e824f8e8a702ff96fb482c2542c0d1437fea5fe051da856f19f9f1340676a5b48c33da3815f989ab7bdbac52829c9f8034c
+  metadata.gz: b9d9dba42336127f9cfc9269ab57ff0f7af9fac620fb735d0749cb40ecf76a96175e25bee9b2a55ef94fd4ba038d10ae0fa371c9b0b0d7ded6f09f4169bbcb93
+  data.tar.gz: 1991082152cbf1bfc5748a37e6108418313871ea5272e8ad42b33a2be4081174b282601deedd027f8187df2e513071ea80636423f77168fffe2d2f42dba82af2

data/.github/pull_request_template.md

@@ -0,0 +1,39 @@
+Addresses: [ECI-XXXX](https://dripcom.atlassian.net/browse/ECI-XXXX)
+
+plus links to any other relevant tickets, PRs, JIRAs, wikis, e.g.:
+
+Followup to: https://github.com/DripEmail/drip-ruby/12437
+
+Also any pair partners that worked on this code:
+
+Co-authored-by: Jesse Developer <jesse.developer@drip.com>
+
+## Background
+
+Explain the context and why you're making that change. What is the
+problem you're trying to solve? In some cases there is not a problem
+and this can be thought of being the motivation for your change.
+
+## Modification
+
+Describe the modifications you've done.
+
+## Result
+
+What will change as a result of your pull request? Note that sometimes
+this section is unnecessary because it is self-explanatory based on
+the solution.
+
+## Additional Context
+
+Does the PR title contain the JIRA key if using JIRA?
+
+## How to verify/test
+
+Aside from automated tests that should be part of every PR,
+what are the steps necessary to independently confirm that the PR
+is correct in staging or production? Describe here the steps did you do
+to manually smoke test or verify the functionality from the point of
+view of a non-developer.
+
+This section may not apply to all PRs.

data/CHANGELOG.md

@@ -6,10 +6,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-[master]: https://github.com/DripEmail/drip-ruby/compare/v3.4.1...HEAD
+[master]: https://github.com/DripEmail/drip-ruby/compare/v3.4.2...HEAD
 
 - Your contribution here!
 
+## [3.4.2] - 2021-04-25
+
+[3.4.2]: https://github.com/DripEmail/drip-ruby/compare/v3.4.1...v3.4.2
+
+### Changed
+- `Drip::Client#create_or_update_subscriber` can be used with a BigCommerce Subscriber ID as the required key
+
 ## [3.4.1] - 2020-04-21
 
 [3.4.1]: https://github.com/DripEmail/drip-ruby/compare/v3.4.0...v3.4.1

data/lib/drip/client/subscribers.rb

@@ -35,8 +35,10 @@ module Drip
       #
       # 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
@@ -45,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
@@ -52,7 +57,7 @@ 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)
+        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
 
@@ -152,5 +157,12 @@ module Drip
         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

data/lib/drip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Drip
-  VERSION = "3.4.1"
+  VERSION = "3.4.2"
 end

data/test/drip/client/subscribers_test.rb

@@ -84,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drip-ruby
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.4.2
 platform: ruby
 authors:
 - Drip
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies: []
 description: A simple wrapper for the Drip API
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -141,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A Ruby gem for interacting with the Drip API