tehportal 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c5a8fa924393d1efda5585ea6666232b67310de
-  data.tar.gz: 5f6601b8bd473d1b691c56258bbe1a8814140a86
+  metadata.gz: 89c7023c36b3c4aaf5d169c02278e63f57ebbe08
+  data.tar.gz: b671e3f9bd9a34c230f865e78560bb2598179d15
 SHA512:
-  metadata.gz: 1392c6f43ed7369ccbc8b5ce71d26e34a0ade9363d5dd718df3a3d45e511bc19e0334aecc4bad58d81bcc8c907b1a2cda3d4828358b76150022cc6a11197849b
-  data.tar.gz: 2b70144a02c70d0a8fc3229a496751c94426fbcfc47f8115ace6182e7eab7c9e7184ce8fb4546311cff2e0da71680230e1ca85d7ef74febc18193f9c803ee2cf
+  metadata.gz: ce27c58dc530915a96c0c2a99bf57d52cf4c22c562e658b62eb5e8ef1fb826f60d625e1b5de22bf333e28d4082c3fc42f2683b32a556ad8f4a5ae3bda9ded389
+  data.tar.gz: f698526fb5feefedd5d9c1925b5a768f9eecb841ffa9c7aabb14e0f351933939b6e1f44e2d3c5e46fcddbea23ecbaff8ea3777c0d828a75ef5644308b79571f3

data/README.md

@@ -3,30 +3,6 @@
 ## Описание
 Данный gem  это ядро для работы с remedy и возможно с другими системами.
 
-##  Модели
-Все сервиси группируем - инциденты, изменения, проблемы, задачи и тд. Для каждой группы делаем модель с базовым классом - **Tehportal::Model**.
-В модели делаем описание всех сервисов в виде хэша:
-
-    @@services = {
-        show:   'ATC:HPD:AKEOS-Portal-Get-Incident-WorkInfo',
-        list:   'ATC:INC:AKEOS-List',
-        create: 'ATC:INC:AKEOS-Create',
-        update: 'ATC:INC:AKEOS-Modify'
-    }
-
-Где ключ данного хэша будет соответствовать action-методу в соответствующем контроллере. 
-Также в базовом классе моделе реализован запрос к серверу(сейчас через method_missing, после рефакторинга с помощью class_eval). 
-Модели называем во множественном числе(например: Tehportal::Incidents), чтобы соответствовало названию контроллера. 
-
-**ВАЖНО:** Т.к. в remedy важен порядок передаваемых ему полей в моделе реализован механизм, который расставляем параметры в нжном порядке. Нужно просто передать параметры.
-
-### 1.Инциденты
-Модель: **Tehportal::Incidents**
-### 2.Изменения
-### 3.Проблемы
-Модель: **Tehportal::Problems**
-### 4.Релизы
-
 ## Контроллеры/API
 Все контроллеры для работы с remedy наследуются от **RemedyBaseController**. Перед запуском любого action-метода срабатывает хук который отпределяет 
 с какой моделью работать данному контроллеру. 
@@ -36,69 +12,6 @@
 Базовый url: _/tp/remedy_  
 
 Параметры который пойдут на вход Remedy передаются в массиве data (пример: data[ID]=23&data[Description]=New_Message)  
-Для action может быть несколько операций, они передаются параметром operation(пример: operation=INCGetList-InWork)  
-
-### 1.Инциденты
-#### Список инцидентов
-
-*URL:* GET /incidents/ 
-
-|Операция|Описание|Параметры|
-|--------|--------|---------|
-| _INCGetList-InWork_ | Назначенные на меня со статусом "открытые" |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Login - логин пользователя| 
-| _INCGetList-SLABreached-My_ | Назначенные на меня со статусом "нарушенные" |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Login - логин пользователя|  
-| _INCGetList-Pending-My_ | Назначенные на меня со статусом "в ожидании" |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Login - логин пользователя|  
-| _INC_Created_By_Me_InWork_ | Созданные мной |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Login - логин пользователя|
-| _INCGetList-SLABreached-OnMyGroup_ | Назначенные на группу со статусом "просроченные"|startRecord - offset для списка<br /> maxLimit - limit для списка<br />Group - Название группы|
-| _INCGetList-InWork-OnMyGroup_ | Назначенные на группу со статусом "открытые"|startRecord - offset для списка<br /> maxLimit - limit для списка<br />Group - Название группы|
-| _NCGetList-Pending-OnMyGroup_ | Назначенные на группу со статусом "в ожидании" |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Group - Название группы|
-
-##### *URL:* GET /incidents/:id  - Просмотр инцидента   
-##### *URL:* GET /incidents/:id/associations - Просмотр инцидента: свзяи
-##### *URL:* GET /incidents/:id/tasks - Просмотр инцидента: задачи
-##### *URL:* GET /incidents/:id/times - Просмотр инцидента: затраченное время
-
-### 2.Задачи
-#### Список задач
-
-*URL:* GET /tasks/ 
-
-|Операция|Описание|Параметры|
-|--------|--------|---------|
-| _TSK_My_InWork_ | Назначенные на меня со статусом "открытые" |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Login - логин пользователя| 
-| _TSK_Created_By_Me_InWork_ | Созданные мной |startRecord - offset для списка<br /> maxLimit - limit для списка<br />Login - логин пользователя|
-| _TSK_OnMyGroup_InWork_ | Назначенные на группу со статусом "открытые"|startRecord - offset для списка<br /> maxLimit - limit для списка<br />Group - Название группы|
-
-##### *URL:* GET /incidents/:id - Просмотр задачи
-##### *URL:* GET /tasks/:id/comments - Просмотр задачи: комментарии
-##### *URL:* GET /tasks/:id/times - Просмотр задачи: затраченное время
-
-
-### 3.Изменения
-### 4.Проблемы
-Контроллер: **ProblemsController**  
-Методы:
-
-* list  
-      
-    команда:  
-    `GET /tp/remedy/problems?operation=[операция]`  
-      
-    операции:
-  
-        - InWorkMy
-        - InWorkGroup
-        - InWorkAllGroups
-
-* show  
-    команда:  
-        `GET /tp/remedy/problems/[id]`  
-  
-* create  
-    команда:  
-        `POST /tp/remedy/problems`  
-
-### 5.Релизы
 
 # Установка
 
@@ -109,9 +22,13 @@
 1. В приложении необходимо создать инициализатор gem'а:
 
     `Tehportal.configure do |config|
+    
       config.url      = 'http://example.com'
+      
       config.server   = 'example-server'
+      
       config.endpoint = 'http://example.com/services/ARService'
+      
     end`
     
 1. Роутинг:

data/app/controllers/remedy_controller.rb

@@ -50,8 +50,12 @@ class RemedyController < Tehportal.config.parent_controller.constantize
   private
 
   def render_remedy_json(data)
-    prepared = data.except('@xmlns:ns0', '@xmlns:xsd', '@xmlns:xsi')
-    render json: (prepared.blank? && data.length != 3) ? nil : prepared
+    if data.is_a? Array
+      render json: data
+    else
+      prepared = data.except!('@xmlns:ns0', '@xmlns:xsd', '@xmlns:xsi')
+      render json: (prepared.blank? && data.length != 3) ? {} : prepared
+    end
   end
 
 end

data/lib/tehportal/operation.rb

@@ -20,10 +20,27 @@ module Operation
 
       # Добавляем синглтон метод к классу модели
       define_singleton_method(name) do |*args|
+        args[0] ||= {}
         client = args[0].delete(:client) || Tehportal.client
         message = options[:defaults].merge(args[0])
-
-        client.request(service, operation, message)
+        
+        unless options[:cache] and result = Rails.cache.fetch([:tehportal, service, operation, message])
+          result = client.request(service, operation, message)
+          if options[:cache] and !result.include?(:errorMessage)
+            Rails.cache.write([:tehportal, service, operation, message], result, expires_in: options[:cache])
+          end
+        end
+        
+        if options[:as] == :list
+          if result.include?(:errorMessage)
+            if result[:errorMessage] =~ /^ERROR \(302\)/
+              result = []
+            end
+          else
+            result = Array.wrap(result['getListValues'] || [result])
+          end
+        end
+        result
       end
     end
   end

data/lib/tehportal/remedy_client.rb

@@ -1,10 +1,12 @@
 module Tehportal
   class RemedyClient
-    delegate :config, to: :Tehportal
+    attr_reader :config
 
-    def initialize(login = nil, password = nil)
+    def initialize(login = nil, password = nil, **config_override)
       @login, @password = login, password
       @definitions = Rails.cache.read('tp.remedy.definitions') || {}
+      @config = Tehportal.config
+      config_override.each {|k, v| @config.send "#{k}=", v}
     end
 
     # Выполнение запроса к сервису
@@ -15,6 +17,7 @@ module Tehportal
     #     e.g.: {"Status" => "Pending"}
     def request(service, method, body = {})
       message = {}
+      body = body.with_indifferent_access
       operation_map = operation_map(service, method)
 
       operation_map[:input].each do |key|
@@ -32,7 +35,7 @@ module Tehportal
                             log: true,
                             logger: Rails.logger,
                             log_level: :debug,
-                            filters: [:password])
+                            filters: [:password, *[1,2,3].map {|i| :"z2AF_Work_Log0#{i}_attachmentData"}, *[1,2,3].map {|i| :"WLG_Attach#{i}_File"}])
 
       response = client.call(method, message: message, soap_action: "urn:#{service}/#{method}", advanced_typecasting: false)
 
@@ -67,6 +70,41 @@ module Tehportal
 
       @definitions[service]
     end
+    
+    # Хелперы для #operations_map и, в частности, для дебага не очень прямых сервисов
+    def operation_fields(op_name, elements: nil, types: nil)
+      unless elements and types
+        unless op_name['/']
+          raise ArgumentError, 'Нужно передать либо полное имя сервиса, e.g. ATC:FoundationCatalogs/SupportGroups, либо :elements и :types'
+        end
+        service, op_name = op_name.split '/'
+        elements, types = elements_and_types(service)
+      end
+      type_name = elements.find {|e| e['@name'] == op_name}['@type'].sub(/^[^:]+:/, '')
+      type_input = types.find {|t| t['@name'] == type_name}['sequence'] || {}
+      Array.wrap(type_input['element'])
+    end
+    
+    def definition_schema(defs)
+      schema = defs['types'].blank? ? {} : defs['types']['schema']
+      if schema.is_a? Array # для Ремеди Росреестра; у сибирского всегда только 1 schema
+        main_schema = schema[0]
+        schema.sum(&:keys).uniq.each {|k|
+          unless k['@']
+            main_schema[k] = schema.sum {|i| Array.wrap(i[k])}
+          end
+        }
+        main_schema
+      else
+        schema
+      end
+    end
+    
+    def elements_and_types(service)
+      schema = definition_schema(definitions(service))
+      [Array.wrap(schema['element']), 
+       Array.wrap(schema['complexType'])]
+    end
 
     # Определение доступных операций и их характеристик
     # в соответствии с wsdl:definition по указанному сервису
@@ -75,10 +113,8 @@ module Tehportal
     #     e.g.: ATC:INC:AKEOS-List
     def operations_map(service)
       defs = definitions(service)
-      schema = defs['types']['schema']
+      elements, types = elements_and_types(service)
       messages = Array.wrap(defs['message'])
-      elements = Array.wrap(schema['element'])
-      types = Array.wrap(schema['complexType'])
       operations = Array.wrap(defs['portType']['operation'])
       
       res = operations.map do |op|
@@ -90,14 +126,10 @@ module Tehportal
         # undasherize для удобства обхода (совместимо с текущим кодом)
         element_name.tr! '-', '_'
         
-        type_name = elements.find {|e| e['@name'] == op_name}['@type'].sub(/^[^:]+:/, '')
-        type_input = types.find {|t| t['@name'] == type_name}['sequence']
-        if type_input
-          fields = Array.wrap(type_input['element'])
-          field_names = fields.map {|f| f['@name']}
-        end
+        fields = operation_fields op_name, elements: elements, types: types
+        field_names = fields.map {|f| f['@name']}
 
-        [op_name, {output: element_name, input: Array.wrap(field_names)}]
+        [op_name, {output: element_name, input: field_names}]
       end
 
       Hash[res]

data/lib/tehportal/version.rb

@@ -1,3 +1,3 @@
 module Tehportal
-  VERSION = '0.1.0'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tehportal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - AT Consulting