teamsupport 0.1.0

data/lib/teamsupport/client.rb

@@ -0,0 +1,86 @@
+require 'teamsupport/error'
+require 'teamsupport/utils'
+require 'teamsupport/version'
+
+module Teamsupport
+  class Client
+    # Provide api_key and api_secret methods for accessing Client API values
+    #
+    # @example
+    #   teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS')
+    #   teamsupport_client.api_key
+    #   teamsupport_client.api_secret
+    #
+    # @return [String]
+    #
+    # @api public
+    attr_accessor :api_key, :api_secret
+
+    # Provide user_agent method for overriding default Client user_agent value
+    #
+    # @example
+    #   teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS')
+    #   teamsupport_client.user_agent = 'MyTeamsupportClient/1.0.0'
+    #
+    # @return [String]
+    #
+    # @api public
+    attr_writer :user_agent
+
+    # Initializes a new Client object
+    #
+    # @param options [Hash]
+    #
+    # @return [Teamsupport::Client]
+    #
+    # @api private
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+    end
+
+    # Returns user agent string for the Client
+    #
+    # @example
+    #   teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS')
+    #   teamsupport_client.user_agent
+    #
+    # @return [String]
+    #
+    # @api public
+    def user_agent
+      @user_agent ||= "TeamsupportRubyGem/#{Teamsupport::Version}"
+    end
+
+    # Returns authentication hash for the Client
+    #
+    # @example
+    #   teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS')
+    #   teamsupport_client.auth
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def auth
+      {
+        user: api_key,
+        password: api_secret,
+      }
+    end
+
+    # Checks for the existence of an authentication hash on the Client
+    #
+    # @example
+    #   teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS')
+    #   teamsupport_client.auth?
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def auth?
+      auth.values.all?
+    end
+  end
+end

data/lib/teamsupport/creatable.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+module Teamsupport
+  module Creatable
+    # Time when object was created on TeamSupport
+    #
+    # @example
+    #   teamsupport_object = Teamsupport::Creatable.new(DateCreated: '4/4/2015 9:45 AM')
+    #   teamsupport_object.DateCreated
+    #
+    # @return [Time]
+    #
+    # @api public
+    def DateCreated # rubocop:disable Style/MethodName
+      Time.strptime(@attrs[:DateCreated], '%m/%d/%Y %l:%M %p').utc unless @attrs[:DateCreated].nil?
+    end
+
+    # Time when object was last modified on TeamSupport
+    #
+    # @example
+    #   teamsupport_object = Teamsupport::Creatable.new(DateModified: '4/4/2015 10:00 AM')
+    #   teamsupport_object.DateModified
+    #
+    # @return [Time]
+    #
+    # @api public
+    def DateModified # rubocop:disable Style/MethodName
+      Time.strptime(@attrs[:DateModified], '%m/%d/%Y %l:%M %p').utc unless @attrs[:DateModified].nil?
+    end
+  end
+end

data/lib/teamsupport/customer.rb

@@ -0,0 +1,66 @@
+require 'teamsupport/base'
+require 'teamsupport/creatable'
+require 'teamsupport/identity'
+
+module Teamsupport
+  class Customer < Teamsupport::Identity
+    include Teamsupport::Creatable
+
+    # @return [Integer]
+    attr_reader :ID, :PrimaryUserID, :CreatorID, :ModifierID, :SlaLevelID, :DefaultSupportGroupID, :DefaultSupportUserID, :SupportHoursMonth, :SupportHoursUsed, :SupportHoursRemaining
+    # @return [String]
+    attr_reader :Name, :Description, :Website, :InActiveReason, :PrimaryContact, :Domains, :CreatedBy, :LastModifiedBy, :SlaName, :CRMLinkId, :DefaultWikiArticle, :DefaultSupportGroup, :DefaultSupportUser
+
+    # Boolean indicating whether a Customer is active on Teamsupport
+    #
+    # @example
+    #   teamsupport_customer = Teamsupport::Customer.new(IsActive: true)
+    #   teamsupport_customer.IsActive
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def IsActive # rubocop:disable Style/MethodName
+      @attrs[:IsActive] == 'True' ? true : false
+    end
+
+    # Boolean indicating whether a Customer has portal access on Teamsupport
+    #
+    # @example
+    #   teamsupport_customer = Teamsupport::Customer.new(HasPortalAccess: true)
+    #   teamsupport_customer.HasPortalAccess
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def HasPortalAccess # rubocop:disable Style/MethodName
+      @attrs[:HasPortalAccess] == 'True' ? true : false
+    end
+
+    # Boolean indicating whether a Customer needs indexing on Teamsupport
+    #
+    # @example
+    #   teamsupport_customer = Teamsupport::Customer.new(NeedsIndexing: true)
+    #   teamsupport_customer.NeedsIndexing
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def NeedsIndexing # rubocop:disable Style/MethodName
+      @attrs[:NeedsIndexing] == 'True' ? true : false
+    end
+
+    # Time when the Customer's Service Agreement expires on Teamsupport
+    #
+    # @example
+    #   teamsupport_customer = Teamsupport::Customer.new(SAExpirationDate: '4/4/2015 10:15 AM')
+    #   teamsupport_customer.SAExpirationDate
+    #
+    # @return [Time]
+    #
+    # @api public
+    def SAExpirationDate # rubocop:disable Style/MethodName
+      Time.strptime(@attrs[:SAExpirationDate], '%m/%d/%Y %l:%M %p').utc unless @attrs[:SAExpirationDate].nil?
+    end
+  end
+end

data/lib/teamsupport/customer_product.rb

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

data/lib/teamsupport/error.rb

@@ -0,0 +1,135 @@
+module Teamsupport
+  # Custom error class for rescuing from all Teamsupport errors
+  class Error < StandardError
+    # Provide a code method for reading HTTP status code from Error
+    #
+    # @example
+    #   teamsupport_error = Teamsupport::Error.new(code: 404)
+    #   teamsupport_error.code
+    #
+    # @return [Integer]
+    #
+    # @api public
+    attr_reader :code
+
+    # Raised when Teamsupport returns a 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # Raised when Teamsupport returns the HTTP status code 400
+    BadRequest = Class.new(ClientError)
+
+    # Raised when Teamsupport returns the HTTP status code 401
+    Unauthorized = Class.new(ClientError)
+
+    # Raised when Teamsupport returns the HTTP status code 403
+    Forbidden = Class.new(ClientError)
+
+    # Raised when Teamsupport returns the HTTP status code 404
+    NotFound = Class.new(ClientError)
+
+    # Raised when Teamsupport returns the HTTP status code 406
+    NotAcceptable = Class.new(ClientError)
+
+    # Raised when Teamsupport returns the HTTP status code 422
+    UnprocessableEntity = Class.new(ClientError)
+
+    # Raised when Teamsupport returns the HTTP status code 429
+    TooManyRequests = Class.new(ClientError)
+
+    # Raised when Teamsupport returns a 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # Raised when Teamsupport returns the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
+    # Raised when Teamsupport returns the HTTP status code 502
+    BadGateway = Class.new(ServerError)
+
+    # Raised when Teamsupport returns the HTTP status code 503
+    ServiceUnavailable = Class.new(ServerError)
+
+    # Raised when Teamsupport returns the HTTP status code 504
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      400 => Teamsupport::Error::BadRequest,
+      401 => Teamsupport::Error::Unauthorized,
+      403 => Teamsupport::Error::Forbidden,
+      404 => Teamsupport::Error::NotFound,
+      406 => Teamsupport::Error::NotAcceptable,
+      422 => Teamsupport::Error::UnprocessableEntity,
+      429 => Teamsupport::Error::TooManyRequests,
+      500 => Teamsupport::Error::InternalServerError,
+      502 => Teamsupport::Error::BadGateway,
+      503 => Teamsupport::Error::ServiceUnavailable,
+      504 => Teamsupport::Error::GatewayTimeout,
+    }.freeze
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @example
+      #   teamsupport_error = Teamsupport::Error::ERRORS[code]
+      #   teamsupport_error.from_response(body, headers) unless klass.nil?
+      #
+      # @param body [String]
+      # @param headers [Hash]
+      #
+      # @return [Teamsupport::Error]
+      #
+      # @api public
+      def from_response(body, _headers)
+        message, code = parse_error(body)
+        new(message, code)
+      end
+
+    private
+
+      # Parses response body for errors
+      #
+      # @param body [String]
+      #
+      # @return [Array, nil]
+      #
+      # @api private
+      def parse_error(body)
+        if body.nil? || body.empty?
+          ['', nil]
+        elsif body[:error]
+          [body[:error], nil]
+        elsif body[:errors]
+          extract_message_from_errors(body)
+        end
+      end
+
+      # Extracts error messages from response body
+      #
+      # @param body [String]
+      #
+      # @return [Array]
+      #
+      # @api private
+      def extract_message_from_errors(body)
+        first = Array(body[:errors]).first
+        if first.is_a?(Hash)
+          [first[:message].chomp, first[:code]]
+        else
+          [first.chomp, nil]
+        end
+      end
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    #
+    # @return [Teamsupport::Error]
+    #
+    # @api private
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+  end
+end

data/lib/teamsupport/headers.rb

@@ -0,0 +1,51 @@
+require 'addressable/uri'
+require 'base64'
+
+module Teamsupport
+  class Headers
+    # Initializes a new Headers object
+    #
+    # @param client [Teamsupport::Client]
+    # @param request_method [String]
+    # @param url [String]
+    # @param options [Hash]
+    #
+    # @return [Teamsupport::Headers]
+    #
+    # @api private
+    def initialize(client, request_method, url, options = {})
+      @client = client
+      @request_method = request_method.to_sym
+      @uri = Addressable::URI.parse(url)
+      @options = options
+    end
+
+    # Returns HTTP request headers for the client
+    #
+    # @example
+    #   teamsupport_client = Teamsupport::Client.new(api_key: 'AK', api_secret: 'AS')
+    #   teamsupport_headers = Teamsupport::Headers.new(teamsupport_client, :get, 'https://app.teamsupport.com')
+    #   teamsupport_headers.request_headers
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def request_headers
+      headers = {'Content-Type' => 'application/json'}
+      headers[:user_agent] = @client.user_agent
+      headers[:authorization] = auth_header
+      headers
+    end
+
+  private
+
+    # Generates authentication header for TeamSupport API's basic auth
+    #
+    # @return [String]
+    #
+    # @api private
+    def auth_header
+      "Basic #{Base64.strict_encode64("#{@client.api_key}:#{@client.api_secret}")}"
+    end
+  end
+end

data/lib/teamsupport/identity.rb

@@ -0,0 +1,43 @@
+require 'equalizer'
+require 'teamsupport/base'
+
+module Teamsupport
+  class Identity < Teamsupport::Base
+    include Equalizer.new(:ID)
+    # @return [Integer]
+
+    # Method for reading the TeamSupport ID of an object
+    #
+    # @example
+    #   teamsupport_object = Teamsupport::Identity.new(ID: 1)
+    #   teamsupport_object.ID
+    #
+    # @return [Integer]
+    #
+    # @api public
+    attr_reader :ID
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    #
+    # @raise [ArgumentError] Error raised when supplied argument is missing an :ID key.
+    #
+    # @return [Teamsupport::Identity]
+    #
+    # @api private
+    def initialize(attrs = {})
+      # Workaround for dealing with TeamSupport API inconsistently sending ID for objects
+      unless attrs[:ID]
+        attrs[:ID] = attrs.fetch(:OrganizationID) if attrs[:OrganizationID]
+
+        attrs[:ID] = attrs.fetch(:ProductID) if attrs[:ProductID]
+
+        attrs[:ID] = attrs.fetch(:TicketID) if attrs[:TicketID]
+      end
+
+      attrs.fetch(:ID)
+      super
+    end
+  end
+end

data/lib/teamsupport/null_object.rb

@@ -0,0 +1,52 @@
+require 'naught'
+
+module Teamsupport
+  NullObject = Naught.build do |config|
+    include Comparable
+
+    config.black_hole
+    config.define_explicit_conversions
+    config.define_implicit_conversions
+    config.predicates_return false
+
+    def !
+      true
+    end
+
+    def respond_to?(*)
+      true
+    end
+
+    def respond_to?(*)
+      true
+    end
+
+    def instance_of?(klass)
+      raise(TypeError, 'class or module required') unless klass.is_a?(Class)
+      self.class == klass
+    end
+
+    def kind_of?(mod)
+      raise(TypeError, 'class or module required') unless mod.is_a?(Module)
+      self.class.ancestors.include?(mod)
+    end
+
+    alias_method :is_a?, :kind_of?
+
+    def <=>(other)
+      if other.is_a?(self.class)
+        0
+      else
+        -1
+      end
+    end
+
+    def nil?
+      true
+    end
+
+    def as_json(*)
+      'null'
+    end
+  end
+end