misskey 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e2e920853b80640240b7ad629a1f998b23df4369542f9d8a6e909a3883147d
-  data.tar.gz: bd07e84986ca9e0d9807b5c3055c20c02ff9ec7ffe39e7388f5864cb0739af58
+  metadata.gz: 2c4008ac213ee40bf57c9755520e34002d91fa6f730e7fd0d316a71ec4d25aa5
+  data.tar.gz: aff4ba972e9212006a148beacda5673a0b689c9302194f748a65dba610ffb613
 SHA512:
-  metadata.gz: dadffdeacd82c3244c69a5e00a41bad5ed2ef275de8169deb4d384459bdb1788a78f6b143d6e53b19b3aabda3fdcd9bf359a3cd734a66836c4f0f8859818b777
-  data.tar.gz: e7e120302904faa5d1863bef0af94654a643f7788e0a4fc307a6a3897d59c2266361d3e14022dffdf165e14641d710887046cdf804d1b8c4e5a67f08af50d8ea
+  metadata.gz: 802c89d8a5645c7d4b4f7b40896be93a1b786227e8e7d90ddd3ca71e4489d8140d46388239b1e9a57bd67b5f06f9124861e47b3ff8f7d0bc8a31cfa41fa4c389
+  data.tar.gz: 7ccdc70381209c61f3165586bd99db68b5a0e99bb6eb73813a714099d28cc62c990efc0ebc2a22c651528879d9096ab47a1d2e469500d4b6a2af02d7358984be

data/README.md

@@ -30,6 +30,8 @@ I didn't have the energy to make a real wiki for this and I have no idea how to
 
 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.
@@ -156,6 +158,8 @@ You may refer to the [Misskey API docs](https://sharkey.skydevs.me/api-doc#tag/n
 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"
 
@@ -217,3 +221,113 @@ 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

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.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sky.Bit