ip21 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f2ff27e5846b94cea2044e6dae841e67fdbcc8f71b60b98b3a83414bd36a5a7
+  data.tar.gz: 5ccba3e19ebe69ef3a1e8a336f1ea24105ac943c7a3bb20c05a9ea3d0cb63de8
+SHA512:
+  metadata.gz: 1ddc0aa93c48e956364ad5bd1af42b9c341f42e0f8dcd1dc6acb9aea68d22969f48c4e8f3fb2c12a0ab51f3504124cd960018498588a479b471b9196356840aa
+  data.tar.gz: a95c8b4c947ed19786cd5a3897e7f9eaddc08229239ab3a66741a43cf553ec32204fb6eeae1c5dbe73993d774f7bd9365a87c698ec90bf840a94f83971a82008

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected - README.md LICENSE

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Rhuan Barreto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Aspentech IP21 Ruby Gem
+
+With this gem you will be able to connect to IP21 and execute queries against the database using SQL statements.
+
+## Installing
+
+To install this gem, use the following command:
+
+```sh
+$ gem install ip21
+```
+
+Or add to your Gemfile:
+
+```ruby
+# Gemfile
+gem 'ip21'
+```
+
+And use the class in your code to execute queries:
+
+```ruby
+IP21.new(
+    auth: {
+    account: 'john.doe',
+    domain: 'contoso.com',
+    password: 'set_your_own_password'
+    },
+    sqlplus_address: '127.0.0.1',
+    ip21_address: '127.0.0.1',
+).query('SELECT IP_PLANT_AREA, Name, IP_DESCRIPTION FROM IP_AnalogDef')
+```
+
+## Prerequisites
+
+- IP21 Database
+- SQLPlus with REST or SOAP Web Service installed
+
+## Authentication
+
+This gem uses Windows authentication 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)
+
+# Changelog
+See the [commit page](https://github.com/rhuanbarreto/ip21-ruby/commits) for a list of changes.
+
+# License
+IP21 Gem by Rhuan Barreto. IP21 Gem is licensed under the MIT license. Please see the LICENSE file for more information.

data/ip21.gemspec

@@ -0,0 +1,19 @@
+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.1'
+  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 'ruby-ntlm'
+  s.add_dependency 'rubyntlm'
+  s.add_dependency 'savon'
+  s.files = Dir.glob('{docs,bin,lib,spec,templates,benchmarks}/**/*') +
+            ['LICENSE', 'README.md', '.yardopts', __FILE__]
+  s.require_path = 'lib'
+end

data/lib/ip21.rb

@@ -0,0 +1,92 @@
+# Aspentech IP21 Adapter for executing queries using SQLPlus
+#
+# This library uses Windows Authentication for connecting to SQLPlus
+#
+# @author Rhuan Barreto
+#
+# @example
+#   IP21.new(
+#     auth: {
+#       account: 'john.doe',
+#       domain: 'contoso.com',
+#       password: 'set_your_own_password'
+#     },
+#     sqlplus_address: '127.0.0.1',
+#     ip21_address: '127.0.0.1',
+#   ).query('SELECT IP_PLANT_AREA, Name, IP_DESCRIPTION FROM IP_AnalogDef')
+class IP21
+  # Initializes the connection
+  #
+  # @param [Hash] auth The Windows account, domain and password for connecting
+  #   to SQLPLus
+  # @param [String] sqlplus_address The hostname or IP address for connecting
+  #   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
+  def initialize(
+    auth: {
+      account: 'john.doe',
+      domain: 'contoso.com',
+      password: 'set_your_own_password'
+    },
+    sqlplus_address: '127.0.0.1',
+    ip21_address: '127.0.0.1',
+    soap: false
+  )
+    @account = auth[:account]
+    @domain = auth[:domain]
+    @password = auth[:password]
+    @sqlplus_address = sqlplus_address
+    @ip21_address = ip21_address
+    @soap = soap
+  end
+
+  # Executes a direct query againt the database
+  #
+  # @param [String] sql The query to be executed
+  # @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)
+  end
+
+  private
+
+  def soap(sql)
+    require 'savon'
+    client = Savon.client(
+      wsdl: soap_address,
+      ntlm: [@account, @password, @domain],
+      env_namespace: :soap,
+      namespace_identifier: nil
+    )
+    client.call(:execute_sql, message: { command: sql }).body
+  end
+
+  def rest(sql, limit)
+    require 'net/http'
+    require 'ntlm/http'
+    uri = URI(rest_address(sql, limit))
+    http = Net::HTTP.new(uri.host)
+    request = Net::HTTP::Get.new(uri)
+    request.ntlm_auth(@account, @domain, @password)
+    response = http.request(request)
+    response.body
+  end
+
+  def soap_address
+    "http://#{@sqlplus_address}/SQLplusWebService/SQLplusWebService.asmx?WSDL"
+  end
+
+  def rest_address(sql, limit)
+    query = '/ProcessData/AtProcessDataREST.dll/SQL?<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>"
+    "http://#{@sqlplus_address}#{query}"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: ip21
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rhuan Barreto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-ntlm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyntlm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Aspentech IP21 Adapter for executing queries using SQLPlusWebService
+  or REST API
+email: rhuan@rhuan.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- ip21.gemspec
+- lib/ip21.rb
+homepage: http://rubygems.org/gems/ip21
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Aspentech IP21 Adapter for Ruby
+test_files: []