opener-property-tagger 3.1.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5c733650becb914d2974c844954ef3a53febf56e
-  data.tar.gz: 5e42560d34a43e15786d743626d4b7518bdc705f
+SHA256:
+  metadata.gz: 6483ef2a01a413e280ed9555566499496748cb0b8c25ddd9853fb50165ab03f9
+  data.tar.gz: eb0f85d3d82aed282d21a3b51a0c75867b62c547b49fd1ceeaac374baff86111
 SHA512:
-  metadata.gz: 8cbb1e79839415fff83b68ad363175a5dead10ce9e4e814e10ced7878553c38a8ee0690b751e0aea4810e40638a23cdb1d8b1c5f83377b341c21049a2cf5be5d
-  data.tar.gz: 4e8989a60251a2f712563e770574ac2638b3484abca7b123d4e988040dd5d7848b6d4158a5656547dfb123170dc5ac2ea9bd123fb89e167bfa1f2982e9a554ad
+  metadata.gz: fe31cb493644de7eaed474d9064e3f8880f229b8e05f0685aae18e730f5cd3d94c92aa403966904147b710f0e9589cffa840cf44ac83d64fc7f9c9211ffc6313
+  data.tar.gz: '0939965101de5ccd503bbdeae6b511552354d8f285e263b739b5d5f004ffdf03411fac5b4a97404f728bd1038f8320843c2dcb2f8ae70059eedc44e0682c4d71'

data/lib/opener/property_tagger.rb

@@ -2,13 +2,18 @@ require 'open3'
 require 'slop'
 require 'oga'
 require 'monitor'
+require 'httpclient'
+require 'hashie'
+require 'json'
+require 'active_support/all'
 
 require 'rexml/document'
 require 'rexml/formatters/pretty'
 
 require_relative 'property_tagger/version'
 require_relative 'property_tagger/cli'
-require_relative 'property_tagger/aspects_cache'
+require_relative 'property_tagger/remote_aspects_cache'
+require_relative 'property_tagger/file_aspects_cache'
 require_relative 'property_tagger/processor'
 
 module Opener
@@ -43,14 +48,17 @@ module Opener
     # @return [String]
     #
     def path
-      path = options[:resource_path] || ENV['RESOURCE_PATH'] ||
+      return @path if @path
+
+      @path = options[:resource_path] || ENV['RESOURCE_PATH'] ||
         ENV['PROPERTY_TAGGER_LEXICONS_PATH']
+      return unless @path
 
-      unless path
-        raise ArgumentError, 'No lexicon path provided'
-      end
+      @path = File.expand_path @path
+    end
 
-      return File.expand_path(path)
+    def remote_url
+      @remote_url ||= ENV['PROPERTY_TAGGER_LEXICONS_URL']
     end
 
     ##
@@ -59,11 +67,18 @@ module Opener
     # @param [String] input
     # @return [String]
     #
-    def run(input)
+    def run input, params = {}
       timestamp = !options[:no_time]
 
-      return Processor.new(input, path, timestamp, options[:pretty]).process
+      Processor.new(input,
+        params:    params,
+        url:       remote_url,
+        path:      path,
+        timestamp: timestamp,
+        pretty:    options[:pretty],
+      ).process
     end
-  end # PolarityTagger
-end # Opener
+
+  end
+end
 

data/lib/opener/property_tagger/{aspects_cache.rb → file_aspects_cache.rb}

@@ -3,7 +3,8 @@ module Opener
     ##
     # Thread-safe cache for storing the contents of aspect files.
     #
-    class AspectsCache
+    class FileAspectsCache
+
       include MonitorMixin
 
       def initialize
@@ -22,8 +23,6 @@ module Opener
         synchronize do
           @cache[path] = load_aspects(path) unless @cache.key?(path)
         end
-
-        return @cache[path]
       end
 
       alias_method :get, :[]
@@ -44,6 +43,7 @@ module Opener
 
         return mapping
       end
-    end # AspectsCache
-  end # PropertyTagger
-end # Opener
+
+    end
+  end
+end

data/lib/opener/property_tagger/processor.rb

@@ -4,14 +4,18 @@ module Opener
     # Class that applies property tagging to a given input KAF file.
     #
     class Processor
-      attr_accessor :document, :aspects_path, :timestamp, :pretty
+
+      attr_accessor :document
+      attr_accessor :aspects, :aspects_path, :aspects_url
+      attr_accessor :timestamp, :pretty
 
       ##
       # Global cache used for storing loaded aspects.
       #
-      # @return [Opener::PropertyTagger::AspectsCache.new]
+      # @return [Opener::PropertyTagger::FileAspectsCache.new]
       #
-      ASPECTS_CACHE = AspectsCache.new
+      FILE_ASPECTS_CACHE   = FileAspectsCache.new
+      REMOTE_ASPECTS_CACHE = RemoteAspectsCache.new
 
       ##
       # @param [String|IO] file The KAF file/input to process.
@@ -20,13 +24,19 @@ module Opener
       # @param [TrueClass|FalseClass] pretty Enable pretty formatting, disabled
       #  by default due to the performance overhead.
       #
-      def initialize(file, aspects_path, timestamp = true, pretty = false)
-        @document     = Oga.parse_xml(file)
-        @aspects_path = aspects_path
+      def initialize file, params: {}, url: nil, path: nil, timestamp: true, pretty: false
+        @document     = Oga.parse_xml file
+        raise 'Error parsing input. Input is required to be KAF' unless is_kaf?
         @timestamp    = timestamp
         @pretty       = pretty
 
-        raise 'Error parsing input. Input is required to be KAF' unless is_kaf?
+        @params       = params
+        @cache_keys   = params[:cache_keys] || {lang: language}
+        @remote       = !url.nil?
+        @aspects_path = path
+        @aspects_url  = url
+
+        @aspects = if @remote then REMOTE_ASPECTS_CACHE[**@cache_keys].aspects else FILE_ASPECTS_CACHE[aspects_file] end
       end
 
       ##
@@ -50,13 +60,6 @@ module Opener
         return pretty ? pretty_print(document) : document.to_xml
       end
 
-      ##
-      # @return [Hash]
-      #
-      def aspects
-        return ASPECTS_CACHE[aspects_file]
-      end
-
       ##
       # Get the language of the input file.
       #
@@ -228,9 +231,9 @@ module Opener
       # @return [String]
       #
       def aspects_file
-        return @aspects_file ||=
-          File.expand_path("#{aspects_path}/#{language}.txt", __FILE__)
+        @aspects_file ||= File.expand_path "#{aspects_path}/#{language}.txt", __FILE__
       end
-    end # Processor
-  end # PropertyTagger
-end # Opener
+
+    end
+  end
+end

data/lib/opener/property_tagger/remote_aspects_cache.rb

@@ -0,0 +1,60 @@
+module Opener
+  class PropertyTagger
+    ##
+    # Thread-safe cache for storing the contents of remote aspects.
+    #
+    class RemoteAspectsCache
+
+      include MonitorMixin
+
+      UPDATE_INTERVAL = (ENV['CACHE_EXPIRE_MINS']&.to_i || 5).minutes
+
+      def initialize
+        super
+
+        @url   = ENV['PROPERTY_TAGGER_LEXICONS_URL']
+        @cache = {}
+      end
+
+      def [] **params
+        synchronize do
+          existing = @cache[params]
+          break existing if existing and existing.from > UPDATE_INTERVAL.ago
+          @cache[params] = cache_update existing, **params
+        end
+      end
+      alias_method :get, :[]
+
+      def cache_update existing = nil, **params
+        from     = Time.now
+        lexicons = load_aspects cache: existing, **params
+
+        if existing and lexicons.blank?
+          existing.from = from
+          return existing
+        end
+
+        Hashie::Mash.new(
+          aspects: lexicons,
+          from:    from,
+        )
+      end
+
+      def load_aspects lang:, cache:, **params
+        url      = "#{@url}&language_code=#{lang}&#{params.to_query}"
+        url     += "&if_updated_since=#{cache.from.iso8601}" if cache
+        puts "#{lang}: loading aspects from #{url}"
+
+        lexicons = JSON.parse HTTPClient.new.get(url).body
+        lexicons = lexicons['data'].map{ |l| Hashie::Mash.new l }
+        mapping  = Hash.new{ |hash, key| hash[key] = [] }
+        lexicons.each do |l|
+          mapping[l.lemma.to_sym] << l.aspect
+        end
+
+        mapping
+      end
+
+    end
+  end
+end

data/lib/opener/property_tagger/version.rb

@@ -1,5 +1,7 @@
 module Opener
   class PropertyTagger
-    VERSION = '3.1.0'
-  end # PropertyTagger
-end # Opener
+
+    VERSION = '3.3.2'
+
+  end
+end

data/opener-property-tagger.gemspec

@@ -28,7 +28,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'opener-webservice', '~> 2.1'
   gem.add_dependency 'opener-core', '~> 2.2'
 
-  gem.add_dependency 'oga', '~> 1.3.0'
+  gem.add_dependency 'oga', ['~> 1.0', '>= 1.3.1']
+  gem.add_dependency 'httpclient'
+  gem.add_dependency 'hashie'
+  gem.add_dependency 'activesupport'
 
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'cucumber'

metadata

@@ -1,129 +1,177 @@
 --- !ruby/object:Gem::Specification
 name: opener-property-tagger
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.2
 platform: ruby
 authors:
 - development@olery.com
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: opener-daemons
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-  type: :runtime
+  name: opener-daemons
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: opener-webservice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-  type: :runtime
+  name: opener-webservice
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: opener-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-  type: :runtime
+  name: opener-core
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: oga
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  name: oga
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: httpclient
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: hashie
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: activesupport
+  prerelease: false
+  type: :runtime
+  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: '3.0'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: cucumber
   prerelease: false
+  type: :development
   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
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  type: :development
+  name: benchmark-ips
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Property tagger for hotels in Dutch and English.
-email: 
+email:
 executables:
 - property-tagger
 - property-tagger-daemon
@@ -139,10 +187,11 @@ files:
 - config.ru
 - exec/property-tagger.rb
 - lib/opener/property_tagger.rb
-- lib/opener/property_tagger/aspects_cache.rb
 - lib/opener/property_tagger/cli.rb
+- lib/opener/property_tagger/file_aspects_cache.rb
 - lib/opener/property_tagger/processor.rb
 - lib/opener/property_tagger/public/markdown.css
+- lib/opener/property_tagger/remote_aspects_cache.rb
 - lib/opener/property_tagger/server.rb
 - lib/opener/property_tagger/version.rb
 - lib/opener/property_tagger/views/index.erb
@@ -154,7 +203,7 @@ homepage: http://opener-project.github.com/
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,10 +218,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.9
+signing_key:
 specification_version: 4
 summary: Property tagger for hotels in Dutch and English.
 test_files: []
-has_rdoc: