Merge pull request 'Rename backend to API' (#12) from rename-backend-to-api into main

Reviewed-on: #12

.drone.yml

@@ -16,19 +16,19 @@ steps:
 ---
 kind: pipeline
 type: docker
-name: backend
+name: api
 steps:
   - name: ameba
     image: veelenga/ameba
     commands:
-      - cd docker/backend/
+      - cd docker/api/
       - ameba micrate/src/ src/
   - name: pgsanity
     image: boechat107/pgsanity
     commands:
-      - cd docker/backend/db/
+      - cd docker/api/db/
       - find -name "*.sql" | xargs pgsanity
-  - name: backend
+  - name: api
     image: docker:dind
     volumes:
       - name: dockersock
@@ -36,7 +36,7 @@ steps:
     commands:
       - cp .example.env .env
       - cd docker/
-      - docker build --build-arg BUILD_ENV=development backend
+      - docker build --build-arg BUILD_ENV=development api
     depends_on:
       - ameba
       - pgsanity

.example.env

@@ -1,4 +1,4 @@
 POSTGRES_USER="mw"
 POSTGRES_PASSWORD="SUPERDUPERSECRET"
 
-BACKEND_JWT_SECRET="SUPERDUPERSECRET"
+API_JWT_SECRET="SUPERDUPERSECRET"

config/nginx/nginx.conf

@@ -10,7 +10,7 @@ http {
     # }
 
     location /graphql {
-      proxy_pass http://backend;
+      proxy_pass http://api;
     }
 
     location /adminer {

docker-compose.yml

@@ -7,7 +7,7 @@ services:
     ports:
       - 80:80
     depends_on:
-      - backend
+      - api
 
   db:
     image: postgres:alpine
@@ -25,17 +25,15 @@ services:
     depends_on:
       - db
 
-  backend:
+  api:
     build:
-      context: ./docker/backend
+      context: ./docker/api
       args:
         BUILD_ENV: production
-    container_name: backend
+    container_name: api
     environment:
-      BACKEND_SERVER_PORT: 8080
-      BACKEND_SERVER_HOST: 0.0.0.0
-      BACKEND_DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_USER}
-      BACKEND_JWT_SECRET: ${BACKEND_JWT_SECRET}
+      API_DATABASE_URL: postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_USER}
+      API_JWT_SECRET: ${API_JWT_SECRET}
     depends_on:
       - db
 

docker/api/Dockerfile

@@ -17,14 +17,14 @@ RUN if [ "${BUILD_ENV}" = "development" ]; then \
   fi
 
 FROM ubuntu:latest as user
-RUN useradd -u 10001 mw
+RUN useradd -u 10001 api
 
 FROM scratch as runner
 WORKDIR /app
 COPY --from=user /etc/passwd /etc/passwd
-COPY --from=builder /app/bin/mw /bin/mw
+COPY --from=builder /app/bin/api /bin/api
 COPY --from=builder /app/bin/micrate /bin/micrate
 COPY ./db ./db
-USER mw
+USER api
 EXPOSE 80
-ENTRYPOINT [ "mw" ]
+ENTRYPOINT [ "api" ]

docker/api/shard.yml

@@ -1,12 +1,12 @@
-name: mw
+name: api
 version: 0.1.0
 
 authors:
   - Dominic Grimm <dominic.grimm@gmail.com>
 
 targets:
-  mw:
-    main: src/mw.cr
+  api:
+    main: src/api.cr
   micrate:
     main: src/micrate.cr
 

docker/api/src/api.cr

@@ -0,0 +1 @@
+require "./api/*"

docker/api/src/api/auth.cr

@@ -1,7 +1,7 @@
 require "crystal-argon2"
 require "jwt"
 
-module MW
+module API
   module Auth
     extend self
 
@@ -23,7 +23,7 @@ module MW
         "exp"  => expiration,
       }
 
-      JWT.encode(payload.to_h, ENV_REQUESTER["BACKEND_JWT_SECRET"], JWT::Algorithm::HS256)
+      JWT.encode(payload.to_h, ENV_REQUESTER["API_JWT_SECRET"], JWT::Algorithm::HS256)
     end
 
     def create_user_jwt(user_id : Int, expiration : Int = (Time.utc + Time::Span.new(hours: 6)).to_unix) : String
@@ -31,7 +31,7 @@ module MW
     end
 
     def decode_jwt(jwt : String) : JSON::Any
-      JWT.decode(jwt, ENV_REQUESTER["BACKEND_JWT_SECRET"], JWT::Algorithm::HS256)[0]
+      JWT.decode(jwt, ENV_REQUESTER["API_JWT_SECRET"], JWT::Algorithm::HS256)[0]
     end
 
     def decode_jwt?(jwt : String) : JSON::Any?

docker/api/src/api/authors.cr

@@ -1,5 +1,5 @@
 require "shard"
 
-module MW
+module API
   AUTHORS = Shard.authors
 end

docker/api/src/api/cli.cr

@@ -4,7 +4,7 @@ require "fancyline"
 
 require "./db"
 
-module MW
+module API
   module CLI
     extend self
 
@@ -25,11 +25,11 @@ module MW
     end
 
     cli = Commander::Command.new do |cmd|
-      cmd.use = "mw"
-      cmd.long = "Mentorenwahl"
+      cmd.use = "api"
+      cmd.long = "Mentorenwahl API CLI"
 
       cmd.run do
-        MW.run
+        API.run
       end
 
       cmd.commands.add do |c|
@@ -37,7 +37,7 @@ module MW
         c.long = "Prints the current version"
 
         c.run do
-          puts MW::VERSION
+          puts API::VERSION
         end
       end
 
@@ -46,7 +46,7 @@ module MW
         c.long = "Prints the authors"
 
         c.run do
-          puts MW::AUTHORS.join(",\n")
+          puts API::AUTHORS.join(",\n")
         end
       end
 

docker/api/src/api/context.cr

@@ -2,7 +2,7 @@ require "http/request"
 require "graphql"
 require "granite"
 
-module MW
+module API
   class Context < GraphQL::Context
     getter user : Db::User?
     getter role : Schema::UserRole?

docker/api/src/api/db.cr

@@ -3,8 +3,8 @@ require "granite/adapter/pg"
 
 require "./db/*"
 
-module MW
+module API
   module Db
-    Granite::Connections << Granite::Adapter::Pg.new(name: "pg", url: ENV_REQUESTER["BACKEND_DATABASE_URL"])
+    Granite::Connections << Granite::Adapter::Pg.new(name: "pg", url: ENV_REQUESTER["API_DATABASE_URL"])
   end
 end

docker/api/src/api/db/admin.cr

@@ -1,6 +1,6 @@
 require "granite"
 
-module MW
+module API
   module Db
     class Admin < Granite::Base
       table admins

docker/api/src/api/db/student.cr

@@ -1,6 +1,6 @@
 require "granite"
 
-module MW
+module API
   module Db
     class Student < Granite::Base
       table students

docker/api/src/api/db/teacher.cr

@@ -1,6 +1,6 @@
 require "granite"
 
-module MW
+module API
   module Db
     class Teacher < Granite::Base
       table teachers

docker/api/src/api/db/teacher_vote.cr

@@ -1,6 +1,6 @@
 require "granite"
 
-module MW
+module API
   module Db
     class TeacherVote < Granite::Base
       table teacher_votes

docker/api/src/api/db/user.cr

@@ -1,7 +1,7 @@
 require "CrystalEmail"
 require "granite"
 
-module MW
+module API
   module Db
     class User < Granite::Base
       table users

docker/api/src/api/db/user_role.cr

@@ -1,4 +1,4 @@
-module MW
+module API
   module Db
     enum UserRole
       Admin

docker/api/src/api/db/vote.cr

@@ -1,6 +1,6 @@
 require "granite"
 
-module MW
+module API
   module Db
     class Vote < Granite::Base
       table votes

docker/api/src/api/env_requester.cr

@@ -1,4 +1,4 @@
-module MW
+module API
   class EnvRequester
     private property keys
 
@@ -35,9 +35,9 @@ module MW
   end
 
   ENV_REQUESTER = EnvRequester.new([
-    "BACKEND_DATABASE_URL",
-    "BACKEND_ADMIN_EMAIL",
-    "BACKEND_ADMIN_PASSWORD",
-    "BACKEND_JWT_SECRET",
+    "API_DATABASE_URL",
+    "API_ADMIN_EMAIL",
+    "API_ADMIN_PASSWORD",
+    "API_JWT_SECRET",
   ])
 end

docker/api/src/api/run.cr

@@ -1,6 +1,6 @@
 require "http/server"
 
-module MW
+module API
   extend self
 
   def run : Nil

docker/api/src/api/schema.cr

@@ -3,7 +3,7 @@ require "graphql"
 require "./schema/helpers"
 require "./schema/*"
 
-module MW
+module API
   module Schema
     SCHEMA = GraphQL::Schema.new(Query.new, Mutation.new)
   end

docker/api/src/api/schema/admin.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class Admin < GraphQL::BaseObject

docker/api/src/api/schema/helpers.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     module Helpers
       module ObjectMacros
@@ -39,8 +39,8 @@ module MW
 
       module DbObject
         macro db_object(type)
-          include ::MW::Schema::Helpers::ObjectDbInit
-          include ::MW::Schema::Helpers::ObjectFinders
+          include ::API::Schema::Helpers::ObjectDbInit
+          include ::API::Schema::Helpers::ObjectFinders
 
           db_init {{ type }}
           finders {{ type }}

docker/api/src/api/schema/mutation.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class Mutation < GraphQL::BaseMutation

docker/api/src/api/schema/query.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class Query < GraphQL::BaseQuery

docker/api/src/api/schema/student.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class Student < GraphQL::BaseObject

docker/api/src/api/schema/teacher.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class Teacher < GraphQL::BaseObject

docker/api/src/api/schema/teacher_vote.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class TeacherVote < GraphQL::BaseObject

docker/api/src/api/schema/user.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class User < GraphQL::BaseObject

docker/api/src/api/schema/user_role.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Enum]
     enum UserRole

docker/api/src/api/schema/vote.cr

@@ -1,6 +1,6 @@
 require "graphql"
 
-module MW
+module API
   module Schema
     @[GraphQL::Object]
     class Vote < GraphQL::BaseObject

docker/api/src/api/server.cr

@@ -1,7 +1,7 @@
 require "toro"
 require "json"
 
-module MW
+module API
   class Server < Toro::Router
     private struct GraphQLData
       include JSON::Serializable

docker/api/src/api/version.cr

@@ -1,5 +1,5 @@
 require "shard"
 
-module MW
+module API
   VERSION = Shard.version
 end

docker/api/src/micrate.cr

@@ -0,0 +1,5 @@
+require "micrate"
+require "pg"
+
+Micrate::DB.connection_url = ENV["API_DATABASE_URL"]?
+Micrate::Cli.run

docker/backend/src/micrate.cr

@@ -1,5 +0,0 @@
-require "micrate"
-require "pg"
-
-Micrate::DB.connection_url = ENV["BACKEND_DATABASE_URL"]?
-Micrate::Cli.run

docker/backend/src/mw.cr

@@ -1 +0,0 @@
-require "./mw/*"

scripts/micrate.sh

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 
-docker-compose exec backend /micrate "$@"
+docker-compose exec api micrate "$@"