Grand work for integration tests with real instance

Author: erimicel

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.2', '3.3']
+        ruby-version: ['3.0', '3.2', '3.3', '3.4']
     services:
       typesense:
         image: typesense/typesense:28.0

.gitignore

@@ -16,3 +16,6 @@ typesense-server-peers
 # rspec failure tracking
 .rspec_status
 typesense-data
+
+# os files
+.DS_Store

.rubocop.yml

@@ -1,4 +1,6 @@
-require: rubocop-rspec
+plugins:
+  - rubocop-rspec
+  - rubocop-rake
 
 AllCops:
   NewCops: enable

Gemfile

@@ -16,6 +16,7 @@ gem 'rspec', '~> 3.9'
 gem 'rspec_junit_formatter', '~> 0.4'
 gem 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
 gem 'rubocop', '~> 1.12'
+gem 'rubocop-rake', '~> 0.7'
 gem 'rubocop-rspec', '~> 2.4', require: false
 gem 'simplecov', '~> 0.18'
 gem 'timecop', '~> 0.9'

spec/fixtures/collections/companies.json

@@ -0,0 +1,11 @@
+{
+  "name": "companies",
+  "num_documents": 0,
+  "fields": [
+    { "name": "company_name", "type": "string", "facet": false },
+    { "name": "num_employees", "type": "int32", "facet": false },
+    { "name": "country", "type": "string", "facet": true }
+  ],
+  "token_ranking_field": "num_employees",
+  "default_sorting_field": "num_employees"
+}

spec/spec_helper.rb

@@ -11,6 +11,8 @@
 require 'webmock/rspec'
 require 'typesense'
 
+WebMock.disable_net_connect!(allow_localhost: true)
+
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = '.rspec_status'

spec/typesense/collection_spec.rb

@@ -8,30 +8,7 @@
 
   include_context 'with Typesense configuration'
 
-  let(:company_schema) do
-    {
-      'name' => 'companies',
-      'num_documents' => 0,
-      'fields' => [
-        {
-          'name' => 'company_name',
-          'type' => 'string',
-          'facet' => false
-        },
-        {
-          'name' => 'num_employees',
-          'type' => 'int32',
-          'facet' => false
-        },
-        {
-          'name' => 'country',
-          'type' => 'string',
-          'facet' => true
-        }
-      ],
-      'token_ranking_field' => 'num_employees'
-    }
-  end
+  let(:company_schema) { JSON.parse(File.read('spec/fixtures/collections/companies.json')) }
 
   describe '#retrieve' do
     it 'returns the specified collection' do

spec/typesense/collections_spec.rb

@@ -8,30 +8,7 @@
 
   include_context 'with Typesense configuration'
 
-  let(:company_schema) do
-    {
-      'name' => 'companies',
-      'num_documents' => 0,
-      'fields' => [
-        {
-          'name' => 'company_name',
-          'type' => 'string',
-          'facet' => false
-        },
-        {
-          'name' => 'num_employees',
-          'type' => 'int32',
-          'facet' => false
-        },
-        {
-          'name' => 'country',
-          'type' => 'string',
-          'facet' => true
-        }
-      ],
-      'token_ranking_field' => 'num_employees'
-    }
-  end
+  let(:company_schema) { JSON.parse(File.read('spec/fixtures/collections/companies.json')) }
 
   describe '#create' do
     it 'creates a collection and returns it' do
@@ -52,29 +29,7 @@
     end
 
     context 'with integration', :integration do
-      let(:integration_schema) do
-        {
-          'name' => 'integration_companies',
-          'fields' => [
-            {
-              'name' => 'company_name',
-              'type' => 'string',
-              'facet' => false
-            },
-            {
-              'name' => 'num_employees',
-              'type' => 'int32',
-              'facet' => false
-            },
-            {
-              'name' => 'country',
-              'type' => 'string',
-              'facet' => true
-            }
-          ],
-          'default_sorting_field' => 'num_employees'
-        }
-      end
+      let(:integration_schema) { company_schema }
 
       let(:integration_client) do
         Typesense::Client.new(
@@ -135,15 +90,15 @@
       before do
         WebMock.disable!
         begin
-          integration_client.collections['integration_companies'].delete
+          integration_client.collections['companies'].delete
         rescue Typesense::Error::ObjectNotFound
           # Collection doesn't exist, which is fine
         end
       end
 
       after do
         begin
-          integration_client.collections['integration_companies'].delete
+          integration_client.collections['companies'].delete
         rescue Typesense::Error::ObjectNotFound
           # Collection doesn't exist, which is fine
         end
@@ -153,7 +108,7 @@
       it 'creates a collection on a real Typesense server' do
         result = integration_client.collections.create(integration_schema)
 
-        expect(result['name']).to eq('integration_companies')
+        expect(result['name']).to eq('companies')
         expect(result['fields']).to eq(expected_fields)
         expect(result['default_sorting_field']).to eq(integration_schema['default_sorting_field'])
         expect(result['num_documents']).to eq(0)

spec/typesense/document_spec.rb

@@ -8,30 +8,7 @@
 
   include_context 'with Typesense configuration'
 
-  let(:company_schema) do
-    {
-      'name' => 'companies',
-      'num_documents' => 0,
-      'fields' => [
-        {
-          'name' => 'company_name',
-          'type' => 'string',
-          'facet' => false
-        },
-        {
-          'name' => 'num_employees',
-          'type' => 'int32',
-          'facet' => false
-        },
-        {
-          'name' => 'country',
-          'type' => 'string',
-          'facet' => true
-        }
-      ],
-      'token_ranking_field' => 'num_employees'
-    }
-  end
+  let(:company_schema) { JSON.parse(File.read('spec/fixtures/collections/companies.json')) }
 
   let(:document) do
     {

spec/typesense/documents_spec.rb

@@ -8,30 +8,7 @@
 
   include_context 'with Typesense configuration'
 
-  let(:company_schema) do
-    {
-      'name' => 'companies',
-      'num_documents' => 0,
-      'fields' => [
-        {
-          'name' => 'company_name',
-          'type' => 'string',
-          'facet' => false
-        },
-        {
-          'name' => 'num_employees',
-          'type' => 'int32',
-          'facet' => false
-        },
-        {
-          'name' => 'country',
-          'type' => 'string',
-          'facet' => true
-        }
-      ],
-      'token_ranking_field' => 'num_employees'
-    }
-  end
+  let(:company_schema) { JSON.parse(File.read('spec/fixtures/collections/companies.json')) }
 
   let(:document) do
     {