ip21 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b56f02bb8919d8869c39d3b98248fbd2befad1160c76195fe1280da011af15b9
-  data.tar.gz: cac1e5bf0dabe81118c1245a93f70d503cec9eb1a631e497ee6d6a01c853b108
+  metadata.gz: 9dd35382e2131fbd28394514ad75654306db5c1b82ab25020582e66cc68c70aa
+  data.tar.gz: 50a792351ef0bd99c769cd4375234a0ca308d2c3c0f137faeca3ee1ddc090471
 SHA512:
-  metadata.gz: 5d616968d8a324319d6a426e3ee8e318a8b9cb9784166d20a46babf530fe676e6e3b399d144a07bdca36bf0f63ae98ab5ba72df861311ff501c67e264d510807
-  data.tar.gz: b5a2a166c73a875aa8deec5b3375d93cafd38bd28b73b6b9a6ac8efd5d7095e93346ab44d50847e3dce981fb6ce7fed9268ac979ee112f2bb313e68b8ce48c8b
+  metadata.gz: 4c551cb26ae0f39eea73adda7585a4f886c6db379e815e8de8565e50450f76c2c84b59310c9101ad1505baf3d7d45faef584be583c0a0aba82b9187806964614
+  data.tar.gz: cdc1dc78116e7ce6b5f4ac2915ae64c9be5e3bbdc7130065ccdff4623d253c5be9462e7683c28f9b28dfb348f43d8b35fa3251048d0555d8822ecb8759c73eb1

data/README.md

@@ -2,7 +2,9 @@
 
 [![Gem Version](https://badge.fury.io/rb/ip21@2x.png)](https://badge.fury.io/rb/ip21)
 
-With this gem you will be able to connect to IP21 and execute queries against the database using SQL statements.
+With this gem you will be able to connect to IP21 and execute queries against the database using SQL statements or fetching from history or KPI table definitions.
+
+Full documentation on https://rubydoc.info/gems/ip21
 
 ## Installing
 
@@ -38,11 +40,11 @@ IP21.new(
 ## Prerequisites
 
 - IP21 Database
-- SQLPlus with REST or SOAP Web Service installed
+- SQLPlus with REST installed
 
 ## Authentication
 
-This gem uses Windows authentication to connect to SQLPlus, so don't forget to set your credentials correctly.
+This gem uses Windows authentication (NTLM) to connect to SQLPlus, so don't forget to set your credentials correctly.
 
 On domain you can use the NETBIOS name (CONTOSO) or the normal domain name (contoso.com)
 

data/ip21.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Aspentech IP21 Adapter for Ruby'
   s.description = 'Aspentech IP21 Adapter for executing queries using SQLPlus' \
                   'WebService or REST API'
-  s.version     = '0.0.7'
+  s.version     = '1.0.0'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.author      = 'Rhuan Barreto'
   s.email       = 'rhuan@rhuan.com.br'
@@ -13,9 +13,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.license     = 'MIT'
   s.add_dependency 'activesupport', '~>6.0.1'
-  s.add_dependency 'ruby-ntlm', '~>0.0'
   s.add_dependency 'rubyntlm', '~>0.6'
-  s.add_dependency 'savon', '~>2.12'
   s.files = Dir.glob('{docs,bin,lib,spec,templates,benchmarks}/**/*') +
             ['LICENSE', 'README.md', '.yardopts', __FILE__]
   s.require_path = 'lib'

data/lib/ip21.rb

@@ -25,8 +25,6 @@ class IP21
   #   to SQLPlus
   # @param [String] ip21_address The hostname or IP address for connecting to
   #   the IP21 Database
-  # @param [Boolean] soap Set this parameter to true for connecting to SQLPlus
-  #   using the SOAP Web Service
   # @param [Boolean] debug Set this parameter to true for enabling debug
   #   information
   def initialize(
@@ -37,7 +35,6 @@ class IP21
     },
     sqlplus_address: '127.0.0.1',
     ip21_address: '127.0.0.1',
-    soap: false,
     debug: false
   )
     @account = auth[:account]
@@ -45,7 +42,6 @@ class IP21
     @password = auth[:password]
     @sqlplus_address = sqlplus_address
     @ip21_address = ip21_address
-    @soap = soap
     @debug = debug
   end
 
@@ -55,40 +51,77 @@ class IP21
   # @param [Integer] limit The maximum number of rows that the query will output
   #
   # @return [Hash] Response from the query
-  def query(sql, limit = 100, type = 'SQL')
-    @soap ? soap(sql) : rest(sql, limit, type)
+  def query(sql, limit = 100)
+    parse_rest(
+      rest_request('SQL', sql_query_body(sql, limit))
+    )
   end
 
-  private
-
-  def soap(sql)
-    require 'savon'
-    client = Savon.client(
-      wsdl: soap_address,
-      ntlm: [@account, @password, @domain],
-      env_namespace: :soap,
-      namespace_identifier: nil
+  # Fetch data from IP21 History
+  #
+  # @param [String] tag The tag to be queried
+  # @param [Integer] start_time The unix timestamp in miliseconds for the start
+  #   of the query period
+  # @param [Integer] end_time The unix timestamp in miliseconds for the end of
+  #   the query period
+  # @param [Hash] opts Optional extra values
+  # @option opts [Integer] limit The maximum number of items to be retrieved
+  # @option opts [Integer] outsiders The maximum number of items to be retrieved
+  # @option opts [Integer] history_format The value format during retrieval.
+  #   Possible values are:
+  #   - 0: Raw
+  #   - 1: Record as String
+  # @option opts [Integer] retrieval_type The retrieval type of the query.
+  #   Possible values are:
+  #   0 - Actual
+  #   1 - Interpolated
+  #   2 - Best Fit
+  #   3 - Manual
+  #   10 - Not Good
+  #   11 - Good
+  #   12 - Average
+  #   13 - Maximum
+  #   14 - Minimum
+  #   15 - Range
+  #   16 - Sum
+  #   17 - Standard Deviation
+  #   18 - Variance
+  #   19 - Good Only
+  #   20 - Suspect Only
+  #   21 - First
+  #   22 - Last
+  # @option opts [Integer] outsiders Whether or not to include outsiders
+  #   0 - False
+  #   1 - True
+  #
+  # @return [Hash] Response from IP21
+  def history(tag, start_time, end_time, opts = {
+    limit: 1000, outsiders: 1, history_format: 0, retrieval_type: 0
+  })
+    parse_rest(
+      rest_request(
+        'History',
+        history_query_body(tag, start_time, end_time, opts)
+      )
     )
-    client.call(:execute_sql, message: { command: sql }).body
   end
 
-  def rest(sql, limit, type)
-    response = rest_request(
-      rest_address(type), query_body(sql, limit, type)
-    )
-    parse_rest(response)
+  def kpi(tag)
+    parse_rest(rest_request('KPI', kpi_query_body(tag)))
   end
 
-  def rest_request(url, body)
+  private
+
+  def rest_request(type, body)
     require 'net/http'
     require 'ntlm/http'
-    uri = URI(url)
+    uri = URI(rest_address(type))
     http = Net::HTTP.new(uri.host)
     request = Net::HTTP::Post.new(uri)
     request.body = body
     request.ntlm_auth(@account, @domain, @password)
     response = http.request(request)
-    debug_info(url, request.body, response) if @debug
+    debug_info(uri, request.body, response) if @debug
     response
   end
 
@@ -110,25 +143,32 @@ class IP21
     end
   end
 
-  def soap_address
-    "http://#{@sqlplus_address}/SQLplusWebService/SQLplusWebService.asmx?WSDL"
-  end
-
   def rest_address(type)
     "http://#{@sqlplus_address}/ProcessData/AtProcessDataREST.dll/#{type}"
   end
 
-  def query_body(sql, limit, type)
-    case type
-    when 'SQL'
-      "<SQL c=\"DRIVER={AspenTech SQLplus};HOST=#{@ip21_address};Port=10014;" \
-      "CHARINT=N;CHARFLOAT=N;CHARTIME=N;CONVERTERRORS=N;\" m=\"#{limit}\" " \
-      "to=\"30\" s=\"#{select?(sql) ? 1 : 0}\"><![CDATA[#{sql}]]></SQL>"
-    when 'KPI'
-      require 'active_support'
-      require 'active_support/core_ext/object/to_query'
-      sql.to_query
-    end
+  def sql_query_body(sql, limit = 1000)
+    "<SQL c=\"DRIVER={AspenTech SQLplus};HOST=#{@ip21_address};Port=10014;" \
+    "CHARINT=N;CHARFLOAT=N;CHARTIME=N;CONVERTERRORS=N;\" m=\"#{limit}\" " \
+    "to=\"30\" s=\"#{select?(sql) ? 1 : 0}\"><![CDATA[#{sql}]]></SQL>"
+  end
+
+  def kpi_query_body(tag)
+    require 'active_support'
+    require 'active_support/core_ext/object/to_query'
+    {
+      dataSource: @ip21_address,
+      tag: tag,
+      allQuotes: 1
+    }.to_query
+  end
+
+  def history_query_body(tag, start_time, end_time, opts)
+    '<Q f="D" allQuotes="1"><Tag>' + "<N><![CDATA[#{tag}]]></N>" \
+      "<D><![CDATA[#{@ip21_address}]]></D>" + "<HF>#{opts[:history_format]}</HF>" \
+      "<St>#{start_time}</St>" + "<Et>#{end_time}</Et>" \
+      "<RT>#{opts[:retrieval_type]}</RT>" + "<X>#{opts[:limit]}</X>" \
+      "<O>#{opts[:outsiders]}</O>" + '</Tag></Q>'
   end
 
   def select?(query)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip21
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Rhuan Barreto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 6.0.1
-- !ruby/object:Gem::Dependency
-  name: ruby-ntlm
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rubyntlm
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: savon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.12'
 description: Aspentech IP21 Adapter for executing queries using SQLPlusWebService
   or REST API
 email: rhuan@rhuan.com.br