rsmart_toolbox 0.10 → 0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13ec30f97bddd32bc604c1395a371e5a8dd9c4bc
-  data.tar.gz: bab3bab4ef63ebf15a26c2bd4a5d98966313c529
+  metadata.gz: 7ab463e0fe4efdc8c8264b52d9eb1de6b6f2c9cf
+  data.tar.gz: 441a7cc41c768e9f0cb906b9b4b14805e8f953e1
 SHA512:
-  metadata.gz: f6cb52bfe81dcb9663609702eace294df5cef7b073214734398444fc2d3eb91b767b9477a712eed1f75f7cc67b8afdcc3f10770e34c2d5e6355479277bd30bd1
-  data.tar.gz: da9dd51a65a9df329aca5c97efd9636c4713a2a9a218bdf2b2cdac3b0900e2c7d6355a5119ad851886c94af353fd590ed14ad4aab4d18b7f90b6e85f294c09a1
+  metadata.gz: 289a7548aabe2f24752affb7f3d36e2b2e46b305a38e76a7ca4c94a8a82e2753bec731a03845d6d9281a2221393709c9fa95db6792522eaef160d7dce23e5f0f
+  data.tar.gz: 956180913c4683d73c68caf9bd8f72015936f8bac666f290ed24201c01fb87e56a8064ad7e04633221829fb9cb24991e145d9c5172a24e1ba6485066211aac53

data/README.md

@@ -40,6 +40,13 @@ Usage: transform_CSV_to_HR_XML [options] csv_file
     -h, --help                       Display this screen
 ```
 
+### validate_HR_XML
+
+```
+Usage: validate_HR_XML xml_file
+    -h, --help                       Display this screen
+```
+
 ## Contributing
 
 1. Fork it: https://github.com/rSmart/rsmart_toolbox/fork

data/bin/transform_CSV_to_HR_XML

@@ -5,11 +5,8 @@ require 'bundler/setup'
 
 require 'builder'
 require 'csv'
-require 'net/http'
-require 'nokogiri'
 require 'optparse'
 require 'rest_client'
-require 'tempfile'
 require 'time'
 require 'rsmart_toolbox/etl/grm'
 
@@ -302,33 +299,10 @@ CSV.open(opt[:csv_filename], opt[:csv_options]) do |csv|
     end # hrmanifest
   end # xml_file
 end # csv
+
 puts "\nXML file written to #{opt[:xml_filename]}\n\n"
 
-# validate the resulting XML file against the official XSD schema
-uri = URI 'https://raw.githubusercontent.com/rSmart/ce-tech-docs/master/hrmanifest.xsd'
-Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-  Tempfile.open "hrmanifest.xsd" do |file|
-    request = Net::HTTP::Get.new uri
-    http.request request do |response|
-      response.read_body do |segment|
-        file.write(segment)
-      end
-    end
-    file.rewind
-    xsd = Nokogiri::XML::Schema file
-    doc = Nokogiri::XML File.read opt[:xml_filename]
-    xml_errors = xsd.validate doc
-    if xml_errors.empty?
-      puts "Congratulations! The XML file passes XSD schema validation! w00t!\n\n"
-    else
-      puts "Sorry, the XML file does NOT pass XSD schema validation!:"
-      xml_errors.each do |error|
-        puts error.message
-      end
-      exit 1
-    end
-  end # file
-end
+exit 1 unless GRM.validate_hr_xml opt[:xml_filename]
 
 # POST the XML file to the server if opt[:url]
 if opt[:url]

data/bin/validate_HR_XML

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'optparse'
+require 'rsmart_toolbox/etl/grm'
+
+GRM = Rsmart::ETL::GRM
+
+def self.parse_command_line_options( executable, args, opt={} )
+  optparse = OptionParser.new do |opts|
+    opts.banner = "Usage: #{executable} xml_file"
+    opts.on( '-h', '--help', 'Display this screen' ) do
+      puts opts
+      exit 1
+    end
+
+    opt[:xml_filename] = args[0] unless opt[:xml_filename]
+    if opt[:xml_filename].nil? || opt[:xml_filename].empty?
+      puts opts
+      exit 1
+    end
+  end
+  optparse.parse!
+
+  return opt
+end
+
+opt = parse_command_line_options (File.basename $0), ARGF.argv
+
+exit 1 unless GRM.validate_hr_xml opt[:xml_filename]

data/lib/rsmart_toolbox/etl/grm.rb

@@ -14,6 +14,9 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+require 'net/http'
+require 'nokogiri'
+require 'tempfile'
 require "rsmart_toolbox/etl"
 
 # rSmart Grant and Research Management methods.
@@ -354,4 +357,38 @@ module Rsmart::ETL::GRM
     Rsmart::ETL::mutate_sql_stmt! insert_str, opt[:name], values_str, actv_ind
   end
 
+  # Performs an XML XSD schema validation using the published schema.
+  # @note Any schema validation errors are output to STDOUT via puts.
+  # @param xml_filename [String] A path to the XML file to be validated.
+  # @return [Boolean] true if no validation errors are found; otherwise false.
+  def self.validate_hr_xml(xml_filename)
+    ret_val = false
+    # validate the resulting XML file against the official XSD schema
+    uri = URI 'https://raw.githubusercontent.com/rSmart/ce-tech-docs/master/hrmanifest.xsd'
+    Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+      Tempfile.open "hrmanifest.xsd" do |schema|
+        request = Net::HTTP::Get.new uri
+        http.request request do |response|
+          response.read_body do |segment|
+            schema.write(segment)
+          end
+        end
+        schema.rewind
+        xsd = Nokogiri::XML::Schema schema
+        doc = Nokogiri::XML File.read xml_filename
+        xml_errors = xsd.validate doc
+        if xml_errors.empty?
+          puts "Congratulations! The XML file passes XSD schema validation! w00t!\n\n"
+          ret_val = true
+        else
+          puts "Sorry, the XML file does NOT pass XSD schema validation!:"
+          xml_errors.each do |error|
+            puts error.message
+          end
+        end
+      end # schema
+    end
+    return ret_val
+  end
+
 end

data/lib/rsmart_toolbox/version.rb

@@ -16,5 +16,5 @@
 
 module Rsmart
   # The gem version number.
-  VERSION = "0.10"
+  VERSION = "0.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmart_toolbox
 version: !ruby/object:Gem::Version
-  version: '0.10'
+  version: '0.11'
 platform: ruby
 authors:
 - Lance Speelmon
@@ -30,7 +30,7 @@ cert_chain:
   sKRWzEtHFamxQaIspOja5O4oQKiCbWa90fEuIoCtwyy1rQtL9VKoDTs4vZASXNuc
   F/lEyekXSjN36uTtlt4LkKLn/k7k5gRbt4+C9Q==
   -----END CERTIFICATE-----
-date: 2014-09-10 00:00:00.000000000 Z
+date: 2014-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -135,6 +135,7 @@ email:
 - lspeelmon@rsmart.com
 executables:
 - transform_CSV_to_HR_XML
+- validate_HR_XML
 extensions: []
 extra_rdoc_files: []
 files:
@@ -145,6 +146,7 @@ files:
 - README.md
 - Rakefile
 - bin/transform_CSV_to_HR_XML
+- bin/validate_HR_XML
 - lib/rsmart_toolbox.rb
 - lib/rsmart_toolbox/etl.rb
 - lib/rsmart_toolbox/etl/grm.rb