README.md in rakuten_web_service-1.9.2 vs README.md in rakuten_web_service-1.10.0
- old
+ new
@@ -6,11 +6,11 @@
[](https://codeclimate.com/github/rakuten-ws/rws-ruby-sdk)
[](https://gitter.im/rakuten-ws/rws-ruby-sdk?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
This gem provides a client for easily accessing [Rakuten Web Service APIs](https://webservice.rakuten.co.jp/).
-# Table of Contents
+## Table of Contents
* [Prerequisite](#prerequisite)
* [Installation](#installation)
* [Usage](#usage)
* [Prerequisite: Getting Application ID](#prerequisite-getting-application-id)
@@ -23,16 +23,16 @@
* [Rakuten Ichiba APIs](#rakuten-ichiba-apis)
* [Rakuten Books APIs](#rakuten-books-apis)
* [Rakuten Kobo APIs](#rakuten-kobo-apis)
* [Rakuten Recipe APIs](#rakuten-recipe-apis)
* [Rakuten GORA APIs](#rakuten-gora-apis)
+ * [Rakuten Travel APIs](#rakuten-travel-apis)
* [Contributing](#contributing)
-
## Prerequisite
-* Ruby 2.2 or later
+* Ruby 2.3 or later
## Installation
Add this line to your application's Gemfile:
@@ -40,23 +40,22 @@
gem 'rakuten_web_service'
```
And then execute:
- $ bundle
+ bundle
Or install it yourself as:
- $ gem install rakuten_web_service
+ gem install rakuten_web_service
-
## Usage
### Prerequisite: Getting Application ID
-You need to get Application ID for your application to access to Rakuten Web Service APIs.
-If you have not got it, register your application [here](https://webservice.rakuten.co.jp/app/create).
+You need to get Application ID for your application to access to Rakuten Web Service APIs.
+If you have not got it, register your application [here](https://webservice.rakuten.co.jp/app/create).
### Configuration
At first, you have to specify your application's key. And you can tell the client your afiiliate id with `RakutenWebService.configuration`.
@@ -68,12 +67,12 @@
c.application_id = 'YOUR_APPLICATION_ID'
# (Optional) Affiliate ID for your Rakuten account.
c.affiliate_id = 'YOUR_AFFILIATE_ID' # default: nil
- # (Optional) # of retries to send requests when the client receives
- # When the number of requests in some period overcomes the limit, the endpoints will return
+ # (Optional) # of retries to send requests when the client receives
+ # When the number of requests in some period overcomes the limit, the endpoints will return
# too many requests error. Then the client tries to retry to send the same request after a
# while.
c.max_retries = 3 # default: 5
# (Optional) Enable debug mode. When set true, the client streams out all HTTP requests and
@@ -86,11 +85,10 @@
#### Environment Variables
You can configure `application_id` and `affiliate_id` by defining environment variables `RWS_APPLICATION_ID` and `RWS_AFFILIATION_ID`.
-
### Search Ichiba Items
```ruby
items = RakutenWebService::Ichiba::Item.search(keyword: 'Ruby') # This returns Enumerable object
items.first(10).each do |item|
@@ -137,11 +135,10 @@
# Use genre id to fetch genre object
RakutenWebService::Ichiba::Genre[100316].name # => "水・ソフトドリンク"
```
-
### Ichiba Item Ranking
```ruby
ranking_by_age = RakutenWebService::Ichiba::Item.ranking(age: 30, sex: 1) # returns the TOP 30 items for Male in 30s
# For attributes other than 'itemName', see: http://webservice.rakuten.co.jp/api/ichibaitemsearch/#outputParameter
@@ -191,9 +188,14 @@
### Rakuten GORA APIs
* [Rakuten GORA Golf Course Search API](https://webservice.rakuten.co.jp/api/goragolfcoursesearch/)
* [Rakuten GORA Golf Course Detail Search API](https://webservice.rakuten.co.jp/api/goragolfcoursedetail/)
* [Rakuten GORA Plan Search API](https://webservice.rakuten.co.jp/api/goraplansearch/)
+
+### Rakuten Travel APIs
+
+* [Rakuten Travel Simple Hotel API](https://webservice.rakuten.co.jp/api/simplehotelsearch/)
+* [Rakuten Travel Get Area Class API](https://webservice.rakuten.co.jp/api/getareaclass/)
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)