Rename root route module (#5)

Author: duffn

.gitignore

@@ -122,5 +122,5 @@ build-iPhoneSimulator/
 
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 .idea/
-config/jwt/*
+config/jwt/*.key*
 .dccache

README.md

@@ -33,6 +33,14 @@ openssl rsa -in jwtRS256.key -pubout -outform PEM -out jwtRS256.key.pub
 docker compose up --build
 ```
 
+- Setup and seed the database.
+
+```
+docker compose exec app bundle exec rake db:setup
+```
+
+- Visit your API at http://localhost:3000
+
 ## Creating a user
 
 - Run the create users Rake task.

Rakefile

@@ -1,7 +1,6 @@
 #!/usr/bin/env rake
 # frozen_string_literal: true
 
-require 'rubygems'
 require 'bundler'
 
 ENV['RAKE_ENV'] ||= 'development'
@@ -37,12 +36,12 @@ begin
   require 'bundler/audit/task'
   Bundler::Audit::Task.new
 rescue LoadError
-  puts 'Not loading RSpec or Rubocop.'
+  puts 'Not loading development only rake tasks.'
 end
 
 # Shows app routes
 task routes: :environment do
-  API::Root.routes.each do |route|
+  GrapeApiBoilerplate::Api::Root.routes.each do |route|
     method = route.request_method.ljust(10)
     path = route.origin
     puts "      #{method} #{path}"

app/api/helpers.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
-module API
-  module Helpers
-    def logger
-      Root.logger
+module GrapeApiBoilerplate
+  module Api
+    module Helpers
+      def logger
+        Root.logger
+      end
     end
   end
 end

app/root.rb

@@ -1,41 +1,43 @@
 # frozen_string_literal: true
 
-module API
-  class Root < Grape::API
-    format :json
-    default_format :json
-    content_type :json, 'application/json'
-    prefix :api
+module GrapeApiBoilerplate
+  module Api
+    class Root < Grape::API
+      format :json
+      default_format :json
+      content_type :json, 'application/json'
+      prefix :api
 
-    rescue_from :grape_exceptions
+      rescue_from :grape_exceptions
 
-    # Logging
-    insert_before Grape::Middleware::Error, GrapeLogging::Middleware::RequestLogger,
-                  {
-                    logger:,
-                    formatter: GrapeLogging::Formatters::Json.new,
-                    include: [GrapeLogging::Loggers::FilterParameters.new([:password])]
-                  }
+      # Logging
+      insert_before Grape::Middleware::Error, GrapeLogging::Middleware::RequestLogger,
+                    {
+                      logger:,
+                      formatter: GrapeLogging::Formatters::Json.new,
+                      include: [GrapeLogging::Loggers::FilterParameters.new([:password])]
+                    }
 
-    # Helpers
-    helpers do
-      include Helpers
-    end
+      # Helpers
+      helpers do
+        include Helpers
+      end
 
-    # Routes
-    mount GrapeApiBoilerplate::Api::Endpoints::Session
-    mount GrapeApiBoilerplate::Api::Endpoints::V1::HelloWorldEndpoint
-    mount GrapeApiBoilerplate::Api::Endpoints::V1::WidgetEndpoint
+      # Routes
+      mount GrapeApiBoilerplate::Api::Endpoints::Session
+      mount GrapeApiBoilerplate::Api::Endpoints::V1::HelloWorldEndpoint
+      mount GrapeApiBoilerplate::Api::Endpoints::V1::WidgetEndpoint
 
-    add_swagger_documentation \
-      info: {
-        title: 'Grape Boilerplate',
-        description: 'A full-featured API boilerplate to get you started with the Grape framework.'
-      }
+      add_swagger_documentation \
+        info: {
+          title: 'Grape Boilerplate',
+          description: 'A full-featured API boilerplate to get you started with the Grape framework.'
+        }
 
-    # Handle 404s
-    route :any, '*path' do
-      error!({ message: 'resource does not exist' }, 404)
+      # Handle 404s
+      route :any, '*path' do
+        error!({ message: 'resource does not exist' }, 404)
+      end
     end
   end
 end

config.ru

@@ -14,5 +14,5 @@ use OTR::ActiveRecord::ConnectionManagement
 # Load Swagger UI when running locally.
 use Rack::Static, urls: ['/public/swagger'] unless ENV['RACK_ENV'] == 'production'
 
-API::Root.compile!
-run API::Root
+GrapeApiBoilerplate::Api::Root.compile!
+run GrapeApiBoilerplate::Api::Root

config/boot.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
-require 'rubygems'
 require 'bundler/setup'
 require 'rack/cors'

config/jwt/.gitkeep

@@ -5,7 +5,6 @@ services:
     build:
       context: .
       dockerfile: dev.Dockerfile
-    container_name: ruby-grape
     environment:
       RACK_ENV: development
       WEB_CONCURRENCY: "0"

docker-compose.yml

@@ -2,11 +2,11 @@
 
 require 'spec_helper'
 
-describe API::Root do
+describe GrapeApiBoilerplate::Api::Root do
   include Rack::Test::Methods
 
   def app
-    API::Root
+    GrapeApiBoilerplate::Api::Root
   end
 
   it 'gets hello world' do