Skip to content

solidusio-contrib/solidus_drip

Repository files navigation

Solidus Drip

CircleCI codecov

Installation

Add solidus_drip to your Gemfile:

gem 'solidus_drip'

Bundle your dependencies and run the installation generator:

bin/rails generate solidus_drip:install

Usage

Add your Drip credentials as environment variables. Get your Drip API key here.

ENV['DRIP_API_KEY'] = 'YOUR_API_KEY'
ENV['DRIP_ACCOUNT_ID'] = 'YOUR_ACCOUNT_ID'

Import Data

You can import all order data from your Solidus store to Drip via a rake task. This should ideally only be run once.

rails drip:import_orders

For any additional info, please refer to the Drip API Documentation.

Development

Testing the extension

First bundle your dependencies, then run bin/rake. bin/rake will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using bin/rake extension:test_app.

bin/rake

To run Rubocop static code analysis run

bundle exec rubocop

When testing your application's integration with this extension you may use its factories. Simply add this require statement to your spec_helper:

require 'solidus_drip/testing_support/factories'

Running the sandbox

To run this extension in a sandboxed Solidus application, you can run bin/sandbox. The path for the sandbox app is ./sandbox and bin/rails will forward any Rails commands to sandbox/bin/rails.

Here's an example:

$ bin/rails server
=> Booting Puma
=> Rails 6.0.2.1 application starting in development
* Listening on tcp://127.0.0.1:3000
Use Ctrl-C to stop

Updating the changelog

Before and after releases the changelog should be updated to reflect the up-to-date status of the project:

bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"

Releasing new versions

Please refer to the dedicated page on Solidus wiki.

License

Copyright (c) 2019-2021 Eric Saupe, released under the New BSD License