https://github.com/solidusio-contrib/solidus_drip
Drip integration for Solidus
https://github.com/solidusio-contrib/solidus_drip
drip solidus-extensions
Last synced: 10 months ago
JSON representation
Drip integration for Solidus
- Host: GitHub
- URL: https://github.com/solidusio-contrib/solidus_drip
- Owner: solidusio-contrib
- License: bsd-3-clause
- Created: 2019-10-30T23:04:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-09T18:05:27.000Z (almost 4 years ago)
- Last Synced: 2025-04-06T03:12:43.436Z (about 1 year ago)
- Topics: drip, solidus-extensions
- Language: Ruby
- Size: 72.3 KB
- Stars: 2
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Solidus Drip
[](https://circleci.com/gh/solidusio-contrib/solidus_drip)
[](https://codecov.io/gh/solidusio-contrib/solidus_drip)
## Installation
Add solidus_drip to your Gemfile:
```ruby
gem 'solidus_drip'
```
Bundle your dependencies and run the installation generator:
```shell
bin/rails generate solidus_drip:install
```
## Usage
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'
```
### 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.
```shell
rails drip:import_orders
```
For any additional info, please refer to the [Drip API Documentation](https://developer.drip.com/).
## 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`.
```shell
bin/rake
```
To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
```shell
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:
```ruby
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:
```shell
bin/rake changelog
git add CHANGELOG.md
git commit -m "Update the changelog"
```
### Releasing new versions
Please refer to the dedicated [page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) on Solidus wiki.
## License
Copyright (c) 2019-2021 Eric Saupe, released under the New BSD License