Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prismicio/ruby-kit
Community maintained development kit for Prismic and the Ruby language
https://github.com/prismicio/ruby-kit
ruby
Last synced: about 2 months ago
JSON representation
Community maintained development kit for Prismic and the Ruby language
- Host: GitHub
- URL: https://github.com/prismicio/ruby-kit
- Owner: prismicio-community
- License: apache-2.0
- Created: 2013-08-01T09:53:34.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T23:55:51.000Z (over 1 year ago)
- Last Synced: 2024-11-26T07:08:48.330Z (about 2 months ago)
- Topics: ruby
- Language: Ruby
- Homepage: https://prismic.io
- Size: 1.46 MB
- Stars: 45
- Watchers: 19
- Forks: 35
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-prismic - ruby-kit - Ruby kit. (Ecosystem / Development Kits)
README
## Ruby development kit for prismic.io
[](http://badge.fury.io/rb/prismic.io)
[](https://travis-ci.com/prismicio-community/ruby-kit)
### Getting Started
The prismic kit is compatible with Ruby 1.9.3 or later.
#### Install the kit for your project
_(Assuming that [Ruby is installed](https://www.ruby-lang.org/en/downloads/) on your computer, as well as [RubyGems](http://rubygems.org/pages/download))_
To install the gem on your computer, run in shell:
```sh
gem install prismic.io --pre
```
then add in your code:
```ruby
require 'prismic'
```
To add the gem as a dependency to your project with [Bundler](http://bundler.io/), you can add this line in your Gemfile:
```ruby
gem 'prismic.io', require: 'prismic'
```
#### Get started
- [developer documentation](./docs-usage)
- [quickstart](https://prismic.io/quickstart)
- [API reference](http://prismicio.github.io/ruby-kit/)
The quickstart is not available for Ruby yet, but if you understand Javascript you can easily adapt the code.
#### Configuring Alternative API Caches
The default cache stores data in-memory, in the server. You may want to use a different cache, for example to share it between several servers (with memcached or similar). A null cache (does no caching) is also available if you need a predictible behavior for testing or VCR. To use it (or any other compliant cache), simply add `api_cache: Prismic::BasicNullCache.new` to the options passed to `Prismic.api`.
### Changelog
Need to see what changed, or to upgrade your kit? We keep our changelog on [this repository's "Releases" tab](https://github.com/prismicio/ruby-kit/releases).
#### Install the kit locally
Of course, you're going to need [Ruby installed](https://www.ruby-lang.org/en/downloads/) on your computer, as well as [RubyGems](http://rubygems.org/pages/download) and [Bundler](http://bundler.io/).
Clone the kit, then run `bundle install`.
#### Test
Please write tests for any bugfix or new feature, by placing your tests in the [spec/](spec/) folder, following the [RSpec](http://rspec.info/) syntax. Launch the tests by running `rspec`
If you find existing code that is not optimally tested and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
#### Documentation
Please document any bugfix or new feature, using the [Yard](http://yardoc.org/) syntax. Don't worry about generating the doc, we'll take care of that.
If you find existing code that is not optimally documented and wish to make it better, we really appreciate it; but you should document it on its own branch and its own pull request.
### Contributing
We hope you'll get involved! Read our [Contributors' Guide](/CONTRIBUTING.md) for details.
### Licence
This software is licensed under [Apache 2.0 license](/LICENSE.md)
Copyright 2013-2021 Prismic (https://prismic.io)