Project

issue_centre

0.0
No commit activity in last 3 years
No release in over 3 years
issue_centrekitebuggy/issue_centreHomepageDocumentationSource CodeBug TrackerWiki
IssueCentre allows you to record, manage and solve helpdesk issues. Features include intelligent search, advanced ticket and SLA management, email integration, and multi-branding. This gem provides a convenient interface for the API calls to an IssueCentre back-end.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
12,307
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.0.7
Total releases
6
First release
2016-08-28
Latest release
2016-09-03
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-05-26
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.7
minitest
>= 0
rake
~> 10.0
vcr
>= 0
webmock
>= 0
yard
>= 0

Runtime

activesupport
>= 0
faraday
>= 0
savon
~> 2.0
 Project Readme

IssueCentre

This library is designed to help Ruby/Rails based applications communicate with the publicly available API for IssueCentre, as provided by First Option Software (http://www.bespokesoftware.com/).

Installation

Add this line to your application's Gemfile:

gem 'issue_centre'

And then execute:

$ bundle

Or install it yourself as:

$ gem install issue_centre

Usage

Basic usage:

require 'rubygems'
require 'issue_centre'

# Create an authentication client connection to authenticate session
auth_conn = IssueCentre::AuthConnection.new( "<IssueCentre Auth URL>")

# Collect all applicable contracts
contracts = auth_conn.get_contracts( "<username>", "<password>")


# Obtain a session key for a relevant contract
session_key = auth_conn.generate_key( "<username>", "<password>", contracts.last[:id])

# Create a customer connection (note this is usually a different URL)
cust_conn = IssueCentre::CustomerConnection.new( "<IssueCentre Customer URL>"), session_key)

# Grab a list of all companies (you can also search with a wildcard)
companies = cust_conn.get_companies( session_key)

# or using a wildcard to find companies beginning with "British"...
companies = cust_conn.get_companies( session_key, "British*")

# Grab a list of all contacts (you can also search with a wildcard)
contacts = cust_conn.get_contacts( session_key)

# Grab a list of all countries
countries = cust_conn.get_countries( session_key)

# Create a ticket connection (note this is usually a different URL)
ticket_conn = IssueCentre::TicketConnection.new( "<IssueCentre Ticket URL>", session_key)

# Grab a list of open tickets for the specified company
open_tickets = ticket_conn.get_open_tickets( session_key, companies.first[:id], 100, 1)

# Grab a list of closed tickets for the specified company
closed_tickets = ticket_conn.get_closed_tickets( session_key, companies.first[:id], 100, 1)

# Grab a list of events for the specified ticket
events = ticket_conn.get_events_for_ticket( session_key, closed_tickets.last[:id])

# And many more... (don't forget to check the docs for a full list!)

Contributing

  1. Fork it ( https://github.com/kitebuggy/issue_centre/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