adiwg-mdtranslator 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6737cb739485e1dd0410fac29c0047e2c3015ba
+  data.tar.gz: 81cf624e5573470534f2b88293859180f88f859d
+SHA512:
+  metadata.gz: 6b60ef40c307cd32941fc045558239795dcd6d8c7229058614a7536b4bf0163f27896f794a882aca28be5cbed9080bb959ccda4c16f136643318936ccb78d33d
+  data.tar.gz: f3b1d7faaaf5c5d39af832a49c6650aa498a518503e414720d24d9f8f199e5eb4c5c43cf090815c5ae5b46ae1e81f509fc18ab81455d4a48e7c676a4014de3c4

data/.gitignore

@@ -0,0 +1,23 @@
+/.project
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adiwg-mdtranslator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/README.md

@@ -0,0 +1,31 @@
+[![Build Status](https://travis-ci.org/adiwg/mdTranslator.svg?branch=master)](https://travis-ci.org/adiwg/mdTranslator)
+
+# Mdtranslator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mdtranslator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mdtranslator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mdtranslator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.test_files = FileList['test/tc*.rb']
+	t.verbose = true
+end
+
+desc 'Run tests'
+task :default => :test
+
+

data/adiwg-mdtranslator.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adiwg/mdtranslator/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "adiwg-mdtranslator"
+	spec.version       = ADIWG::Mdtranslator::VERSION
+	spec.authors       = ["Stan Smith", "Josh Bradley"]
+	spec.email         = ["stansmith@usgs.gov", "joshua_bradley@fws.gov"]
+	spec.summary       = %q{The mdtranslator (metadata translator) is a toolkit for translating metadata in one format to another. The toolkit is written and maintained by the Alaska Data Integration Working Group (ADIwg).}
+	spec.description   = %q{The mdtranslator was written by the Alaska Data Integration Working Group (ADIwg) to assist users prepare ISO 19115-2 metadata records.  Input to the mdtranslator is simple JSON using the adiwg-json-schema.  The mdtranslator architecture allows developers to write additional readers for other input formats and/or write additional writers for other output other than ISO 19115-2.}
+	spec.homepage      = "http://www.adiwg.org/mdTranslator"
+	spec.license       = "UNLICENSED"
+
+	spec.files         = %x(git ls-files).split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(tc|test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1"
+	spec.add_development_dependency "rake", "~>10"
+	spec.add_development_dependency "minitest", "~>5"
+
+	spec.add_runtime_dependency "json", "~>1.8"
+	spec.add_runtime_dependency "builder", "~>3.2"
+	spec.add_runtime_dependency "thor", "~>0.19"
+	spec.add_runtime_dependency "uuidtools", "~>2.1"
+	spec.add_runtime_dependency "json-schema", "~>2.2"
+	spec.add_runtime_dependency "adiwg-json_schemas", "~>0.8"
+end

data/bin/mdtranslator

@@ -0,0 +1,164 @@
+#!/usr/bin/env ruby
+# ADIwg mdTranslator - Thor CLI for mdtranslator
+
+# History:
+# 	Stan Smith 2014-07-15 original script
+#   Stan Smith 2014-09-02 changed name to mdtranslator
+#   Stan Smith 2014-09-21 coded cli to 0.8.0 api
+
+require 'thor'
+require 'adiwg-mdtranslator'
+
+class Mdtranslator < Thor
+
+	# exit_on_failure added to exit with code 1 if thor cannot complete task
+	# such as if required parameters are missing
+	def self.exit_on_failure?
+		true
+	end
+
+	# basic cli description
+	desc 'translate [FILE]', %q{Pass JSON string or filename plus parameters to mdtranslator translate}
+	long_desc <<-LONGDESC
+	    'mdtranslator translate' provides command line access to the ADIWG metadata translator
+ with options to select the input file reader, select writer output format, show empty tags
+ in XML outputs, and choose level of validation for JSON inputs.
+	LONGDESC
+	# define cli options
+	method_option :reader, :aliases => '-r', :desc => 'Name of reader to read your input', :default => 'adiwgJson'
+	method_option :writer, :aliases => '-w', :desc => 'Name of writer to create your metadata, or leave blank to validate input only'
+	method_option :validate, :aliases => '-v', :desc => 'Specify level of validation to be performed', :enum => %w{none normal strict}, :default => 'normal'
+	method_option :showAllTags, :aliases => '-s', :desc => 'Include tags for unused attributes', :type => :boolean, :default => false
+	method_option :messages, :aliases => '-m', :desc => 'On error return messages as formatted text or json object', :enum => %w{json text}, :default => 'text'
+	method_option :returnObject, :aliases => '-o', :desc => 'Return full JSON object generated by translator', :type => :boolean, :default => false
+
+	# accept command and options
+	def translate(file)
+
+		# test to see if file parameter is a local file
+		# if not ... it is assumed to be a json string
+		if File.exist?(file)
+			# read file
+			my_file = File.open(file, 'r')
+			fileObj = my_file.read
+			my_file.close
+		else
+			fileObj = file
+		end
+
+		# call mdtranslator
+		mdReturn = ADIWG::Mdtranslator.translate(fileObj, options[:reader], options[:writer],
+												 options[:validate], options[:showAllTags])
+
+		# determine return content and type of return ...
+		if mdReturn[:readerStructurePass] && mdReturn[:readerValidationPass]
+
+			# no problem was found with the input file
+			if options[:writer].nil?
+				# if no writer was specified the input was being validated only,
+				# ...no writer output will have been generated,
+				# ...and the return will be a string unless json was requested
+				if options[:messages] == 'json'
+					$stdout.write mdReturn.to_json
+					return
+				else
+					$stdout.write 'Success'
+					return
+				end
+			else
+				# a writer was specified,
+				# output is expected from the translator's writer
+				if mdReturn[:writerPass]
+				    # writer output was generated
+					# ...return the writer output in its native format unless json was requested
+					if options[:returnObject]
+						$stdout.write mdReturn.to_json
+						return
+					else
+						$stdout.write mdReturn[:writerOutput].to_s
+						return
+					end
+				else
+					# the writer failed or generated warnings to be reported
+					# ...return the messages as a string unless json was requested
+					if options[:messages] == 'json'
+						$stdout.write mdReturn.to_json
+						return
+					else
+						# build a string with messages issues from parser and validator
+						s = ''
+						s += "Failed\n"
+						s += "Writer failed to generate output or issued significant warnings\n"
+						s += "See following messages for further information\n"
+
+						# post structure messages
+						i = 0
+						mdReturn[:writerMessages].each do |message|
+							i += 1
+							s += "\nMessage: #{i}\n"
+							s += message + "\n"
+						end
+
+						$stdout.write s
+						return
+
+					end
+				end
+			end
+
+		else
+
+			# problems were found with the input file
+
+			# if no writer was specified the input was being validated only,
+			# ...no writer output will have been generated,
+			# ...and return is always expected to be a string
+			if options[:messages] == 'json'
+				$stdout.write mdReturn.to_json
+				return
+			else
+				# build a string with messages issues from parser and validator
+				s = ''
+				s += "Failed\n"
+				s += "Input failed to pass either file structure validation or content does not match schema\n"
+				s += "See following messages for further information\n"
+
+				# post structure messages
+				if mdReturn[:readerStructurePass]
+					s += "Success - Input structure is valid\n"
+				else
+					s += "Fail - Structure of input file is invalid - see following message(s):\n"
+					i = 0
+					mdReturn[:readerStructureMessages].each do |message|
+						i += 1
+						s += "\nMessage: #{i}\n"
+						s += message.to_s + "\n"
+					end
+				end
+
+				# post validator messages
+				unless mdReturn[:readerValidationPass].nil?
+					if mdReturn[:readerValidationPass]
+						s += "Success - Input content passes schema definition\n"
+					else
+						s += "Fail - Input content did not pass schema validation - see following message(s):\n"
+						i = 0
+						mdReturn[:readerValidationMessages].each do |message|
+							i += 1
+							s += "\nMessage: #{i}\n"
+							s += message.to_s + "\n"
+						end
+					end
+				end
+
+				$stdout.write s
+				return
+
+			end
+		end
+
+	end
+
+	Mdtranslator.start(ARGV)
+
+end