meilisearch 0.18.1 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6309d55fa663d9fd8126c1bbf290313ddab29e0e8e72ee690b0abe49887d6097
-  data.tar.gz: 2386993d60f7fa52c38e10d58e191a0f0797a3672de31a36b5c1013440285584
+  metadata.gz: 9b69f3c0d8bf43393b59abe4e44aabf40ff673dd08bde8f6e60d1c996be8b7bf
+  data.tar.gz: d2ff90fe7e1cf738dc4e3297cf7e7215e80c7a63317d06144681fab39206d1b2
 SHA512:
-  metadata.gz: d50aa62ffebcd4d707fc55471e8738d9dd53433c77af3f1bb08e3681395ee19eb35513bc14a1e769bf223a9e16622805dc1010d06b4b84c2252237d1eb5a8b97
-  data.tar.gz: fff2a910e52b6c137037c3b011ddba3b0d11d28fd2427c1b4d45e925e2b28711c4e0fca269309de9b97dd99df980e4ed067b322c7148c0fde68a14ce4fe7d388
+  metadata.gz: 59dfc2b7ced1fec8a75c32b4b02b49d42a8a63af862bcb86931692be8e9c92b89657b93958c150937ddbe295d645eff5192a181ef439885462c2f6174c1519c3
+  data.tar.gz: 71b81d762f8c609a7e2d50ac0052e6c8e0b904c28b2cb7b98f0c55934122c97c1160a4c0b4a2659adcf474a59be85ea609a75183e69550ca4971d177afb8e2b0

data/README.md

@@ -198,7 +198,7 @@ JSON output:
 
 ## 🤖 Compatibility with Meilisearch
 
-This package only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
+This package only guarantees the compatibility with the [version v0.26.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.26.0).
 
 ## 💡 Learn More
 

data/lib/meilisearch/client.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'meilisearch/http_request'
-
 module MeiliSearch
   class Client < HTTPRequest
+    include MeiliSearch::TenantToken
+
     ### INDEXES
 
     def raw_indexes

data/lib/meilisearch/error.rb

@@ -62,4 +62,10 @@ module MeiliSearch
       super(@message)
     end
   end
+
+  module TenantToken
+    class ExpireOrInvalidSignature < StandardError; end
+    class InvalidApiKey < StandardError; end
+    class InvalidSearchRules < StandardError; end
+  end
 end

data/lib/meilisearch/tenant_token.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  module TenantToken
+    HEADER = {
+      typ: 'JWT',
+      alg: 'HS256'
+    }.freeze
+
+    def generate_tenant_token(search_rules, api_key: nil, expires_at: nil)
+      signature = retrieve_valid_key!(api_key, @api_key)
+      expiration = validate_expires_at!(expires_at)
+      rules = validate_search_rules!(search_rules)
+      unsigned_data = build_payload(expiration, rules, signature)
+
+      combine(unsigned_data, to_base64(sign_data(signature, unsigned_data)))
+    end
+
+    private
+
+    def build_payload(expiration, rules, signature)
+      payload = {
+        searchRules: rules,
+        apiKeyPrefix: signature[0..7],
+        exp: expiration
+      }
+
+      combine(encode(HEADER), encode(payload))
+    end
+
+    def validate_expires_at!(expires_at)
+      return unless expires_at
+      return expires_at.to_i if expires_at.utc? && expires_at > Time.now.utc
+
+      raise
+    rescue StandardError
+      raise ExpireOrInvalidSignature
+    end
+
+    def validate_search_rules!(data)
+      return data if data
+
+      raise InvalidSearchRules
+    end
+
+    def retrieve_valid_key!(*keys)
+      key = keys.compact.find { |k| !k.empty? }
+
+      raise InvalidApiKey if key.nil?
+
+      key
+    end
+
+    def sign_data(key, msg)
+      OpenSSL::HMAC.digest('SHA256', key, msg)
+    end
+
+    def to_base64(data)
+      Base64.urlsafe_encode64(data, padding: false)
+    end
+
+    def encode(data)
+      to_base64(JSON.generate(data))
+    end
+
+    def combine(*parts)
+      parts.join('.')
+    end
+  end
+end

data/lib/meilisearch/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MeiliSearch
-  VERSION = '0.18.1'
+  VERSION = '0.18.2'
 
   def self.qualified_version
     "Meilisearch Ruby (v#{VERSION})"

data/lib/meilisearch.rb

@@ -2,6 +2,8 @@
 
 require 'meilisearch/version'
 require 'meilisearch/utils'
+require 'meilisearch/http_request'
+require 'meilisearch/tenant_token'
 require 'meilisearch/task'
 require 'meilisearch/client'
 require 'meilisearch/index'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.18.2
 platform: ruby
 authors:
 - Meili
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,6 +44,7 @@ files:
 - lib/meilisearch/http_request.rb
 - lib/meilisearch/index.rb
 - lib/meilisearch/task.rb
+- lib/meilisearch/tenant_token.rb
 - lib/meilisearch/utils.rb
 - lib/meilisearch/version.rb
 homepage: https://github.com/meilisearch/meilisearch-ruby