elastic-enterprise-search 0.3.0 → 7.13.0.pre

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

@@ -1,112 +1,94 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
 require 'net/https'
 require 'json'
 require 'elastic/enterprise-search/exceptions'
-require 'openssl'
+require 'base64'
 
 module Elastic
   module EnterpriseSearch
-    CLIENT_NAME = 'elastic-enterprise-search-ruby'
+    CLIENT_NAME = 'elastic-enteprise-search-ruby'
     CLIENT_VERSION = Elastic::EnterpriseSearch::VERSION
 
+    # Module included in Elastic::Enterprise::Client for http requests.
     module Request
-      def get(path, params={})
-        request(:get, path, params)
+      def get(path, params = {}, headers = {})
+        request(:get, path, params, headers)
       end
 
-      def post(path, params={})
-        request(:post, path, params)
+      def post(path, params = {}, body = {}, headers = {})
+        request(:post, path, params, body, headers)
       end
 
-      def put(path, params={})
-        request(:put, path, params)
+      def put(path, params = {}, body = {}, headers = {})
+        request(:put, path, params, body, headers)
       end
 
-      def delete(path, params={})
-        request(:delete, path, params)
+      def delete(path, params = {}, headers = {})
+        request(:delete, path, params, headers)
       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
+      def request(method, path, params = {}, body = {}, headers = {})
+        meta_headers = { authorization: decide_authorization(params), user_agent: request_user_agent }
+        headers = if headers.nil? || !headers.is_a?(Hash)
+                    meta_headers
+                  else
+                    headers.merge(meta_headers)
+                  end
+
+        @transport.perform_request(method.to_s.upcase, path, params, body, headers)
+      end
 
-          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.realpath(File.join(File.dirname(__FILE__), '..', '..', 'data', 'ca-bundle.crt'))
-            http.ssl_timeout = open_timeout
-          end
+      def setup_authentication_header
+        basic_auth_header
+      end
 
-          response = http.request(request)
-          handle_errors(response)
-          JSON.parse(response.body) if response.body && response.body.strip != ''
-        end
+      def basic_auth_header
+        credentials = Base64.strict_encode64("#{http_auth[:user]}:#{http_auth[:password]}")
+        "Basic #{credentials}"
       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, "#{response.code} #{response.body}"
-        when Net::HTTPForbidden
-          raise Elastic::EnterpriseSearch::Forbidden
-        else
-          raise Elastic::EnterpriseSearch::UnexpectedHTTPException, "#{response.code} #{response.body}"
+
+      def request_user_agent
+        ua = "#{CLIENT_NAME}/#{CLIENT_VERSION}"
+        meta = ["RUBY_VERSION: #{RUBY_VERSION}"]
+        if RbConfig::CONFIG && RbConfig::CONFIG['host_os']
+          meta << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} " \
+                  "#{RbConfig::CONFIG['target_cpu']}"
         end
+        meta << "elasticsearch-transport: #{Elasticsearch::Transport::VERSION}"
+        "#{ua} (#{meta.join('; ')})"
       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
+      def decide_authorization(params)
+        if params[:grant_type] == 'authorization_code'
+          "Bearer #{params[:code]}"
+        elsif params[:access_token]
+          "Bearer #{params.delete(:access_token)}"
+        else
+          setup_authentication_header
         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

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

@@ -1,7 +1,27 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
 module Elastic
   module EnterpriseSearch
+    # Util functions
     module Utils
-      extend self
+      DEFAULT_HOST = 'http://localhost:3002'
 
       def stringify_keys(hash)
         output = {}
@@ -10,6 +30,13 @@ module Elastic
         end
         output
       end
+
+      def self.symbolize_keys(hash)
+        hash.each_with_object({}) do |(key, value), out|
+          new_key = key.respond_to?(:to_sym) ? key.to_sym : key
+          out[new_key] = value
+        end
+      end
     end
   end
 end

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

@@ -1,5 +1,24 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
 module Elastic
   module EnterpriseSearch
-    VERSION = '0.3.0'
+    VERSION = '7.13.0.pre'
   end
 end

data/lib/elastic/enterprise_search.rb

@@ -0,0 +1,49 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# frozen_string_literal: true
+
+require 'elastic/enterprise-search/version'
+
+# Require API code:
+[
+  "#{File.dirname(__FILE__)}/enterprise-search/api/*.rb",
+  "#{File.dirname(__FILE__)}/workplace-search/api/*.rb",
+  "#{File.dirname(__FILE__)}/app-search/api/*.rb"
+].each do |path|
+  Dir[path].sort.each { |file| require file }
+end
+
+require 'elastic/enterprise-search/client'
+require 'elastic/workplace-search/workplace_search'
+require 'elastic/app-search/app_search'
+
+module Elastic
+  # If the version is X.X.X.pre/alpha/beta, use X.X.Xp for the meta-header:
+  def self.client_meta_version
+    regexp = /^([0-9]+\.[0-9]+\.[0-9]+)\.?([a-z0-9.-]+)?$/
+    match = Elastic::EnterpriseSearch::VERSION.match(regexp)
+    return "#{match[1]}p" if match[2]
+
+    Elastic::EnterpriseSearch::VERSION
+  end
+
+  ENTERPRISE_SERVICE_VERSION = [:ent, client_meta_version].freeze
+
+  module EnterpriseSearch
+  end
+end

data/lib/elastic/workplace-search/api/add_user_permissions.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module EnterpriseSearch
+    module WorkplaceSearch
+      module Actions
+        # Permissions - Adds one or more new permissions atop existing permissions
+        # Add one or more permission for a given user. Permissions are added atop the existing
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Array] :body List of permissions
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#add-one
+        #
+        def add_user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/add/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/content_source.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module EnterpriseSearch
+    module WorkplaceSearch
+      module Actions
+        # ContentSources - Retrieves a content source by ID
+        # Retrieves a content source by ID
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#get-content-source-api
+        #
+        def content_source(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_id}/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/create_analytics_event.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elastic
+  module EnterpriseSearch
+    module WorkplaceSearch
+      module Actions
+        # Analytics - Capture click and feedback analytic events
+        # Capture Analytic events for click and feedback
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :access_token OAuth Access Token (*Required*)
+        # @option arguments [Object] :body Workplace Search analytics event (Required: type, query_id, page, content_source_id, document_id, rank)
+        # @option body [String] :type
+        # @option body [String] :query_id query identifier for the event
+        # @option body [Integer] :page page number of the document in the query result set
+        # @option body [String] :content_source_id content source identifier for the event document
+        # @option body [String] :document_id document identifier for the event
+        # @option body [Integer] :rank rank of the document in the overall result set
+        # @option body [String] :event the target identifier for a click event
+        # @option body [Integer] :score the feedback score, constrained to the values -1 or 1
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-analytics-api.html
+        #
+        def create_analytics_event(arguments = {})
+          raise ArgumentError, "Required parameter 'access_token' missing" unless arguments[:access_token]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            'api/ws/v1/analytics/event/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end