elastic-enterprise-search 0.3.1 → 7.12.1

data/.circleci/config.yml

@@ -1,68 +0,0 @@
-# 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/.travis.yml

@@ -1,15 +0,0 @@
-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/NOTICE.txt

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

data/lib/elastic/enterprise-search.rb

@@ -1,7 +0,0 @@
-require 'elastic/enterprise-search/client'
-
-module Elastic
-  module EnterpriseSearch
-    extend Elastic::EnterpriseSearch::Configuration
-  end
-end

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

@@ -1,46 +0,0 @@
-# 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

@@ -1,30 +0,0 @@
-# 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/spec/client/content_source_documents_spec.rb

@@ -1,55 +0,0 @@
-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

@@ -1,75 +0,0 @@
-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/configuration_spec.rb

@@ -1,19 +0,0 @@
-require 'spec_helper'
-
-describe 'Configuration' do
-  context '.endpoint' do
-    context 'with a trailing /' do
-      it 'adds / to the end of of the URL' do
-        Elastic::EnterpriseSearch.endpoint = 'https://api.swiftype.com/api/v1'
-        expect(Elastic::EnterpriseSearch.endpoint).to eq('https://api.swiftype.com/api/v1/')
-      end
-    end
-
-    context 'with a trailing /' do
-      it 'leaves the URL alone' do
-        Elastic::EnterpriseSearch.endpoint = 'https://api.swiftype.com/api/v1/'
-        expect(Elastic::EnterpriseSearch.endpoint).to eq('https://api.swiftype.com/api/v1/')
-      end
-    end
-  end
-end

data/spec/fixtures/vcr/add_user_permissions.yml

@@ -1,55 +0,0 @@
----
-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.1
-      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/async_create_or_update_document_success.yml

@@ -1,51 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: http://localhost:3002/api/v1/ent/sources/59542d332139de0acacc7dd4/documents/bulk_create.json
-    body:
-      encoding: UTF-8
-      string: '[{"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"}]'
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      Content-Type:
-      - application/json
-      Authorization:
-      - Bearer cGUN-vBokevBhhzyA669
-  response:
-    status:
-      code: 202
-      message: Accepted
-    headers:
-      X-Frame-Options:
-      - SAMEORIGIN
-      X-Xss-Protection:
-      - 1; mode=block
-      X-Content-Type-Options:
-      - nosniff
-      Content-Type:
-      - application/json; charset=utf-8
-      Cache-Control:
-      - no-cache
-      Set-Cookie:
-      - _st_main_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFVEkiJWE4NGIxMjQ0YjgzNzYwOWU2NzljZGYyMjkwYzM2ODA4BjsAVA%3D%3D--d0ca869176aa0b9f3d57baf66152897d305fabae;
-        path=/; expires=Mon, 05 Jul 2027 17:52:09 -0000; HttpOnly
-      X-Request-Id:
-      - '09b779a9-1704-46e7-991d-9e92e67b0001'
-      X-Runtime:
-      - '0.115497'
-      Connection:
-      - close
-      Server:
-      - thin 1.5.0 codename Knife
-    body:
-      encoding: UTF-8
-      string: '[{"id":null,"id":"1234","errors":[]},{"id":null,"id":"1235","errors":[]}]'
-    http_version:
-  recorded_at: Wed, 05 Jul 2017 17:52:09 GMT
-recorded_with: VCR 3.0.3

data/spec/fixtures/vcr/destroy_documents_success.yml

@@ -1,51 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: http://localhost:3002/api/v1/ent/sources/59542d332139de0acacc7dd4/documents/bulk_destroy.json
-    body:
-      encoding: UTF-8
-      string: '["INscMGmhmX4"]'
-    headers:
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      Content-Type:
-      - application/json
-      Authorization:
-      - Bearer cGUN-vBokevBhhzyA669
-  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/"ab494a471abdde82a270b9d9562b7bb9"
-      Cache-Control:
-      - max-age=0, private, must-revalidate
-      Set-Cookie:
-      - _st_main_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFVEkiJTQ5ZGE4NjY4ZjZmY2Q2OTM2MGM0OTIyMDFkNmRmMzFlBjsAVA%3D%3D--75e0f9002e5f32100e4814a9dc015ffd43a5b6eb;
-        path=/; expires=Mon, 05 Jul 2027 17:52:12 -0000; HttpOnly
-      X-Request-Id:
-      - ec1754ea-5fa3-474f-87ba-e754e4c62553
-      X-Runtime:
-      - '1.367282'
-      Connection:
-      - close
-      Server:
-      - thin 1.5.0 codename Knife
-    body:
-      encoding: UTF-8
-      string: '[{"id":"INscMGmhmX4","success":true}]'
-    http_version:
-  recorded_at: Wed, 05 Jul 2017 17:52:12 GMT
-recorded_with: VCR 3.0.3