README.md
![Abundance Labds](.github/AbundanceLabs_readme_banner.png)
# Spree Batch API
[![Build Status](https://travis-ci.org/public-market/spree_batch_api.svg?branch=master)](https://travis-ci.org/public-market/spree_batch_api)
[![Maintainability](https://api.codeclimate.com/v1/badges/27c408372144ced90920/maintainability)](https://codeclimate.com/github/public-market/spree_batch_api/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/27c408372144ced90920/test_coverage)](https://codeclimate.com/github/public-market/spree_batch_api/test_coverage)
Batch API extension allows to update product/inventory/orders in batches.
## Installation
1. Add this extension to your Gemfile with this line:
```ruby
gem 'spree_batch_api', github: 'public-market/spree_batch_api'
```
1. Install the gem using Bundler:
```ruby
bundle install
```
1. Copy & run migrations
```ruby
bundle exec rails g spree_batch_api:install
```
1. Restart your server
If your server was running, restart it so that it can find the assets properly.
## 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. 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 'spree_batch_api/factories'
```
## Contributing
If you'd like to contribute, please take a look at the
[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
pull request.
Copyright (c) 2018 Abundance Labs, Inc., released under the New BSD License