solidus_drip 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 290275654534a1c5517175eda1d17cc7be8fc7ace035f306f78d41ebabcc130b
+  data.tar.gz: c93f0603d7e88e4ddbcd076fc41c759c60abb78392531deedefab2f4ac847649
+SHA512:
+  metadata.gz: 913a6ee519bed0452b89f2ee0e566593e2b97c3de0e22d58184bfadb10f722877e98b05cff71b921e10e9b6feeaefa2af9b4ad239c975c3d1a5222f5f6003245
+  data.tar.gz: e718d1fca112dbb26fe783df56230eb2cb855638cc3bb5b7133902f4506a6134565349c13bd589cbe88dfb073d2b4d19a37a177f0d952aba57c7281cc60803f6

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2019 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,55 @@
+# SolidusDrip
+
+Solidus integration for [Drip](https://www.drip.com/)
+
+## Installation
+
+Add `solidus_drip` to your Gemfile:
+
+```ruby
+gem 'solidus_drip'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_drip:install
+```
+
+Add your Drip credentials as environment variables. Get your Drip API key [here](https://www.getdrip.com/user/edit).
+
+```ruby
+ENV['DRIP_API_KEY'] = 'YOUR_API_KEY'
+ENV['DRIP_ACCOUNT_ID'] = 'YOUR_ACCOUNT_ID'
+```
+
+## Testing
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_drip/factories'
+```
+
+## Releasing
+
+Your new extension version can be released using `gem-release` like this:
+
+```shell
+bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+## References
+
+- [Drip API Documentation](https://developer.drip.com/)
+
+Copyright (c) 2019 Eric Saupe, released under the New BSD License

data/Rakefile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rubocop/rake_task'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  RuboCop::RakeTask.new
+
+  task default: %i(first_run rubocop spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_drip'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/spree/frontend/solidus_drip.js.erb

@@ -0,0 +1,11 @@
+var _dcq = _dcq || [];
+var _dcs = _dcs || {};
+_dcs.account = '<%= ENV['DRIP_API_KEY'] %>';
+
+(function() {
+  var dc = document.createElement('script');
+  dc.type = 'text/javascript'; dc.async = true;
+  dc.src = '<%= "//tag.getdrip.com/#{ENV['DRIP_API_KEY']}.js" %>';
+  var s = document.getElementsByTagName('script')[0];
+  s.parentNode.insertBefore(dc, s);
+})();

data/app/decorators/models/solidus_drip/spree/order_decorator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  module Spree
+    module OrderDecorator
+      def self.prepended(base)
+        base.after_create(proc { |order|
+          order.drip.cart_activity('created')
+        })
+        base.state_machine.after_transition(to: :complete, do: proc { |order|
+          order.drip.order_activity('placed')
+        })
+        base.state_machine.after_transition(to: :canceled, do: proc { |order|
+          order.drip.order_activity('canceled')
+        })
+      end
+
+      ##
+      # Updates activity on Drip
+      #
+      # This method is called as part of the Spree::Order.update_hooks
+      #
+      # @see SolidusDrip::ShopperActivity::Order
+      #
+      def update_drip_activity
+        # If the order is complete it is no longer considered cart data
+        if completed?
+          if shipment_state_changed? && shipped?
+            drip.order_activity('fulfilled')
+          end
+          if payment_state_changed? && paid?
+            drip.order_activity('paid')
+          end
+          drip.order_activity('updated')
+        else
+          drip.cart_activity('updated')
+        end
+      end
+
+      def drip
+        @drip ||= SolidusDrip::ShopperActivity::Order.new(self)
+      end
+
+      ::Spree::Order.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_drip/spree/variant_decorator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  module Spree
+    module VariantDecorator
+      def self.prepended(base)
+        base.after_create(proc { |variant|
+          variant.drip.product_activity('created')
+        })
+        base.after_update(proc { |variant|
+          variant.drip.product_activity('updated')
+        })
+        base.after_destroy(proc { |variant|
+          variant.drip.product_activity('deleted')
+        })
+      end
+
+      def drip
+        @drip ||= SolidusDrip::ShopperActivity::Product.new(self)
+      end
+
+      ::Spree::Variant.prepend self
+    end
+  end
+end

data/config/initializers/default_host.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# A default_host is required to generate full URL paths to be sent to Drip
+# Here we initialize one if one is not present
+
+if Spree::Core::Engine.routes.default_url_options.dig(:host).blank?
+  Rails.logger.warn('solidus_drip, default_url_options was blank and is being set to localhost')
+  Spree::Core::Engine.routes.default_url_options[:host] = 'localhost:3000'
+end

data/config/initializers/update_hooks.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Spree::Order.register_update_hook(:update_drip_activity)

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+end

data/lib/generators/solidus_drip/install/install_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_drip\n"
+      end
+
+      def add_stylesheets; end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_drip'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/solidus_drip.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'drip'
+require 'solidus_core'
+require 'solidus_drip/engine'
+require 'solidus_drip/base'
+require 'solidus_drip/shopper_activity'
+require 'solidus_drip/shopper_activity/order'
+require 'solidus_drip/shopper_activity/product'

data/lib/solidus_drip/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  class Base
+    include Spree::Core::Engine.routes.url_helpers
+
+    attr_accessor :client
+
+    def initialize(*_args)
+      @client = ::Drip::Client.new do |c|
+        c.api_key = ENV['DRIP_API_KEY']
+        c.account_id = ENV['DRIP_ACCOUNT_ID']
+      end
+    end
+
+    private
+
+    ##
+    # When a response is not successful this method should be called
+    # to handle it appropriately. Currently it logs the bad request and does
+    # not stop the execution flow. A failed response from Drip shouldn't affect
+    # the user experience with the site.
+    #
+    def handle_error_response(response)
+      # Some errors come back under the `message` key while others are nested
+      # under `error`
+      error_message = response.body.dig('message') || response.body.dig('error', 'message')
+      Rails.logger.error("SOLIDUS DRIP | #{error_message}")
+    end
+  end
+end

data/lib/solidus_drip/engine.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_drip'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_drip/factories.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'solidus_drip/factories'
+end

data/lib/solidus_drip/shopper_activity.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  module ShopperActivity
+  end
+end

data/lib/solidus_drip/shopper_activity/order.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module SolidusDrip
+  module ShopperActivity
+    class Order < SolidusDrip::Base
+      attr_accessor :order
+
+      ##
+      # ShopperActivity::Order relies on order data to be useful. We call super
+      # to initialize the client and then we set the order attribute to be used
+      # in the API calls.
+      #
+      # @param order [Spree::Order] the order to be recorded
+      #
+      def initialize(order)
+        super
+        @order = order
+      end
+
+      ##
+      # Cart Activity helps identify cart abandonment.
+      #
+      # @param action [String] the cart action, `created` or `updated`
+      # @see https://developer.drip.com/#cart-activity
+      #
+      def cart_activity(action)
+        response = client.create_cart_activity_event(cart_data(action))
+        handle_error_response(response) if !response.success?
+
+        response.success?
+      end
+
+      ##
+      # Order Activity helps identify a user's lifetime value by tracking the values
+      #
+      # @param action [String] the cart action, `placed`, `updated`, `paid`,
+      #   `fulfilled`, `refunded`, or `canceled`
+      # @see https://developer.drip.com/#order-activity
+      #
+      def order_activity(action)
+        response = client.create_order_activity_event(order_data(action))
+        handle_error_response(response) if !response.success?
+
+        response.success?
+      end
+
+      private
+
+      ##
+      # Formats data to be used in Drip cart calls
+      #
+      def cart_data(action)
+        {
+          provider: 'solidus',
+          email: order.email,
+          action: action,
+          cart_id: order.id.to_s,
+          cart_public_id: order.number,
+          grand_total: order.total.to_f,
+          total_discounts: order.promo_total.to_f,
+          currency: order.currency,
+          cart_url: cart_url,
+          items: order.line_items.map do |line_item|
+            {
+              product_id: line_item.product.id.to_s,
+              product_variant_id: line_item.variant_id.to_s,
+              sku: line_item.sku,
+              name: line_item.name,
+              categories: line_item.product.taxons.pluck(:name),
+              price: line_item.price.to_f,
+              quantity: line_item.quantity,
+              discounts: line_item.promo_total.to_f,
+              total: line_item.total.to_f,
+              product_url: product_url(line_item.product)
+            }.compact
+          end
+        }.compact
+      end
+
+      ##
+      # Formats data to be used in Drip order calls
+      #
+      def order_data(action)
+        {
+          provider: 'solidus',
+          email: order.email,
+          action: action,
+          order_id: order.id.to_s,
+          order_public_id: order.number,
+          grand_total: order.total.to_f,
+          total_taxes: order.tax_total.to_f,
+          total_discounts: order.promo_total.to_f,
+          currency: order.currency,
+          order_url: order_url(order),
+          items: order.line_items.map do |line_item|
+            {
+              product_id: line_item.product.id.to_s,
+              product_variant_id: line_item.variant_id.to_s,
+              sku: line_item.sku,
+              name: line_item.name,
+              categories: line_item.product.taxons.pluck(:name),
+              price: line_item.price.to_f,
+              quantity: line_item.quantity,
+              discounts: line_item.promo_total.to_f,
+              taxes: line_item.additional_tax_total.to_f,
+              total: line_item.total.to_f,
+              product_url: product_url(line_item.product)
+            }.compact
+          end,
+          billing_address: {
+            first_name: order.billing_address.firstname,
+            last_name: order.billing_address.lastname,
+            company: order.billing_address.company,
+            address_1: order.billing_address.address1,
+            address_2: order.billing_address.address2,
+            city: order.billing_address.city,
+            state: order.billing_address.state&.abbr || order.billing_address.state_name,
+            postal_code: order.billing_address.zipcode,
+            country: order.billing_address.country&.name,
+            phone: order.billing_address.phone
+          }.compact,
+          shipping_address: {
+            first_name: order.shipping_address.firstname,
+            last_name: order.shipping_address.lastname,
+            company: order.shipping_address.company,
+            address_1: order.shipping_address.address1,
+            address_2: order.shipping_address.address2,
+            city: order.shipping_address.city,
+            state: order.shipping_address.state&.abbr || order.shipping_address.state_name,
+            postal_code: order.shipping_address.zipcode,
+            country: order.shipping_address.country&.name,
+            phone: order.shipping_address.phone
+          }.compact
+        }.compact
+      end
+    end
+  end
+end