teamsupport 0.1.0

data/lib/teamsupport/rest/tickets.rb

@@ -0,0 +1,134 @@
+require 'teamsupport/error'
+require 'teamsupport/ticket'
+require 'teamsupport/rest/utils'
+require 'teamsupport/utils'
+
+module Teamsupport
+  module REST
+    module Tickets
+      include Teamsupport::REST::Utils
+      include Teamsupport::Utils
+
+      # Returns all available tickets for the TeamSupport organization
+      #
+      # @see http://help.teamsupport.com/1/en/topic/api
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.tickets()
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied API credentials are not valid.
+      #
+      # @return [Array<Teamsupport::Ticket>]
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve.
+      #
+      # @api public
+      def tickets(options = {})
+        perform_get_with_objects_from_collection('/api/json/tickets.json', options, Teamsupport::Ticket, :Tickets)
+      end
+
+      # Returns a customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.ticket('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Ticket] The requested ticket.
+      #
+      # @param id [Integer] A ticket ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def ticket(id, options = {})
+        perform_get_with_object_from_collection("/api/json/tickets/#{id}.json", options, Teamsupport::Ticket, :Ticket)
+      end
+
+      # Create a ticket
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.create_ticket(Name: 'New Ticket', Description: 'Ticket Description')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Ticket] The new ticket.
+      #
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def create_ticket(options = {})
+        perform_post_with_object_from_collection('/api/json/tickets.json', options, Teamsupport::Ticket, :Ticket)
+      end
+
+      # Updates the ticket
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.update_ticket('1', Name: 'Updated Ticket Name')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Ticket] The updated ticket.
+      #
+      # @param id [Integer] A ticket ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def update_ticket(id, options = {})
+        ticket_hash = ticket(id).to_h
+        perform_put_with_object_from_collection("/api/json/tickets/#{id}.json", ticket_hash.merge(options), Teamsupport::Ticket, :Ticket)
+      end
+
+      # Deletes the ticket
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.delete_ticket('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @param id [Integer] A ticket ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def delete_ticket(id, options = {})
+        perform_delete("/api/json/tickets/#{id}.json", options)
+      end
+
+      # Returns the actions for a ticket
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.ticket_actions('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Array<Teamsupport::Product>]
+      #
+      # @param id [Integer] A ticket ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def ticket_actions(id, options = {})
+        options = options.dup
+        perform_get_with_objects_from_collection("/api/json/tickets/#{id}/actions.json", options, Teamsupport::TicketAction, :Actions)
+      end
+    end
+  end
+end

data/lib/teamsupport/rest/utils.rb

@@ -0,0 +1,325 @@
+require 'addressable/uri'
+require 'teamsupport/arguments'
+require 'teamsupport/rest/request'
+require 'teamsupport/utils'
+require 'uri'
+
+module Teamsupport
+  module REST
+    module Utils
+      include Teamsupport::Utils
+
+    private
+
+      # Take a URI string or Teamsupport::Identity object and return its ID
+      #
+      # @param object [Integer, String, URI, Teamsupport::Identity] An ID, URI, or object.
+      #
+      # @return [Integer]
+      #
+      # @api private
+      def extract_id(object)
+        case object
+        when ::Integer
+          object
+        when ::String
+          object.split('/').last.to_i
+        when URI, Addressable::URI
+          object.path.split('/').last.to_i
+        when Teamsupport::Identity
+          object.ID
+        end
+      end
+
+      # Alias for performing HTTP GET request
+      #
+      # @param path [String]
+      # @param options [Hash]
+      #
+      # @return [Array, Hash]
+      #
+      # @api private
+      def perform_get(path, options = {})
+        perform_request(:get, path, options)
+      end
+
+      # Alias for performing HTTP POST request
+      #
+      # @param path [String]
+      # @param options [Hash]
+      #
+      # @return [Array, Hash]
+      #
+      # @api private
+      def perform_post(path, options = {})
+        perform_request(:post, path, options)
+      end
+
+      # Alias for performing HTTP PUT request
+      #
+      # @param path [String]
+      # @param options [Hash]
+      #
+      # @return [Array, Hash]
+      #
+      # @api private
+      def perform_put(path, options = {})
+        perform_request(:put, path, options)
+      end
+
+      # Alias for performing HTTP DELETE request
+      #
+      # @param path [String]
+      # @param options [Hash]
+      #
+      # @return [Array, Hash]
+      #
+      # @api private
+      def perform_delete(path, options = {})
+        perform_request(:delete, path, options)
+      end
+
+      # Create a new Teamsupport::REST::Request and perform an HTTP request
+      #
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      #
+      # @return [Array, Hash]
+      #
+      # @api private
+      def perform_request(request_method, path, options = {})
+        Teamsupport::REST::Request.new(self, request_method, path, options).perform
+      end
+
+      # Alias for performing HTTP GET request returning an object
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_get_with_object(path, options, klass)
+        perform_request_with_object(:get, path, options, klass)
+      end
+
+      # Alias for performing HTTP POST request returning an object
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_post_with_object(path, options, klass)
+        perform_request_with_object(:post, path, options, klass)
+      end
+
+      # Alias for performing HTTP PUT request returning an object
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_put_with_object(path, options, klass)
+        perform_request_with_object(:put, path, options, klass)
+      end
+
+      # Alias for performing HTTP requests returning an object
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_request_with_object(request_method, path, options, klass)
+        response = perform_request(request_method, path, options)
+        klass.new(response)
+      end
+
+      # Alias for performing HTTP GET request returning an object from a collection
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_get_with_object_from_collection(path, options, klass, collection_name)
+        perform_request_with_object_from_collection(:get, path, options, klass, collection_name)
+      end
+
+      # Alias for performing HTTP POST request returning an object from a collection
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_post_with_object_from_collection(path, options, klass, collection_name)
+        perform_request_with_object_from_collection(:post, path, options, klass, collection_name)
+      end
+
+      # Alias for performing HTTP PUT request returning an object from a collection
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_put_with_object_from_collection(path, options, klass, collection_name)
+        perform_request_with_object_from_collection(:put, path, options, klass, collection_name)
+      end
+
+      # Alias for performing HTTP requests returning an object from a collection
+      #
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Object]
+      #
+      # @api private
+      def perform_request_with_object_from_collection(request_method, path, options, klass, collection_name) # rubocop:disable Metrics/ParameterLists
+        options = {collection_name.to_sym => options} unless options.empty?
+
+        response = perform_request(request_method, path, options).fetch(collection_name.to_sym)
+        klass.new(response)
+      end
+
+      # Alias for performing HTTP GET request returning multiple objects
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_get_with_objects(path, options, klass)
+        perform_request_with_objects(:get, path, options, klass)
+      end
+
+      # Alias for performing HTTP POST request returning multiple objects
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_post_with_objects(path, options, klass)
+        perform_request_with_objects(:post, path, options, klass)
+      end
+
+      # Alias for performing HTTP PUT request returning multiple objects
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_put_with_objects(path, options, klass)
+        perform_request_with_objects(:put, path, options, klass)
+      end
+
+      # Alias for performing HTTP requests returning multiple objects
+      #
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_request_with_objects(request_method, path, options, klass)
+        perform_request(request_method, path, options).collect do |element|
+          klass.new(element)
+        end
+      end
+
+      # Alias for performing HTTP GET request returning multiple objects in a collection
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_get_with_objects_from_collection(path, options, klass, collection_name)
+        perform_request_with_objects_from_collection(:get, path, options, klass, collection_name)
+      end
+
+      # Alias for performing HTTP POST request returning multiple objects in a collection
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_post_with_objects_from_collection(path, options, klass, collection_name)
+        perform_request_with_objects_from_collection(:post, path, options, klass, collection_name)
+      end
+
+      # Alias for performing HTTP PUT request returning multiple objects in a collection
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_put_with_objects_from_collection(path, options, klass, collection_name)
+        perform_request_with_objects_from_collection(:put, path, options, klass, collection_name)
+      end
+
+      # Alias for performing HTTP requests returning multiple objects in a collection
+      #
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      # @param collection_name [Symbol]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def perform_request_with_objects_from_collection(request_method, path, options, klass, collection_name) # rubocop:disable Metrics/ParameterLists
+        options = {collection_name.to_sym => options} unless options.empty?
+
+        perform_request(request_method, path, options).fetch(collection_name.to_sym).collect do |element|
+          klass.new(element)
+        end
+      end
+    end
+  end
+end