Merge pull request #5 from capcom6/feature/static-root

Added: index page

.dockerignore

@@ -0,0 +1 @@
+.git/

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -35,6 +35,12 @@ build:
 install:
 	go install ./cmd/$(project_name)
 
+docker-build:
+	docker build -f build/package/Dockerfile -t $(image_name) --build-arg APP=$(project_name) .
+
+docker:
+	docker-compose -f deployments/docker-compose/docker-compose.yml up --build
+
 docker-dev:
 	docker-compose -f deployments/docker-compose/docker-compose.dev.yml up --build
 
@@ -45,4 +51,7 @@ api-docs:
 view-docs:
 	php -S 127.0.0.1:8080 -t ./api
 
-.PHONY: init init-dev air run test install api-docs docker-dev view-docs
+clean:
+	docker-compose -f deployments/docker-compose/docker-compose.yml down --volumes
+
+.PHONY: init init-dev air run test install docker docker-build api-docs docker-dev view-docs clean

api/requests.http

@@ -1,3 +1,4 @@
+@localUrl=http://localhost:8080
 @baseUrl=http://localhost:3000
 
 ###
@@ -12,24 +13,37 @@ Content-Type: application/json
 ###
 POST {{baseUrl}}/api/3rdparty/v1/message HTTP/1.1
 Content-Type: application/json
-Authorization: Basic IUGFXE:v4ejpbeydvjo1h
+Authorization: Basic RMTJTU:yv3sqcidpqeoxc
 
 {
     "message": "Test",
-    "ttl": 60,
+    "ttl": 600,
     "phoneNumbers": [
         "79990001234"
     ]
 }
 
 ###
-GET {{baseUrl}}/api/3rdparty/v1/message/iZo6T9hw7wTuKLQUIP29I HTTP/1.1
-Authorization: Basic IUGFXE:v4ejpbeydvjo1h
+GET {{baseUrl}}/api/3rdparty/v1/message/HE9_eR12bfUauavjvgS1O HTTP/1.1
+Authorization: Basic RMTJTU:yv3sqcidpqeoxc
 
 ###
 GET {{baseUrl}}/api/mobile/v1/message HTTP/1.1
 Authorization: Bearer KuvE4LBXzvy8QO2ZXDDMP
 
+###
+POST {{localUrl}}/message HTTP/1.1
+Content-Type: application/json
+Authorization: Basic sms:6jH2vwEA
+
+{
+    "message": "Test",
+    "ttl": 600,
+    "phoneNumbers": [
+        "+79990001234"
+    ]
+}
+
 ###
 PATCH {{baseUrl}}/api/mobile/v1/message HTTP/1.1
 Authorization: Bearer KuvE4LBXzvy8QO2ZXDDMP

build/package/Dockerfile

@@ -19,6 +19,18 @@ COPY . .
 # RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -o app .
 RUN CGO_ENABLED=0 go build -a -installsuffix cgo -o app ./cmd/${APP}/main.go
 
+# Build MkDocs
+FROM squidfunk/mkdocs-material AS mkdocs
+
+WORKDIR /docs
+
+RUN pip install mkdocs-render-swagger-plugin
+
+COPY web/mkdocs .
+
+RUN mkdocs build
+
+
 # Moving the binary to the 'final Image' to make it smaller
 FROM alpine:3 as prod
 
@@ -33,7 +45,7 @@ COPY --from=build /go/bin/goose /app/goose
 
 COPY scripts/docker-entrypoint.sh /docker-entrypoint.sh
 
-# `boilerplate` should be replaced here as well
+COPY --from=mkdocs /docs/site /app/static
 COPY db/migrations /app/migrations
 COPY --from=build /go/src/app /app
 

deployments/docker-compose/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=sms-gateway

deployments/docker-compose/docker-compose.yml

@@ -0,0 +1,53 @@
+version: '3'
+services:
+  backend:
+    image: capcom6/sms-gateway
+    build:
+      context: ../..
+      dockerfile: ./build/package/Dockerfile
+      args:
+        - APP=sms-gateway
+    environment:
+      - DEBUG=1
+      - CONFIG_PATH=config.yml
+      - GOOSE_DBSTRING=sms:sms@tcp(db:3306)/sms
+      - HTTP__LISTEN=0.0.0.0:3000
+      - DATABASE__HOST=db
+      - DATABASE__PORT=3306
+      - DATABASE__USER=sms
+      - DATABASE__PASSWORD=sms
+      - DATABASE__DATABASE=sms
+    ports:
+      - "3000:3000"
+    volumes:
+      - ../../configs/config.yml:/app/config.yml:ro
+    restart: 'no'
+    depends_on:
+      db:
+        condition: service_healthy
+
+  db:
+    image: mariadb:10.6
+    environment:
+      - MYSQL_ROOT_PASSWORD=root
+      - MYSQL_DATABASE=sms
+      - MYSQL_USER=sms
+      - MYSQL_PASSWORD=sms
+    volumes:
+      - mariadb-data:/var/lib/mysql
+    restart: 'no'
+    healthcheck:
+      test:
+        [
+          "CMD",
+          "mysqladmin",
+          "ping",
+          "-proot",
+          "-h",
+          "127.0.0.1"
+        ]
+      timeout: 5s
+      retries: 10
+
+volumes:
+  mariadb-data:

internal/sms-gateway/handlers/root.go

@@ -8,9 +8,7 @@ type rootHandler struct {
 }
 
 func (h *rootHandler) Register(app *fiber.App) {
-	app.Get("/", func(c *fiber.Ctx) error {
-		return c.Redirect("https://github.com/capcom6/android-sms-gateway")
-	})
+	app.Static("/", "static")
 }
 
 func newRootHandler() *rootHandler {

web/mkdocs/.dockerignore

@@ -0,0 +1,2 @@
+venv/
+site/

web/mkdocs/.gitignore

@@ -0,0 +1,2 @@
+venv/
+site/

web/mkdocs/docs/api.md

@@ -0,0 +1,7 @@
+# API
+
+The Android SMS Gateway provides an API that allows you to send SMS messages programmatically from your own applications or services. 
+
+You can find the OpenAPI specification for our API at the following link: [OpenAPI Specification](https://capcom6.github.io/android-sms-gateway/). This specification includes detailed information about the available endpoints, request/response structure, and more.
+
+Feel free to explore it for better understanding and integration with our service.