elastic-app-search 0.7.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c263dbb3b01b9822aa74c538a14e2c46c7f227e
-  data.tar.gz: 0b8a9a96f0b802fd48c6fd6e0f9ed28c7bc2f738
+SHA256:
+  metadata.gz: ad91d2a33d9f54d5ee8fc870a8a106cf7d0b3b3351b9920130932c06ae09a21b
+  data.tar.gz: 3d38cc89d75dff5d8e03f3ad3326636ae84b3fb5d703494e1eac173396ada939
 SHA512:
-  metadata.gz: 6781841178891c52afee16c6ade751a0f81bf2c153df1027010efd2350ec518a703688c566f836da0c577c4382321435e419fe7cf08adfd704f23d8da2f757ff
-  data.tar.gz: cec6394c61716f08273aee6249e852d3467310782b0bc22c01bbf07bef8e551f52b35f408211f3f8f55dccb86c5413ae3f5011c7fb8a18de074ad4dfb34c3656
+  metadata.gz: 9060edf116f45ca45c19f152a980325f7f480f74de6c85694bd22dd203746f21cc6f307991592b6a8675d7fb9d0505d69dcbb8beff20b4ec4ad71c70022d99cf
+  data.tar.gz: 04a7789fa959203fa4cacb0cb310428af8988d83f9c954e2b7165d13a2cc5222c47ce98abf33747cdf17198d362f7a482d9121c050fd43fb4db5caab0b550339

data/.circleci/config.yml

@@ -2,17 +2,20 @@
 #
 # Check https://circleci.com/docs/2.0/language-ruby/ for more details
 #
-version: 2
+version: 2.1
+
+executors:
+  ruby-24: { docker: [{ image: "ruby:2.4" }] }
+  ruby-25: { docker: [{ image: "ruby:2.5" }] }
+  ruby-26: { docker: [{ image: "ruby:2.6" }] }
+  jruby-92: { docker: [{ image: "jruby:9.2.7-jdk" }] }
+
 jobs:
   build:
-    docker:
-      # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
-
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
+    parameters:
+      executor:
+        type: executor
+    executor: << parameters.executor >>
 
     working_directory: ~/repo
 
@@ -22,9 +25,9 @@ jobs:
       # Download and cache dependencies
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "Gemfile" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
+            - v1-dependencies-{{ checksum "Gemfile" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
 
       - run:
           name: install dependencies
@@ -54,3 +57,11 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
+
+workflows:
+  run-tests:
+    jobs:
+      - build: { name: run-tests-ruby-2.4, executor: ruby-24 }
+      - build: { name: run-tests-ruby-2.5, executor: ruby-25 }
+      - build: { name: run-tests-ruby-2.6, executor: ruby-26 }
+      - build: { name: run-tests-jruby-92, executor: jruby-92 }

data/README.md

@@ -7,6 +7,7 @@
 ## Contents
 
 - [Getting started](#getting-started-)
+- [Versioning](#versioning)
 - [Usage](#usage)
 - [Running Tests](#running-tests)
 - [Debugging API Calls](#debugging-api-calls)
@@ -24,7 +25,17 @@ To install the gem, execute:
 gem install elastic-app-search
 ```
 
-Or place `gem 'elastic-app-search', '~> 0.7.0'` in your `Gemfile` and run `bundle install`.
+Or place `gem 'elastic-app-search', '~> 7.2.0'` in your `Gemfile` and run `bundle install`.
+
+## Versioning
+
+This client is versioned and released alongside App Search.
+
+To guarantee compatibility, use the most recent version of this library within the major version of the corresponding App Search implementation.
+
+For example, for App Search `7.3`, use `7.3` of this library or above, but not `8.0`.
+
+If you are a [SaaS](https://app.swiftype.com/as) user, simply use the most recent version of this library.
 
 ## Usage
 
@@ -263,6 +274,24 @@ engine_name = 'favorite-videos'
 client.reset_settings(engine_name)
 ```
 
+#### Create a Signed Search Key
+
+Creating a search key that will only return the title field.
+
+```ruby
+public_search_key = 'search-xxxxxxxxxxxxxxxxxxxxxxxx'
+public_search_key_name = 'search-key'
+enforced_options = {
+  result_fields: { title: { raw: {} } },
+  filters: { world_heritage_site: 'true' }
+}
+
+signed_search_key = Elastic::AppSearch::Client.create_signed_search_key(public_search_key, public_search_key_name, enforced_options)
+
+client = Elastic::AppSearch::Client.new(host_identifier: 'host-c5s2mj', api_key: signed_search_key)
+client.search('national-parks-demo', 'everglade')
+```
+
 ## Running Tests
 
 ```bash

data/lib/elastic/app-search/exceptions.rb

@@ -9,7 +9,7 @@ module Elastic
         else
           response['errors'] || [response]
         end
-        message = (errors.count == 1) ? "Error: #{errors.first}" : "Errors: #{errors.inspect}"
+        message = (errors.size == 1) ? "Error: #{errors.first}" : "Errors: #{errors.inspect}"
         super(message)
       end
     end

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

@@ -1,5 +1,5 @@
 module Elastic
   module AppSearch
-    VERSION = '0.7.0'
+    VERSION = '7.2.0'
   end
 end

data/spec/client_spec.rb

@@ -1,7 +1,8 @@
 require 'config_helper'
+require 'securerandom'
 
 describe Elastic::AppSearch::Client do
-  let(:engine_name) { "ruby-client-test-#{Time.now.to_i}" }
+  let(:engine_name) { "ruby-client-test-#{SecureRandom.hex}" }
 
   include_context 'App Search Credentials'
   let(:client) { Elastic::AppSearch::Client.new(client_options) }
@@ -9,7 +10,7 @@ describe Elastic::AppSearch::Client do
   before(:all) do
     # Bootstraps a static engine for 'read-only' options that require indexing
     # across the test suite
-    @static_engine_name = "ruby-client-test-static-#{Time.now.to_i}"
+    @static_engine_name = "ruby-client-test-static-#{SecureRandom.hex}"
     as_api_key = ConfigHelper.get_as_api_key
     as_host_identifier = ConfigHelper.get_as_host_identifier
     as_api_endpoint = ConfigHelper.get_as_api_endpoint

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-app-search
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -97,7 +97,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - NOTICE.txt
@@ -141,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Elastic App Search API

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-script: rspec
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.4
-  - jruby
-jdk:
-  - oraclejdk8
-
-before_install:
-  - gem update --system
-  - gem --version
-  - gem update bundler