Project

rakumarket

0.0
No commit activity in last 3 years
No release in over 3 years
A reader-friendly Ruby abstraction of the Rakuten Market API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.0.0
~> 2.6

Runtime

>= 0.1.0
~> 1.3.0
>= 0
 Project Readme

A reader-friendly Ruby abstraction of the Rakuten Market API.

See the Github page for detailed usage information.

Description¶ ↑

The goal was to abstract Rakuten’s complex API away from users and provide a simpler, easier-to-read Ruby interface in its place.

Features¶ ↑

  • Idiomatic Ruby

  • Simpler and more readable representation of the underlying API

  • Well-tested

  • Concrete classes and methods

Goals¶ ↑

  • Completeness

Installation¶ ↑

gem install rakumarket

Configuration¶ ↑

A Rakuten developer ID is required.

require 'rakumarket'
Rakumarket.developer_id = 'your_developer_id'

Basic Usage¶ ↑

Please see the wiki for a more comprehensive documentation.

Item Search¶ ↑

Rakumarket.item_search "roomba", :price => {:maximum => 30000}

Item Lookup¶ ↑

Rakumarket.item_lookup "act-corp:10000580"

Genre Search¶ ↑

Rakumarket.genre_search

Item Ranking¶ ↑

Rakumarket.item_ranking :sex => :male, :age_range => (20..29)

Todo¶ ↑

  • remaining APIs

  • RDoc markup

License¶ ↑

Released under the MIT License. See the [LICENSE][] file for further details.

Credit¶ ↑

Rakumarket is influenced by multiple other Ruby API wrappers including instagram, groupon and facebooker.

[license]: LICENSE