Add this line to your application's Gemfile:
gem 'etna'
And then execute:
$ bundle
Or install it yourself as:
$ gem install etna
This is a general purpose Json API client library on top of Typhoeus. You can implement the 4 general verbs like:
### GET
client = Etna::Client.new('http://some_service')
client.get("/users")
### POST
client = Etna::Client.new('http://some_service')
client.post("/users", { name: 'Calisto', last_name: 'Mejidez' })
### PATCH
client = Etna::Client.new('http://some_service')
client.patch("/users/34", { name: 'Calisto', last_name: 'Mejidez' })
### DELETE
client = Etna::Client.new('http://some_service')
client.delete("/users/34")
Responses can be of the kind:
Etna::Components::Responses::Entity
Etna::Components::Responses::Collection
Etna::Components::Responses::ApiError
The Responses objects accepts response's attributes and delegates them to the internal Typhoeus object. Also they implement an unified interface with the following methods.
reponse.uid
reponse.success?
reponse.error?
reponse.code
reponse.to_h
reponse.body
And collections implement extra methods:
reponse.to_a
reponse[] # Iterator
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/etna. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Etna project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.