14 Commits

Author SHA1 Message Date
Juan Rodriguez 3fa30b3a32 chore: Update README.md 2024-10-27 13:01:40 +01:00
Juan Rodriguez 80ed6033d1 chore: update README.md 2024-10-27 12:56:06 +01:00
Juan Rodriguez 4640522d5d chore: refactor create_links with curl parallel 2024-10-27 12:55:38 +01:00
Juan Rodriguez 848232cc11 fix: create links pipe ipc 2024-10-27 12:01:38 +01:00
Juan Rodriguez 98dedc4494 refactor: powered_by_header kemal config 2024-10-27 11:07:59 +01:00
Juan Rodriguez e6f64ea026 chore: update benchmark with bombardier 2024-10-27 11:07:23 +01:00
Juan Rodriguez ea71d3825e fix: generate slug by user + check existing link on update 2024-07-31 22:09:24 +02:00
Juan Rodriguez afa9b33568 tests: update error messages assertions 2024-07-31 21:50:35 +02:00
Juan Rodriguez a93189411b fix: test suite drop database before all 2024-07-31 21:39:24 +02:00
Juan Rodriguez 98f103f5cf fix: url validate format 2024-07-31 21:38:57 +02:00
Juan Rodriguez 6fc48dae83 refactor: replace slug generation with CRC32 + base62 2024-07-31 21:38:36 +02:00
Juan Rodriguez d039add340 chore: bump version 2024-07-31 08:08:38 +02:00
Juan Rodriguez 0214d6f46d ci: fix publish extract version step 2024-07-31 08:08:15 +02:00
Juan Rodriguez 37e14ec2f8 refactor: sha256 slug generation 2024-07-31 08:07:08 +02:00
13 changed files with 295 additions and 255 deletions
+2 -3
View File
@@ -35,8 +35,7 @@ jobs:
- name: Extract version from shard.yml - name: Extract version from shard.yml
id: extract_version id: extract_version
run: | run: |
VERSION=$(grep -oP 'version:\s*\K\S+' shard.yml) VERSION=$(grep '^version:' shard.yml | cut -d ' ' -f 2)
VERSION=$(echo $VERSION | tr -d '\n\r')
echo "RELEASE_TAG=$VERSION" >> $GITHUB_ENV echo "RELEASE_TAG=$VERSION" >> $GITHUB_ENV
- name: Set tags - name: Set tags
@@ -50,7 +49,7 @@ jobs:
- name: Build and push image - name: Build and push image
id: push id: push
uses: docker/build-push-action@v5.0.0 uses: docker/build-push-action@v5
with: with:
context: . context: .
push: true push: true
+98 -89
View File
@@ -2,91 +2,6 @@
[![Docker Stars](https://img.shields.io/docker/stars/sjdonado/bit.svg)](https://hub.docker.com/repository/docker/sjdonado/bit) [![Docker Stars](https://img.shields.io/docker/stars/sjdonado/bit.svg)](https://hub.docker.com/repository/docker/sjdonado/bit)
[![Docker Image Size](https://img.shields.io/docker/image-size/sjdonado/bit/latest)](https://hub.docker.com/repository/docker/sjdonado/bit) [![Docker Image Size](https://img.shields.io/docker/image-size/sjdonado/bit/latest)](https://hub.docker.com/repository/docker/sjdonado/bit)
# Benchmark
```shell
$ ./benchmark.sh
Semaphore initialized with 2666 slots.
Setup...
[+] Running 2/2
✔ Network bit_default Created 0.0s
✔ Container bit-app-1 Started 0.2s
2024-07-12T18:41:20.962052Z INFO - micrate: Migrating db, current version: 0, target: 20240711224103
2024-07-12T18:41:20.965729Z INFO - micrate: OK 20240512214223_create_links.sql
2024-07-12T18:41:20.969198Z INFO - micrate: OK 20240512225208_add_slug_index_to_links.sql
2024-07-12T18:41:20.973136Z INFO - micrate: OK 20240513115731_create_users.sql
2024-07-12T18:41:20.975525Z INFO - micrate: OK 20240513130054_add_api_key_index_to_users.sql
2024-07-12T18:41:20.979195Z INFO - micrate: OK 20240711224103_create_clicks.sql
Captured API Key: Z01Qk4M5E0xhggZUCdQAPw
Waiting for database to be ready...
Creating 1000 short links...
Created short link 100/1000
Created short link 200/1000
Created short link 300/1000
Created short link 400/1000
Created short link 500/1000
Created short link 600/1000
Created short link 700/1000
Created short link 800/1000
Created short link 900/1000
Created short link 1000/1000
Accessing each link 10 times concurrently...
****Results****
Average Memory Usage: 16.36 MiB
Average CPU Usage: 0%
Average Response Time: 12.37 µs
```
# Self-hosted
## Run via docker-compose
```bash
docker-compose up
# Generate an api key
docker-compose exec -it app cli --create-user=Admin
```
## Run via docker cli
```bash
docker run \
--name bit \
-p 4000:4000 \
-e ENV="production" \
-e DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" \
-e APP_URL="http://localhost:4000" \
sjdonado/bit
docker exec -it bit cli --create-user=Admin
```
## Dokku
```dockerfile
FROM sjdonado/bit
```
```bash
dokku apps:create bit
dokku domains:set bit bit.donado.co
dokku letsencrypt:enable bit
dokku storage:ensure-directory bit-sqlite
dokku storage:mount bit /var/lib/dokku/data/storage/bit-sqlite:/usr/src/app/sqlite/
dokku config:set bit DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" APP_URL=https://bit.donado.co
dokku ports:add bit http:80:4000
dokku ports:add bit https:443:4000
dokku run bit cli --create-user=Admin
```
# Usage
## API Endpoints ## API Endpoints
1. **Ping the API** 1. **Ping the API**
@@ -249,10 +164,104 @@ Options:
--delete-user=USER_ID Delete a user by ID --delete-user=USER_ID Delete a user by ID
``` ```
# Development ## Benchmark
## Installation ```
$ ./benchmark.sh
Setting up...
[+] Running 3/3
✔ Network bit_default Created 0.0s
✔ Volume "bit_sqlite_data" Created 0.0s
✔ Container bit Started 0.1s
Captured API Key: aHOCnZSuo2kOHy2mDa-iOA
Waiting for the application to be ready...
HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json
Date: Sun, 27 Oct 2024 11:52:33 GMT
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, Accept, Origin, X-Api-Key
Content-Length: 13
Starting resource usage monitoring...
Creating 10000 short links with 100 conrurrent requests...
Link creation complete: 10000 links created.
Fetching all created links from /api/links...
Selected link for benchmarking: http://localhost:4000/UaVZjA
Starting benchmark with Bombardier...
Bombarding http://localhost:4000/oEKLAg with 10000 request(s) using 100 connection(s)
10000 / 10000 [===============================================================================] 100.00% 830/s 12s
Done!
Statistics Avg Stdev Max
Reqs/sec 853.89 1625.49 8942.54
Latency 118.48ms 11.52ms 142.58ms
HTTP codes:
1xx - 0, 2xx - 0, 3xx - 10000, 4xx - 0, 5xx - 0
others - 0
Throughput: 360.02KB/s
Benchmark completed.
Analyzing resource usage...
**** Results ****
Average CPU Usage: 40.68%
Average Memory Usage: 28.62 MiB
./benchmark.sh: line 135: 61567 Terminated: 15 monitor_resource_usage
[+] Running 2/2
✔ Container bit Removed 10.1s
✔ Network bit_default Removed
```
## Self-hosted
### Run via docker-compose
```bash
docker-compose up
# Generate an api key
docker-compose exec -it app cli --create-user=Admin
```
### Run via docker cli
```bash
docker run \
--name bit \
-p 4000:4000 \
-e ENV="production" \
-e DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" \
-e APP_URL="http://localhost:4000" \
sjdonado/bit
docker exec -it bit cli --create-user=Admin
```
### Dokku
```dockerfile
FROM sjdonado/bit
```
```bash
dokku apps:create bit
dokku domains:set bit bit.donado.co
dokku letsencrypt:enable bit
dokku storage:ensure-directory bit-sqlite
dokku storage:mount bit /var/lib/dokku/data/storage/bit-sqlite:/usr/src/app/sqlite/
dokku config:set bit DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" APP_URL=https://bit.donado.co
dokku ports:add bit http:80:4000
dokku ports:add bit https:443:4000
dokku run bit cli --create-user=Admin
```
## Development
- Setup
```bash ```bash
brew tap amberframework/micrate brew tap amberframework/micrate
brew install micrate brew install micrate
@@ -262,13 +271,13 @@ brew install micrate
shards run bit shards run bit
``` ```
## Generate the `X-Api-Key` - Generate the `X-Api-Key`
```bash ```bash
shards run cli -- --create-user=Admin shards run cli -- --create-user=Admin
``` ```
## Run tests - Run tests
```bash ```bash
ENV=test crystal spec ENV=test crystal spec
+2
View File
@@ -3,3 +3,5 @@ require "kemal"
Kemal.config.env = ENV["ENV"]? || "development" Kemal.config.env = ENV["ENV"]? || "development"
Kemal.config.port = ENV["PORT"]?.try(&.to_i) || 4000 Kemal.config.port = ENV["PORT"]?.try(&.to_i) || 4000
Kemal.config.host_binding = ENV["HOST"]? || "0.0.0.0" Kemal.config.host_binding = ENV["HOST"]? || "0.0.0.0"
Kemal.config.powered_by_header = false
+14 -11
View File
@@ -9,6 +9,7 @@ module App::Controllers::Link
class Create < App::Lib::BaseController class Create < App::Lib::BaseController
include App::Models include App::Models
include App::Lib include App::Lib
include App::Services
def call(env) def call(env)
user = env.get("user").as(User) user = env.get("user").as(User)
@@ -26,16 +27,7 @@ module App::Controllers::Link
link.id = UUID.v4.to_s link.id = UUID.v4.to_s
link.url = url link.url = url
link.user = user link.user = user
link.slug = SlugService.shorten_url(url, user.id.to_s)
attempts = 0
loop do
slug = Random::Secure.urlsafe_base64(attempts >= 2 ? 6 : 5).gsub(/[^a-zA-Z0-9]/, "")
unless Database.get_by(Link, slug: slug)
link.slug = slug
break
end
attempts += 1
end
changeset = Database.insert(link) changeset = Database.insert(link)
if !changeset.valid? if !changeset.valid?
@@ -126,6 +118,7 @@ module App::Controllers::Link
class Update < App::Lib::BaseController class Update < App::Lib::BaseController
include App::Models include App::Models
include App::Lib include App::Lib
include App::Services
def call(env) def call(env)
user = env.get("user").as(User) user = env.get("user").as(User)
@@ -138,7 +131,17 @@ module App::Controllers::Link
raise App::NotFoundException.new(env) if link.nil? raise App::NotFoundException.new(env) if link.nil?
raise App::ForbiddenException.new(env) if link.user_id != user.id raise App::ForbiddenException.new(env) if link.user_id != user.id
link.url = body["url"].to_s new_url = body["url"].to_s
existing_query = Database::Query.where(url: new_url, user_id: user.id.to_s).limit(1)
existing_link = Database.all(Link, existing_query).first?
if existing_link
raise App::UnprocessableEntityException.new(env, { "url" => ["URL already exists"] })
end
link.url = new_url
link.slug = SlugService.shorten_url(new_url, user.id.to_s)
changeset = Database.update(link) changeset = Database.update(link)
if !changeset.valid? if !changeset.valid?
+1 -1
View File
@@ -17,6 +17,6 @@ module App::Models
unique_constraint :slug unique_constraint :slug
validate_required [:slug, :url] validate_required [:slug, :url]
validate_format :url, /\Ahttps?:\/\/(?:[\w.-]+)(?::\d+)?(?:[\/?#]\S*)?\z/i validate_format :url, /\A(?:(https?:\/\/)?(?:[\w-]+\.)+[a-z]{2,})(?::\d+)?(?:[\/?#]\S*)?\z/i
end end
end end
-1
View File
@@ -5,7 +5,6 @@ module App
env.response.headers["Access-Control-Allow-Origin"] = "*" env.response.headers["Access-Control-Allow-Origin"] = "*"
env.response.headers["Access-Control-Allow-Methods"] = "GET, POST, PUT, DELETE, OPTIONS" env.response.headers["Access-Control-Allow-Methods"] = "GET, POST, PUT, DELETE, OPTIONS"
env.response.headers["Access-Control-Allow-Headers"] = "Content-Type, Accept, Origin, X-Api-Key" env.response.headers["Access-Control-Allow-Headers"] = "Content-Type, Accept, Origin, X-Api-Key"
env.response.headers.delete("X-Powered-By")
end end
after_all do |env| after_all do |env|
+12
View File
@@ -0,0 +1,12 @@
require "digest"
require "base64"
module App::Services::SlugService
def self.shorten_url(url : String, user_id : String) : String
combined = "#{user_id}-#{url}"
crc32_hash = Digest::CRC32.digest(combined)
base62_encoded = Base64.urlsafe_encode(crc32_hash).strip.tr("-_=", "")
base62_encoded
end
end
+129 -121
View File
@@ -1,148 +1,156 @@
#!/bin/bash #!/bin/bash
api_url="http://localhost:4001/api/links" # Configuration variables
num_links=1000 server_url="http://localhost:4000"
num_requests=10 api_url="${server_url}/api/links"
resource_usage_interval=1 # Interval in seconds for resource usage logging num_links=10000
num_requests=10000
concurrency=100
resource_usage_interval=1
container_name="bit"
semaphore="/tmp/semaphore" check_dependencies() {
max_concurrent_processes=$(ulimit -u) # Adjust this number based on your system's capability if ! command -v bombardier &> /dev/null; then
echo "Error: bombardier is not installed. Please install it to proceed."
exit 1
fi
# Initialize semaphore if ! command -v jq &> /dev/null; then
mkfifo $semaphore echo "Error: jq is not installed. Please install it to proceed."
exec 3<> $semaphore exit 1
rm $semaphore fi
}
for ((i=0; i<max_concurrent_processes; i++)); do setup_containers() {
echo >&3 echo "Setting up..."
done docker compose up -d
if [ $? -ne 0 ]; then
echo "Failed to start Docker containers."
exit 1
fi
echo "Semaphore initialized with $max_concurrent_processes slots." output=$(docker compose exec -T app cli --create-user=Admin)
api_key=$(echo "$output" | awk -F' ' '/X-Api-Key:/{print $NF}')
echo "Captured API Key: $api_key"
function get_resource_usage { if [[ -z "$api_key" ]]; then
while true; do echo "Error: API key could not be retrieved."
docker stats --no-stream --format "table {{.MemUsage}} {{.CPUPerc}}" bit-app-1 | awk 'NR>1 {print "Memory:", $1, "CPU:", $2}' >> resource_usage.txt exit 1
fi
echo "Waiting for the application to be ready..."
until curl --silent --head --fail --header "X-Api-Key: $api_key" "$server_url/api/ping"; do
sleep 2
done
}
monitor_resource_usage() {
echo "Starting resource usage monitoring..."
echo "Timestamp,CPU,Memory" > resource_usage.csv
while :; do
stats=$(docker stats --no-stream --format "{{.CPUPerc}},{{.MemUsage}}" $container_name)
cpu=$(echo $stats | awk -F',' '{print $1}' | sed 's/%//')
mem=$(echo $stats | awk -F',' '{print $2}' | awk '{print $1}')
timestamp=$(date +%s)
echo "$timestamp,$cpu,$mem" >> resource_usage.csv
sleep $resource_usage_interval sleep $resource_usage_interval
done done
} }
function calculate_average_usage { create_links() {
total_mem=0 local temp_file=$(mktemp)
total_cpu=0
count=0
while read -r line; do echo "Creating $num_links short links with $concurrency conrurrent requests..."
if echo $line | grep -q 'Memory'; then
mem=$(echo $line | awk '{print $2}' | sed 's/MiB//')
total_mem=$(echo "$total_mem + $mem" | bc)
elif echo $line | grep -q 'CPU'; then
cpu=$(echo $line | awk '{print $2}' | sed 's/%//')
total_cpu=$(echo "$total_cpu + $cpu" | bc)
fi
((count++))
done < resource_usage.txt
avg_mem=$(echo "scale=2; $total_mem / ($count / 2)" | bc) # Since there are 2 lines per interval # Populate URLs into a file to feed into curl
avg_cpu=$(echo "scale=2; $total_cpu / ($count / 2)" | bc) for ((i=1; i<=num_links; i++)); do
rm resource_usage.txt url="https://example.com/${i}-${num_links}"
echo "--next" >> "$temp_file"
echo "--request POST" >> "$temp_file"
echo "--url \"$api_url\"" >> "$temp_file"
echo "--header \"X-Api-Key: $api_key\"" >> "$temp_file"
echo "--header \"Content-Type: application/json\"" >> "$temp_file"
echo "--data \"{ \\\"url\\\": \\\"$url\\\" }\"" >> "$temp_file"
done
echo "Average Memory Usage: $avg_mem MiB" curl --parallel --parallel-immediate --parallel-max $concurrency --config "$temp_file" --silent --write-out "%{http_code}\n" > /dev/null
echo "Average CPU Usage: $avg_cpu%"
echo "Link creation complete: $num_links links created."
# Clean up
rm -f "$temp_file"
} }
function measure { run_benchmark() {
total_time=0 echo "Fetching all created links from /api/links..."
declare -a refer_links all_links_response=$(curl --silent --request GET \
--url "$api_url" \
--header "X-Api-Key: $api_key" \
--header "Content-Type: application/json")
# Start resource usage logging in the background links=($(echo "$all_links_response" | jq -r '.data[] | .refer'))
nohup bash -c "$(declare -f get_resource_usage); get_resource_usage" &> /dev/null & if [[ ${#links[@]} -ne $num_links ]]; then
resource_usage_pid=$! echo "Error: Expected $num_links links but found ${#links[@]}."
disown exit 1
echo "Creating $num_links short links..."
for ((i=1; i<=num_links; i++)); do
response=$(curl --silent --request POST \
--url $api_url \
--header "X-Api-Key: $api_key" \
--header "Content-Type: application/json" \
--data "{ \"url\": \"https://kagi.com\" }")
refer=$(echo $response | awk -F'"' '/"refer":/{print $(NF-1)}')
if [[ -n $refer ]]; then
refer_links+=("$refer")
if (( i % 100 == 0 )); then
echo "Created short link $i/$num_links"
fi
else
echo "Failed to create short link $i"
echo $response
exit 1
fi
done
echo "Accessing each link $num_requests times concurrently..."
> times.txt # Ensure times.txt is created and empty
total_accesses=$((num_links * num_requests))
accesses_done=0
for refer in "${refer_links[@]}"; do
for ((i=1; i<=num_requests; i++)); do
# Wait for a slot
read -u 3
{
start_time=$(date +%s%6N)
curl -s "$refer" >> /dev/null
end_time=$(date +%s%6N)
elapsed_time=$(echo "$end_time - $start_time" | bc)
echo $elapsed_time >> times.txt
# Release the slot
echo >&3
((accesses_done++))
if (( accesses_done % 10 == 0 )); then
echo "Accessed $accesses_done/$total_accesses"
fi
} &
done
done
wait
# Stop resource usage logging
if kill -0 $resource_usage_pid 2>/dev/null; then
kill $resource_usage_pid
fi fi
# Read all elapsed times and calculate total random_link="${links[RANDOM % ${#links[@]}]}"
while read -r time; do echo "Selected link for benchmarking: $random_link"
total_time=$(echo "$total_time + $time" | bc)
done < times.txt
rm times.txt
echo "****Results****" echo "Starting benchmark with Bombardier..."
bombardier -c $concurrency -n $num_requests "$random_link"
calculate_average_usage echo "Benchmark completed."
echo "Average Response Time: $(echo "scale=2; $total_time / ($num_links * $num_requests)" | bc) µs"
} }
echo "Setup..." analyze_resource_usage() {
echo "Analyzing resource usage..."
total_cpu=0
total_mem=0
count=0
docker-compose up -d while IFS=',' read -r timestamp cpu mem; do
if [ $? -ne 0 ]; then # Skip header line and lines with empty cpu or mem values
echo "Failed to start Docker containers." if [[ $timestamp != "Timestamp" && -n $cpu && -n $mem ]]; then
exit 1 mem=${mem%MiB}
fi
# Create a new user and capture the API key total_cpu=$(echo "$total_cpu + $cpu" | bc)
output=$(docker-compose exec -T app cli --create-user=Admin) total_mem=$(echo "$total_mem + $mem" | bc)
api_key=$(echo "$output" | awk -F' ' '/X-Api-Key:/{print $NF}') ((count++))
echo "Captured API Key: $api_key" fi
done < resource_usage.csv
echo "Waiting for database to be ready..." avg_cpu=0.00
sleep 5 avg_mem=0.00
measure if (( count > 0 )); then
avg_cpu=$(echo "scale=2; $total_cpu / $count" | bc)
avg_mem=$(echo "scale=2; $total_mem / $count" | bc)
fi
# Clean up echo "**** Results ****"
docker-compose down echo "Average CPU Usage: $avg_cpu%"
echo "Average Memory Usage: $avg_mem MiB"
}
cleanup() {
rm -f resource_usage.csv
docker compose down
}
main() {
check_dependencies
setup_containers
monitor_resource_usage & # Start monitoring in the background
monitor_pid=$!
trap 'kill $monitor_pid; cleanup; exit' INT
create_links
run_benchmark
kill $monitor_pid
analyze_resource_usage
cleanup
}
main
+1
View File
@@ -5,6 +5,7 @@ require "./app/lib/*"
require "./app/models/*" require "./app/models/*"
require "./app/serializers/*" require "./app/serializers/*"
require "./app/middlewares/*" require "./app/middlewares/*"
require "./app/services/*"
require "./app/routes" require "./app/routes"
+1
View File
@@ -1,5 +1,6 @@
services: services:
app: app:
container_name: bit
build: . build: .
environment: environment:
ENV: production ENV: production
+1 -1
View File
@@ -1,5 +1,5 @@
name: bit name: bit
version: 1.2.0 version: 1.2.1
authors: authors:
- Juan Rodriguez <sjdonado@icloud.com> - Juan Rodriguez <sjdonado@icloud.com>
+18 -24
View File
@@ -22,7 +22,7 @@ describe "App::Controllers::Link" do
it "should return existing link if url already exists" do it "should return existing link if url already exists" do
test_user = create_test_user() test_user = create_test_user()
payload = {"url" => "https://kagi.com"} payload = {"url" => "http://idonthavespotify.donado.co"}
post( post(
"/api/links", "/api/links",
headers: HTTP::Headers{"Content-Type" => "application/json", "X-Api-Key" => test_user.api_key.to_s}, headers: HTTP::Headers{"Content-Type" => "application/json", "X-Api-Key" => test_user.api_key.to_s},
@@ -75,7 +75,7 @@ describe "App::Controllers::Link" do
payload = {"url" => "https://kagi.com"} payload = {"url" => "https://kagi.com"}
post("/api/links", headers: HTTP::Headers{"Content-Type" => "application/json"}, body: payload.to_json) post("/api/links", headers: HTTP::Headers{"Content-Type" => "application/json"}, body: payload.to_json)
expected = {"error" => "Unauthorized"}.to_json expected = {"error" => "Unauthorized access"}.to_json
response.status_code.should eq(401) response.status_code.should eq(401)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -83,7 +83,7 @@ describe "App::Controllers::Link" do
describe "Index" do describe "Index" do
it "should redirect to origin domain" do it "should redirect to origin domain" do
link = "https://kagi.com" link = "https://test.com"
test_user = create_test_user() test_user = create_test_user()
test_link = create_test_link(test_user, link) test_link = create_test_link(test_user, link)
@@ -95,7 +95,7 @@ describe "App::Controllers::Link" do
end end
it "should create a new click after redirect" do it "should create a new click after redirect" do
link = "https://kagi.com" link = "https://sjdonado.com"
test_user = create_test_user() test_user = create_test_user()
test_link = create_test_link(test_user, link) test_link = create_test_link(test_user, link)
@@ -112,17 +112,11 @@ describe "App::Controllers::Link" do
end end
it "should return 404 - link does not exist" do it "should return 404 - link does not exist" do
link = "https://kagi.com"
test_user = create_test_user() test_user = create_test_user()
test_link = create_test_link(test_user, link) get("https://localhost:4001/R4kj2")
serialized_link = App::Serializers::Link.new(test_link)
delete_test_link(test_link.id) expected = {"error" => "Resource not found"}.to_json
get(serialized_link.refer, headers: HTTP::Headers{"X-Api-Key" => test_user.api_key.to_s})
expected = {"error" => "Not Found"}.to_json
response.status_code.should eq(404) response.status_code.should eq(404)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -146,7 +140,7 @@ describe "App::Controllers::Link" do
end end
it "should return owned links only" do it "should return owned links only" do
links = ["https://google.com", "google.com", "google.com.co", "kagi.com"] links = ["https://google.de", "google.de", "google.edu.co", "x.com"]
test_user = create_test_user() test_user = create_test_user()
links[0..2].each do |link| links[0..2].each do |link|
@@ -168,7 +162,7 @@ describe "App::Controllers::Link" do
it "should return 401 - missing api key" do it "should return 401 - missing api key" do
get "/api/links" get "/api/links"
expected = {"error" => "Unauthorized"}.to_json expected = {"error" => "Unauthorized access"}.to_json
response.status_code.should eq(401) response.status_code.should eq(401)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -176,7 +170,7 @@ describe "App::Controllers::Link" do
describe "Get" do describe "Get" do
it "should return the specified link with click details" do it "should return the specified link with click details" do
link = "https://kagi.com" link = "https://bing.com"
test_user = create_test_user() test_user = create_test_user()
test_link = create_test_link(test_user, link) test_link = create_test_link(test_user, link)
@@ -192,7 +186,7 @@ describe "App::Controllers::Link" do
get("/api/links/1", headers: HTTP::Headers{"X-Api-Key" => test_user.api_key.to_s}) get("/api/links/1", headers: HTTP::Headers{"X-Api-Key" => test_user.api_key.to_s})
expected = {"error" => "Not Found"}.to_json expected = {"error" => "Resource not found"}.to_json
response.status_code.should eq(404) response.status_code.should eq(404)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -200,7 +194,7 @@ describe "App::Controllers::Link" do
it "should return 401 - missing api key" do it "should return 401 - missing api key" do
get "/api/links/1" get "/api/links/1"
expected = {"error" => "Unauthorized"}.to_json expected = {"error" => "Unauthorized access"}.to_json
response.status_code.should eq(401) response.status_code.should eq(401)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -208,11 +202,11 @@ describe "App::Controllers::Link" do
describe "Update" do describe "Update" do
it "should update link url" do it "should update link url" do
link = "https://kagi.com" link = "https://github.com"
test_user = create_test_user() test_user = create_test_user()
test_link = create_test_link(test_user, link) test_link = create_test_link(test_user, link)
payload = {"url" => "https://kagi.com.co"} payload = {"url" => "https://github.com.co"}
put( put(
"/api/links/#{test_link.id}", "/api/links/#{test_link.id}",
headers: HTTP::Headers{"Content-Type" => "application/json", "X-Api-Key" => test_user.api_key.to_s}, headers: HTTP::Headers{"Content-Type" => "application/json", "X-Api-Key" => test_user.api_key.to_s},
@@ -233,7 +227,7 @@ describe "App::Controllers::Link" do
body: payload.to_json body: payload.to_json
) )
expected = {"error" => "Not Found"}.to_json expected = {"error" => "Resource not found"}.to_json
response.status_code.should eq(404) response.status_code.should eq(404)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -246,7 +240,7 @@ describe "App::Controllers::Link" do
body: payload.to_json body: payload.to_json
) )
expected = {"error" => "Unauthorized"}.to_json expected = {"error" => "Unauthorized access"}.to_json
response.status_code.should eq(401) response.status_code.should eq(401)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -254,7 +248,7 @@ describe "App::Controllers::Link" do
describe "Delete" do describe "Delete" do
it "should delete link url" do it "should delete link url" do
link = "https://kagi.com" link = "https://news.ycombinator.com"
test_user = create_test_user() test_user = create_test_user()
test_link = create_test_link(test_user, link) test_link = create_test_link(test_user, link)
@@ -268,7 +262,7 @@ describe "App::Controllers::Link" do
delete("/api/links/1", headers: HTTP::Headers{"X-Api-Key" => test_user.api_key.to_s}) delete("/api/links/1", headers: HTTP::Headers{"X-Api-Key" => test_user.api_key.to_s})
expected = {"error" => "Not Found"}.to_json expected = {"error" => "Resource not found"}.to_json
response.status_code.should eq(404) response.status_code.should eq(404)
response.body.should eq(expected) response.body.should eq(expected)
end end
@@ -276,7 +270,7 @@ describe "App::Controllers::Link" do
it "should return 401 - missing api key" do it "should return 401 - missing api key" do
delete "/api/links/1" delete "/api/links/1"
expected = {"error" => "Unauthorized"}.to_json expected = {"error" => "Unauthorized access"}.to_json
response.status_code.should eq(401) response.status_code.should eq(401)
response.body.should eq(expected) response.body.should eq(expected)
end end
+16 -4
View File
@@ -1,11 +1,21 @@
require "uuid" require "uuid"
require "file_utils"
require "spec-kemal" require "spec-kemal"
require "micrate" require "micrate"
require "dotenv"
Dotenv.load ".env.#{ENV["ENV"]}"
require "../bit" require "../bit"
Spec.before_suite do Spec.before_suite do
# Delete the SQLite database file if it exists
db_file_path = ENV["DATABASE_URL"].split("sqlite3://").last.split("?").first
if File.exists?(db_file_path)
File.delete(db_file_path)
end
Micrate::DB.connection_url = ENV["DATABASE_URL"] Micrate::DB.connection_url = ENV["DATABASE_URL"]
Micrate::Cli.run_up Micrate::Cli.run_up
@@ -20,7 +30,8 @@ def create_test_user
changeset = App::Lib::Database.insert(user) changeset = App::Lib::Database.insert(user)
if !changeset.valid? if !changeset.valid?
raise "Test user creation failed" error_messages = changeset.errors.map { |error| "#{error}" }.join(", ")
raise "Test user creation failed #{error_messages}"
end end
user user
@@ -29,13 +40,14 @@ end
def create_test_link(user, url) def create_test_link(user, url)
link = App::Models::Link.new link = App::Models::Link.new
link.id = UUID.v4.to_s link.id = UUID.v4.to_s
link.slug = App::Services::SlugService.shorten_url(url, user.id.to_s)
link.url = url link.url = url
link.slug = Random::Secure.urlsafe_base64(4)
link.user = user link.user = user
changeset = App::Lib::Database.insert(link) changeset = App::Lib::Database.insert(link)
if !changeset.valid? unless changeset.valid?
raise "Test link creation failed" error_messages = changeset.errors.map { |error| "#{error}" }.join(", ")
raise "Test link creation failed: #{error_messages}"
end end
link.clicks = [] of App::Models::Click link.clicks = [] of App::Models::Click