rakuten_web_service 1.9.1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd60bf746130b97cac7b59e6a529457183b6eae42f3eb595b64c4aa820b2bbcd
-  data.tar.gz: e773d058c29619d931bda28e656f7fe7cea63816905c56e20fa55c7a84662d49
+  metadata.gz: bdb4eed0f6b4075f460d74c30218551f0345c9bc12cda1a433bdcf9525e4ff64
+  data.tar.gz: ce188517ae7113a4322b35b271c9c5fccda23f0bb5694a8047bea1afdbf25a0c
 SHA512:
-  metadata.gz: a68b23e18568d9e7cc60213b2fc881d02085966f809f7dd7e3e503e8c7404096ee46ea5120b2740ad896f4699a915cd57cf53af892ee17cb47aafc7944bb8031
-  data.tar.gz: ce2b779f0eddebd1c9246dc041bc277b84a3047e3428f7150ccfd2c60ecc204fa73b89817f31380e80d5c393e09a382cbf765569871912387f2153e2ba6cbf95
+  metadata.gz: 8b996cb29aa1fc0dd7634ee33dced0386e0d320711a42e98a20af695815df35709778d2150327551fa2dffe27a69407eb04f0aa4a3c72d01ba485e8e6ac172b7
+  data.tar.gz: 265354c69faacb14e9fe3aa3565b44d9813a8011562b913a3fe4ee017ea3e18bc4cf4df0e1f97295a5eb5c235a3beecc75e9efa37ecb89543fee5543c8e49307

data/.codeclimate.yml

@@ -1,4 +1,5 @@
-engines:
+version: "2"
+plugins:
   rubocop:
     enabled: true
   duplication:
@@ -6,11 +7,7 @@ engines:
     config:
       languages:
         - ruby
-
-ratings:
-  paths:
-    - lib/**/*.rb
-
-exclude_paths:
-  - spec/**/*
-  - examples/*.rb
+exclude_patterns:
+  - "bin/"
+  - "spec/"
+  - "examples/"

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [satoryu] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.travis.yml

@@ -1,42 +1,30 @@
 language: ruby
 rvm:
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
 
-env:
-  - INTEGRATION=yes
-  - INTEGRATION=no
-
 group: travis_lts
 
 cache: bundler
 
 before_install:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
   - gem install bundler
-
-bundler_args:  --without vscode
+  - bundle config set without 'vscode'
 
 script:
   - bundle exec rake
-  - bundle exec codeclimate-test-reporter
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
 matrix:
   allow_failures:
   - rvm: ruby-head
-  exclude:
-  - rvm: 2.3.6
-    env: INTEGRATION=yes
-  - rvm: 2.4.3
-    env: INTEGRATION=yes
-  - rvm: ruby-head
-    env: INTEGRATION=yes
-
-addons:
-  code_climate:
-    repo_token:
-      secure: Z23O936LoCDGJ/OyYsLzxTUI+CMWyrfeN1PtQdCNMdF4vxwaCsAHr3ulTdudGhKMrVZGENSEK6fq0Xal3o3oPaH9aGM9sUQ/ibRM+J94Lx6Owu4okTsIHoEy4vFeW+A/62aiwxPcoi7PFrvC8FOfaZg+b+vvYAQcitVe6qwBHiE=
 
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,156 +1,214 @@
-# v1.9.1 (2018/03/30)
+# CHANGELOG
 
-## Improvements
+## v1.13.0 (2020/10/15)
+
+### Enhancements
+
+- Adds `RakutenWebService::Ichiba::Tab.search` [#112](https://github.com/rakuten-ws/rws-ruby-sdk/pull/112)
+
+### Improvements
+
+- Adds `rexml` to development dependencies to run tests in ruby 3.0 [#127](https://github.com/rakuten-ws/rws-ruby-sdk/pull/127)
+- Abolishes integration spec [#126](https://github.com/rakuten-ws/rws-ruby-sdk/pull/126)
+- Suppresses deprecation warning for bundle install's option [#125](https://github.com/rakuten-ws/rws-ruby-sdk/pull/125)
+- Updates README.ja.md by fuyuton [#124](https://github.com/rakuten-ws/rws-ruby-sdk/pull/124)
+- Removes comment out by 4geru [#123](https://github.com/rakuten-ws/rws-ruby-sdk/pull/123)
+- Use instance variable in ichiba item example code by 4geru [#122](https://github.com/rakuten-ws/rws-ruby-sdk/pull/122)
+- Updates .travis.yml by 4geru [#121](https://github.com/rakuten-ws/rws-ruby-sdk/pull/121)
+- Adds recipe example code by @4geru [#119](https://github.com/rakuten-ws/rws-ruby-sdk/pull/119) [#120](https://github.com/rakuten-ws/rws-ruby-sdk/pull/120)
+- Drop v2.4 from supported ruby versions [#118](https://github.com/rakuten-ws/rws-ruby-sdk/pull/118)
+- Update supported ruby versions: welcome ruby 2.7 [#117](https://github.com/rakuten-ws/rws-ruby-sdk/pull/117)
+- Inserts frozen string literal comments to travel api codes [#113](https://github.com/rakuten-ws/rws-ruby-sdk/pull/113)
+- Refactoring: Extract process from `Travel::Areaclass::Base` constructor [#114](https://github.com/rakuten-ws/rws-ruby-sdk/pull/114)
+- Refactoring: decompose `RakutenWebService::Resource.attribute` to reduce its complexity [#115](https://github.com/rakuten-ws/rws-ruby-sdk/pull/115)
+- Refactoring: fix some style issues [#116](https://github.com/rakuten-ws/rws-ruby-sdk/pull/116)
+
+### Thanks
+
+We are pleased to say thanks to @4geru and @fuyuton. This release includes their seminal works.
+Thanks :tada:
+
+## v1.12.0 (2019/09/09)
+
+### Enhancements
+
+- Starts Support Ichiba Tag API. [#110](https://github.com/rakuten-ws/rws-ruby-sdk/pull/110)
+
+### Thanks
+
+We are pleased to say thanks to @keisukeponpoko. This release is made by their seminal work.
+
+## v1.11.0 (2019/07/11)
+
+### Improvements
+
+* Drop ruby 2.3 from supported ruby versions. [#104](https://github.com/rakuten-ws/rws-ruby-sdk/pull/104)
+* Fixes some issues reported by CoceClimate [#108](https://github.com/rakuten-ws/rws-ruby-sdk/pull/108)
+* `RWS.configuration` no longer accepsts block [#107](https://github.com/rakuten-ws/rws-ruby-sdk/pull/107)
+
+## v1.10.0 (2019/03/11)
+
+### Enhancements
+
+* Starts Support of two Travel APIs: SimpleHotelSearch and GetAreaClass. [#91](https://github.com/rakuten-ws/rws-ruby-sdk/pull/91)
+
+## v1.9.2 (2018/12/28)
+
+### Enhancements
+
+* Ruby 2.6 has been released :tada: this version joined the supported versions! [#100](https://github.com/rakuten-ws/rws-ruby-sdk/pull/100)
+
+## v1.9.1 (2018/03/30)
+
+### Improvements
 
 * Use the magic comment to frozen all string literals.[#93](https://github.com/rakuten-ws/rws-ruby-sdk/pull/93)
 * Drop ruby 2.2 from supported ruby versions since it goes to the EOL. [#95](https://github.com/rakuten-ws/rws-ruby-sdk/pull/95)
 
-# v1.9.0 (2018/01/04)
+## v1.9.0 (2018/01/04)
 
-## Enhancements
+### Enhancements
 
 * Update supported API versions. [#87](https://github.com/rakuten-ws/rws-ruby-sdk/pull/87)
 
-# v1.8.0 (2017/12/30)
+## v1.8.0 (2017/12/30)
 
-## Enhancements
+### Enhancements
 
 * Add `RWS::Resource#attributes` method. [#85](https://github.com/rakuten-ws/rws-ruby-sdk/pull/85)
 
-## Improvements
+### Improvements
 
 * Start supporting Ruby 2.5 and drop 2.1 from supported versions. [#83](https://github.com/rakuten-ws/rws-ruby-sdk/pull/83)
 * Update outdated gems. [#84](https://github.com/rakuten-ws/rws-ruby-sdk/pull/84)
 
-# v1.7.0 (2017/09/17)
+## v1.7.0 (2017/09/17)
 
-## Enhancements
+### Enhancements
 
 * Add Helpers for pagination. [#78](https://github.com/rakuten-ws/rws-ruby-sdk/pull/78)
 
-## Improvements
+### Improvements
 
 * Minor fix for README.ja.md [#77](https://github.com/rakuten-ws/rws-ruby-sdk/pull/77)
 * Suppressing installing gems required for debugging with VSCode in CI. [#79](https://github.com/rakuten-ws/rws-ruby-sdk/pull/79)
 
-## Thanks
+### Thanks
 
 I'm pleasured to say thanks to @jinco13. He fixed wrong method names and links in README.ja.md.
 
-# v1.6.1 (2017/08/21)
+## v1.6.1 (2017/08/21)
 
-## Bug Fix
+### Bug Fix
 
 * `RakutenWebService::Ichiba::Genre#brothers` always returns an empty array. [#75](https://github.com/rakuten-ws/rws-ruby-sdk/pull/75)
 
-# v1.6.0 (2017/08/16)
+## v1.6.0 (2017/08/16)
 
-## Improvements
+### Improvements
 
 * Added `RakutenWebService::BaseGenre#brothers`. [#74](https://github.com/rakuten-ws/rws-ruby-sdk/pull/74)
 
-# v1.5.0 (2017/03/31)
+## v1.5.0 (2017/03/31)
 
-## Improvements
+### Improvements
 
 * Allows to call `RakutenWebService::Recipe.ranking` without `category_id`. [#70](https://github.com/rakuten-ws/rws-ruby-sdk/pull/70)
 
-## Thanks
+### Thanks
 
 I'm pleasured to say thanks to @kakakakakku. His work has made the usage of `RWS::Recipe.raning` easy to get the ranking in all genres.
 Thanks!
 
-# v1.4.2 (2017/01/22)
+## v1.4.2 (2017/01/22)
 
-## Bug Fixes
+### Bug Fixes
 
 * `Net::HTTP` is NOT `reuquire`d anywhere in the codebase. [#67](https://github.com/rakuten-ws/rws-ruby-sdk/pull/67)
 
    The version 1.4.1 or earlier of this gem doesn't `require 'net/http'` by itself.
    @gouf found the bug report in [teratail](https://teratail.com/questions/62804) and made a pull-request to fix it. Thanks!
 
-## Improvements
+### Improvements
 
 * `debug_mode` has come again! if you want to see responses from Rakuten Web Service APIs, you can see the ones by set `debug_mode` `true`. [#56](https://github.com/rakuten-ws/rws-ruby-sdk/pull/56)
 * Refactoring: use new Hash syntax as supporting ruby 1.9 series has been stopped already. [#60](https://github.com/rakuten-ws/rws-ruby-sdk/pull/60)
 
-# v1.4.1 (2016/11/22)
+## v1.4.1 (2016/11/22)
 
-## Bug Fix
+### Bug Fix
 
 * Fixed: `WrongParameter` raises when giving any `sort` option to `RakutenWebService::Resource.serch`. [#54](https://github.com/rakuten-ws/rws-ruby-sdk/pull/54)
 
-## Thanks
+### Thanks
 
 I'm pleased to say thanks to @sho-yamane since he reported the bug #53. If he didn't do it, I would find the bug much later.
 Thanks, @sho-yamane.
 
+## v1.4.0 (2016/11/11)
 
-# v1.4.0 (2016/11/11)
-
-## Enhancements
+### Enhancements
 
 * Raise RuntimeError if required option `application_id` is not set when generating parameters. [#51](https://github.com/rakuten-ws/rws-ruby-sdk/pull/51)
 
+## v1.3.0 (2016/11/08)
 
-# v1.3.0 (2016/11/08)
-
-## Enhancements
+### Enhancements
 
 * Loads Application ID and Affiliate ID from environment varaibles `RWS_APPLICATION_ID` and `RWS_AFFILIATE_ID` respectively. [#47](https://github.com/rakuten-ws/rws-ruby-sdk/pull/47)
 
-## Improvements
+### Improvements
 
 * Upgraded `codeclimate-test-reporter`. [#48](https://github.com/rakuten-ws/rws-ruby-sdk/pull/48)
 
-# v1.2.0 (2016/10/25)
+## v1.2.0 (2016/10/25)
 
-## Ehancements
+### Ehancements
 
 * Started supporting GenreInformation. [#45](https://github.com/rakuten-ws/rws-ruby-sdk/pull/45)
 * `RakutenWebService::BaseGenre#parent` returns Genre object of the parent genre. [#44](https://github.com/rakuten-ws/rws-ruby-sdk/pull/44)
 
-# v1.1.1 (2016/09/12)
+## v1.1.1 (2016/09/12)
 
-## Bug Fix
+### Bug Fix
 
 * Fixed `RakutenWebService::Ichiba::Genre#ranking` ignores given options to be passed to Ichiba Ranking API. [#43](https://github.com/rakuten-ws/rws-ruby-sdk/pull/43)
 
-# v1.1.0 (2016/09/12)
+## v1.1.0 (2016/09/12)
 
-## Enhancements
+### Enhancements
 
 * Remove the dependency on faraday, using `Net::HTTP`. [#39](https://github.com/rakuten-ws/rws-ruby-sdk/pull/39)
 * Allows users to rescue any exception with `RakutenWebService::Error` which is a superclass of all the error class like `RakutenWebService::NotFound`. [#41](https://github.com/rakuten-ws/rws-ruby-sdk/pull/41)
 
-# v1.0.0 (2016/07/29)
+## v1.0.0 (2016/07/29)
 
-## Enhancements
+### Enhancements
 
 * Upgrade the version of RSpec and refactoring the configuration. [#36](https://github.com/rakuten-ws/rws-ruby-sdk/pull/36) and [#37](https://github.com/rakuten-ws/rws-ruby-sdk/pull/36)
 
-# v1.0.0.rc1
+## v1.0.0.rc1
 
-## Enhancements
+### Enhancements
 
 * Started supporting Gora APIs by @kamatama41 .[#29](https://github.com/rakuten-ws/rws-ruby-sdk/pull/29)
 * Started supporting Recipe APIs. [#31](https://github.com/rakuten-ws/rws-ruby-sdk/pull/31)
 * Updated versions of supported Rakuten Web Service APIs.
 
-## Compatibility Changes
+### Compatibility Changes
 
 * Updated supported Ruby versions to 2.1.0 or later
 * Any resource's `search` such as `RakutenWebService::Ichiba::Item` returns Enumerator which provides resources fetched at one page.
   It used to provide all resources by auto-pagerize. From this version provides methods for pagerizing. Please refer to [the sample in README](https://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.md#pagerizing).
 * Deprecated calling `RakutenWebService.configuration` with a block, recommending to use `RakutenWebService.configure`.
 
-## Thanks
+### Thanks
 
 At first, I should appreciate all users of the gems.
 One of the enhancements, supporting Gora APIs, is realized by @kamatama41 's seminal work.
 Thank you for your contribution!
 
-# v0.6.3 (2015/07/03)
+## v0.6.3 (2015/07/03)
 
 * Update a gem dependency by @45deg
 * Fix typo by @45deg

data/Gemfile

@@ -4,11 +4,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'codeclimate-test-reporter', '~> 1.0.0'
-  gem 'simplecov', '~> 0.15.1', require: false
+  gem 'simplecov', '~> 0.17.1', require: false
 end
 
 group :vscode do
-  gem 'debase', '0.2.2.beta14'
-  gem 'ruby-debug-ide', '~> 0.6.0'
+  gem 'debase', '~> 0.2', '>= 0.2.4.1'
+  gem 'ruby-debug-ide', '~> 0.7'
 end

data/README.ja.md

@@ -8,62 +8,34 @@ rakuten\_web\_serviceは、 Rubyから楽天が提供しているAPIに簡単に
 
 English version is [here](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.md).
 
+## 前提条件
+
+* Ruby 2.5 またはそれ以上のバージョンであること
+
 ## インストール方法
 
 bundlerを利用したアプリケーションの場合、Gemfileに以下の1行を追加します。
 
 ```ruby
-  gem 'rakuten_web_service'
+gem 'rakuten_web_service'
 ```
 
 そして`bundle`コマンドでインストール。
 
-    $ bundle
+```sh
+bundle
+```
 
 もしくは、`gem`コマンドにより
 
-    $ gem install rakuten_web_service
+```sh
+gem install rakuten_web_service
+```
 
 とすることでインストールできます。
 
 現在rakuten\_web\_serviceは下記のAPIをサポートしています。
 
-### 楽天市場API
-
-* [Rakuten Ichiba Item Search API](http://webservice.rakuten.co.jp/api/ichibaitemsearch/)
-* [Rakuten Ichiba Genre Search API](http://webservice.rakuten.co.jp/api/ichibagenresearch/)
-* [Rakuten Ichiba Ranking API](http://webservice.rakuten.co.jp/api/ichibaitemranking/)
-* [Rakuten Product API](http://webservice.rakuten.co.jp/api/productsearch/)
-
-
-### 楽天ブックス系API
-
-* [Rakuten Books Total Search API](http://webservice.rakuten.co.jp/api/bookstotalsearch/)
-* [Rakuten Books Book Search API](http://webservice.rakuten.co.jp/api/booksbooksearch/)
-* [Rakuten Books CD Search API](http://webservice.rakuten.co.jp/api/bookscdsearch/)
-* [Rakuten Books DVD/Blu-ray Search API](http://webservice.rakuten.co.jp/api/booksdvdsearch/)
-* [Rakuten Books ForeignBook Search API](http://webservice.rakuten.co.jp/api/booksforeignbooksearch/)
-* [Rakuten Books Magazine Search API](http://webservice.rakuten.co.jp/api/booksmagazinesearch/)
-* [Rakuten Books Game Search API](http://webservice.rakuten.co.jp/api/booksgamesearch/)
-* [Rakuten Books Software Search API](http://webservice.rakuten.co.jp/api/bookssoftwaresearch/)
-* [Rakuten Books Genre Search API](http://webservice.rakuten.co.jp/api/booksgenresearch/)
-
-### 楽天Kobo系API
-
-* [楽天Kobo電子書籍検索API](http://webservice.rakuten.co.jp/api/koboebooksearch/)
-* [楽天Koboジャンル検索API](http://webservice.rakuten.co.jp/api/kobogenresearch/)
-
-### 楽天レシピ系API
-
-* [楽天レシピカテゴリ一覧API](https://webservice.rakuten.co.jp/api/recipecategorylist/)
-* [楽天レシピカテゴリ別ランキングAPI](https://webservice.rakuten.co.jp/api/recipecategoryranking/)
-
-### 楽天GORA系API
-
-* [楽天GORAゴルフ場検索API](https://webservice.rakuten.co.jp/api/goragolfcoursesearch/)
-* [楽天GORAゴルフ場詳細API](https://webservice.rakuten.co.jp/api/goragolfcoursedetail/)
-* [楽天GORAプラン検索API](https://webservice.rakuten.co.jp/api/goraplansearch/)
-
 ## 使用方法
 
 ### 事前準備: アプリケーションIDの取得
@@ -77,19 +49,62 @@ bundlerを利用したアプリケーションの場合、Gemfileに以下の1
 
 ```ruby
   RakutenWebService.configure do |c|
+    # (必須) アプリケーションID
     c.application_id = 'YOUR_APPLICATION_ID'
-    c.affiliate_id = 'YOUR_AFFILIATE_ID'
+
+    # (任意) 楽天アフィリエイトID
+    c.affiliate_id = 'YOUR_AFFILIATE_ID' # default: nil
+
+    # (任意) リクエストのリトライ回数
+    # 一定期間の間のリクエスト数が制限を超えた時、APIはリクエスト過多のエラーを返す。
+    # その後、クライアントは少し間を空けた後に同じリクエストを再度送る。
+    c.max_retries = 3 # default: 5
+
+    # (任意) デバッグモード
+    # trueの時、クライアントはすべてのHTTPリクエストとレスポンスを
+    # 標準エラー出力に流す。
+    c.debug = true # default: false
   end
 ```
 
 `'YOUR_APPLICATION_ID'` と `'YOUR_AFFILIATE_ID'` は、実際のアプリケーションIDとアフィリエイトIDに置き換えてください。
 
+#### 環境変数
+
+`application_id` と `affiliate_id` はそれぞれ、環境変数`RWS_APPLICATION_ID`と`RWS_AFFILIATION_ID`を定義することでも設定できる。
+
 ### 市場商品の検索
 
 ```ruby
-  items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enumerable object
+  items = RakutenWebService::Ichiba::Item.search(keyword:  'Ruby') # Enumerable オブジェクトが返ってくる
   items.first(10).each do |item|
-    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.
+    puts "#{item['itemName']}, #{item.price} yen" # Hashのように値を参照できる
+  end
+```
+
+### ページング
+
+`RakutenWebService::Ichiba::Item.search` など`search`メソッドはページングのためのメソッドを持ったオブジェクトを返します。
+
+```ruby
+  items = RakutenWebService::Ichiba::Item.search(keyword: 'Ruby')
+  items.count #=> 30. デフォルトで1度のリクエストで30件の商品情報が返ってくる
+
+  last_items = items.page(3) # 3ページ目の情報を取る
+
+  # 最後のページまでスキップする
+  while last_items.has_next_page?
+    last_items = last_items.next_page
+  end
+
+  # 最後のページの商品名を表示
+  last_items.each do |item|
+    puts item.name
+  end
+
+  # 上記の処理をより簡潔に書くと以下のようになる
+  items.page(3).all do |item|
+    puts item.name
   end
 ```
 
@@ -98,32 +113,87 @@ bundlerを利用したアプリケーションの場合、Gemfileに以下の1
 Genreクラスは、`children`や`parent`といったジャンル階層を辿るインターフェースを持っています。
 
 ```ruby
-  root = RakutenWebService::Ichiba::Genre.root # root genre
-  # children returns sub genres
+  root = RakutenWebService::Ichiba::Genre.root # ジャンルのルート
+  # children はそのジャンルの直下のサブジャンルを返す
   root.children.each do |child|
     puts "[#{child.id}] #{child.name}"
   end
 
-  # Use genre id to fetch genre object
+  # ジャンルの情報を引くため、ジャンルIDを用る
   RakutenWebService::Ichiba::Genre[100316].name # => "水・ソフトドリンク"
 ```
 
-
 ### 市場商品ランキング
 
 ```ruby
   ranking_by_age = RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 1) # 30代男性 のランキングTOP 30
   ranking_by_age.each do |ranking|
     # 'itemName'以外の属性については右記を参照 http://webservice.rakuten.co.jp/api/ichibaitemsearch/#outputParameter
-    puts ranking['itemName']
+    puts item.name
   end
 
   ranking_by_genre = RakutenWebService::Ichiba::Genre[200162].ranking # "水・ソフトドリンク" ジャンルのTOP 30
   ranking_by_genre.each do |ranking|
-    puts ranking['itemName']
+    puts item.name
+  end
+```
+
+### レシピ
+
+```ruby
+  categories = RakutenWebService::Recipe.small_categories
+
+  # 全種類の小カテゴリーを表示
+  categories.each do |category|
+    category.name
+  end
+
+  recipes = categories.first.ranking
+
+  # カテゴリーに対応するレシピを表示
+  recipes.each do |recipe|
+    recipe.title
   end
 ```
 
+## サポートしているAPI
+
+### 楽天市場API
+
+* [Rakuten Ichiba Item Search API](http://webservice.rakuten.co.jp/api/ichibaitemsearch/)
+* [Rakuten Ichiba Genre Search API](http://webservice.rakuten.co.jp/api/ichibagenresearch/)
+* [Rakuten Ichiba Ranking API](http://webservice.rakuten.co.jp/api/ichibaitemranking/)
+* [Rakuten Product API](http://webservice.rakuten.co.jp/api/productsearch/)
+* [Rakuten Ichiba Tag Search API](https://webservice.rakuten.co.jp/api/ichibatagsearch/)
+
+### 楽天ブックス系API
+
+* [Rakuten Books Total Search API](http://webservice.rakuten.co.jp/api/bookstotalsearch/)
+* [Rakuten Books Book Search API](http://webservice.rakuten.co.jp/api/booksbooksearch/)
+* [Rakuten Books CD Search API](http://webservice.rakuten.co.jp/api/bookscdsearch/)
+* [Rakuten Books DVD/Blu-ray Search API](http://webservice.rakuten.co.jp/api/booksdvdsearch/)
+* [Rakuten Books ForeignBook Search API](http://webservice.rakuten.co.jp/api/booksforeignbooksearch/)
+* [Rakuten Books Magazine Search API](http://webservice.rakuten.co.jp/api/booksmagazinesearch/)
+* [Rakuten Books Game Search API](http://webservice.rakuten.co.jp/api/booksgamesearch/)
+* [Rakuten Books Software Search API](http://webservice.rakuten.co.jp/api/bookssoftwaresearch/)
+* [Rakuten Books Genre Search API](http://webservice.rakuten.co.jp/api/booksgenresearch/)
+
+### 楽天Kobo系API
+
+* [楽天Kobo電子書籍検索API](http://webservice.rakuten.co.jp/api/koboebooksearch/)
+* [楽天Koboジャンル検索API](http://webservice.rakuten.co.jp/api/kobogenresearch/)
+
+### 楽天レシピ系API
+
+* [楽天レシピカテゴリ一覧API](https://webservice.rakuten.co.jp/api/recipecategorylist/)
+* [楽天レシピカテゴリ別ランキングAPI](https://webservice.rakuten.co.jp/api/recipecategoryranking/)
+
+### 楽天GORA系API
+
+* [楽天GORAゴルフ場検索API](https://webservice.rakuten.co.jp/api/goragolfcoursesearch/)
+* [楽天GORAゴルフ場詳細API](https://webservice.rakuten.co.jp/api/goragolfcoursedetail/)
+* [楽天GORAプラン検索API](https://webservice.rakuten.co.jp/api/goraplansearch/)
+
 ## Contributing
 
 1. Fork it