Learn more  » Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Bower components Debian packages RPM packages NuGet packages

customerlobby / razorsync   ruby

Repository URL to install this package:

  lib
  spec
8y   .gitignore
8y   Gemfile
8y   Gemfile.lock
8y   LICENSE.txt
8y   README.md
8y   Rakefile
8y   razorsync.gemspec
  README.md

Razorsync

A Ruby wrapper for the Razorsync REST API.

Installation

Add this line to your application's Gemfile:

gem 'razorsync'

And then execute:

$ bundle

Or install it yourself as:

$ gem install razorsync

Usage

Configuration

Before you can make calls to Razorsync you must configure the library with a valid API Token. You can request a token be generated by Razorsync. The API Token ties the API request to a particualr Razorsync company id.

There are two ways to configure the gem. You can pass a hash of configuration options when you create a client, or you can use a configure block.

client = Razorsync.client({token: "YOUR_TOKEN_HERE", portal_name: "YOUR_PORTAL_NAME HERE"})

Example: For URL: https://CustomerLobby1.0.razorsync.com portal_name: CustomerLobby1

Logging can also be enabled by passing an optional parameter

client = Razorsync.client({api_token: "YOUR_TOKEN_HERE", logging: true})
Razorsync.configure do |config|
  config.api_token = "YOUR_TOKEN_HERE"
end

client = Razorsync.client

Contributing

  1. Fork it
  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 new Pull Request