ipbase-ruby

ipbase-ruby is the official Ruby Wrapper around the ipbase API.

Installation

Add this line to your application's Gemfile:

gem 'ipbase'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ipbase

Configuration

You will need your apikey to use Ipbase, you can get one https://app.ipbase.com/register.

Create an instance and pass your api key like here:

fx = Ipbase::Endpoints.new(:apikey => 'APIKEY')

Usage & Endpoints

Use the instance to call the endpoints

Status

Returns your current quota

fx.status()

Info

Checks the provided ip address (both v4 & v6 formats) and returns all available information.

fx.info(ip, language)

| Parameter | Data type | Mandatory | Description | | --- | ----------- | --- | ----------- | | ip | string, Path Parameter | yes | The ip address you want to query | | language | string | no | An ISO Alpha 2 Language Code for localising the ip data |

You can find further information on https://ipbase.com/docs/

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

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