rakuten_web_service 0.6.3 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47b5569e0735b1e86b81ece9379494ba24dcbed1
-  data.tar.gz: 959707be796c57c8790ce6b37b251eb9955e8593
+  metadata.gz: b44c66119bf5c9b8fa5dc6b6de6ffac8ca51530d
+  data.tar.gz: 32c3815fb9e4e4d2304df63142cbb7dfa0bef592
 SHA512:
-  metadata.gz: 4fce2a1c0dea879426d99faa85bbe421f1b258ce4dbf150df22b859719d17aed5a17e52e9d7d6355c11a1665501517b4d6a0a1af2a795251783b3c487d150010
-  data.tar.gz: f89784d970a60b00caa9411970d43fa5598318dc87a577d75ac71bae077b0063e82b97029e994f033046c61f03c487d39392b44081bbbe0e3398fe2c317b3fd1
+  metadata.gz: 7ecd020582c74f06fdadb1ce977248998f5aaba06f2db8fe94c93412bdbf8de0a7c7a8867bf8470d602923684c36943d6f351a0fced044baced6f02df342ada6
+  data.tar.gz: 81cc1e9e67ad04c7116f817b882d7718046ad7c4a49dbb096c89855804f4f43570d13b9924f3cc3be83f65cd1f4e120508b46216060c297ddb892d18b91ab10d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,5 +1,21 @@
 language: ruby
+
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.3
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+
+cache: bundler
+
+before_install:
+  - gem install bundler
+
+matrix:
+  allow_failures:
+  - rvm: ruby-head
+
+addons:
+  code_climate:
+    repo_token:
+      secure: Z23O936LoCDGJ/OyYsLzxTUI+CMWyrfeN1PtQdCNMdF4vxwaCsAHr3ulTdudGhKMrVZGENSEK6fq0Xal3o3oPaH9aGM9sUQ/ibRM+J94Lx6Owu4okTsIHoEy4vFeW+A/62aiwxPcoi7PFrvC8FOfaZg+b+vvYAQcitVe6qwBHiE=

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v1.0.0.rc1
+
+## Enhancements
+
+* Start supporting Gora APIs. Thank you for your contribution @kamatama41 .[#29](https://github.com/rakuten-ws/rws-ruby-sdk/pull/29)
+* Start supporting Recipe APIs.
+* Update versions of supported Rakuten Web Service APIs.
+
+## Compatibility Changes
+
+* Supported Ruby versions are 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).
+
 # v0.6.3 
 
 * Update a gem dependency by @45deg

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rakuten_web_service.gemspec
 gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+  gem "coveralls", require: nil
+end

data/README.ja.md

@@ -0,0 +1,133 @@
+# RakutenWebService
+
+[![Build Status](https://travis-ci.org/rakuten-ws/rws-ruby-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-ruby-sdk)
+[![Gem Version](https://badge.fury.io/rb/rakuten_web_service.png)](http://badge.fury.io/rb/rakuten_web_service)
+[![Coverage Status](https://coveralls.io/repos/github/rakuten-ws/rws-ruby-sdk/badge.svg?branch=master)](https://coveralls.io/github/rakuten-ws/rws-ruby-sdk?branch=master)
+
+rakuten\_web\_serviceは、 Rubyから楽天が提供しているAPIに簡単にアクセスできるSDK(Software Development Kit)です。
+
+English version is [here](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.en.md).
+
+## インストール方法
+
+bundlerを利用したアプリケーションの場合、Gemfileに以下の1行を追加します。
+
+```ruby
+  gem 'rakuten_web_service'
+```
+
+そして`bundle`コマンドでインストール。
+
+    $ bundle
+
+もしくは、`gem`コマンドにより
+
+    $ 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の取得
+
+楽天ウェブサービスAPIを利用の際に、アプリケーションIDが必要です。
+まだ取得していない場合は、楽天ウェブサービスAPIの[アプリケーション登録](https://webservice.rakuten.co.jp/app/create)を行い、アプリケーションIDを取得してください。
+
+### 設定
+
+`RakutenWebService.configuration` メソッドを使い、Application IDとAffiliate ID（オプション）を指定することができます。
+
+```ruby
+  RakutenWebService.configuration do |c|
+    c.application_id = 'YOUR_APPLICATION_ID'
+    c.affiliate_id = 'YOUR_AFFILIATE_ID'
+  end
+```
+
+`'YOUR_APPLICATION_ID'` と `'YOUR_AFFILIATE_ID'` は、実際のアプリケーションIDとアフィリエイトIDに置き換えてください。
+
+### 市場商品の検索
+
+```ruby
+  items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enumerable object
+  items.first(10).each do |item|
+    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.
+  end
+```
+
+### ジャンル
+
+Genreクラスは、`children`や`parent`といったジャンル階層を辿るインターフェースを持っています。
+
+```ruby
+  root = RakutenWebService::Ichiba::Genre.root # root genre
+  # children returns sub genres
+  root.children.each do |child|
+    puts "[#{child.id}] #{child.name}"
+  end
+
+  # Use genre id to fetch genre object
+  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']
+  end
+
+  ranking_by_genre = RakutenWebService::Ichiba::Genre[200162].ranking # "水・ソフトドリンク" ジャンルのTOP 30
+  ranking_by_genre.each do |ranking|
+    puts ranking['itemName']
+  end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/README.md

@@ -1,88 +1,122 @@
 # RakutenWebService
 
-[![Build Status](https://travis-ci.org/rakuten-ws/rws-ruby-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-ruby-sdk) [![Gem Version](https://badge.fury.io/rb/rakuten_web_service.png)](http://badge.fury.io/rb/rakuten_web_service)
+[![Build Status](https://travis-ci.org/rakuten-ws/rws-ruby-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-ruby-sdk)
+[![Gem Version](https://badge.fury.io/rb/rakuten_web_service.png)](http://badge.fury.io/rb/rakuten_web_service)
+[![Coverage Status](https://coveralls.io/repos/github/rakuten-ws/rws-ruby-sdk/badge.svg?branch=master)](https://coveralls.io/github/rakuten-ws/rws-ruby-sdk?branch=master)
 
-rakuten\_web\_serviceは、 Rubyから楽天が提供しているAPIに簡単にアクセスできるSDK(Software Development Kit)です。
+This gem provides a client for easily accessing [Rakuten Web Service APIs](https://webservice.rakuten.co.jp/).
 
-English version is [here](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.en.md).
+# Table of Contents
 
-## インストール方法
+* [Prerequisite](#prerequisite)
+* [Installation](#installation)
+* [Usage](#usage)
+  * [Prerequisite: Getting Application ID](#prerequisite-getting-application-id)
+  * [Configuration](#configuration)
+  * [Search Ichiba Items](#search-ichiba-items)
+  * [Pagerizing](#pagerizing)
+  * [Genre](#genre)
+  * [Ichiba Item Ranking](#ichiba-item-ranking)
+* [Supported APIs](#supported-apis)
+  * [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)
+* [Contributing](#contributing)
 
-bundlerを利用したアプリケーションの場合、Gemfileに以下の1行を追加します。
+
+## Prerequisite
+
+* Ruby 2.1.0 or later
+
+## Installation
+
+Add this line to your application's Gemfile:
 
 ```ruby
   gem 'rakuten_web_service'
 ```
 
-そして`bundle`コマンドでインストール。
+And then execute:
 
     $ bundle
 
-もしくは、`gem`コマンドにより
+Or install it yourself as:
 
     $ gem install rakuten_web_service
 
-とすることでインストールできます。
 
-現在rakuten\_web\_serviceは下記のAPIをサポートしています。
+## Usage
 
-### 楽天市場API
+### Prerequisite: Getting Application ID
 
-* [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/)
+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
 
-### 楽天ブックス系API
+At first, you have to specify your application's key. And you can tell the client your afiiliate id with `RakutenWebService.configuration`.
 
-* [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/)
+```ruby
+  RakutenWebService.configuration do |c|
+    # (Required) Appliction ID for your application.
+    c.application_id = 'YOUR_APPLICATION_ID'
 
-## 使用方法
+    # (Optional) Affiliate ID for your Rakuten account.
+    c.affiliate_id = 'YOUR_AFFILIATE_ID' # default: nil
 
-### 事前準備: アプリケーションIDの取得
+    # (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
 
-楽天ウェブサービスAPIを利用の際に、アプリケーションIDが必要です。
-まだ取得していない場合は、楽天ウェブサービスAPIの[アプリケーション登録](https://webservice.rakuten.co.jp/app/create)を行い、アプリケーションIDを取得してください。
+    # (Optional) Enable debug mode. When set true, the client streams out all HTTP requests and
+    # responses to the standard error.
+    c.debug = true # default: false
+  end
+```
 
-### 設定
+Please note that you need to replace `'YOUR_APPLICATION_ID'` and `'YOUR_AFFILIATE_ID'` with actual ones you have.
 
-`RakutenWebService.configuration` メソッドを使い、Application IDとAffiliate ID（オプション）を指定することができます。
+### Search Ichiba Items
 
 ```ruby
-  RakutenWebService.configuration do |c|
-    c.application_id = 'YOUR_APPLICATION_ID'
-    c.affiliate_id = 'YOUR_AFFILIATE_ID'
+  items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enumerable object
+  items.first(10).each do |item|
+    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.
   end
 ```
 
-`'YOUR_APPLICATION_ID'` と `'YOUR_AFFILIATE_ID'` は、実際のアプリケーションIDとアフィリエイトIDに置き換えてください。
+### Pagerizing
 
-### 市場商品の検索
+Responses of resources' `search` such as `RakutenWebService::Ichiba::Item.search` have methods for paginating fetched resources.
 
 ```ruby
-  items = RakutenWebService::Ichiba::Item.search(:keyword => 'Ruby') # This returns Enumerable object
-  items.first(10).each do |item|
-    puts "#{item['itemName']}, #{item.price} yen" # You can refer to values as well as Hash.
+  items = RakutenWebService::Ichiba::Item.search(keyword: 'Ruby')
+  items.count #=> 30. In default, the API returns up to 30 items matched with given keywords.
+
+  last_items = items.page(3) # Skips first 2 pages.
+
+  # Go to the last page
+  while last_items.has_next_page?
+    last_items = last_items.next_page
+  end
+
+  # Shows the title of the last 30 items
+  last_items.each do |item|
+    puts item.name
+  end
+
+  items.all do |item|
+    puts item.name
   end
 ```
 
-### ジャンル
+### Genre
 
-Genreクラスは、`children`や`parent`といったジャンル階層を辿るインターフェースを持っています。
+Genre class provides an interface to traverse sub genres.
 
 ```ruby
   root = RakutenWebService::Ichiba::Genre.root # root genre
@@ -96,13 +130,60 @@ Genreクラスは、`children`や`parent`といったジャンル階層を辿る
 ```
 
 
-### 市場商品ランキング
+### Ichiba Item Ranking
 
 ```ruby
-  RakutenWebService::Ichiba::Item.ranking(:age => 30, :sex => 0) # 30代男性 のランキングTOP 30
-  RakutenWebService::Ichiba::Genre[100316].ranking # "水・ソフトドリンク" ジャンルのTOP 30
+  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
+  ranking_by_age.each do |ranking|
+    puts ranking['itemName']
+  end
+
+  ranking_by_genre = RakutenWebService::Ichiba::Genre[200162].ranking # the TOP 30 items in "水・ソフトドリンク" genre
+  ranking_by_genre.each do |ranking|
+    puts ranking['itemName']
+  end
 ```
 
+## Supported APIs
+
+Now rakuten\_web\_service is supporting the following APIs:
+
+### Rakuten Ichiba APIs
+
+* [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 Books APIs
+
+* [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/)
+
+### Rakuten Kobo APIs
+
+* [Rakuten Kobo Ebook Search API](http://webservice.rakuten.co.jp/api/koboebooksearch/)
+* [Rakuten Kobo Genre Search API](http://webservice.rakuten.co.jp/api/kobogenresearch/)
+
+### Rakuten Recipe APIs
+
+* [Rakuten Recipe Category List API](https://webservice.rakuten.co.jp/api/recipecategorylist/)
+* [Rakuten Recipe Category Ranking API](https://webservice.rakuten.co.jp/api/recipecategoryranking/)
+
+### 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/)
+
 ## Contributing
 
 1. Fork it