https://github.com/terenceponce/codes_wholesale

A Ruby interface to the CodesWholesale API
https://github.com/terenceponce/codes_wholesale

Last synced: about 2 months ago
JSON representation

A Ruby interface to the CodesWholesale API

• Host: GitHub
• URL: https://github.com/terenceponce/codes_wholesale
• Owner: terenceponce
• License: mit
• Created: 2016-03-18T06:00:25.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-02T01:50:40.000Z (almost 9 years ago)
• Last Synced: 2024-04-25T18:42:45.641Z (9 months ago)
• Language: Ruby
• Homepage:
• Size: 33.2 KB
• Stars: 5
• Watchers: 4
• 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

        
# CodesWholesale

A Ruby interface to the [CodesWholesale](http://codeswholesale.com) API

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'codes_wholesale'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install codes_wholesale

## Usage

```ruby

# Authentication

client = CodesWholesale::Client.new(client_id: "ff72ce315d1259e822f47d87d02d261e", client_secret: "$2a$10$E2jVWDADFA5gh6zlRVcrlOOX01Q/HJoT6hXuDMJxek.YEo.lkO2T6")

# Find a product

product = client.products('ffe2274d-5469-4b0f-b57b-f8d21b09c24c')

# Get all products

products = client.products

# Get your current account details

account = client.account

# Order a product

order = client.order('ffe2274d-5469-4b0f-b57b-f8d21b09c24c')

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/terenceponce/codes_wholesale. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).