rakuten_web_service 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83286096e80c11fd787ab5164cda5fbe4831a67ebdf632dc60362902b097fcc8
-  data.tar.gz: f3c679a0bd4e3f709b3de7af151b0a303e3218c2e3e2f2c24320b0ffdd1d94ab
+  metadata.gz: 7680e31b8cfe5db1599dfa4e721a69819fc5f4a47a2b36c12c703a7f967457ea
+  data.tar.gz: e13ad84b8941b87dd2ad6bfbdd496efec1639bc27d4d262935889ac49e1f23ac
 SHA512:
-  metadata.gz: 4e809916a2e388516dce43548638d0ebac5a055fe260583fee6c9cbe5b9a9813bf412234073c347419b48e443989e8c52ada62945df76be158295e42e43e00fa
-  data.tar.gz: 789738d853d0c6df9ba663ab88c8910db9bb7b4557f1a5542905abf7ac9028adec4375caf3f706580acbed09b3a68192e3d6ca9423b05d05f3258fd70a7fed8e
+  metadata.gz: 7776c1c27d1ab2e47c9c6d23bc770e572490605e5e98f187c35d17f3a1cfae7e17ddd4ce4f963fa902dfebdc05528767d9348add83ff54c47197bbcd84b11847
+  data.tar.gz: 0b0bf4c5223e8dcdbbbc6e20e09743b738a5f8499ce2de1701c84fcfca608526dff24fb87ce7c593e459a02397da49179d183f1053aa65f24c27dfab325518a8

data/.github/workflows/ci.yml

@@ -29,3 +29,19 @@ jobs:
           bundler-cache: true
       - name: Run test
         run: bundle exec rake
+
+  rbs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        env:
+          BUNDLE_WITHOUT: vscode
+        with:
+          ruby-version: 4.0
+          bundler-cache: true
+      - name: Check generated RBS signatures are up to date
+        run: bundle exec rake sig:check
+      - name: Validate RBS signatures
+        run: bundle exec rbs -r uri -r json -I sig validate

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v1.17.0 (2026/06/02)
+
+### Improvements
+
+- Ships RBS type signatures under `sig/` so users can type-check code that uses this gem.
+  - `SearchResult`, `Response` and `AllProxy` are generic over the resource class, so e.g. `Ichiba::Item.search(...).first` is typed as `Ichiba::Item?`.
+  - Reader methods defined by `attribute` are declared in `sig/generated/attributes.rbs`, generated by `rake sig:generate`.
+
 ## v1.13.2 (2023/03/26)
 
 ### Improvements

data/README.ja.md

@@ -51,6 +51,10 @@ gem install rakuten_web_service
     # (必須) アプリケーションID
     c.application_id = 'YOUR_APPLICATION_ID'
 
+    # (必須) アクセスキー
+    # 注意: セキュリティ上の理由から、この値はシークレットマネージャーまたは環境変数から取得することを推奨します。
+    c.access_key = 'YOUR_ACCESS_KEY'
+
     # (任意) 楽天アフィリエイトID
     c.affiliate_id = 'YOUR_AFFILIATE_ID' # default: nil
 

data/README.md

@@ -72,6 +72,10 @@ At first, you have to specify your application's key. And you can tell the clien
     # (Required) Appliction ID for your application.
     c.application_id = 'YOUR_APPLICATION_ID'
 
+    # (Required) Access key
+    # Note: For security purposes, we recommend retrieving this value from a secrets manager or environment variable.
+    c.access_key = 'YOUR_ACCESS_KEY'
+
     # (Optional) Affiliate ID for your Rakuten account.
     c.affiliate_id = 'YOUR_AFFILIATE_ID' # default: nil
 

data/Rakefile

@@ -14,6 +14,50 @@ task :endpoints do
   puts table
 end
 
+namespace :sig do
+  ATTRIBUTES_SIG = 'sig/generated/attributes.rbs'
+
+  # Builds RBS declarations for the reader methods that `Resource.attribute`
+  # defines dynamically, so they are visible to type checkers.
+  def attributes_sig
+    require 'rakuten_web_service'
+
+    resource_file = File.expand_path('lib/rakuten_web_service/resource.rb', __dir__)
+    resource_classes = ObjectSpace.each_object(Class).select { |klass| klass < RakutenWebService::Resource }
+
+    sig = +"# This file is generated by `rake sig:generate`. Do not edit it by hand.\n"
+    resource_classes.sort_by(&:name).each do |klass|
+      # Skip methods overridden by a hand-written definition; those are
+      # declared in the hand-written signatures.
+      method_names = klass.attribute_methods.uniq.select do |method_name|
+        klass.instance_method(method_name).source_location&.first == resource_file
+      end
+      next if method_names.empty?
+
+      sig << "\nclass #{klass.name} < #{klass.superclass.name}\n"
+      method_names.each do |method_name|
+        return_type = method_name.end_with?('?') ? 'bool' : 'untyped'
+        sig << "  def #{method_name}: () -> #{return_type}\n"
+      end
+      sig << "end\n"
+    end
+    sig
+  end
+
+  desc "Generate #{ATTRIBUTES_SIG} from the attributes declared in resources"
+  task :generate do
+    FileUtils.mkdir_p(File.dirname(ATTRIBUTES_SIG))
+    File.write(ATTRIBUTES_SIG, attributes_sig)
+  end
+
+  desc "Check that #{ATTRIBUTES_SIG} is up to date"
+  task :check do
+    unless File.exist?(ATTRIBUTES_SIG) && File.read(ATTRIBUTES_SIG) == attributes_sig
+      abort "#{ATTRIBUTES_SIG} is outdated. Run `rake sig:generate`."
+    end
+  end
+end
+
 RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
   t.rspec_opts = '-c -fd'

data/lib/rakuten_web_service/books/book.rb

@@ -5,8 +5,8 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class Book < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksBook/Search/20170404'
 
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksBook/Search/20170404'
       attribute :title, :titleKana, :subTitle, :subTitleKana,
                 :seriesName, :seriesNameKana,
                 :contents, :contentsKana,

data/lib/rakuten_web_service/books/cd.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class CD < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksCD/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksCD/Search/20170404'
 
       attribute :title, :titleKana, :artistName, :artistNameKana,
                 :label, :jan, :makerCode,

data/lib/rakuten_web_service/books/dvd.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class DVD < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksDVD/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksDVD/Search/20170404'
 
       attribute :title, :titleKana, :artistName, :artistNameKana,
                 :label, :jan, :makerCode,

data/lib/rakuten_web_service/books/foreign_book.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/resource'
 module RakutenWebService
   module Books
     class ForeignBook < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksForeignBook/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksForeignBook/Search/20170404'
 
       attribute :title, :titleKana, :japaneseTitle,
                 :author, :authorKana,

data/lib/rakuten_web_service/books/game.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class Game < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksGame/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksGame/Search/20170404'
 
       attribute :title, :titleKana, :hardware, :jan, :makerCode,
                 :itemCaption,

data/lib/rakuten_web_service/books/genre.rb

@@ -7,7 +7,7 @@ module RakutenWebService
     class Genre < RakutenWebService::BaseGenre
       self.resource_name = 'books_genre'
 
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksGenre/Search/20121128'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksGenre/Search/20121128'
 
       attribute :booksGenreId, :booksGenreName, :genreLevel, :itemCount
 

data/lib/rakuten_web_service/books/magazine.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class Magazine < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksMagazine/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksMagazine/Search/20170404'
 
       attribute :title, :titleKana, :publisherName, :jan,
                 :itemCaption,

data/lib/rakuten_web_service/books/software.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class Software < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksSoftware/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksSoftware/Search/20170404'
 
       attribute :title, :titleKana, :os, :jan, :makerCode,
                 :itemCaption,

data/lib/rakuten_web_service/books/total.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/books/resource'
 module RakutenWebService
   module Books
     class Total < Books::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/BooksTotal/Search/20170404'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/BooksTotal/Search/20170404'
 
       parser do |response|
         response['Items'].map do |item|

data/lib/rakuten_web_service/client.rb

@@ -39,6 +39,12 @@ module RakutenWebService
       end
       path = "#{path}?#{URI.encode_www_form(params)}"
       header = { 'User-Agent' => USER_AGENT }
+      if RakutenWebService.configuration.access_key
+        case RakutenWebService.configuration.access_key_transport
+        when :access_key_header
+          header['accessKey'] = RakutenWebService.configuration.access_key
+        end
+      end
       http.get(path, header)
     end
   end

data/lib/rakuten_web_service/configuration.rb

@@ -4,12 +4,17 @@ require 'rakuten_web_service/string_support'
 
 module RakutenWebService
   class Configuration
-    attr_accessor :application_id, :affiliate_id, :max_retries, :debug
+    attr_accessor :application_id, :affiliate_id, :max_retries, :debug, :access_key
+    attr_reader :access_key_transport
+
+    ALLOWED_ACCESS_KEY_TRANSPORTS = [:access_key_header, :query].freeze
 
     def initialize
       @application_id = ENV['RWS_APPLICATION_ID']
       @affiliate_id = ENV['RWS_AFFILIATE_ID']
       @max_retries = 5
+      @access_key = ENV['RWS_ACCESS_KEY']
+      @access_key_transport = :access_key_header
     end
 
     def generate_parameters(params)
@@ -17,18 +22,29 @@ module RakutenWebService
     end
 
     def default_parameters
-      raise 'Application ID is not defined' unless has_required_options?
-      { application_id: application_id, affiliate_id: affiliate_id, format_version: '2' }
+      raise 'Application ID and access key are not defined' unless has_required_options?
+      params = { application_id: application_id, affiliate_id: affiliate_id, format_version: '2' }
+      if access_key_transport == :query
+        params[:access_key] = access_key
+      end
+      params
     end
 
     def has_required_options?
-      application_id && application_id != ''
+      application_id && application_id != '' && access_key && access_key != ''
     end
 
     def debug_mode?
       ENV.key?('RWS_SDK_DEBUG') || debug
     end
 
+    def access_key_transport=(value)
+      unless ALLOWED_ACCESS_KEY_TRANSPORTS.include?(value&.to_sym)
+        raise ArgumentError, "Invalid access_key_transport value: #{value}, expected one of: #{ALLOWED_ACCESS_KEY_TRANSPORTS.inspect}"
+      end
+      @access_key_transport = value&.to_sym
+    end
+
     private
 
     using RakutenWebService::StringSupport

data/lib/rakuten_web_service/error.rb

@@ -8,7 +8,10 @@ module RakutenWebService
 
     def self.for(response)
       error_class = repository[response.code.to_i]
-      error_class.new(JSON.parse(response.body)['error_description'])
+      json_body = JSON.parse(response.body)
+      # Note: In some case (e.g. authentication info missing), the server returns another format of error response like following:
+      #       {"errors"=>{"errorCode"=>400, "errorMessage"=>"accessKey must be present as a query parameter or in the header"}}
+      error_class.new(json_body['error_description'] || json_body.dig('errors', 'errorMessage'))
     end
 
     def self.repository

data/lib/rakuten_web_service/gora/course.rb

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

data/lib/rakuten_web_service/gora/course_detail.rb

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

data/lib/rakuten_web_service/gora/plan.rb

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

data/lib/rakuten_web_service/ichiba/genre.rb

@@ -7,9 +7,9 @@ require 'rakuten_web_service/ichiba/product'
 module RakutenWebService
   module Ichiba
     class Genre < RakutenWebService::BaseGenre
-      endpoint 'https://app.rakuten.co.jp/services/api/IchibaGenre/Search/20140222'
+      endpoint 'https://openapi.rakuten.co.jp/ichibagt/api/IchibaGenre/Search/20170711'
 
-      attribute :genreId, :genreName, :genreLevel, :itemCount
+      attribute :genreId, :genreName, :genreLevel, :englishName, :linkGenreId, :chopperFlg, :lowestFlg, :itemCount
 
       root_id 0
 

data/lib/rakuten_web_service/ichiba/item.rb

@@ -15,7 +15,7 @@ module RakutenWebService
         end
       end
 
-      endpoint 'https://app.rakuten.co.jp/services/api/IchibaItem/Search/20220601'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/IchibaItem/Search/20220601'
 
       parser do |response|
         (response['Items'] || []).map { |item| Item.new(item) }

data/lib/rakuten_web_service/ichiba/product.rb

@@ -6,14 +6,14 @@ require 'rakuten_web_service/ichiba/genre'
 module RakutenWebService
   module Ichiba
     class Product < Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/Product/Search/20170426'
+      endpoint 'https://openapi.rakuten.co.jp/ichibaproduct/api/Product/Search/20250801'
 
       parser do |response|
         (response['Products'] || []).map { |prod| Product.new(prod) }
       end
 
-      attribute :productId, :productName, :productNo, :brandName,
-        :productUrlPC, :productUrlMobile, :affiliateUrl,
+      attribute :productId, :productCode, :productName, :productNo, :brandName,
+        :productUrlPC, :productUrlMobile, :searchUrl, :affiliateUrl,
         :smallImageUrl, :mediumImageUrl,
         :productCaption, :releaseDate,
         :makerCode, :makerName, :makerNameKana, :makerNameFormal,
@@ -24,7 +24,7 @@ module RakutenWebService
         :minPrice, :salesMinPrice, :usedExcludeMinPrice, :usedExcludeSalesMinPrice,
         :averagePrice,
         :reviewCount, :reviewAverage, :reviewUrlPC, :reviewUrlMobile,
-        :rankTargetGenreId, :rankTargetProductCount,
+        :rank, :rankTargetGenreId, :rankTargetProductCount,
         :genreId, :genreName,
         :ProductDetails
 

data/lib/rakuten_web_service/ichiba/ranking.rb

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

data/lib/rakuten_web_service/ichiba/tag_group.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/resource'
 module RakutenWebService
   module Ichiba
     class TagGroup < Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/IchibaTag/Search/20140222'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/IchibaTag/Search/20140222'
 
       parser do |response|
         response['tagGroups'].map { |tag_group| TagGroup.new(tag_group) }

data/lib/rakuten_web_service/kobo/ebook.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/resource'
 module RakutenWebService
   module Kobo
     class Ebook < RakutenWebService::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/Kobo/EbookSearch/20170426'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/Kobo/EbookSearch/20170426'
 
       attribute :title, :titleKana, :subTitle, :seriesName,
         :author, :authorKana, :publisherName,

data/lib/rakuten_web_service/kobo/genre.rb

@@ -9,7 +9,7 @@ module RakutenWebService
 
       root_id '101'
 
-      endpoint 'https://app.rakuten.co.jp/services/api/Kobo/GenreSearch/20131010'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/Kobo/GenreSearch/20131010'
 
       attribute :koboGenreId, :koboGenreName, :genreLevel, :itemCount
 

data/lib/rakuten_web_service/recipe/category.rb

@@ -27,7 +27,7 @@ module RakutenWebService
     end
 
     class Category < Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/Recipe/CategoryList/20170426'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/Recipe/CategoryList/20170426'
 
       attribute :categoryId, :categoryName, :categoryUrl, :parentCategoryId, :categoryType
 

data/lib/rakuten_web_service/recipe.rb

@@ -6,7 +6,7 @@ require 'rakuten_web_service/recipe/category'
 
 module RakutenWebService
   class Recipe < Resource
-    endpoint 'https://app.rakuten.co.jp/services/api/Recipe/CategoryRanking/20170426'
+    endpoint 'https://openapi.rakuten.co.jp/services/api/Recipe/CategoryRanking/20170426'
 
     attribute :recipeId, :recipeTitle, :recipeUrl,
       :foodImageUrl, :mediumImageUrl, :smallImageUrl,

data/lib/rakuten_web_service/resource.rb

@@ -34,6 +34,12 @@ module RakutenWebService
         end
       end
 
+      # Names of the reader methods defined by `attribute` on this class
+      # (not including ones inherited from superclasses).
+      def attribute_methods
+        @attribute_methods ||= []
+      end
+
       def search(options)
         SearchResult.new(options, self)
       end
@@ -69,6 +75,7 @@ module RakutenWebService
         define_method method_name do
           get_attribute(attribute_name)
         end
+        attribute_methods << method_name
       end
 
       def define_asking_method_for_attribute(attribute_name)
@@ -79,6 +86,7 @@ module RakutenWebService
         define_method "#{method_name}?" do
           get_attribute(attribute_name) == 1
         end
+        attribute_methods << "#{method_name}?"
       end
     end
 

data/lib/rakuten_web_service/travel/area_class.rb

@@ -18,7 +18,7 @@ module RakutenWebService
       module_function :search, :[]
 
       class Base < RakutenWebService::Travel::Resource
-        endpoint 'https://app.rakuten.co.jp/services/api/Travel/GetAreaClass/20131024'
+        endpoint 'https://openapi.rakuten.co.jp/engine/api/Travel/GetAreaClass/20140210'
 
         parser do |response|
           response['areaClasses']['largeClasses'].map do |data|

data/lib/rakuten_web_service/travel/hotel.rb

@@ -5,7 +5,7 @@ require 'rakuten_web_service/travel/resource'
 module RakutenWebService
   module Travel
     class Hotel < RakutenWebService::Travel::Resource
-      endpoint 'https://app.rakuten.co.jp/services/api/Travel/SimpleHotelSearch/20170426'
+      endpoint 'https://openapi.rakuten.co.jp/services/api/Travel/SimpleHotelSearch/20170426'
 
       parser do |response|
         response['hotels'].map do |hotel_info|

data/lib/rakuten_web_service/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RakutenWebService
-  VERSION = '1.16.0'
+  VERSION = '1.17.0'
 end

data/rakuten_web_service.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'debug'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rbs', '~> 4.0'
   spec.add_development_dependency 'rexml', '~> 3.2'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'tapp', '~> 1.5.1'