Why Gemfury? Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Debian packages RPM packages NuGet packages

Repository URL to install this package:

Details    
  lib
  spec
  .gitignore
  Gemfile
  Gemfile.lock
  LICENSE.txt
  README.md
  Rakefile
  appointment_plus.gemspec
  deploy.rb
Size: Mime:
  README.md

AppointmentPlus

A Ruby wrapper for the AppointmentPlus REST API.

Installation

Add this line to your application's Gemfile:

gem 'appointment_plus'

And then execute:

$ bundle

Or install it yourself as:

$ gem install appointment_plus

Usage

Configuration

Before you can make calls to AppointmentPlus you must configure the library with a valid API key and Site ID. You can request an API key and Site ID from AppointmentPlus. Basic Authentication is used with Site ID as username and API key as password.

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 = AppointmentPlus.client({api_key: "YOUR_KEY_HERE", site_id: "YOUR_SITE_ID_HERE"})

Logging can also be enabled by passing an optional parameter

client = AppointmentPlus.client({api_key: "YOUR_KEY_HERE", site_id: "YOUR_SITE_ID_HERE" logging: true})
AppointmentPlus.configure do |config|
  config.api_key = "YOUR_KEY_HERE"
  config.site_id = "YOUR_SITE_ID_HERE"
end

client = AppointmentPlus.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