mongodb_meilisearch 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c07c25d10efdfee292401ba54dacb34aee8abd153226a3618a2c88de96661dc
-  data.tar.gz: 40ec770c86ab522f3cf49ff950230a8f82f6527d4a3b33842f8d56c12f47067a
+  metadata.gz: f94879936fd02812f5a9e9887ce71774edf2049f5b03610196e8a25af558e32c
+  data.tar.gz: 1078bb0b874e10957d95a5583423a22304fba95b6016f4115407dee6c4c9bee2
 SHA512:
-  metadata.gz: db89325982a30521bec7fcaee27f0da61a177b7738591dbf0b95c36666f3a02e94a85e3403a7c2b81a92d0396839b1344dc7c63a4a4ae937793c743bcbb26e4f
-  data.tar.gz: 05415b71991b53ff28ab4c10e5c3b9ea27ef7399f1c91d1e0444974469b9649d24191ec0438a91045438c95207fa4dcf6f4c4ea545008e5d30b52574daf5752b
+  metadata.gz: f41b528068bf5bd587e399ab71f502dcbf9ccdb4f8b4c1c282448335f0f4bc98a69372345f205c536c27e88585bfaa080d1f8c76b42ceac396aa5c8f9ae478f0
+  data.tar.gz: f594659bcdd20c7e0a2cdebfc30731d17f3e82abf681a2bc343f92b98f2f204b42e3193653b2af11ff1fa517d54f02fc51a26a10073ee07616e0437b8b1d82e4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongodb_meilisearch (2.0.0)
+    mongodb_meilisearch (2.1.0)
       meilisearch
       mongoid (~> 7.0)
       rails
@@ -111,6 +111,7 @@ GEM
       httparty (>= 0.17.1, < 0.22.0)
     method_source (1.0.0)
     mini_mime (1.1.2)
+    mini_portile2 (2.8.7)
     minitest (5.18.1)
     mongo (2.19.0)
       bson (>= 4.14.1, < 5.0.0)
@@ -129,9 +130,8 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.15.3-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.3-x86_64-linux)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
@@ -222,6 +222,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/README.org

@@ -97,6 +97,33 @@ This will return a hash with the keys you'll need.
 
 Use those keys in your environment. The next time the =Search::Client= is initialized it'll use them.
 
+***** Validating Search & Admin keys
+When switching between Meilisearch instances the same master key doesn't result in the same default admin and search keys. Being able to easily validate this is useful in situations like testing code against Meilisearch instances that are inside a Docker container /and/ in the Host OS.
+
+Practically speaking you may want to simply /not/ provide these keys during development, and only use the =MEILI_MASTER_KEY=. Just be sure to include them when talking to a production instance.
+
+#+begin_src ruby
+Search::Client.instance.validate_default_keys(ENV['MEILI_MASTER_KEY'])
+#+end_src
+
+This returns a hash like the following.
+
+- =status= is always either ="provided"= or ="missing"= and indicates if the =MEILISEARCH_SEARCH_KEY= or =MEILISEARCH_ADMIN_KEY= were found in the environment.
+- =matches= is always either =true= or =false=, and indicates if the provided Search & Admin keys (if any) match the defaults the current instance is returning.
+
+#+begin_src ruby
+{
+  :search_key=>{
+   :status=>"provided",
+   :matches=>true
+  },
+  :admin_key=>{
+    :status=>"provided",
+    :matches=>true
+  }
+}
+#+end_src
+
 ** Model Integration
 Add the following near the top of your model. Only the =extend= and
 =include= lines are required. This assumes your model also includes
@@ -611,9 +638,9 @@ but not share all your source.
 
 ** Code of Conduct
 Everyone interacting in this project's codebases, issue trackers, chat
-rooms and mailing lists is expected to follow the
-[[https://github.com/masukomi/mongodb_meilisearch/blob/main/CODE_OF_CONDUCT.md][code
-of conduct]].
+rooms and mailing lists is expected to follow the [[https://github.com/masukomi/mongodb_meilisearch/blob/main/CODE_OF_CONDUCT.md][code of conduct]].
+
+It is furthermore /fully/ acknowledged that "master" is a problematic term that shouldn't be used. However, we're stuck with it until Meilisearch changes the name of that key.
 
 * Footnotes
 [fn:macos] MacOS users I have not found a way to successfully automatically Meilisearch with launchctl (brew services uses this) that allows it to see the ~MEILI_MASTER_KEY~ environment variable. As such, I can /not/ recommend using launchctl for running Meilisearch. Running it without a master key only works in development mode, and introduces complications.

data/lib/mongodb_meilisearch/version.rb

@@ -5,5 +5,5 @@ module MongodbMeilisearch
   # @note This library will adhere to strict semantic versioning.
   # See https://semver.org/
   #
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/search/client.rb

@@ -6,10 +6,17 @@ module Search
     include Singleton
     attr_reader :admin_client, :search_client
     attr_accessor :logger
+    MASTER_KEY          = "MEILI_MASTER_KEY".freeze
+    SEARCH_KEY          = "MEILISEARCH_SEARCH_KEY".freeze
+    ADMIN_KEY           = "MEILISEARCH_ADMIN_KEY".freeze
+    URL_KEY             = "MEILISEARCH_URL".freeze
+    TIMEOUT_KEY         = "MEILISEARCH_TIMEOUT".freeze
+    MAX_RETRIES_KEY     = "MEILISEARCH_MAX_RETRIES".freeze
+    SEARCH_ENABLED_KEY = "SEARCH_ENABLED".freeze
 
     def initialize
       @logger = default_logger
-      if ENV.fetch("SEARCH_ENABLED", "true") == "true"
+      if ENV.fetch(SEARCH_ENABLED_KEY, "true") == "true"
         initialize_clients
         # WARNING: ⚠ clients MAY be nil depending on what api keys were provided
         # In this case rails logger warnings and/or errors will have already
@@ -20,7 +27,7 @@ module Search
           )
         end
       else
-        @logger.info("SEARCH_ENABLED is not \"true\" - mongodb_meilisearch NOT initialized")
+        @logger.info("#{SEARCH_ENABLED_KEY} is not \"true\" - mongodb_meilisearch NOT initialized")
       end
     end
 
@@ -45,8 +52,8 @@ module Search
 
     def initialize_clients
       # see what env vars they've configured
-      search_api_key = ENV.fetch("MEILISEARCH_SEARCH_KEY", nil)
-      admin_api_key  = ENV.fetch("MEILISEARCH_ADMIN_KEY", nil)
+      search_api_key = ENV.fetch(SEARCH_KEY, nil)
+      admin_api_key  = ENV.fetch(ADMIN_KEY, nil)
       search_api_key = nil if search_api_key == ""
       admin_api_key = nil if admin_api_key == ""
 
@@ -98,12 +105,12 @@ module Search
 
     def master_client(master_api_key = nil)
       master_api_key = nil if master_api_key == ""
-      master_api_key ||= ENV.fetch("MEILI_MASTER_KEY", nil)
+      master_api_key ||= ENV.fetch(MASTER_KEY, nil)
       if !url || !master_api_key
 
         unless master_api_key
           @logger.error(
-            "MEILI_MASTER_KEY is not set. Cannot create master client."
+            "#{MASTER_KEY} is not set. Cannot create master client."
           )
         end
 
@@ -112,28 +119,28 @@ module Search
 
       initialize_new_client(
         url: url,
-        api_key: ENV.fetch("MEILI_MASTER_KEY"),
+        api_key: ENV.fetch(MASTER_KEY),
         timeout: timeout,
         max_retries: max_retries
       )
     end
 
     def url
-      maybe_url = ENV.fetch("MEILISEARCH_URL", nil)
+      maybe_url = ENV.fetch(URL_KEY, nil)
       unless maybe_url
         @logger.error(
-          "MEILI_MASTER_KEY is not set. Cannot create master client."
+          "#{MASTER_KEY} is not set. Cannot create master client."
         )
       end
       maybe_url
     end
 
     def timeout
-      ENV.fetch("MEILISEARCH_TIMEOUT", 10).to_i
+      ENV.fetch(TIMEOUT_KEY, 10).to_i
     end
 
     def max_retries
-      ENV.fetch("MEILISEARCH_MAX_RETRIES", 2).to_i
+      ENV.fetch(MAX_RETRIES_KEY, 2).to_i
     end
 
     def get_default_keys(m_c)
@@ -162,6 +169,28 @@ module Search
       response
     end
 
+    # Validates that the keys keys provided for search & admin
+    # correspond to the default keys Meilisearch returns
+    # @param [String] m_c - the Meilisearch Master Key to use.
+    #                 This is most likely found in ENV['MEILI_MASTER_KEY']
+    # @return [Hash[Hash]]
+    def validate_default_keys(m_c)
+      default_keys = get_default_keys(m_c)
+      search_key = ENV.fetch(SEARCH_KEY, nil)
+      admin_key = ENV.fetch(ADMIN_KEY, nil)
+
+      {
+        search_key: {
+          status: search_key.nil? ? "missing" : "provided",
+          matches: default_keys[:search] == search_key
+        },
+        admin_key: {
+          status: admin_key.nil? ? "missing" : "provided",
+          matches: default_keys[:admin] == admin_key
+        }
+      }
+    end
+
     def default_logger
       in_rails = Module.constants.include?(:Rails)
       in_rails ? Rails.logger : Logger.new($stdout)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongodb_meilisearch
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - masukomi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: MeiliSearch integration for MongoDB