elastic-enterprise-search 0.3.1 → 7.10.0.beta.1

data/Rakefile

@@ -1 +1,71 @@
-require "bundler/gem_tasks"
+# 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 'rspec/core/rake_task'
+require_relative './lib/generator/endpoint_generator'
+
+SPECS = [:workplace, :enterprise, :app].freeze
+
+desc 'Generate code from JSON API spec - rake generate[wokplace||enterprise||app]'
+task :generate, [:files] do |_, params|
+  if params[:files].nil?
+    SPECS.each do |spec|
+      generate_specs(spec)
+    end
+  else
+    params[:files].split(' ').each do |arg|
+      unless SPECS.include?(arg.to_sym)
+        raise "Available parameters are #{SPECS.map(&:to_s).join(', ')}. No spec for #{arg}"
+      end
+
+      generate_specs(arg)
+    end
+  end
+end
+
+def generate_specs(name)
+  Elastic::Generator::EndpointGenerator.new(name.to_sym).generate
+end
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -r rubygems -I lib -r elastic-enterprise-search.rb'
+end
+
+desc 'Run Elastic Enterprise Search stack'
+task :stack, [:version] do |_, params|
+  sh "STACK_VERSION=#{params[:version]} ./.ci/run-local.sh"
+end
+
+namespace :spec do
+  desc 'Run client tests'
+  task :client do
+    sh 'rspec spec/enterprise-search spec/workplace-search spec/app-search'
+  end
+
+  desc 'Run integration tests'
+  task :integration do
+    sh 'rspec spec/integration'
+  end
+
+  desc 'Run all tests'
+  task :all do
+    sh 'rspec spec'
+  end
+end

data/elastic-enterprise-search.gemspec

@@ -1,24 +1,58 @@
-$:.push File.expand_path("../lib", __FILE__)
-require "elastic/enterprise-search/version"
+# 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
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'elastic/enterprise-search/version'
+
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |s|
-  s.name        = "elastic-enterprise-search"
+  s.required_ruby_version = '>= 2.5'
+  s.name        = 'elastic-enterprise-search'
   s.version     = Elastic::EnterpriseSearch::VERSION
-  s.authors     = ["Quin Hoxie"]
-  s.email       = ["support@elastic.co"]
-  s.homepage    = "https://github.com/elastic/enterprise-search-ruby"
-  s.summary     = %q{Deprecated gem for accessing the Elastic Workplace Search API. Use elastic-workplace-search instead.}
-  s.description = %q{Deprecated API client for accessing the Elastic Workplace Search API. Use elastic-workplace-search instead.}
-  s.post_install_message = "DEPRECATION WARNING: The elastic-enterprise-search gem has been deprecated and replaced by elastic-workplace-search."
-  s.licenses    = ['Apache-2.0']
+  s.authors     = ['Fernando Briano']
+  s.email       = ['support@elastic.co']
+  s.homepage    = 'https://github.com/elastic/enterprise-search-ruby'
+  s.summary     = 'Official gem for accessing the Elastic Enterprise Search APIs'
+  s.description = <<~DESCRIPTION
+    API client for accessing the Elastic Enterprise APIs. This gem is in a beta state.
+  DESCRIPTION
+  s.licenses = ['Apache-2.0']
+
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/elastic/enterprise-search-ruby/issues',
+    'documentation_uri' => 'https://github.com/elastic/enterprise-search-ruby/blob/master/README.md',
+    'homepage_uri' => 'https://www.elastic.co/enterprise-search',
+    'source_code_uri' => 'https://github.com/elastic/enterprise-search-ruby'
+  }
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  s.add_development_dependency 'rspec', '~> 3.0.0'
+  s.add_dependency 'elasticsearch-transport'
   s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)
+  s.add_development_dependency 'rspec', '~> 3.9.0'
+  s.add_development_dependency 'rspec_junit_formatter'
+  s.add_development_dependency 'rubocop', '~> 1.0.0'
   s.add_development_dependency 'vcr', '~> 3.0.3'
   s.add_development_dependency 'webmock'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/elastic-enterprise-search.rb

@@ -1 +1,20 @@
-require 'elastic/enterprise-search'
+# 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'

data/lib/elastic/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: ../../.rubocop.yml
+
+Layout/LineLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false

data/lib/elastic/app-search/api/add_meta_engine_source.rb

@@ -0,0 +1,48 @@
+# 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 AppSearch
+      module Actions
+        # Engine - Add a source engine to an existing meta engine
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option body - The request body
+        #
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/meta-engines.html#meta-engines-add-source-engines
+        #
+        def add_meta_engine_source(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/source_engines/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/api_logs.rb

@@ -0,0 +1,63 @@
+# 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 AppSearch
+      module Actions
+        # Logs - The API Log displays API request and response data at the Engine level
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option from_date [String] Filter date from (*Required*)
+        # @option to_date [String] Filter date to (*Required*)
+        # @option current_page [String] The page to fetch. Defaults to 1
+        # @option page_size [String] The number of results per page
+        # @option query [String] Use this to specify a particular endpoint, like analytics, search, curations and so on
+        # @option http_status_filter [String] Filter based on a particular status code: 400, 401, 403, 429, 200
+        # @option http_method_filter [String] Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
+        # @option sort_direction [String] Would you like to have your results ascending, oldest to newest, or descending, newest to oldest?
+        # @option body - The request body
+        #
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/api-logs.html
+        #
+        def api_logs(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'from_date' missing" unless arguments[:from_date]
+          raise ArgumentError, "Required parameter 'to_date' missing" unless arguments[:to_date]
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+
+          arguments[:from_date] = date_to_rfc3339(arguments[:from_date])
+          arguments['filters[date][from]'] = arguments.delete(:from_date)
+          arguments[:to_date] = date_to_rfc3339(arguments[:to_date])
+          arguments['filters[date][to]'] = arguments.delete(:to_date)
+
+          request(
+            :get,
+            "api/as/v1/engines/#{engine_name}/logs/api/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/count_analytics.rb

@@ -0,0 +1,50 @@
+# 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 AppSearch
+      module Actions
+        # Analytics - Returns the number of clicks and total number of queries over a period
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option filters [Array] Analytics filters
+        # @option interval [String] You can define an interval along with your date range. Can be either hour or day
+        # @option body - The request body
+        #
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/counts.html
+        #
+        def count_analytics(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :get,
+            "api/as/v1/engines/#{engine_name}/analytics/counts/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_curation.rb

@@ -0,0 +1,52 @@
+# 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 AppSearch
+      module Actions
+        # Curations - Create a new curation
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option queries [Array] List of affected search queries (*Required*)
+        # @option promoted_doc_ids [] List of promoted document IDs
+        # @option hidden_doc_ids [] List of hidden document IDs
+        # @option body - The request body
+        #
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-create
+        #
+        def create_curation(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'queries' missing" unless arguments[:queries]
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/curations/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_engine.rb

@@ -0,0 +1,51 @@
+# 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 AppSearch
+      module Actions
+        # Engine - Creates a new engine
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option name [String] Engine name (*Required*)
+        # @option language [String] Engine language (null for universal)
+        # @option type [String] Engine type
+        # @option source_engines [Array] Sources engines list
+        # @option body - The request body
+        #
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-create
+        #
+        def create_engine(arguments = {})
+          raise ArgumentError, "Required parameter 'name' missing" unless arguments[:name]
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            'api/as/v1/engines/',
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_synonym_set.rb

@@ -0,0 +1,50 @@
+# 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 AppSearch
+      module Actions
+        # Synonyms - Create a new synonym set
+        #
+        # @param engine_name [String]  (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option synonyms [] List of synonyms words (*Required*)
+        # @option body - The request body
+        #
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-create
+        #
+        def create_synonym_set(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'synonyms' missing" unless arguments[:synonyms]
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            "api/as/v1/engines/#{engine_name}/synonyms/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end