Project

binking

0.0
The project is in a healthy, maintained state
Ruby client for binking.io API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 3.2

Runtime

~> 2.0
 Project Readme

Binking

Simple API client for binking.io service

Installation

Add this line to your application's Gemfile:

gem 'binking'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install binking

Usage

At first you need to setup config:

require 'binking'

Binking.configure do |config|
  config.api_token = 'my_api_key'
end

If you need caching, you can add config.cache parameter with FaradayMiddleware::Caching compatible cache store.

Add config.logger if you need logging.

Also you can provide request options like timeouts or proxy:

Binking.configure do |config|
  config.api_token = 'my_api_key'
  config.request_options = {
    proxy: nil,
    timeout: nil,
    open_timeout: nil,
    read_timeout: nil,
    write_timeout: nil
  }
end

And then you can simply get one of resource binking resource form/bank/banks

Binking.form('123456')
Binking.bank('ru-sberasdbank')
Binking.bank('ru-sberasdbank,ru-rosbanqwek')

Add sandbox: true, if you need sandbox mode. By default it's false. You can also setup sandbox mode in config config.sandbox = true

Binking.form('123456', sandbox: true)

Add fields param with array of fields to get certain fields.

Binking.form('123456', fields: [:bankAlias, :bankLogoBigOriginalPng])

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/RainbowPonny/ruby-binking. 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 Binking project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.