commit e49b52622e78e701a7643f32616b3a541c2b4cb6 · dunkirk.sh/cachet

+26 -13

README.md

···

       6
        
       </h1>

     

       7
        
       

     

       8
        
       <p align="center">

     

       9
       -
           <i><b>noun</b> - A mark or quality, as of distinction, individuality, or authenticity.</i>

     

       10
        
       </p>

     

       11
        
       

     

       12
        
       <p align="center">

     
···

       66
        
       

     

       67
        
       ### Usage

     

       68
        
       

     

       69
       -
       The api is pretty simple. You can get a profile picture by calling `GET /profile/:id` where `:id` is the slack user id. You can get an emoji by calling `GET /emoji/:name` where `:name` is the name of the emoji. You can also get a list of all emojis by calling `GET /emojis`. 

     

       70
        
       

     

       71
        
       Additionally, you can manually purge a specific user's cache with `POST /users/:user/purge` (requires authentication with a bearer token).

     

       72
        
       

     

       73
       -
       There are also complete swagger docs available at [`/swagger`](https://cachet.dunkirk.sh/swagger)! They are dynamically generated from the code so they should always be up to date! (The types force me to keep them up to date ^_^)

     

       74
        
       

     

       75
        
       ![Swagger Docs](https://raw.githubusercontent.com/taciturnaxolotl/cachet/master/.github/images/swagger.webp)

     

       76
        
       

     
···

       109
        
         },

     

       110
        
       );

     

       111
        
       

     

       112
       -
       await cache.insertUser("U062UG485EE", "https://avatars.slack-edge.com/2024-11-30/8105375749571_53898493372773a01a1f_original.jpg", null);

     

       113
       -
       await cache.insertEmoji("hackshark", "https://emoji.slack-edge.com/T0266FRGM/hackshark/0bf4771247471a48.png");

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       114
        
       

     

       115
        
       const emoji = await cache.getEmoji("hackshark");

     

       116
        
       const user = await cache.getUser("U062UG485EE");

     
···

       123
        
       The final bit was at this point a bit of a ridiculous one. I didn't like how heavyweight the `bolt` or `slack-edge` packages were so I rolled my own slack api wrapper. It's again fully typed and designed to be as lightweight as possible.

     

       124
        
       

     

       125
        
       ```typescript

     

       126
       -
       const slack = new Slack(process.env.SLACK_TOKEN, process.env.SLACK_SIGNING_SECRET);

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       127
        
       

     

       128
        
       const user = await slack.getUser("U062UG485EE");

     

       129
        
       const emojis = await slack.getEmoji();

     

       130
        
       

     

       131
        
       // Manually purge a specific user's cache using the API endpoint

     

       132
       -
       const response = await fetch("https://cachet.example.com/users/U062UG485EE/purge", {

     

       133
       -
         method: "POST",

     

       134
       -
         headers: {

     

       135
       -
           "Authorization": `Bearer ${process.env.BEARER_TOKEN}`

     

       136
       -
         }

     

       137
       -
       });

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       138
        
       const result = await response.json();

     

       139
        
       // { message: "User cache purged", userId: "U062UG485EE", success: true }

     

       140
        
       ```

     
···

       157
        
       export const myNewMigration: Migration = {

     

       158
        
         version: "0.3.2", // Should match package.json version

     

       159
        
         description: "What this migration does",

     

       160
       -
         

     

       161
        
         async up(db: Database): Promise<void> {

     

       162
        
           // Migration code here

     

       163
        
           db.run(`ALTER TABLE my_table ADD COLUMN new_column TEXT`);

···

       6
        
       </h1>

     

       7
        
       

     

       8
        
       <p align="center">

     

       9
       +
           <i>the slack emoji and profile cache serving the hackclub slack</i>

     

       10
        
       </p>

     

       11
        
       

     

       12
        
       <p align="center">

     
···

       66
        
       

     

       67
        
       ### Usage

     

       68
        
       

     

       69
       +
       The api is pretty simple. You can get a profile picture by calling `GET /profile/:id` where `:id` is the slack user id. You can get an emoji by calling `GET /emoji/:name` where `:name` is the name of the emoji. You can also get a list of all emojis by calling `GET /emojis`.

     

       70
        
       

     

       71
        
       Additionally, you can manually purge a specific user's cache with `POST /users/:user/purge` (requires authentication with a bearer token).

     

       72
        
       

     

       73
       +
       There are also complete swagger docs available at [`/swagger`](https://cachet.dunkirk.sh/swagger)! They are dynamically generated from the code so they should always be up to date! (The types force me to keep them up to date ^\_^)

     

       74
        
       

     

       75
        
       ![Swagger Docs](https://raw.githubusercontent.com/taciturnaxolotl/cachet/master/.github/images/swagger.webp)

     

       76
        
       

     
···

       109
        
         },

     

       110
        
       );

     

       111
        
       

     

       112
       +
       await cache.insertUser(

     

       113
       +
         "U062UG485EE",

     

       114
       +
         "https://avatars.slack-edge.com/2024-11-30/8105375749571_53898493372773a01a1f_original.jpg",

     

       115
       +
         null,

     

       116
       +
       );

     

       117
       +
       await cache.insertEmoji(

     

       118
       +
         "hackshark",

     

       119
       +
         "https://emoji.slack-edge.com/T0266FRGM/hackshark/0bf4771247471a48.png",

     

       120
       +
       );

     

       121
        
       

     

       122
        
       const emoji = await cache.getEmoji("hackshark");

     

       123
        
       const user = await cache.getUser("U062UG485EE");

     
···

       130
        
       The final bit was at this point a bit of a ridiculous one. I didn't like how heavyweight the `bolt` or `slack-edge` packages were so I rolled my own slack api wrapper. It's again fully typed and designed to be as lightweight as possible.

     

       131
        
       

     

       132
        
       ```typescript

     

       133
       +
       const slack = new Slack(

     

       134
       +
         process.env.SLACK_TOKEN,

     

       135
       +
         process.env.SLACK_SIGNING_SECRET,

     

       136
       +
       );

     

       137
        
       

     

       138
        
       const user = await slack.getUser("U062UG485EE");

     

       139
        
       const emojis = await slack.getEmoji();

     

       140
        
       

     

       141
        
       // Manually purge a specific user's cache using the API endpoint

     

       142
       +
       const response = await fetch(

     

       143
       +
         "https://cachet.example.com/users/U062UG485EE/purge",

     

       144
       +
         {

     

       145
       +
           method: "POST",

     

       146
       +
           headers: {

     

       147
       +
             Authorization: `Bearer ${process.env.BEARER_TOKEN}`,

     

       148
       +
           },

     

       149
       +
         },

     

       150
       +
       );

     

       151
        
       const result = await response.json();

     

       152
        
       // { message: "User cache purged", userId: "U062UG485EE", success: true }

     

       153
        
       ```

     
···

       170
        
       export const myNewMigration: Migration = {

     

       171
        
         version: "0.3.2", // Should match package.json version

     

       172
        
         description: "What this migration does",

     

       173
       +
       

     

       174
        
         async up(db: Database): Promise<void> {

     

       175
        
           // Migration code here

     

       176
        
           db.run(`ALTER TABLE my_table ADD COLUMN new_column TEXT`);