drip-ruby 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70f3d91d9c2443f74403c190edb0cf38e67f6659
-  data.tar.gz: '0759cfde4ef6ed2361b909c6f765a9cec2579a14'
+  metadata.gz: da8e0406199eb9a3a9c4d1dc54822dcf8126897a
+  data.tar.gz: a4ef8f3a36b59e4a54ed2c7f23895bcedea5d60c
 SHA512:
-  metadata.gz: cad33578769c6b1e0d45dec91e9f4fd691eb32f36df440b82b41649ea723bf5906c3bc4fa0a5341920e17e2720857c94e6da1459ebe18df023a12c1fc28686f7
-  data.tar.gz: c03a67601a4d2cd13154002460576ffe475049d00e5beadb84b49a7b9ba263c6806624aa847767473cf6caaa972d8d46c43edbddf2a7b4f3be55919e680237dc
+  metadata.gz: 3c69d1a5f1a6c1749a0d799a4810aef260c875bb0d03c3a975117f15af9108cfb7dc6f3552a8d15eb31c67a44c5709cabbfc026e35efac5f3f0dc002992c013e
+  data.tar.gz: 183dad58f6e69ee0f1f8f102308a9b8fc42dc87c164523220d7e9d17e07bee1b3f510b4f89a00f319676c009a85c0e233969ce15a9abe7d4c85c7acf500622f5

data/.rubocop.yml

@@ -1,7 +1,7 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: '2.1'
+  TargetRubyVersion: '2.2'
   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,9 @@
 language: ruby
 sudo: false
 rvm:
+  - 2.6
   - 2.5
   - 2.4
   - 2.3
   - 2.2
-  - 2.1
   - jruby-19mode

data/CHANGELOG.md

@@ -6,10 +6,29 @@ 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.3.0...HEAD
 
 - Your contribution here!
 
+## [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

@@ -2,3 +2,13 @@ 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/drip-ruby.gemspec

@@ -7,8 +7,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 +19,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.2'
 end

data/lib/drip/client.rb

@@ -1,14 +1,18 @@
 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/webhooks"
@@ -29,88 +33,75 @@ module Drip
     include Events
     include Forms
     include Orders
+    include ShopperActivity
     include Subscribers
     include Tags
     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".freeze
+    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".freeze
+    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 +111,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

data/lib/drip/client/accounts.rb

@@ -6,7 +6,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 +16,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

@@ -12,7 +12,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 +22,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

@@ -8,7 +8,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

@@ -14,7 +14,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 +24,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 +34,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 +44,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 +68,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,28 @@
+module Drip
+  class Client
+    class Configuration
+      DEFAULT_URL_PREFIX = "https://api.getdrip.com/".freeze
+      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