search_flip 3.9.0 → 4.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84f5374ca017b59ee706e4e6e06c9739c18a83395ded6df0628b234d0e129e39
-  data.tar.gz: 1f6e1dd1a76f69b8cb552387add7d1dfe2b367739c38a7b9260db0c9954b8e26
+  metadata.gz: b023bc6411647eaecfcb8f5b0fe535379974a0824d49699dd74ef867a67c69eb
+  data.tar.gz: 5dc4a0439f9442811f3966e86b0c6b09d09c54450a04234c3738ae0ab7935900
 SHA512:
-  metadata.gz: 283b816aa7602cb4ffb1c981421e7fb13353158f40de052daec3c6c6700b42ff2b19eeb6accb22b8dcc29cf4589caf8c4a01edd827bc055eb97e16c6ed3ba972
-  data.tar.gz: a63de18588ef4b93c38eb7b4bfb91135f73e027f21371ff46c053dfbadb207661008aa5b31d05ac6e62298539e73cdf5c8421bb6aff93f2369f2712724bcd7f8
+  metadata.gz: a5fc637e8c016531df22af678adcae60a4f4169e5f1d2215d52be0a0dff1111b849cb4d79ca36d6cbf315c8516bc51d543852ab5026339d59cb1f5d08ba356f7
+  data.tar.gz: 7cf9d55a9aca5d6d63401750d40bc656fcc345101d8ce92a300c24649e38810d399d43ff225611bbdd91a257d6cb15eee26a6c811974b987e92e72e67eded704

data/.github/workflows/test.yml

@@ -7,58 +7,28 @@ jobs:
       fail-fast: false
       matrix:
         elasticsearch:
-        - image: plainpicture/elasticsearch:2.4.1_delete-by-query
-          env:
-            discovery.type: single-node
-            xpack.security.enabled: false
-        - image: elasticsearch:5.4
-          env:
-            discovery.type: single-node
-            xpack.security.enabled: false
-        - image: docker.elastic.co/elasticsearch/elasticsearch:6.7.0
-          env:
-            discovery.type: single-node
-            xpack.security.enabled: false
-        - image: docker.elastic.co/elasticsearch/elasticsearch:7.0.0
-          env:
-            discovery.type: single-node
-            xpack.security.enabled: false
-        - image: docker.elastic.co/elasticsearch/elasticsearch:7.11.2
-          env:
-            discovery.type: single-node
-            xpack.security.enabled: false
-        - image: docker.elastic.co/elasticsearch/elasticsearch:8.1.1
-          env:
-            discovery.type: single-node
-            xpack.security.enabled: false
-        - image: opensearchproject/opensearch:1.3.14
-          env:
-            discovery.type: single-node
-            plugins.security.disabled: true
-        - image: opensearchproject/opensearch:2.11.1
-          env:
-            discovery.type: single-node
-            plugins.security.disabled: true
-        - image: opensearchproject/opensearch:2.13.0
-          env:
-            discovery.type: single-node
-            DISABLE_SECURITY_PLUGIN: true
+        - plainpicture/elasticsearch:2.4.1_delete-by-query
+        - elasticsearch:5.4
+        - docker.elastic.co/elasticsearch/elasticsearch:6.7.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.0.0
+        - docker.elastic.co/elasticsearch/elasticsearch:7.9.0
         ruby:
+        - 2.5
+        - 2.6
         - 2.7
-        - 3.0
-        - 3.1
-        - 3.2
     services:
       elasticsearch:
-        image: ${{ matrix.elasticsearch.image }}
-        env: ${{ matrix.elasticsearch.env }}
+        image: ${{ matrix.elasticsearch }}
+        env:
+          discovery.type: single-node
         ports:
           - 9200:9200
     steps:
     - uses: actions/checkout@v1
-    - uses: ruby/setup-ruby@v1
+    - uses: actions/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - run: bundle
+    - run: sleep 10
     - run: bundle exec rspec
     - run: bundle exec rubocop

data/.rubocop.yml

@@ -1,15 +1,11 @@
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.5
-  SuggestExtensions: false
+  TargetRubyVersion: 2.4
 
-Gemspec/RequireMFA:
+Gemspec/RequiredRubyVersion:
   Enabled: false
 
-Layout/EmptyLineBetweenDefs:
-  EmptyLineBetweenClassDefs: false
-
-Gemspec/RequiredRubyVersion:
+Style/CaseLikeIf:
   Enabled: false
 
 Style/ExplicitBlockArgument:

data/CHANGELOG.md

@@ -1,63 +1,13 @@
 
 # CHANGELOG
 
-## v3.9.0
+## v4.0.0
 
-* Allow to configure the elasticsearch version no matter which elasticsearch
-  version is actually in use. The version information is needed to support
-  version dependent features. Please note that manually configuring the version
-  is usually not need as the version by default is determined by sending one
-  request to elasticsearch.
-
-```ruby
-SearchFlip::Config[:version] = { number: "8.1.1" }
-SearchFlip::Config[:version] = { number: "2.13", distribution: "opensearch" }
-```
-
-## v3.8.0
-
-* Support Opensearch 1.x and 2.x
-
-## v3.7.2
-
-* Fix wrong AWS signatures by generating the json before passing it to http-rb
-
-## v3.7.1
-
-* Fix thread-safety issue of http-rb
-
-## v3.7.0
-
-* Add `SearchFlip::Connection#bulk` to allow more clean bulk indexing to
-  multiple indices at once
-
-## v3.6.0
-
-* Support Elasticsearch v8
-
-## v3.5.0
-
-* Add `SearchFlip::Criteria#http_timeout` to allow specifying timeouts on
-  a query level
-
-## v3.4.0
-
-* Expose `Http#timeout` via `SearchFlip::HTTPClient`
-
-## v3.3.0
-
-* Update httprb
-* Changed oj default options
-* Allow to set oj json options
-
-## v3.2.1
-
-* Fix `refresh` having a empty body breaking in elasticsearch 7.11
-
-## v3.2.0
-
-* Fix `index_scope` not being passed in `each_record` without block
-* Added `SearchFlip::Criteria#match_none`
+* [BREAKING] For performance reasons, `SearchFlip::Result` now no longer
+  inherits `Hashie::Mash`
+  * It no longer supports symbol based access like `result[:id]`
+  * It no longer supports question mark methods like `result.title?`
+  * It no longer supports method based assignment like `result.some_key = "value"`
 
 ## v3.1.2
 

data/Gemfile

@@ -2,18 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2")
-  gem "activerecord", ">= 3.0", "< 5"
-else
-  gem "activerecord", ">= 3.0"
-end
-
-gem "aws-sdk-core"
-gem "bundler"
-gem "factory_bot"
-gem "rake"
-gem "rspec"
-gem "rubocop"
-gem "sqlite3", "~> 1.4"
-gem "timecop"
-gem "webmock"
+gem "activerecord", "< 5" if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2")

data/README.md

@@ -9,9 +9,8 @@
 Using SearchFlip it is dead-simple to create index classes that correspond to
 [Elasticsearch](https://www.elastic.co/) indices and to manipulate, query and
 aggregate these indices using a chainable, concise, yet powerful DSL. Finally,
-SearchFlip supports Elasticsearch 2.x, 5.x, 6.x, 7.x and 8.x as well as
-Opensearch 1.x and 2.x. Check section [Feature Support](#feature-support) for
-version dependent features.
+SearchFlip supports Elasticsearch 2.x, 5.x, 6.x, 7.x. Check section
+[Feature Support](#feature-support) for version dependent features.
 
 ```ruby
 CommentIndex.search("hello world", default_field: "title").where(visible: true).aggregate(:user_id).sort(id: "desc")
@@ -52,7 +51,7 @@ CommentIndex.search("hello world").where(available: true).sort(id: "desc").aggre
 
 ```
 
-Finally, SearchFlip comes with a minimal set of dependencies.
+Finally, SearchFlip comes with a minimal set of dependencies (http-rb and oj only).
 
 ## Reference Docs
 
@@ -98,16 +97,6 @@ Available config options are:
 * `auto_refresh` tells SearchFlip to automatically refresh an index after
   import, index, delete, etc operations. This is e.g. useful for testing, etc.
   Defaults to false.
-* `version` allows to configure the elasticsearch version no matter which
-  elasticsearch version is actually in use. The version information is needed to
-  support version dependent features. Please note that manually configuring the
-  version is usually not need as the version by default is determined by sending
-  one request to elasticsearch.
-
-```ruby
-SearchFlip::Config[:version] = { number: "8.1.1" }
-SearchFlip::Config[:version] = { number: "2.13", distribution: "opensearch" }
-```
 
 ## Usage
 
@@ -429,14 +418,6 @@ Simply matches all documents:
 CommentIndex.match_all
 ```
 
-* `match_none`
-
-Simply matches none documents at all:
-
-```ruby
-CommentIndex.match_none
-```
-
 * `all`
 
 Simply returns the criteria as is or an empty criteria when called on the index
@@ -493,8 +474,8 @@ end
 ```
 
 Generally, aggregation results returned by Elasticsearch are returned as a
-`SearchFlip::Result`, which basically is a `Hashie::Mash`, such that you can
-access them via:
+`SearchFlip::Result`, which basically is a Hash with method-like access, such
+that you can access them via:
 
 ```ruby
 query.aggregations(:username)["mrkamel"].revenue.value
@@ -709,14 +690,6 @@ Specify a timeout to limit query processing time:
 CommentIndex.timeout("3s").execute
 ```
 
-* `http_timeout`
-
-Specify a http timeout for the request which will be send to Elasticsearch:
-
-```ruby
-CommentIndex.http_timeout(3).execute
-```
-
 * `terminate_after`
 
 Activate early query termination to stop query processing after the specified
@@ -775,7 +748,7 @@ end
 This allows to use different clusters per index e.g. when migrating indices to
 new versions of Elasticsearch.
 
-You can specify basic auth, additional headers, request timeouts, etc via:
+You can specify basic auth, additional headers, etc via:
 
 ```ruby
 http_client = SearchFlip::HTTPClient.new
@@ -792,9 +765,6 @@ http_client = http_client.via("proxy.host", 8080)
 # Custom headers
 http_client = http_client.headers(key: "value")
 
-# Timeouts
-http_client = http_client.timeout(20)
-
 SearchFlip::Connection.new(base_url: "...", http_client: http_client)
 ```
 
@@ -863,7 +833,7 @@ performance tracing, etc.
 To use instrumentation, configure the instrumenter:
 
 ```ruby
-SearchFlip::Config[:instrumenter] = ActiveSupport::Notifications
+SearchFlip::Config[:instrumenter] = ActiveSupport::Notifications.notifier
 ```
 
 Subsequently, you can subscribe to notifcations for `request.search_flip`:
@@ -904,52 +874,57 @@ Thus, if your ORM supports `.find_each`, `#id` and `#where` you are already
 good to go. Otherwise, simply add your custom implementation of those methods
 that work with whatever ORM you use.
 
-## JSON
+## Date and Timestamps in JSON
 
-SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
-JSON. More concretely, SearchFlip is using:
+Elasticsearch requires dates and timestamps to have one of the formats listed
+here: [https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#strict-date-time](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#strict-date-time).
+
+However, `JSON.generate` in ruby by default outputs something like:
 
 ```ruby
-Oj.dump({ key: "value" }, mode: :custom, use_to_json: true, time_format: :xmlschema, bigdecimal_as_decimal: false)
+JSON.generate(time: Time.now.utc)
+# => "{\"time\":\"2018-02-22 18:19:33 UTC\"}"
 ```
 
-The `use_to_json` option is used for maximum compatibility, most importantly
-when using rails `ActiveSupport::TimeWithZone` timestamps, which `oj` can not
-serialize natively. However, `use_to_json` adds performance overhead. You can
-change the json options via:
+This format is not compatible with Elasticsearch by default. If you're on
+Rails, ActiveSupport adds its own `#to_json` methods to `Time`, `Date`, etc.
+However, ActiveSupport checks whether they are used in combination with
+`JSON.generate` or not and adapt:
 
 ```ruby
-SearchFlip::Config[:json_options] = {
-  mode: :custom,
-  use_to_json: false,
-  time_format: :xmlschema,
-  bigdecimal_as_decimal: false
-}
+Time.now.utc.to_json
+=> "\"2018-02-22T18:18:22.088Z\""
+
+JSON.generate(time: Time.now.utc)
+=> "{\"time\":\"2018-02-22 18:18:59 UTC\"}"
 ```
 
-However, you then have to convert timestamps manually for indexation via e.g.:
+SearchFlip is using the [Oj gem](https://github.com/ohler55/oj) to generate
+JSON. More concretely, SearchFlip is using:
 
 ```ruby
-class MyIndex
-  # ...
+Oj.dump({ key: "value" }, mode: :custom, use_to_json: true)
+```
 
-  def self.serialize(model)
-    {
-      # ...
+This mitigates the issues if you're on Rails:
 
-      created_at: model.created_at.to_time
-    }
-  end
-end
+```ruby
+Oj.dump(Time.now, mode: :custom, use_to_json: true)
+# => "\"2018-02-22T18:21:21.064Z\""
 ```
 
-Please check out the oj docs for more details.
+However, if you're not on Rails, you need to add `#to_json` methods to `Time`,
+`Date` and `DateTime` to get proper serialization. You can either add them on
+your own, via other libraries or by simply using:
+
+```ruby
+require "search_flip/to_json"
+```
 
 ## Feature Support
 
 * for Elasticsearch 2.x, the delete-by-query plugin is required to delete
   records via queries
-* `#match_none` is only available with Elasticsearch >= 5
 * `#track_total_hits` is only available with Elasticsearch >= 7
 
 ## Keeping your Models and Indices in Sync
@@ -981,6 +956,7 @@ SearchFlip is using Semantic Versioning: [SemVer](http://semver.org/)
 
 * Elasticsearch: [https://www.elastic.co/](https://www.elastic.co/)
 * Reference Docs: [http://www.rubydoc.info/github/mrkamel/search_flip](http://www.rubydoc.info/github/mrkamel/search_flip)
+* Travis: [http://travis-ci.org/mrkamel/search_flip](http://travis-ci.org/mrkamel/search_flip)
 * will_paginate: [https://github.com/mislav/will_paginate](https://github.com/mislav/will_paginate)
 * kaminari: [https://github.com/kaminari/kaminari](https://github.com/kaminari/kaminari)
 * Oj: [https://github.com/ohler55/oj](https://github.com/ohler55/oj)

data/UPDATING.md

@@ -1,6 +1,46 @@
 
 # Updating from previous SearchFlip versions
 
+## Update 3.x to 4.x
+
+**[BREAKING]** For performance reasons, `SearchFlip::Result` no longer
+inherits `Hashie::Mash`
+
+* It no longer supports symbol based access like `result[:id]`
+
+2.x:
+
+```ruby
+CommentIndex.match_all.results.first[:id]
+CommentIndex.aggregate(:tags).aggregations(:tags).values.first[:doc_count]
+```
+
+3.x
+
+```ruby
+CommentIndex.match_all.results.first["id"] # or .id
+CommentIndex.aggregate(:tags).aggregations(:tags).values.first["doc_count"] # or .doc_count
+```
+
+* It no longer supports question mark methods like `result.title?`
+
+2.x:
+
+```ruby
+CommentIndex.match_all.results.first.is_published?
+```
+
+3.x
+
+```ruby
+CommentIndex.match_all.results.first.is_published == true
+```
+
+* It no longer supports method based assignment like `result.some_key = "value"`.
+
+However, this should not have any practical implications, as changing the
+results is not considered to be a common use case.
+
 ## Update 2.x to 3.x
 
 * **[BREAKING]**  No longer pass multiple arguments to `#must`, `#must_not`,

data/docker-compose.yml

@@ -4,6 +4,5 @@ services:
     image: $ES_IMAGE
     environment:
       - discovery.type=single-node
-      - xpack.security.enabled=false
     ports:
       - 9200:9200

data/lib/search_flip/aggregation.rb

@@ -30,7 +30,7 @@ module SearchFlip
       res[:aggregations] = aggregation_values if aggregation_values
 
       if must_values || must_not_values || filter_values
-        if target.connection.distribution || target.connection.version.to_i >= 2
+        if target.connection.version.to_i >= 2
           res[:filter] = {
             bool: {}
               .merge(must_values ? { must: must_values } : {})

data/lib/search_flip/aws_sigv4_plugin.rb

@@ -37,6 +37,7 @@ module SearchFlip
       }
 
       signature_request[:body] = options[:body] if options.key?(:body)
+      signature_request[:body] = options[:json].respond_to?(:to_str) ? options[:json] : JSON.generate(options[:json]) if options[:json]
 
       signature = signer.sign_request(signature_request)
 

data/lib/search_flip/bulk.rb

@@ -143,12 +143,12 @@ module SearchFlip
 
       return if options[:raise] == false
 
-      parsed_response = SearchFlip::JSON.parse(response.to_s)
+      parsed_response = response.parse
 
       return unless parsed_response["errors"]
 
       parsed_response["items"].each do |item|
-        item.each_value do |element|
+        item.each do |_, element|
           status = element["status"]
 
           next if status.between?(200, 299)

data/lib/search_flip/config.rb

@@ -5,12 +5,6 @@ module SearchFlip
     bulk_limit: 1_000,
     bulk_max_mb: 100,
     auto_refresh: false,
-    instrumenter: NullInstrumenter.new,
-    json_options: {
-      mode: :custom,
-      use_to_json: true,
-      time_format: :xmlschema,
-      bigdecimal_as_decimal: false
-    }
+    instrumenter: NullInstrumenter.new
   }
 end