rocksky 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6c83fa81b7bb244115d6b179b278f592dbbade9efdbcb5ec1d4b0f7e2d4b9c
-  data.tar.gz: 410f0dda9e50cdc5b60f39d84d3184cc740db1937672fa3f63417b77665e46a6
+  metadata.gz: 0b8b76d8708ad8f7131598c1440f644a6e037f5f83d15438c64b9b855e41cbca
+  data.tar.gz: 746d5eaad86c2ecc50fc8e24b64e34c06619df8f7446258d5974e84050df9088
 SHA512:
-  metadata.gz: 0b0f47853567386514a64edd0beca2ea4c1ab0561f5834371c1756566e026681d0456876c7adacc3d6c1d957be83e3735e0ed5b1e9c9c940c1495851362075d8
-  data.tar.gz: 190f6cbdba923e62b13332f6a04f897c07dec5a5b8098ee7cfc4947b15088dd721deae25778ed9a3ea26b1a4bf3f1926c9891b6c81e5ddce367cc7761324f7a6
+  metadata.gz: 8978ba1c65543698e7af1790d8e2eb0e9c38048b6b1d15c15abc8482681ea13238bda48fb810ef122a6de59ba42ed1983522d336df809c3277c50650f5c6330a
+  data.tar.gz: 3e573bd6311727ae239f95de13b0dcc38b77bd8aa0a1d3d7c74e08c0e97d7747d3de144f076a9956a6445c10de3bac1e2598d7da51dc62871287cfd07811e57a

data/README.md

@@ -14,7 +14,7 @@ gem install rocksky
 Or in a Gemfile:
 
 ```ruby
-gem "rocksky", "~> 0.6"
+gem "rocksky", "~> 0.7"
 ```
 
 The gem is pure-Ruby; the native library is fetched from the GitHub release on

data/lib/rocksky/library.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module Rocksky
+  # Authenticated client for the app.rocksky.library.* API — the Subsonic /
+  # navidrome-compatible surface over a user's uploaded music. Every method
+  # requires auth, so a token is mandatory at construction (see Rocksky.library).
+  # Optional params are Ruby keyword args (nil = omitted); wire keys stay
+  # camelCase. Returns the parsed JSON payload.
+  class Library
+    def initialize(token, base: nil)
+      raise Error, "app.rocksky.library.* requires an access token" if token.nil? || token.to_s.empty?
+
+      @token = token.to_s
+      @base = base.to_s
+    end
+
+    # app.rocksky.library.ping
+    def ping()
+      query("app.rocksky.library.ping", {})
+    end
+
+    # app.rocksky.library.getLicense
+    def get_license()
+      query("app.rocksky.library.getLicense", {})
+    end
+
+    # app.rocksky.library.getMusicFolders
+    def get_music_folders()
+      query("app.rocksky.library.getMusicFolders", {})
+    end
+
+    # app.rocksky.library.getScanStatus
+    def get_scan_status()
+      query("app.rocksky.library.getScanStatus", {})
+    end
+
+    # app.rocksky.library.startScan
+    def start_scan()
+      query("app.rocksky.library.startScan", {})
+    end
+
+    # app.rocksky.library.getUser
+    def get_user()
+      query("app.rocksky.library.getUser", {})
+    end
+
+    # app.rocksky.library.getArtists
+    def get_artists()
+      query("app.rocksky.library.getArtists", {})
+    end
+
+    # app.rocksky.library.getIndexes
+    def get_indexes()
+      query("app.rocksky.library.getIndexes", {})
+    end
+
+    # app.rocksky.library.getArtist
+    def get_artist(id)
+      query("app.rocksky.library.getArtist", { id: id })
+    end
+
+    # app.rocksky.library.getArtistInfo
+    def get_artist_info(id)
+      query("app.rocksky.library.getArtistInfo", { id: id })
+    end
+
+    # app.rocksky.library.getAlbum
+    def get_album(id)
+      query("app.rocksky.library.getAlbum", { id: id })
+    end
+
+    # app.rocksky.library.getAlbumList
+    def get_album_list(type, size: nil, offset: nil, from_year: nil, to_year: nil, genre: nil)
+      query("app.rocksky.library.getAlbumList", { type: type, size: size, offset: offset, fromYear: from_year, toYear: to_year, genre: genre })
+    end
+
+    # app.rocksky.library.getAlbumInfo
+    def get_album_info(id)
+      query("app.rocksky.library.getAlbumInfo", { id: id })
+    end
+
+    # app.rocksky.library.getSong
+    def get_song(id)
+      query("app.rocksky.library.getSong", { id: id })
+    end
+
+    # app.rocksky.library.getRandomSongs
+    def get_random_songs(size: nil, genre: nil, from_year: nil, to_year: nil)
+      query("app.rocksky.library.getRandomSongs", { size: size, genre: genre, fromYear: from_year, toYear: to_year })
+    end
+
+    # app.rocksky.library.getSongsByGenre
+    def get_songs_by_genre(genre, count: nil, offset: nil)
+      query("app.rocksky.library.getSongsByGenre", { genre: genre, count: count, offset: offset })
+    end
+
+    # app.rocksky.library.getSimilarSongs
+    def get_similar_songs(id, count: nil)
+      query("app.rocksky.library.getSimilarSongs", { id: id, count: count })
+    end
+
+    # app.rocksky.library.getTopSongs
+    def get_top_songs(artist, count: nil)
+      query("app.rocksky.library.getTopSongs", { artist: artist, count: count })
+    end
+
+    # app.rocksky.library.getLyrics
+    def get_lyrics(artist: nil, title: nil)
+      query("app.rocksky.library.getLyrics", { artist: artist, title: title })
+    end
+
+    # app.rocksky.library.getMusicDirectory
+    def get_music_directory(id)
+      query("app.rocksky.library.getMusicDirectory", { id: id })
+    end
+
+    # app.rocksky.library.getGenres
+    def get_genres()
+      query("app.rocksky.library.getGenres", {})
+    end
+
+    # app.rocksky.library.search
+    def search(query, artist_count: nil, artist_offset: nil, album_count: nil, album_offset: nil, song_count: nil, song_offset: nil)
+      query("app.rocksky.library.search", { query: query, artistCount: artist_count, artistOffset: artist_offset, albumCount: album_count, albumOffset: album_offset, songCount: song_count, songOffset: song_offset })
+    end
+
+    # app.rocksky.library.getStarred
+    def get_starred()
+      query("app.rocksky.library.getStarred", {})
+    end
+
+    # app.rocksky.library.star
+    def star(id, album_id: nil, artist_id: nil)
+      procedure("app.rocksky.library.star", { id: id, albumId: album_id, artistId: artist_id })
+    end
+
+    # app.rocksky.library.unstar
+    def unstar(id, album_id: nil, artist_id: nil)
+      procedure("app.rocksky.library.unstar", { id: id, albumId: album_id, artistId: artist_id })
+    end
+
+    # app.rocksky.library.getPlaylists
+    def get_playlists()
+      query("app.rocksky.library.getPlaylists", {})
+    end
+
+    # app.rocksky.library.getPlaylist
+    def get_playlist(id)
+      query("app.rocksky.library.getPlaylist", { id: id })
+    end
+
+    # app.rocksky.library.createPlaylist
+    def create_playlist(name)
+      procedure("app.rocksky.library.createPlaylist", { name: name })
+    end
+
+    # app.rocksky.library.updatePlaylist
+    def update_playlist(playlist_id, name: nil, comment: nil, song_id_to_add: nil, song_index_to_remove: nil)
+      procedure("app.rocksky.library.updatePlaylist", { playlistId: playlist_id, name: name, comment: comment, songIdToAdd: song_id_to_add, songIndexToRemove: song_index_to_remove })
+    end
+
+    # app.rocksky.library.deletePlaylist
+    def delete_playlist(id)
+      procedure("app.rocksky.library.deletePlaylist", { id: id })
+    end
+
+    # app.rocksky.library.deleteSong
+    def delete_song(id)
+      procedure("app.rocksky.library.deleteSong", { id: id })
+    end
+
+    # app.rocksky.library.deleteAlbum
+    def delete_album(id)
+      procedure("app.rocksky.library.deleteAlbum", { id: id })
+    end
+
+    # app.rocksky.library.scrobble
+    def scrobble(id, time: nil, submission: nil)
+      procedure("app.rocksky.library.scrobble", { id: id, time: time, submission: submission })
+    end
+
+    # app.rocksky.library.updateNowPlaying
+    def update_now_playing(id)
+      procedure("app.rocksky.library.updateNowPlaying", { id: id })
+    end
+
+    # app.rocksky.library.getNowPlaying
+    def get_now_playing()
+      query("app.rocksky.library.getNowPlaying", {})
+    end
+
+    # app.rocksky.library.getPlayQueue
+    def get_play_queue()
+      query("app.rocksky.library.getPlayQueue", {})
+    end
+
+    # app.rocksky.library.savePlayQueue
+    def save_play_queue(id: nil, current: nil, position: nil)
+      procedure("app.rocksky.library.savePlayQueue", { id: id, current: current, position: position })
+    end
+
+    # app.rocksky.library.getStreamUrl
+    def get_stream_url(id, max_bit_rate: nil, format: nil)
+      query("app.rocksky.library.getStreamUrl", { id: id, maxBitRate: max_bit_rate, format: format })
+    end
+
+    # app.rocksky.library.getDownloadUrl
+    def get_download_url(id)
+      query("app.rocksky.library.getDownloadUrl", { id: id })
+    end
+
+    # app.rocksky.library.getCoverArtUrl
+    def get_cover_art_url(id, size: nil)
+      query("app.rocksky.library.getCoverArtUrl", { id: id, size: size })
+    end
+
+    # app.rocksky.library.getInternetRadioStations
+    def get_internet_radio_stations()
+      query("app.rocksky.library.getInternetRadioStations", {})
+    end
+
+    private
+
+    def query(nsid, params = {})
+      Rocksky.unwrap(C.rocksky_library_get(@base, @token, nsid, JSON.generate(params.compact)))
+    end
+
+    def procedure(nsid, body = {})
+      Rocksky.unwrap(C.rocksky_library_post(@base, @token, nsid, JSON.generate(body.compact)))
+    end
+  end
+end

data/lib/rocksky/manifest.json

@@ -1,12 +1,12 @@
 {
   "repo": "tsirysndr/rocksky",
-  "tag": "bindings-v0.3.0",
+  "tag": "bindings-v0.5.0",
   "checksums": {
-    "aarch64-apple-darwin": "645f343ba39bbcaa62ed38a56b8b9d88010d20e8e1f7488b691eab751f05d52d",
-    "aarch64-linux-gnu": "d8939244fa7fac3b56e83012fc30c87dc50b8531e21f860ab324159d38d5e78d",
-    "x86_64-apple-darwin": "9702077e8793c2a3c07c345e684c0918da04a44c71668c862fb516a75af61763",
-    "x86_64-linux-gnu": "964afa99734213465343daf3c5e5681be7c1a5a5d656a7030b5f2cc2b3bcea23",
-    "x86_64-unknown-freebsd": "e827e572d9d18eb9996607a9107bed4e28aaea0878f744b152bd3e6afec05bf4",
-    "x86_64-unknown-netbsd": "78744d465bbcbbe2f7fc61e36e554153d9a8334ac471e52f65c997c1beaeb455"
+    "aarch64-apple-darwin": "f0a2965681967c261cd9b11ddf3ccf33fbc813cd4551cad35316f25e988c9e2c",
+    "aarch64-linux-gnu": "345f0545415ea86a9b1d6f397c36f1810ce78140c7b1db3eee4bdb7b9299f4f2",
+    "x86_64-apple-darwin": "d2568ab8c781851023c9922f7b7853adbd7af40bfa606814ef6abcd541510eb7",
+    "x86_64-linux-gnu": "9b6b17d884207a3fb79b0c89d7db4d24817ca01a947616ffafdde9f47f1f4931",
+    "x86_64-unknown-freebsd": "aba544031f8e146086a0ea5628382bcf19c9f6a3311cbb6586fa8661ca5da914",
+    "x86_64-unknown-netbsd": "483a0b272e080f596709812eb55cbe983332cf3f40ae3fa15ed7e0179df21636"
   }
 }

data/lib/rocksky/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rocksky
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

data/lib/rocksky.rb

@@ -27,6 +27,9 @@ module Rocksky
       "char* rocksky_top_tracks(const char*, unsigned int, unsigned int)",
       "char* rocksky_global_stats(const char*)",
       "char* rocksky_get(const char*, const char*, const char*, const char*)",
+      "char* rocksky_update_seen(const char*, const char*, const char*)",
+      "char* rocksky_library_get(const char*, const char*, const char*, const char*)",
+      "char* rocksky_library_post(const char*, const char*, const char*, const char*)",
       "char* rocksky_match_song(const char*, const char*, const char*, const char*, const char*)",
       "char* rocksky_top_tracks_interval(const char*, unsigned int, unsigned int, const char*, unsigned int, const char*, const char*)",
       "char* rocksky_top_artists_interval(const char*, unsigned int, unsigned int, const char*, unsigned int, const char*, const char*)",
@@ -42,6 +45,8 @@ module Rocksky
       "char* rocksky_agent_like(void*, const char*, const char*)",
       "char* rocksky_agent_follow(void*, const char*)",
       "char* rocksky_agent_shout(void*, const char*, const char*, const char*)",
+      "char* rocksky_agent_shout_with_gif(void*, const char*, const char*, const char*, const char*)",
+      "char* rocksky_agent_reply_shout_with_gif(void*, const char*, const char*, const char*, const char*, const char*, const char*)",
       "char* rocksky_agent_refresh_session(void*)"
     ].each { |sig| extern sig }
   end
@@ -100,6 +105,30 @@ module Rocksky
     unwrap(C.rocksky_get(base.to_s, nsid, JSON.generate(params), token.to_s))
   end
 
+  # ---- notifications (auth-gated; +token+ required) ----
+
+  # The authenticated viewer's unread-notification count. Returns
+  # { "count" => Integer }.
+  def self.unread_count(token:, base: nil)
+    get("app.rocksky.notification.getUnreadCount", {}, base: base, token: token)
+  end
+
+  # The authenticated viewer's notifications, most recent first. +limit+ defaults
+  # to 30 server-side; +cursor+ paginates. Returns
+  # { "notifications" => [...], "unreadCount" => Integer, "cursor" => String? }.
+  def self.notifications(token:, limit: nil, cursor: nil, base: nil)
+    params = {}
+    params[:limit] = limit unless limit.nil?
+    params[:cursor] = cursor unless cursor.nil?
+    get("app.rocksky.notification.listNotifications", params, base: base, token: token)
+  end
+
+  # Mark notifications as viewed. +ids+ is an array of notification ids, or an
+  # empty array to mark *all* as viewed. Returns { "unreadCount" => Integer }.
+  def self.update_seen(token:, ids: [], base: nil)
+    unwrap(C.rocksky_update_seen(base.to_s, token.to_s, JSON.generate(ids)))
+  end
+
   # Resolve full canonical metadata for a bare title + artist (matchSong).
   def self.match_song(title, artist, mb_id: nil, isrc: nil, base: nil)
     unwrap(C.rocksky_match_song(base.to_s, title, artist, mb_id.to_s, isrc.to_s))
@@ -198,6 +227,24 @@ module Rocksky
       Rocksky.unwrap(C.rocksky_agent_shout(@ptr, subject_uri, subject_cid, message))
     end
 
+    # Post a shout with an optional GIF/sticker/clip attachment. Pass at least
+    # one of +message+ / +gif+. +gif+ is a Hash with camelCase keys ("url"
+    # required, plus "previewUrl", "alt", "width", "height").
+    def shout_with_gif(subject_uri, subject_cid, message: nil, gif: nil)
+      Rocksky.unwrap(C.rocksky_agent_shout_with_gif(
+                       @ptr, subject_uri, subject_cid, message.to_s, gif ? JSON.generate(gif) : ""
+                     ))
+    end
+
+    # Reply to a shout with an optional GIF/sticker/clip attachment. Semantics
+    # match #shout_with_gif, plus a parent strong-ref (+parent_uri+/+parent_cid+).
+    def reply_shout_with_gif(subject_uri, subject_cid, parent_uri, parent_cid, message: nil, gif: nil)
+      Rocksky.unwrap(C.rocksky_agent_reply_shout_with_gif(
+                       @ptr, subject_uri, subject_cid, parent_uri, parent_cid,
+                       message.to_s, gif ? JSON.generate(gif) : ""
+                     ))
+    end
+
     def refresh_session
       Rocksky.unwrap(C.rocksky_agent_refresh_session(@ptr))
     end
@@ -210,4 +257,15 @@ module Rocksky
       @ptr = Fiddle::Pointer.new(0)
     end
   end
+
+  # Build an authenticated app.rocksky.library.* (uploaded-music) client. The
+  # token is required — every library method is auth-gated.
+  #
+  #   lib = Rocksky.library(token)
+  #   lib.get_song(song_id)
+  def self.library(token, base: nil)
+    Library.new(token, base: base)
+  end
 end
+
+require_relative "rocksky/library"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rocksky
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rocksky
@@ -80,6 +80,7 @@ files:
 - README.md
 - exe/rocksky-console
 - lib/rocksky.rb
+- lib/rocksky/library.rb
 - lib/rocksky/manifest.json
 - lib/rocksky/native.rb
 - lib/rocksky/version.rb