sirportly 1.0.4 → 1.1.0

data/lib/sirportly.rb

@@ -1,24 +1,39 @@
+require 'time'
 require 'uri'
 require 'net/https'
 require 'json'
 
+require 'sirportly/client'
 require 'sirportly/request'
-require 'sirportly/ticket'
-require 'sirportly/knowledge_base'
-require 'sirportly/objects'
-require 'sirportly/public_token'
+require 'sirportly/data_set'
+require 'sirportly/data_object'
+
+require 'sirportly/data_objects/brand'
+require 'sirportly/data_objects/customer'
+require 'sirportly/data_objects/customer_contact_method'
+require 'sirportly/data_objects/department'
+require 'sirportly/data_objects/escalation_path'
+require 'sirportly/data_objects/priority'
+require 'sirportly/data_objects/filter'
+require 'sirportly/data_objects/sla'
+require 'sirportly/data_objects/status'
+require 'sirportly/data_objects/team'
+require 'sirportly/data_objects/ticket'
+require 'sirportly/data_objects/ticket_update'
+require 'sirportly/data_objects/user'
 
 module Sirportly
   class << self
     
     ## Returns the current version number for the Sirportly API client.
     def version
-      "1.0.2"
+      "1.1.0"
     end
     
-    ## Stores authentication details
-    attr_accessor :token
-    attr_accessor :secret
+    ## Stores the application token if one has been provided. This can be nil if no
+    ## application token exists, however if nil, you cannot authenticate using user
+    ## tokens.
+    attr_accessor :application
     
     ## Allow the domain to be changed
     attr_writer :domain
@@ -37,6 +52,7 @@ module Sirportly
     class AccessDenied < Error; end
     class NotFound < Error; end
     class CommunicationError < Error; end
+    class ValidationError < Error; end
   end
   
 end

data/lib/sirportly/client.rb

@@ -0,0 +1,91 @@
+module Sirportly
+  class Client
+    
+    attr_reader :token, :secret
+    
+    def initialize(token, secret)
+      @token, @secret = token, secret
+    end
+    
+    ## Make a request using this client's authentication token and return the request.
+    def request(*args)
+      Request.request(self, *args)
+    end
+    
+    ## Return all brands
+    def brands
+      Brand.all(self)
+    end
+    
+    ## Return all customers
+    def customers(opts = {})
+      Customer.all(self, opts)
+    end
+    
+    ## Return a specific customer
+    def customer(q)
+      Customer.find(self, q)
+    end
+    
+    ## Return all departments
+    def departments
+      Department.all(self)
+    end
+    
+    ## Return all escalation paths
+    def escalation_paths
+      EscalationPath.all(self)
+    end
+    
+    ## Return all filters
+    def filters
+      Filter.all(self)
+    end
+    
+    ## Return all priorities
+    def priorities
+      Priority.all(self)
+    end
+    
+    ## Return all SLAs
+    def slas
+      SLA.all(self)
+    end
+    
+    ## Return all statuses
+    def statuses
+      Status.all(self)
+    end
+    
+    ## Return all teams
+    def teams
+      Team.all(self)
+    end
+    
+    ## Return all tickets
+    def tickets
+      Ticket.all(self)
+    end
+    
+    ## Return a specific ticket
+    def ticket(q)
+      Ticket.find(self, q)
+    end
+    
+    ## Return a set of tickets for given search term
+    def ticket_search(query, page = 1)
+      Ticket.search(self, query, page)
+    end
+    
+    ## Return all users
+    def users(opts = {})
+      User.all(self, opts)
+    end
+    
+    ## Return a specific user
+    def user(q)
+      User.find(self, q)
+    end
+    
+  end
+end

data/lib/sirportly/data_object.rb

@@ -0,0 +1,67 @@
+module Sirportly
+  class DataObject
+    
+    class << self
+      attr_accessor :collection_path
+      attr_accessor :member
+      attr_accessor :maps
+      
+      def all(client, options = {})
+        raise Sirportly::Error, "This object does not support a full list" if collection_path.nil?
+        result = client.request(collection_path, :page => options[:page] || 1)
+        DataSet.new(client, result, self)
+      end
+      
+      def find(client, query)
+        raise Sirportly::Error, "This object does not support finding objects" unless member.is_a?(Hash)
+        result = client.request(member[:path], {member[:param] => query})
+        self.new(client, result)
+      end
+      
+    end
+    
+    attr_reader :attributes
+    attr_reader :client
+    
+    def initialize(client, attributes = {})
+      @client = client
+      set_attributes(attributes)
+    end
+    
+    def inspect
+      "#<#{self.class.to_s} #{attributes.inspect}>"
+    end
+    
+    def method_missing(name)
+      if attributes.keys.include?(name.to_s)
+        attributes[name.to_s]
+      else
+        super
+      end
+    end
+    
+    private
+    
+    def set_attributes(attributes)
+      @attributes = attributes.inject({}) do |hash, (k,v)|
+        case k
+        when /\_(at|on)\Z/
+          hash[k] = v ? Time.parse(v) : nil
+        when /minutes\_since/
+          hash[k] = v.to_f
+        else
+          hash[k] = v          
+          if self.class.maps.is_a?(Hash) && klass_name = self.class.maps[k]
+            if v.is_a?(Array)
+              hash[k] = v.map { |p| Sirportly.const_get(klass_name).new(@client, p) }
+            elsif v.is_a?(Hash)
+              hash[k] = Sirportly.const_get(klass_name).new(@client, v)
+            end
+          end
+        end
+        hash
+      end
+    end
+        
+  end
+end

data/lib/sirportly/data_set.rb

@@ -0,0 +1,36 @@
+module Sirportly
+  class DataSet < Array
+  
+    def initialize(client, records, klass)
+      @pagination = {}
+      if records.is_a?(Hash)
+        @pagination = records['pagination']
+        records = records['records']
+      end
+
+      records.map! { |r| klass.new(client, r) }
+      self.push(*records)
+    end
+  
+    def page
+      @pagination['page']
+    end
+  
+    def total_records
+      @pagination['total_records']
+    end
+  
+    def per_page
+      @pagination['per_page']
+    end
+  
+    def pages
+      @pagination['pages']
+    end
+  
+    def offset
+      @pagination['offset']
+    end
+  
+  end
+end

data/lib/sirportly/request.rb

@@ -1,18 +1,19 @@
 module Sirportly
   class Request
     
-    def self.request(path, data = {})
-      req = self.new(path, :post)
+    def self.request(client, path, data = {})
+      req = self.new(client, path, :post)
       req.data = data
       req.make && req.success? ? req.output : false
     end
     
-    attr_reader :path, :method
+    attr_reader :path, :method, :client
     attr_accessor :data
     
-    def initialize(path, method = :get)
+    def initialize(client, path, method = :get)
       @path = path
       @method = method
+      @client = client
     end
     
     def success?
@@ -27,8 +28,13 @@ module Sirportly
       uri = URI.parse([Sirportly.domain, "api/v1", @path].join('/'))
       http_request = http_class.new(uri.request_uri)
       http_request.initialize_http_header({"User-Agent" => "SirportlyRubyClient/#{Sirportly.version}"})
-      http_request.add_field("X-Auth-Token", Sirportly.token)
-      http_request.add_field("X-Auth-Secret", Sirportly.secret)
+      http_request.add_field("X-Auth-Token", @client.token)
+      http_request.add_field("X-Auth-Secret", @client.secret)
+
+      if Sirportly.application
+        http_request.add_field("X-Auth-Application", Sirportly.application)
+      end
+
       http_request.set_form_data(@data)
       
       http = Net::HTTP.new(uri.host, uri.port)
@@ -48,9 +54,11 @@ module Sirportly
       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}"
+        
+        raise Sirportly::Errors::NotFound, json['error']
       when Net::HTTPClientError
-        @output
+        json = JSON.parse(http_result.body)
+        raise Sirportly::Errors::ValidationError, json['errors'].to_s
       else
         raise Sirportly::Errors::CommunicationError, http_result.body
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sirportly
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000Z
+date: 2012-03-16 00:00:00.000000000Z
 dependencies: []
 description: 
 email: adam@atechmedia.com
@@ -18,11 +18,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sirportly.rb
-- lib/sirportly/knowledge_base.rb
-- lib/sirportly/objects.rb
-- lib/sirportly/public_token.rb
+- lib/sirportly/client.rb
+- lib/sirportly/data_object.rb
+- lib/sirportly/data_set.rb
 - lib/sirportly/request.rb
-- lib/sirportly/ticket.rb
 homepage: http://www.sirportly.com
 licenses: []
 post_install_message: 

data/lib/sirportly/knowledge_base.rb

@@ -1,53 +0,0 @@
-module Sirportly
-  class KnowledgeBase
-
-    attr_accessor :id
-    
-    class << self
-      def list
-        Request.request('knowledge/list')
-      end
-
-      def find_by_id(id)
-        tree = Request.request('knowledge/tree', :kb => id)
-        self.new(id, tree = tree)
-      rescue Errors::NotFound
-        false
-      end
-    end
-
-    def initialize(id, tree = nil)
-      @id = id
-      @tree = tree
-    end
-
-    def page(path)
-      request('page', :path => path)
-    end
-
-    def tree
-      @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

@@ -1,47 +0,0 @@
-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/public_token.rb

@@ -1,19 +0,0 @@
-module Sirportly
-  class PublicToken
-
-    class << self
-
-      def token_login_url(public_interface, customer_details = {})
-        token = generate_public_token(public_interface, customer_details)
-        "#{token['public_interface']['access_domain_with_protocol']}/login/#{token['token']}"
-      end
-
-      def generate_public_token(public_interface, customer_details={})
-        options = {:public_interface => public_interface}.merge(customer_details)
-        Request.request('authentication/public_token', options)
-      end
-
-    end
-
-  end
-end

data/lib/sirportly/ticket.rb

@@ -1,27 +0,0 @@
-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