elastic-workplace-search 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eff4106e056b0af7231e0e10e140690beeefd94e9bc7ac6e3f0160cceaa39a96
+  data.tar.gz: f379feb78cb139c41dc4d0edc5cd6708e5aec572b88dba7a1d58b8eb446d6e31
+SHA512:
+  metadata.gz: 15316ac5167d84e8e8cda1cbd953729cb38e74b81523af9588415debfd98639d6d59504ad221c274953e393efb5d276bbef2c3d72d353e8613cee817d687c60d
+  data.tar.gz: dce46994ec6435935162bfbe93335ab9e9d403e1ba0e1d802edb5d22dbc00c0ab9edaf581a9be6ef5167bb3585b63e1f7f3758b92377d30ab6bd057567bc4d18

data/.circleci/config.yml

@@ -0,0 +1,68 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2.1
+
+executors:
+  ruby-24: {docker: [{image: 'ruby:2.4'}]}
+  ruby-25: {docker: [{image: 'ruby:2.5'}]}
+  ruby-26: {docker: [{image: 'ruby:2.6'}]}
+  jruby-92: {docker: [{image: 'jruby:9.2.7-jdk'}]}
+
+jobs:
+  build:
+    parameters:
+      executor:
+        type: executor
+    executor: << parameters.executor >>
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+
+workflows:
+  run-tests:
+    jobs:
+    - build: {name: run-tests-ruby-2.4, executor: ruby-24}
+    - build: {name: run-tests-ruby-2.5, executor: ruby-25}
+    - build: {name: run-tests-ruby-2.6, executor: ruby-26}
+    - build: {name: run-tests-jruby-92, executor: jruby-92}

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.rvmrc
+.ruby-version
+.ruby-gemset
+.yardoc
+doc

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+script: rspec
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.4
+  - jruby
+jdk:
+  - oraclejdk8
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in elastic-workplace-search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 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 2019 Elasticsearch B.V.
+
+    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/NOTICE.txt

@@ -0,0 +1,3 @@
+Elastic Workplace Search Ruby client.
+
+ Copyright 2012-2020 Elasticsearch B.V.

data/README.md

@@ -0,0 +1,171 @@
+ <p align="center"><a href="https://circleci.com/gh/elastic/workplace-search-ruby"><img src="https://circleci.com/gh/elastic/workplace-search-ruby.svg?style=svg" alt="CircleCI build"></a></p>
+
+> A first-party Ruby client for [Elastic Workplace Search](https://www.elastic.co/workplace-search).
+
+## Contents
+
++ [Getting started](#getting-started-)
++ [Usage](#usage)
++ [FAQ](#faq-)
++ [Contribute](#contribute-)
++ [License](#license-)
+
+***
+
+## Getting started 🐣
+
+To install the gem, execute:
+
+```bash
+gem install elastic-workplace-search
+```
+
+Or place `gem 'elastic-workplace-search', '~> 0.4.0` in your `Gemfile` and run `bundle install`.
+
+## Usage
+
+Create a new instance of the Elastic Workplace Search client with your access token:
+
+```ruby
+Elastic::WorkplaceSearch.access_token = '' # your access token
+client = Elastic::WorkplaceSearch::Client.new
+```
+
+### Change API endpoint
+
+```ruby
+client = Elastic::WorkplaceSearch::Client.new
+Elastic::WorkplaceSearch.endpoint = 'https://your-server.example.com/api/ws/v1'
+```
+
+### Specifying an HTTP Proxy
+
+```ruby
+client = Elastic::WorkplaceSearch::Client.new(:proxy => 'http://localhost:8888')
+```
+
+### Documents
+
+#### Indexing Documents
+
+This example shows how to use the index_documents method:
+
+```ruby
+content_source_key = '' # your content source key
+documents = [
+  {
+    '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'
+  }
+]
+
+begin
+  document_receipts = client.index_documents(content_source_key, documents)
+  # handle results
+rescue Elastic::WorkplaceSearch::ClientException => e
+  # handle error
+end
+```
+
+#### Destroying Documents
+
+```ruby
+content_source_key = '' # your content source key
+document_ids = ['INscMGmhmX4', 'JNDFojsd02']
+
+begin
+  destroy_document_results = client.destroy_documents(content_source_key, document_ids)
+  # handle destroy document results
+rescue Elastic::WorkplaceSearch::ClientException => e
+  # handle error
+end
+```
+
+### Permissions
+
+#### Listing all permissions
+
+```ruby
+content_source_key = '' # your content source key
+
+client.list_all_permissions(content_source_key)
+```
+
+#### Listing all permissions with paging
+
+```ruby
+content_source_key = '' # your content source key
+
+client.list_all_permissions(content_source_key, :current => 2, :size => 20)
+```
+
+#### Retrieve a User's permissions
+
+```ruby
+content_source_key = '' # your content source key
+user = 'enterprise_search'
+
+client.get_user_permissions(content_source_key, user)
+```
+
+#### Add permissions to a User
+```ruby
+content_source_key = '' # your content source key
+user = 'enterprise_search'
+permissions = ['permission1']
+
+client.add_user_permissions(content_source_key, user, :permissions => permissions)
+```
+
+#### Update a User's permissions
+```ruby
+content_source_key = '' # your content source key
+user = 'enterprise_search'
+permissions = ['permission2']
+
+client.update_user_permissions(content_source_key, user, :permissions => permissions)
+```
+
+#### Remove permissions from a User
+```ruby
+content_source_key = '' # your content source key
+user = 'enterprise_search'
+permissions = ['permission2']
+
+client.remove_user_permissions(content_source_key, user, :permissions => permissions)
+```
+
+## Running tests
+
+Run tests via rspec:
+
+```bash
+$ ENDPOINT=http://localhost:3002/api/ws/v1 bundle exec rspec
+```
+
+## FAQ 🔮
+
+### Where do I report issues with the client?
+
+If something is not working as expected, please open an [issue](https://github.com/elastic/workplace-search-ruby/issues/new).
+
+## Contribute 🚀
+
+We welcome contributors to the project. Before you begin, a couple notes...
+
++ Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/workplace-search-ruby/issues).
++ Please write simple code and concise documentation, when appropriate.
+
+## License 📗
+
+[Apache 2.0](https://github.com/elastic/workplace-search-ruby/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
+
+Thank you to all the [contributors](https://github.com/elastic/workplace-search-ruby/graphs/contributors)!