ip21 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8d4ac24d383e2c349ece94689263d7a9b805cb523a287a3a08f627e9e77067d
-  data.tar.gz: a3d8fd3621a0367f53ea32966174248d51cd07c4abe35b623f093cd633d76c20
+  metadata.gz: b56f02bb8919d8869c39d3b98248fbd2befad1160c76195fe1280da011af15b9
+  data.tar.gz: cac1e5bf0dabe81118c1245a93f70d503cec9eb1a631e497ee6d6a01c853b108
 SHA512:
-  metadata.gz: 6981aa92d3635aa716f19644660d5e1ea676e6cb21e389116a07a09d5f48d785b68a9b60b1b7b5d61d79f9b5d74bd6539f05cd1dac121c6ec456aa2fbcf498c9
-  data.tar.gz: 2ffcc26a10fa07aaca18a619244ccec717f6e3501e7fbcd8826847dd67edc74fdb90f90d1a724a26805d84e33289ffd40c76fc657aa39fa1ebf180a7e290c54c
+  metadata.gz: 5d616968d8a324319d6a426e3ee8e318a8b9cb9784166d20a46babf530fe676e6e3b399d144a07bdca36bf0f63ae98ab5ba72df861311ff501c67e264d510807
+  data.tar.gz: b5a2a166c73a875aa8deec5b3375d93cafd38bd28b73b6b9a6ac8efd5d7095e93346ab44d50847e3dce981fb6ce7fed9268ac979ee112f2bb313e68b8ce48c8b

data/README.md

@@ -1,5 +1,7 @@
 # Aspentech IP21 Ruby Gem
 
+[![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.
 
 ## Installing

data/ip21.gemspec

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 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     = '0.0.5'
+  s.version     = '0.0.7'
   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 'ruby-ntlm', '~>0.0'
   s.add_dependency 'rubyntlm', '~>0.6'
   s.add_dependency 'savon', '~>2.12'

data/lib/ip21.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aspentech IP21 Adapter for executing queries using SQLPlus
 #
 # This library uses Windows Authentication for connecting to SQLPlus
@@ -25,6 +27,8 @@ class IP21
   #   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(
     auth: {
       account: 'john.doe',
@@ -33,7 +37,8 @@ class IP21
     },
     sqlplus_address: '127.0.0.1',
     ip21_address: '127.0.0.1',
-    soap: false
+    soap: false,
+    debug: false
   )
     @account = auth[:account]
     @domain = auth[:domain]
@@ -41,6 +46,7 @@ class IP21
     @sqlplus_address = sqlplus_address
     @ip21_address = ip21_address
     @soap = soap
+    @debug = debug
   end
 
   # Executes a direct query againt the database
@@ -49,8 +55,8 @@ 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)
-    @soap ? soap(sql) : rest(sql, limit)
+  def query(sql, limit = 100, type = 'SQL')
+    @soap ? soap(sql) : rest(sql, limit, type)
   end
 
   private
@@ -66,16 +72,30 @@ class IP21
     client.call(:execute_sql, message: { command: sql }).body
   end
 
-  def rest(sql, limit)
+  def rest(sql, limit, type)
+    response = rest_request(
+      rest_address(type), query_body(sql, limit, type)
+    )
+    parse_rest(response)
+  end
+
+  def rest_request(url, body)
     require 'net/http'
     require 'ntlm/http'
-    uri = URI(rest_address)
+    uri = URI(url)
     http = Net::HTTP.new(uri.host)
     request = Net::HTTP::Post.new(uri)
-    request.body = query_body(sql, limit)
+    request.body = body
     request.ntlm_auth(@account, @domain, @password)
     response = http.request(request)
-    parse_rest(response)
+    debug_info(url, request.body, response) if @debug
+    response
+  end
+
+  def debug_info(address, body, response)
+    puts "Request: #{address}"
+    puts "Body: #{body}"
+    puts "Response: #{response.body}"
   end
 
   def parse_rest(response)
@@ -94,14 +114,24 @@ class IP21
     "http://#{@sqlplus_address}/SQLplusWebService/SQLplusWebService.asmx?WSDL"
   end
 
-  def rest_address
-    "http://#{@sqlplus_address}/ProcessData/AtProcessDataREST.dll/SQL"
+  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
   end
 
-  def query_body(sql, limit)
-    "<SQL c=\"DRIVER={AspenTech SQLplus};HOST=#{@ip21_address};" \
-    'PORT=10014;CHARISNULL=Y;CHARINT=N;CHARFLOAT=N;CHARTIME=N;' \
-    "CONVERTERRORS=N;ROWID=Y;TIMEOUT=10\" m=\"#{limit}\">" \
-    "<![CDATA[#{sql}]]></SQL>"
+  def select?(query)
+    /^select/i.match?(query)
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ip21
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Rhuan Barreto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
 - !ruby/object:Gem::Dependency
   name: ruby-ntlm
   requirement: !ruby/object:Gem::Requirement