jahuty-ruby
Welcome Jahuty's Ruby SDK!
Installation
This library requires Ruby 2.3+.
It is multi-platform, and we strive to make it run equally well on Windows, Linux, and OSX.
Add this line to your application's Gemfile, where x is the latest major version number:
gem "jahuty", "~> 1.0"
And then execute:
$ bundle
Usage
Before use, the library needs to be configured with your API key (ideally, once during startup):
require "jahuty"
Jahuty.key = "YOUR_API_KEY"
With the API key set, you can use the get() method to retrieve a snippet:
Then, use the .get method to fetch a snippet:
require "jahuty"
# retrieve the snippet
snippet = Snippet.get YOUR_SNIPPET_ID
# convert it to a string
snippet.to_s
# or, access its attributes
snippet.id
snippet.content
In an HTML view:
<%-
require "jahuty"
Jahuty.key = "YOUR_API_KEY"
%>
<!doctype html>
<html>
<head>
<title>Awesome example</title>
</head>
<body>
<%= Snippet.get YOUR_SNIPPET_ID %>
</body>
Parameters
You can pass parameters into your snippet with an optional second argument:
require "jahuty"
Snippet.get(YOUR_SNIPPET_ID, {
foo: "bar",
baz: ["qux", "quux"],
corge: {
grault: {
garply: "waldo"
}
}
});
The parameters above would be equivalent to assigning the variables below in your snippet:
{% assign foo = "bar" %}
{% assign baz = ["qux", "quux"] %}
{% assign corge.grault.garply = "waldo" %}
Errors
If you don't set your API key before calling Snippet.get, a StandardError will be raised. If an error occurs with Jahuty's API, a NotOk exception will be raised:
require "jahuty"
begin
Snippet.get YOUR_SNIPPET_ID
rescue StandardError => e
# hmm, did you set the API key first?
rescue Jahuty::Exception::NotOk => e
# hmm, the API returned something besides 2xx status code
puts e.problem.type # a URL to more information
puts e.problem.status # the status code
puts e.problem.detail # a description of the error
end
That's it!
Contributing
Bug reports and pull requests are welcome on GitHub.
License
The gem is available as open source under the terms of the MIT License.