🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

base_api

0.1.0
Version published
Maintainers
1
Created

BaseApi

A Ruby interface to the BASE API. (This library is unofficial.)

BASE API doc

BASE is a Japanese service that allows you to easily open an online shop. Please check the official page for details.

日本語版のREADME

Installation

Add this line to your application's Gemfile:

gem 'base_api'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install base_api

Usage

Basic usage

# Initialize Client instance with bearer token issued with OAuth2.0
client = BaseApi::Client.new(access_token: 'bearer token')

# Fetch items
response = client.items
response['items']

Default results per request

Default results from the BASE API are 20. If you wish to change per request results number, you can set in three ways:

# Environment variable
export BASE_API_LIMIT=30

or

# Arguments for initialzie a client instance
client = BaseApi::Client.new(access_token: 'bearer token', limit: 30)

or

# Arguments for call api
client = BaseApi::Client.new(access_token: 'bearer token')
client.items({ limit: 30 })

Pagination

Errors

Development

TODO

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/base_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the BaseApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

FAQs

Package last updated on 21 Mar 2020

Did you know?

Socket

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.

Install

Related posts