Vogogo

This is API wrapper for Vogogo. Built according to API version V3. More info: https://docs.vogogo.com/api/v3

Installation

Add this line to your application's Gemfile:

gem 'vogogo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vogogo

Initialization

By default gem will look for ENV['VOGOGO_SECRET'].

@client = Vogogo::Client.new

If you still prefer to provide your secret on initialize, then put it as an argument.

@client = Vogogo::Client.new('very-secret-key')

Basic usage

According to API you can use methods mentioned there. For example, Customers:

@client.get_customers
@client.create_customer(params_for_customer_as_stated_in_documentation)
@client.get_customer(customer_id)
@client.update_customer(customer_id, params)

For more info, just check the code inside lib/vogogo.

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tehPlayer/vogogo-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Feel free to contact me if you need help: adamczyk.marcin [--a-t--] outlook.com