misskey 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71cbb354bf3e664aced3e95663daf3913fbc15164101b9e142c287b30ee8832c
-  data.tar.gz: 64b42af87b8adb89acf63b1127b7b33928f4eee6efd2ceea366ced0c3b46841e
+  metadata.gz: 2c4008ac213ee40bf57c9755520e34002d91fa6f730e7fd0d316a71ec4d25aa5
+  data.tar.gz: aff4ba972e9212006a148beacda5673a0b689c9302194f748a65dba610ffb613
 SHA512:
-  metadata.gz: 36fbcabc078bc9802c708b1f9653a7a1677a29ab21433aa8ea34a95b90913945c975b33066e009ae948da8a44b52eafaab944eee34827c181d675628e0faaece
-  data.tar.gz: 9794cbf3ddaf2ae5bb4b2d8a2dd1a654d539f2be83cc5ef048178217bac8f60309c98c6b62b3f2b6ed4f89c5e251d570eb18e3bda6dce5123c43d0969119ba0e
+  metadata.gz: 802c89d8a5645c7d4b4f7b40896be93a1b786227e8e7d90ddd3ca71e4489d8140d46388239b1e9a57bd67b5f06f9124861e47b3ff8f7d0bc8a31cfa41fa4c389
+  data.tar.gz: 7ccdc70381209c61f3165586bd99db68b5a0e99bb6eb73813a714099d28cc62c990efc0ebc2a22c651528879d9096ab47a1d2e469500d4b6a2af02d7358984be

data/README.md

@@ -1,3 +1,333 @@
 # Misskey.rb
 
-A Ruby module for interacting with the Misskey API
+A Ruby module for interacting with the Misskey API. Releases hosted on [Rubygems](https://rubygems.org/gems/misskey). **This is not affiliated with Syuilo in any way!!**
+
+## Installation :neofox_science:
+Either add it to your Gemfile:
+```Gemfile
+gem "misskey"
+```
+or install it directly with Gem:
+```sh
+gem install misskey
+```
+
+## Contributing :neofox_laptop:
+Because it would be really difficult for me to implement *every* Misskey API feature, I would really appreciate contributions!
+
+When contributing please make sure to follow these guidelines. These may change as time goes on:
+
+1) No LLM-generated commits please! Vibecoded software tends to get really messy and introduce more issues than it solves. Also everything around LLMs are highly unethical and I don't want to support that. Thanks!
+
+2) Please do not create multiple functions that do the same thing.
+
+3) Follow common sense.
+
+Thank you! :neofox_heart:
+
+## Using :neofox_notice:
+I didn't have the energy to make a real wiki for this and I have no idea how to use the Rubygems documentation thingy so I just stuck it in one big readme. I am deeply sorry about this :neofox_googly_shocked:
+
+Like I said in the contributing guide, this doesn't implement every Misskey API feature and if you want to see a feature added it would mean a lot to me if you could contribute! Thanks :neofox_heart:
+
+All responses from the API are automatically parsed from JSON to a Ruby Array so you shouldn't need to worry about that.
+
+### Authentication **(REQUIRED!!!)**
+#### `Misskey.auth.instanceURI`
+This sets the instance URI that your client will connect to. This and `Misskey.auth.token` are **required** when using Misskey.rb.
+
+This can be used like a variable. You can change it or access it at any time. See some examples below:
+
+Changing the value:
+```ruby
+require "misskey"
+
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+```
+
+Calling the value:
+```ruby
+require "misskey"
+
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+# Getting the value
+puts Misskey.auth.instanceURI
+```
+
+Pretty simple :neofox_floof_happy:
+
+#### `Misskey.auth.token`
+This sets the API key/token that your client will connect to. This and `Misskey.auth.instanceURI` are **required** when using Misskey.rb.
+
+This can be used like a variable. You can change it or access it at any time. See some examples below:
+
+Changing the value:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "blahblahtokenweeewooooooo"
+```
+
+Calling the value:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "wafwaftokenaaaaaa"
+
+# Getting the value
+puts Misskey.auth.token
+```
+
+You can also use this in pair with the `dotenv` module:
+```ruby
+require "misskey"
+require "dotenv"
+
+Dotenv.load "./.env"
+Misskey.auth.token = ENV["APIKey"]
+```
+
+Also pretty simple :neofox_floof_happy:
+
+### Notes
+#### `Misskey.notes.create`
+Creates a note.
+
+Order of arguments are as follows: `noteContent` also known as the body text (REQUIRED), `visibility`, `localonly`, `cw` also known as a content warning.
+
+Visibility options include: `public`, `home`, `followers`, and `specified`. `specified` is also known as a direct note or private message.
+
+Some examples:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.notes.create "Hello world!! :neofox_floof:"
+```
+It will automatically convert things like ":neofox_floof:" to their respective emojis as seen above.
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.notes.create "Hello there, this is a home note.", "home"
+```
+The example above shows a client creating a note with the visibility "home"
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.notes.create "Hi this is local!", "public", true
+```
+The example above shows a client creating a public local (aka defederated) note.
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.notes.create "Hi this is local and features a content warning!", "public", true, "Holy moly it's a post by me wow beware"
+```
+As the note body suggests, this is a local note that has a content warning.
+
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/notes/POST/notes/create) for more info.
+
+#### `Misskey.notes.create.reply`
+Very similar to `Misskey.notes.create` except it features a new required argument called `replyId`.
+
+Arguments for this are as follows: `replyId` (REQUIRED), `noteContent` (REQUIRED), visibility, localOnly, cw
+
+An example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.notes.create.reply "someReplyId", "Hello there, this is a reply."
+```
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/notes/POST/notes/create) for more info.
+
+#### `Misskey.notes.timeline`
+Retrieves the home timeline of the currently logged-in user I believe? Not too sure because I only tested it on a dummy account that doesn't follow anyone. 
+
+There is one optional argument which is `limit`. As the name suggests, it sets a limit to how many notes should be retrieved. By default it's set to 10.
+
+Here's an example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+puts Misskey.notes.timeline
+```
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/notes/POST/notes/timeline) for more info.
+
+### `Misskey.getOnlineUsersCount`
+Pretty self-explanatory, gets the number of users online. Using it is really simple, here's an example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+puts "There are #{Misskey.getOnlineUsersCount} user(s) online right now!"
+```
+Slightly more complicated example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+case Misskey.getOnlineUserscount.to_i
+when 0
+    puts "There are no users online :("
+when 1
+    puts "There is 1 user online."
+when > 1
+    puts "There are #{Misskey.getOnlineUserscount} users online"
+end
+```
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/meta/POST/get-online-users-count) for more info.
+
+### `Misskey.serverInfo`
+Retrieves the instance/server information. Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+puts Misskey.serverInfo
+```
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/meta/POST/server-info) for more info.
+
+### `Misskey.i`
+Retrieves the information about the currently logged-in user. Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+puts Misskey.i
+```
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/account/POST/i) for more info.
+
+#### `Misskey.i.notifications`
+Retrieves the currently logged-in user's notifications. Has one argument which is `limit`. By default, `limit` is set to 10. Here's an example
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+puts Misskey.i.notifications
+```
+You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/account/POST/i/notifications) for more info.
+
+### Websockets!! (THis is my favorite thing about this library :neofox_floof_cute:)
+#### `Misskey.websocket.connect`
+Connects your client to Misskey via the websocket protocol. Automatically runs in a separate thread. There is no documentation on websockets in the Misskey API docs but the JSON data it gives is in the same structure as doing a normal request to their documented API.
+
+#### Notifications
+##### `Misskey.websocket.notifications.onMention`
+Used with a block; runs said block with an argument contianing the message when you recieve a mention notification.
+
+Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.websocket.connect
+
+Misskey.websocket.notifications.onMention do |message|
+    puts message
+end
+```
+In this example, `puts message` will print the message JSON data in the terminal when it recieves a mention.
+
+##### `Misskey.websocket.notifications.onReaction`
+Used with a block; runs said block with an argument contianing the message when you recieve a reaction notification.
+
+Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.websocket.connect
+
+Misskey.websocket.notifications.onReaction do |message|
+    puts message
+end
+```
+In this example, `puts message` will print the message JSON data in the terminal when it recieves a reaction.
+
+##### `Misskey.websocket.notifications.onRenote`
+Used with a block; runs said block with an argument contianing the message when you recieve a renote notification.
+
+Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.websocket.connect
+
+Misskey.websocket.notifications.onRenote do |message|
+    puts message
+end
+```
+In this example, `puts message` will print the message JSON data in the terminal when it recieves a renote.
+
+##### `Misskey.websocket.notifications.onNotification`
+Used with a block; runs said block with an argument contianing the message when you recieve a notification.
+
+Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.websocket.connect
+
+Misskey.websocket.notifications.onNotification do |message|
+    puts message
+end
+```
+In this example, `puts message` will print the message JSON data in the terminal when it recieves a notification.
+
+##### `Misskey.websocket.notifications.onQuote`
+Used with a block; runs said block with an argument contianing the message when you recieve a quote notification.
+
+Example:
+```ruby
+require "misskey"
+
+Misskey.auth.token = "tokenwaaaaaaa"
+Misskey.auth.instanceURI = "sharkey.skydevs.me"
+
+Misskey.websocket.connect
+
+Misskey.websocket.notifications.onQuote do |message|
+    puts message
+end
+```
+In this example, `puts message` will print the message JSON data in the terminal when it recieves a quote.
+
+## That's all!
+Those are all the features currently implemented, but don't worry, more will be added as time goes on :neofox_heart:

data/lib/misskey.rb

@@ -11,12 +11,6 @@ include WS
 module Misskey
   @@token = nil
   @@instanceURI = nil
-  @@onMentionDo = [false, nil]
-  @@debugging = false
-  @@onReactionDo = [false, nil]
-  @@onRenoteDo = [false, nil]
-  @@onNotificationDo = [false, nil]
-  @@onQuoteDo = [false, nil]
 
   def auth
     def token
@@ -54,6 +48,27 @@ module Misskey
         Creates.created.reply replyId, noteContent, visibility = "public", localOnly = false, cw = ""
       end
     end
+
+    def timeline limit = 10
+      instance = "https://#{Misskey.auth.instanceURI}/api/notes/timeline"
+
+      postJSON = <<EOF
+{
+  "limit": #{limit}
+}
+EOF
+  
+      request = HTTParty.post(
+        instance,
+        body: postJSON,
+        headers: { 
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{Misskey.auth.token}"
+        }
+      )
+
+      return JSON.parse request.body
+    end
   end
 
   def getOnlineUsersCount
@@ -110,27 +125,6 @@ EOF
         "Authorization" => "Bearer #{Misskey.auth.token}"
       }
     )
-
-    def timeline limit = 100
-      instance = "https://#{Misskey.auth.instanceURI}/api/notes/timeline"
-
-      postJSON = <<EOF
-{
-  "limit": #{limit}
-}
-EOF
-  
-      request = HTTParty.post(
-        instance,
-        body: postJSON,
-        headers: { 
-          "Content-Type" => "application/json",
-          "Authorization" => "Bearer #{Misskey.auth.token}"
-        }
-      )
-
-      return JSON.parse request.body
-    end
     
     def notifications limit = 10
       instance = "https://#{Misskey.auth.instanceURI}/api/i/notifications"

data/lib/websocket.rb

@@ -1,4 +1,11 @@
 module WS
+  @@onMentionDo = [false, nil]
+  @@debugging = false
+  @@onReactionDo = [false, nil]
+  @@onRenoteDo = [false, nil]
+  @@onNotificationDo = [false, nil]
+  @@onQuoteDo = [false, nil]
+
   def c
     Thread.start do 
       EM.run do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: misskey
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Sky.Bit