elastic-enterprise-search 0.1.0

data/lib/elastic/enterprise-search.rb

@@ -0,0 +1,7 @@
+require 'elastic/enterprise-search/client'
+
+module Elastic
+  module EnterpriseSearch
+    extend Elastic::EnterpriseSearch::Configuration
+  end
+end

data/lib/elastic/enterprise-search/client.rb

@@ -0,0 +1,92 @@
+require 'set'
+require 'elastic/enterprise-search/configuration'
+require 'elastic/enterprise-search/request'
+require 'elastic/enterprise-search/utils'
+
+module Elastic
+  module EnterpriseSearch
+    # API client for the {Elastic Enterprise Search API}[https://swiftype.com/enterprise-search].
+    class Client
+      DEFAULT_TIMEOUT = 15
+
+      include Elastic::EnterpriseSearch::Request
+
+      def self.configure(&block)
+        Elastic::EnterpriseSearch.configure &block
+      end
+
+      # Create a new Elastic::EnterpriseSearch::Client client
+      #
+      # @param options [Hash] a hash of configuration options that will override what is set on the Elastic::EnterpriseSearch class.
+      # @option options [String] :access_token an Access Token to use for this client
+      # @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
+      # @option options [String] :proxy url of proxy to use, ex: "http://localhost:8888"
+      def initialize(options = {})
+        @options = options
+      end
+
+      def access_token
+        @options[:access_token] || Elastic::EnterpriseSearch.access_token
+      end
+
+      def open_timeout
+        @options[:open_timeout] || DEFAULT_TIMEOUT
+      end
+
+      def proxy
+        @options[:proxy]
+      end
+
+      def overall_timeout
+        (@options[:overall_timeout] || DEFAULT_TIMEOUT).to_f
+      end
+
+      # Documents have fields that can be searched or filtered.
+      #
+      # For more information on indexing documents, see the {Content Source documentation}[https://swiftype.com/documentation/enterprise-search/guides/content-sources].
+      module ContentSourceDocuments
+
+        # Index a batch of documents using the {Content Source API}[https://swiftype.com/documentation/enterprise-search/api/custom-sources].
+        #
+        # @param [String] content_source_key the unique Content Source key as found in your Content Sources dashboard
+        # @param [Array] documents an Array of Document Hashes
+        #
+        # @return [Array<Hash>] an Array of Document indexing Results
+        #
+        # @raise [Elastic::EnterpriseSearch::InvalidDocument] when a single document is missing required fields or contains unsupported fields
+        # @raise [Timeout::Error] when timeout expires waiting for results
+        def index_documents(content_source_key, documents)
+          documents = Array(documents).map! { |document| normalize_document(document) }
+
+          async_create_or_update_documents(content_source_key, documents)
+        end
+
+        # Destroy a batch of documents given a list of external IDs
+        #
+        # @param [Array<String>] document_ids an Array of Document External IDs
+        #
+        # @return [Array<Hash>] an Array of Document destroy result hashes
+        #
+        # @raise [Timeout::Error] when timeout expires waiting for results
+        def destroy_documents(content_source_key, document_ids)
+          document_ids = Array(document_ids)
+          post("ent/sources/#{content_source_key}/documents/bulk_destroy.json", document_ids)
+        end
+
+        private
+
+        def async_create_or_update_documents(content_source_key, documents)
+          post("ent/sources/#{content_source_key}/documents/bulk_create.json", documents)
+        end
+
+        def normalize_document(document)
+          Utils.stringify_keys(document)
+        end
+      end
+
+      include Elastic::EnterpriseSearch::Client::ContentSourceDocuments
+    end
+  end
+end

data/lib/elastic/enterprise-search/configuration.rb

@@ -0,0 +1,54 @@
+require 'uri'
+require 'elastic/enterprise-search/version'
+
+module Elastic
+  module EnterpriseSearch
+    module Configuration
+      DEFAULT_ENDPOINT = "http://localhost:3002/api/v1/"
+
+      VALID_OPTIONS_KEYS = [
+        :access_token,
+        :user_agent,
+        :endpoint
+      ].freeze
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def self.extended(base)
+        base.reset
+      end
+
+      # Reset configuration to default values.
+      def reset
+        self.access_token = nil
+        self.endpoint = DEFAULT_ENDPOINT
+        self.user_agent = nil
+        self
+      end
+
+      # Yields the Elastic::EnterpriseSearch::Configuration module which can be used to set configuration options.
+      #
+      # @return self
+      def configure
+        yield self
+        self
+      end
+
+      # Return a hash of the configured options.
+      def options
+        options = {}
+        VALID_OPTIONS_KEYS.each{ |k| options[k] = send(k) }
+        options
+      end
+
+      # setter for endpoint that ensures it always ends in '/'
+      def endpoint=(endpoint)
+        if endpoint.end_with?('/')
+          @endpoint = endpoint
+        else
+          @endpoint = "#{endpoint}/"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Elastic
+  module EnterpriseSearch
+    class ClientException < StandardError; end
+    class NonExistentRecord < ClientException; end
+    class InvalidCredentials < ClientException; end
+    class BadRequest < ClientException; end
+    class Forbidden < ClientException; end
+    class UnexpectedHTTPException < ClientException; end
+    class InvalidDocument < ClientException; end
+  end
+end

data/lib/elastic/enterprise-search/request.rb

@@ -0,0 +1,113 @@
+require 'net/https'
+require 'json'
+require 'elastic/enterprise-search/exceptions'
+require 'openssl'
+
+module Elastic
+  module EnterpriseSearch
+    CLIENT_NAME = 'elastic-enterprise-search-ruby'
+    CLIENT_VERSION = Elastic::EnterpriseSearch::VERSION
+
+    module Request
+      def get(path, params={})
+        request(:get, path, params)
+      end
+
+      def post(path, params={})
+        request(:post, path, params)
+      end
+
+      def put(path, params={})
+        request(:put, path, params)
+      end
+
+      def delete(path, params={})
+        request(:delete, path, params)
+      end
+
+      # Construct and send a request to the API.
+      #
+      # @raise [Timeout::Error] when the timeout expires
+      def request(method, path, params = {})
+        Timeout.timeout(overall_timeout) do
+          uri = URI.parse("#{Elastic::EnterpriseSearch.endpoint}#{path}")
+
+          request = build_request(method, uri, params)
+
+          if proxy
+            proxy_parts = URI.parse(proxy)
+            http = Net::HTTP.new(uri.host, uri.port, proxy_parts.host, proxy_parts.port, proxy_parts.user, proxy_parts.password)
+          else
+            http = Net::HTTP.new(uri.host, uri.port)
+          end
+
+          http.open_timeout = open_timeout
+          http.read_timeout = overall_timeout
+
+          if uri.scheme == 'https'
+            http.use_ssl = true
+            # 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
+
+          response = http.request(request)
+          handle_errors(response)
+          JSON.parse(response.body) if response.body && response.body.strip != ''
+        end
+      end
+
+      private
+      def handle_errors(response)
+        case response
+        when Net::HTTPSuccess
+          response
+        when Net::HTTPUnauthorized
+          raise Elastic::EnterpriseSearch::InvalidCredentials
+        when Net::HTTPNotFound
+          raise Elastic::EnterpriseSearch::NonExistentRecord
+        when Net::HTTPBadRequest
+          raise Elastic::EnterpriseSearch::BadRequest
+        when Net::HTTPForbidden
+          raise Elastic::EnterpriseSearch::Forbidden
+        else
+          raise Elastic::EnterpriseSearch::UnexpectedHTTPException, "#{response.code} #{response.body}"
+        end
+      end
+
+      def build_request(method, uri, params)
+        klass = case method
+                when :get
+                  Net::HTTP::Get
+                when :post
+                  Net::HTTP::Post
+                when :put
+                  Net::HTTP::Put
+                when :delete
+                  Net::HTTP::Delete
+                end
+
+        case method
+        when :get, :delete
+          uri.query = URI.encode_www_form(params) if params && !params.empty?
+          req = klass.new(uri.request_uri)
+        when :post, :put
+          req = klass.new(uri.request_uri)
+          req.body = JSON.generate(params) unless params.length == 0
+        end
+
+        req['User-Agent'] = Elastic::EnterpriseSearch.user_agent if Elastic::EnterpriseSearch.user_agent
+        req['Content-Type'] = 'application/json'
+        req['X-Swiftype-Client'] = CLIENT_NAME
+        req['X-Swiftype-Client-Version'] = CLIENT_VERSION
+        req['Authorization'] = "Bearer #{access_token}"
+        puts req
+
+        req
+      end
+    end
+  end
+end

data/lib/elastic/enterprise-search/utils.rb

@@ -0,0 +1,15 @@
+module Elastic
+  module EnterpriseSearch
+    module Utils
+      extend self
+
+      def stringify_keys(hash)
+        output = {}
+        hash.each do |key, value|
+          output[key.to_s] = value
+        end
+        output
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Elastic
+  module EnterpriseSearch
+    VERSION = '0.1.0'
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Elastic::EnterpriseSearch::Client do
+  let(:engine_slug) { 'enterprise-search-api-example' }
+  let(:client) { Elastic::EnterpriseSearch::Client.new }
+
+  before :each do
+    Elastic::EnterpriseSearch.access_token = 'cGUN-vBokevBhhzyA669'
+  end
+
+  context 'ContentSourceDocuments' do
+    def check_receipt_response_format(response, options = {})
+      expect(response.keys).to match_array(["document_receipts", "batch_link"])
+      expect(response["document_receipts"]).to be_a_kind_of(Array)
+      expect(response["document_receipts"].first.keys).to match_array(["id", "id", "links", "status", "errors"])
+      expect(response["document_receipts"].first["id"]).to eq(options[:id]) if options[:id]
+      expect(response["document_receipts"].first["status"]).to eq(options[:status]) if options[:status]
+      expect(response["document_receipts"].first["errors"]).to eq(options[:errors]) if options[:errors]
+    end
+
+    let(:content_source_key) { '59542d332139de0acacc7dd4' }
+    let(:documents) do
+      [{'id'=>'INscMGmhmX4',
+        'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE',
+        'title' => 'The Original Grumpy Cat',
+        'body' => 'this is a test'},
+       {'id'=>'JNDFojsd02',
+               'url' => 'http://www.youtube.com/watch?v=tsdfhk2j',
+               'title' => 'Another Grumpy Cat',
+               'body' => 'this is also a test'}]
+    end
+
+    context '#index_documents' do
+      it 'returns results when successful' do
+        VCR.use_cassette(:async_create_or_update_document_success) do
+          response = client.index_documents(content_source_key, documents)
+            expect(response.size).to eq(2)
+        end
+      end
+    end
+
+    context '#destroy_documents' do
+      it 'returns #async_create_or_update_documents format return when async has been passed as true' do
+        VCR.use_cassette(:async_create_or_update_document_success) do
+          VCR.use_cassette(:document_receipts_multiple_complete) do
+            client.index_documents(content_source_key, documents)
+            VCR.use_cassette(:destroy_documents_success) do
+              response = client.destroy_documents(content_source_key, [documents.first['id']])
+              expect(response.size).to eq(1)
+              expect(response.first['success']).to eq(true)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'Configuration' do
+  context '.endpoint' do
+    context 'with a trailing /' do
+      it 'adds / to the end of of the URL' do
+        Elastic::EnterpriseSearch.endpoint = 'https://api.swiftype.com/api/v1'
+        expect(Elastic::EnterpriseSearch.endpoint).to eq('https://api.swiftype.com/api/v1/')
+      end
+    end
+
+    context 'with a trailing /' do
+      it 'leaves the URL alone' do
+        Elastic::EnterpriseSearch.endpoint = 'https://api.swiftype.com/api/v1/'
+        expect(Elastic::EnterpriseSearch.endpoint).to eq('https://api.swiftype.com/api/v1/')
+      end
+    end
+  end
+end

data/spec/fixtures/vcr/async_create_or_update_document_success.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/v1/ent/sources/59542d332139de0acacc7dd4/documents/bulk_create.json
+    body:
+      encoding: UTF-8
+      string: '[{"id":"INscMGmhmX4","url":"http://www.youtube.com/watch?v=v1uyQZNg2vE","title":"The
+        Original Grumpy Cat","body":"this is a test"},{"id":"JNDFojsd02","url":"http://www.youtube.com/watch?v=tsdfhk2j","title":"Another
+        Grumpy Cat","body":"this is also a test"}]'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer cGUN-vBokevBhhzyA669
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Cache-Control:
+      - no-cache
+      Set-Cookie:
+      - _st_main_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFVEkiJWE4NGIxMjQ0YjgzNzYwOWU2NzljZGYyMjkwYzM2ODA4BjsAVA%3D%3D--d0ca869176aa0b9f3d57baf66152897d305fabae;
+        path=/; expires=Mon, 05 Jul 2027 17:52:09 -0000; HttpOnly
+      X-Request-Id:
+      - '09b779a9-1704-46e7-991d-9e92e67b0001'
+      X-Runtime:
+      - '0.115497'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: UTF-8
+      string: '[{"id":null,"id":"1234","errors":[]},{"id":null,"id":"1235","errors":[]}]'
+    http_version:
+  recorded_at: Wed, 05 Jul 2017 17:52:09 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/destroy_documents_success.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/v1/ent/sources/59542d332139de0acacc7dd4/documents/bulk_destroy.json
+    body:
+      encoding: UTF-8
+      string: '["INscMGmhmX4"]'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      Content-Type:
+      - application/json
+      Authorization:
+      - Bearer cGUN-vBokevBhhzyA669
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"ab494a471abdde82a270b9d9562b7bb9"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_main_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFVEkiJTQ5ZGE4NjY4ZjZmY2Q2OTM2MGM0OTIyMDFkNmRmMzFlBjsAVA%3D%3D--75e0f9002e5f32100e4814a9dc015ffd43a5b6eb;
+        path=/; expires=Mon, 05 Jul 2027 17:52:12 -0000; HttpOnly
+      X-Request-Id:
+      - ec1754ea-5fa3-474f-87ba-e754e4c62553
+      X-Runtime:
+      - '1.367282'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: UTF-8
+      string: '[{"id":"INscMGmhmX4","success":true}]'
+    http_version:
+  recorded_at: Wed, 05 Jul 2017 17:52:12 GMT
+recorded_with: VCR 3.0.3