ip21 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dd35382e2131fbd28394514ad75654306db5c1b82ab25020582e66cc68c70aa
-  data.tar.gz: 50a792351ef0bd99c769cd4375234a0ca308d2c3c0f137faeca3ee1ddc090471
+  metadata.gz: f638df374799c3d306c2dc305384e7c796b64a31c75e5a9e8320e73eb27db0d7
+  data.tar.gz: 2c73764f135c65782921cee24dcf03cd5a778431b0c8313e7bcfa264376006eb
 SHA512:
-  metadata.gz: 4c551cb26ae0f39eea73adda7585a4f886c6db379e815e8de8565e50450f76c2c84b59310c9101ad1505baf3d7d45faef584be583c0a0aba82b9187806964614
-  data.tar.gz: cdc1dc78116e7ce6b5f4ac2915ae64c9be5e3bbdc7130065ccdff4623d253c5be9462e7683c28f9b28dfb348f43d8b35fa3251048d0555d8822ecb8759c73eb1
+  metadata.gz: 6c845f6d07f705b6dfa5e6dad7ab86cfcb6aedfe903af71a7e07b55b05c81b7b5bd7adf14b42827b26dd967267b53f9d1b6a3501390842d6e33f82a0e486df69
+  data.tar.gz: 83ea282fef5124401e7b2ab4eccfd8d052de345e559ff2b5012e9fd06e5638a673c8d928b2d4b16fac8bd23f5b771de4924fe55ed570a6a8b1bba2202871ac3c

data/ip21.gemspec

@@ -4,8 +4,8 @@ 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.0.1'
   s.date        = Time.now.strftime('%Y-%m-%d')
   s.author      = 'Rhuan Barreto'
   s.email       = 'rhuan@rhuan.com.br'

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,6 +113,10 @@ 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'
@@ -125,12 +130,22 @@ class IP21
     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'
       require 'json'
@@ -143,6 +158,11 @@ class IP21
     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
@@ -164,7 +184,11 @@ class IP21
   end
 
   def history_query_body(tag, start_time, end_time, opts)
-    '<Q f="D" allQuotes="1"><Tag>' + "<N><![CDATA[#{tag}]]></N>" \
+    opts[:limit] ||= 1000
+    opts[:outsiders] ||= 0
+    opts[:history_format] ||= 0
+    opts[:retrieval_type] ||= 0
+    '<Q appId="20" 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>" \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip21
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rhuan Barreto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-10 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,8 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: Aspentech IP21 Adapter for executing queries using SQLPlusWebService
-  or REST API
+description: Aspentech IP21 Adapter for executing queries using SQLPlus REST API
 email: rhuan@rhuan.com.br
 executables: []
 extensions: []