This gem provides a client for easily accessing Rakuten Web Service APIs.
日本語のドキュメントはこちら。
Add this line to your application's Gemfile:
gem 'rakuten_web_service'
And then execute:
bundle
Or install it yourself as:
gem install rakuten_web_service
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.
At first, you have to specify your application's key. And you can tell the client your afiiliate id with RakutenWebService.configure.
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
# too many requests error. Then the client tries to retry to send the same request after a
# while.
c.max_retries = 3 # default: 5
# (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.
You can configure application_id and affiliate_id by defining environment variables RWS_APPLICATION_ID and RWS_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
Responses of resources' search such as RakutenWebService::Ichiba::Item.search have methods for paginating fetched resources.
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.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
# Easier way to fetch all resources page 3 and latter
items.page(3).all do |item|
puts item.name
end
Genre class provides an interface to traverse sub genres.
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 # => "水・ソフトドリンク"
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: https://webservice.rakuten.co.jp/documentation/ichibaitemsearch/#outputParameter
ranking_by_age.each do |ranking|
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 item.name
end
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
Now rakuten_web_service is supporting the following APIs:
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)FAQs
Unknown package
We found that rakuten_web_service demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.