A reader-friendly Ruby abstraction of the Rakuten Market API
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.travis.yml
Gemfile
LICENSE
README.rdoc
Rakefile
rakumarket.gemspec

README.rdoc

Rakumarket

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