rakuten_web_service 1.10.0 → 1.13.1

data/README.md

@@ -1,5 +1,5 @@
 # RakutenWebService
-
+[![CI](https://github.com/rakuten-ws/rws-ruby-sdk/workflows/CI/badge.svg)](https://github.com/rakuten-ws/rws-ruby-sdk/actions?query=workflow%3ACI+branch%3Amaster)
 [![Build Status](https://travis-ci.org/rakuten-ws/rws-ruby-sdk.svg?branch=master)](https://travis-ci.org/rakuten-ws/rws-ruby-sdk)
 [![Gem Version](https://badge.fury.io/rb/rakuten_web_service.svg)](https://badge.fury.io/rb/rakuten_web_service)
 [![Test Coverage](https://codeclimate.com/github/rakuten-ws/rws-ruby-sdk/badges/coverage.svg)](https://codeclimate.com/github/rakuten-ws/rws-ruby-sdk/coverage)
@@ -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
 
@@ -57,12 +63,12 @@ If you have not got it, register your application [here](https://webservice.raku
 
 ### 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'
 
@@ -107,7 +113,7 @@ Responses of resources' `search` such as `RakutenWebService::Ichiba::Item.search
   last_items = items.page(3) # Skips first 2 pages.
 
   # Go to the last page
-  while last_items.has_next_page?
+  while last_items.next_page?
     last_items = last_items.next_page
   end
 
@@ -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
 ```
 
@@ -162,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
 

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

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

@@ -41,20 +41,4 @@ module RakutenWebService
       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

@@ -7,7 +7,7 @@ module RakutenWebService
     def self.inherited(klass)
       super
 
-      klass.set_parser do |response|
+      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/item.rb

@@ -17,8 +17,8 @@ module RakutenWebService
 
       endpoint 'https://app.rakuten.co.jp/services/api/IchibaItem/Search/20170706'
 
-      set_parser do |response|
-        response['Items'].map { |item| Item.new(item) }
+      parser do |response|
+        (response['Items'] || []).map { |item| Item.new(item) }
       end
 
       attribute :itemName, :catchcopy, :itemCode, :itemPrice,
@@ -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
 

data/lib/rakuten_web_service/ichiba/ranking.rb

@@ -7,7 +7,7 @@ module RakutenWebService
     class RankingItem < RakutenWebService::Ichiba::Item
       endpoint 'https://app.rakuten.co.jp/services/api/IchibaItem/Ranking/20170628'
 
-      set_parser do |response|
+      parser do |response|
         response['Items'].map { |item| RankingItem.new(item) }
       end
 

data/lib/rakuten_web_service/ichiba/tag.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rakuten_web_service/resource'
+
+module RakutenWebService
+  module Ichiba
+    class Tag < Resource
+      attribute :tagId, :tagName, :parentTagId
+
+      def search(params = {})
+        params = params.merge(tagId: id)
+        RakutenWebService::Ichiba::Item.search(params)
+      end
+    end
+  end
+end

data/lib/rakuten_web_service/ichiba/tag_group.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rakuten_web_service/resource'
+
+module RakutenWebService
+  module Ichiba
+    class TagGroup < Resource
+      endpoint 'https://app.rakuten.co.jp/services/api/IchibaTag/Search/20140222'
+
+      parser do |response|
+        response['tagGroups'].map { |tag_group| TagGroup.new(tag_group) }
+      end
+
+      attribute :tagGroupName, :tagGroupId
+
+      def tags
+        get_attribute('tags').map do |tag|
+          Tag.new(tag)
+        end
+      end
+    end
+  end
+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/kobo/ebook.rb

@@ -16,7 +16,7 @@ module RakutenWebService
         :reviewCount, :reviewAverage,
         :koboGenreId
 
-      set_parser do |response|
+      parser do |response|
         response['Items'].map { |i| new(i) }
       end
 

data/lib/rakuten_web_service/kobo/genre.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/genre'
 module RakutenWebService
   module Kobo
     class Genre < RakutenWebService::BaseGenre
-      set_resource_name :kobo_genre
+      self.resource_name = :kobo_genre
 
       root_id '101'
 

data/lib/rakuten_web_service/recipe/category.rb

@@ -37,7 +37,9 @@ module RakutenWebService
 
       def parent_category
         return nil if parent_category_type.nil?
-        Recipe.categories(parent_category_type).find { |c| c.id.to_i == parent_category_id.to_i }
+        Recipe.categories(parent_category_type).find do |c|
+          c.id.to_i == parent_category_id.to_i
+        end
       end
 
       def absolute_category_id

data/lib/rakuten_web_service/recipe.rb

@@ -15,7 +15,7 @@ module RakutenWebService
       :recipeIndication, :recipeCost,
       :recipePublishday, :rank
 
-    set_parser do |response|
+    parser do |response|
       response['result'].map { |r| Recipe.new(r) }
     end
 

data/lib/rakuten_web_service/resource.rb

@@ -12,6 +12,8 @@ module RakutenWebService
     using RakutenWebService::StringSupport
 
     class << self
+      attr_writer :resource_name
+
       def inherited(subclass)
         @@subclasses ||= []
         @@subclasses.push(subclass)
@@ -24,20 +26,11 @@ module RakutenWebService
       def attribute(*attribute_names)
         attribute_names.each do |attribute_name|
           attribute_name = attribute_name.to_s
-          method_name = attribute_name.to_snake
-          method_name = method_name.sub(/^#{resource_name}_(\w+)$/, '\1')
-
-          instance_eval do
-            define_method method_name do
-              get_attribute(attribute_name)
-            end
-          end
-          next if method_name !~ /(.+)_flag$/
-          instance_eval do
-            define_method "#{$1}?" do
-              get_attribute(attribute_name) == 1
-            end
-          end
+
+          define_getter_for_attribute(attribute_name)
+          next unless attribute_name.end_with?('Flag')
+
+          define_asking_method_for_attribute(attribute_name)
         end
       end
 
@@ -57,19 +50,36 @@ module RakutenWebService
         @resource_name ||= name.split('::').last.downcase
       end
 
-      def set_resource_name(name)
-        @resource_name = name
-      end
-
       def endpoint(url = nil)
         @endpoint = url || @endpoint
       end
 
-      def set_parser(&block)
+      def parser(&block)
         instance_eval do
           define_singleton_method :parse_response, block
         end
       end
+
+      private
+
+      def define_getter_for_attribute(attribute_name)
+        method_name = attribute_name.to_snake
+        method_name.sub!(/^#{resource_name}_(\w+)$/, '\1')
+
+        define_method method_name do
+          get_attribute(attribute_name)
+        end
+      end
+
+      def define_asking_method_for_attribute(attribute_name)
+        method_name = attribute_name.to_snake
+        method_name.sub!(/^#{resource_name}_(\w+)$/, '\1')
+        method_name.sub!(/(.+)_flag$/, '\1')
+
+        define_method "#{method_name}?" do
+          get_attribute(attribute_name) == 1
+        end
+      end
     end
 
     def initialize(params)
@@ -79,7 +89,6 @@ module RakutenWebService
 
     def [](key)
       camel_key = key.to_camel
-      # camel_key[0] = camel_key[0].downcase
       @params[key] || @params[camel_key]
     end