Repository is archived
No commit activity in last 3 years
No release in over 3 years
This gem provides a simplified Ruby API for DMTD customers accessing the vbmappapp.com REST service.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.9
~> 10.0
~> 3.2

Runtime

~> 1.8
~> 2.0
 Project Readme

DmtdVbmapp

CI Status Version License

The gem is provided to ease access to DMTD's vbmappapp.com REST service.

Installation

Add this line to your application's Gemfile:

gem 'dmtd_vbmapp_data'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dmtd_vbmapp_data

Configuration

Upon receiving an authorization token from Data Makes the Difference, add the following lines to your application's configuration:

DmtdVbmappData.configure server_url: 'your_assigned_web_service_url' # It can also be 'http://data-sandbox.vbmappapp.com' for testing purposes
DmtdVbmappData.configure auth_token: 'your_auth_token'
DmtdVbmappData.configure organization_id: your_organization_id
DmtdVbmappData.configure document_type: 'html' # It can be either 'html' or 'text' 

Further Reading

Full documentation of the gem can be found at: http://www.rubydoc.info/github/foscomputerservices/dmtd_vbmapp_data/master

Contributing

  1. Fork it ( https://github.com/[my-github-username]/dmtd_vbmapp_data/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