elastic-enterprise-search 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe677ed48cb89f43237777fddd2943dab50a3c56a95f0ddfb0586d7aa50c6fa1
-  data.tar.gz: b63ccdd45e4663b6780fc1aae4f99ab9152bbd1ce875542a651c4698f4d36b35
+  metadata.gz: 4515fe152cfe00b0bcc53e873771342434c5dd5a61f776805b89e3b52b44c795
+  data.tar.gz: 100c01185713f91eb9648da0fd38acd059ae0a30fc5f3d900acec85a540efaab
 SHA512:
-  metadata.gz: a78e1072de507150193cd96248a1cac29921b25d7f196846a22a133bec8ad9aeaedc0685dfc1db920ab857151bc95404adc296b130a4010d9f8c44635dd27ef9
-  data.tar.gz: 0d1def4f1c50324b108ed1a244bb40609c787ff6fb4135df3e7d2509eadfcdde1d050c3ac0632fd1fc816d89d4fab06a360486fe394ca8e9fee67ea55b00c40f
+  metadata.gz: cfe7f71022fe098efdbe20442151ba14fdf75947c3fd24a240310f2d853d4fa0995f7ac469dc86e3c770eb950cd68f13a82b1064cd7a7590052c3b81cc210fe3
+  data.tar.gz: a3b97981a52556f9966858abd1d1767ab13c16ac3494908f3bdb8712f539a62ae896bbf386b8a0d6f1658ab8d8792dad4bfc9269eea2d02bcfd415370466bb74

data/README.md

@@ -22,7 +22,7 @@ To install the gem, execute:
 gem install elastic-enterprise-search
 ```
 
-Or place `gem 'elastic-enterprise-search', '~> 0.2.1` in your `Gemfile` and run `bundle install`.
+Or place `gem 'elastic-enterprise-search', '~> 0.3.0` in your `Gemfile` and run `bundle install`.
 
 ## Usage
 
@@ -46,7 +46,9 @@ Elastic::EnterpriseSearch.endpoint = 'https://your-server.example.com/api/v1'
 client = Elastic::EnterpriseSearch::Client.new(:proxy => 'http://localhost:8888')
 ```
 
-### Indexing Documents
+### Documents
+
+#### Indexing Documents
 
 This example shows how to use the index_documents method:
 
@@ -75,7 +77,7 @@ rescue Elastic::EnterpriseSearch::ClientException => e
 end
 ```
 
-### Destroying Documents
+#### Destroying Documents
 
 ```ruby
 content_source_key = '' # your content source key
@@ -89,6 +91,60 @@ rescue Elastic::EnterpriseSearch::ClientException => e
 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:

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

@@ -7,6 +7,9 @@ module Elastic
   module EnterpriseSearch
     # API client for the {Elastic Enterprise Search API}[https://swiftype.com/enterprise-search].
     class Client
+      autoload :ContentSourceDocuments, 'elastic/enterprise-search/client/content_source_documents.rb'
+      autoload :Permissions, 'elastic/enterprise-search/client/permissions.rb'
+
       DEFAULT_TIMEOUT = 15
 
       include Elastic::EnterpriseSearch::Request
@@ -43,50 +46,8 @@ module Elastic
         (@options[:overall_timeout] || DEFAULT_TIMEOUT).to_f
       end
 
-      # Documents have fields that can be searched or filtered.
-      #
-      # For more information on indexing documents, see the {Content Source documentation}[https://swiftype.com/documentation/enterprise-search/guides/content-sources].
-      module ContentSourceDocuments
-
-        # Index a batch of documents using the {Content Source API}[https://swiftype.com/documentation/enterprise-search/api/custom-sources].
-        #
-        # @param [String] content_source_key the unique Content Source key as found in your Content Sources dashboard
-        # @param [Array] documents an Array of Document Hashes
-        #
-        # @return [Array<Hash>] an Array of Document indexing Results
-        #
-        # @raise [Elastic::EnterpriseSearch::InvalidDocument] when a single document is missing required fields or contains unsupported fields
-        # @raise [Timeout::Error] when timeout expires waiting for results
-        def index_documents(content_source_key, documents)
-          documents = Array(documents).map! { |document| normalize_document(document) }
-
-          async_create_or_update_documents(content_source_key, documents)
-        end
-
-        # Destroy a batch of documents given a list of external IDs
-        #
-        # @param [Array<String>] document_ids an Array of Document External IDs
-        #
-        # @return [Array<Hash>] an Array of Document destroy result hashes
-        #
-        # @raise [Timeout::Error] when timeout expires waiting for results
-        def destroy_documents(content_source_key, document_ids)
-          document_ids = Array(document_ids)
-          post("ent/sources/#{content_source_key}/documents/bulk_destroy.json", document_ids)
-        end
-
-        private
-
-        def async_create_or_update_documents(content_source_key, documents)
-          post("ent/sources/#{content_source_key}/documents/bulk_create.json", documents)
-        end
-
-        def normalize_document(document)
-          Utils.stringify_keys(document)
-        end
-      end
-
       include Elastic::EnterpriseSearch::Client::ContentSourceDocuments
+      include Elastic::EnterpriseSearch::Client::Permissions
     end
   end
 end

data/lib/elastic/enterprise-search/client/content_source_documents.rb

@@ -0,0 +1,46 @@
+# Content Source API - https://swiftype.com/documentation/enterprise-search/api/custom-sources
+module Elastic
+  module EnterpriseSearch
+    class Client
+      module ContentSourceDocuments
+
+        # Index a batch of documents.
+        #
+        # @param [String] content_source_key the unique Content Source key as found in your Content Sources dashboard
+        # @param [Array] documents an Array of Document Hashes
+        #
+        # @return [Array<Hash>] an Array of Document indexing Results
+        #
+        # @raise [Elastic::EnterpriseSearch::InvalidDocument] when a single document is missing required fields or contains unsupported fields
+        # @raise [Timeout::Error] when timeout expires waiting for results
+        def index_documents(content_source_key, documents)
+          documents = Array(documents).map! { |document| normalize_document(document) }
+
+          async_create_or_update_documents(content_source_key, documents)
+        end
+
+        # Destroy a batch of documents given a list of external IDs
+        #
+        # @param [Array<String>] document_ids an Array of Document External IDs
+        #
+        # @return [Array<Hash>] an Array of Document destroy result hashes
+        #
+        # @raise [Timeout::Error] when timeout expires waiting for results
+        def destroy_documents(content_source_key, document_ids)
+          document_ids = Array(document_ids)
+          post("ent/sources/#{content_source_key}/documents/bulk_destroy.json", document_ids)
+        end
+
+        private
+
+        def async_create_or_update_documents(content_source_key, documents)
+          post("ent/sources/#{content_source_key}/documents/bulk_create.json", documents)
+        end
+
+        def normalize_document(document)
+          Utils.stringify_keys(document)
+        end
+      end
+    end
+  end
+end

data/lib/elastic/enterprise-search/client/permissions.rb

@@ -0,0 +1,30 @@
+# Document Permissions API - /documentation/enterprise-search/api/document-permissions
+module Elastic
+  module EnterpriseSearch
+    class Client
+      module Permissions
+
+        def list_all_permissions(content_source_key, current: 1, size: 25)
+          get("ent/sources/#{content_source_key}/permissions", "page[current]" => current, "page[size]" => size )
+        end
+
+        def get_user_permissions(content_source_key, user)
+          get("ent/sources/#{content_source_key}/permissions/#{user}")
+        end
+
+        def update_user_permissions(content_source_key, user, options)
+          post("ent/sources/#{content_source_key}/permissions/#{user}", options)
+        end
+
+        def add_user_permissions(content_source_key, user, options)
+          post("ent/sources/#{content_source_key}/permissions/#{user}/add", options)
+        end
+
+        def remove_user_permissions(content_source_key, user, options)
+          post("ent/sources/#{content_source_key}/permissions/#{user}/remove", options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -70,7 +70,7 @@ module Elastic
         when Net::HTTPNotFound
           raise Elastic::EnterpriseSearch::NonExistentRecord
         when Net::HTTPBadRequest
-          raise Elastic::EnterpriseSearch::BadRequest
+          raise Elastic::EnterpriseSearch::BadRequest, "#{response.code} #{response.body}"
         when Net::HTTPForbidden
           raise Elastic::EnterpriseSearch::Forbidden
         else

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

@@ -1,5 +1,5 @@
 module Elastic
   module EnterpriseSearch
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/spec/client/content_source_documents_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Elastic::EnterpriseSearch::Client::ContentSourceDocuments do
+  let(:engine_slug) { 'enterprise-search-api-example' }
+  let(:client) { Elastic::EnterpriseSearch::Client.new }
+
+  before :each do
+    Elastic::EnterpriseSearch.access_token = 'cGUN-vBokevBhhzyA669'
+  end
+
+  def check_receipt_response_format(response, options = {})
+    expect(response.keys).to match_array(["document_receipts", "batch_link"])
+    expect(response["document_receipts"]).to be_a_kind_of(Array)
+    expect(response["document_receipts"].first.keys).to match_array(["id", "id", "links", "status", "errors"])
+    expect(response["document_receipts"].first["id"]).to eq(options[:id]) if options[:id]
+    expect(response["document_receipts"].first["status"]).to eq(options[:status]) if options[:status]
+    expect(response["document_receipts"].first["errors"]).to eq(options[:errors]) if options[:errors]
+  end
+
+  let(:content_source_key) { '59542d332139de0acacc7dd4' }
+  let(:documents) do
+    [{'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'}]
+  end
+
+  context '#index_documents' do
+    it 'returns results when successful' do
+      VCR.use_cassette(:async_create_or_update_document_success) do
+        response = client.index_documents(content_source_key, documents)
+          expect(response.size).to eq(2)
+      end
+    end
+  end
+
+  context '#destroy_documents' do
+    it 'returns #async_create_or_update_documents format return when async has been passed as true' do
+      VCR.use_cassette(:async_create_or_update_document_success) do
+        VCR.use_cassette(:document_receipts_multiple_complete) do
+          client.index_documents(content_source_key, documents)
+          VCR.use_cassette(:destroy_documents_success) do
+            response = client.destroy_documents(content_source_key, [documents.first['id']])
+            expect(response.size).to eq(1)
+            expect(response.first['success']).to eq(true)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/client/permissions_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Elastic::EnterpriseSearch::Client::Permissions do
+  let(:client) { Elastic::EnterpriseSearch::Client.new }
+
+  before :each do
+    Elastic::EnterpriseSearch.access_token = 'xyT3mm3ecPsPuYxd_6fX'
+  end
+
+  let(:content_source_key) { '5d96387b75444bf49532c24a' }
+  let(:user) { 'enterprise_search' }
+
+  context '#list_all_permissions' do
+    it 'lists all permissions' do
+      VCR.use_cassette(:list_all_permissions) do
+        response = client.list_all_permissions(content_source_key)
+        expect(response['results'].size).to eq(2)
+      end
+    end
+
+    it 'lists all permissions with paging' do
+      VCR.use_cassette(:list_all_permissions_with_paging) do
+        response = client.list_all_permissions(content_source_key, :current => 2, :size => 5)
+        expect(response['meta']['page']['current']).to eq(2)
+        expect(response['meta']['page']['size']).to eq(5)
+        expect(response['results'].size).to eq(0)
+      end
+    end
+  end
+
+  context '#add_user_permissions' do
+    let(:permissions) { ['permission1'] }
+
+    it 'adds permissions to a user' do
+      VCR.use_cassette(:add_user_permissions) do
+        response = client.add_user_permissions(content_source_key, user, :permissions => permissions)
+        expect(response['permissions']).to eq(['permission1'])
+      end
+    end
+  end
+
+  context '#get_user_permissions' do
+    let(:permissions) { ['permission1'] }
+
+    it 'gets permissions for a user' do
+      VCR.use_cassette(:get_user_permissions) do
+        response = client.get_user_permissions(content_source_key, user)
+        expect(response['permissions']).to eq(['permission1'])
+      end
+    end
+  end
+
+  context '#update_user_permissions' do
+    let(:permissions) { ['permission2'] }
+
+    it 'updates permissions for a user' do
+      VCR.use_cassette(:update_user_permissions) do
+        response = client.update_user_permissions(content_source_key, user, :permissions => permissions)
+        expect(response['permissions']).to eq(['permission2'])
+      end
+    end
+  end
+
+  context '#remove_user_permissions' do
+    let(:permissions) { ['permission2'] }
+
+    it 'removes permissions from a user' do
+      VCR.use_cassette(:remove_user_permissions) do
+        response = client.remove_user_permissions(content_source_key, user, :permissions => permissions)
+        expect(response['permissions']).to eq([])
+      end
+    end
+  end
+
+end

data/spec/fixtures/vcr/add_user_permissions.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/v1/ent/sources/5d96387b75444bf49532c24a/permissions/enterprise_search/add
+    body:
+      encoding: UTF-8
+      string: '{"permissions":["permission1"]}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+      X-Swiftype-Client:
+      - elastic-enterprise-search-ruby
+      X-Swiftype-Client-Version:
+      - 0.3.0
+      Authorization:
+      - Bearer xyT3mm3ecPsPuYxd_6fX
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"6cb0d74ff26d6f74253df3ee283a38dd"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_frito_togo_session=KzdUM3ZvN3Z3aUIvRHNudUF0ZzJaT01EK2tNUk53akxDNVBlNWZxYVVDd3o4YlhqZXVUWjA3MWlqSlZnNzB0eFJrRW5RaUZBRFdHeVdtRnBtWUs5bWc9PS0tcEhjSk0xekxrOGRrcXNsWE83dlJrUT09--6f1c0da2f24a45042ff4492d5bac3ae214cd3731;
+        path=/; expires=Mon, 08 Oct 2029 18:04:32 -0000; HttpOnly
+      X-Request-Id:
+      - 616a8613-11c8-4031-8767-16f3ff735170
+      X-Runtime:
+      - '0.310198'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"user":"enterprise_search","permissions":["permission1"]}'
+    http_version:
+  recorded_at: Tue, 08 Oct 2019 18:04:32 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/get_user_permissions.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/v1/ent/sources/5d96387b75444bf49532c24a/permissions/enterprise_search
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+      X-Swiftype-Client:
+      - elastic-enterprise-search-ruby
+      X-Swiftype-Client-Version:
+      - 0.3.0
+      Authorization:
+      - Bearer xyT3mm3ecPsPuYxd_6fX
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"6cb0d74ff26d6f74253df3ee283a38dd"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_frito_togo_session=NFJOYW80dHcxSGVmMTZTYUJaSTN4aUhKZjhtNmRhUVowN29zV3doakdJOHpyUDdzRnhoMlJJeE9nd1RvWWh0R1E1Zk1lUnhvTzNvajNUbXpmWnZIcVE9PS0tbENURG5USHgwYTZOUlcxS3lNUkdtQT09--e15485e53d7c2a3aa83288a815d1dcdfe6b9788a;
+        path=/; expires=Mon, 08 Oct 2029 18:04:48 -0000; HttpOnly
+      X-Request-Id:
+      - 67442386-136f-4f13-8f8e-0ac1b9ac10ce
+      X-Runtime:
+      - '0.303674'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"user":"enterprise_search","permissions":["permission1"]}'
+    http_version:
+  recorded_at: Tue, 08 Oct 2019 18:04:48 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/list_all_permissions.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/v1/ent/sources/5d96387b75444bf49532c24a/permissions?page%5Bcurrent%5D=1&page%5Bsize%5D=25
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+      X-Swiftype-Client:
+      - elastic-enterprise-search-ruby
+      X-Swiftype-Client-Version:
+      - 0.3.0
+      Authorization:
+      - Bearer xyT3mm3ecPsPuYxd_6fX
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"5c7f433cb2ebcb5549f57098f3ceab57"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_frito_togo_session=UFpRY1dUSldpNXhOdVUxVGlGaUl3c20ybGFkVGZFemhJZGFqVjNHcDhGWWdjVVpBVDVIWENNQkVWVXJXYnRKcmxqSm1TdHY0WjRoMDNmczJvT2Yzamc9PS0tcDkzWmV3MXN4Z0labTNxMXJrbitMdz09--ed529bc01c2d5cc98d6272fa033a876b1a7e689c;
+        path=/; expires=Mon, 08 Oct 2029 17:56:03 -0000; HttpOnly
+      X-Request-Id:
+      - 9bee4837-355a-4486-a35f-a92d5f13f389
+      X-Runtime:
+      - '0.230366'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"page":{"current":1,"total_pages":1,"total_results":2,"size":25}},"results":[{"user":"elastic","permissions":[]},{"user":"enterprise_search","permissions":[]}]}'
+    http_version:
+  recorded_at: Tue, 08 Oct 2019 17:56:03 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/list_all_permissions_with_paging.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:3002/api/v1/ent/sources/5d96387b75444bf49532c24a/permissions?page%5Bcurrent%5D=2&page%5Bsize%5D=5
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+      X-Swiftype-Client:
+      - elastic-enterprise-search-ruby
+      X-Swiftype-Client-Version:
+      - 0.3.0
+      Authorization:
+      - Bearer xyT3mm3ecPsPuYxd_6fX
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"701f9ddd65c2586e892ac7f10050825f"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_frito_togo_session=ZXVYWkI5SFNTSm94Z29MY2thQTQvcmx4aStDenhUWkFWOVNyUWFCYWZaL3NJcDI2N21BcXJzK2h5dzNHNjd3NUdDYUNMYmgwYkNVczhjUmQ1dkd6Y2c9PS0tM3B5ciswcGlxek1QVXVjMUFsbFdPdz09--cea9576c7338c79cbd06216fe476cb63a9f6364f;
+        path=/; expires=Mon, 08 Oct 2029 17:58:09 -0000; HttpOnly
+      X-Request-Id:
+      - 1f924257-ed83-4715-a2f3-88be62d7d3c5
+      X-Runtime:
+      - '0.211862'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"meta":{"page":{"current":2,"total_pages":1,"total_results":2,"size":5}},"results":[]}'
+    http_version:
+  recorded_at: Tue, 08 Oct 2019 17:58:09 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/remove_user_permissions.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/v1/ent/sources/5d96387b75444bf49532c24a/permissions/enterprise_search/remove
+    body:
+      encoding: UTF-8
+      string: '{"permissions":["permission2"]}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+      X-Swiftype-Client:
+      - elastic-enterprise-search-ruby
+      X-Swiftype-Client-Version:
+      - 0.3.0
+      Authorization:
+      - Bearer xyT3mm3ecPsPuYxd_6fX
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"eaf0aef29a99d5f9dda5844986aa3880"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_frito_togo_session=aGhGT0VyRUVVZDIzMEJMTkpjR3U5TURLR01MVFIvajlqUmtEVG85My9ZWlk3dU1OdC9nWVVnNFhIRGlTdC9Ddks4dzNoeGx6d20raFVjSUI4d0Q5NWc9PS0tT2hwcXNkZnA1T2gyUUVDcUZIWEtrUT09--0e523f810425ee9c2b201bef99048a24b7f4e5d0;
+        path=/; expires=Mon, 08 Oct 2029 18:04:32 -0000; HttpOnly
+      X-Request-Id:
+      - 32583732-daf1-4153-9978-f2567862b21d
+      X-Runtime:
+      - '0.295464'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"user":"enterprise_search","permissions":[]}'
+    http_version:
+  recorded_at: Tue, 08 Oct 2019 18:04:32 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/update_user_permissions.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:3002/api/v1/ent/sources/5d96387b75444bf49532c24a/permissions/enterprise_search
+    body:
+      encoding: UTF-8
+      string: '{"permissions":["permission2"]}'
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+      X-Swiftype-Client:
+      - elastic-enterprise-search-ruby
+      X-Swiftype-Client-Version:
+      - 0.3.0
+      Authorization:
+      - Bearer xyT3mm3ecPsPuYxd_6fX
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"d9b34b6591f5971aeb0f3d706560e171"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Set-Cookie:
+      - _st_frito_togo_session=VXFPc0pKQitCSkcvb2c4Wjl3ZEx2YXRTL1NXWW5KbHVwdHhIcEVpd3lJS3orVVM3eVV0UVo1bTJ5MGFxQXhMQjZCM3VOZmV3bDl5NHl1a3ZkV2UxOHc9PS0tc2Nma0NRR0FmcWs0S0tJdFBxUXF3UT09--97d427ee534c30c51d1770571623a1d361b61b6f;
+        path=/; expires=Mon, 08 Oct 2029 18:04:31 -0000; HttpOnly
+      X-Request-Id:
+      - 9404a936-7a58-4412-8ab8-e08f71a0380c
+      X-Runtime:
+      - '0.388014'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"user":"enterprise_search","permissions":["permission2"]}'
+    http_version:
+  recorded_at: Tue, 08 Oct 2019 18:04:31 GMT
+recorded_with: VCR 3.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-enterprise-search
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Quin Hoxie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -86,16 +86,25 @@ files:
 - lib/elastic-enterprise-search.rb
 - lib/elastic/enterprise-search.rb
 - lib/elastic/enterprise-search/client.rb
+- lib/elastic/enterprise-search/client/content_source_documents.rb
+- lib/elastic/enterprise-search/client/permissions.rb
 - lib/elastic/enterprise-search/configuration.rb
 - lib/elastic/enterprise-search/exceptions.rb
 - lib/elastic/enterprise-search/request.rb
 - lib/elastic/enterprise-search/utils.rb
 - lib/elastic/enterprise-search/version.rb
 - logo-enterprise-search.png
-- spec/client_spec.rb
+- spec/client/content_source_documents_spec.rb
+- spec/client/permissions_spec.rb
 - spec/configuration_spec.rb
+- spec/fixtures/vcr/add_user_permissions.yml
 - spec/fixtures/vcr/async_create_or_update_document_success.yml
 - spec/fixtures/vcr/destroy_documents_success.yml
+- spec/fixtures/vcr/get_user_permissions.yml
+- spec/fixtures/vcr/list_all_permissions.yml
+- spec/fixtures/vcr/list_all_permissions_with_paging.yml
+- spec/fixtures/vcr/remove_user_permissions.yml
+- spec/fixtures/vcr/update_user_permissions.yml
 - spec/spec_helper.rb
 homepage: https://github.com/elastic/enterprise-search-ruby
 licenses:
@@ -116,14 +125,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Official gem for accessing the Elastic Enterprise Search API
 test_files:
-- spec/client_spec.rb
+- spec/client/content_source_documents_spec.rb
+- spec/client/permissions_spec.rb
 - spec/configuration_spec.rb
+- spec/fixtures/vcr/add_user_permissions.yml
 - spec/fixtures/vcr/async_create_or_update_document_success.yml
 - spec/fixtures/vcr/destroy_documents_success.yml
+- spec/fixtures/vcr/get_user_permissions.yml
+- spec/fixtures/vcr/list_all_permissions.yml
+- spec/fixtures/vcr/list_all_permissions_with_paging.yml
+- spec/fixtures/vcr/remove_user_permissions.yml
+- spec/fixtures/vcr/update_user_permissions.yml
 - spec/spec_helper.rb

data/spec/client_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-describe Elastic::EnterpriseSearch::Client do
-  let(:engine_slug) { 'enterprise-search-api-example' }
-  let(:client) { Elastic::EnterpriseSearch::Client.new }
-
-  before :each do
-    Elastic::EnterpriseSearch.access_token = 'cGUN-vBokevBhhzyA669'
-  end
-
-  context 'ContentSourceDocuments' do
-    def check_receipt_response_format(response, options = {})
-      expect(response.keys).to match_array(["document_receipts", "batch_link"])
-      expect(response["document_receipts"]).to be_a_kind_of(Array)
-      expect(response["document_receipts"].first.keys).to match_array(["id", "id", "links", "status", "errors"])
-      expect(response["document_receipts"].first["id"]).to eq(options[:id]) if options[:id]
-      expect(response["document_receipts"].first["status"]).to eq(options[:status]) if options[:status]
-      expect(response["document_receipts"].first["errors"]).to eq(options[:errors]) if options[:errors]
-    end
-
-    let(:content_source_key) { '59542d332139de0acacc7dd4' }
-    let(:documents) do
-      [{'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'}]
-    end
-
-    context '#index_documents' do
-      it 'returns results when successful' do
-        VCR.use_cassette(:async_create_or_update_document_success) do
-          response = client.index_documents(content_source_key, documents)
-            expect(response.size).to eq(2)
-        end
-      end
-    end
-
-    context '#destroy_documents' do
-      it 'returns #async_create_or_update_documents format return when async has been passed as true' do
-        VCR.use_cassette(:async_create_or_update_document_success) do
-          VCR.use_cassette(:document_receipts_multiple_complete) do
-            client.index_documents(content_source_key, documents)
-            VCR.use_cassette(:destroy_documents_success) do
-              response = client.destroy_documents(content_source_key, [documents.first['id']])
-              expect(response.size).to eq(1)
-              expect(response.first['success']).to eq(true)
-            end
-          end
-        end
-      end
-    end
-  end
-end