No commit activity in last 3 years
No release in over 3 years
https://transparentdata.eu API client
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
~> 3.0

Runtime

~> 2.1
~> 13.0
 Project Readme

Transparent Data Ruby Client

Gem Version Build Status

Supports

Ruby >= 2.7.

Installation

Add this line to your application's Gemfile:

gem 'transparent_data_client-rb'

And then execute:

$ bundle install

Or install with:

$ gem install transparent_data_client-rb

Usage

You can call TransparentData API using this:

  • add
response = TransparentData.add(source, method, parameters)
  • result
response = TransparentData.result(ident)

Response:

response.body # => { content: {...}}
response.status # => 200
response.headers # => {...}
response.success? # => true

Configuration

Before using the gem you need to configure some parameters:

TransparentData.configure do |config|
    config.username = 'user' # TransparentData username
    config.password = 'password' # TransparentData password
    config.key = 'key' # TransparentData API Key
    config.response_symbolize_keys = true # Symbolize response body keys (default: true)
end