opensearch-dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6345138436b27bcbb4ed3dc062220d4945ae079acb22544f5a16f0cc8d44a43f
+  data.tar.gz: 2c043715ba32ae26ef06ba43ffbdbdee4ffa03c3b39464c9ccbbb4e4c6dea298
+SHA512:
+  metadata.gz: e1b52a6498cbf4daa244681e35fa6b5ea7bd910f097e5271c10e2eb70ba22e4baf6031c438675bd147e3ec785594c83e93728e583f9d4477e7dcc34eb25045a0
+  data.tar.gz: d2dcdd9b5633514157410a1691b8a838b6ebf9c592ea0bb67e948430526dc41d230ebe2918884a62a2d8fcdf04d88dea6d0c718601b32140f6c2a581e702f81c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,51 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opensearch-dsl.gemspec
+gemspec
+
+if File.exist? File.expand_path('../../opensearch/opensearch.gemspec', __FILE__)
+  gem 'opensearch-ruby', path: File.expand_path('../../opensearch', __FILE__), require: false
+end
+
+if File.exist? File.expand_path('../../opensearch-transport', __FILE__)
+  gem 'opensearch-transport', path: File.expand_path('../../opensearch-transport', __FILE__), require: true
+end
+
+if File.exist? File.expand_path('../../opensearch-api', __FILE__)
+  gem 'opensearch-api', path: File.expand_path('../../opensearch-api', __FILE__), require: false
+end
+
+group :development do
+  gem 'rspec'
+  if defined?(JRUBY_VERSION)
+    gem 'pry-nav'
+  else
+    gem 'pry-byebug'
+  end
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

data/README.md

@@ -0,0 +1,149 @@
+# OpenSearch::DSL
+
+The `opensearch-dsl` library provides a Ruby API for
+the `OpenSearch Query DSL`
+
+The library is compatible with Ruby 1.9 or higher and OpenSearch 1.0.0 and higher.
+
+## Installation
+
+Install the package from [Rubygems](https://rubygems.org):
+
+    gem install opensearch-dsl
+
+To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
+
+    gem 'opensearch-dsl', git: 'git://github.com/opensearch-project/opensearch-ruby.git'
+
+or install it from a source code checkout:
+
+    git clone https://github.com/opensearch-project/opensearch-ruby
+    cd opensearch-ruby/opensearch-dsl
+    bundle install
+    rake install
+
+## Usage
+
+The library is designed as a group of standalone Ruby modules, classes and DSL methods,
+which provide an idiomatic way to build complex search definitions
+
+Let's have a simple example using the declarative variant:
+
+```ruby
+require 'opensearch'
+require 'opensearch/dsl'
+include OpenSearch::DSL
+
+# If you want to use authentication credentials
+client = OpenSearch::Client.new url: 'https://admin:admin@localhost:9200', log: true
+
+# If you don't want to use authentication credentials
+# client = OpenSearch::Client.new url: 'http://localhost:9200', log: true
+
+index_name = 'my-dsl-index'
+index_body = {
+  'settings': {
+    'index': {
+      'number_of_shards': 4
+    }
+  }
+}
+response = client.indices.create(
+        index: index_name,
+        body: index_body
+)
+
+puts 'Creating index:'
+puts response
+
+# Add a document to the index.
+document = {
+        'title': 'ruby',
+        'description': 'beta',
+        'category': 'search'
+}
+id = '1'
+
+response = client.index(
+        index: index_name,
+        body: document,
+        id: id,
+        refresh: true
+)
+
+puts 'Adding document:'
+puts response
+
+response = client.search index: index_name, body: search {
+      query do
+            bool do
+                  filter do
+                        term category: "search"
+                  end
+                  must do
+                        match title: "ruby"
+                  end
+            end
+      end
+}.to_hash
+
+puts 'Search results:'
+puts response
+
+
+# Delete the document.
+response = client.delete(
+        index: index_name,
+        id: id
+)
+
+puts 'Deleting document:'
+puts response
+
+# Delete the index.
+response = client.indices.delete(
+        index: index_name
+)
+
+puts 'Deleting index:'
+puts response
+
+```
+
+## Features Overview
+
+The library allows to programatically build complex search definitions for OpenSearch in Ruby,
+which are translated to Hashes, and ultimately, JSON, the language of OpenSearch.
+
+All OpenSearch DSL features are supported, namely:
+
+* Queries and Filter context
+* Aggregations
+* Suggestions
+* Sorting
+* Pagination
+* Options
+
+## Development
+
+To work on the code, clone the repository and install the dependencies:
+
+```
+git clone https://github.com/opensearch-project/opensearch-ruby
+cd opensearch-ruby/opensearch-dsl/
+bundle install
+```
+
+Use the Rake tasks to run the test suites:
+
+```
+bundle exec rake test:unit
+bundle exec rake test:integration
+```
+
+To launch a separate OpenSearch server for integration tests,
+see instructions in the main [README](../README.md#development).
+
+## License
+
+This software is licensed under the [Apache 2 license](./LICENSE).

data/Rakefile

@@ -0,0 +1,234 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+require "bundler/gem_tasks"
+
+task(:default) { system "rake --tasks" }
+task  :test    => 'test:unit'
+
+# ----- Test tasks ------------------------------------------------------------
+
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+namespace :test do
+
+  desc "Wait for OpenSearch to be in a green state"
+  task :wait_for_green do
+    sh '../scripts/wait-cluster.sh'
+  end
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  Rake::TestTask.new(:unit) do |test|
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/unit/**/*_test.rb"]
+    test.deps = [ :spec ]
+    test.verbose = false
+    test.warning = false
+  end
+
+  Rake::TestTask.new(:integration) do |test|
+    test.deps = [ :wait_for_green ]
+    test.libs << 'lib' << 'test'
+    test.test_files = FileList["test/integration/**/*_test.rb"]
+    test.verbose = false
+    test.warning = false
+  end
+
+  desc "Run unit and integration tests"
+  task :all do
+    Rake::Task['test:unit'].invoke
+    Rake::Task['test:integration'].invoke
+  end
+
+end
+
+# ----- Documentation tasks ---------------------------------------------------
+
+require 'yard'
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = %w| --embed-mixins --markup=markdown |
+end
+
+# ----- Code analysis tasks ---------------------------------------------------
+
+require 'cane/rake_task'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 15
+  cane.no_style = true
+end
+
+# ----- Generating the source code --------------------------------------------
+
+require 'net/http'
+require 'json'
+require 'coderay'
+
+namespace :generate do
+  desc <<-DESC.gsub(/^    /, '')
+    Generate Ruby source and tests for query/filter/aggregation
+
+    Pass the type of the component, the name, and any option methods as Rake task arguments.
+
+    Example:
+
+        $ rake generate:source[query,boosting]
+        Source: /.../opensearch-ruby/opensearch-dsl/lib/opensearch/dsl/search/queries/boosting.rb
+        ...
+        Test: /.../opensearch-ruby/opensearch-dsl/test/unit/queries/boosting_test.rb
+        ...
+
+        $ rake generate:source[query,common,query/cutoff_frequency/low_freq_operator/...]
+        Source: /.../opensearch-ruby/opensearch-dsl/lib/opensearch/dsl/search/queries/common.rb
+        ...
+        Test: /.../opensearch-ruby/opensearch-dsl/test/unit/queries/common_test.rb
+        ...
+
+  DESC
+  task :source, [:type, :name, :option_methods] do |task, options|
+    begin
+      query    = URI.escape("#{options[:name]} #{options[:type]}")
+      response = Net::HTTP.get('search.opensearch.org', "/search/?q=#{query}")
+      hits     = JSON.load(response)['hits']['hits']
+
+      if hit = hits.first
+        doc_url = ("http://opensearch.org" + hit['fields']['url']).gsub(/#.+$/, '') if hit['_score'] > 0.2
+      end
+    rescue Exception => e
+      puts "[!] ERROR: #{e.inspect}"
+    end unless ENV['NOCRAWL']
+
+    case options[:type]
+      when /query/
+        module_name = 'Queries'
+        path_name   = 'queries'
+        include_module = 'BaseComponent'
+      when /filter/
+        module_name = 'Filters'
+        path_name   = 'filters'
+        include_module = 'BaseComponent'
+      when /agg/
+        module_name = 'Aggregations'
+        path_name   = 'aggregations'
+        include_module = 'BaseAggregationComponent'
+      else raise ArgumentError, "Unknown DSL type [#{options[:type]}]"
+    end
+
+    name = options[:name].downcase
+
+    class_name = options[:name].split('_').map(&:capitalize).join
+
+    option_methods = options[:option_methods].to_s.split('/').reduce('') do |sum, item|
+      sum << "                "
+      sum << "option_method :#{item}"
+      sum << "\n" unless item == options[:option_methods].to_s.split('/').last
+      sum
+    end
+
+    option_methods = "\n\n#{option_methods}" unless option_methods.empty?
+
+    source = <<-RUBY.gsub(/^      /, '')
+      module OpenSearch
+        module DSL
+          module Search
+            module #{module_name}
+
+              # #{class_name} #{options[:type]}
+              #
+              # @example
+              #
+              # @see #{doc_url}
+              #
+              class #{class_name}
+                include #{include_module}#{option_methods}
+              end
+
+            end
+          end
+        end
+      end
+    RUBY
+
+    if options[:option_methods].to_s.empty?
+      test_option_methods = ''
+    else
+      setup = "\n" + options[:option_methods].to_s.split('/').reduce('') do |sum,item|
+        sum << "          subject.#{item} 'bar'\n"; sum
+      end
+      asserts = "\n          assert_equal %w[ #{options[:option_methods].to_s.split('/').sort.join(' ')} ],\n                       subject.to_hash[:#{name}][:foo].keys.map(&:to_s).sort"
+      asserts << "\n          assert_equal 'bar', subject.to_hash[:#{name}][:foo][:#{options[:option_methods].to_s.split('/').first}]"
+
+      test_option_methods =  <<-RUBY.gsub(/^        /, '')
+
+        should "have option methods" do
+          subject = #{class_name}.new :foo
+          #{setup}#{asserts}
+        end
+
+        should "take a block" do
+          subject = #{class_name}.new :foo do
+            #{options[:option_methods].to_s.split('/').first} 'bar'
+          end
+          assert_equal({#{name}: { foo: { #{options[:option_methods].to_s.split('/').first}: 'bar' } }}, subject.to_hash)
+        end
+      RUBY
+    end
+
+    test = <<-RUBY.gsub(/^      /, '')
+      require 'test_helper'
+
+      module OpenSearch
+        module Test
+          module #{module_name}
+            class #{class_name}Test < ::OpenSearch::Test::UnitTestCase
+              include OpenSearch::DSL::Search::#{module_name}
+
+              context "#{class_name} #{options[:type]}" do
+                subject { #{class_name}.new }
+
+                should "be converted to a Hash" do
+                  assert_equal({ #{name}: {} }, subject.to_hash)
+                end
+                #{test_option_methods.empty? ? '' : test_option_methods.split("\n").map { |l| '                ' + l }.join("\n")}
+              end
+            end
+          end
+        end
+      end
+    RUBY
+
+    source_full_path = File.expand_path("../lib/opensearch/dsl/search/#{path_name}/#{name}.rb", __FILE__)
+    test_full_path   = File.expand_path("../test/unit/#{path_name}/#{name}_test.rb", __FILE__)
+
+    puts '-'*80, "Source: #{source_full_path}", '-'*80, "\n", CodeRay.scan(source, :ruby).terminal, "\n\n"
+    puts '-'*80, "Test: #{test_full_path}",     '-'*80, "\n", CodeRay.scan(test,   :ruby).terminal, "\n"
+
+    File.open(source_full_path, 'w') { |file| file << source }
+
+    File.open(test_full_path, 'w') { |file| file << test }
+  end
+end