sirportly 1.0.0

data/lib/sirportly.rb

@@ -0,0 +1,41 @@
+require 'uri'
+require 'net/https'
+require 'json'
+
+require 'sirportly/request'
+require 'sirportly/ticket'
+require 'sirportly/knowledge_base'
+require 'sirportly/objects'
+
+module Sirportly
+  class << self
+    
+    ## Returns the current version number for the Sirportly API client.
+    def version
+      "1.0.0-beta"
+    end
+    
+    ## Stores authentication details
+    attr_accessor :token
+    attr_accessor :secret
+    
+    ## Allow the domain to be changed
+    attr_writer :domain
+    
+    ## Returns the domain which should be used to query the API
+    def domain
+      @domain ||= 'https://app.sirportly.com'
+    end
+    
+  end
+  
+  ## Various error classes to raise
+  class Error < StandardError; end
+  module Errors
+    class ServiceUnavailable < Error; end
+    class AccessDenied < Error; end
+    class NotFound < Error; end
+    class CommunicationError < Error; end
+  end
+  
+end

data/lib/sirportly/knowledge_base.rb

@@ -0,0 +1,54 @@
+module Sirportly
+  class KnowledgeBase
+
+    attr_accessor :id
+
+    class << self
+
+      def list
+        Request.request('knowledge/list')
+      end
+
+      def find_by_id(id)
+        Request.request('knowledge/tree', :kb => id)
+        self.new(id)
+      rescue Errors::NotFound
+        false
+      end
+
+    end
+
+    def initialize(id)
+      self.id = id
+    end
+
+    def page(path)
+      request('page', :path => path)
+    end
+
+    def tree
+      request('tree')
+    end
+
+    def add_page(options = {})
+      request('add_page', options)
+    end
+
+    def edit_page(path, options = {})
+      options[:path] = path
+      request('edit_page', options)
+    end
+
+    def delete_page(path)
+      request('delete_page', :path => path)
+    end
+    
+    private
+
+    def request(path, options = {})
+      options[:kb] = self.id
+      Request.request('knowledge/'+path, options)
+    end
+
+  end
+end

data/lib/sirportly/objects.rb

@@ -0,0 +1,47 @@
+module Sirportly
+  class Objects
+    class << self
+      
+      def statuses
+        Request.request('objects/statuses')
+      end
+      
+      def priorities
+        Request.request('objects/priorities')
+      end
+      
+      def users
+        Request.request('objects/users')
+      end
+      
+      def teams
+        Request.request('objects/teams')
+      end
+      
+      def brands
+        Request.request('objects/brands')
+      end
+      
+      def departments(brand_id = nil)
+        if brand_id
+          begin
+            Request.request('objects/departments', :brand_id => brand_id.to_i)
+          rescue Errors::NotFound
+            false
+          end
+        else
+          Request.request('objects/departments')
+        end
+      end
+      
+      def escalation_paths
+        Request.request('objects/escalation_paths')
+      end
+      
+      def slas
+        Request.request('objects/slas')
+      end
+      
+    end
+  end
+end

data/lib/sirportly/request.rb

@@ -0,0 +1,72 @@
+module Sirportly
+  class Request
+    
+    def self.request(path, data = {})
+      req = self.new(path, :post)
+      req.data = data
+      req.make && req.success? ? req.output : false
+    end
+    
+    attr_reader :path, :method
+    attr_accessor :data
+    
+    def initialize(path, method = :get)
+      @path = path
+      @method = method
+    end
+    
+    def success?
+      @success || false
+    end
+    
+    def output
+      @output || nil
+    end
+    
+    def make
+      uri = URI.parse([Sirportly.domain, "api/v1", @path].join('/'))
+      http_request = http_class.new(uri.request_uri)
+      http_request.add_field("X-Auth-Token", Sirportly.token)
+      http_request.add_field("X-Auth-Secret", Sirportly.secret)
+      http_request.set_form_data(@data)
+      
+      http = Net::HTTP.new(uri.host, uri.port)
+      
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      
+      http_result = http.request(http_request)
+      @output = JSON.parse(http_result.body)
+      @success = case http_result
+      when Net::HTTPSuccess
+        true
+      when Net::HTTPServiceUnavailable
+        raise Sirportly::Errors::ServiceUnavailable
+      when Net::HTTPForbidden, Net::HTTPUnauthorized
+        raise Sirportly::Errors::AccessDenied, "Access Denied for '#{Sirportly.token}'"
+      when Net::HTTPNotFound
+        raise Sirportly::Errors::NotFound, "Not Found at #{uri.to_s}"
+      when Net::HTTPClientError
+        @output
+      else
+        raise Sirportly::Errors::CommunicationError, http_result.body
+      end
+      self
+    end
+    
+    private
+    
+    def http_class  
+      case @method
+      when :post    then Net::HTTP::Post
+      when :put     then Net::HTTP::Put
+      when :delete  then Net::HTTP::Delete
+      else
+        Net::HTTP::Get
+      end
+    end
+    
+  end
+end

data/lib/sirportly/ticket.rb

@@ -0,0 +1,27 @@
+module Sirportly
+  class Ticket
+    
+    class << self
+    
+      def find_by_reference(reference)
+        Request.request('tickets/ticket', :reference => reference)
+      rescue Errors::NotFound
+        false
+      end
+    
+      def execute_spql(query)
+        Request.request('tickets/spql', :spql => query)
+      end
+      
+      def submit(options)
+        Request.request('tickets/submit', options)
+      end
+      
+      def update(reference, options)
+        options.merge!(:ticket => reference)
+        Request.request('tickets/post_update', options)
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: sirportly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-26 00:00:00.000000000Z
+dependencies: []
+description: 
+email: adam@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sirportly.rb
+- lib/sirportly/knowledge_base.rb
+- lib/sirportly/objects.rb
+- lib/sirportly/request.rb
+- lib/sirportly/ticket.rb
+homepage: http://www.sirportly.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easy to use client library for Sirportly
+test_files: []