tehportal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c5a8fa924393d1efda5585ea6666232b67310de
+  data.tar.gz: 5f6601b8bd473d1b691c56258bbe1a8814140a86
+SHA512:
+  metadata.gz: 1392c6f43ed7369ccbc8b5ce71d26e34a0ade9363d5dd718df3a3d45e511bc19e0334aecc4bad58d81bcc8c907b1a2cda3d4828358b76150022cc6a11197849b
+  data.tar.gz: 2b70144a02c70d0a8fc3229a496751c94426fbcfc47f8115ace6182e7eab7c9e7184ce8fb4546311cff2e0da71680230e1ca85d7ef74febc18193f9c803ee2cf

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tehportal.gemspec
+gemspec

data/README.md

@@ -0,0 +1,128 @@
+# Tehportal
+
+## Описание
+Данный 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-метода срабатывает хук который отпределяет 
+с какой моделью работать данному контроллеру. 
+
+Для каждого сервиса реализуется action-метод, в который в качестве параметра передается название операции и другие параметры.
+
+Базовый 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.Релизы
+
+# Установка
+
+1. Добавить следующую строчку в Gemfile:
+
+    `gem 'tehportal', git: 'git@gitlab.at-consulting:dfp/tehportal'`
+    
+1. В приложении необходимо создать инициализатор gem'а:
+
+    `Tehportal.configure do |config|
+      config.url      = 'http://example.com'
+      config.server   = 'example-server'
+      config.endpoint = 'http://example.com/services/ARService'
+    end`
+    
+1. Роутинг:
+
+    `mount Tehportal::Engine => '/'`
+    
+1. Авторизация: перед выполением каких либо действий нужно настроить пользователя от чьего имени будут выполняться запросы, если используется devise, то код будет следующего вида:
+
+    `Tehportal.setup_client(current_user.login, current_user.decrypt_password) if current_user`
+
+
+# Использование
+
+TODO: Write usage instructions here

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/remedy_controller.rb

@@ -0,0 +1,59 @@
+#++
+# Базовый контроллер для всех remedy-запросов.
+#
+# Базовый action-методы описываются тут, если в конкретном подклассе необходимо,
+# то всегда базовый метод можно переопределить.
+#--
+class RemedyController < Tehportal.config.parent_controller.constantize
+  # before_filter :specify_params, only: %i(index search)
+  # respond_with_params only: %i(index search)
+
+  def send_request
+    model = "Tehportal::#{params[:model].capitalize}".constantize
+    render_remedy_json model.send(params[:method], params[:data])
+  end
+
+  # ВСЕВОЗМОЖНЫЕ СПИСКИ
+  def index
+    result = model.list(params[:operation], list_params)
+    result['getListValues'] = Array.wrap(result['getListValues'])
+
+    render_remedy_json result
+  end
+
+  # СВЯЗИ
+  def associations
+    render_remedy_json model.associations('GetList_Association', association_params)
+  end
+
+  private
+
+  # Получение класса модели, через которую будут делаться запросы
+  def model
+    @model ||= "Tehportal::#{params[:controller].split('/').last.capitalize}".constantize
+  end
+
+  def model_class(name)
+    "Tehportal::#{name.capitalize}".constantize
+  end
+
+  # Запрос на получение связей, имя ID объекта у всех разный
+  def association_params
+    data = {}
+    model_name = params[:controller].split('/').last.downcase.to_sym
+    params_map = {incidents: 'IncidentNumber', problems: 'ProblemInvestigationID', changes: 'Infrastructure_Change_ID'}
+
+    data[params_map[model_name]] = params[:id]
+    data
+  end
+
+  private
+
+  def render_remedy_json(data)
+    prepared = data.except('@xmlns:ns0', '@xmlns:xsd', '@xmlns:xsi')
+    render json: (prepared.blank? && data.length != 3) ? nil : prepared
+  end
+
+end
+
+

data/config/locales/ru.yml

@@ -0,0 +1,2 @@
+ru:
+  errors:

data/config/routes.rb

@@ -0,0 +1,8 @@
+Tehportal::Engine.routes.draw do
+  # Модули для работы с Remedy
+  namespace :remedy do
+    scope :v1 do
+      post ':model/:method', action: 'send_request'
+    end
+  end
+end

data/lib/nori_patch.rb

@@ -0,0 +1,30 @@
+require 'nori/parser/nokogiri'
+
+# В текущей реализации парсер пропускает пробелы между
+# представленными в виде xml character entities non-ASCII словами,
+# считая их мусором:
+# <ns0:ASSIGNEDGROUP>&#x414;&#x435;&#x436;&#x443;&#x440;&#x43D;&#x430;&#x44F; &#x441;&#x43C;&#x435;&#x43D;&#x430; &#x41B;&#x41F;1.5</ns0:ASSIGNEDGROUP>
+# Ожидается: "ns0:ASSIGNEDGROUP"=>"Дежурная смена ЛП1.5"
+# Имеется в nori-2.4.0: "ns0:ASSIGNEDGROUP"=>"ДежурнаясменаЛП1.5"
+class Nori::Parser::Nokogiri::Document
+
+  def characters(string)
+    last = stack.last
+    if last and last.children.last.is_a?(String) or string.strip.size > 0
+      last.add_node(string)
+    end
+  end
+  alias cdata_block characters
+
+  def end_element(name)
+    if stack.size > 1
+      last = stack.pop
+      maybe_string = last.children.last
+      if maybe_string.is_a?(String) and maybe_string.strip.empty?
+        last.children.pop
+      end
+      stack.last.add_node last
+    end
+  end
+
+end

data/lib/tehportal/attachment.rb

@@ -0,0 +1,62 @@
+module Tehportal
+  module Attachment
+    module_function
+
+    def file_list(path)
+      file_list = []
+      if path.present? and File.directory?(path)
+        file_list = Dir(path).content.select {|f| File.file?(f)}.map {|f| File.basename(f)}
+      end
+      file_list
+    end
+
+    def path_for(request_params, user)
+      if request_params[:commentable]
+        subject, id = request_params[:commentable]/'/'
+      else
+        subject = request_params[:controller]
+        if request_params[:action] == 'create'
+          id = 'NEW'
+        else
+          id = request_params[:id]
+        end
+      end
+      if subject
+        "#{Rails.root}/tmp/#{subject}/#{id}/#{user.login}"
+      end
+    end
+
+    def file_list_for(request_params, user)
+      path = path_for(request_params, user)
+      Attachment.file_list path
+    end
+
+    def collect_files_at(path)
+      files = {dir: path}
+
+      if File.directory?(path)
+        file_list = Attachment.file_list(path)
+        file_list[0..2].each_with_index do |file_name, index|
+          i = index+1
+          if content = read("#{path}/#{file_name}")
+            files.merge! :"name_#{i}" => file_name,
+              :"data_#{i}" => Base64.encode64(content),
+              :"size_#{i}" => content.size
+          end
+        end
+      end
+
+      files
+    end
+
+    def collect_files_for(request_params, user)
+      collect_files_at path_for(request_params, user)
+    end
+
+    def clear(params, user)
+      path_tmp = path_for(params, user)
+      FileUtils.rm_rf(path_tmp) if File.directory?(path_tmp)
+    end
+
+  end
+end

data/lib/tehportal/configuration.rb

@@ -0,0 +1,5 @@
+module Tehportal
+  class Configuration
+    attr_accessor :url, :endpoint, :server, :parent_controller
+  end
+end

data/lib/tehportal/engine.rb

@@ -0,0 +1,9 @@
+require 'rails/engine'
+
+module Tehportal
+  class Engine < Rails::Engine
+    engine_name 'tp'
+
+    config.autoload_paths += %W(#{config.root}/models/**)
+  end
+end

data/lib/tehportal/model.rb

@@ -0,0 +1,14 @@
+require 'tehportal/operation'
+
+module Tehportal
+  class Model
+    extend ActiveModel::Naming
+    include Operation
+
+    @operations = {}
+
+    class << self
+      attr_accessor :operations
+    end
+  end
+end

data/lib/tehportal/operation.rb

@@ -0,0 +1,30 @@
+# Орерации(действия)
+module Operation
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    # Метод описания операции
+    # @ name    : Название операции
+    # @ url     : url = название_сервиса + / + название_операции
+    # @ options : Параметры для операции
+    #     - defaults : Значения по умолчанию для Body
+    def operation(name, url, options = {})
+      options[:defaults] ||= {}
+      service, operation = url.split('/')
+      model_name = self.name.split('::').last.downcase
+
+      Tehportal::Model.operations[model_name] ||= {}
+      Tehportal::Model.operations[model_name][name] = {service: service, operation: operation}
+
+      # Добавляем синглтон метод к классу модели
+      define_singleton_method(name) do |*args|
+        client = args[0].delete(:client) || Tehportal.client
+        message = options[:defaults].merge(args[0])
+
+        client.request(service, operation, message)
+      end
+    end
+  end
+end

data/lib/tehportal/remedy_client.rb

@@ -0,0 +1,111 @@
+module Tehportal
+  class RemedyClient
+    delegate :config, to: :Tehportal
+
+    def initialize(login = nil, password = nil)
+      @login, @password = login, password
+      @definitions = Rails.cache.read('tp.remedy.definitions') || {}
+    end
+
+    # Выполнение запроса к сервису
+    #
+    # @ service : Веб-сервис
+    # @ method  : операция веб-сервиса
+    # @ body    : хеш данных для запроса к веб-сервису
+    #     e.g.: {"Status" => "Pending"}
+    def request(service, method, body = {})
+      message = {}
+      operation_map = operation_map(service, method)
+
+      operation_map[:input].each do |key|
+        message[key] = body[key] if body.has_key?(key) && body[key].to_s.downcase != 'null'
+      end unless operation_map.nil?
+
+      client = Savon.client(endpoint: "#{config.endpoint}?server=#{config.server}&webService=#{service}",
+                            namespace: service,
+                            soap_header: {'AuthenticationInfo' => {userName: @login, password: @password}},
+                            ssl_verify_mode: :none,
+                            raise_errors: false,
+                            convert_response_tags_to:  nil,
+                            open_timeout: 300,
+                            read_timeout: 300,
+                            log: true,
+                            logger: Rails.logger,
+                            log_level: :debug,
+                            filters: [:password])
+
+      response = client.call(method, message: message, soap_action: "urn:#{service}/#{method}", advanced_typecasting: false)
+
+      hash = response.to_hash
+      hash.has_key?('Fault') ? {errorMessage: hash['Fault']['faultstring']} : hash["#{method.gsub(/-/, '_')}Response"]
+    end
+
+    def wsdl_url(service)
+      [config.url, config.server, service].join('/')
+    end
+
+    # Получить Nori-made хеш на основе xml-документа <wsdl:definitions>
+    # e.g.: http://188.254.6.21/arsys/WSDL/public/skuf-app/ATC:INC:AKEOS-List
+    #
+    # @ service : имя сервиса
+    #     e.g.: ATC:INC:AKEOS-List
+    def definitions(service)
+      unless @definitions[service]
+        @definitions[service] ||= begin
+          client = Savon.client({wsdl: wsdl_url(service),
+                                 ssl_verify_mode: :none,
+                                 raise_errors: false,
+                                 convert_request_keys_to: :none,
+                                 convert_response_tags_to: :none})
+          client.operations
+          xml = client.instance_variable_get(:@wsdl).xml
+          Nori.new(strip_namespaces: true, delete_namespace_attributes: true).parse(xml)['definitions']
+        end
+
+        Rails.cache.write('tp.remedy.definitions', @definitions, expires_in: 1.day)
+      end
+
+      @definitions[service]
+    end
+
+    # Определение доступных операций и их характеристик
+    # в соответствии с wsdl:definition по указанному сервису
+    #
+    # @ service : путь к значению в конфиге
+    #     e.g.: ATC:INC:AKEOS-List
+    def operations_map(service)
+      defs = definitions(service)
+      schema = defs['types']['schema']
+      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|
+        op_name = op['@name']
+        
+        message_name = op['output']['@message'].sub(/^[^:]+:/, '')
+        message = messages.find {|m| m['@name'] == message_name}
+        element_name = message['part']['@element'].sub(/^[^:]+:/, '')
+        # 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
+
+        [op_name, {output: element_name, input: Array.wrap(field_names)}]
+      end
+
+      Hash[res]
+    end
+
+    def operation_map(service, operation)
+      all_operations = operations_map(service)
+      all_operations[operation]
+    end
+  end
+end

data/lib/tehportal/version.rb

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

data/lib/tehportal.rb

@@ -0,0 +1,39 @@
+require 'rails/all'
+require 'savon'
+
+require 'nori_patch'
+require 'tehportal/engine'
+
+# --
+# Обертка для запросов к бекенду Техпортала (Ремеди)
+# ++
+module Tehportal
+  extend ActiveSupport::Autoload
+
+  autoload :Attachment
+  autoload :Configuration
+  autoload :Model
+  autoload :RemedyClient
+
+  class << self
+    attr_writer :config
+    attr_reader :client
+
+    delegate :request, to: :client
+
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def setup_client(login, password)
+      @client = RemedyClient.new(login, password)
+    end
+  end
+end
+
+require 'tehportal/version'
+

data/tehportal.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tehportal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tehportal'
+  spec.version       = Tehportal::VERSION
+  spec.authors       = ['AT Consulting']
+  spec.email         = ['info@at-consulting.ru']
+  spec.summary       = %q{Прослойка для работы с Remedy.}
+  spec.description   = %q{Прослойка для работы с Remedy.}
+  spec.homepage      = 'https://at-consulting.ru'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'savon', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: tehportal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AT Consulting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "Прослойка для работы с Remedy."
+email:
+- info@at-consulting.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- app/controllers/remedy_controller.rb
+- config/config.yml
+- config/locales/ru.yml
+- config/routes.rb
+- lib/nori_patch.rb
+- lib/tehportal.rb
+- lib/tehportal/attachment.rb
+- lib/tehportal/configuration.rb
+- lib/tehportal/engine.rb
+- lib/tehportal/model.rb
+- lib/tehportal/operation.rb
+- lib/tehportal/remedy_client.rb
+- lib/tehportal/version.rb
+- tehportal.gemspec
+homepage: https://at-consulting.ru
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "Прослойка для работы с Remedy."
+test_files: []