wmls 0.1.1

data/LICENSE

@@ -0,0 +1,2 @@
+Copyright 2010 Wellstorm Development. 
+Dual licensed under the Ruby License, or the GPLv2 or later.

data/README

@@ -0,0 +1,25 @@
+wmls.rb -- WITSML command line tool in Ruby.
+
+Use this script to call GetFromStore, AddToStore, UpdateInStore, or DeleteFromStore on 
+a WITSML server.
+
+Usage: wmls.rb [options]
+    -v, --verbose                    Run verbosely
+    -r, --url url                    URL of the WITSML service
+    -u, --username USER              HTTP user name
+    -p, --password PASS              HTTP password
+    -q, --query QUERYFILE            Path to file containing query, delete, add or update template
+    -a get|add|update|delete         WITSML action; default is 'get'
+        --action
+    -h, --help                       Show this message
+
+Example:
+ruby wmls.rb -q query_v1311/get_all_wells.xml -r https://witsml.wellstorm.com/witsml/services/store -u username -p mypassword -a get
+
+I've included a bunch of sample query templates originally created by Gary Masters of Energistics. 
+
+License: Apache 2.0
+
+History:
+
+10 Mar 2011 -- initial commit. 

data/lib/wmls.rb

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby -w
+# Copyright 2011 Wellstorm Development LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'stringio'
+require 'rexml/document'
+
+class Wmls
+
+  attr_accessor :timeout
+
+  def initialize (url, user_name, password)
+    @url = url
+    @user_name = user_name
+    @password = password
+
+    @optionsIn = ''
+    @capabilitiesIn = ''
+    @timeout = 60
+
+    @envelope_begin = <<END
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:ns0="http://www.witsml.org/message/120">
+    <SOAP-ENV:Header/>
+    <SOAP-ENV:Body>
+END
+
+    @envelope_end = <<END
+    </SOAP-ENV:Body>
+</SOAP-ENV:Envelope>
+END
+  end
+
+
+
+  # Replace special xml chartacters '&' and '<'
+  def escape_xml(xml_in) 
+    return xml_in.gsub(/&/,'&amp;').gsub(/</,'&lt;')
+  end
+
+  def pretty_xml(xml_data)
+    s = ''
+    doc = REXML::Document.new(xml_data)
+    doc.write(s, 2)
+    return s
+  end
+
+  # parse the xml and return the singular of the root element name.
+  def extract_type(xml_data)
+    doc = REXML::Document.new(xml_data)
+    plural = doc.root.name
+    return plural[0..plural.length-2]
+  end
+
+  #extract the witsml response: status_code and xml_out
+  def extract_response(xml_data)
+    doc = REXML::Document.new(xml_data)
+    r = 0
+    x = ''
+    s = ''
+    doc.root.each_element('//Result') { |elt| r = elt.text}  
+    doc.root.each_element('//XMLout') { |elt| x = pretty_xml(elt.text)}  
+    doc.root.each_element('//SuppMsgOut') { |elt| s = elt.text }  
+    return [r.to_i,s,x];
+  end
+
+
+  def post(io, url, user, pass, soap_action)    
+    url = URI.parse(url)  if url.is_a? String
+    io = StringIO.new(io) if io.is_a? String
+
+    req = Net::HTTP::Post.new(url.path)
+    req.basic_auth user, pass if user && user.length > 0
+    req.body_stream = io
+    req.add_field('SOAPAction', soap_action)
+    req.content_type = 'application/soap+xml'
+    #req.content_length = io.stat.size
+    req.content_length = io.size   # specific to StringIO class ? why no stat on that class?
+    http = Net::HTTP.new(url.host, url.port)  
+    http.use_ssl = true
+    http.read_timeout = @timeout # secs
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    res = http.start {|http2| http2.request(req) }
+
+    case res
+    when Net::HTTPSuccess, Net::HTTPRedirection
+      # OK
+      res
+    else
+      res.error!
+    end
+  end
+
+
+  def send(envelope_middle, soap_action)
+    envelope = @envelope_begin + envelope_middle + @envelope_end
+    response = post(envelope, @url, @user_name, @password, soap_action)
+    status, supp_msg, witsml = extract_response(response.body)
+  end
+
+  def add_to_store(template)
+    wmlTypeIn = extract_type(template)
+    queryIn = escape_xml(template)
+    soap_action = 'http://www.witsml.org/action/120/Store.WMLS_AddToStore'
+    envelope_middle = <<END
+        <ns0:WMLS_AddToStore SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+            <WMLtypeIn>#{wmlTypeIn}</WMLtypeIn>
+            <XMLin>#{queryIn}</XMLin>
+            <OptionsIn>#{@optionsIn}</OptionsIn>
+            <CapabilitiesIn>#{@capabilitiesIn}</CapabilitiesIn>
+        </ns0:WMLS_AddToStore>
+END
+    return send envelope_middle, soap_action
+  end
+
+  def delete_from_store(template)
+    wmlTypeIn = extract_type(template)
+    queryIn = escape_xml(template)
+    soap_action = 'http://www.witsml.org/action/120/Store.WMLS_DeleteFromStore'
+    envelope_middle = <<END
+        <ns0:WMLS_DeleteFromStore SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+            <WMLtypeIn>#{wmlTypeIn}</WMLtypeIn>
+            <QueryIn>#{queryIn}</QueryIn>
+            <OptionsIn>#{@optionsIn}</OptionsIn>
+            <CapabilitiesIn>#{@capabilitiesIn}</CapabilitiesIn>
+        </ns0:WMLS_DeleteFromStore>
+END
+    return send envelope_middle, soap_action
+  end
+  def update_in_store(template)
+    wmlTypeIn = extract_type(template)
+    queryIn = escape_xml(template)
+    soap_action = 'http://www.witsml.org/action/120/Store.WMLS_UpdateInStore'
+    envelope_middle = <<END
+        <ns0:WMLS_UpdateInStore SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+            <WMLtypeIn>#{wmlTypeIn}</WMLtypeIn>
+            <XMLin>#{queryIn}</XMLin>
+            <OptionsIn>#{@optionsIn}</OptionsIn>
+            <CapabilitiesIn>#{@capabilitiesIn}</CapabilitiesIn>
+        </ns0:WMLS_UpdateInStore>
+END
+    return send envelope_middle, soap_action
+  end
+  
+  def get_from_store(template)
+    wmlTypeIn = extract_type(template)
+    queryIn = escape_xml(template)
+    soap_action = 'http://www.witsml.org/action/120/Store.WMLS_GetFromStore'
+    envelope_middle = <<END
+        <ns0:WMLS_GetFromStore SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+            <WMLtypeIn>#{wmlTypeIn}</WMLtypeIn>
+            <QueryIn>#{queryIn}</QueryIn>
+            <OptionsIn>#{@optionsIn}</OptionsIn>
+            <CapabilitiesIn>#{@capabilitiesIn}</CapabilitiesIn>
+        </ns0:WMLS_GetFromStore>
+END
+    return send envelope_middle, soap_action
+  end
+
+
+end

data/main.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby -w
+# Copyright 2011 Wellstorm Development LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rubygems'
+require 'optparse'
+require 'wmls'
+options = {}
+
+opts =OptionParser.new do |o|
+  o.banner = "Usage: wmls.rb [options]"
+#  o.on("-v", "--verbose", "Run verbosely") do |v|
+#    options[:verbose] = v
+#  end
+  o.on("-r", "--url url", "URL of the WITSML service") do |v|
+    options[:url] = v
+  end
+  o.on("-u", "--username USER", "HTTP user name (optional)") do |v|
+    options[:user_name] = v
+  end
+  o.on("-p", "--password PASS", "HTTP password (optional)") do |v|
+    options[:password] = v
+  end
+  o.on("-q", "--query QUERYFILE", "Path to file containing query, delete, add or update template. (optional, default stdin)") do |v|
+    options[:query] = v
+  end
+  o.on("-a", "--action ACTION", [:add,:get,:update,:delete], "WITSML action: add, get, update, or delete (optional, default 'get')") do |v|
+    options[:action] = v || :get
+  end
+  o.on_tail("-h", "--help", "Show this message") do
+    puts o
+    exit
+  end
+end
+
+
+# Load the named file and return its contents as a string
+def get_file_as_string(filename)
+  data = ''
+  if(filename)
+    f = File.open(filename, "r")
+  else
+    f = $stdin
+  end
+
+  f.each_line do |line|
+    data += line
+  end
+  return data
+end
+
+
+opts.parse!
+if ( !options[:url] )
+  puts(opts.help)
+  exit 1
+end
+
+
+template= get_file_as_string(options[:query] )
+
+wmls = Wmls.new options[:url], options[:user_name], options[:password]
+
+case options[:action]
+  when :add
+  result = wmls.add_to_store(template)
+  when :delete
+  result = wmls.delete_from_store(template)
+  when :update
+  result = wmls.update_in_store(template)
+  when :get,nil
+  result = wmls.get_from_store(template)
+  else
+  raise "unsupported action #{options[:action]}"
+end
+
+
+status, supp_msg, witsml = result
+if (status != 1)
+  $stderr.puts "Error #{status}: #{supp_msg}"
+else
+  $stdout.puts witsml
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: wmls
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Hugh Winkler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-29 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Wmls calls GetFromStore, AddToStore, UpdateInStore, or DeleteFromStore on a WITSML server.
+email: hugh.winkler@wellstorm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- main.rb
+- lib/wmls.rb
+has_rdoc: true
+homepage: https://github.com/wellstorm/wmls.rb/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Calls GetFromStore, AddToStore, UpdateInStore, or DeleteFromStore on a WITSML server.
+test_files: []
+