elastic-workplace-search 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +7 -0
  2. data/.circleci/config.yml +68 -0
  3. data/.gitignore +10 -0
  4. data/.travis.yml +15 -0
  5. data/Gemfile +4 -0
  6. data/LICENSE.txt +201 -0
  7. data/NOTICE.txt +3 -0
  8. data/README.md +171 -0
  9. data/Rakefile +1 -0
  10. data/elastic-workplace-search.gemspec +23 -0
  11. data/lib/data/ca-bundle.crt +3554 -0
  12. data/lib/elastic-workplace-search.rb +1 -0
  13. data/lib/elastic/workplace-search.rb +7 -0
  14. data/lib/elastic/workplace-search/client.rb +53 -0
  15. data/lib/elastic/workplace-search/client/content_source_documents.rb +45 -0
  16. data/lib/elastic/workplace-search/client/permissions.rb +29 -0
  17. data/lib/elastic/workplace-search/configuration.rb +54 -0
  18. data/lib/elastic/workplace-search/exceptions.rb +11 -0
  19. data/lib/elastic/workplace-search/request.rb +113 -0
  20. data/lib/elastic/workplace-search/utils.rb +15 -0
  21. data/lib/elastic/workplace-search/version.rb +5 -0
  22. data/spec/client/content_source_documents_spec.rb +55 -0
  23. data/spec/client/permissions_spec.rb +75 -0
  24. data/spec/configuration_spec.rb +19 -0
  25. data/spec/fixtures/vcr/add_user_permissions.yml +55 -0
  26. data/spec/fixtures/vcr/async_create_or_update_document_success.yml +51 -0
  27. data/spec/fixtures/vcr/destroy_documents_success.yml +51 -0
  28. data/spec/fixtures/vcr/get_user_permissions.yml +55 -0
  29. data/spec/fixtures/vcr/list_all_permissions.yml +55 -0
  30. data/spec/fixtures/vcr/list_all_permissions_with_paging.yml +55 -0
  31. data/spec/fixtures/vcr/remove_user_permissions.yml +55 -0
  32. data/spec/fixtures/vcr/update_user_permissions.yml +55 -0
  33. data/spec/spec_helper.rb +28 -0
  34. metadata +143 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: eff4106e056b0af7231e0e10e140690beeefd94e9bc7ac6e3f0160cceaa39a96
4
+ data.tar.gz: f379feb78cb139c41dc4d0edc5cd6708e5aec572b88dba7a1d58b8eb446d6e31
5
+ SHA512:
6
+ metadata.gz: 15316ac5167d84e8e8cda1cbd953729cb38e74b81523af9588415debfd98639d6d59504ad221c274953e393efb5d276bbef2c3d72d353e8613cee817d687c60d
7
+ data.tar.gz: dce46994ec6435935162bfbe93335ab9e9d403e1ba0e1d802edb5d22dbc00c0ab9edaf581a9be6ef5167bb3585b63e1f7f3758b92377d30ab6bd057567bc4d18
@@ -0,0 +1,68 @@
1
+ # Ruby CircleCI 2.0 configuration file
2
+ #
3
+ # Check https://circleci.com/docs/2.0/language-ruby/ for more details
4
+ #
5
+ version: 2.1
6
+
7
+ executors:
8
+ ruby-24: {docker: [{image: 'ruby:2.4'}]}
9
+ ruby-25: {docker: [{image: 'ruby:2.5'}]}
10
+ ruby-26: {docker: [{image: 'ruby:2.6'}]}
11
+ jruby-92: {docker: [{image: 'jruby:9.2.7-jdk'}]}
12
+
13
+ jobs:
14
+ build:
15
+ parameters:
16
+ executor:
17
+ type: executor
18
+ executor: << parameters.executor >>
19
+
20
+ working_directory: ~/repo
21
+
22
+ steps:
23
+ - checkout
24
+
25
+ # Download and cache dependencies
26
+ - restore_cache:
27
+ keys:
28
+ - v1-dependencies-{{ checksum "Gemfile" }}
29
+ # fallback to using the latest cache if no exact match is found
30
+ - v1-dependencies-
31
+
32
+ - run:
33
+ name: install dependencies
34
+ command: |
35
+ bundle install --jobs=4 --retry=3 --path vendor/bundle
36
+
37
+ - save_cache:
38
+ paths:
39
+ - ./vendor/bundle
40
+ key: v1-dependencies-{{ checksum "Gemfile" }}
41
+
42
+ # run tests!
43
+ - run:
44
+ name: run tests
45
+ command: |
46
+ mkdir /tmp/test-results
47
+ TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
48
+
49
+ bundle exec rspec --format progress \
50
+ --out /tmp/test-results/rspec.xml \
51
+ --format progress \
52
+ $TEST_FILES
53
+
54
+ # collect reports
55
+ - store_test_results:
56
+ path: /tmp/test-results
57
+ - store_artifacts:
58
+ path: /tmp/test-results
59
+ destination: test-results
60
+
61
+
62
+ workflows:
63
+ run-tests:
64
+ jobs:
65
+ - build: {name: run-tests-ruby-2.4, executor: ruby-24}
66
+ - build: {name: run-tests-ruby-2.5, executor: ruby-25}
67
+ - build: {name: run-tests-ruby-2.6, executor: ruby-26}
68
+ - build: {name: run-tests-jruby-92, executor: jruby-92}
@@ -0,0 +1,10 @@
1
+ *.gem
2
+ .bundle
3
+ Gemfile.lock
4
+ pkg/*
5
+ .DS_Store
6
+ .rvmrc
7
+ .ruby-version
8
+ .ruby-gemset
9
+ .yardoc
10
+ doc
@@ -0,0 +1,15 @@
1
+ language: ruby
2
+ script: rspec
3
+ rvm:
4
+ - 2.0
5
+ - 2.1
6
+ - 2.2
7
+ - 2.4
8
+ - jruby
9
+ jdk:
10
+ - oraclejdk8
11
+
12
+ before_install:
13
+ - gem update --system
14
+ - gem --version
15
+ - gem update bundler
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in elastic-workplace-search.gemspec
4
+ gemspec
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2019 Elasticsearch B.V.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,3 @@
1
+ Elastic Workplace Search Ruby client.
2
+
3
+ Copyright 2012-2020 Elasticsearch B.V.
@@ -0,0 +1,171 @@
1
+ <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>
2
+
3
+ > A first-party Ruby client for [Elastic Workplace Search](https://www.elastic.co/workplace-search).
4
+
5
+ ## Contents
6
+
7
+ + [Getting started](#getting-started-)
8
+ + [Usage](#usage)
9
+ + [FAQ](#faq-)
10
+ + [Contribute](#contribute-)
11
+ + [License](#license-)
12
+
13
+ ***
14
+
15
+ ## Getting started 🐣
16
+
17
+ To install the gem, execute:
18
+
19
+ ```bash
20
+ gem install elastic-workplace-search
21
+ ```
22
+
23
+ Or place `gem 'elastic-workplace-search', '~> 0.4.0` in your `Gemfile` and run `bundle install`.
24
+
25
+ ## Usage
26
+
27
+ Create a new instance of the Elastic Workplace Search client with your access token:
28
+
29
+ ```ruby
30
+ Elastic::WorkplaceSearch.access_token = '' # your access token
31
+ client = Elastic::WorkplaceSearch::Client.new
32
+ ```
33
+
34
+ ### Change API endpoint
35
+
36
+ ```ruby
37
+ client = Elastic::WorkplaceSearch::Client.new
38
+ Elastic::WorkplaceSearch.endpoint = 'https://your-server.example.com/api/ws/v1'
39
+ ```
40
+
41
+ ### Specifying an HTTP Proxy
42
+
43
+ ```ruby
44
+ client = Elastic::WorkplaceSearch::Client.new(:proxy => 'http://localhost:8888')
45
+ ```
46
+
47
+ ### Documents
48
+
49
+ #### Indexing Documents
50
+
51
+ This example shows how to use the index_documents method:
52
+
53
+ ```ruby
54
+ content_source_key = '' # your content source key
55
+ documents = [
56
+ {
57
+ 'id' => 'INscMGmhmX4',
58
+ 'url' => 'http://www.youtube.com/watch?v=v1uyQZNg2vE',
59
+ 'title' => 'The Original Grumpy Cat',
60
+ 'body' => 'this is a test'
61
+ },
62
+ {
63
+ 'id' => 'JNDFojsd02',
64
+ 'url' => 'http://www.youtube.com/watch?v=tsdfhk2j',
65
+ 'title' => 'Another Grumpy Cat',
66
+ 'body' => 'this is also a test'
67
+ }
68
+ ]
69
+
70
+ begin
71
+ document_receipts = client.index_documents(content_source_key, documents)
72
+ # handle results
73
+ rescue Elastic::WorkplaceSearch::ClientException => e
74
+ # handle error
75
+ end
76
+ ```
77
+
78
+ #### Destroying Documents
79
+
80
+ ```ruby
81
+ content_source_key = '' # your content source key
82
+ document_ids = ['INscMGmhmX4', 'JNDFojsd02']
83
+
84
+ begin
85
+ destroy_document_results = client.destroy_documents(content_source_key, document_ids)
86
+ # handle destroy document results
87
+ rescue Elastic::WorkplaceSearch::ClientException => e
88
+ # handle error
89
+ end
90
+ ```
91
+
92
+ ### Permissions
93
+
94
+ #### Listing all permissions
95
+
96
+ ```ruby
97
+ content_source_key = '' # your content source key
98
+
99
+ client.list_all_permissions(content_source_key)
100
+ ```
101
+
102
+ #### Listing all permissions with paging
103
+
104
+ ```ruby
105
+ content_source_key = '' # your content source key
106
+
107
+ client.list_all_permissions(content_source_key, :current => 2, :size => 20)
108
+ ```
109
+
110
+ #### Retrieve a User's permissions
111
+
112
+ ```ruby
113
+ content_source_key = '' # your content source key
114
+ user = 'enterprise_search'
115
+
116
+ client.get_user_permissions(content_source_key, user)
117
+ ```
118
+
119
+ #### Add permissions to a User
120
+ ```ruby
121
+ content_source_key = '' # your content source key
122
+ user = 'enterprise_search'
123
+ permissions = ['permission1']
124
+
125
+ client.add_user_permissions(content_source_key, user, :permissions => permissions)
126
+ ```
127
+
128
+ #### Update a User's permissions
129
+ ```ruby
130
+ content_source_key = '' # your content source key
131
+ user = 'enterprise_search'
132
+ permissions = ['permission2']
133
+
134
+ client.update_user_permissions(content_source_key, user, :permissions => permissions)
135
+ ```
136
+
137
+ #### Remove permissions from a User
138
+ ```ruby
139
+ content_source_key = '' # your content source key
140
+ user = 'enterprise_search'
141
+ permissions = ['permission2']
142
+
143
+ client.remove_user_permissions(content_source_key, user, :permissions => permissions)
144
+ ```
145
+
146
+ ## Running tests
147
+
148
+ Run tests via rspec:
149
+
150
+ ```bash
151
+ $ ENDPOINT=http://localhost:3002/api/ws/v1 bundle exec rspec
152
+ ```
153
+
154
+ ## FAQ 🔮
155
+
156
+ ### Where do I report issues with the client?
157
+
158
+ If something is not working as expected, please open an [issue](https://github.com/elastic/workplace-search-ruby/issues/new).
159
+
160
+ ## Contribute 🚀
161
+
162
+ We welcome contributors to the project. Before you begin, a couple notes...
163
+
164
+ + Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/workplace-search-ruby/issues).
165
+ + Please write simple code and concise documentation, when appropriate.
166
+
167
+ ## License 📗
168
+
169
+ [Apache 2.0](https://github.com/elastic/workplace-search-ruby/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
170
+
171
+ Thank you to all the [contributors](https://github.com/elastic/workplace-search-ruby/graphs/contributors)!