Rename the project because it will have more responsibilities.

Author: Burgy Benjamin

.gitignore

@@ -23,5 +23,5 @@ erl_crash.dump
 /tmp/
 
 # Ignore package tarball (built via "mix hex.build").
-kdrive_bridge-*.tar
+ksuite_middleware-*.tar
 

Dockerfile

@@ -22,14 +22,14 @@ FROM ${BUILDER_IMAGE} as builder
 
 # install build dependencies
 RUN apt-get update -y && apt-get install -y build-essential git \
-    && apt-get clean && rm -f /var/lib/apt/lists/*_*
+  && apt-get clean && rm -f /var/lib/apt/lists/*_*
 
 # prepare build dir
 WORKDIR /app
 
 # install hex + rebar
 RUN mix local.hex --force && \
-    mix local.rebar --force
+  mix local.rebar --force
 
 # set build ENV
 ENV MIX_ENV="prod"
@@ -80,7 +80,7 @@ RUN chown nobody /app
 ENV MIX_ENV="prod"
 
 # Only copy the final release from the build stage
-COPY --from=builder --chown=nobody:root /app/_build/${MIX_ENV}/rel/kdrive_bridge ./
+COPY --from=builder --chown=nobody:root /app/_build/${MIX_ENV}/rel/ksuite_middleware ./
 
 USER nobody
 

README.md

@@ -1,6 +1,8 @@
-# KdriveBridge
+# Ksuite-middleware
 
-The goal of this project is to provide access to the content of your files saved in kDrive without the KSuite layer by calling the URL:
+Project providing a single endpoint with a single API configuration to access to many resources from a KSuite environment.
+
+## Kdrive
 
 ```
 http://localhost:4000/files/<your-kdrive-file-id>
@@ -11,29 +13,29 @@ http://localhost:4000/files/<your-kdrive-file-id>
 | Environment variables | Description                                                                                                                  |
 |-----------------------|------------------------------------------------------------------------------------------------------------------------------|
 | KDRIVE_ID             | The identifier of your KDrive.                                                                                               |
-| KDRIVE_API_TOKEN      | The API token to use the KDrive API.                                                                                         |
+| KSUITE_API_TOKEN      | The API token to use the KDrive API.                                                                                         |
 | PHX_HOST              | The host the web server. (default: example.com)                                                                              |
 | PORT                  | The port for the web server. (default: 4000)                                                                                 |
 | SECRET_KEY_BASE       | Secret key used by the [phoenix framework](https://hexdocs.pm/phoenix/deployment.html#handling-of-your-application-secrets). |
 
 ```yaml
 version: '3'
 services:
-  kdrive-bridge:
-    image: minidfx/kdrive-bridge:v0.3.0
+  ksuite-middleware:
+    image: minidfx/ksuite-middleware:v0.4.0
     environment:
       - SECRET_KEY_BASE=<secret>
       - PHX_HOST=<host>
       - PORT=<port>
       - KDRIVE_ID=<id>
-      - KDRIVE_API_TOKEN=<token>
+      - KSUITE_API_TOKEN=<token>
     ports:
       - 4000:4000
 ```
 
 ## Running with Docker (recommended way)
 
-With Docker, running the application is a breeze. Simply update the environment variables SECRET_KEY_BASE, PHX_HOST, KDRIVE_ID, and KDRIVE_API_TOKEN. Then, run it to kickstart the application.
+With Docker, running the application is a breeze. Simply update the environment variables SECRET_KEY_BASE, PHX_HOST, KDRIVE_ID, and KSUITE_API_TOKEN. Then, run it to kickstart the application.
 
 ```bash
 docker-compose up

config/config.exs

@@ -7,18 +7,18 @@
 # General application configuration
 import Config
 
-config :kdrive_bridge,
+config :ksuite_middleware,
   generators: [timestamp_type: :utc_datetime]
 
 # Configures the endpoint
-config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
+config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint,
   url: [host: "localhost"],
   adapter: Phoenix.Endpoint.Cowboy2Adapter,
   render_errors: [
-    formats: [json: KdriveBridgeWeb.ErrorJSON],
+    formats: [json: KsuiteMiddlewareWeb.ErrorJSON],
     layout: false
   ],
-  pubsub_server: KdriveBridge.PubSub,
+  pubsub_server: KsuiteMiddleware.PubSub,
   live_view: [signing_salt: "7nfCI6sX"]
 
 # Configures Elixir's Logger

config/dev.exs

@@ -6,7 +6,7 @@ import Config
 # The watchers configuration can be used to run external
 # watchers to your application. For example, we can use it
 # to bundle .js and .css sources.
-config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
+config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint,
   # Binding to loopback ipv4 address prevents access from other machines.
   # Change to `ip: {0, 0, 0, 0}` to allow access from other machines.
   http: [ip: {0, 0, 0, 0}, port: 4000],
@@ -40,7 +40,7 @@ config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
 # different ports.
 
 # Enable dev routes for dashboard and mailbox
-config :kdrive_bridge, dev_routes: true
+config :ksuite_middleware, dev_routes: true
 
 # Do not include metadata nor timestamps in development logs
 config :logger, :console, format: "[$level] $message\n"

config/runtime.exs

@@ -12,12 +12,12 @@ import Config
 # If you use `mix release`, you need to explicitly enable the server
 # by passing the PHX_SERVER=true when you start it:
 #
-#     PHX_SERVER=true bin/kdrive_bridge start
+#     PHX_SERVER=true bin/ksuite_middleware start
 #
 # Alternatively, you can use `mix phx.gen.release` to generate a `bin/server`
 # script that automatically sets the env var above.
 if System.get_env("PHX_SERVER") do
-  config :kdrive_bridge, KdriveBridgeWeb.Endpoint, server: true
+  config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint, server: true
 end
 
 if config_env() == :prod do
@@ -36,9 +36,9 @@ if config_env() == :prod do
   host = System.get_env("PHX_HOST") || "example.com"
   port = String.to_integer(System.get_env("PORT") || "4000")
 
-  config :kdrive_bridge, :dns_cluster_query, System.get_env("DNS_CLUSTER_QUERY")
+  config :ksuite_middleware, :dns_cluster_query, System.get_env("DNS_CLUSTER_QUERY")
 
-  config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
+  config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint,
     url: [host: host, port: 443, scheme: "http"],
     http: [
       # Enable IPv6 and bind on all interfaces.
@@ -50,16 +50,16 @@ if config_env() == :prod do
     ],
     secret_key_base: secret_key_base
 
-  config :kdrive_bridge,
+  config :ksuite_middleware,
     kdrive_id: System.get_env("KDRIVE_ID") || raise("The KDRIVE_ID variable was missing"),
-    kdrive_api_token: System.get_env("KDRIVE_API_TOKEN") || raise("The KDRIVE_API_TOKEN variable was missing")
+    ksuite_api_token: System.get_env("KSUITE_API_TOKEN") || raise("The KSUITE_API_TOKEN variable was missing")
 
   # ## SSL Support
   #
   # To get SSL working, you will need to add the `https` key
   # to your endpoint configuration:
   #
-  #     config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
+  #     config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint,
   #       https: [
   #         ...,
   #         port: 443,
@@ -81,7 +81,7 @@ if config_env() == :prod do
   # We also recommend setting `force_ssl` in your endpoint, ensuring
   # no data is ever sent via http, always redirecting to https:
   #
-  #     config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
+  #     config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint,
   #       force_ssl: [hsts: true]
   #
   # Check `Plug.SSL` for all available options in `force_ssl`.

config/test.exs

@@ -2,7 +2,7 @@ import Config
 
 # We don't run a server during test. If one is required,
 # you can enable the server option below.
-config :kdrive_bridge, KdriveBridgeWeb.Endpoint,
+config :ksuite_middleware, KsuiteMiddlewareWeb.Endpoint,
   http: [ip: {127, 0, 0, 1}, port: 4002],
   secret_key_base: "BQY9JpU3sNCk28WVxTGzJMma6M4DIiMD+4L/OskOMPSgOXp08t6OBveo2ccdxYxr",
   server: false

docker-compose.yml

@@ -1,13 +1,13 @@
 version: '3'
 services:
-  kdrive-bridge:
+  ksuite-middleware:
     build: .
-    image: minidfx/kdrive-bridge:v0.3.0
+    image: minidfx/ksuite-middleware:v0.4.0
     environment:
       - SECRET_KEY_BASE=<secret>
       - PHX_HOST=<host>
       - PORT=<port>
       - KDRIVE_ID=<id>
-      - KDRIVE_API_TOKEN=<token>
+      - KSUITE_API_TOKEN=<token>
     ports:
       - 4000:4000

lib/kdrive_bridge.ex renamed to lib/ksuite_middleware.ex

@@ -1,6 +1,6 @@
-defmodule KdriveBridge do
+defmodule KsuiteMiddleware do
   @moduledoc """
-  KdriveBridge keeps the contexts that define your domain
+  KsuiteMiddleware keeps the contexts that define your domain
   and business logic.
 
   Contexts are also responsible for managing your data, regardless

lib/kdrive_bridge/application.ex renamed to lib/ksuite_middleware/application.ex

@@ -1,4 +1,4 @@
-defmodule KdriveBridge.Application do
+defmodule KsuiteMiddleware.Application do
   # See https://hexdocs.pm/elixir/Application.html
   # for more information on OTP Applications
   @moduledoc false
@@ -8,26 +8,26 @@ defmodule KdriveBridge.Application do
   @impl true
   def start(_type, _args) do
     children = [
-      KdriveBridgeWeb.Telemetry,
-      {DNSCluster, query: Application.get_env(:kdrive_bridge, :dns_cluster_query) || :ignore},
-      {Phoenix.PubSub, name: KdriveBridge.PubSub},
-      # Start a worker by calling: KdriveBridge.Worker.start_link(arg)
-      # {KdriveBridge.Worker, arg},
+      KsuiteMiddlewareWeb.Telemetry,
+      {DNSCluster, query: Application.get_env(:ksuite_middleware, :dns_cluster_query) || :ignore},
+      {Phoenix.PubSub, name: KsuiteMiddleware.PubSub},
+      # Start a worker by calling: KsuiteMiddleware.Worker.start_link(arg)
+      # {KsuiteMiddleware.Worker, arg},
       # Start to serve requests, typically the last entry
-      KdriveBridgeWeb.Endpoint
+      KsuiteMiddlewareWeb.Endpoint
     ]
 
     # See https://hexdocs.pm/elixir/Supervisor.html
     # for other strategies and supported options
-    opts = [strategy: :one_for_one, name: KdriveBridge.Supervisor]
+    opts = [strategy: :one_for_one, name: KsuiteMiddleware.Supervisor]
     Supervisor.start_link(children, opts)
   end
 
   # Tell Phoenix to update the endpoint configuration
   # whenever the application is updated.
   @impl true
   def config_change(changed, _new, removed) do
-    KdriveBridgeWeb.Endpoint.config_change(changed, removed)
+    KsuiteMiddlewareWeb.Endpoint.config_change(changed, removed)
     :ok
   end
 end