Updated Ruby on Rails docs #22
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…8080 to 3000 for local application and Swagger documentation access.
…me, install additional gem, and reflect port change to 3000 for application and Swagger documentation access.
shyam-cb
requested changes
Aug 20, 2025
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
tutorial/markdown/ruby/ruby-on-rails/quickstart-ruby-on-rails.md
Outdated
Show resolved
Hide resolved
shyam-cb
requested changes
Aug 21, 2025
|
|
||
| The application uses the following gems and needs to be installed globally even though they are specified in the `Gemfile`. | ||
|
|
||
| ```shell |
There was a problem hiding this comment.
use bundle install package manager not gem install for each dependency.
|
|
||
| Once the application starts, you can see the details of the application on the logs. | ||
|
|
||
|  |
There was a problem hiding this comment.
use relative path, so the image does not breaks in the PR
|
|
||
| ## Data Model | ||
|
|
||
| For this tutorial, we use three collections, `airport`, `airline` and `route` 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. |
There was a problem hiding this comment.
use relative path, so the image does not breaks in the PR
|
|
||
| We have the Couchbase SDK operations defined in the `CouchbaseClient` class inside the `config/initializers/couchbase.rb` file. | ||
|
|
||
| We recommend creating a single Couchbase connection when your application starts up, and sharing this instance throughout your application. If you know at startup time which buckets, scopes, and collections your application will use, we recommend obtaining them from the Cluster at startup time and sharing those instances throughout your application as well. |
|
|
||
| We recommend creating a single Couchbase connection when your application starts up, and sharing this instance throughout your application. If you know at startup time which buckets, scopes, and collections your application will use, we recommend obtaining them from the Cluster at startup time and sharing those instances throughout your application as well. | ||
|
|
||
| In this application, we have created the connection object in `config/initializers/couchbase.rb` and we use this object in all of our APIs. The object is initialized in `config/initializers/couchbase.rb`. We have also stored the reference to our bucket, `travel-sample` and the scope, `inventory` in the connection object. |
There was a problem hiding this comment.
why this line is repeated "The object is initialized in `config/initializers/couchbase.rb"
also below paragraph taks the same
| Inn the above code, we first create an instance of the `Airline` class using the `update` method. We pass the ID and the airline data to the `update` method. If the airline is updated successfully, we return the airline document with a status of 200. If there are any missing fields in the request, we return a bad request status of 400. If there is any other error, we return an internal server error status of 500. | ||
|
|
||
| ```rb | ||
| def update(id, attributes) |
| Navigate to the `destroy` method in the `AirlinesController` class in the `airlines_controller.rb` file. We only need the airline document ID or our key from the user to delete a particular airline document using a key-value operation which is passed in the `destroy` method. | ||
|
|
||
| ```rb | ||
| # DELETE /api/v1/airlines/{id} |
|
|
||
| ```rb | ||
| # GET /api/v1/airlines/list | ||
| def index |
|
|
||
| ## Running Tests | ||
|
|
||
| We have defined integration tests using [RSpec](https://rspec.info/) for all the API end points. The integration tests use the same database configuration as the application. For the tests, we perform the operation using the API and confirm the results by checking the documents in the database. For example, to check the creation of the document by the API, we would call the API to create the document and then read the same document directly from the database using the CouchbaseClient and compare them. After the tests, the documents are cleaned up. |
There was a problem hiding this comment.
just provide a single command to run all the tests , also flow other tutorials
| If you would like to add another entity to the APIs, these are the steps to follow: | ||
|
|
||
| - Create the new entity (collection) in the Couchbase bucket. You can create the collection using the [SDK](https://docs.couchbase.com/sdk-api/couchbase-ruby-client/Couchbase/Collection.html#create_collection-instance_method) or via the [Couchbase Server interface](https://docs.couchbase.com/server/current/manage/manage-settings/manage-collections.html). | ||
| - Define the routes in a new file in the `api` folder similar to the existing routes like `airline_controller.rb`. |
There was a problem hiding this comment.
this statement is workong properly explain where to add route, controller and model logic
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.