swiftype-app-search 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1986746b954002b52e3ddc39165f4b9ffd6e97004f91ab467e078ce93e61c97f
-  data.tar.gz: f7f082f36f27c87b9fc9db7f2de3ece9200ee11635a93116919b7c9e72abb644
+  metadata.gz: 4a2254f5b17c63dc6aad243e5b4a7e165cdfc7fd29f75ef20f3a7d8b46f57403
+  data.tar.gz: 4f5967113edc23e4d9b1a521d06e14c64e7cb69a37d57d6ef342b5003be70f2d
 SHA512:
-  metadata.gz: 1452ee050399d1e34f5febf9a33893bc990c4846a56e56d00e4b31f207673725f9015b4a67134f22d6ff5172830ca6e96662f421950540499ebef55678218562
-  data.tar.gz: 1338b25a69535c36561e0197ea0befdbacaa80cb8955f9e0eaa7bf01b2687a329fe572863e9dd70af607a3aff421dedbc3a86317d166c94873703dc5d2cfa92c
+  metadata.gz: ec871c6e1c1e798cb91e749cde14e86a7fdca6c119855fa84a23cf29a09962018ee4022849017450d201784dce32023e47fb4ebf83390cd63aea7ffdcbd2853d
+  data.tar.gz: f9a52b4a5d73328230c55498a9bef95b6045271ecf49ca29fe2b2b7eeea7c16be4a92efdccc98c8ad4f7aa68fb7c4e4a392657e8cf6dfd72aa3638464e569f6c

data/README.md

@@ -14,12 +14,14 @@ Or place `gem 'swiftype-app-search', '~> 0.1.3` in your `Gemfile` and run `bundl
 
 ### Setup: Configuring the client and authentication
 
-Create a new instance of the Swiftype App Search Client. This requires your `ACCOUNT_HOST_KEY`, which
+Create a new instance of the Swiftype App Search Client. This requires your `[HOST_IDENTIFIER]`, which
 identifies the unique hostname of the Swiftype API that is associated with your Swiftype account.
-It also requires a valid `API_KEY`, which authenticates requests to the API:
+It also requires a valid `[API_KEY]`, which authenticates requests to the API. You can use any key type with the client, however each has a different scope. For more information on keys, check out the [documentation](https://swiftype.com/documentation/app-search/credentials).
+
+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(:account_host_key => 'host-c5s2mj', :api_key => 'api-mu75psc5egt9ppzuycnc2mc3')
+client = SwiftypeAppSearch::Client.new(:host_identifier => 'host-c5s2mj', :api_key => 'api-mu75psc5egt9ppzuycnc2mc3')
 ```
 
 ### API Methods
@@ -171,16 +173,16 @@ end
 ## Running Tests
 
 ```bash
-export AS_API_KEY="your API key"
-export AS_ACCOUNT_HOST_KEY="your account host key"
+export AS_API_KEY="[API_KEY]"
+export AS_HOST_IDENTIFIER="[HOST_IDENTIFIER]"
 bundle exec rspec
 ```
 
 You can also run tests against a local environment by passing a `AS_API_ENDPOINT` environment variable
 
 ```bash
-export AS_API_KEY="your API key"
-export AS_API_ENDPOINT="http://<your account host key>.api.127.0.0.1.ip.es.io:3002/api/as/v1"
+export AS_API_KEY="[API_KEY]"
+export AS_API_ENDPOINT="http://[HOST_IDENTIFIER].api.127.0.0.1.ip.es.io:3002/api/as/v1"
 bundle exec rspec
 ```
 

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

@@ -19,13 +19,13 @@ module SwiftypeAppSearch
     # Create a new SwiftypeAppSearch::Client client
     #
     # @param options [Hash] a hash of configuration options that will override what is set on the SwiftypeAppSearch class.
-    # @option options [String] :account_host_key an Account Host Key to use for this client
-    # @option options [String] :api_key an Api Key to use for this client
+    # @option options [String] :account_host_key or :host_identifier is your Host Identifier to use with this client.
+    # @option options [String] :api_key can be any of your API Keys. Each has a different scope, so ensure you are using the correct key.
     # @option options [Numeric] :overall_timeout overall timeout for requests in seconds (default: 15s)
     # @option options [Numeric] :open_timeout the number of seconds Net::HTTP (default: 15s)
     #   will wait while opening a connection before raising a Timeout::Error
     def initialize(options = {})
-      @api_endpoint = options.fetch(:api_endpoint) { "https://#{options.fetch(:account_host_key)}.api.swiftype.com/api/as/v1/" }
+      @api_endpoint = options.fetch(:api_endpoint) { "https://#{options.fetch(:account_host_key) { options.fetch(:host_identifier) }}.api.swiftype.com/api/as/v1/" }
       @api_key = options.fetch(:api_key)
       @open_timeout = options.fetch(:open_timeout, DEFAULT_TIMEOUT).to_f
       @overall_timeout = options.fetch(:overall_timeout, DEFAULT_TIMEOUT).to_f

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

@@ -1,3 +1,3 @@
 module SwiftypeAppSearch
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/spec/client_spec.rb

@@ -148,8 +148,13 @@ describe SwiftypeAppSearch::Client do
   end
 
   context 'Configuration' do
-    context 'account_host_key' do
+    context 'host_identifier' do
       it 'sets the base url correctly' do
+        client = SwiftypeAppSearch::Client.new(:host_identifier => 'host-asdf', :api_key => 'foo')
+        expect(client.api_endpoint).to eq('https://host-asdf.api.swiftype.com/api/as/v1/')
+      end
+
+      it 'sets the base url correctly using deprecated as_host_key' do
         client = SwiftypeAppSearch::Client.new(:account_host_key => 'host-asdf', :api_key => 'foo')
         expect(client.api_endpoint).to eq('https://host-asdf.api.swiftype.com/api/as/v1/')
       end

data/spec/spec_helper.rb

@@ -6,12 +6,13 @@ require 'swiftype-app-search'
 
 RSpec.shared_context "App Search Credentials" do
   let(:as_api_key) { ENV.fetch('AS_API_KEY', 'API_KEY') }
-  let(:as_account_host_key) { ENV.fetch('AS_ACCOUNT_HOST_KEY', 'ACCOUNT_HOST_KEY') }
+  # AS_ACCOUNT_HOST_KEY is deprecated
+  let(:as_host_identifier) { ENV['AS_ACCOUNT_HOST_KEY'] || ENV['AS_HOST_IDENTIFIER'] || 'ACCOUNT_HOST_KEY' }
   let(:as_api_endpoint) { ENV.fetch('AS_API_ENDPOINT', nil) }
   let(:client_options) do
     {
       :api_key => as_api_key,
-      :account_host_key => as_account_host_key
+      :host_identifier => as_host_identifier
     }.tap do |opts|
       opts[:api_endpoint] = as_api_endpoint unless as_api_endpoint.nil?
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-app-search
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-27 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print