solidus_reserved_stock 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG +6 -0
- data/README.md +14 -7
- data/lib/solidus_reserved_stock/version.rb +1 -1
- metadata +2 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0783c98152397178f9ab177ab2c1b54f51c5a179
|
|
4
|
+
data.tar.gz: 542da8addb35bce147e16db465aef1c3b4b384a8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d6de82ccfbf81470a0c71738fe45c23e4b5d5b92a5c592451bbea7e4b4c4324ad21c2d0295a3b7284b681cde38b813696e7db9418efd7674cdb0b52fe6045c0f
|
|
7
|
+
data.tar.gz: a8ed6ba58773a587c4907c5ad809935a65bbc924e0010509d2d248782a44046eb451db6a1d3dc65bd3c091addc537cdf318960129825e4a3b9a6ac9c29f53d26
|
data/CHANGELOG
ADDED
data/README.md
CHANGED
|
@@ -6,9 +6,6 @@ When a customer reserves stock, it's moved from its normal stock location to a s
|
|
|
6
6
|
|
|
7
7
|
Reserved stock can be restored to its original stock location at any time, and can be stored with an expiry date for the reservation.
|
|
8
8
|
|
|
9
|
-
## How it works
|
|
10
|
-
TODO
|
|
11
|
-
|
|
12
9
|
## Installation
|
|
13
10
|
|
|
14
11
|
Add this line to your application's Gemfile:
|
|
@@ -26,8 +23,7 @@ Or install it yourself as:
|
|
|
26
23
|
$ gem install solidus_reserved_stock
|
|
27
24
|
|
|
28
25
|
## Usage
|
|
29
|
-
|
|
30
|
-
<!-- TODO: Write usage instructions here -->
|
|
26
|
+
Access to stock reservations is currently provided only through an API, and back end admin controls. Helper methods for the front end are a possibility for the future if there's enough interest.
|
|
31
27
|
|
|
32
28
|
### API Usage
|
|
33
29
|
`GET /api/v1/reserved_stock_items.json`
|
|
@@ -63,12 +59,23 @@ This is the same as the standard Solidus route, but the response is decorated to
|
|
|
63
59
|
Same as the standard Solidus routes, but accept an optional `user_id` parameter
|
|
64
60
|
so that `total_on_hand` can include reserved stock for the user.
|
|
65
61
|
|
|
62
|
+
### Back End
|
|
63
|
+
On the Solidus back end, `solidus_reserved_stock` adds a new `Reserved Items` sidebar menu item to user edit pages. Admins can use this to reserve stock for a customer or restock reserved items. An expiry date is optional.
|
|
66
64
|
|
|
67
|
-
|
|
65
|
+
The Reserved Items stock location appears in Settings, like all stock locations.
|
|
68
66
|
|
|
67
|
+
## How it works
|
|
68
|
+
The site maintains a special stock location that accepts ReservedStockItems – a subclass of Spree::StockItem with some additional features. ReservedStockItems remember their original stock location and the user they were reserved for, with validation relaxed so that different users may have reservations for the same variant.
|
|
69
|
+
|
|
70
|
+
## Contributing
|
|
69
71
|
Bug reports and pull requests are welcome on GitHub at https://github.com/resolve/solidus_reserved_stock. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
|
|
70
72
|
|
|
73
|
+
## Future Plans
|
|
74
|
+
- Currently the gem is designed mainly for use via the API. I'd like to build out some helper methods to support using it from the Solidus front end.
|
|
75
|
+
- Further overrides are needed to various Solidus methods that deal with stock levels. In general, they should include reserved items if a user argument is provided. See e.g. app/models/spree/variant_decorator.rb
|
|
76
|
+
- Currently there's a single reserved stock location for all reserved stock items. There's been some interest in allowing an arbitrary number of reserved stock locations.
|
|
77
|
+
- Currently we require a source stock location to be specified for each reservation. It would be nice to make this optional, and if not present draw from whichever stock locations have stock in the given variant, according to normal Solidus prioritization.
|
|
78
|
+
- Reserving stock should use stock transfers, but currently doesn't.
|
|
71
79
|
|
|
72
80
|
## License
|
|
73
|
-
|
|
74
81
|
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: solidus_reserved_stock
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Isaac Freeman
|
|
@@ -280,6 +280,7 @@ files:
|
|
|
280
280
|
- ".rubocop.yml"
|
|
281
281
|
- ".ruby-gemset"
|
|
282
282
|
- ".travis.yml"
|
|
283
|
+
- CHANGELOG
|
|
283
284
|
- CODE_OF_CONDUCT.md
|
|
284
285
|
- Gemfile
|
|
285
286
|
- LICENSE.txt
|