ruby-kit: A Ruby repository from Swiftype

Ruby development kit for prismic.io

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 on your computer, as well as RubyGems)

To install the gem on your computer, run in shell:

gem install prismic.io --pre

then add in your code:

require 'prismic'

To add the gem as a dependency to your project with Bundler, you can add this line in your Gemfile:

gem 'prismic.io', require: 'prismic'

Get started with prismic.io

You can find out how to get started with prismic.io on our prismic.io developer's portal.

Get started using the kit

Also on our prismic.io developer's portal, on top of our full documentation, you will:

get a thorough introduction of how to use prismic.io kits, including this one.
see what else is available for Ruby: starter projects, examples, ...

Using the kit

Kit's detailed documentation

To get a detailed documentation of the Ruby kit's variables and methods, please check out the prismic.io Ruby kit's documentation.

Specific Ruby kit syntax

Thanks to Ruby's syntax, this kit contains some mild differences and syntastic sugar over the "Kits and helpers" section of our API documentation in general (which you should read first). They are listed here:

When calling the API, a faster way to pass the ref: directly as a parameter of the submit method (no need to use the ref method then): api.form("everything").submit(@ref).
Accessing type-dependent fields from a document is done through the [] operator (rather than a get() method). Printing the HTML version of a field therefore looks like document["title_user_friendly"].as_html(link_resolver(@ref)).
Two of the fields in the DocumentLink object (the one used to write your link_resolver method, for instance) were renamed to fit Ruby's best practice: doc.type is in fact doc.link_type, and doc.isBroken is in fact doc.broken?.
You don't need to pass a ctx object in as_html(), you can use the Prismic.link_resolver static method to build a link resolver object that takes the ref into account, like this: @link_resolver = Prismic.link_resolver(@ref) { |doc| ... }. Then you can simply go: fragment.as_html(@link_resolver). Note: the Rails starter kit provides you with a helper allowing you to pass the ref each time you call the link resolver, like this: fragment.as_html(link_resolver(@ref)).
the Response class is fit to work with the Kaminari gem. So if you have a @response object in your controller, you can display a whole pagination for it in your view like this: <%= paginate @response %> (this works with any Rails 3 or 4 app with the Kaminari gem installed).

Knowing all that, here is typical code written with the Ruby kit:

A typical API object instantiation looks like this: Prismic.api(url, opts)
A typical querying looks like this: api.form('everything').query('[[:d = at(document.type, "product")]]').submit(@ref)
A typical fragment manipulation looks like this: doc['article.image'].get_view('icon').url
A typical fragment serialization to HTML looks like this: doc['article.body'].as_html(@link_resolver)

Changelog

Need to see what changed, or to upgrade your kit? We keep our changelog on this repository's "Releases" tab.

Contribute to the kit

Contribution is open to all developer levels, read our "Contribute to the official kits" documentation to learn more.

Install the kit locally

Of course, you're going to need Ruby installed on your computer, as well as RubyGems and Bundler.

Clone the kit, then run bundle install.

Test

Please write tests for any bugfix or new feature, by placing your tests in the spec/ folder, following the RSpec syntax. Launch the tests by running bundle exec 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 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.

Licence

This software is licensed under the Apache 2 license, quoted below.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

swiftype/ruby-kit