https://github.com/kenchan/suzuri_client

https://github.com/kenchan/suzuri_client

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/kenchan/suzuri_client
• Owner: kenchan
• License: mit
• Created: 2015-03-12T03:39:41.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-05-09T06:48:26.000Z (over 7 years ago)
• Last Synced: 2024-12-01T06:54:38.533Z (about 1 month ago)
• Language: Ruby
• Size: 13.7 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# SuzuriClient

[SUZURI](https://suzuri.jp) API Client Library generated by [Heroics](https://github.com/interagent/heroics).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'suzuri_client'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install suzuri_client

## Usage

### Private API Key Authentication

```ruby

require 'suzuri_client'

client = Suzuri.connect_token("#{YOUR_PRIVATE_API_KEY}")

client.item.list

```

For more information on the SUZURI Client, see our documentation: [http://www.rubydoc.info/github/kenchan/suzuri_client](http://www.rubydoc.info/github/kenchan/suzuri_client)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

1. Fork it ( https://github.com/kenchan/suzuri_client/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request