grape-listing 1.1.9 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4640c1fef7edd90ba2d131032ba1f8ee8d5edf276d8a703f114b7d944e0ef52
-  data.tar.gz: c5cccf46f30fddf0fa7bf7b9f128e42fc6a6fe3291c941a302ea4c440e34e726
+  metadata.gz: 42151a397fe1355931f6dcd0c63fb939c3243946fd74d740917a7baade052cc3
+  data.tar.gz: a05d65e9c19e8e6a842b4e6de0d35beababfab88199542a1f1c91c0bc4fddf60
 SHA512:
-  metadata.gz: 96658857f1c6b6f2eecc2b45417c2240dad18880ae87dd6e0d9522f468fcda24ab50bfc9cb20762166e664f0a1b2f78739122c8c5041783914a7ef4c9f8e7478
-  data.tar.gz: 38681ed959270122c72573669b9ba6d92bf534adace4b99ee948e1f2e25580e9d9da6056229c3484a23a53f21c735c1d93414714c5c6ec42617be32cbec70c64
+  metadata.gz: 1aff012b41a15c19efe96e9256901cfd865184f7db29bf39b1e28bbac9aa3b9a631f636d1fb5c14820a3e6dd599422c4060b662bd63b977f092fd3a4d482af06
+  data.tar.gz: 1d958d8fdbfc3035f7518cb560262ff04a0dea151f42dd160af7c1c88dd1d029060c9711f73f16f16092b73bf189ad865b5e77d0f6a889bd5ab2f9b84d5e50af

data/README.md

@@ -26,8 +26,7 @@ bundle
 ```ruby
 get 'users' do
   listing model: User,
-          entity: UserEntity,
-          search: %w[email name|ilike role|custom.for_role]
+          entity: UserEntity
 end
 
 ```
@@ -52,7 +51,24 @@ end
 
 ### Поиск
 
-Для поиска по полям необходимо передать их в запросе в виде `?field=value`. Для поиска по нескольким полям, параметры должны быть перечислены через `&`, например: `?field_1=value&field_2=value`.
+Для возможности поиска необходимо передать названия полей, по которым может осуществляться поиск, в виде массива в опции `search`.
+
+Для осуществления фильтрации необходимо передать параметры в запросе в виде `?field=value`. Для поиска по нескольким полям, параметры должны быть перечислены через `&`, например: `?field_1=value&field_2=value`.
+
+В общем случае, названия полей соответствуют названиями параметров (например поле `name` и параметр `name`).
+
+Пример использования с осуществлением поиска по полю `name` с полным совпадением:
+
+```ruby
+get 'users' do
+  listing model: User,
+          entity: UserEntity,
+          search: %w[name]
+end
+```
+```
+GET http://localhost:3000/api/users?name=Ivan
+```
 
 ### Сортировка
 

data/lib/grape/dsl.rb

@@ -1,3 +1,5 @@
+require 'addressable/uri'
+
 module Grape
   module DSL
     module InsideRoute

data/lib/listing_service/args_handling.rb

@@ -69,6 +69,13 @@ module GrapeListing
     end
 
     def count_cache_key
+      # необходимо убрать параметры offset и page из uri
+      uri_path, params = @request_uri.split('?')
+      if params
+        params = Rack::Utils.parse_query(params).except('offset', 'page')
+        @request_uri = params.present? ? "#{uri_path}?#{Rack::Utils.build_query(params)}" : uri_path
+      end
+
       # пример: "GET api/v1/users?active=true"
       body = "#{@request_method} #{@request_uri}"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-listing
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.1.11
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack