Project

mitel_oig

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A client linrary for working with Mitel's OIG services.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 2.0
 Project Readme

Mitel::OIG

Code Climate Test Coverage Build Status

This gem provides a client library for working with the Open Integration Gateway provided by Mitel phone systems. The library makes use of both the SOAP and REST interfaces to try to expose as much of the available functionality as possible. The library maintains a Ruby-oriented way of interacting with the OIG services by exposing simple objects that represent and permit interaction with various elements of the OIG services.

Installation

Add this line to your application's Gemfile:

gem 'mitel_oig'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mitel_oig

Usage

Configuration

Before being able to use any of the Mitel::OIG classes to interact with OIG services, you will need to setup a valid configuration. The code package already incorporates the various WSDLs for the OIG services, but configuration for where to access your specific endpoint is necessary. Configuration is handled globally by the Mitel::OIG::Configuration class and you can set it up like so:

Mitel::OIG::Configuration.set(:endpoint, 'https://192.168.0.1:8080')
Mitel::OIG::Configuration.set(:application_name, 'MyOIGApp')
Mitel::OIG::Configuration.set(:application_password, 'secret')
Mitel::OIG::Configuration.set(:company_name, 'MyCompany')
Mitel::OIG::Configuration.set(:local_password, 'secret')

All the options described above are required to properly authenticate your application with the OIG services. All these credentials are shared globally within your application and are automatically accessible to the classes provided by this gem.

Contributing

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