Project

hybiscus_pdf_report

0.0
The project is in a healthy, maintained state
hybiscus_pdf_reporttimly-software-ag/hybiscuspdfreportrubygemDocumentationSource CodeBug TrackerWiki
This gem provides a simple access using Ruby to the Hybiscus.dev PDF reports generator API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
243
Stars
0
Forks
0
Watchers
0
 Releases
Current version
0.1.0
Total releases
1
First release
2024-12-10
Latest release
2024-12-10
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2025-02-23
Reverse Dependencies
0

 Dependencies

Development

pry
>= 0

Runtime

base64
>= 0
faraday
~> 1.10
 Project Readme

Hybiscus API Ruby Wrapper

This is the API Wrapper for the Hybiscus REST API

Installation

Add this line to your application's Gemfile:

gem 'hybiscus_pdf_report'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install hybiscus_pdf_report

Usage

Configure the client

The Gem is configured by default to work with the public platform of Hybiscus at

  • API: https://api.hybiscus.dev/api/v1/

Instantiate a client

# To connect to the default SaaS Instance of Adnexo: https://prod.api.ax-track.ch/api/v1
client = HybiscusPdfReport::Client.new(api_key: your_api_key)
# Or if you have set ENV['HYBISCUS_API_KEY'] set, you don't need to pass in the api key.
client = HybiscusPdfReport::Client.new

# The default time out is 10 seconds. To change the value, pass in the parameter
client = HybiscusPdfReport::Client.new(api_key: your_api_key, timeout: 20)

# If you have a Hybiscus in your private cloud and have a different URL, you can pass the URL as a parameter
client = HybiscusPdfReport::Client.new(hybiskus_api_url: #URL#)
# You can also set the URL as  ENV["HYBISCUS_API_URL"]

Accessing the Endpoints

Submit to 'build-report'

response = client.request.build_report(json)

The Response object is returned, containint the task_id AND the task status. These information are also stored and can be accessed as follows

response = client.request.last_task_id
response = client.request.last_task_status

Submit to 'preview-report'

response = client.request.preview_report(json)

Submit to 'get-task-status'

response = client.request.get_task_status(task_id)
# if you previously already made a request, you can get the status of the last task directly without having to store and pass the task_id
response = client.request.get_last_task_status

Submit to 'get-report'

response = client.request.get_report(task_id)
# if you previously already made a request, you can get the status of the last task directly without having to store and pass the task_id
response = client.request.get_last_report
# To access the report
response.report

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test 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.

To test the application in the console

client = HybiscusPdfReport::Client.new(api_key: _YOUR_API_KEY_)
# to get a list of all trackers (just as an example)
client.trackers.all

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Timly-Software-AG/HybiscusPdfReportRubyGem.

License

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

Open development

  • Pagination for development