waistband 6.1.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2a8dfc890aa44ce948449adc7d58bab2f3094451
-  data.tar.gz: 183af89784e63a51d6b83484136b545a620a7709
+SHA256:
+  metadata.gz: c663d799154fe793531c32248de60aa7942f34dbb54b0c04cf3373f9df652b0a
+  data.tar.gz: 9cc04d751ab8bf8911cc2c5925c805e7656a73bdc1a31e6092f873f14f025006
 SHA512:
-  metadata.gz: 6920854fb526fb24b0ebac953b634d31905a9e0cabcaed4a6cfcf88960b3fa0880c8dbdd9b35cc1f165d0f231095ddfd4704838e673e8986dff840fd39bd1b4c
-  data.tar.gz: a160cc5185218e52281e05323620f7b355bb3132560aa6b26ff7a1e81c19b5c8fcc1a99ea241fdf94b9ad15db837311e09416f7d3725ec5394a6b51c34d8c6b4
+  metadata.gz: 84ed774572d1aa01b615987c5bc8de1b8f6a55532307fc140a7a370652822b0c60e26ce7211e63cb0e5b83c713472f4988b8734f3382a7e6b43f3a9eb7bcbd4d
+  data.tar.gz: 2524de64e2658792fd7eb71efdd9e357f246d94bcfe9ebace8f6aeae98c8984c3d6bdd17491821ac3efd389a6873f5a306c8ec49253a6d4a2588f85a1360e47f

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p648
+3.1.4

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.3.0] - 2023-10-11
+### Added
+  - Support for Ruby 3.1 and its attendant Psych version
+
+## [6.2.0] - 2019-10-30
+### Added
+  - `#update`
+
+## [6.1.1] - 2019-10-29
+### Bug fix
+  - Ensure configuration loaded via YAML is compatible with `elasticsearch-transport`
+
 ## [6.1.0] - 2019-05-10
 ### Added
   - `#delete_by_query`

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rspec', '~> 3.1.0'
-gem 'timecop', '~> 0.7.1'
+gem 'timecop'
 
 unless ENV['ON_TRAVIS']
   gem 'byebug'

data/README.md

@@ -185,6 +185,11 @@ index.find('my_data') # => {"important"=>true, "valuable"=>{"always"=>true}}
 # reading with all the internal data
 index.read('my_data') # => {'_id' => '123123', '_source' => {"important"=>true, "valuable"=>{"always"=>true}}, ...}
 
+# partial updating
+index.save('my_data', {'important' => true, 'valuable' => {'always' => true}}) # => true
+index.update('my_data', {'important' => false }) # => true
+index.read('my_data') # => {'_id' => '123123', '_source' => {"important"=>false, "valuable"=>{"always"=>true}}, ...}
+
 # deleting
 index.destroy('my_data') # => "{\"ok\":true,\"found\":true,\"_index\":\"search\",\"_type\":\"search\",\"_id\":\"my_data\",\"_version\":2}"
 

data/lib/waistband/client.rb

@@ -53,11 +53,10 @@ module Waistband
 
     private
 
-      def hosts
-        @hosts ||= @servers.map do |server_name, config|
-          config
-        end
+    def hosts
+      @hosts ||= @servers.map do |server_name, config|
+        config.each_with_object({}) { |(key, value), obj| obj[key.to_sym] = value }
       end
-
+    end
   end
 end

data/lib/waistband/configuration.rb

@@ -63,9 +63,9 @@ module Waistband
 
       def load_yml_with_erb(file)
         if defined?(ERB)
-          YAML.load(ERB.new(File.read(file)).result)
+          YAML.safe_load(ERB.new(File.read(file)).result, aliases: true, permitted_classes: [Symbol])
         else
-          YAML.load_file(file)
+          YAML.safe_load_file(file, aliases: true, permitted_classes: [Symbol])
         end
       end
 

data/lib/waistband/errors.rb

@@ -15,6 +15,7 @@ module Waistband
     class IndexNotFound < StandardError; end
     class NoSearchHits < StandardError; end
     class UnableToSave < StandardError; end
+    class UnableToUpdate < StandardError; end
 
   end
 end

data/lib/waistband/index.rb

@@ -132,6 +132,40 @@ module Waistband
       false
     end
 
+    def update!(*args)
+      check_permission!('write')
+
+      body_hash = args.extract_options!
+      id = args.first
+      _type = body_hash.delete(:_type) || body_hash.delete('_type') || default_type_name
+
+      # map everything to strings if need be
+      body_hash = stringify_all(body_hash) if @stringify
+
+      verify_body_size(config_name, _type, id, body_hash)
+
+      body_hash = { doc: body_hash }
+
+      saved = client.update(
+        index: config_name,
+        type: _type,
+        id: id,
+        body: body_hash
+      )
+
+      unless saved['_id'].present?
+        raise ::Waistband::Errors::UnableToUpdate.new("Unable to update to index: #{config_name}, type: #{_type}, id: #{id}: result: #{saved}")
+      end
+
+      saved
+    end
+
+    def update(*args)
+      update!(*args)
+    rescue ::Waistband::Errors::UnableToUpdate
+      false
+    end
+
     def find(id, options = {})
       find!(id, options)
     rescue Elasticsearch::Transport::Transport::Errors::NotFound

data/lib/waistband/version.rb

@@ -1,3 +1,3 @@
 module Waistband
-  VERSION = "6.1.1"
+  VERSION = "6.3.0"
 end

data/spec/lib/configuration_spec.rb

@@ -25,11 +25,11 @@ describe Waistband::Configuration do
   end
 
   it "permits passing in an adapter to use to the client" do
-    original_config = YAML.load_file(File.join(::Waistband.config.config_dir, 'waistband.yml'))['test']
+    original_config = YAML.safe_load_file(File.join(::Waistband.config.config_dir, 'waistband.yml'), aliases: true, permitted_classes: [Symbol])['test']
 
     expect(::Waistband.config.instance_variable_get('@adapter')).to be_nil
 
-    expect(YAML).to receive(:load).and_return({'test' => original_config.merge({'adapter' => :net_http})}).at_least(:once)
+    expect(YAML).to receive(:safe_load).and_return({'test' => original_config.merge({'adapter' => :net_http})}).at_least(:once)
     ::Waistband.config.setup
     expect(::Waistband.config.instance_variable_get('@adapter')).to eql :net_http
     expect(::Waistband.client.transport.options[:adapter]).to eql :net_http
@@ -48,6 +48,10 @@ describe Waistband::Configuration do
   end
 
   describe 'hosts' do
+    it "formats host Hashes to use Symbolized keys" do
+      keys = config.client.send(:hosts).first.keys
+      expect(keys.first).to be_a(Symbol)
+    end
 
     it "returns array of all available servers' configs" do
       hosts = config.client.send(:hosts)
@@ -55,9 +59,9 @@ describe Waistband::Configuration do
       expect(hosts.size).to eql 2
 
       hosts.each_with_index do |server, i|
-        expect(server['host']).to match(/127\.0\.0\.1|localhost/)
-        expect(server['port']).to eql 9200
-        expect(server['protocol']).to eql 'http'
+        expect(server[:host]).to match(/127\.0\.0\.1|localhost/)
+        expect(server[:port]).to eql 9200
+        expect(server[:protocol]).to eql 'http'
       end
     end
 

data/spec/lib/index/index_spec.rb

@@ -71,8 +71,8 @@ describe Waistband::Index do
 
   it "correctly sets hosts" do
     expect(index.client.send(:hosts)).to eql([
-      {"host" => "localhost", "port" => 9200, "protocol" => "http"},
-      {"host" => "127.0.0.1", "port" => 9200, "protocol" => "http"}
+      {host: "localhost", port: 9200, protocol: "http"},
+      {host: "127.0.0.1", port: 9200, protocol: "http"}
     ])
   end
 
@@ -92,10 +92,9 @@ describe Waistband::Index do
   end
 
   describe "storing" do
-
     it "stores data" do
       expect(index.save('__test_write', {'ok' => 'yeah'})).to be_present
-      expect(index.read('__test_write')).to eql({
+      expect(index.read('__test_write')).to match a_hash_including({
         '_id' => '__test_write',
         '_index' => 'events_test',
         '_source' => {'ok' => 'yeah'},
@@ -105,6 +104,19 @@ describe Waistband::Index do
       })
     end
 
+    it "can partially updates documents" do
+      expect(index.save('__test_write', {'ok' => 'yeah', 'not_ok' => 'yeah'})).to be_present
+      expect(index.update('__test_write', {'not_ok' => 'no'})).to be_present
+      expect(index.read('__test_write')).to match a_hash_including({
+        '_id' => '__test_write',
+        '_index' => 'events_test',
+        '_source' => {'ok' => 'yeah', 'not_ok' => 'no'},
+        '_type' => 'event',
+        '_version' => 2,
+        'found' => true
+      })
+    end
+
     it "data is stringified" do
       index.save('__test_write', attrs)
       expect(index.read('__test_write')[:_source]).to eql({"ok"=>"{\"yeah\"=>true}"})

data/spec/lib/index_multi_connection_spec.rb

@@ -8,11 +8,13 @@ describe Waistband::Index do
   it "grabs connection data from the index's settings" do
     expect(client).to be_a(::Waistband::Client)
     expect(client.connection).to be_a(::Elasticsearch::Transport::Client)
-    expect(client.instance_variable_get('@servers')).to eql({"server1"=>{"host"=>"127.0.0.1", "port"=>9200, "protocol"=>"http"}})
+    expect(client.instance_variable_get('@servers'))
+      .to eql({"server1"=>{"host"=>"127.0.0.1", "port"=>9200, "protocol"=>"http"}})
   end
 
   it "correctly sets hosts" do
-    expect(client.send(:config_hash)[:hosts]).to eql([{"host"=>"127.0.0.1", "port"=>9200, "protocol"=>"http"}])
+    expect(client.send(:config_hash)[:hosts])
+      .to eql([{host: "127.0.0.1", port: 9200, protocol: "http"}])
   end
 
   it "exposes servers correctly" do
@@ -22,7 +24,7 @@ describe Waistband::Index do
   it "works" do
     index.delete
     index.create
-    saved = index.save('testing123', {ok: 'yeah'})
+    index.save('testing123', {ok: 'yeah'})
     index.refresh
     data = index.read('testing123')
     expect(data['_source']['ok']).to eql 'yeah'

data/waistband.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activesupport', '< 7.1.0'
   spec.add_dependency 'elasticsearch',  '~> 6.0'
   spec.add_dependency 'json'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.4"
   spec.add_development_dependency "rake",    "~> 10.3"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: waistband
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.3.0
 platform: ruby
 authors:
 - David Jairala
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ homepage: https://github.com/taskrabbit/waistband
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,9 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Configuration and sensible defaults for ElasticSearch on Ruby
 test_files: