0.01
No release in over a year
This is the official Ruby client library for Kaze (https://www.kaze.so/) API. The API documentation can be found at https://documenter.getpostman.com/view/15303175/U16nLQ7r.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 0.18, >= 0.18.1
~> 1.1, >= 1.1.2
 Project Readme

KazeClient

This is the official Ruby client library for Kaze API.

Installation

Add this line to your application's Gemfile:

gem 'kaze_client'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install kaze_client

Usage

Here is an example of how to chain requests:

require 'kaze_client'

client = KazeClient::Client.new('https://app.kaze.so', token: 'A_valid_token')
request = KazeClient::JobsRequest.new.filter_by_status('completed').filter_by_query('client_reference_42')

response = client.execute(request)

first_job = response.dig['data'].first
puts("First job id: #{first_job['id']}")

request = KazeClient::JobRequest.new(first_job['id'])

job = client.execute(request)
pickup_address = job.fetch_data_from_child('pick_up_address', field: 'city')
puts("City: #{pickup_address}")

Development

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/moduloTech/kaze_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the KazeClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.