swiftype-app-search 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd624bd0145b983734fdd65725ad222fb07752b5
-  data.tar.gz: d02e4f1e25f9e6a8d06eb83f33bc38b5aa132ec5
+SHA256:
+  metadata.gz: 1986746b954002b52e3ddc39165f4b9ffd6e97004f91ab467e078ce93e61c97f
+  data.tar.gz: f7f082f36f27c87b9fc9db7f2de3ece9200ee11635a93116919b7c9e72abb644
 SHA512:
-  metadata.gz: 5afb7ec9fc723e2fceaaa629d3dc948857ad3f4546db3ea67b659870f4aac7115d1185a7927194d2e18d4697e2026f026697b061c8c5a13f7bd94ca4a49577ea
-  data.tar.gz: 7d88608afa49080ad259930b299d2d78774a3188a26aadeb6ea9db58af94d45c8581df8329e9d54314918107578247554ed6dbd1f6f88f863b376f8f1ed5b2d8
+  metadata.gz: 1452ee050399d1e34f5febf9a33893bc990c4846a56e56d00e4b31f207673725f9015b4a67134f22d6ff5172830ca6e96662f421950540499ebef55678218562
+  data.tar.gz: 1338b25a69535c36561e0197ea0befdbacaa80cb8955f9e0eaa7bf01b2687a329fe572863e9dd70af607a3aff421dedbc3a86317d166c94873703dc5d2cfa92c

data/README.md

@@ -22,7 +22,13 @@ It also requires a valid `API_KEY`, which authenticates requests to the API:
 client = SwiftypeAppSearch::Client.new(:account_host_key => 'host-c5s2mj', :api_key => 'api-mu75psc5egt9ppzuycnc2mc3')
 ```
 
-### Indexing Creating or Updating a Single Document
+### API Methods
+
+This client is a thin interface to the Swiftype App Search Api. Additional details for requests and responses can be
+found in the [documentation](https://swiftype.com/documentation/app-search).
+
+#### Indexing: Creating or Updating a Single Document
+
 ```ruby
 engine_name = 'favorite-videos'
 document = {
@@ -33,13 +39,14 @@ document = {
 }
 
 begin
-  client.index_document(engine_name, document)
+  response = client.index_document(engine_name, document)
+  puts response
 rescue SwiftypeAppSearch::ClientException => e
-  # handle error
+  puts e
 end
 ```
 
-### Indexing: Creating or Updating Documents
+#### Indexing: Creating or Updating Documents
 
 ```ruby
 engine_name = 'favorite-videos'
@@ -59,42 +66,92 @@ documents = [
 ]
 
 begin
-  index_document_results = client.index_documents(engine_name, documents)
-  # handle index document results
+  response = client.index_documents(engine_name, documents)
+  puts response
 rescue SwiftypeAppSearch::ClientException => e
-  # handle error
+  puts e
 end
 ```
 
-### Listing Documents
+#### Listing Documents
 
 ```ruby
 engine_name = 'favorite-videos'
 document_ids = ['INscMGmhmX4', 'JNDFojsd02']
 
 begin
-  document_contents = client.get_documents(engine_name, document_ids)
-  # handle document contents
+  response = client.get_documents(engine_name, document_ids)
+  puts response
 rescue SwiftypeAppSearch::ClientException => e
-  # handle error
+  puts e
 end
 ```
 
-### Destroying Documents
+#### Destroying Documents
 
 ```ruby
 engine_name = 'favorite-videos'
 document_ids = ['INscMGmhmX4', 'JNDFojsd02']
 
 begin
-  destroy_document_results = client.destroy_documents(engine_name, document_ids)
-  # handle destroy document results
+  response = client.destroy_documents(engine_name, document_ids)
+  puts response
+rescue SwiftypeAppSearch::ClientException => e
+  puts e
+end
+```
+
+#### Listing Engines
+
+```ruby
+begin
+  response = client.list_engines
+  puts response
+rescue SwiftypeAppSearch::ClientException => e
+  puts e
+end
+```
+
+#### Retrieving Engines
+
+```ruby
+engine_name = 'favorite-videos'
+
+begin
+  response = client.get_engine(engine_name)
+  puts response
 rescue SwiftypeAppSearch::ClientException => e
-  # handle error
+  puts e
 end
 ```
 
-### Searching
+#### Creating Engines
+
+```ruby
+engine_name = 'favorite-videos'
+
+begin
+  response = client.create_engine(engine_name)
+  puts response
+rescue SwiftypeAppSearch::ClientException => e
+  puts e
+end
+```
+
+#### Destroying Engines
+
+```ruby
+engine_name = 'favorite-videos'
+
+begin
+  response = client.destroy_engine(engine_name)
+  puts response
+rescue SwiftypeAppSearch::ClientException => e
+  puts e
+end
+```
+
+#### Searching
 
 ```ruby
 engine_name = 'favorite-videos'
@@ -104,20 +161,27 @@ result_fields = { :title => { :raw => {} } }
 options = { :search_fields => search_fields, :result_fields => result_fields }
 
 begin
-  search_results = client.search(engine_name, query, options)
-  # handle search results
+  response = client.search(engine_name, query, options)
+  puts response
 rescue SwiftypeAppSearch::ClientException => e
-  # handle error
+  puts e
 end
 ```
 
-
 ## Running Tests
 
 ```bash
 export AS_API_KEY="your API key"
 export AS_ACCOUNT_HOST_KEY="your account host key"
-rspec
+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"
+bundle exec rspec
 ```
 
 ## Debugging API calls
@@ -135,4 +199,4 @@ If you need to debug an API call made by the client, there are a few things you
 
 ## Contributions
 
-To contribute code to this gem, please fork the repository and submit a pull request.
+To contribute code, please fork the repository and submit a pull request.

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

@@ -1,5 +1,6 @@
 require 'net/https'
 require 'json'
+require 'time'
 require 'swiftype-app-search/exceptions'
 require 'swiftype-app-search/version'
 require 'openssl'
@@ -46,7 +47,10 @@ module SwiftypeAppSearch
 
         if uri.scheme == 'https'
           http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          # st_ssl_verify_none provides a means to disable SSL verification for debugging purposes. An example
+          # is Charles, which uses a self-signed certificate in order to inspect https traffic. This will
+          # not be part of this client's public API, this is more of a development enablement option
+          http.verify_mode = ENV['st_ssl_verify_none'] == 'true' ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
           http.ca_file = File.join(File.dirname(__FILE__), '..', 'data', 'ca-bundle.crt')
           http.ssl_timeout = open_timeout
         end
@@ -86,6 +90,32 @@ module SwiftypeAppSearch
       @debug ||= (ENV['AS_DEBUG'] == 'true')
     end
 
+    def serialize_json(object)
+      JSON.generate(clean_json(object))
+    end
+
+    def clean_json(object)
+      case object
+      when Hash
+        object.inject({}) do |builder, (key, value)|
+          builder[key] = clean_json(value)
+          builder
+        end
+      when Enumerable
+        object.map { |value| clean_json(value) }
+      else
+        clean_atom(object)
+      end
+    end
+
+    def clean_atom(atom)
+      if atom.is_a?(Time)
+        atom.to_datetime
+      else
+        atom
+      end
+    end
+
     def build_request(method, uri, params)
       klass = case method
               when :get
@@ -101,7 +131,7 @@ module SwiftypeAppSearch
               end
 
       req = klass.new(uri.request_uri)
-      req.body = JSON.generate(params) unless params.length == 0
+      req.body = serialize_json(params) unless params.length == 0
 
       req['User-Agent'] = DEFAULT_USER_AGENT
       req['Content-Type'] = 'application/json'

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

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

data/spec/client_spec.rb

@@ -2,7 +2,7 @@ describe SwiftypeAppSearch::Client do
   let(:engine_name) { "ruby-client-test-#{Time.now.to_i}" }
 
   include_context "App Search Credentials"
-  let(:client) { SwiftypeAppSearch::Client.new(:account_host_key => as_account_host_key, :api_key => as_api_key) }
+  let(:client) { SwiftypeAppSearch::Client.new(client_options) }
 
   context 'Documents' do
     let(:document) { { 'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE' } }
@@ -40,6 +40,23 @@ describe SwiftypeAppSearch::Client do
           end.to raise_error(SwiftypeAppSearch::InvalidDocument, /Invalid field/)
         end
       end
+
+      context 'when a document has a Ruby Time object' do
+        let(:time_rfc3339) { '2018-01-01T01:01:01+00:00' }
+        let(:time_object) { Time.parse(time_rfc3339) }
+        let(:document) { { 'created_at' => time_object } }
+
+        it 'should serialize the time object in RFC 3339' do
+          response = subject
+          expect(response).to have_key('id')
+          document_id = response.fetch('id')
+          expect do
+            documents = client.get_documents(engine_name, [document_id])
+            expect(documents.size).to eq(1)
+            expect(documents.first['created_at']).to eq(time_rfc3339)
+          end.to_not raise_error
+        end
+      end
     end
 
     describe '#index_documents' do

data/spec/spec_helper.rb

@@ -7,6 +7,15 @@ 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') }
+  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
+    }.tap do |opts|
+      opts[:api_endpoint] = as_api_endpoint unless as_api_endpoint.nil?
+    end
+  end
 end
 
 RSpec.configure do |config|

data/swiftype-app-search.gemspec

@@ -16,8 +16,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'awesome_print', '~> 1.8'
+  s.add_development_dependency 'pry', '~> 0.11.3'
+  s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'webmock', '~> 3.3'
 
   s.add_runtime_dependency 'jwt', '~> 2.1'

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: swiftype-app-search
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Swiftype App Search API