Singletons: Default collection_name to singleton_name
#418
+63
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When declaring a resource as a "singleton" (through including the
`ActiveResource::Singleton` module), ensure that subsequent calls to
class-level custom methods (through the `get`, `post`, `put`, `patch`,
and `delete` class and instance methods) use the singleton name by
default.
```ruby
Inventory.get(:report, product_id: 1) # => GET /products/1/inventory/report.json
Inventory.delete(:reset, product_id: 1) # => DELETE /products/1/inventory/reset.json
```
Similarly, instance-level custom methods (through the same `get`,
`post`, `put`, `patch`, and `delete` style methods) use the singleton
name **and** omit the resource ID from the path.
```ruby
inventory = Inventory.find(params: { product_id: 1 }) # => GET /products/1/inventory.json
inventory.get(:report) # => GET /products/1/inventory/report.json
inventory.delete(:reset) # => DELETE /products/1/inventory/reset.json
```
When a `collection_name` is explicitly configured, use that value
instead of the `singleton_name` default.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When declaring a resource as a "singleton" (through including the
ActiveResource::Singletonmodule), ensure that subsequent calls to class-level custom methods (through theget,post,put,patch, anddeleteclass and instance methods) use the singleton name by default.Similarly, instance-level custom methods (through the same
get,post,put,patch, anddeletestyle methods) use the singleton name and omit the resource ID from the path.When a
collection_nameis explicitly configured, use that value instead of thesingleton_namedefault.