Giter Club home page Giter Club logo

onsip_ruby's Introduction

OnSip for Ruby

Ruby gem that wraps the Onsip Admin API

http://developer.onsip.com/admin-api/

Installation

Add this line to your application's Gemfile:

gem 'onsip'

And then execute:

$ bundle

Or install it yourself as:

$ gem install onsip

Getting Started

The Onsip for Ruby gem is currently in development and many things are missing such as proper error handling. It is not recommended to use this gem at the current time but and additions to the gem would be appreciated.

Road Map

Planned Releases

v0.0.1 (July 2014) - Implement the Session actions and the CdrBrowse action

v0.0.2 (July 2014)- Implement proper error handling for http responses

v0.0.3 - Implement the remaining get requests

Releases

none yet :)

Usage

Authentication

http://developer.onsip.com/admin-api/Authentication/#sessioncreate

Creating a Session

Before making any API calls you need to authenticate

Session returns a boolean indicating whether the session was made successfully. Because the session is a singleton you don't need to store any session or pass the session id to any further calls.

  Onsip::Session.instance.authenticate("username", "password") 

Destroying a Session

  Onsip::Session.instance.destroy 

Call Detail Records

Search

call_data_records = Onsip::CallDataRecord.where(:session_id => session_id,
                                         :account_id => account_id,
                                         :start_at => start_date_time,
                                         :end_at => end_date_time,
                                         :order_by => :date_time,
                                         :limit => )

Count

call_data_record.count = Onsip::CallDataRecord.count(:session_id => session_id,
                                         :account_id => account_id,
                                         :start_at => start_date_time,
                                         :end_at => end_date_time
                                         )

Contributing

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

onsip_ruby's People

Contributors

brettallred avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.