ticket_abstractor_client 1.29.0 → 2.0.0

data/lib/ticket_abstractor_client/service_now/attachment.rb

@@ -0,0 +1,41 @@
+module TicketAbstractorClient
+  module ServiceNow
+    class Attachment < Base::Attachment
+      attr_accessor :ticket_id, :endpoint, :project
+
+      class << self
+        def fetch(ticket_id, endpoint, project)
+          download_files(ticket_id, endpoint).map do |filepath|
+            new(file_path: filepath, ticket_id: ticket_id, endpoint: endpoint, project: project)
+          end
+        end
+
+        protected
+
+        def download_files(ticket_id, endpoint)
+          response = Client.new(endpoint).get_attachments(ticket_id: ticket_id)
+          return [] if response.blank?
+          decode_and_save(Array.wrap(response['payload']), Array.wrap(response['file_name']))
+        end
+
+        def decode_and_save(payload, files_names)
+          payload.each.with_index.with_object([]) do |(payload, index), files|
+            next if payload.blank?
+            file_name = files_names[index]
+            decoded_payload = Base64.decode64(payload)
+            files << save_content(decoded_payload, file_name)
+          end
+        end
+      end
+
+      def initialize(opts)
+        super(opts)
+        @ticket_id, @endpoint, @project = opts.values_at(:ticket_id, :endpoint, :project)
+      end
+
+      def sync!
+        Client.new(@endpoint).create_attachment(self)
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/service_now/client.rb

@@ -0,0 +1,78 @@
+module TicketAbstractorClient
+  module ServiceNow
+    class Client < Base::Client
+      include ServiceNow::ParamsBuilder
+
+      SYS_ID_LENGTH = 32
+
+      def initialize(endpoint = 'default')
+        super()
+        @service_now_endpoint = endpoint
+      end
+
+      def get_all_tickets(opts)
+        get_tickets_by_query(build_all_tickets_params(opts))
+      end
+
+      def get_attachments(opts)
+        get(__method__, opts)
+      end
+
+      def get_comments(opts)
+        opts[:ticket_id] = get_ticket_sys_id(opts)
+        opts[:display_value] ||= TicketAbstractorClient.configuration.snow_display_value
+        get(__method__, opts)
+      end
+
+      def get_ticket_by_id(opts)
+        opts[:ticket_id] = get_ticket_sys_id(opts)
+        opts[:display_value] ||= TicketAbstractorClient.configuration.snow_display_value
+        get(__method__, opts)
+      end
+
+      def get_tickets_by_query(opts)
+        opts[:display_value] ||= TicketAbstractorClient.configuration.snow_display_value
+        get(__method__, opts)
+      end
+
+      def create_attachment(attachment)
+        attachment.ticket_id = get_ticket_sys_id(ticket_id: attachment.ticket_id, table_name: attachment.project)
+        post(__method__, build_attachment_params(attachment))
+      end
+
+      def create_comment(comment)
+        comment.ticket_id = get_ticket_sys_id(ticket_id: comment.ticket_id, table_name: comment.project)
+        post(__method__, build_comment_params(comment))
+      end
+
+      def create_ticket(ticket)
+        post(__method__, build_ticket_params(ticket))
+      end
+
+      def update_ticket(ticket)
+        ticket.ticket_id = get_ticket_sys_id(ticket_id: ticket.ticket_id, table_name: ticket.project)
+        post(__method__, build_ticket_params(ticket))
+      end
+
+      def update_ticket_status(ticket)
+        post(:update_ticket, build_status_params(ticket))
+      end
+
+      protected
+
+      def get_ticket_sys_id(opts)
+        return opts[:ticket_id] if opts[:ticket_id].length == SYS_ID_LENGTH
+
+        get(__method__, opts)[0]['sys_id']
+      end
+
+      def get(path, args = {}, params = {})
+        super("service_now/#{path}", args, params.merge(service_now_endpoint: @service_now_endpoint))
+      end
+
+      def post(path, args = {}, params = {})
+        super("service_now/#{path}", args, params.merge(service_now_endpoint: @service_now_endpoint))
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/service_now/comment.rb

@@ -0,0 +1,30 @@
+module TicketAbstractorClient
+  module ServiceNow
+    class Comment < Base::Comment
+      attr_accessor :ticket_id, :endpoint, :project
+
+      def self.fetch(ticket_id, endpoint, project)
+        response = Client.new(endpoint).get_comments(ticket_id: ticket_id, table_name: project)
+        response.map do |raw_comment|
+          new({
+            author: raw_comment['sys_created_by_name'],
+            body: raw_comment['value'],
+            external_created_at: raw_comment['sys_created_on'],
+            ticket_id: ticket_id,
+            endpoint: endpoint,
+            project: project
+          })
+        end
+      end
+
+      def initialize(opts)
+        super(opts)
+        @ticket_id, @endpoint, @project = opts.values_at(:ticket_id, :endpoint, :project)
+      end
+
+      def sync!
+        Client.new(@endpoint).create_comment(self)
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/service_now/errors.rb

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

data/lib/ticket_abstractor_client/service_now/params_builder.rb

@@ -0,0 +1,56 @@
+module TicketAbstractorClient
+  module ServiceNow
+    module ParamsBuilder
+      extend ActiveSupport::Concern
+
+      def biuld_all_tickets_params(opts)
+        opts[:sysparm_query] = build_sysparm_query(opts)
+        opts[:sysparm_fields] = Array.wrap(opts.delete(:fields))
+        opts.except!(:service_desk, :states)
+        opts[:display_value] ||= TicketAbstractorClient.configuration.snow_display_value
+        opts
+      end
+
+      def build_attachment_params(attachment)
+        file_path = attachment.file_path
+        mime_type = MIME::Types.type_for(file_path).first.try(:to_s) || '*/*'
+        file = File.open(file_path, 'rb')
+        {
+          agent: 'AttachmentCreator',
+          topic: 'AttachmentCreator',
+          name: "#{File.basename(file_path)}:#{mime_type}",
+          source: "#{attachment.project}:#{attachment.ticket_id}",
+          payload: Base64.encode64(file.read)
+        }
+      end
+
+      def build_comment_params(comment)
+        {
+          comment_params: { comments: comment.body },
+          ticket_id: comment.ticket_id,
+          table_name: comment.project,
+          display_value: TicketAbstractorClient.configuration.snow_display_value
+        }
+      end
+
+      def build_status_params(ticket)
+        { ticket_params: { state: ticket.status }, ticket_id: ticket.ticket_id, table_name: ticket.project }
+      end
+
+      def build_ticket_params(ticket)
+        opts = { ticket_params: ticket.fields, table_name: ticket.project }
+        opts.merge!(ticket_id: ticket.ticket_id) if ticket.ticket_id.present?
+        opts
+      end
+
+      def build_sysparm_query(opts)
+        sysparm_query = {
+          'u_support_fieldLIKE' => opts[:service_desk],
+          'u_input_source=' => 'OIV',
+          '' => opts.fetch(:states, '').split(',').map { |st| "state=#{st}" }.join('^OR')
+        }
+        sysparm_query.select { |_, v| v.present? }.map { |k, v| [k, v].join }.join('^')
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/service_now/ticket.rb

@@ -0,0 +1,120 @@
+module TicketAbstractorClient
+  module ServiceNow
+    class Ticket < Base::Ticket
+
+      def self.fetch_by_id(opts)
+        fetch(:by_id, opts).first
+      end
+
+      def self.fetch_all_tickets(opts)
+        fetch(:all, opts)
+      end
+
+      def self.fetch_tickets_by_query(opts)
+        fetch(:by_query, opts)
+      end
+
+      def initialize(opts = {})
+        super(opts)
+        @project = opts[:project] || raise(Errors::TicketArgumentError, 'Project is not given')
+        @status = @fields.delete('state')
+      end
+
+      def add_attachment(attachment)
+        @attachments << Attachment.new(attachment.merge!(ticket_id: @ticket_id, endpoint: @endpoint))
+        @changes[:new_attachments] += 1
+        self
+      end
+
+      def add_comment(comment)
+        @comments << Comment.new(comment.merge!(ticket_id: @ticket_id, endpoint: @endpoint))
+        @changes[:new_comments] += 1
+        self
+      end
+
+      def attachments
+        return @attachments if @attachments.present?
+
+        return [] if @ticket_id.blank? && @attachments.blank?
+
+        @attachments = Attachment.fetch(@ticket_id, @endpoint)
+      end
+
+      def comments
+        return @comments if @comments.present?
+
+        return [] if @ticket_id.blank? && @comments.blank?
+
+        @comments = Comment.fetch(@ticket_id, @endpoint)
+      end
+
+      def sync!
+        raise TicketArgumentError, 'No changes to apply' unless self.any_changes?
+        return create_ticket if @changes[:create]
+        update_ticket if @changes[:update]
+        update_status if @changes[:new_status]
+        sync_comments unless @changes[:new_comments].zero?
+        sync_attachments unless @changes[:new_attachments].zero?
+        reset_changes!
+      end
+
+      def updated_at
+        @fields['sys_updated_on']
+      end
+
+      private
+
+      # selektor -- all, by_id, by_query
+      # Ticket.fetch(:all, opts)
+      # Ticket.fetch(:by_id, opts)
+      # Ticket.fetch(:by_query, opts)
+      def self.fetch(selektor, opts)
+        opts = opts.with_indifferent_access
+        endpoint = opts.delete(:endpoint)
+        method_map = { all: :get_all_tickets, by_id: :get_ticket_by_id, by_query: :get_tickets_by_query }
+        client_response = Client.new(endpoint).public_send(method_map.fetch(selektor.to_sym), opts)
+
+        Array.wrap(client_response).map do |hash|
+          fields = filter_fields(hash)
+          ticket = new(ticket_id: opts[:ticket_id], fields: fields, endpoint: endpoint, project: opts[:table_name])
+          ticket.reset_changes!
+          ticket
+        end
+      end
+
+      def self.filter_fields(fields)
+        filter_fields_klass = TicketAbstractorClient.configuration.snow_fields_filter_class
+
+        return fields if filter_fields_klass.blank?
+
+        filter_fields_klass.new(fields).filter_fields
+      end
+
+      def create_ticket
+        response = Client.new(@endpoint).create_ticket(self)
+        ticket = Ticket.fetch_by_id(ticket_id: response['number'], table_name: @project, endpoint: @endpoint)
+        @fields = ticket.fields
+        @status = ticket.status
+        reset_changes!
+      end
+
+      def update_status
+        @fields['state'] = @status
+        update_ticket
+      end
+
+      def update_ticket
+        response = Client.new(@endpoint).update_ticket(self)
+        @fields['sys_updated_on'] = response['sys_updated_on']
+      end
+
+      def sync_attachments
+        @attachments.last(@changes[:new_attachments]).map(&:sync!)
+      end
+
+      def sync_comments
+        @comments.last(@changes[:new_comments]).map(&:sync!)
+      end
+    end
+  end
+end

data/lib/ticket_abstractor_client/version.rb

@@ -1,3 +1,3 @@
 module TicketAbstractorClient
-  VERSION = '1.29.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ticket_abstractor_client
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Roman Samoilov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,6 +53,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
 description: Get access to Jira and Brouha ticketing systems through the single service
 email:
 - rsamoilov@productengine.com
@@ -63,13 +91,28 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/ticket_abstractor_client.rb
-- lib/ticket_abstractor_client/brouha_client.rb
-- lib/ticket_abstractor_client/client.rb
-- lib/ticket_abstractor_client/i_logger_client.rb
-- lib/ticket_abstractor_client/itrc_client.rb
-- lib/ticket_abstractor_client/jira_client.rb
-- lib/ticket_abstractor_client/service_now_client.rb
-- lib/ticket_abstractor_client/sev_one_client.rb
+- lib/ticket_abstractor_client/base/attachment.rb
+- lib/ticket_abstractor_client/base/client.rb
+- lib/ticket_abstractor_client/base/comment.rb
+- lib/ticket_abstractor_client/base/errors.rb
+- lib/ticket_abstractor_client/base/fields_filter.rb
+- lib/ticket_abstractor_client/base/response_handler.rb
+- lib/ticket_abstractor_client/base/ticket.rb
+- lib/ticket_abstractor_client/client_helper.rb
+- lib/ticket_abstractor_client/configuration.rb
+- lib/ticket_abstractor_client/jira/attachment.rb
+- lib/ticket_abstractor_client/jira/client.rb
+- lib/ticket_abstractor_client/jira/comment.rb
+- lib/ticket_abstractor_client/jira/errors.rb
+- lib/ticket_abstractor_client/jira/fields_meta.rb
+- lib/ticket_abstractor_client/jira/params_builder.rb
+- lib/ticket_abstractor_client/jira/ticket.rb
+- lib/ticket_abstractor_client/service_now/attachment.rb
+- lib/ticket_abstractor_client/service_now/client.rb
+- lib/ticket_abstractor_client/service_now/comment.rb
+- lib/ticket_abstractor_client/service_now/errors.rb
+- lib/ticket_abstractor_client/service_now/params_builder.rb
+- lib/ticket_abstractor_client/service_now/ticket.rb
 - lib/ticket_abstractor_client/version.rb
 homepage: https://github.comcast.com/opsint/ticket-abstractor-client
 licenses: