https://github.com/madetech/solidus_crm
https://github.com/madetech/solidus_crm
ruby-on-rails solidus
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/madetech/solidus_crm
- Owner: madetech
- License: bsd-3-clause
- Created: 2016-10-29T12:10:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-27T13:29:30.000Z (about 8 years ago)
- Last Synced: 2025-01-25T14:11:44.067Z (over 1 year ago)
- Topics: ruby-on-rails, solidus
- Language: Ruby
- Size: 44.9 KB
- Stars: 2
- Watchers: 41
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SolidusCrm
==========
[](https://travis-ci.org/madetech/solidus_crm)
============
Installation
------------
Add solidus_crm to your Gemfile:
```ruby
gem 'solidus_crm'
```
Bundle your dependencies and run the installation generator:
```shell
bundle
bundle exec rails g solidus_crm:install
```
Configuration
-------------
The default values for `crm_endpoint`, `crm_request_headers`, `crm_order_emitter_class`, `crm_shipment_emitter_class` and are preferences which are by default are set to:
| Preference | Default |
|------------------------------|----------------------------|
| `crm_endpoint` | `''` |
| `crm_request_headers` | `{}` |
| `crm_order_emitter_class` | SolidusCrm::Event::Order |
| `crm_shipment_emitter_class` | SolidusCrm::Event::Order |
| `deliver_mailers_class` | SolidusCrm::DeliverMailers |
To override these defaults set them in `config/initializers/spree.rb` e.g.
```ruby
Spree::CrmConfig[:endpoint] = 'https://www.my-super-crm.com'
```
Setting the endpoint is required.
SolidusCrm::DeliverMailers returns true.
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 applications integration with this extension you may use it's factories.
Simply add this require statement to your spec_helper:
```ruby
require 'solidus_crm/factories'
```
Copyright (c) 2016 [Made Tech](https://www.madetech.com), released under the New BSD License