solr_cloud-connection 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4b1ea9a7eade492c2e88434c38dadc43bcbb5a28084c4be797ce2c77eb70ce
-  data.tar.gz: 5531b66702ac408e0631239568035f2693cbda02b06e5401b858caa3bd633d9f
+  metadata.gz: da67e9a6312ae058259368a9933abe711d1c0554337c59c5f688cf2f17cee606
+  data.tar.gz: 36b815217b2f3e806d9b639d4839f093d61327ee496fee1c3d4774039c688e48
 SHA512:
-  metadata.gz: b6fcb28bcf8a42191ce737b4c5ae431d669a66e92b3a2d947e26c7901f3a9b5ec0afd4353d00bf6db4ae397a10c4c8aee629c366fbb6976595170b47b7cf1e2a
-  data.tar.gz: c8689a6b34f2ba3307ac1bfd19adf2c5fff13ecfd7b6aa2fc934754c9667569b369fddfcb4f796528d3594d5babf3213c603a9871cb92edbbb28a6f78e45e006
+  metadata.gz: c828e6c7f7976cee46ac7b81c8955d2253253e3084e3841e26a502bf2d03808327578e69e63a47c0907dd7d38df3db27747a2383a6e8a6f9f4b1a73c69832340
+  data.tar.gz: 25548a6825b308a62ec376bf1b59d596a557c8508f9feeb56cabd5bc402907ecf4f7602658c5087483424844d1fffddf2c7673ecc2f16cefb3ad79f03696aba5

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.5.0] - 2025-03-24
+- Added some sugar for unifying aliases and collections
+- Update tests
+- Better errors
+- Flesh out README.md to be a useful document
+
+
 ## [0.4.0] - 2023-12-07
 - Fixed rules about what names are legal collections/configsets/aliases
 - Update version and changelog

data/README.md

@@ -1,14 +1,36 @@
 # SolrCloud::Connection
 
-Do basic administrative tasks on a running Solr cloud instance, including:
+## Common usage
 
-* create (i.e., upload) a configSet when given a `conf` directory
-* list, create, and delete configsets, collections, and aliases
-* get basic version information for the running solr
-* check on the health of individual collections
-* treat an alias (mostly) as a collection
-* TODO automatically generate methods to talk to defined requestHandlers
-* TODO Add something useful for configsets to do
+```ruby
+
+# Connect to the server, upload a config set, make a collection based on it,
+# and make an alias pointing to that collection
+
+server = SolrCloud::Connection.new(url: url, user: user, password: pass) 
+cfg = server.create_configset(name: "my_cfg", confdir: "/path/to/my/conf")
+cars_v1 = server.create_collection(name: "cars_v1", configset: "my_cfg")
+cars = cars_v1.alias_as("cars")
+
+```
+
+## Basic functionality / Roadmap
+
+Do basic administrative tasks on a running Solr cloud instance
+
+* [x] create (i.e., upload) a configSet when given a `conf` directory
+* [x] list, create, and delete configsets, collections, and aliases
+* [x] get basic version information for the running solr
+* [x] check on the health of individual collections
+* [x] treat an alias (mostly) as a collection
+* [ ] automatically generate methods to talk to defined requestHandlers and updateHandlers
+* [ ] provide a way to talk to the analyzer for testing of fieldTypes
+* [ ] hook into the schema API
+* [ ] allow it to work with cores, and not just solrcloud collections (which, you know bad naming then)
+* [ ] figure out how to deal with managed resources
+* [ ] get info from updateHandler metrics, esp. pending documents and cumulative errors
+* [ ] hook into performance metrics for easy reporting and checks
+* [ ] support more of the v2 API 
 
 In almost all cases, you can treat an alias to a collection like the underlying collection. 
 
@@ -43,6 +65,8 @@ user = "solr"
 password = "SolrRocks"
 config_directory = "/path/to/myconfig/conf" # Directory 'conf' contains solrconfig.xml
 
+require "solr_cloud/connection"
+
 server = SolrCloud::Connection.new(url: url, user: user, password: pass) 
   #=> <SolrCloud::Connection http://localhost:9090>
 
@@ -66,19 +90,25 @@ server.configset_names #=> ["_default"]
 
 # Create a new configset by taking a conf directory, zipping it up,
 # and sending it to solr
-cset = server.create_configset(name: "horseless", confdir: config_directory) #=> <SolrCloud::Configset 'horseless' at http://localhost:9090>
+cset = server.create_configset(name: "horseless", confdir: config_directory)
+  #=> <SolrCloud::Configset 'horseless' at http://localhost:9090>
 server.configset_names #=> ["_default", "horseless"]
 
 # That's a dumb name for a config set. Delete it and try again.
 cset.delete! #=> <SolrCloud::Connection http://localhost:9090>
-cset = server.create_configset(name: "cars_cfg", confdir: config_directory) #=> <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>
-server.configsets #=> [<SolrCloud::Configset '_default' at http://localhost:9090>, <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>]
+cset = server.create_configset(name: "cars_cfg", confdir: config_directory)
+  #=> <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>
+server.configsets
+  #=> [<SolrCloud::Configset '_default' at http://localhost:9090>,
+  #    <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>]
 
 # Can't be overwritten by accident
-server.create_configset(name: "cars_cfg", confdir: config_directory) #=> raised #<SolrCloud::WontOverwriteError: Won't replace configset cars_cfg unless 'force: true' passed >
+server.create_configset(name: "cars_cfg", confdir: config_directory)
+  #=> raised #<SolrCloud::WontOverwriteError: Won't replace configset cars_cfg unless 'force: true' passed >
 
 # But you can force it
-server.create_configset(name: "cars_cfg", confdir: config_directory, force: true) #=> <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>
+server.create_configset(name: "cars_cfg", confdir: config_directory, force: true)
+  #=> <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>
 
 cfg = server.get_configset("cars_cfg") #=> <SolrCloud::Configset 'cars_cfg' at http://localhost:9090>
 cfg.in_use? #=> false
@@ -127,7 +157,8 @@ cars_v1.aliased? #=> true
 
 cars_v1.has_alias?("cars") #=> true
 cars_v1.alias_as("autos") #=> <SolrCloud::Alias 'autos' (alias of 'cars_v1')>
-cars_v1.aliases #=> [<SolrCloud::Alias 'cars' (alias of 'cars_v1')>, <SolrCloud::Alias 'autos' (alias of 'cars_v1')>]
+cars_v1.aliases
+  #=> [<SolrCloud::Alias 'cars' (alias of 'cars_v1')>, <SolrCloud::Alias 'autos' (alias of 'cars_v1')>]
 
 cars_v1.get_alias("autos").delete! #=> <SolrCloud::Connection http://localhost:9090>
 cars_v1.aliases #=> [<SolrCloud::Alias 'cars' (alias of 'cars_v1')>]
@@ -226,5 +257,5 @@ This repository is set up to run tests under docker.
 
 ## Contributing
 
-Bugs, functionality suggestions, API suggestions, feature requests, etc. all welcom
+Bugs, functionality suggestions, API suggestions, feature requests, etc. all welcome
 on GitHub at https://github.com/mlibrary/solr_cloud-connection.

data/Rakefile

@@ -10,7 +10,7 @@ require "standard/rake"
 task default: %i[spec standard docs]
 task docs: %i[yard]
 
-require 'yard'
+require "yard"
 
 YARD::Rake::YardocTask.new do |t|
   t.files = ["lib/**/*.rb"] # optional

data/lib/solr_cloud/alias.rb

@@ -41,13 +41,13 @@ module SolrCloud
     # @return [Collection] the now-current collection
     def switch_collection_to(coll)
       collect_name = case coll
-                       when String
-                         coll
-                       when Collection
-                         coll.name
-                       else
-                         raise "Alias#switch_collection_to only takes a name(string) or a collection, not '#{coll}'"
-                     end
+      when String
+        coll
+      when Collection
+        coll.name
+      else
+        raise "Alias#switch_collection_to only takes a name(string) or a collection, not '#{coll}'"
+      end
       raise NoSuchCollectionError unless connection.has_collection?(collect_name)
       connection.create_alias(name: name, collection_name: collect_name, force: true)
     end

data/lib/solr_cloud/collection.rb

@@ -55,10 +55,10 @@ module SolrCloud
 
     def ==(other)
       case other
-        when SolrCloud::Collection
-          self.collection.name == other.collection.name
-        else
-          false
+      when SolrCloud::Collection
+        collection.name == other.collection.name
+      else
+        false
       end
     end
 
@@ -68,7 +68,7 @@ module SolrCloud
     def delete!
       return connection unless exist?
       raise CollectionAliasedError.new("Cannot delete collection #{name}; it has alias(s) #{alias_names.join(", ")}") if aliased?
-      connection.get("solr/admin/collections", { action: "DELETE", name: name })
+      connection.get("solr/admin/collections", {action: "DELETE", name: name})
       connection
     end
 
@@ -181,10 +181,10 @@ module SolrCloud
 
     def add(docs)
       docarray = if docs === Array
-                   docs
-                 else
-                   [docs]
-                 end
+        docs
+      else
+        [docs]
+      end
       post("solr/#{name}/update/") do |r|
         r.body = docarray
       end
@@ -200,10 +200,10 @@ module SolrCloud
     def inspect
       anames = alias_names
       astring = if anames.empty?
-                  ""
-                else
-                  " (aliased by #{anames.map { |x| "'#{x}'" }.join(", ")})"
-                end
+        ""
+      else
+        " (aliased by #{anames.map { |x| "'#{x}'" }.join(", ")})"
+      end
       "<#{self.class} '#{name}'#{astring}>"
     end
 

data/lib/solr_cloud/configset.rb

@@ -7,7 +7,6 @@ module SolrCloud
   # throw an error if that's an illegal operation (because a collection is
   # using it)
   class Configset
-
     # @return [String] the name of this configset
     attr_reader :name
 

data/lib/solr_cloud/connection/alias_admin.rb

@@ -5,7 +5,6 @@ module SolrCloud
     # methods having to do with aliases, to be included by the connection object.
     # These are split out only to make it easier to deal with them.
     module AliasAdmin
-
       # A simple data-class to pair an alias with its collection
       AliasCollectionPair = Struct.new(:alias, :collection)
 
@@ -24,7 +23,7 @@ module SolrCloud
         end
         raise NoSuchCollectionError.new("Can't find collection #{collection_name}") unless has_collection?(collection_name)
         if has_alias?(name) && !force
-          raise WontOverwriteError.new("Alias '#{name}' already points to collection '#{self.get_alias(name).collection.name}'; won't overwrite without force: true")
+          raise WontOverwriteError.new("Alias '#{name}' already points to collection '#{get_alias(name).collection.name}'; won't overwrite without force: true")
         end
         connection.get("solr/admin/collections", action: "CREATEALIAS", name: name, collections: collection_name)
         get_alias(name)
@@ -83,5 +82,3 @@ module SolrCloud
     end
   end
 end
-
-

data/lib/solr_cloud/connection/collection_admin.rb

@@ -20,17 +20,16 @@ module SolrCloud
       # @raise [WontOverwriteError] if the collection already exists
       # @return [Collection] the collection created
       def create_collection(name:, configset:, shards: 1, replication_factor: 1)
-
         unless legal_solr_name?(name)
           raise IllegalNameError.new("'#{name}' is not a valid solr name. Use only ASCII letters/numbers, dash, and underscore")
         end
 
         configset_name = case configset
-                           when Configset
-                             configset.name
-                           else
-                             configset.to_s
-                         end
+        when Configset
+          configset.name
+        else
+          configset.to_s
+        end
         raise WontOverwriteError.new("Collection #{name} already exists") if has_collection?(name)
         raise NoSuchConfigSetError.new("Configset '#{configset_name}' doesn't exist") unless has_configset?(configset_name)
 

data/lib/solr_cloud/connection/configset_admin.rb

@@ -7,7 +7,6 @@ module SolrCloud
     # methods having to do with configsets, to be included by the connection object.
     # These are split out only to make it easier to deal with them.
     module ConfigsetAdmin
-
       # Given the path to a solr configuration "conf" directory (i.e., the one with
       # solrconfig.xml in it), zip it up and send it to solr as a new configset.
       # @param name [String] Name to give the new configset

data/lib/solr_cloud/connection/version.rb

@@ -2,6 +2,6 @@
 
 module SolrCloud
   class Connection
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/solr_cloud/connection.rb

@@ -31,12 +31,20 @@ module SolrCloud
     # @return [String] String representation of the URL to solr
     attr_reader :url
 
+    # @return [String] solr user
+    attr_reader :user
+    alias_method :username, :user
+
+    # @return [String] Solr password
+    attr_reader :password
+
     # @return [#info] The logger
     attr_reader :logger
 
     # @return [Faraday::Connection] the underlying Faraday connection
     attr_reader :connection
 
+
     # let the underlying connection handle HTTP verbs
 
     # @!method get
@@ -72,12 +80,12 @@ module SolrCloud
       @user = user
       @password = password
       @logger = case logger
-                  when :off, :none
-                    Logger.new(File::NULL, level: Logger::FATAL)
-                  when nil
-                    Logger.new($stderr, level: Logger::WARN)
-                  else
-                    logger
+                when :off, :none
+                  Logger.new(File::NULL, level: Logger::FATAL)
+                when nil
+                  Logger.new($stderr, level: Logger::WARN)
+                else
+                  logger
                 end
       @connection = create_raw_connection(url: url, adapter: adapter, user: user, password: password, logger: @logger)
       bail_if_incompatible!
@@ -112,10 +120,6 @@ module SolrCloud
       end
     end
 
-    # Allow accessing the raw_connection via "connection". Yes, connection.connection
-    # can be confusing, but it makes the *_admin stuff easier to read.
-    alias_method :connection, :connection
-
     # Check to see if we can actually talk to the solr in question
     # raise [UnsupportedSolr] if the solr version isn't at least 8
     # raise [ConnectionFailed] if we can't connect for some reason
@@ -192,6 +196,3 @@ module SolrCloud
     end
   end
 end
-
-
-

data/readme.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "pathname"
 $LOAD_PATH.unshift Pathname.new(__dir__) + "lib"
 require_relative "lib/solr_cloud/connection"
@@ -7,13 +8,11 @@ url = "http://localhost:9090"
 user = "solr"
 pass = "SolrRocks"
 
-
 server = SolrCloud::Connection.new(url: url, user: user, password: pass) #=>
 
-
-server.aliases.each {|a| a.delete!}
-server.collections.each {|c| c.delete!}
-server.configsets.reject {|c| c.name == "_default"}.each {|c| c.delete!}
+server.aliases.each { |a| a.delete! }
+server.collections.each { |c| c.delete! }
+server.configsets.reject { |c| c.name == "_default" }.each { |c| c.delete! }
 
 # or bring your own Faraday object
 # server2 = SolrCloud::Connection.new_with_faraday(faraday_connection)
@@ -83,8 +82,6 @@ begin
 rescue
 end
 
-
-
 ##### Aliases
 
 # We'll want to alias it so we can just use 'cars'
@@ -125,9 +122,6 @@ cars.switch_collection_to("cars_v1")
 server.collection_names
 
 # They even == to each other
-cars
-cars == cars_v1
-cars == cars_v2
 
 # But sometimes you want to differentiate them from each other
 server.only_collection_names

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_cloud-connection
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Bill Dueber
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,75 +53,107 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.35.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.35.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description:
 email:
 - bill@dueber.com
@@ -170,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Do basic administrative operations on a solr cloud instance and collections