opener-core 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb32f59ce0335afa43bacee5a96fb97ca475d7d9
-  data.tar.gz: ed38573de519ec4ec5b2093be5092ad830270d06
+  metadata.gz: 87117423cfca0b17170602c260fc9104ba2b45ac
+  data.tar.gz: 9d4bb57cb373d9267e7919a931f8bbed7df2f674
 SHA512:
-  metadata.gz: bc40f6969b68fb51f8b01a997aa221951c6dfce0c41acc53c9be19c4d04234131bc0926cfc0e7a916b7a305b8e68c7f8f07759ebc60adf434c191cc94a0199a4
-  data.tar.gz: efbbd5b7f3059688f4086a21aee00198a96dd175b4694d26199bec41d9fa566d8d25b4b71cdb3c9beb6804b18650beed4b96f9c23e2aa69f1afe559cf8ac932e
+  metadata.gz: 82117f92f331dce2a4f0d59e4da78028afc67c2eac93710d8d87b0b5c9440aa2a3bae643a62c1880cc8687401437c6ad5cb96417dd6df6040a0e16bfad7d9712
+  data.tar.gz: 005414617ad9a815772613340254c8d955c4c0b8a388587eb8f37f3dcd793b2df8c9c8babcfbda40baaebc4e8dd6c2173e439058c05a040e7ac97fbd8f3f2888

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2014 OpeNER Project Consortium
+
+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.

data/README.md

@@ -1,7 +1,19 @@
-# Opener::Core
+# Opener Core
 
 A Gem that provides commonly re-used functionality for the various OpeNER Gems.
 
+## Requirements
+
+| Ruby     | Required      | Recommended |
+|:---------|:--------------|:------------|
+| MRI      | >= 1.9.3      | >= 2.1.4    |
+| Rubinius | >= 2.2        | >= 2.3.0    |
+| JRuby    | >= 1.7        | >= 1.7.16   |
+
+For the resource switcher you'll need to have
+[libarchive](http://www.libarchive.org/) installed as it's used for unpacking
+archives.
+
 ## Installation
 
 You can install opener-core as a Gem by running:

data/lib/opener/core.rb

@@ -1,13 +1,13 @@
-require 'benchmark'
-require 'optparse'
 require 'tempfile'
 require 'uri'
-require 'nokogiri'
+require 'syslog'
+require 'fileutils'
+
+require 'slop'
+require 'httpclient'
+require 'archive'
 
 require_relative 'core/version'
-require_relative 'core/argv_splitter'
 require_relative 'core/opt_parser'
 require_relative 'core/resource_switcher'
-require_relative 'core/memory_usage'
-require_relative 'core/benchmark'
-require_relative 'core/error_layer'
+require_relative 'core/syslog'

data/lib/opener/core/resource_switcher.rb

@@ -1,85 +1,128 @@
 module Opener
   module Core
+    ##
+    # Class for downloading and extracting external resources such as
+    # models/lexicons.
+    #
+    # @!attribute [r] http
+    #  @return [HTTPClient]
+    #
     class ResourceSwitcher
+      attr_reader :http
 
-      def bind(opts, options)
-        OptParser.bind(opts,options)
+      def initialize
+        @http = HTTPClient.new
       end
 
-      def install(options, force=true)
-        Installer.new(options).install(force)
+      ##
+      # Adds extra CLI options to the given Slop instance.
+      #
+      # @param [Slop] slop
+      #
+      def bind(slop)
+        slop.separator "\nResource Options:\n"
+
+        slop.on :'resource-url=',
+          'URL pointing to a .zip/.tar.gz file to download',
+          :as => String
+
+        slop.on :'resource-path=',
+          'Path where the resources should be saved',
+          :as => String
+
+        # Hijack Slop's run block so we can inject our own code before it.  This
+        # is quite grotesque, but sadly the only way.
+        old_runner = slop.instance_variable_get(:@runner)
+
+        slop.run do |opts, args|
+          if opts[:'resource-path'] and opts[:'resource-url']
+            download_and_extract(opts[:'resource-url'], opts[:'resource-path'])
+          end
+
+          old_runner.call(opts, args)
+        end
       end
 
-      class Installer
-        attr_reader :options
+      ##
+      # @param [String] url
+      # @param [String] path
+      #
+      def download_and_extract(url, path)
+        filename  = filename_from_url(url)
+        temp_path = File.join(path, filename)
 
-        def initialize(options={})
-          @options = options
-        end
+        create_directory(path)
 
-        def install(force=true)
-          return if !options[:resource_path] && !options[:resource_url]
+        download(url, temp_path)
 
-          path = options[:resource_path]
-          if options[:resource_url] && path.nil? && force
-            raise ArgumentError, "No resource-path given"
-          end
+        Archive.extract(temp_path, path)
 
-          FileUtils.mkdir_p File.expand_path(path)
+        remove_file(temp_path)
+      end
 
-          if url = options[:resource_url]
-            download_and_unzip_resource(url,path)
+      ##
+      # Downloads the given file.
+      #
+      # @param [String] url
+      # @param [String] path
+      #
+      def download(url, path)
+        File.open(path, 'w', :encoding => Encoding::BINARY) do |handle|
+          http.get(url) do |chunk|
+            handle.write(chunk)
           end
         end
+      end
 
-        def download_and_unzip_resource(url, path)
-          filename = download(url, path)
-          unzip(filename, path)
+      ##
+      # Returns the filename of the file located at `url`.
+      #
+      # @param [String] url
+      # @return [String]
+      #
+      def filename_from_url(url)
+        headers = get_headers(url)
+
+        unless headers['Content-Disposition']
+          raise "The URL #{url.inspect} did not return a Content-Disposition " \
+            "header. This header is required to figure out the filename"
         end
 
-        def download(url, path)
-          filename = get_filename_from_url(url)
-          destination = File.expand_path(filename, path)
-          `wget -N -P #{path} #{url}`
-          return destination
-        end
+        matches = headers['Content-Disposition'].match(/filename=(.+)/)
 
-        def unzip(file, path)
-          extname = File.extname(file)
-          full_filename = Dir.glob("#{file}*").first
-          puts "Extracting full_filename"
-          if extname == ".zip"
-            puts `unzip -o #{full_filename} -d #{path}`
-          else
-            puts `tar -zxvf #{full_filename} --directory #{path}`
-          end
+        if !matches or !matches[1]
+          raise 'No filename could be found in the Content-Disposition header'
         end
 
-        def get_filename_from_url(url)
-          URI.parse(url).path[1..-1].split("/").last
-        end
+        return matches[1]
       end
 
-      class OptParser < Opener::Core::OptParser
-        attr_accessor :option_parser, :options
-
-        def self.bind(opts, options)
-          opts.on("--resource-path PATH", "Path where the resources are located. In combination with the --resource-url option this is also the path where the resources will be installed") do |v|
-            options[:resource_path] = v
-          end
+      ##
+      # Creates the path. This method mainly exists to make testing a bit
+      # easier.
+      #
+      # @param [String] path
+      #
+      def create_directory(path)
+        FileUtils.mkdir_p(path)
+      end
 
-          opts.on("--resource-url URL", "URL where a zip file containing all resources can be downloaded") do |v|
-            options[:resource_url] = v
-          end
-        end
-        private
+      ##
+      # Removes the given file, mainly exists to make testing easier.
+      #
+      # @param [String] path
+      #
+      def remove_file(path)
+        File.unlink(path)
+      end
 
-        def construct_option_parser(options, &block)
-          OptionParser.new do |opts|
-            self.class.bind(opts, options)
-          end
-        end
+      ##
+      # @param [String] url
+      # @return [Hash]
+      #
+      def get_headers(url)
+        return http.head(url).headers
       end
-    end
-  end
-end
+    end # ResourceSwitcher
+  end # Core
+end # Opener

data/lib/opener/core/syslog.rb

@@ -0,0 +1,67 @@
+module Opener
+  module Core
+    ##
+    # Wrapper around `Syslog` that makes it easier to disable loggers and to log
+    # custom key/value pairs in message.
+    #
+    module Syslog
+      ##
+      # Returns `true` if Syslog should be enabled.
+      #
+      # @return [TrueClass|FalseClass]
+      #
+      def self.enabled?
+        return !!ENV['ENABLE_SYSLOG']
+      end
+
+      ##
+      # Configures Syslog.
+      #
+      # @see [Syslog.open]
+      # @param [String] name The name of the program.
+      # @param [Fixnum] facility
+      #
+      def self.open(name, facility = nil)
+        ::Syslog.open(name, facility) if enabled?
+      end
+
+      # methods defined using define_method() are slower than those defined
+      # using eval() on JRuby and Rubinius.
+      [:debug, :err, :fatal, :info, :warn, :unknown].each do |method|
+        eval <<-EOF, nil, __FILE__, __LINE__ + 1
+        def self.#{method}(message, meta = {})
+          add(:#{method}, message, meta)
+        end
+        EOF
+      end
+
+      ##
+      # Adds a new log message.
+      #
+      # @example
+      #  add(:info, 'Testing Syslog', :user_id => 19)
+      #
+      # @param [Symbol] type The type of log message to add, corresponds to the
+      #  logger method that will be called.
+      #
+      # @param [String] message The message to log.
+      # @param [Hash] meta Extra meta data to log.
+      #
+      def self.add(type, message, meta = {})
+        return unless enabled?
+
+        pairs = make_pairs(meta)
+
+        ::Syslog.send(type, "#{pairs} #{message}".strip)
+      end
+
+      ##
+      # @param [Hash] meta
+      # @return [String]
+      #
+      def self.make_pairs(meta)
+        return meta.map { |(key, value)| "#{key}=#{value.inspect}" }.join(' ')
+      end
+    end # Syslog
+  end # Core
+end # Opener

data/lib/opener/core/version.rb

@@ -1,5 +1,5 @@
 module Opener
   module Core
-    VERSION = '1.0.2'
+    VERSION = '2.0.0'
   end
 end

data/opener-core.gemspec

@@ -7,17 +7,20 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Gem that contains some low level generic functions for all OpeNER components.'
   spec.description   = spec.summary
   spec.homepage      = 'http://opener-project.github.com'
-  spec.license       = 'Apachev2'
+  spec.license       = 'Apache 2.0'
 
   spec.files = Dir.glob([
     'lib/**/*',
     '*.gemspec',
-    'README.md'
+    'README.md',
+    'LICENSE.txt'
   ]).select { |file| File.file?(file) }
 
   spec.executables = Dir.glob('bin/*').map { |file| File.basename(file) }
 
-  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'slop', '~> 3.0'
+  spec.add_dependency 'httpclient'
+  spec.add_dependency 'archive'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,109 +1,136 @@
 --- !ruby/object:Gem::Specification
 name: opener-core
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - development@olery.com
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: bundler
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: archive
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rspec
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem that contains some low level generic functions for all OpeNER components.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
 - lib/opener/core.rb
-- lib/opener/core/argv_splitter.rb
-- lib/opener/core/benchmark.rb
-- lib/opener/core/error_layer.rb
-- lib/opener/core/memory_usage.rb
 - lib/opener/core/opt_parser.rb
 - lib/opener/core/resource_switcher.rb
+- lib/opener/core/syslog.rb
 - lib/opener/core/version.rb
 - opener-core.gemspec
 homepage: http://opener-project.github.com
 licenses:
-- Apachev2
+- Apache 2.0
 metadata: {}
-post_install_message:
+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: []
-rubyforge_project:
+rubyforge_project: 
 rubygems_version: 2.2.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Gem that contains some low level generic functions for all OpeNER components.
 test_files: []
+has_rdoc: 

data/lib/opener/core/argv_splitter.rb

@@ -1,19 +0,0 @@
-module Opener
-  module Core
-    class ArgvSplitter
-
-      def self.split(args, char="--")
-        if index = args.index(char)
-          first = args[0..index-1]
-          second = args[index+1..-1]
-        else
-          first = args
-          second = []
-        end
-
-        [first,second]
-      end
-    end
-  end
-end
-

data/lib/opener/core/benchmark.rb

@@ -1,137 +0,0 @@
-module Opener
-  module Core
-    ##
-    # Class for measuring and adding benchmarking information to KAF documents.
-    #
-    # Basic usage is as following:
-    #
-    #     benchmark = Opener::Core::Benchmark.new('opener-property-tagger')
-    #     document  = nil
-    #     results   = benchmark.measure do
-    #       document = some_stuff_that_emits_kaf
-    #     end
-    #
-    #     # Add the data to the document. This method returns the new XML as a
-    #     # String.
-    #     xml = benchmark.write(document, results)
-    #
-    # ## Metrics
-    #
-    # The following metrics are gathered:
-    #
-    # * Starting memory usage
-    # * End memory usage
-    # * Memory increase (if any)
-    # * CPU system time
-    # * CPU user time
-    # * Real time
-    # * Total time
-    #
-    # @!attribute [r] name
-    #  @return [String]
-    #
-    # @!attribute [r] results
-    #  @return [Hash]
-    #
-    class Benchmark
-      attr_reader :name
-
-      ##
-      # @param [String] name The name of the benchmark.
-      #
-      def initialize(name)
-        @name = name
-      end
-
-      ##
-      # Measures the block and returns the results as a Hash.
-      #
-      # @example
-      #  measure do
-      #    sleep(5)
-      #  end
-      #
-      # @return [Hash]
-      #
-      def measure
-        mem_usage = MemoryUsage.new
-        mem_start = mem_usage.usage
-        timings   = ::Benchmark.measure do
-          yield
-        end
-
-        mem_end = mem_usage.usage
-
-        return {
-          :memory_start    => mem_start,
-          :memory_end      => mem_end,
-          :memory_increase => mem_end - mem_start,
-          :time_cpu_system => timings.stime,
-          :time_cpu_user   => timings.utime,
-          :time_real       => timings.real,
-          :time_total      => timings.total
-        }
-      end
-
-      ##
-      # Writes benchmarking results to the specified document.
-      #
-      # @param [String] xml The XML document.
-      # @param [Hash] results The benchmarking results to write.
-      # @return [String]
-      #
-      def write(xml, results)
-        document   = Nokogiri::XML(xml)
-        root       = document.at('KAF')
-        benchmarks = root.at('benchmarks')
-
-        unless benchmarks
-          benchmarks = Nokogiri::XML::Node.new('benchmarks', document)
-
-          root.add_child(benchmarks)
-        end
-
-        benchmark = create_benchmark_node(document)
-
-        results.each do |name, val|
-          benchmark.add_child(create_node(name, val, document))
-        end
-
-        benchmarks.add_child(benchmark)
-
-        return document.to_xml(
-          :indent   => 2,
-          :encoding => document.encoding || 'UTF-8'
-        )
-      end
-
-      private
-
-      ##
-      # @param [Nokogiri::XML::Document] document
-      # @return [Nokogiri::XML::Node]
-      #
-      def create_benchmark_node(document)
-        node = Nokogiri::XML::Node.new('benchmark', document)
-
-        node.set_attribute('name', name)
-
-        return node
-      end
-
-      ##
-      # @param [String|Symbol] name
-      # @param [Mixed] text
-      # @param [Nokogiri::XML::Document] document
-      # @return [Nokogiri::XML::Node]
-      #
-      def create_node(name, text, document)
-        node = Nokogiri::XML::Node.new(name.to_s, document)
-
-        node.inner_html = text.to_s
-
-        return node
-      end
-    end # Benchmark
-  end # Core
-end # Opener

data/lib/opener/core/error_layer.rb

@@ -1,89 +0,0 @@
-require 'nokogiri'
-
-module Opener
-  module Core
-    ##
-    # Add Error Layer to KAF file instead of throwing an error.
-    #
-    class ErrorLayer
-      attr_accessor :input, :document, :error, :klass
-      
-      def initialize(input, error, klass)
-        @input    = input.to_s
-        # Make sure there is always a document, even if it is empty.
-        @document = Nokogiri::XML(input) rescue Nokogiri::XML(nil)
-        @error    = error
-        @klass    = klass
-      end
-      
-      def add
-        if is_xml?
-          unless has_errors_layer?
-            add_errors_layer
-          end
-        else
-          add_root
-          add_text
-          add_errors_layer
-        end
-        add_error
-        
-        xml = !!document.encoding ? document.to_xml : document.to_xml(:encoding => "UTF-8")
-        
-        return xml
-      end
-      
-      ##
-      # Check if the document is a valid XML file.
-      #
-      def is_xml?
-        !!document.root
-      end
-      
-      ##
-      # Add root element to the XML file.
-      #
-      def add_root
-        root = Nokogiri::XML::Node.new "KAF", document
-        document.add_child(root)
-      end
-      
-      ##
-      # Check if the document already has an errors layer.
-      #
-      def has_errors_layer?
-        !!document.at('errors')
-      end
-      
-      ##
-      # Add errors element to the XML file.
-      #
-      def add_errors_layer
-        node = Nokogiri::XML::Node.new "errors", document
-        document.root.add_child(node)
-      end
-      
-      ##
-      # Add the text file incase it is not a valid XML document. More
-      # info for debugging.
-      #
-      def add_text
-        node = Nokogiri::XML::Node.new "raw", document
-        node.inner_html = input
-        document.root.add_child(node)    
-      end
-      
-      ##
-      # Add the actual error to the errors layer.
-      #
-      def add_error
-        node = document.at('errors')
-        error_node = Nokogiri::XML::Node.new "error", node
-        error_node['class']   = klass.to_s
-        error_node['version'] = klass::VERSION
-        error_node.inner_html = error
-        node.add_child(error_node)
-      end     
-    end # ErrorLayer
-  end # Core
-end # Opener

data/lib/opener/core/memory_usage.rb

@@ -1,47 +0,0 @@
-module Opener
-  module Core
-    ##
-    # Class for returning the memory usage of the current process. This uses
-    # the `/proc` filesystem if available and falls back to `ps`.
-    #
-    class MemoryUsage
-      ##
-      # Returns the RSS (aka total memory) in bytes.
-      #
-      # @return [Fixnum]
-      #
-      def usage
-        return has_proc? ? rss_proc : rss_ps
-      end
-
-      ##
-      # @return [TrueClass|FalseClass]
-      #
-      def has_proc?
-        return File.exists?('/proc')
-      end
-
-      ##
-      # Returns the RSS using the `/proc` filesystem.
-      #
-      # @return [Fixnum]
-      #
-      def rss_proc
-        kb = File.read('/proc/self/status').match(/VmRSS:\s+(\d+)/)[1].to_i
-
-        return kb * 1024
-      end
-
-      ##
-      # Returns the RSS using the `ps` command.
-      #
-      # @return [Fixnum]
-      #
-      def rss_ps
-        kb = `ps -o rss= #{Process.pid}`.strip.to_i
-
-        return kb * 1024
-      end
-    end # MemoryUsage
-  end # Core
-end # Opener