Sha256: 396b3af5072d12c132e0f7bbd59d945eb0575b08a7f06a919e6396c0a064c7bb
Contents?: true
Size: 1.74 KB
Versions: 18
Compression:
Stored size: 1.74 KB
Contents
#  Aptible::Resource
[](https://rubygems.org/gems/aptible-resource)
[](https://travis-ci.org/aptible/aptible-resource)
[](https://gemnasium.com/aptible/aptible-resource)
Foundation classes for Aptible resource server gems.
## Usage
To build a new resource server gem on top of `aptible-resource`, create a top-level class for your resource server. For example:
```ruby
module Example
module Api
class Resource < Aptible::Resource::Base
def namespace
'Example::Api'
end
def root_url
'https://api.example.com'
end
end
end
end
```
Then add the gem to your gemspec:
```ruby
spec.add_dependency 'aptible-resource'
```
## Development
This gem depends on a vendored version of [HyperResource](https://github.com/gamache/hyperresource), which can be updated from a local checkout of HyperResource as follows:
cp -rp /path/to/hyperresource/lib/hyper_resource* lib/
## Contributing
1. Fork the project.
1. Commit your changes, with specs.
1. Ensure that your code passes specs (`rake spec`) and meets Aptible's Ruby style guide (`rake rubocop`).
1. Create a new pull request on GitHub.
## Copyright and License
MIT License, see [LICENSE](LICENSE.md) for details.
Copyright (c) 2014 [Aptible](https://www.aptible.com) and contributors.
[<img src="https://s.gravatar.com/avatar/9b58236204e844e3181e43e05ddb0809?s=60" style="border-radius: 50%;" alt="@sandersonet" />](https://github.com/sandersonet)
Version data entries
18 entries across 18 versions & 1 rubygems