drip-ruby 3.2.0 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 70f3d91d9c2443f74403c190edb0cf38e67f6659
-  data.tar.gz: '0759cfde4ef6ed2361b909c6f765a9cec2579a14'
+SHA256:
+  metadata.gz: a315464f308426c87063f971108b2861cc7f6beacf9320fdf16af17bed73fc16
+  data.tar.gz: 70cd96e4f9ea7a463f73ae83990e8cfda6519563bbcaec9b4942d1862d7613b8
 SHA512:
-  metadata.gz: cad33578769c6b1e0d45dec91e9f4fd691eb32f36df440b82b41649ea723bf5906c3bc4fa0a5341920e17e2720857c94e6da1459ebe18df023a12c1fc28686f7
-  data.tar.gz: c03a67601a4d2cd13154002460576ffe475049d00e5beadb84b49a7b9ba263c6806624aa847767473cf6caaa972d8d46c43edbddf2a7b4f3be55919e680237dc
+  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/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: '2.1'
+  TargetRubyVersion: '2.3'
   Exclude:
     - 'test/fixtures/**/*'
 
@@ -32,3 +32,7 @@ Layout/MultilineMethodCallIndentation:
 Metrics/ClassLength:
   Exclude:
     - 'test/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'

data/.rubocop_todo.yml

@@ -1,11 +1,18 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-05-24 10:21:33 -0500 using RuboCop version 0.56.0.
+# on 2019-05-02 16:45:21 -0500 using RuboCop version 0.67.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 2
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - 'lib/drip/client/subscribers.rb'
+    - 'lib/drip/response.rb'
+
 # Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
@@ -14,17 +21,18 @@ Lint/UnusedMethodArgument:
     - 'lib/drip/client.rb'
     - 'lib/drip/collection.rb'
 
-# Offense count: 1
+# Offense count: 2
 Metrics/AbcSize:
-  Max: 26
+  Max: 25
 
-# Offense count: 5
+# Offense count: 8
 # Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
 Metrics/BlockLength:
   Max: 46
 
 # Offense count: 4
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 26
 
@@ -39,14 +47,14 @@ Performance/InefficientHashSearch:
     - 'lib/drip/resource.rb'
     - 'lib/drip/response.rb'
 
-# Offense count: 23
+# Offense count: 24
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, EnforcedStyle.
 # SupportedStyles: nested, compact
 Style/ClassAndModuleChildren:
   Enabled: false
 
-# Offense count: 45
+# Offense count: 44
 Style/Documentation:
   Enabled: false
 
@@ -81,13 +89,13 @@ Style/MissingRespondToMissing:
     - 'lib/drip/resource.rb'
     - 'lib/drip/response.rb'
 
-# Offense count: 10
+# Offense count: 12
 # Cop supports --auto-correct.
 # Configuration parameters: Strict.
 Style/NumericLiterals:
   MinDigits: 8
 
-# Offense count: 605
+# Offense count: 700
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes

data/.travis.yml

@@ -1,9 +1,7 @@
 language: ruby
 sudo: false
 rvm:
+  - 2.7
+  - 2.6
   - 2.5
-  - 2.4
-  - 2.3
-  - 2.2
-  - 2.1
   - jruby-19mode

data/CHANGELOG.md

@@ -6,10 +6,60 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-[master]: https://github.com/DripEmail/drip-ruby/compare/v3.2.0...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
+
+### Fixed
+- Support for Ruby 2.7 hash parameters.
+
+## [3.4.0] - 2020-04-21
+
+[3.4.0]: https://github.com/DripEmail/drip-ruby/compare/v3.3.1...v3.4.0
+
+### Added
+- Support for the user endpoint in the REST API
+
+### Changed
+- `Drip::Client#create_cart_activity_event` can be used with visitor UUID
+
+## [3.3.1] - 2019-05-28
+
+[3.3.1]: https://github.com/DripEmail/drip-ruby/compare/v3.3.0...v3.3.1
+
+### Fixed
+- Correct shopper activity batch orders API to wrap things in an `orders` key.
+
+## [3.3.0] - 2019-05-24
+
+[3.3.0]: https://github.com/DripEmail/drip-ruby/compare/v3.2.0...v3.3.0
+
+### Added
+- Support for the cart, order, and product endpoints in the shopper activity API.
+
+### Changed
+- `Drip::Client#url_prefix` parameter no longer includes `/vN` part of the URL in order to prepare for Shopper Activity API. This breaks backwards compatibility for this option, but there is no expected production usage of this parameter.
+- `Drip::Client#get`, `Drip::Client#post`, `Drip::Client#put`, and `Drip::Client#delete` are deprecated. If you are using these to hit a Drip API endpoint, please file a ticket or PR to fix the use case.
+- `Drip::Client#generate_resource` is deprecated and will be removed in a future version.
+- `Drip::Client#content_type` is deprecated and will be removed in a future version. It is no longer used internally, effective immediately.
+- When using the block form of parameter initialization, a configuration object is provided instead of the client itself.
+- Calling configuration setters on `Drip::Client` is deprecated.
+- `Drip::Client::REDIRECT_LIMIT` constant is now private. This is supposed to be an implementation detail and shouldn't leak.
+
+### Removed
+- Drop support for Ruby 2.1.
+
 ## [3.2.0] - 2018-08-15
 
 [3.2.0]: https://github.com/DripEmail/drip-ruby/compare/v3.1.1...v3.2.0

data/Gemfile

@@ -1,4 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in drip-ruby.gemspec
 gemspec
+
+gem "bundler", ">= 1.6", "< 3"
+gem "minitest", "~> 5.0"
+gem "mocha", "~> 1.1"
+gem "rake", "~> 12.0"
+gem "rubocop", "~> 0.67.2"
+gem "rubocop-performance", "~> 1.1.0"
+gem "shoulda-context", "~> 1.0"
+gem "simplecov", require: false
+gem "webmock", "~> 3.4"

data/README.md

@@ -150,6 +150,12 @@ as methods on the client object. The following methods are currently available:
 | Apply a tag                | `#apply_tag(email, tag)`                             |
 | Remove a tag               | `#remove_tag(email, tag)`                            |
 
+
+#### Users
+| Actions                    | Methods                                              |
+| :------------------------- | :--------------------------------------------------- |
+| Fetch user                 | `#user`                                              |
+
 #### Webhooks
 
 | Actions                    | Methods                                              |

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/drip-ruby.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -7,8 +8,8 @@ require 'drip/version'
 Gem::Specification.new do |spec|
   spec.name          = "drip-ruby"
   spec.version       = Drip::VERSION
-  spec.authors       = ["Derrick Reimer"]
-  spec.email         = ["derrickreimer@gmail.com"]
+  spec.authors       = ["Drip"]
+  spec.email         = ["support@drip.com"]
   spec.summary       = 'A Ruby gem for interacting with the Drip API'
   spec.description   = 'A simple wrapper for the Drip API'
   spec.homepage      = "http://github.com/DripEmail/drip-ruby"
@@ -19,13 +20,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.1'
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "mocha", "~> 1.1"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rubocop", "~> 0.56.0"
-  spec.add_development_dependency "shoulda-context", "~> 1.0"
-  spec.add_development_dependency "webmock", "~> 3.4"
+  spec.required_ruby_version = '>= 2.3'
 end

data/lib/drip.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "drip/version"
 require "drip/client"

data/lib/drip/client.rb

@@ -1,16 +1,23 @@
+# frozen_string_literal: true
+
 require "drip/errors"
+require "drip/request"
 require "drip/response"
 require "drip/client/accounts"
 require "drip/client/broadcasts"
 require "drip/client/campaigns"
 require "drip/client/campaign_subscriptions"
+require "drip/client/configuration"
 require "drip/client/conversions"
 require "drip/client/custom_fields"
 require "drip/client/events"
 require "drip/client/forms"
+require "drip/client/http_client"
 require "drip/client/orders"
+require "drip/client/shopper_activity"
 require "drip/client/subscribers"
 require "drip/client/tags"
+require "drip/client/users"
 require "drip/client/webhooks"
 require "drip/client/workflows"
 require "drip/client/workflow_triggers"
@@ -29,88 +36,76 @@ module Drip
     include Events
     include Forms
     include Orders
+    include ShopperActivity
     include Subscribers
     include Tags
+    include Users
     include Webhooks
     include Workflows
     include WorkflowTriggers
 
-    REDIRECT_LIMIT = 10
+    Drip::Client::Configuration::CONFIGURATION_FIELDS.each do |config_key|
+      define_method(config_key) do
+        @config.public_send(config_key)
+      end
+
+      setter_name = "#{config_key}=".to_sym
+      define_method(setter_name) do |val|
+        warn "[DEPRECATED] Setting configuration on Drip::Client after initialization will be removed in a future version"
+        @config.public_send(setter_name, val)
+      end
+    end
+
+    JSON_API_CONTENT_TYPE = "application/vnd.api+json"
+    private_constant :JSON_API_CONTENT_TYPE
 
-    attr_accessor :access_token, :api_key, :account_id, :url_prefix, :http_open_timeout, :http_timeout
+    JSON_CONTENT_TYPE = "application/json"
+    private_constant :JSON_CONTENT_TYPE
 
     def initialize(options = {})
-      @account_id = options[:account_id]
-      @access_token = options[:access_token]
-      @api_key = options[:api_key]
-      @url_prefix = options[:url_prefix] || "https://api.getdrip.com/v2/"
-      @http_open_timeout = options[:http_open_timeout]
-      @http_timeout = options[:http_timeout]
-      yield(self) if block_given?
+      @config = Drip::Client::Configuration.new(**options)
+      yield(@config) if block_given?
     end
 
     def generate_resource(key, *args)
-      { key => args }
+      warn "[DEPRECATED] Drip::Client#generate_resource is deprecated and will be removed in a future version"
+      private_generate_resource(key, *args)
     end
 
     def content_type
-      'application/vnd.api+json'
+      warn "[DEPRECATED] Drip::Client#content_type is deprecated and will be removed in a future version"
+      JSON_API_CONTENT_TYPE
     end
 
-    def get(url, options = {})
-      make_request(Net::HTTP::Get, make_uri(url), options)
+    Drip::Request::VERB_CLASS_MAPPING.keys.each do |verb|
+      define_method(verb) do |path, options = {}|
+        warn "[DEPRECATED] Drip::Client##{verb} please use the API endpoint specific methods"
+        make_json_api_request(verb, "v2/#{path}", options)
+      end
     end
 
-    def post(url, options = {})
-      make_request(Net::HTTP::Post, make_uri(url), options)
-    end
+  private
 
-    def put(url, options = {})
-      make_request(Net::HTTP::Put, make_uri(url), options)
+    def make_json_api_request(http_verb, path, options = {})
+      make_request Drip::Request.new(http_verb, make_uri(path), options, JSON_API_CONTENT_TYPE)
     end
 
-    def delete(url, options = {})
-      make_request(Net::HTTP::Delete, make_uri(url), options)
+    def make_json_request(http_verb, path, options = {})
+      make_request Drip::Request.new(http_verb, make_uri(path), options, JSON_CONTENT_TYPE)
     end
 
-  private
+    def private_generate_resource(key, *args)
+      # No reason for this to be part of the public API, so making a duplicate method to make it private.
+      { key => args }
+    end
 
     def make_uri(path)
-      URI(url_prefix) + URI(path)
+      URI(@config.url_prefix) + URI(path)
     end
 
-    def make_request(verb_klass, uri, options, step = 0)
-      raise TooManyRedirectsError, 'too many HTTP redirects' if step >= REDIRECT_LIMIT
-
+    def make_request(drip_request)
       build_response do
-        Net::HTTP.start(uri.host, uri.port, connection_options(uri.scheme)) do |http|
-          if verb_klass == Net::HTTP::Get
-            uri.query = URI.encode_www_form(options)
-          end
-
-          request = verb_klass.new uri
-
-          unless verb_klass == Net::HTTP::Get
-            request.body = options.to_json
-          end
-
-          request['User-Agent'] = "Drip Ruby v#{Drip::VERSION}"
-          request['Content-Type'] = content_type
-          request['Accept'] = "*/*"
-
-          if access_token
-            request['Authorization'] = "Bearer #{access_token}"
-          else
-            request.basic_auth api_key, ""
-          end
-
-          response = http.request request
-          if response.is_a?(Net::HTTPRedirection)
-            return make_request(verb_klass, URI(response["Location"]), options, step + 1)
-          else
-            response
-          end
-        end
+        Drip::Client::HTTPClient.new(@config).make_request(drip_request)
       end
     end
 
@@ -120,18 +115,5 @@ module Drip
     rescue JSON::ParserError
       Drip::Response.new(response.code.to_i, nil)
     end
-
-    def connection_options(uri_scheme)
-      options = { use_ssl: uri_scheme == "https" }
-
-      if @http_open_timeout
-        options[:open_timeout] = @http_open_timeout
-        options[:ssl_timeout] = @http_open_timeout
-      end
-
-      options[:read_timeout] = @http_timeout if @http_timeout
-
-      options
-    end
   end
 end