rakuten_web_service 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f66fb3ced048c2710640e4e32c241dd4ce7a2db17acd084a2f0228feed0b76
-  data.tar.gz: b8c080ef1f1bdbd68117c8d82bc5723458c0b954fcf859c1c04862b025e3beac
+  metadata.gz: bdb4eed0f6b4075f460d74c30218551f0345c9bc12cda1a433bdcf9525e4ff64
+  data.tar.gz: ce188517ae7113a4322b35b271c9c5fccda23f0bb5694a8047bea1afdbf25a0c
 SHA512:
-  metadata.gz: 71c17732c800e111dd727bbabbf04ebde576d95ae269724d3aaef79446b1ffb7b8608b44efa3cf35fae6830b8b1a3daee7e9203b9f1dcfcd13efae878b3ae915
-  data.tar.gz: 9b737c01bd7de2d7f47a958a0c191a608cecf854ad353034e76a45905a1ecccad0c244af999ed78ead0431e563be2450a88fd640e2222a07e093d53e8f7ad29d
+  metadata.gz: 8b996cb29aa1fc0dd7634ee33dced0386e0d320711a42e98a20af695815df35709778d2150327551fa2dffe27a69407eb04f0aa4a3c72d01ba485e8e6ac172b7
+  data.tar.gz: 265354c69faacb14e9fe3aa3565b44d9813a8011562b913a3fe4ee017ea3e18bc4cf4df0e1f97295a5eb5c235a3beecc75e9efa37ecb89543fee5543c8e49307

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,14 +1,10 @@
 language: ruby
 rvm:
-  - 2.4.3
-  - 2.5.0
-  - 2.6.0
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
 
-env:
-  - INTEGRATION=yes
-  - INTEGRATION=no
-
 group: travis_lts
 
 cache: bundler
@@ -18,8 +14,7 @@ before_install:
   - 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
@@ -30,13 +25,6 @@ after_script:
 matrix:
   allow_failures:
   - rvm: ruby-head
-  exclude:
-  - rvm: 2.4.3
-    env: INTEGRATION=yes
-  - rvm: 2.5.0
-    env: INTEGRATION=yes
-  - rvm: ruby-head
-    env: INTEGRATION=yes
 
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # CHANGELOG
 
+## 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

data/Gemfile

@@ -4,10 +4,10 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'simplecov', '~> 0.15.1', require: false
+  gem 'simplecov', '~> 0.17.1', require: false
 end
 
 group :vscode do
-  gem 'debase', '0.2.2'
-  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

data/README.md

@@ -8,6 +8,8 @@
 
 This gem provides a client for easily accessing [Rakuten Web Service APIs](https://webservice.rakuten.co.jp/).
 
+日本語のドキュメントは[こちら](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.ja.md)。
+
 ## Table of Contents
 
 * [Prerequisite](#prerequisite)
@@ -30,23 +32,27 @@ This gem provides a client for easily accessing [Rakuten Web Service APIs](https
 
 ## Prerequisite
 
-* Ruby 2.3 or later
+* Ruby 2.5 or later
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-  gem 'rakuten_web_service'
+gem 'rakuten_web_service'
 ```
 
 And then execute:
 
-    bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    gem install rakuten_web_service
+```sh
+gem install rakuten_web_service
+```
 
 ## Usage
 
@@ -143,12 +149,30 @@ Genre class provides an interface to traverse sub genres.
   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']
+    puts item.name
   end
 
   ranking_by_genre = RakutenWebService::Ichiba::Genre[200162].ranking # the TOP 30 items in "水・ソフトドリンク" genre
   ranking_by_genre.each do |ranking|
-    puts ranking['itemName']
+    puts item.name
+  end
+```
+
+### Recipe
+
+```ruby
+  categories = RakutenWebService::Recipe.small_categories
+
+  # Search all small recipe categories.
+  categories.each do |category|
+    category.name
+  end
+
+  recipes = categories.first.ranking
+
+  # Search category recipes.
+  recipes.each do |recipe|
+    recipe.title
   end
 ```
 

data/examples/ichiba_item_search.rb

@@ -10,5 +10,5 @@ end
 items = RakutenWebService::Ichiba::Item.search(keyword: keyword)
 
 items.first(10).each do |item|
-  puts "#{item['itemName']}, #{item['itemPrice']} yen"
+  puts "#{item.name}, #{item.price} yen"
 end

data/examples/recipe_search.rb

@@ -0,0 +1,16 @@
+require 'rakuten_web_service'
+
+application_id = ARGV.shift
+keyword = ARGV[0..-1].join(' ')
+
+RakutenWebService.configure do |c|
+  c.application_id = application_id
+end
+
+category = RakutenWebService::Recipe.small_categories.find { |c| c.name.match(keyword) }
+
+recipes = category.ranking
+
+recipes.first(10).each do |recipe|
+  puts "#{recipe.title} is made by #{recipe.nickname}"
+end

data/lib/rakuten_web_service/all_proxy.rb

@@ -14,7 +14,8 @@ module RakutenWebService
         search_result.each do |resource|
           yield resource
         end
-        break unless search_result.has_next_page?
+        break unless search_result.next_page?
+
         search_result = search_result.next_page
       end
     end