feat: Refactor nested document class names in airport and hotel models

Author: teetangh

README.md

@@ -52,17 +52,21 @@ Open the `config/couchbase.yml` file and update the connection string, username,
 
 ```yml
 common: &common
+  bucket: travel-sample
+  connection_string: <%= ENV['DB_CONN_STR'] %>
+  username: <%= ENV['DB_USERNAME'] %>
+  password: <%= ENV['DB_PASSWORD'] %>
+
+development:
   connection_string: couchbase://localhost
   username: Administrator
   password: password
 
-development:
+test:
   <<: *common
-  bucket: travel-sample
 
-test:
+production:
   <<: *common
-  bucket: travel-sample
 ```
 
 > Note: The connection string expects the `couchbases://` or `couchbase://` part.
@@ -97,11 +101,11 @@ docker run -p 3000:3000 ruby-couchbase-orm-quickstart -e DB_CONN_STR=<connection
 
 Once the application starts, you can see the details of the application on the terminal.
 
-Show Image
+![Application Start](./public/application_start.png)
 
 The application will run on the port specified by Rails on your local machine (eg: http://localhost:3000). You will find the interactive Swagger documentation of the API if you go to the URL in your browser. Swagger documentation is used in this demo to showcase the different API endpoints and how they can be invoked. More details on the Swagger documentation can be found in the appendix.
 
-Show Image
+![Swagger Documentation](./public/swagger_documentation.png)
 
 ## Running The Tests
 
@@ -119,26 +123,100 @@ bundle exec rspec test/integration
 
 For this quickstart, we use three collections, airport, airline and routes that contain sample airports, airlines and airline routes respectively. The route collection connects the airports and airlines as seen in the figure below. We use these connections in the quickstart to generate airports that are directly connected and airlines connecting to a destination airport. Note that these are just examples to highlight how you can use SQL++ queries to join the collections.
 
-![Data Model](image_link)
-
-## Extending API by Adding New Entity
-
-If you would like to add another entity to the APIs, these are the steps to follow:
-
-1. Create a new model: Create a new model for the entity in the `app/models` folder. This model should contain the schema for the entity.
-2. Create the new route: In Rails, you can create a new route by adding a new resource in the `config/routes.rb` file. This file should contain the logic for the new entity's CRUD operations.
-3. Create the new controller: Create a new controller for the entity in the `app/controllers` folder. This controller should contain the logic for the new entity's CRUD operations.
-4. Add the integration tests: Add integration tests for the new entity in the `test/integration` folder. This ensures that the new entity's CRUD operations are tested. The test file should be named `<entity>_spec.rb`.
-
-Following these steps ensures a systematic and organized approach to expanding the API functionality with a new entity.
+![Data Model](./public/travel_sample_data_model.png)
+
+## Extending API by Adding a New Entity
+
+If you would like to add another entity to the APIs, follow these steps:
+
+1. Create a new model:
+   - Create a new model file for the entity in the `app/models` folder.
+   - Define the schema for the entity using the appropriate attributes and validations.
+   - Example: `app/models/customer.rb`
+
+2. Create the new routes:
+   - Open the `config/routes.rb` file.
+   - Add new routes for the entity's CRUD operations using the `resources` method.
+   - Example:
+     ```ruby
+     namespace :api do
+       namespace :v1 do
+         resources :customers
+       end
+     end
+     ```
+
+3. Create the new controller:
+   - Create a new controller file for the entity in the `app/controllers/api/v1` folder.
+   - Implement the necessary CRUD actions (index, show, create, update, destroy) in the controller.
+   - Example: `app/controllers/api/v1/customers_controller.rb`
+
+4. Add Swagger documentation:
+   - Open the `spec/requests/api/v1/customers_spec.rb` file.
+   - Define the Swagger documentation for the new entity's API endpoints using RSpec and the `rswag` gem.
+   - Specify the request and response parameters, headers, and schemas for each endpoint.
+   - Example:
+     ```ruby
+     require 'swagger_helper'
+
+     describe 'Customers API', type: :request do
+       path '/api/v1/customers' do
+         get 'Retrieves all customers' do
+           tags 'Customers'
+           produces 'application/json'
+
+           response '200', 'customers retrieved' do
+             schema type: :array,
+                    items: {
+                      type: :object,
+                      properties: {
+                        id: { type: :integer },
+                        name: { type: :string },
+                        email: { type: :string }
+                      },
+                      required: ['id', 'name', 'email']
+                    }
+
+             run_test!
+           end
+         end
+       end
+     end
+     ```
+
+5. Add integration tests:
+   - Create a new integration test file for the entity in the `test/integration` folder.
+   - Write integration tests to cover the CRUD operations of the new entity.
+   - Example: `test/integration/customers_spec.rb`
+     ```ruby
+     require 'rails_helper'
+
+     RSpec.describe 'Customers API', type: :request do
+       describe 'GET /api/v1/customers' do
+         # Add tests for retrieving customers
+       end
+
+       describe 'POST /api/v1/customers' do
+         # Add tests for creating a customer
+       end
+
+       # Add more tests for other CRUD operations
+     end
+     ```
+
+6. Run tests and verify:
+   - Run the integration tests using the command `bundle exec rspec test/integration`.
+   - Ensure that all tests pass and the new entity's CRUD operations are working as expected.
+
+By following these steps, you can systematically extend the API functionality with a new entity while maintaining a well-structured and tested codebase.
 
 ## Running Self-Managed Couchbase Cluster
 
 If you are running this quickstart with a self-managed Couchbase cluster, you need to load the travel-sample data bucket in your cluster and generate the credentials for the bucket by creating a user.
 
-You need to update the connection string and the credentials in the `dev.env` file in the root folder.
+You need to update the connection string and the credentials in the `couchbase.yml` file in the `config` folder.
 
-Note: Couchbase Server must be installed and running prior to running this app.
+Note: Couchbase Server must be installed and running before running this app.
 
 ## Swagger Documentation