teamsupport 0.1.0

data/lib/teamsupport/product.rb

@@ -0,0 +1,14 @@
+require 'teamsupport/base'
+require 'teamsupport/creatable'
+require 'teamsupport/identity'
+
+module Teamsupport
+  class Product < Teamsupport::Identity
+    include Teamsupport::Creatable
+
+    # @return [Integer]
+    attr_reader :ID, :CreatorID, :ModifierID
+    # @return [String]
+    attr_reader :Name, :Description
+  end
+end

data/lib/teamsupport/rest/api.rb

@@ -0,0 +1,19 @@
+require 'teamsupport/rest/customers'
+require 'teamsupport/rest/products'
+require 'teamsupport/rest/tickets'
+
+module Teamsupport
+  module REST
+    module API
+      # TODO: include Teamsupport::REST::Assets
+      # TODO: include Teamsupport::REST::Contacts
+      include Teamsupport::REST::Customers
+      # TODO: include Teamsupport::REST::Groups
+      include Teamsupport::REST::Products
+      # TODO: include Teamsupport::REST::Properties
+      include Teamsupport::REST::Tickets
+      # TODO: include Teamsupport::REST::Users
+      # TODO: include Teamsupport::REST::Wiki
+    end
+  end
+end

data/lib/teamsupport/rest/client.rb

@@ -0,0 +1,25 @@
+require 'teamsupport/client'
+require 'teamsupport/rest/api'
+require 'teamsupport/rest/request'
+require 'teamsupport/rest/utils'
+
+module Teamsupport
+  module REST
+    class Client < Teamsupport::Client
+      include Teamsupport::REST::API
+
+      # Checks for the existence of an authentication hash on the Client
+      #
+      # @example
+      #   teamsupport_client = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_client.auth?
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def auth?
+        super
+      end
+    end
+  end
+end

data/lib/teamsupport/rest/customers.rb

@@ -0,0 +1,156 @@
+require 'teamsupport/error'
+require 'teamsupport/customer'
+require 'teamsupport/rest/utils'
+require 'teamsupport/utils'
+
+module Teamsupport
+  module REST
+    module Customers
+      include Teamsupport::REST::Utils
+      include Teamsupport::Utils
+
+      # Returns all available customers 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.customers()
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied API credentials are not valid.
+      #
+      # @return [Array<Teamsupport::Customer>]
+      #
+      # @param options [Hash] A customizable set of options.
+      #
+      # @option options [Integer] :count Specifies the number of records to retrieve.
+      #
+      # @api public
+      def customers(options = {})
+        perform_get_with_objects_from_collection('/api/json/customers.json', options, Teamsupport::Customer, :Customers)
+      end
+
+      # Returns a customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.customer('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Customer] The requested customer.
+      #
+      # @param id [Integer] A customer ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def customer(id, options = {})
+        perform_get_with_object_from_collection("/api/json/customers/#{id}.json", options, Teamsupport::Customer, :Customer)
+      end
+
+      # Create a customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.create_customer(Name: 'New Customer')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Customer] The new customer.
+      #
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def create_customer(options = {})
+        perform_post_with_object_from_collection('/api/json/customers.json', options, Teamsupport::Customer, :Customer)
+      end
+
+      # Updates the customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.update_customer('1', Name: 'Updated Customer Name')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Customer] The updated customer.
+      #
+      # @param id [Integer] A customer ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def update_customer(id, options = {})
+        customer_hash = customer(id).to_h
+        perform_put_with_object_from_collection("/api/json/customers/#{id}.json", customer_hash.merge(options), Teamsupport::Customer, :Customer)
+      end
+
+      # Deletes the customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.delete_customer('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @param id [Integer] A customer ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def delete_customer(id, options = {})
+        perform_delete("/api/json/customers/#{id}.json", options)
+      end
+
+      # Returns the products for a customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.customer_products('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 customer ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def customer_products(id, options = {})
+        options = options.dup
+        perform_get_with_objects_from_collection("/api/json/customers/#{id}/products.json", options, Teamsupport::CustomerProduct, :OrganizationProducts)
+      end
+
+      # Returns the tickets for a customer
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.customer_tickets('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Array<Teamsupport::Ticket>]
+      #
+      # @param id [Integer] A customer ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def customer_tickets(id, options = {})
+        options = options.dup
+        perform_get_with_objects_from_collection("/api/json/customers/#{id}/tickets.json", options, Teamsupport::Ticket, :Tickets)
+      end
+    end
+  end
+end

data/lib/teamsupport/rest/products.rb

@@ -0,0 +1,113 @@
+require 'teamsupport/error'
+require 'teamsupport/product'
+require 'teamsupport/rest/utils'
+require 'teamsupport/utils'
+
+module Teamsupport
+  module REST
+    module Products
+      include Teamsupport::REST::Utils
+      include Teamsupport::Utils
+
+      # Returns all available products 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.products()
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied API credentials are not valid.
+      #
+      # @return [Array<Teamsupport::Product>]
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve.
+      #
+      # @api public
+      def products(options = {})
+        perform_get_with_objects_from_collection('/api/json/products.json', options, Teamsupport::Product, :Products)
+      end
+
+      # Returns a product
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.product('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Product] The requested product.
+      #
+      # @param id [Integer] A product ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def product(id, options = {})
+        perform_get_with_object_from_collection("/api/json/products/#{id}.json", options, Teamsupport::Product, :Product)
+      end
+
+      # Create a product
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.create_product(Name: 'New Product')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Product] The new product.
+      #
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def create_product(options = {})
+        perform_post_with_object_from_collection('/api/json/products.json', options, Teamsupport::Product, :Product)
+      end
+
+      # Updates the product
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.update_product('1', Name: 'Updated Product Name')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @return [Teamsupport::Product] The updated product.
+      #
+      # @param id [Integer] A product ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def update_product(id, options = {})
+        product_hash = product(id).to_h
+        perform_put_with_object_from_collection("/api/json/products/#{id}.json", product_hash.merge(options), Teamsupport::Product, :Product)
+      end
+
+      # Deletes the product
+      #
+      # @example
+      #   teamsupport_api = Teamsupport::REST::Client.new(api_key: 'AK', api_secret: 'AS')
+      #   teamsupport_api.delete_product('1')
+      #
+      # @authentication Requires Basic Authentication
+      #
+      # @raise [Teamsupport::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #
+      # @param id [Integer] A product ID.
+      # @param options [Hash] A customizable set of options.
+      #
+      # @api public
+      def delete_product(id, options = {})
+        perform_delete("/api/json/products/#{id}.json", options)
+      end
+    end
+  end
+end

data/lib/teamsupport/rest/request.rb

@@ -0,0 +1,116 @@
+require 'addressable/uri'
+require 'http'
+require 'http/form_data'
+require 'json'
+require 'openssl'
+require 'teamsupport/error'
+require 'teamsupport/headers'
+
+module Teamsupport
+  module REST
+    class Request
+      BASE_URL = 'https://app.teamsupport.com'.freeze
+      attr_accessor :client, :headers, :options, :path, :request_method, :uri
+      alias verb request_method
+
+      # Initialize a new REST Request object
+      #
+      # @param client [Teamsupport::Client]
+      # @param request_method [String, Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      #
+      # @return [Teamsupport::REST::Request]
+      #
+      # @api private
+      def initialize(client, request_method, path, options = {})
+        @client = client
+        @uri = Addressable::URI.parse(path.start_with?('http') ? path : BASE_URL + path)
+        @request_method = request_method
+        @headers = Teamsupport::Headers.new(@client, @request_method, @uri, options).request_headers
+        @path = uri.path
+        @options = options
+      end
+
+      # Perform an HTTP REST request and return response body or raise the error
+      #
+      # @example
+      #   Teamsupport::REST::Request.new(self, request_method, path, options).perform
+      #
+      # @return [Array, Hash]
+      #
+      # @api public
+      def perform
+        options_key = @request_method == :get ? :params : :body
+        # For non-GET requests need to send the options as JSON in the request body
+        response = http_client.headers(@headers).public_send(@request_method, @uri.to_s, options_key => @options)
+        response_body = response.body.empty? ? '' : symbolize_keys!(response.parse)
+        response_headers = response.headers
+        fail_or_return_response_body(response.code, response_body, response_headers)
+      end
+
+    private
+
+      # Check response and raise an error or return the response body if successful
+      #
+      # @param code [Strin]
+      # @param body [String]
+      # @param headers [String]
+      #
+      # @raise [Teamsupport::Error] Error raised based on response code/body/headers
+      #
+      # @return [Array, Hash]
+      #
+      # @api private
+      def fail_or_return_response_body(code, body, headers)
+        error = error(code, body, headers)
+        raise(error) if error
+        body
+      end
+
+      # Check response code/body/headers for errors and return Teamsupport::Error
+      #
+      # @param code [Strin]
+      # @param body [String]
+      # @param headers [String]
+      #
+      # @return [Teamsupport::Error, nil]
+      #
+      # @api private
+      def error(code, body, headers)
+        klass = Teamsupport::Error::ERRORS[code]
+
+        klass.from_response(body, headers) unless klass.nil?
+      end
+
+      # Convert array/hash keys to symbols
+      #
+      # @param object [Array, Hash]
+      #
+      # @return [Hash, Array]
+      #
+      # @api private
+      def symbolize_keys!(object)
+        if object.is_a?(Array)
+          object.each_with_index do |val, index|
+            object[index] = symbolize_keys!(val)
+          end
+        elsif object.is_a?(Hash)
+          object.keys.each do |key|
+            object[key.to_sym] = symbolize_keys!(object.delete(key))
+          end
+        end
+        object
+      end
+
+      # Returns the HTTP Client object
+      #
+      # @return [HTTP::Client, HTTP]
+      #
+      # @api private
+      def http_client
+        HTTP
+      end
+    end
+  end
+end