chore: cleanup

Author: skitsanos

.github/workflows/publish-to-luarocks.yml

@@ -0,0 +1,71 @@
+name: LuaRocks Release
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '.github/**/*.yml'
+      - '.gitignore'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Set latest version"
+        id: set-latest-tag
+        run: |
+          currentVersion=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" https://api.github.com/repos/${{github.repository}}/tags | jq -r 'sort_by(.name | split(".") | map(tonumber)) | reverse | .[0].name')
+          echo "LATEST_VERSION=$currentVersion" >> $GITHUB_ENV
+      - run: echo "Current version is ${{env.LATEST_VERSION}}"
+
+      - name: "Setup Lua"
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y lua5.1 luarocks
+          sudo luarocks install lua-cjson
+      - name: "Install semver"
+        run: |
+          # Download the script and save it to /usr/local/bin
+          wget -O /usr/local/bin/semver https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver
+          # Make script executable
+          chmod +x /usr/local/bin/semver
+          # Prove it works
+          semver --version
+      - name: Increment version
+        id: new_version
+        run: |
+          NEXT_VERSION=$(semver bump patch ${{env.LATEST_VERSION}})
+          echo "NEXT_VERSION=$NEXT_VERSION" >> $GITHUB_OUTPUT
+      - run: echo "Next version is ${{ steps.new_version.outputs.NEXT_VERSION }}"
+
+      - name: Create new tag
+        run: |
+          git config --global user.email "noreply@skitsanos.com"
+          git config --global user.name "ReleaseBot"
+          git tag -a ${{ steps.new_version.outputs.NEXT_VERSION }} -m "release version ${{ steps.new_version.outputs.NEXT_VERSION }}"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Push new tag
+        run: git push origin ${{ steps.new_version.outputs.NEXT_VERSION }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Create rockspec
+        run: luarocks write_rockspec --lua-versions 5.1 --license MIT --homepage https://github.com/skitsanos/lua-arangodb lua-arangodb ${{ steps.new_version.outputs.NEXT_VERSION }} .
+
+      - name: Package rock
+        run: luarocks pack lua-arangodb-${{ steps.new_version.outputs.NEXT_VERSION }}-1.rockspec
+
+      - name: Upload rock
+        env:
+          LUAROCKS_USERNAME: ${{ secrets.LUAROCKS_USERNAME }}
+          LUAROCKS_PASSWORD: ${{ secrets.LUAROCKS_TOKEN }}
+        run: |
+          echo "Uploading rock to LuaRocks"      
+          luarocks upload --api-key=$LUAROCKS_PASSWORD lua-arangodb-${{ steps.new_version.outputs.NEXT_VERSION }}-1.rockspec

README.md

@@ -1,10 +1,76 @@
+# ArangoDB Client for OpenResty
+
 ### Dependencies
- - lua-cjson
- - base64
- - lua-resty-http
 
-### Testing
+- lua-cjson
+- base64
+- lua-resty-http
+
+### Testing with resty utility
+
+1. Open a terminal window and navigate to your Lua script's directory.
+2. Run the command `resty resty [your lua script name]` to execute the script.
+3. If your Lua script requires any input or parameters, you can pass them as arguments after the script name.
+4. For example, if your lua script is named 'test.lua' and it takes in a parameter 'name', you can run the command.'
+   `resty test.lua name=John`.
+5. The output of the script will be displayed in the terminal.
+6. You can also redirect the output to a file by using the '>' operator, for example, `resty /usr/local/bin/resty
+   test.lua name=John > output.txt`. This will save the script's output in a file named 'output.txt'.
+
+**Example:**
+
+Create a Lua file, for example `test.lua`:
+
+```lua
+local arangodb = require("arangodb")
+
+local db = arangodb.new({
+    endpoint = "http://127.0.0.1:8529",
+    username = "root",
+    password = "openSesame",
+    db = "debug"
+})
+
+local success, results = pcall(function()
+   return db:query("FOR i IN 1..10 RETURN i")
+end)
+
+if success then
+   -- print the results
+   for _, v in ipairs(results) do
+      print(v)
+   end
+else
+   -- print the error message
+   print(results)
+end
+```
+
+Now you could run it just like this:
+
+```shell
+resty src/test.lua
+```
+
+But because `arangodb` module is using few dependencies, you need to make sure they are installed:
+
+```shell
+luarocks install lua-cjson
+luarocks install lbase64
+luarocks install lua-resty-http
+```
+
+Then, when running with `resty` you need to provide the path to Lua libraries.
+
+To include libraries installed by luarocks in your Lua script, you need to add the following line at the top of your
+script
+
+```lua
+local luarocks_path = '/usr/local/share/lua/5.4/'
+package.path = package.path .. ";" .. luarocks_path .. "?.lua"
+```
 
+Or run with `-I` argument pointing to luarocks libraries:
 ```shell
 resty -I /usr/local/share/lua/5.4/ src/test.lua
 ```

src/test.lua

@@ -24,4 +24,3 @@ else
     -- print the error message
     print(results)
 end
-