swiftype-app-search 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 236cc084c39977f3fff52da0695f9d90e66c3209a7596d9ca6805239828be122
-  data.tar.gz: dabefe87c883d2aad2a6991140e03b4dbfc1c6e8a78c0903e9a90dbe25065f72
+  metadata.gz: 8409dce98dbe9ef896e5cc4533cb6b2e6f320fc00b2e1d6d7091c9c1976f3d15
+  data.tar.gz: f3fcbee95672e8a930c7b1f1d182b49b5391e9d843fcdf9875b4b3e26d8b2c0e
 SHA512:
-  metadata.gz: 86c5e5978343a171276ef98d8b84fb6e780a32781d27486d7b172b0d0d64a1864441a0d0cb1ff8322851483e6163bc269df79a6bfda0aa094e3f2ebc75c41935
-  data.tar.gz: 12650e7cd5ff571ebe6243824bb4caa07205a8e8889c45fb07b5ac6e1d32bb75f89b48c4f08923335910c2be598697bf1cb90417f7d5fb1d948688725181ac8c
+  metadata.gz: 1f94fc9f964ebbba4e37401cd455a551116f9041b5aeba8b6caa56c3fb0bf0ba324f2dca3e434cff3717e9d444b3fa934e21d7a6cbb3401ee7e3f9527f8606a3
+  data.tar.gz: 57d7533faa0660c2b542e1438f514e1aa22978bcd6de13af6d320d4d26f6c675b3cde2d5f3585cf4f7fa2595aeba2c75fe20da05fb1f3655af149110a6d96395

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Elastic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,23 @@
-# Ruby client for the Swiftype App Search API
+<p align="center"><img src="https://github.com/swiftype/swiftype-app-search-ruby/blob/master/logo-app-search.png?raw=true" alt="Elastic App Search Logo"></p>
 
-[![CircleCI](https://circleci.com/gh/swiftype/swiftype-app-search-ruby.svg?style=svg)](https://circleci.com/gh/swiftype/swiftype-app-search-ruby)
+<p align="center"><a href="https://circleci.com/gh/swiftype/swiftype-app-search-ruby"><img src="https://circleci.com/gh/swiftype/swiftype-app-search-ruby.svg?style=svg" alt="CircleCI buidl"></a>
+<a href="https://github.com/swiftype/swiftype-app-search-ruby/releases"><img src="https://img.shields.io/github/release/swiftype/swiftype-app-search-ruby/all.svg?style=flat-square" alt="GitHub release" /></a></p>
 
-## Installation
+> A first-party Ruby client for building excellent, relevant search experiences with Elastic App Search.
+
+## Contents
+
++ [Getting started](#getting-started-)
++ [Usage](#usage)
++ [Running Tests](#running-tests)
++ [Debugging API Calls](#debugging-api-calls)
++ [FAQ](#faq-)
++ [Contribute](#contribute-)
++ [License](#license-)
+
+***
+
+## Getting started 🐣
 
 To install the gem, execute:
 
@@ -10,7 +25,7 @@ To install the gem, execute:
 gem install swiftype-app-search
 ```
 
-Or place `gem 'swiftype-app-search', '~> 0.4.4` in your `Gemfile` and run `bundle install`.
+Or place `gem 'swiftype-app-search', '~> 0.5.0'` in your `Gemfile` and run `bundle install`.
 
 ## Usage
 
@@ -23,7 +38,17 @@ It also requires a valid `[API_KEY]`, which authenticates requests to the API. Y
 You can find your `[API_KEY]` and your `[HOST_IDENTIFIER]` within the [Credentials](https://app.swiftype.com/as/credentials) menu:
 
 ```ruby
-client = SwiftypeAppSearch::Client.new(:host_identifier => 'host-c5s2mj', :api_key => 'api-mu75psc5egt9ppzuycnc2mc3')
+client = SwiftypeAppSearch::Client.new(:host_identifier => 'host-c5s2mj', :api_key => 'private-mu75psc5egt9ppzuycnc2mc3')
+```
+
+### Using with App Search Managed Deploys
+
+The client can be configured to use a managed deploy by using the
+`api_endpoint` parameter. Since managed deploys do not rely on a `[HOST_IDENTIFIER]`
+, it can be omitted.
+
+```ruby
+client = SwiftypeAppSearch::Client.new(:api_key => 'private-mu75psc5egt9ppzuycnc2mc3', :api_endpoint => 'http://localhost:3002/api/as/v1/')
 ```
 
 ### API Methods
@@ -164,6 +189,23 @@ queries = [{
 client.multi_search(engine_name, queries)
 ```
 
+#### Query Suggestion
+
+```ruby
+engine_name = 'favorite-videos'
+
+options = {
+  :size => 3,
+  :types => {
+    :documents => {
+      :fields => ['title']
+    }
+  }
+}
+
+client.query_suggestion(engine_name, 'cat', options)
+```
+
 ## Running Tests
 
 ```bash
@@ -193,6 +235,29 @@ If you need to debug an API call made by the client, there are a few things you
    to Swiftype Customer Support to help us quickly find your API request and help you troubleshoot
    your issues.
 
-## Contributions
+## FAQ 🔮
+
+### Where do I report issues with the client?
+
+If something is not working as expected, please open an [issue](https://github.com/swiftype/swiftype-app-search-ruby/issues/new).
+
+### Where can I learn more about App Search?
+
+Your best bet is to read the [documentation](https://swiftype.com/documentation/app-search).
+
+### Where else can I go to get help?
+
+You can checkout the [Elastic App Search community discuss forums](https://discuss.elastic.co/c/app-search).
+
+## Contribute 🚀
+
+We welcome contributors to the project. Before you begin, a couple notes...
+
++ Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/swiftype/swiftype-app-search-ruby/issues).
++ Please write simple code and concise documentation, when appropriate.
+
+## License 📗
+
+[MIT](https://github.com/swiftype/swiftype-app-search-ruby/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
 
-To contribute code, please fork the repository and submit a pull request.
+Thank you to all the [contributors](https://github.com/swiftype/swiftype-app-search-ruby/graphs/contributors)!

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

@@ -9,6 +9,7 @@ module SwiftypeAppSearch
     autoload :Documents, 'swiftype-app-search/client/documents'
     autoload :Engines, 'swiftype-app-search/client/engines'
     autoload :Search, 'swiftype-app-search/client/search'
+    autoload :QuerySuggestion, 'swiftype-app-search/client/query_suggestion'
 
     DEFAULT_TIMEOUT = 15
 
@@ -57,5 +58,6 @@ module SwiftypeAppSearch
     include SwiftypeAppSearch::Client::Engines
     include SwiftypeAppSearch::Client::Search
     include SwiftypeAppSearch::Client::SignedSearchOptions
+    include SwiftypeAppSearch::Client::QuerySuggestion
   end
 end

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

@@ -0,0 +1,17 @@
+module SwiftypeAppSearch
+  class Client
+    module QuerySuggestion
+      # Request Query Suggestions
+      #
+      # @param [String] engine_name the unique Engine name
+      # @param [String] query the search query to suggest for
+      # @options options see the {App Search API}[https://swiftype.com/documentation/app-search/] for supported search options.
+      #
+      # @return [Hash] search results
+      def query_suggestion(engine_name, query, options = {})
+        params = Utils.symbolize_keys(options).merge(:query => query)
+        request(:post, "engines/#{engine_name}/query_suggestion", params)
+      end
+    end
+  end
+end

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

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

data/spec/client_spec.rb

@@ -324,6 +324,35 @@ describe SwiftypeAppSearch::Client do
     end
   end
 
+  context 'QuerySuggest' do
+    describe '#query_suggestion' do
+      let(:query) { 'cat' }
+      let(:options) { { :size => 3, :types => { :documents => { :fields => ['title'] } } } }
+
+      context 'when options are provided' do
+        subject { @static_client.query_suggestion(@static_engine_name, query, options) }
+
+        it 'should request query suggestions' do
+          expect(subject).to match(
+            'meta' => anything,
+            'results' => anything
+          )
+        end
+      end
+
+      context 'when options are omitted' do
+        subject { @static_client.query_suggestion(@static_engine_name, query) }
+
+        it 'should request query suggestions' do
+          expect(subject).to match(
+            'meta' => anything,
+            'results' => anything
+          )
+        end
+      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.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -99,7 +99,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/data/ca-bundle.crt
@@ -107,11 +107,13 @@ files:
 - lib/swiftype-app-search/client.rb
 - lib/swiftype-app-search/client/documents.rb
 - 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/exceptions.rb
 - lib/swiftype-app-search/request.rb
 - lib/swiftype-app-search/utils.rb
 - lib/swiftype-app-search/version.rb
+- logo-app-search.png
 - script/console
 - spec/client_spec.rb
 - spec/config_helper.rb

data/LICENSE.txt

@@ -1,21 +0,0 @@
-Copyright 2017  Swiftype, Inc.
-http://swiftype.com/
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.