ResasKit
Ruby wrapper for the RESAS API.
Installation
Add this line to your application's Gemfile:
gem 'resas_kit'
And then execute:
$ bundle
Or install it yourself as:
$ gem install resas_kit
Usage
require 'resas_kit'
client = ResasKit::Client.new(api_key: '1234567890ABCDEFGHIJ1234567890abcdefghij')
response = client.get('prefectures')
response.body # get body
response.headers # get headers
response.status # get status
client.get('tourism/foreigners/forFrom', year: 2016, pref_code: '32', purpose: 2, add_area: '31,33') # underscored key
client.get('tourism/foreigners/forFrom', year: 2016, prefCode: '32', purpose: 2, addArea: '31,33') # camelized key
client.get_tourism__foreigners__for_from(year: 2016, pref_code: '32', purpose: 2, add_area: '31,33') # ghost method
client.get('prefectures').body.result[0].pref_name # method chaining
ENV
| ENV Variable | Description |
|---|---|
RESAS_API_KEY |
Your RESAS API KEY |
RESAS_API_VERSION |
Target RESAS API VERSION |
You can create instance more easily.
client = ResasKit::Client.new
Supported RESAS API Version
ResasKit supports RESAS API v1.
ResasKit's API documentation is here.
Supported Ruby Versions
- Ruby 2.0.0
- Ruby 2.1
- Ruby 2.2
- Ruby 2.3
- Ruby 2.4
Contributing
- Fork it ( https://github.com/emsk/resas_kit/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request