ticket_abstractor_client 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 115d09ad3d18ed05d7d9bd31cd6bcf5f96f87a13
-  data.tar.gz: 4b9f066a917ec904c2ec00989cabf11c0b1d109d
+  metadata.gz: 5e5d71cc98d22ffbab8164cbcd6d91d19360d516
+  data.tar.gz: ecb8e7f3ba91f51fc9eb47b7776a93d6b76b77b2
 SHA512:
-  metadata.gz: 252d6de493963f80a6608c5288866a0e1490ba35e3582bc24d355992ffce225be53e34a4538a01251c120ce51e1e92a32ce2d4fe15bc2f2f793ffda54c5ba5e3
-  data.tar.gz: 948ace98118b77dd78f67aced69c995ddfa777a585c867fdad70c77af20b9fa2c8e7df56990cbddd537658e9506a56ab22662a567420509fe5cdf9a6e79f70f3
+  metadata.gz: cf1de47f64d0c61c21791d8853e4853292788c364bdff38cd0d61badae1802b91b982ead7f5747cd8082a32aee3a3409a5fdc906603b0520541001bd8c47ddc0
+  data.tar.gz: 39abe1cee3c2a8c4e6aa120cbef44a6ca7d5ace53ce05dcec6866026005a94d9fac27541528c0a791a9b298eb07161ecc1607076f840ac7185d3314325603427

data/README.md

@@ -9,6 +9,8 @@ Client for accessing to a TicketAbstractor service.
 * [Configuration](#configuration)
 * [Usage](#usage)
 * [Filtering fields](#fields_filters)
+* [TODOs](#todos)
+* [Contributing](#contributing)
 
 ---
 
@@ -20,7 +22,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -77,6 +79,40 @@ this parameter defaults to false.
 
     config.snow_display_value = TicketAbstractorClient::Configuration::SNOW_DISPLAY_VALUE_ALL
 
+**Trace communications**
+
+Allows you to see all request's and response's data for `Client`, `Ticket`, `Comment` or `Attachment`
+
+    # add to configuration file
+    config.trace_communications = true # false by default
+
+    # my_class.rb
+    class MyClass
+      include TicketAbstractorClient
+
+      def create_snow_ticket(ticket_params)
+        snow_ticket = ServiceNow::Ticket.new(ticket_params).sync!
+
+        snow_ticket.communications_stack do |communication_data|
+          # do something
+        end
+      end
+    end
+
+`communications_stack` method returns an array of `CommunicationData` objects with following attributes:
+
+- method
+- path
+- args
+- response
+- executed_at
+- total_response_time
+- ta_response_time
+- ts_response_time
+
+`args` and `response` attributes may contain **'Binary content'** text or
+**'Base64 string representation of content'** text for attachments, text depends on ticketing system.
+
 [[table of contents](#content)]
 
 ---
@@ -332,9 +368,11 @@ and implement a `filter_ticket` method, after that configure the gem to use your
       end
 
       def filter_ticket
-        @ticket.fields.each_with_object([]) |raw_field, filtered_fields|
+        @ticket.fields = @ticket.fields.each_with_object([]) do |raw_field, filtered_fields|
           # do some filtering here
         end
+
+        @ticket
       end
     end
 
@@ -352,6 +390,14 @@ JIRA is supported as well.
 
 ---
 
+## <a name="todos"></a> TODOs
+
+- [] Ability to retrieve `communications_stack` data for Jira objects (`Ticket`, `Comment` and `Attachment`)
+
+[[table of contents](#content)]
+
+---
+
 ## <a name="contributing"></a> Contributing
 
 1. Fork it

data/lib/ticket_abstractor_client/base/attachment.rb

@@ -1,7 +1,7 @@
 module TicketAbstractorClient
   module Base
     class Attachment
-      attr_reader :file_path, :data_hash, :external_created_at
+      attr_reader :file_path, :data_hash, :external_created_at, :communications_stack
 
       # Carrierwave uses the same regexp
       SANITIZE_REGEXP = /[^[:word:]\.\-\+]/
@@ -38,6 +38,7 @@ module TicketAbstractorClient
         @file_path = opts[:file_path]
         @external_created_at = opts[:external_created_at]
         @data_hash = opts[:data_hash]
+        @communications_stack = opts[:communications_stack] || []
         set_data_hash! if @data_hash.blank?
       end
 

data/lib/ticket_abstractor_client/base/client.rb

@@ -3,10 +3,16 @@ module TicketAbstractorClient
     class Client
       include ResponseHandler
 
+      TA_RESPONSE_TIME_HEADERS_LIST = %i(total_response_time ta_response_time ts_response_time).freeze
+
+      attr_reader :communications_stack, :trace_communications
+
       def initialize
         @base_url = TicketAbstractorClient.configuration.ticket_abstractor_url
         @security_token = TicketAbstractorClient.configuration.security_token
         @ssl_options = TicketAbstractorClient.configuration.ssl_options
+        @communications_stack = []
+        @trace_communications = TicketAbstractorClient.configuration.trace_communications
 
         raise Errors::ConfigurationError, 'TicketAbstractor url is not given' if @base_url.blank?
         raise Errors::ConfigurationError, 'SecurityToken is not given' if @security_token.blank?
@@ -18,7 +24,7 @@ module TicketAbstractorClient
         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 = make_request(path, 'get', params)
             response.headers.key?(:file_request) ? { 'result' => response } : JSON.parse(response)
           end
         end
@@ -28,12 +34,42 @@ module TicketAbstractorClient
         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
+            response = make_request(path, 'post', params)
             JSON.parse response
           end
         end
       end
 
+      def make_request(path, method, params)
+        request = build_request(path, method, params)
+        executed_at = Time.now
+        response = request.execute
+
+        @communications_stack << communication_data(request, response, executed_at) if self.trace_communications
+
+        response
+      end
+
+      def communication_data(request, response, executed_at)
+        CommunicationData.new.tap do |communication|
+          communication.executed_at = executed_at
+
+          communication.method = request.method
+          communication.path = request.uri.path
+          communication.args = request.args.dig(:payload, :args) || request.args.dig(:headers, :params, :args)
+
+          if response.headers.key?(:file_request)
+            communication.binary_response!
+          else
+            communication.response = response.body
+          end
+
+          TA_RESPONSE_TIME_HEADERS_LIST.each do |key|
+            communication.public_send("#{key}=", response.headers[key])
+          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?

data/lib/ticket_abstractor_client/base/comment.rb

@@ -1,7 +1,7 @@
 module TicketAbstractorClient
   module Base
     class Comment
-      attr_reader :author, :body, :data_hash, :external_created_at
+      attr_reader :author, :body, :data_hash, :external_created_at, :communications_stack
 
       def self.fetch(*opts)
         method_not_implemented __method__
@@ -13,6 +13,7 @@ module TicketAbstractorClient
         @body = opts.fetch(:body, nil) || raise(Errors::CommentArgumentError, 'Body is not given')
         @external_created_at = opts[:external_created_at]
         @data_hash = opts[:data_hash]
+        @communications_stack = opts[:communications_stack] || []
         set_data_hash! if @data_hash.blank?
       end
 

data/lib/ticket_abstractor_client/base/ticket.rb

@@ -2,7 +2,7 @@ module TicketAbstractorClient
   module Base
     class Ticket
       attr_reader :attachments, :comments, :changes, :status
-      attr_accessor :ticket_id, :endpoint, :project, :fields
+      attr_accessor :ticket_id, :endpoint, :project, :fields, :communications_stack
 
       def initialize(opts = {})
         opts = opts.with_indifferent_access
@@ -10,6 +10,7 @@ module TicketAbstractorClient
         @fields = opts.fetch(:fields, {}).with_indifferent_access
         @endpoint = opts[:endpoint] || raise(Errors::TicketArgumentError, 'Endpoint is not given')
         @project = opts[:project]
+        @communications_stack = opts[:communications_stack] || []
         @attachments ||= []
         @comments ||= []
         initialize_changes!
@@ -73,6 +74,7 @@ module TicketAbstractorClient
 
       def mark_changes!
         return @changes[:create] = true if @ticket_id.blank?
+
         @changes[:update] = true if @fields.present?
       end
     end

data/lib/ticket_abstractor_client/communication_data.rb

@@ -0,0 +1,43 @@
+module TicketAbstractorClient
+  class CommunicationData
+    attr_accessor :method, :path, :args, :response, :executed_at,
+      :total_response_time, :ta_response_time, :ts_response_time
+
+    BINARY_RESPONSE_TEXT = 'Binary content'.freeze
+
+    def initialize
+      @binary_response = false
+    end
+
+    def binary_response!
+      @binary_response = true
+    end
+
+    def binary_response?
+      @binary_response
+    end
+
+    def response
+      return BINARY_RESPONSE_TEXT if self.binary_response?
+
+      @response
+    end
+
+    def to_h
+      {
+        method: self.method,
+        path: self.path,
+        args: self.args,
+        response: self.response,
+        executed_at: self.executed_at,
+        total_response_time: self.total_response_time,
+        ta_response_time: self.ta_response_time,
+        ts_response_time: self.ts_response_time
+      }
+    end
+
+    def to_json
+      self.to_h.to_json
+    end
+  end
+end

data/lib/ticket_abstractor_client/configuration.rb

@@ -1,7 +1,7 @@
 module TicketAbstractorClient
   class Configuration
     attr_accessor :ticket_abstractor_url, :security_token, :snow_display_value, :jira_fields_meta,
-      :jira_meta_expiration_period, :ssl_options
+      :jira_meta_expiration_period, :ssl_options, :trace_communications
 
     DEFAULT_JIRA_META_EXPIRATION_PERIOD = 604800 # 1 week
 
@@ -15,6 +15,8 @@ module TicketAbstractorClient
 
     DEFAULT_SSL_OPTIONS = { verify_ssl: true }.freeze
 
+    DEFAULT_TRACE_COMMUNICATIONS = false
+
     def jira_tickets_filter_class
       @jira_tickets_filter_class.presence
     end
@@ -33,6 +35,10 @@ module TicketAbstractorClient
       @jira_meta_expiration_period ||= DEFAULT_JIRA_META_EXPIRATION_PERIOD
     end
 
+    def trace_communications
+      @trace_communications ||= DEFAULT_TRACE_COMMUNICATIONS
+    end
+
     def snow_display_value
       @snow_display_value ||= DEFAULT_SNOW_DISPLAY_VALUE
     end

data/lib/ticket_abstractor_client/jira/ticket.rb

@@ -64,7 +64,7 @@ module TicketAbstractorClient
       def sync!
         raise(Errors::TicketArgumentError, 'No changes to apply') unless self.any_changes?
 
-        return self.create_ticket if @changes[:create]
+        return create_ticket if @changes[:create]
 
         update_ticket if @changes[:update]
         update_status if @changes[:new_status]
@@ -72,6 +72,8 @@ module TicketAbstractorClient
         sync_attachments unless @changes[:new_attachments].zero?
         self.reload!
         self.reset_changes!
+
+        self
       end
 
       def updated_at

data/lib/ticket_abstractor_client/service_now/attachment.rb

@@ -5,26 +5,24 @@ module TicketAbstractorClient
 
       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
+          client = Client.new(endpoint)
+          attachments_list = client.get_attachments(ticket_id: ticket_id)
+          return [[], client.communications_stack] if attachments_list.blank?
 
-        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
+          attachments =
+            attachments_list.map do |attachment|
+              attachment_data = client.get_attachment_file(sys_id: attachment['sys_id'])
+              filepath = save_content(attachment_data.body, attachment['file_name'])
+              new(
+                file_path: filepath,
+                ticket_id: ticket_id,
+                endpoint: endpoint,
+                project: project,
+                communications_stack: client.communications_stack
+              )
+            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
+          [attachments, client.communications_stack]
         end
       end
 
@@ -34,7 +32,11 @@ module TicketAbstractorClient
       end
 
       def sync!
-        Client.new(@endpoint).create_attachment(self)
+        client = Client.new(@endpoint)
+        response = client.create_attachment(self)
+        @communications_stack = client.communications_stack
+
+        response
       end
     end
   end

data/lib/ticket_abstractor_client/service_now/client.rb

@@ -4,6 +4,7 @@ module TicketAbstractorClient
       include ServiceNow::ParamsBuilder
 
       SYS_ID_LENGTH = 32
+      TICKET_NOT_FOUND = 'Ticket not found or incorrect ID given'.freeze
 
       def initialize(endpoint = 'default')
         super()
@@ -15,6 +16,11 @@ module TicketAbstractorClient
       end
 
       def get_attachments(opts)
+        opts[:ticket_id] = get_ticket_sys_id(opts)
+        get(__method__, opts)
+      end
+
+      def get_attachment_file(opts)
         get(__method__, opts)
       end
 
@@ -48,7 +54,9 @@ module TicketAbstractorClient
 
       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))
+
+        args, params = build_attachment_params(attachment)
+        post(__method__, args, params)
       end
 
       def create_comment(comment)
@@ -77,7 +85,7 @@ module TicketAbstractorClient
 
         response = get(__method__, opts)
 
-        raise(Errors::NotFoundError, 'Ticket not found or incorrect ID given') if response.blank?
+        raise(Errors::NotFoundError, TICKET_NOT_FOUND) if response.blank?
 
         response[0]['sys_id']
       end

data/lib/ticket_abstractor_client/service_now/comment.rb

@@ -4,17 +4,23 @@ module TicketAbstractorClient
       attr_accessor :ticket_id, :endpoint, :project
 
       def self.fetch(ticket_id, endpoint, project)
-        response = Client.new(endpoint).get_comments(ticket_id: ticket_id, project: project)
-        response.map do |raw_comment|
-          new({
-            author: raw_comment['sys_created_by'],
-            body: raw_comment['value'],
-            external_created_at: raw_comment['sys_created_on'],
-            ticket_id: ticket_id,
-            endpoint: endpoint,
-            project: project
-          })
-        end
+        client = Client.new(endpoint)
+        response = client.get_comments(ticket_id: ticket_id, project: project)
+
+        comments =
+          response.map do |raw_comment|
+            new({
+              author: raw_comment['sys_created_by'],
+              body: raw_comment['value'],
+              external_created_at: raw_comment['sys_created_on'],
+              ticket_id: ticket_id,
+              endpoint: endpoint,
+              project: project,
+              communications_stack: client.communications_stack
+            })
+          end
+
+        [comments, client.communications_stack]
       end
 
       def initialize(opts)
@@ -23,7 +29,11 @@ module TicketAbstractorClient
       end
 
       def sync!
-        Client.new(@endpoint).create_comment(self)
+        client = Client.new(@endpoint)
+        response = client.create_comment(self)
+        @communications_stack = client.communications_stack
+
+        response
       end
     end
   end

data/lib/ticket_abstractor_client/service_now/params_builder.rb

@@ -15,14 +15,17 @@ module TicketAbstractorClient
       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)
-        }
+        [
+          {
+            table_name: attachment.project,
+            table_sys_id: attachment.ticket_id,
+            file_name: File.basename(file_path),
+            content_type: mime_type
+          },
+          {
+            attachments: [File.new(file_path, 'rb')]
+          }
+        ]
       end
 
       def build_comment_params(comment)

data/lib/ticket_abstractor_client/service_now/ticket.rb

@@ -17,6 +17,7 @@ module TicketAbstractorClient
 
       def initialize(opts = {})
         super(opts)
+
         @project = opts[:project] || raise(Errors::TicketArgumentError, 'Project is not given')
         @sys_id = @fields['sys_id']
         @status = @fields['state']
@@ -25,12 +26,14 @@ module TicketAbstractorClient
       def add_attachment(attachment)
         @attachments << Attachment.new(attachment.merge(ticket_id: @ticket_id, endpoint: @endpoint, project: @project))
         @changes[:new_attachments] += 1
+
         self
       end
 
       def add_comment(comment)
         @comments << Comment.new(comment.merge(ticket_id: @ticket_id, endpoint: @endpoint, project: @project))
         @changes[:new_comments] += 1
+
         self
       end
 
@@ -39,7 +42,10 @@ module TicketAbstractorClient
 
         return [] if @ticket_id.blank? && @attachments.blank?
 
-        @attachments = Attachment.fetch(@ticket_id, @endpoint, @project)
+        @attachments, attachments_communications_stack = Attachment.fetch(@ticket_id, @endpoint, @project)
+        @communications_stack += attachments_communications_stack
+
+        @attachments
       end
 
       def comments
@@ -47,7 +53,10 @@ module TicketAbstractorClient
 
         return [] if @ticket_id.blank? && @comments.blank?
 
-        @comments = Comment.fetch(@ticket_id, @endpoint, @project)
+        @comments, comments_communications_stack = Comment.fetch(@ticket_id, @endpoint, @project)
+        @communications_stack += comments_communications_stack
+
+        @comments
       end
 
       def to_hash
@@ -56,12 +65,16 @@ module TicketAbstractorClient
 
       def sync!
         raise(Errors::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!
+
+        self
       end
 
       def updated_at
@@ -78,13 +91,15 @@ module TicketAbstractorClient
         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)
+        client = Client.new(endpoint)
+        client_response = client.public_send(method_map.fetch(selektor.to_sym), opts)
 
         Array.wrap(client_response).map do |ticket_hash|
           ticket_id = opts[:ticket_id] || ticket_hash['number']
           ticket = new(ticket_id: ticket_id, fields: ticket_hash, endpoint: endpoint, project: opts[:project])
           filtered_ticket = filter_ticket(ticket)
           filtered_ticket.reset_changes!
+          filtered_ticket.communications_stack = client.communications_stack
           filtered_ticket
         end
       end
@@ -98,13 +113,20 @@ module TicketAbstractorClient
       end
 
       def create_ticket
-        response = Client.new(@endpoint).create_ticket(self)
+        client = Client.new(@endpoint)
+        response = client.create_ticket(self)
+        @communications_stack += client.communications_stack
+
         ticket = Ticket.fetch_by_id(ticket_id: response['number'], project: @project, endpoint: @endpoint)
+
         @sys_id = ticket.sys_id
         @fields = ticket.fields
         @status = ticket.status
         @ticket_id = ticket.ticket_id
+        @communications_stack += ticket.communications_stack
         reset_changes!
+
+        self
       end
 
       def update_status
@@ -113,16 +135,26 @@ module TicketAbstractorClient
       end
 
       def update_ticket
-        response = Client.new(@endpoint).update_ticket(self)
+        client = Client.new(@endpoint)
+        response = client.update_ticket(self)
+        @communications_stack += client.communications_stack
         @fields['sys_updated_on'] = response['sys_updated_on']
       end
 
       def sync_attachments
-        @attachments.last(@changes[:new_attachments]).map(&:sync!)
+        @communications_stack +=
+          @attachments.last(@changes[:new_attachments]).flat_map do |attachment|
+            attachment.sync!
+            attachment.communications_stack
+          end
       end
 
       def sync_comments
-        @comments.last(@changes[:new_comments]).map(&:sync!)
+        @communications_stack +=
+          @comments.last(@changes[:new_comments]).flat_map do |comment|
+            comment.sync!
+            comment.communications_stack
+          end
       end
     end
   end

data/lib/ticket_abstractor_client/version.rb

@@ -1,3 +1,3 @@
 module TicketAbstractorClient
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

data/lib/ticket_abstractor_client.rb

@@ -20,4 +20,5 @@ require 'mime-types'
 
 require 'ticket_abstractor_client/version'
 require 'ticket_abstractor_client/configuration'
+require 'ticket_abstractor_client/communication_data'
 require 'ticket_abstractor_client/client_helper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ticket_abstractor_client
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Roman Samoilov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.5
+        version: 1.15.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.5
+        version: 1.15.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
 - lib/ticket_abstractor_client/base/ticket.rb
 - lib/ticket_abstractor_client/base/tickets_filter.rb
 - lib/ticket_abstractor_client/client_helper.rb
+- lib/ticket_abstractor_client/communication_data.rb
 - lib/ticket_abstractor_client/configuration.rb
 - lib/ticket_abstractor_client/jira/attachment.rb
 - lib/ticket_abstractor_client/jira/client.rb