uri_service 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a23d6006da06917691b8db5b5a1a7c77aa7cc50d
-  data.tar.gz: f89dc8f0cabf1ccaccde2e6bb5d595b9a9e4a280
+SHA256:
+  metadata.gz: 2a5e8309e33cf98f187e5f1dc39e5b0c52ea9098146cec6d417c7b4304b7cadc
+  data.tar.gz: d05d94ac0bbb449c1492a93fe4ad121dc8399a07843179899794ebdd8293b000
 SHA512:
-  metadata.gz: 90e9d786e5bb9277c9118aed2fc38fb840f1d5a6d35d9f04a0a78b7bc04bed1182dc0312397d93f3dd37793d015faddab473ce883c17b1c0e85c1c054b6d747b
-  data.tar.gz: fd86538bd5259d7300b26061030ad26f36c75aee391bd51456330996ee87dab85ba82fbd25fb91df8c5543af4f08149434d35cecdb13fb43fdacd19e663bcf30
+  metadata.gz: 419b95b61f9acd1f729543b49ba530f8f1112a3b5d22aebb1a9ea1308e2fd64057dfbd5a674ab65b2d617d04fc7158ab4367c8dac7e626b66264ad09969f86b6
+  data.tar.gz: 6de069fd580769f921b9ca9780a201bc2410f3e7b0f908740b93b37c1935b4b205db662b29c11e8e3d8faf381bfa6d44821f0d6299f21996d06a3a95d54f195c

data/README.md

@@ -2,6 +2,8 @@
 
 A database-backed and Solr-cached lookup/creation service for URIs.  Works with or without Rails.
 
+Note: Version 0.6.x and later are meant for use with Solr 8.
+
 ### Major Concepts:
 
 **External Term (UriService::TermType::EXTERNAL)**
@@ -31,7 +33,7 @@ UriService::init({
   'local_uri_base' => 'http://id.example.com/term/',
   'temporary_uri_base' => 'com:example:id:temporary:',
   'solr' => {
-    'url' => 'http://localhost:8983/solr/uri_service_test',
+    'url' => 'http://localhost:8983/solr/uri_service',
     'pool_size' => 5,
     'pool_timeout' => 5000
   }
@@ -53,7 +55,7 @@ client = UriService::Client.new({
   'local_uri_base' => 'http://id.example.com/term/',
   'temporary_uri_base' => 'com:example:id:temporary:',
   'solr' => {
-    'url' => 'http://localhost:8983/solr/uri_service_test',
+    'url' => 'http://localhost:8983/solr/uri_service',
     'pool_size' => 5,
     'pool_timeout' => 5000
   }
@@ -83,7 +85,7 @@ development:
   local_uri_base: 'http://id.example.com/term/'
   temporary_uri_base: 'com:example:id:temporary:'
   solr:
-    url: 'http://localhost:8983/solr/uri_service_development'
+    url: 'http://localhost:8983/solr/uri_service'
     pool_size: 5
     pool_timeout: 5000
   database:
@@ -96,7 +98,7 @@ test:
   local_uri_base: 'http://id.example.com/term/'
   temporary_uri_base: 'com:example:id:temporary:'
   solr:
-    url: 'http://localhost:8983/solr/uri_service_test'
+    url: 'http://localhost:9983/solr/uri_service'
     pool_size: 5
     pool_timeout: 5000
   database:
@@ -109,7 +111,7 @@ production:
   local_uri_base: 'http://id.example.com/term/'
   temporary_uri_base: 'com:example:id:temporary:'
   solr:
-    url: 'http://localhost:9983/solr/uri_service_production'
+    url: 'http://localhost:8983/solr/uri_service_prod'
     pool_size: 5
     pool_timeout: 5000
   database:

data/lib/tasks/uri_service/ci.rake

@@ -19,13 +19,15 @@ namespace :uri_service do
     puts "[Warning] Exception creating rspec rake tasks.  This message can be ignored in environments that intentionally do not pull in the RSpec gem (i.e. production)."
     puts e
   end
-  
+
   desc "CI build"
   task :ci do
-    Rake::Task["uri_service:ci_with_solr_6_wrapper"].invoke
-    #Rake::Task["uri_service:ci_with_jetty_wrapper"].invoke
+    ENV['APP_ENV'] = 'test'
+    Rake::Task["uri_service:ci_prepare"].invoke
+    Rake::Task["uri_service:docker:setup_config_files"].invoke
+    Rake::Task["uri_service:ci_impl"].invoke
   end
-  
+
   desc "Preparation steps for the CI run"
   task :ci_prepare do
     # Delete existing test database
@@ -36,65 +38,36 @@ namespace :uri_service do
     client.create_required_tables
     FileUtils.mkdir_p('tmp')
   end
-  
-  desc "CI build (using SolrWrapper and Solr 6)"
-  task ci_with_solr_6_wrapper: :ci_prepare do
-    solr_version = '6.3.0'
-    instance_dir = File.join('tmp', "solr-#{solr_version}")
-    FileUtils.rm_rf(instance_dir)
-    
-    puts "Unpacking and starting solr...\n"
-    SolrWrapper.wrap({
-      port: 9983,
-      version: solr_version,
-      verbose: false,
-      mirror_url: 'http://lib-solr-mirror.princeton.edu/dist/',
-      managed: true,
-      download_path: File.join('tmp', "solr-#{solr_version}.zip"),
-      instance_dir: instance_dir,
-    }) do |solr_wrapper_instance|
-      
-      # Create collection
-      solr_wrapper_instance.with_collection(name: 'uri_service_test', dir: File.join('spec/fixtures', 'uri_service_test_cores/uri_service_test-solr6-conf')) do |collection_name|
+
+  desc 'CI build just running specs'
+  task :ci_impl do
+    docker_wrapper do
+      duration = Benchmark.realtime do
         Rake::Task["uri_service:rspec"].invoke
       end
-      
-      puts 'Stopping solr...'
+      puts "\nCI run finished in #{duration} seconds."
     end
   end
-  
-  desc "CI build (using JettyWrapper)"
-  task ci_with_jetty_wrapper: :ci_prepare do
-    
-    Jettywrapper.url = "https://github.com/cul/hydra-jetty/archive/solr-only.zip"
-    Jettywrapper.jetty_dir = File.join('tmp', 'jetty-test')
-  
-    unless File.exists?(Jettywrapper.jetty_dir)
-      puts "\n" + 'No test jetty found.  Will download / unzip a copy now.' + "\n"
+
+  def docker_wrapper(&block)
+    unless ENV['APP_ENV'] == 'test'
+      raise 'This task should only be run in the test environment (because it clears docker volumes)'
     end
-    
-    Rake::Task["jetty:clean"].invoke # Clear and recreate previous jetty directory
-    
-    # Copy solr core fixture to new solr instance
-    FileUtils.cp_r('spec/fixtures/uri_service_test_cores/uri_service_test', File.join(Jettywrapper.jetty_dir, 'solr'))
-    # Update solr.xml configuration file so that it recognizes this code
-    solr_xml_data = File.read(File.join(Jettywrapper.jetty_dir, 'solr/solr.xml'))
-    solr_xml_data.gsub!('</cores>', '  <core name="uri_service_test" instanceDir="uri_service_test" />' + "\n" + '  </cores>')
-    File.open(File.join(Jettywrapper.jetty_dir, 'solr/solr.xml'), 'w') { |file| file.write(solr_xml_data) }
-    
-    jetty_params = Jettywrapper.load_config.merge({
-      jetty_home: Jettywrapper.jetty_dir,
-      solr_home: 'solr',
-      startup_wait: 75,
-      jetty_port: 9983,
-      java_version: '>= 1.8',
-      java_opts: ["-XX:MaxPermSize=128m", "-Xmx256m"]
-    })
-    error = Jettywrapper.wrap(jetty_params) do
-      Rake::Task["uri_service:rspec"].invoke
+
+    # Stop docker if it's currently running (so we can delete any old volumes)
+    Rake::Task['uri_service:docker:stop'].invoke
+    # Rake tasks must be re-enabled if you want to call them again later during the same run
+    Rake::Task['uri_service:docker:stop'].reenable
+
+    ENV['app_env_confirmation'] = ENV['APP_ENV'] # setting this to skip prompt in volume deletion task
+    Rake::Task['uri_service:docker:delete_volumes'].invoke
+
+    Rake::Task['uri_service:docker:start'].invoke
+    begin
+      block.call
+    ensure
+      Rake::Task['uri_service:docker:stop'].invoke
     end
-    raise "test failures: #{error}" if error
-    
   end
 
-end
+end

data/lib/tasks/uri_service/docker.rake

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+require 'open3'
+require 'net/http'
+require 'rainbow'
+
+namespace :uri_service do
+  namespace :docker do
+    def docker_compose_file_path
+      UriService.root.join("docker/docker-compose.#{ENV['APP_ENV']}.yml")
+    end
+
+    def docker_compose_config
+      YAML.load_file(docker_compose_file_path)
+    end
+
+    def wait_for_solr_cores_to_load
+      expected_port = docker_compose_config['services']['solr']['ports'][0].split(':')[0]
+      url_to_check = "http://localhost:#{expected_port}/solr/uri_service/admin/system"
+      puts "Waiting for Solr to become available (at #{url_to_check})..."
+      Timeout.timeout(20, Timeout::Error, 'Timed out during Solr startup check.') do
+        loop do
+          begin
+            sleep 0.25
+            status_code = Net::HTTP.get_response(URI(url_to_check)).code
+            if status_code == '200' # Solr is ready to receive requests
+              puts 'Solr is available.'
+              break
+            end
+          rescue EOFError, Errno::ECONNRESET => e
+            # Try again in response to the above error types
+            next
+          end
+        end
+      end
+    end
+
+    def running?
+      status = `docker compose -f #{UriService.root.join(docker_compose_file_path)} ps`
+      status.split("n").count > 1
+    end
+
+    task :setup_config_files do
+      docker_compose_template_dir = UriService.root.join('docker/templates')
+      docker_compose_dest_dir = UriService.root.join('docker')
+      Dir.foreach(docker_compose_template_dir) do |entry|
+        next unless entry.end_with?('.yml')
+        src_path = File.join(docker_compose_template_dir, entry)
+        dst_path = File.join(docker_compose_dest_dir, entry.gsub('.template', ''))
+        if File.exist?(dst_path)
+          puts Rainbow("File already exists (skipping): #{dst_path}").blue.bright + "\n"
+        else
+          FileUtils.cp(src_path, dst_path)
+          puts Rainbow("Created file at: #{dst_path}").green
+        end
+      end
+    end
+
+    task :start do
+      puts "Starting...\n"
+      if running?
+        puts "\nAlready running."
+      else
+        # NOTE: This command rebuilds the container images before each run, to ensure they're
+        # always up to date. In most cases, the overhead is minimal if the Dockerfile for an image
+        # hasn't changed since the last build.
+        `docker compose -f #{docker_compose_file_path} up --build --detach --wait`
+        wait_for_solr_cores_to_load
+        puts "\nStarted."
+      end
+    end
+
+    task :stop do
+      puts "Stopping...\n"
+      if running?
+        puts "\n"
+        `docker compose -f #{UriService.root.join(docker_compose_file_path)} down`
+        puts "\nStopped"
+      else
+        puts "Already stopped."
+      end
+    end
+
+    task :restart do
+      Rake::Task['uri_service:docker:stop'].invoke
+      Rake::Task['uri_service:docker:start'].invoke
+    end
+
+    task :status do
+      puts running? ? 'Running.' : 'Not running.'
+    end
+
+    task :delete_volumes do
+      if running?
+        puts 'Error: The volumes are currently in use. Please stop the docker services before deleting the volumes.'
+        next
+      end
+
+      puts Rainbow("This will delete ALL Solr data for the selected app "\
+        "environment (#{ENV['APP_ENV']}) and cannot be undone. Please confirm that you want to continue "\
+        "by typing the name of the selected Rails environment (#{ENV['APP_ENV']}):").red.bright
+      print '> '
+      response = ENV['app_env_confirmation'] || $stdin.gets.chomp
+
+      puts ""
+
+      if response != ENV['APP_ENV']
+        puts "Aborting because \"#{ENV['APP_ENV']}\" was not entered."
+        next
+      end
+
+      config = docker_compose_config
+      volume_prefix = config['name']
+      full_volume_names = config['volumes'].keys.map { |short_name| "#{volume_prefix}_#{short_name}" }
+
+      full_volume_names.map do |full_volume_name|
+        if JSON.parse(Open3.capture3("docker volume inspect '#{full_volume_name}'")[0]).length.positive?
+          `docker volume rm '#{full_volume_name}'`
+          puts Rainbow("Deleted: #{full_volume_name}").green
+        else
+          puts Rainbow("Skipped: #{full_volume_name} (already deleted)").blue.bright
+        end
+      end
+
+      puts 'Done.'
+    end
+  end
+end

data/lib/uri_service/client.rb

@@ -96,7 +96,7 @@ class UriService::Client
   def test_connection
     @db.test_connection # Raises Sequel::DatabaseConnectionError if connection didn't work
     @rsolr_pool.with do |rsolr|
-      rsolr.get('admin/ping') # Raises Errno::ECONNREFUSED if connection didn't work
+      rsolr.get('admin/system') # Raises Errno::ECONNREFUSED if connection didn't work
     end
   end
 

data/lib/uri_service/version.rb

@@ -1,9 +1,9 @@
 module UriService
-  
-  VERSION = '0.5.6'
-  
+
+  VERSION = '0.6.0'
+
   def self.version
     VERSION
   end
-  
-end
+
+end

data/lib/uri_service.rb

@@ -6,36 +6,35 @@ require 'uri'
 require 'yaml'
 
 module UriService
-  
   # Constants
   VOCABULARY = :vocabulary
   VOCABULARIES = :vocabularies
   TERM = :term
   TERMS = :terms
   VALID_URI_REGEX = /\A#{URI::regexp}\z/
-  
+
   # Initialize the main instance of UriService::Client
   # opts format: { 'local_uri_base' => 'http://id.example.com/term/', temporary_uri_base: 'temporary:', 'solr' => {...solr config...}, 'database' => {...database config...} }
   def self.init(opts)
     if @client && @client.connected?
       @client.disconnect!
     end
-    
+
     @client = UriService::Client.new(opts)
   end
 
   def self.client
     return @client
   end
-  
+
   def self.version
     return UriService::VERSION
   end
-  
+
   def self.required_tables
     return [UriService::VOCABULARIES, UriService::TERMS]
   end
-  
+
   # Wrapper around escape method for different versions of RSolr
   def self.solr_escape(str)
     if RSolr.respond_to?(:solr_escape)
@@ -44,11 +43,14 @@ module UriService
       return RSolr.escape(str) # Fall back to older method
     end
   end
-  
+
+  def self.root
+    Pathname.new(File.dirname(__dir__))
+  end
 end
 
 require "uri_service/version"
 require "uri_service/term_type"
 require "uri_service/client"
 
-require 'uri_service/railtie' if defined?(Rails)
+require 'uri_service/railtie' if defined?(Rails)

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: uri_service
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.0
 platform: ruby
 authors:
 - Eric O'Hanlon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rsolr
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.26.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.26.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: connection_pool
+  name: rdf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rsolr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,89 +67,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rdf
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.26.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.26.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: jettywrapper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: jettywrapper
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.18
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.18
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.18
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: A service for registering local URIs and performing both local and remote
   URI lookups.
 email: elo2112@columbia.edu
@@ -175,6 +189,7 @@ files:
 - lib/tasks/uri_service.rake
 - lib/tasks/uri_service/ci.rake
 - lib/tasks/uri_service/db.rake
+- lib/tasks/uri_service/docker.rake
 - lib/tasks/uri_service/solr.rake
 - lib/uri_service.rb
 - lib/uri_service/client.rb
@@ -185,7 +200,7 @@ homepage: https://github.com/cul/uri_service
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -200,9 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: A service for registering local URIs and performing both local and remote
   URI lookups.