Added all helper and spec files for Rspec and Rswag

Author: teetangh

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile

@@ -26,6 +26,9 @@ gem 'stimulus-rails'
 # Build JSON APIs with ease [https://github.com/rails/jbuilder]
 gem 'jbuilder'
 
+# Rswag
+gem 'rswag'
+
 # Ruby Couchbase ORM
 gem 'couchbase-orm', git: 'https://github.com/doctolib/couchbase-orm'
 
@@ -61,6 +64,11 @@ group :development do
 
   # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
   # gem "spring"
+
+  gem 'dotenv'
+
+  gem 'rspec-rails'
+  gem 'rubocop', require: false
 end
 
 group :test do

config/couchbase.yml

@@ -9,4 +9,4 @@ development:
 
 test:
   <<: *common
-  bucket: dev_bucket_test
+  bucket: travel-sample

spec/rails_helper.rb

@@ -0,0 +1,65 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require_relative '../config/environment'
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Rails.root.glob('spec/support/**/*.rb').sort.each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  abort e.to_s.strip
+end
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_paths = [
+    Rails.root.join('spec/fixtures')
+  ]
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://rspec.info/features/6-0/rspec-rails
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

spec/requests/api/v1/airlines_spec.rb

@@ -0,0 +1,172 @@
+require 'swagger_helper'
+
+describe 'Airlines API', type: :request do
+  path '/api/v1/airlines/{id}' do
+    get 'Retrieves an airline by ID' do
+      tags 'Airlines'
+      produces 'application/json'
+      parameter name: :id, in: :path, type: :string, description: 'ID of the airline'
+
+      response '200', 'airline found' do
+        schema type: :object,
+               properties: {
+                 name: { type: :string },
+                 iata: { type: :string },
+                 icao: { type: :string },
+                 callsign: { type: :string },
+                 country: { type: :string }
+               },
+               required: %w[name iata icao callsign country]
+
+        let(:id) { 'airline_10' }
+        run_test!
+      end
+
+      response '404', 'airline not found' do
+        let(:id) { 'invalid_id' }
+        run_test!
+      end
+    end
+
+    post 'Creates an airline' do
+      tags 'Airlines'
+      consumes 'application/json'
+      parameter name: :id, in: :path, type: :string, description: 'ID of the airline'
+      parameter name: :airline, in: :body, schema: {
+        type: :object,
+        properties: {
+          name: { type: :string },
+          iata: { type: :string },
+          icao: { type: :string },
+          callsign: { type: :string },
+          country: { type: :string }
+        },
+        required: %w[name iata icao callsign country]
+      }
+
+      response '201', 'airline created' do
+        let(:airline) { { name: 'Foo Airlines', iata: 'FA', icao: 'FOO', callsign: 'FOO', country: 'US' } }
+        run_test!
+      end
+
+      response '400', 'bad request' do
+        let(:airline) { { name: 'Foo Airlines', iata: 'FA', icao: 'FOO', callsign: 'FOO' } }
+        run_test!
+      end
+
+      response '409', 'airline already exists' do
+        let(:airline) { { name: 'Foo Airlines', iata: 'FA', icao: 'FOO', callsign: 'FOO', country: 'US' } }
+        run_test!
+      end
+    end
+
+    put 'Updates an airline' do
+      tags 'Airlines'
+      consumes 'application/json'
+      parameter name: :id, in: :path, type: :string, description: 'ID of the airline'
+      parameter name: :airline, in: :body, schema: {
+        type: :object,
+        properties: {
+          name: { type: :string },
+          iata: { type: :string },
+          icao: { type: :string },
+          callsign: { type: :string },
+          country: { type: :string }
+        }
+      }
+
+      response '200', 'airline updated' do
+        let(:id) { 'airline_10' }
+        let(:airline) { { name: 'Updated Airline' } }
+        run_test!
+      end
+
+      response '400', 'bad request' do
+        let(:id) { 'airline_10' }
+        let(:airline) { { name: '' } }
+        run_test!
+      end
+    end
+
+    delete 'Deletes an airline' do
+      tags 'Airlines'
+      parameter name: :id, in: :path, type: :string, description: 'ID of the airline'
+
+      response '204', 'airline deleted' do
+        let(:id) { 'airline_10' }
+        run_test!
+      end
+
+      response '404', 'airline not found' do
+        let(:id) { 'invalid_id' }
+        run_test!
+      end
+    end
+  end
+
+  path '/api/v1/airlines/list' do
+    get 'Retrieves all airlines by country' do
+      tags 'Airlines'
+      produces 'application/json'
+      parameter name: :country, in: :query, type: :string, description: 'Country of the airline'
+      parameter name: :limit, in: :query, type: :integer, description: 'Maximum number of results to return'
+      parameter name: :offset, in: :query, type: :integer, description: 'Number of results to skip for pagination'
+
+      response '200', 'airlines found' do
+        schema type: :array,
+               items: {
+                 type: :object,
+                 properties: {
+                   name: { type: :string },
+                   iata: { type: :string },
+                   icao: { type: :string },
+                   callsign: { type: :string },
+                   country: { type: :string }
+                 },
+                 required: %w[name iata icao callsign country]
+               }
+
+        let(:country) { 'United States' }
+        let(:limit) { 10 }
+        let(:offset) { 0 }
+        run_test!
+      end
+    end
+  end
+
+  path '/api/v1/airlines/to-airport' do
+    get 'Retrieves airlines flying to a destination airport' do
+      tags 'Airlines'
+      produces 'application/json'
+      parameter name: :destinationAirportCode, in: :query, type: :string,
+                description: 'The ICAO or IATA code of the destination airport'
+      parameter name: :limit, in: :query, type: :integer, description: 'Maximum number of results to return'
+      parameter name: :offset, in: :query, type: :integer, description: 'Number of results to skip for pagination'
+
+      response '200', 'airlines found' do
+        schema type: :array,
+               items: {
+                 type: :object,
+                 properties: {
+                   name: { type: :string },
+                   iata: { type: :string },
+                   icao: { type: :string },
+                   callsign: { type: :string },
+                   country: { type: :string }
+                 },
+                 required: %w[name iata icao callsign country]
+               }
+
+        let(:destinationAirportCode) { 'LAX' }
+        let(:limit) { 10 }
+        let(:offset) { 0 }
+        run_test!
+      end
+
+      response '400', 'bad request' do
+        let(:destinationAirportCode) { '' }
+        run_test!
+      end
+    end
+  end
+end