ip21 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd35382e2131fbd28394514ad75654306db5c1b82ab25020582e66cc68c70aa
-  data.tar.gz: 50a792351ef0bd99c769cd4375234a0ca308d2c3c0f137faeca3ee1ddc090471
+  metadata.gz: 3f2db67d22993c9740ac8eca2abc8296ec6f36cd149b8905fc40d319b66d870c
+  data.tar.gz: 6151fcb02cabf463af378e1e52361ec13447e46318eeb890d697b9ce65e04b8b
 SHA512:
-  metadata.gz: 4c551cb26ae0f39eea73adda7585a4f886c6db379e815e8de8565e50450f76c2c84b59310c9101ad1505baf3d7d45faef584be583c0a0aba82b9187806964614
-  data.tar.gz: cdc1dc78116e7ce6b5f4ac2915ae64c9be5e3bbdc7130065ccdff4623d253c5be9462e7683c28f9b28dfb348f43d8b35fa3251048d0555d8822ecb8759c73eb1
+  metadata.gz: cb98cc8f0a206c3df5c07b137033db87c8aa54245d074a18e6bf3185f9a21a4691e6c581e8f452198905796c603a5175a57ade0546b2d67292fa6c95730a0e5d
+  data.tar.gz: 97da1c4e0f49802501936c8d5a93351a9f3430d0c040cb06f099ef863bfaf09df85dc50a97639b9d76d08b256815f93240ad98b1a9d795733ac9ea235ab0e49a

data/ip21.gemspec

@@ -4,16 +4,17 @@ Gem::Specification.new do |s|
   s.name = 'ip21'
   s.summary     = 'Aspentech IP21 Adapter for Ruby'
   s.description = 'Aspentech IP21 Adapter for executing queries using SQLPlus' \
-                  'WebService or REST API'
-  s.version     = '1.0.0'
+                  ' REST API'
+  s.version     = '1.2.0'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.author      = 'Rhuan Barreto'
   s.email       = 'rhuan@rhuan.com.br'
   s.homepage    = 'http://rubygems.org/gems/ip21'
   s.platform    = Gem::Platform::RUBY
   s.license     = 'MIT'
-  s.add_dependency 'activesupport', '~>6.0.1'
-  s.add_dependency 'rubyntlm', '~>0.6'
+  s.add_dependency 'activesupport', '~> 6.1.0'
+  s.add_dependency 'ruby-ntlm', '~>0.0.4'
+  s.add_dependency 'httpi', '~>2.4'
   s.files = Dir.glob('{docs,bin,lib,spec,templates,benchmarks}/**/*') +
             ['LICENSE', 'README.md', '.yardopts', __FILE__]
   s.require_path = 'lib'

data/lib/ip21.rb

@@ -45,7 +45,7 @@ class IP21
     @debug = debug
   end
 
-  # Executes a direct query againt the database
+  # Executes a direct query against the database
   #
   # @param [String] sql The query to be executed
   # @param [Integer] limit The maximum number of rows that the query will output
@@ -73,30 +73,31 @@ class IP21
   #   - 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
+  #   - 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 the closest
+  #   values outside the date/time range
+  #   - 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
+    limit: 1000, outsiders: 0, history_format: 0, retrieval_type: 0
   })
     parse_rest(
       rest_request(
@@ -112,37 +113,54 @@ class IP21
 
   private
 
+  # Execute the request
+  #
+  # @param [String] type The request type to be passed to rest_address function
+  # @param [String] body The request body
   def rest_request(type, body)
-    require 'net/http'
-    require 'ntlm/http'
-    uri = URI(rest_address(type))
-    http = Net::HTTP.new(uri.host)
-    request = Net::HTTP::Post.new(uri)
+    require 'httpi'
+    HTTPI.log = @debug
+    request = HTTPI::Request.new(rest_address(type))
     request.body = body
-    request.ntlm_auth(@account, @domain, @password)
-    response = http.request(request)
-    debug_info(uri, request.body, response) if @debug
+    request.auth.ntlm(@account, @password, @domain)
+    response = HTTPI.post(request)
+    debug_info(request.url, request.body, response) if @debug
     response
   end
 
+  # Generates request debug info
+  #
+  # @param [String] address The request address
+  # @param [String] body The request body
+  # @param [String] response The request response
   def debug_info(address, body, response)
     puts "Request: #{address}"
     puts "Body: #{body}"
     puts "Response: #{response.body}"
   end
 
+  # Parse the API response displaying errors if needed
+  #
+  # @param [Object] response The request response
+  #
+  # @return [Hash] Response or error from the API
   def parse_rest(response)
-    if response.code == '200'
+    if response.code == 200
       require 'json'
       JSON.parse(response.body)
     else
       {
         status: response.code,
-        message: "Error on IP21: #{response.message}"
+        message: "Error on IP21: #{response.body}"
       }
     end
   end
 
+  # Generate the URL for accessing IP21 based on type
+  #
+  # @param [String] type The type of the request.
+  #
+  # @return [String] Address to access request
   def rest_address(type)
     "http://#{@sqlplus_address}/ProcessData/AtProcessDataREST.dll/#{type}"
   end
@@ -163,12 +181,30 @@ class IP21
     }.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>'
+  def history_query_body(tags, start_time, end_time, opts)
+    opts[:limit] ||= 1000
+    opts[:outsiders] ||= 0
+    opts[:history_format] ||= 0
+    opts[:retrieval_type] ||= 0
+    body = if tags.is_a?(String)
+             tag_request(tags, start_time, end_time, opts)
+           else
+             tags.map { |tag| tag_request(tag, start_time, end_time, opts) }.join
+           end
+    '<Q appId="20" f="D" allQuotes="1">' + body + '</Q>'
+  end
+
+  def tag_request(tag, start_time, end_time, opts)
+    '<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>'
   end
 
   def select?(query)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip21
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rhuan Barreto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,30 +16,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.1
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.1
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
-  name: rubyntlm
+  name: ruby-ntlm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-description: Aspentech IP21 Adapter for executing queries using SQLPlusWebService
-  or REST API
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Aspentech IP21 Adapter for executing queries using SQLPlus REST API
 email: rhuan@rhuan.com.br
 executables: []
 extensions: []