swiftype-app-search 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8409dce98dbe9ef896e5cc4533cb6b2e6f320fc00b2e1d6d7091c9c1976f3d15
-  data.tar.gz: f3fcbee95672e8a930c7b1f1d182b49b5391e9d843fcdf9875b4b3e26d8b2c0e
+  metadata.gz: 171ac3ad757cd4d799653d5db78110c6001cbb025059410b7b8f32e180aa26c4
+  data.tar.gz: 93d90fba2fed89c39847675520eb4a63d549e41ea63db578f979f7b81e398011
 SHA512:
-  metadata.gz: 1f94fc9f964ebbba4e37401cd455a551116f9041b5aeba8b6caa56c3fb0bf0ba324f2dca3e434cff3717e9d444b3fa934e21d7a6cbb3401ee7e3f9527f8606a3
-  data.tar.gz: 57d7533faa0660c2b542e1438f514e1aa22978bcd6de13af6d320d4d26f6c675b3cde2d5f3585cf4f7fa2595aeba2c75fe20da05fb1f3655af149110a6d96395
+  metadata.gz: 811715bd4df0576ac07213595464aed2cb989a32336c1d98c12c6b001e6c03f0cb5981dfbb8fb8bf5d919b4d6b44f9e192e83672d3b00ac6e2ca95c0abfaca26
+  data.tar.gz: a7ba625d89a1a681666dcf75180cf3ad4208990d15e49380f0b47e19846b79e8d9d5baa19ce3b288b004e05a4883e1ea98549c666b22c4033789925264369800

data/README.md

@@ -25,7 +25,7 @@ To install the gem, execute:
 gem install swiftype-app-search
 ```
 
-Or place `gem 'swiftype-app-search', '~> 0.5.0'` in your `Gemfile` and run `bundle install`.
+Or place `gem 'swiftype-app-search', '~> 0.6.0'` in your `Gemfile` and run `bundle install`.
 
 ## Usage
 
@@ -206,6 +206,59 @@ options = {
 client.query_suggestion(engine_name, 'cat', options)
 ```
 
+#### Show Search Settings
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.show_settings(engine_name)
+```
+
+#### Update Search Settings
+
+```ruby
+engine_name = 'favorite-videos'
+
+settings = {
+  "search_fields" => {
+    "id" => {
+      "weight" => 1
+    },
+    "url" => {
+      "weight" => 1
+    },
+    "title" => {
+      "weight" => 1
+    },
+    "body" => {
+      "weight" => 1
+    },
+  },
+  "boosts" => {
+    "title" => [
+      {
+        "type" => "value",
+        "factor" => 9.5,
+        "operation" => "multiply",
+        "value" => [
+          "Titanic"
+        ]
+      }
+    ]
+  }
+}
+
+client.update_settings(engine_name, settings)
+```
+
+#### Reset Search Settings
+
+```ruby
+engine_name = 'favorite-videos'
+
+client.reset_settings(engine_name)
+```
+
 ## Running Tests
 
 ```bash

data/lib/swiftype-app-search/client/search_settings.rb

@@ -0,0 +1,35 @@
+# Search Settings is used to adjust weights and boosts
+module SwiftypeAppSearch
+  class Client
+    module SearchSettings
+
+      # Show all Weights and Boosts applied to the search fields of an Engine.
+      #
+      # @param [String] engine_name the unique Engine name
+      #
+      # @return [Hash] current Search Settings
+      def show_settings(engine_name)
+        get("engines/#{engine_name}/search_settings")
+      end
+
+      # Update Weights or Boosts for search fields of an Engine.
+      #
+      # @param [String] engine_name the unique Engine name
+      # @param [Hash] settings new Search Settings Hash
+      #
+      # @return [Hash] new Search Settings
+      def update_settings(engine_name, settings)
+        put("engines/#{engine_name}/search_settings", settings)
+      end
+
+      # Reset Engine's Search Settings to default values.
+      #
+      # @param [String] engine_name the unique Engine name
+      #
+      # @return [Hash] default Search Settings
+      def reset_settings(engine_name)
+        post("engines/#{engine_name}/search_settings/reset")
+      end
+    end
+  end
+end

data/lib/swiftype-app-search/client.rb

@@ -10,6 +10,7 @@ module SwiftypeAppSearch
     autoload :Engines, 'swiftype-app-search/client/engines'
     autoload :Search, 'swiftype-app-search/client/search'
     autoload :QuerySuggestion, 'swiftype-app-search/client/query_suggestion'
+    autoload :SearchSettings, 'swiftype-app-search/client/search_settings'
 
     DEFAULT_TIMEOUT = 15
 
@@ -59,5 +60,6 @@ module SwiftypeAppSearch
     include SwiftypeAppSearch::Client::Search
     include SwiftypeAppSearch::Client::SignedSearchOptions
     include SwiftypeAppSearch::Client::QuerySuggestion
+    include SwiftypeAppSearch::Client::SearchSettings
   end
 end

data/lib/swiftype-app-search/version.rb

@@ -1,3 +1,3 @@
 module SwiftypeAppSearch
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/client_spec.rb

@@ -353,6 +353,67 @@ describe SwiftypeAppSearch::Client do
     end
   end
 
+  context 'SearchSettings' do
+    let(:default_settings) { {
+      "search_fields" => {
+        "id" => {
+          "weight" => 1
+        }
+      },
+      "boosts" => {}
+    } }
+
+    let(:updated_settings) { {
+      "search_fields" => {
+        "id" => {
+          "weight" => 3
+        }
+      },
+      "boosts" => {}
+    } }
+
+    before(:each) do
+      client.create_engine(engine_name) rescue SwiftypeAppSearch::BadRequest
+    end
+
+    after(:each) do
+      client.destroy_engine(engine_name) rescue SwiftypeAppSearch::NonExistentRecord
+    end
+
+    describe '#show_settings' do
+      subject { client.show_settings(engine_name) }
+
+      it 'should return default settings' do
+        expect(subject).to match(default_settings)
+      end
+    end
+
+    describe '#update_settings' do
+      subject { client.show_settings(engine_name) }
+
+      before do
+        client.update_settings(engine_name, updated_settings)
+      end
+
+      it 'should update search settings' do
+        expect(subject).to match(updated_settings)
+      end
+    end
+
+    describe '#reset_settings' do
+      subject { client.show_settings(engine_name) }
+
+      before do
+        client.update_settings(engine_name, updated_settings)
+        client.reset_settings(engine_name)
+      end
+
+      it 'should reset search settings' do
+        expect(subject).to match(default_settings)
+      end
+    end
+  end
+
   context 'Engines' do
     after do
       client.destroy_engine(engine_name) rescue SwiftypeAppSearch::NonExistentRecord

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-app-search
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -109,6 +109,7 @@ files:
 - lib/swiftype-app-search/client/engines.rb
 - lib/swiftype-app-search/client/query_suggestion.rb
 - lib/swiftype-app-search/client/search.rb
+- lib/swiftype-app-search/client/search_settings.rb
 - lib/swiftype-app-search/exceptions.rb
 - lib/swiftype-app-search/request.rb
 - lib/swiftype-app-search/utils.rb