ticket_abstractor_client 1.29.0 → 2.0.0

data/lib/ticket_abstractor_client.rb

@@ -1,39 +1,13 @@
 module TicketAbstractorClient
-  def self.initialize_client(url, security_token = nil)
-    Base.new url, security_token
-  end
-
-  class Base
-    def initialize(url, security_token = nil)
-      @url = url
-      @security_token = security_token
-      @clients = {}
-    end
-
-    def jira(endpoint = 'tp')
-      client_key = "jira_#{endpoint}".to_sym
-      @clients[client_key] ||= JiraClient.new(@url, @security_token, CGI.escape(endpoint.to_s))
-    end
-
-    def brouha
-      @clients[:brouha] ||= BrouhaClient.new(@url, @security_token)
-    end
-
-    def itrc
-      @clients[:itrc] ||= ItrcClient.new(@url, @security_token)
-    end
+  class << self
+    attr_writer :configuration
 
-    def ilogger
-      @clients[:ilogger] ||= ILoggerClient.new(@url, @security_token)
+    def configuration
+      @configuration ||= Configuration.new
     end
 
-    def sev_one
-      @clients[:sev_one] ||= SevOneClient.new(@url, @security_token)
-    end
-
-    def service_now(endpoint = 'default')
-      client_key = "service_now_#{endpoint}".to_sym
-      @clients[client_key] ||= ServiceNowClient.new(@url, @security_token, CGI.escape(endpoint))
+    def configure
+      yield(configuration)
     end
   end
 end
@@ -41,11 +15,9 @@ end
 require 'cgi'
 require 'json'
 require 'rest_client'
+require 'active_support/all'
+require 'mime-types'
+
 require 'ticket_abstractor_client/version'
-require 'ticket_abstractor_client/client'
-require 'ticket_abstractor_client/jira_client'
-require 'ticket_abstractor_client/brouha_client'
-require 'ticket_abstractor_client/itrc_client'
-require 'ticket_abstractor_client/i_logger_client'
-require 'ticket_abstractor_client/sev_one_client'
-require 'ticket_abstractor_client/service_now_client'
+require 'ticket_abstractor_client/configuration'
+require 'ticket_abstractor_client/client_helper'

data/lib/ticket_abstractor_client/base/attachment.rb

@@ -0,0 +1,52 @@
+module TicketAbstractorClient
+  module Base
+    class Attachment
+      attr_reader :file_path, :data_hash, :external_created_at
+
+      class << self
+        def fetch
+          method_not_implemented __method__
+        end
+
+        protected
+
+        def method_not_implemented(method_name)
+          raise Errors::NotImplementedError, "#{self}##{method_name} is not implemented"
+        end
+
+        def save_content(content, original_filename)
+          tmp_file = Tempfile.new(Time.now.to_s)
+          tmp_file.binmode
+          tmp_file.write(content)
+          tmp_file.close
+          set_original_name(tmp_file.path, original_filename)
+        end
+
+        def set_original_name(filepath, original_name)
+          tmp_basename = File.basename(filepath)
+          tmp_path = filepath.gsub(tmp_basename, '')
+          FileUtils.mv filepath, File.join(tmp_path, original_name)
+          File.join(tmp_path, original_name)
+        end
+      end
+
+      def initialize(opts)
+        @file_path = opts[:file_path]
+        @external_created_at = opts[:external_created_at].to_time.utc rescue Time.now.utc
+        @data_hash = opts[:data_hash]
+        set_data_hash! if @data_hash.blank?
+      end
+
+      def sync!
+        self.class.method_not_implemented __method__
+      end
+
+      def set_data_hash!
+        return if self.file_path.blank?
+        file = File.new(self.file_path, 'rb')
+        @data_hash = Digest::SHA1.hexdigest(file.read)
+        file.close
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/base/client.rb

@@ -0,0 +1,54 @@
+module TicketAbstractorClient
+  module Base
+    class Client
+      include ResponseHandler
+
+      def initialize
+        @base_url = TicketAbstractorClient.configuration.ticket_abstractor_url
+        @security_token = TicketAbstractorClient.configuration.security_token
+        @ssl_options = TicketAbstractorClient.configuration.ssl_options
+
+        raise Errors::ConfigurationError, 'TicketAbstractor url is not given' if @base_url.blank?
+        raise Errors::ConfigurationError, 'SecurityToken is not given' if @security_token.blank?
+      end
+
+      protected
+
+      def get(path, args = {}, params = {})
+        params.merge! args: args.to_json, security_token: @security_token
+        with_response_handling do
+          rest_client_error_handling do
+            response = build_request(path, 'get', params).execute
+            response.headers.key?(:file_request) ? { 'result' => response } : JSON.parse(response)
+          end
+        end
+      end
+
+      def post(path, args = {}, params = {})
+        params.merge! args: args.to_json, security_token: @security_token
+        with_response_handling do
+          rest_client_error_handling do
+            response = build_request(path, 'post', params).execute
+            JSON.parse response
+          end
+        end
+      end
+
+      def build_request(path, method, params)
+        request_params = @ssl_options.merge(url: "#{@base_url}/v2/#{path}", method: method)
+        request_params[:headers] = { params: params } if method.inquiry.get?
+        request_params[:payload] = params if method.inquiry.post?
+
+        RestClient::Request.new(request_params)
+      end
+
+      def rest_client_error_handling
+        yield
+      rescue Errno::ECONNREFUSED => exception
+        raise Errors::UnexpectedError, exception.message
+      rescue RestClient::Exception => exception
+        raise Errors::UnexpectedError, exception.response.body
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/base/comment.rb

@@ -0,0 +1,35 @@
+module TicketAbstractorClient
+  module Base
+    class Comment
+      attr_reader :author, :body, :data_hash, :external_created_at
+
+      def self.fetch(*opts)
+        method_not_implemented __method__
+      end
+
+      def initialize(opts)
+        opts = opts.with_indifferent_access
+        @author = opts[:author]
+        @body = opts.fetch(:body, nil) || raise(Errors::CommentArgumentError, 'Body is not given')
+        @external_created_at = opts[:external_created_at].to_time.utc rescue Time.now.utc
+        @data_hash = opts[:data_hash]
+        set_data_hash! if @data_hash.blank?
+      end
+
+      def set_data_hash!
+        content = "#{@external_created_at}:#{@author}:#{@body}"
+        @data_hash = Digest::SHA1.hexdigest(content)
+      end
+
+      def sync!
+        self.class.method_not_implemented __method__
+      end
+
+      protected
+
+      def self.method_not_implemented(method_name)
+        raise Errors::NotImplementedError, "#{self}##{method_name} is not implemented"
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/base/errors.rb

@@ -0,0 +1,25 @@
+module TicketAbstractorClient
+  module Base
+    module Errors
+      class BaseError < StandardError; end
+      class NotImplementedError < BaseError; end
+      class ConfigurationError < BaseError; end
+      class UnexpectedError < BaseError; end
+
+      class AttachmentArgumentError < BaseError; end
+      class CommentArgumentError < BaseError; end
+      class ClientArgumentError < BaseError; end
+      class TicketArgumentError < BaseError; end
+
+      class AttachmentError < BaseError; end
+      class CommentError < BaseError; end
+      class TicketError < BaseError; end
+
+      class ConnectionError < BaseError; end
+      class NotFoundError < BaseError; end
+      class ParseError < BaseError; end
+      class RequsetFormatError < BaseError; end
+      class AccessError < BaseError; end
+    end
+  end
+end

data/lib/ticket_abstractor_client/base/fields_filter.rb

@@ -0,0 +1,15 @@
+module TicketAbstractorClient
+  module Base
+    class FieldsFilter
+      attr_accessor :raw_fields
+
+      def initialize(raw_fields)
+        @raw_fields = raw_fields
+      end
+
+      def filter_fields
+        raise Errors::NotImplementedError, "#{self}##{__method__} is not implemented"
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/base/response_handler.rb

@@ -0,0 +1,28 @@
+module TicketAbstractorClient
+  module Base
+    module ResponseHandler
+      extend ActiveSupport::Concern
+
+      def with_response_handling
+        response = yield
+
+        raise(error_by_context(response['context']), response['error'].to_s) if response.key?('error')
+
+        response['result']
+      end
+
+      private
+
+      def error_by_context(context)
+        modulo, klass = context.split('::')
+        error_class = "TicketAbstractorClient::#{modulo}::Errors::#{klass}".safe_constantize
+        error_class.presence || unexpected_error_klass
+      end
+
+      def unexpected_error_klass
+        modulo = self.class.name.deconstantize.split('::').last
+        "TicketAbstractorClient::#{modulo}::Errors::UnexpectedError".safe_constantize
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/base/ticket.rb

@@ -0,0 +1,79 @@
+module TicketAbstractorClient
+  module Base
+    class Ticket
+
+      attr_reader :attachments, :comments, :changes, :status, :fields
+      attr_accessor :ticket_id, :endpoint, :project
+
+      def initialize(opts = {})
+        opts = opts.with_indifferent_access
+        @ticket_id = opts[:ticket_id]
+        @fields = opts.fetch(:fields, {}).with_indifferent_access
+        @endpoint = opts[:endpoint] || raise(Errors::TicketArgumentError, 'Endpoint is not given')
+        @project = opts[:project]
+        initialize_changes!
+        mark_changes!
+      end
+
+      def add_attachment(attachment)
+        self.class.not_implemented __method__
+      end
+
+      def add_comment(comment)
+        self.class.not_implemented __method__
+      end
+
+      def any_changes?
+        @changes.values.any? { |value| value.is_a?(Fixnum) ? !value.zero? : value.present? }
+      end
+
+      def reset_changes!
+        initialize_changes!
+      end
+
+      def status=(status)
+        return if @status == status
+        @changes[:new_status] = true
+        @status = status
+      end
+
+      def sync!
+        self.class.not_implemented __method__
+      end
+
+      def to_hash
+        {
+          ticket_id: @ticket_id,
+          status: @status,
+          external_updated_at: @external_updated_at,
+          fields: @fields,
+          comments: @comments.map(&:to_hash),
+          attachments: @attachments.map(&:to_hash)
+        }
+      end
+
+      def to_json
+        to_hash.to_json
+      end
+
+      def updated_at
+        self.class.not_implemented __method__
+      end
+
+      protected
+
+      def self.not_implemented(method_name)
+        raise Errors::NotImplementedError, "#{self}##{__method__} is not implemented"
+      end
+
+      def initialize_changes!
+        @changes = { create: false, update: false, new_status: false, new_attachments: 0, new_comments: 0 }
+      end
+
+      def mark_changes!
+        return @changes[:create] = true if @ticket_id.blank?
+        @changes[:update] = true if @fields.present?
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/client_helper.rb

@@ -0,0 +1,29 @@
+module TicketAbstractorClient
+  module ClientHelper
+    paths_to_load = %W(
+      base/*.rb
+      jira/params_builder.rb
+      jira/*.rb
+      service_now/params_builder.rb
+      service_now/*.rb
+    )
+    paths_to_load.each do |path|
+      location = File.expand_path(path, __dir__)
+      Dir[location].each { |f| require f }
+    end
+
+    Time::DATE_FORMATS[:jira_iso8601] = '%FT%T.%L%z'
+    Time::DATE_FORMATS[:service_now] = '%m-%d-%y %l:%M %p'
+    Time::DATE_FORMATS[:service_now_display_value] = '%m-%d-%y %-l:%M %p'
+    Time::DATE_FORMATS[:service_now_iso8601] = '%F %T'
+    Time::DATE_FORMATS[:unix_timestamp] = '%s'
+    Time::DATE_FORMATS[:unix_timestamp_with_ms] = '%s.%5N'
+
+    def get_jira_fields_meta
+      Jira::Client.new.endpoints.each_with_object({}) do |(endpoint, _), result|
+        result[endpoint.to_sym] = Jira::FieldsMeta.new(endpoint)
+      end
+    end
+    module_function :get_jira_fields_meta
+  end
+end

data/lib/ticket_abstractor_client/configuration.rb

@@ -0,0 +1,61 @@
+module TicketAbstractorClient
+  class Configuration
+    attr_accessor :ticket_abstractor_url, :security_token, :snow_display_value, :jira_fields_meta,
+      :jira_meta_expiration_period, :ssl_options
+
+    DEFAULT_JIRA_META_EXPIRATION_PERIOD = 604800 # 1 week
+
+    SNOW_DISPLAY_VALUES_LIST = [
+      SNOW_DISPLAY_VALUE_ALL = :all,
+      SNOW_DISPLAY_VALUE_TRUE = true,
+      SNOW_DISPLAY_VALUE_FALSE = false
+    ].freeze
+
+    DEFAULT_SNOW_DISPLAY_VALUE = SNOW_DISPLAY_VALUE_FALSE
+
+    DEFAULT_SSL_OPTIONS = { verify_ssl: true }.freeze
+
+    def jira_fields_filter_class
+      @jira_fields_filter_class.presence
+    end
+
+    def jira_fields_filter_class=(filter_klass)
+      raise_configuration_error(filter_klass) unless filter_klass < Base::FieldsFilter
+
+      @jira_fields_filter_class = filter_klass
+    end
+
+    def jira_fields_meta
+      @jira_fields_meta ||= ClientHelper.get_jira_fields_meta
+    end
+
+    def jira_meta_expiration_period
+      @jira_meta_expiration_period ||= DEFAULT_JIRA_META_EXPIRATION_PERIOD
+    end
+
+    def snow_display_value
+      @snow_display_value ||= DEFAULT_SNOW_DISPLAY_VALUE
+    end
+
+    def snow_fields_filter_class
+      @snow_fields_filter_class.presence
+    end
+
+    def snow_fields_filter_class=(filter_klass)
+      raise_configuration_error(filter_klass) unless filter_klass < Base::FieldsFilter
+
+      @snow_fields_filter_class = filter_klass
+    end
+
+    def ssl_options
+      @ssl_options ||= DEFAULT_SSL_OPTIONS
+    end
+
+    private
+
+    def raise_configuration_error(filter_klass)
+      message = "Filter class '#{filter_klass.to_s}' isn't a subclass of Base::FieldsFilter"
+      raise Base::Errors::ConfigurationError, message
+    end
+  end
+end