mongodb_meilisearch 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c07c25d10efdfee292401ba54dacb34aee8abd153226a3618a2c88de96661dc
-  data.tar.gz: 40ec770c86ab522f3cf49ff950230a8f82f6527d4a3b33842f8d56c12f47067a
+  metadata.gz: bd055e2a0c8c754e3fe7d6b770217b65eb6552b5ff9099b5b9c05d052b5de32d
+  data.tar.gz: a79a6b7980a4b809c6e868344fc41ecc512e75a3a30c5a129e5d6f1099a9b667
 SHA512:
-  metadata.gz: db89325982a30521bec7fcaee27f0da61a177b7738591dbf0b95c36666f3a02e94a85e3403a7c2b81a92d0396839b1344dc7c63a4a4ae937793c743bcbb26e4f
-  data.tar.gz: 05415b71991b53ff28ab4c10e5c3b9ea27ef7399f1c91d1e0444974469b9649d24191ec0438a91045438c95207fa4dcf6f4c4ea545008e5d30b52574daf5752b
+  metadata.gz: bf63ed5f1e2efc95b194efe8bbcb0c53d615f8f65d4c9774a4e3aa559408d515e2152940f6a49b43ae0a9840a27615f045577ca30341c5bc6249a92adac8d258
+  data.tar.gz: 13a2adbc8f06838f184d431ac0c523f7bc24987abb32485109ce994fa2780ba2491e676f5d49afec035209b1560d7419644838e3879fee21aeca2e403e9012c2

data/Gemfile.lock

@@ -1,74 +1,15 @@
 PATH
   remote: .
   specs:
-    mongodb_meilisearch (2.0.0)
+    mongodb_meilisearch (2.2.0)
       meilisearch
-      mongoid (~> 7.0)
-      rails
+      mongoid (>= 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.6)
-      actionpack (= 7.0.6)
-      activesupport (= 7.0.6)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.6)
-      actionpack (= 7.0.6)
-      activejob (= 7.0.6)
-      activerecord (= 7.0.6)
-      activestorage (= 7.0.6)
-      activesupport (= 7.0.6)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.6)
-      actionpack (= 7.0.6)
-      actionview (= 7.0.6)
-      activejob (= 7.0.6)
-      activesupport (= 7.0.6)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.6)
-      actionview (= 7.0.6)
-      activesupport (= 7.0.6)
-      rack (~> 2.0, >= 2.2.4)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.6)
-      actionpack (= 7.0.6)
-      activerecord (= 7.0.6)
-      activestorage (= 7.0.6)
-      activesupport (= 7.0.6)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.6)
-      activesupport (= 7.0.6)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.6)
-      activesupport (= 7.0.6)
-      globalid (>= 0.3.6)
     activemodel (7.0.6)
       activesupport (= 7.0.6)
-    activerecord (7.0.6)
-      activemodel (= 7.0.6)
-      activesupport (= 7.0.6)
-    activestorage (7.0.6)
-      actionpack (= 7.0.6)
-      activejob (= 7.0.6)
-      activerecord (= 7.0.6)
-      activesupport (= 7.0.6)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
     activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -76,18 +17,12 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     bson (4.15.0)
-    builder (3.2.4)
     concurrent-ruby (1.2.2)
-    crass (1.0.6)
-    date (3.3.3)
     debug (1.8.0)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    erubi (1.12.0)
-    globalid (1.1.0)
-      activesupport (>= 5.0)
     httparty (0.21.0)
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
@@ -98,18 +33,8 @@ GEM
       reline (>= 0.3.6)
     json (2.6.3)
     lefthook (1.4.5)
-    loofah (2.21.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.2)
     meilisearch (0.24.0)
       httparty (>= 0.17.1, < 0.22.0)
-    method_source (1.0.0)
     mini_mime (1.1.2)
     minitest (5.18.1)
     mongo (2.19.0)
@@ -119,58 +44,12 @@ GEM
       mongo (>= 2.10.5, < 3.0.0)
       ruby2_keywords (~> 0.0.5)
     multi_xml (0.6.0)
-    net-imap (0.3.6)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.1)
-      timeout
-    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)
-      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
       racc
     racc (1.7.1)
-    rack (2.2.7)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails (7.0.6)
-      actioncable (= 7.0.6)
-      actionmailbox (= 7.0.6)
-      actionmailer (= 7.0.6)
-      actionpack (= 7.0.6)
-      actiontext (= 7.0.6)
-      actionview (= 7.0.6)
-      activejob (= 7.0.6)
-      activemodel (= 7.0.6)
-      activerecord (= 7.0.6)
-      activestorage (= 7.0.6)
-      activesupport (= 7.0.6)
-      bundler (>= 1.15.0)
-      railties (= 7.0.6)
-    rails-dom-testing (2.1.1)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.0.6)
-      actionpack (= 7.0.6)
-      activesupport (= 7.0.6)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
     rainbow (3.1.1)
-    rake (13.0.6)
     regexp_parser (2.8.1)
     reline (0.3.6)
       io-console (~> 0.5)
@@ -210,18 +89,13 @@ GEM
       rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    thor (1.2.2)
-    timeout (0.4.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    websocket-driver (0.7.5)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.8)
 
 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.2.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,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mongodb_meilisearch
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - masukomi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-16 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: meilisearch
   requirement: !ruby/object:Gem::Requirement
@@ -42,14 +28,14 @@ dependencies:
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
@@ -188,7 +174,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