rakuten_web_service 1.9.1 → 1.13.0

data/README.md

@@ -8,7 +8,9 @@
 
 This gem provides a client for easily accessing [Rakuten Web Service APIs](https://webservice.rakuten.co.jp/).
 
-# Table of Contents
+日本語のドキュメントは[こちら](http://github.com/rakuten-ws/rws-ruby-sdk/blob/master/README.ja.md)。
+
+## Table of Contents
 
 * [Prerequisite](#prerequisite)
 * [Installation](#installation)
@@ -25,53 +27,56 @@ This gem provides a client for easily accessing [Rakuten Web Service APIs](https
   * [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.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
 
 ### 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`.
+At first, you have to specify your application's key. And you can tell the client your afiiliate id with `RakutenWebService.configure`.
 
 #### In Your Code
 
 ```ruby
-  RakutenWebService.configuration do |c|
+  RakutenWebService.configure 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
 
-    # (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
@@ -88,7 +93,6 @@ Please note that you need to replace `'YOUR_APPLICATION_ID'` and `'YOUR_AFFILIAT
 
 You can configure `application_id` and `affiliate_id` by defining environment variables `RWS_APPLICATION_ID` and `RWS_AFFILIATION_ID`.
 
-
 ### Search Ichiba Items
 
 ```ruby
@@ -139,19 +143,36 @@ Genre class provides an interface to traverse sub genres.
   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
   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
 ```
 
@@ -165,6 +186,7 @@ Now rakuten\_web\_service is supporting the following APIs:
 * [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/)
 
 ### Rakuten Books APIs
 
@@ -194,6 +216,11 @@ Now rakuten\_web\_service is supporting the following APIs:
 * [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

data/Rakefile

@@ -1,6 +1,19 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
+task :endpoints do
+  require 'rakuten_web_service'
+  require 'terminal-table'
+
+  table = Terminal::Table.new(headings: %w[Resource Endpoint]) do |t|
+    RakutenWebService::Resource.subclasses.each do |resource|
+      t << [resource.name, resource.endpoint] unless resource.endpoint.nil?
+    end
+  end
+
+  puts table
+end
+
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
   t.rspec_opts = '-c -fd'

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/examples/travel_apis.rb

@@ -0,0 +1,19 @@
+require 'rakuten_web_service'
+
+application_id = ARGV.shift
+
+RakutenWebService.configure do |c|
+  c.application_id = application_id
+end
+
+tokyo = RakutenWebService::Travel::AreaClass::SmallClass['tokyo']
+
+nikotama = tokyo.children.find do |detail_area|
+  detail_area.class_name =~ /二子玉川/
+end
+
+puts "#{nikotama.class_code}: #{nikotama.class_name}"
+
+nikotama.search(responseType: 'large').first(3).each do |hotel|
+  puts "#{hotel.basic_info['hotelName']} \n\t#{hotel.basic_info['address1']} #{hotel.basic_info['address2']}"
+end

data/lib/rakuten_web_service.rb

@@ -1,10 +1,27 @@
 # frozen_string_literal: true
 
-module RakutenWebService; end
+require 'rakuten_web_service/configuration'
+
+module RakutenWebService
+  def configure(&block)
+    raise ArgumentError, 'Block is required' unless block
+    raise ArgumentError, 'Block is required to have one argument' if block.arity != 1
+    yield configuration
+
+    configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  module_function :configure, :configuration
+end
 RWS = RakutenWebService
 
 require 'rakuten_web_service/ichiba'
 require 'rakuten_web_service/books'
+require 'rakuten_web_service/travel'
 require 'rakuten_web_service/kobo'
 require 'rakuten_web_service/gora'
 require 'rakuten_web_service/recipe'

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

data/lib/rakuten_web_service/books/genre.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/genre'
 module RakutenWebService
   module Books
     class Genre < RakutenWebService::BaseGenre
-      set_resource_name 'books_genre'
+      self.resource_name = 'books_genre'
 
       endpoint 'https://app.rakuten.co.jp/services/api/BooksGenre/Search/20121128'
 

data/lib/rakuten_web_service/books/resource.rb

@@ -6,7 +6,7 @@ require 'rakuten_web_service/books/genre'
 module RakutenWebService
   module Books
     class Resource < RakutenWebService::Resource
-      set_parser do |response|
+      parser do |response|
         response['Items'].map { |item| new(item) }
       end
 

data/lib/rakuten_web_service/books/total.rb

@@ -7,7 +7,7 @@ module RakutenWebService
     class Total < Books::Resource
       endpoint 'https://app.rakuten.co.jp/services/api/BooksTotal/Search/20170404'
 
-      set_parser do |response|
+      parser do |response|
         response['Items'].map do |item|
           resource_class = find_resource_by_genre_id(item['booksGenreId'])
           resource_class.new(item)

data/lib/rakuten_web_service/client.rb

@@ -9,6 +9,8 @@ require 'rakuten_web_service/error'
 
 module RakutenWebService
   class Client
+    USER_AGENT = "RakutenWebService SDK for Ruby v#{RWS::VERSION}(ruby-#{RUBY_VERSION} [#{RUBY_PLATFORM}])".freeze
+
     attr_reader :url
 
     def initialize(resource_class)
@@ -20,25 +22,23 @@ module RakutenWebService
       params = RakutenWebService.configuration.generate_parameters(params)
       response = request(url.path, params)
       body = JSON.parse(response.body)
-
-      if Net::HTTPSuccess === response
-        return RakutenWebService::Response.new(@resource_class, body)
+      unless response.is_a?(Net::HTTPSuccess)
+        raise RakutenWebService::Error.for(response)
       end
-      raise RakutenWebService::Error.repository[response.code.to_i], body['error_description']
+
+      RakutenWebService::Response.new(@resource_class, body)
     end
 
     private
 
     def request(path, params)
-      http = Net::HTTP.new(@url.host, @url.port)
+      http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
       if RakutenWebService.configuration.debug_mode?
         http.set_debug_output($stderr)
       end
-      path = "#{path}?#{params.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')}"
-      header = {
-        'User-Agent' => "RakutenWebService SDK for Ruby v#{RWS::VERSION}(ruby-#{RUBY_VERSION} [#{RUBY_PLATFORM}])"
-      }
+      path = "#{path}?#{URI.encode_www_form(params)}"
+      header = { 'User-Agent' => USER_AGENT }
       http.get(path, header)
     end
   end

data/lib/rakuten_web_service/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rakuten_web_service/string_support'
+
 module RakutenWebService
   class Configuration
     attr_accessor :application_id, :affiliate_id, :max_retries, :debug
@@ -29,28 +31,14 @@ module RakutenWebService
 
     private
 
+    using RakutenWebService::StringSupport
+
     def convert_snake_key_to_camel_key(params)
       params.inject({}) do |h, (k, v)|
-        k = k.to_s.gsub(/([a-z]{1})_([a-z]{1})/) { "#{$1}#{$2.capitalize}" }
+        k = k.to_s.to_camel
         h[k] = v
         h
       end
     end
   end
-
-  def configure(&block)
-    @configuration ||= Configuration.new
-    if block
-      raise ArgumentError, 'Block is required to have one argument' if block.arity != 1
-      yield @configuration
-    end
-    @configuration
-  end
-
-  def configuration(&block)
-    warn 'Warning: RakutenWebService.configuration is deprecated. Use RakutenWebService.configure.' if block_given?
-    configure(&block)
-  end
-
-  module_function :configure, :configuration
 end

data/lib/rakuten_web_service/error.rb

@@ -6,6 +6,11 @@ module RakutenWebService
       repository[status_code] = error
     end
 
+    def self.for(response)
+      error_class = repository[response.code.to_i]
+      error_class.new(JSON.parse(response.body)['error_description'])
+    end
+
     def self.repository
       @repository ||= {}
     end

data/lib/rakuten_web_service/genre.rb

@@ -5,7 +5,9 @@ require 'rakuten_web_service/resource'
 module RakutenWebService
   class BaseGenre < RakutenWebService::Resource
     def self.inherited(klass)
-      klass.set_parser do |response|
+      super
+
+      klass.parser do |response|
         current = response['current']
         %w[children parents brothers].each do |type|
           elements = Array(response[type]).map { |e| klass.new(e) }

data/lib/rakuten_web_service/gora/course.rb

@@ -7,7 +7,7 @@ module RakutenWebService
     class Course < Resource
       endpoint 'https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseSearch/20170623'
 
-      set_parser do |response|
+      parser do |response|
         response['Items'].map { |item| new(item) }
       end
 

data/lib/rakuten_web_service/gora/course_detail.rb

@@ -13,7 +13,7 @@ module RakutenWebService
 
       endpoint 'https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseDetail/20170623'
 
-      set_parser do |response|
+      parser do |response|
         [new(response['Item'])]
       end
 

data/lib/rakuten_web_service/gora/plan.rb

@@ -7,7 +7,7 @@ module RakutenWebService
     class Plan < Resource
       endpoint 'https://app.rakuten.co.jp/services/api/Gora/GoraPlanSearch/20170623'
 
-      set_parser do |response|
+      parser do |response|
         response['Items'].map { |item| new(item) }
       end
 

data/lib/rakuten_web_service/ichiba.rb

@@ -8,3 +8,5 @@ require 'rakuten_web_service/ichiba/item'
 require 'rakuten_web_service/ichiba/genre'
 require 'rakuten_web_service/ichiba/ranking'
 require 'rakuten_web_service/ichiba/product'
+require 'rakuten_web_service/ichiba/tag_group'
+require 'rakuten_web_service/ichiba/tag'

data/lib/rakuten_web_service/ichiba/item.rb

@@ -17,7 +17,7 @@ module RakutenWebService
 
       endpoint 'https://app.rakuten.co.jp/services/api/IchibaItem/Search/20170706'
 
-      set_parser do |response|
+      parser do |response|
         response['Items'].map { |item| Item.new(item) }
       end
 
@@ -34,7 +34,7 @@ module RakutenWebService
                 :reviewCount, :reviewAverage,
                 :pointRate, :pointRateStartTime, :pointRateEndTime,
                 :shopName, :shopCode, :shopUrl, :shopAffiliateUrl,
-                :genreId
+                :genreId, :tagIds
 
       def genre
         Genre.new(genre_id)

data/lib/rakuten_web_service/ichiba/product.rb

@@ -8,7 +8,7 @@ module RakutenWebService
     class Product < Resource
       endpoint 'https://app.rakuten.co.jp/services/api/Product/Search/20170426'
 
-      set_parser do |response|
+      parser do |response|
         (response['Products'] || []).map { |prod| Product.new(prod) }
       end