songstats-api 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d8df26fc2d79b94ae28d7c834c6d6d05faf8b48e7eeca5b66fb0c0c3916cab6
-  data.tar.gz: 0db44faaaea2e1738aaf0bb31a0c498ec840e2d9dca342aecc540807803f28ff
+  metadata.gz: abef0db83768f11fbe5b7b4065be17b37314ba7ae09838218fb679e1ed6ce609
+  data.tar.gz: e727fe9aa96d85f7cbeca6340453f931c214c3654b0ced5be3ce378f29e4017b
 SHA512:
-  metadata.gz: 23ffaa30f77ef53d95556ce21a7f702f1c225c7d91b9a1dd217d2956b6a9efcf387bde7550ec3ba263605820c04c8081be63421686f36edd6176c367465cc9eb
-  data.tar.gz: 6613a579154f5b7e718909a0f417884619cd159dd6073644960056bcf0c522f89e31c45fed0c51a5c4c53f9b9604af344041868c7ee5b583b60a260c1c7fd83d
+  metadata.gz: '0058d84c8f6b1af15782760e7d97ecf9e2afbc58735c07c4950902d51abbb470056068016b7a9ec6edf2338635af3eebe150599ae7ece7c7b245d01db365df16'
+  data.tar.gz: 0a8e2720669bd876f5b5572146aef63d9a9e041fbc04e77b4875b09b095aa38502992da63611bec54eaf00e1762cab1cfa3a0786988771d9d7bde329c6da9af2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    songstats-api (1.1.0)
+    songstats-api (1.3.0)
       httparty
 
 GEM

data/README.md

@@ -24,7 +24,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use this gem ensure that `SONGSTATS_API_KEY` is set as an env variarble.
+
+This is a wrapper around Song Stats API - [you can find their docs here](https://docs.songstats.com/docs/api/e80265bb8b01b-songstats-api).
+
+
+### Artist
+```ruby
+    artist = Songstats::Api::Artist.new
+    artist.search "elton john", {"limit": "1"}
+    artist.info "22wbnEMDvgVIAGdFeek6ET"
+```
+
+### Track
+```ruby
+    track = Songstats::Api::Track.new
+    track.search "rocket man", {"limit": "1"}
+    track.info "12341234"
+```
 
 ## Development
 

data/lib/songstats/api/artist.rb

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
-require "singleton"
-
 module Songstats
   module Api
     # Artist class for the Songstats API
     class Artist < Base
-      include Singleton
-
       def initialize
         super
         @type = "artist"
@@ -77,6 +73,24 @@ module Songstats
         # https://docs.songstats.com/docs/api/dc58c858fdbb6-delete-artist-link
         delete path(id, "/artists/link_request", link: link)
       end
+
+      def add_track(id, track_id)
+        # https://docs.songstats.com/docs/api/aux8fvg3g9sv7-add-artist-track
+        options = {}
+        options[:isrc] = track_id if track_id.size == ISRC_LENGTH
+        options[:spotify_track_id] = track_id if track_id.size > ISRC_LENGTH && !url?(track_id)
+        options[:link] = track_id if url? track_id
+        post path(id, "/artists/track_request", options)
+      end
+
+      def delete_track(id, track_id)
+        # https://docs.songstats.com/docs/api/sijd2vkvgwpdj-remove-artist-track
+        options = {}
+        options[:isrc] = track_id if track_id.size == ISRC_LENGTH
+        options[:songstats_track_id] = track_id if track_id.size == SONG_STATS_ID_LENGTH
+        options[:spotify_track_id] = track_id if track_id.size > ISRC_LENGTH
+        delete path(id, "/artists/track_request", options)
+      end
     end
   end
 end

data/lib/songstats/api/base.rb

@@ -21,6 +21,11 @@ module Songstats
 
       private
 
+      def url?(str)
+        url_regex = /\A#{URI::DEFAULT_PARSER.make_regexp(%w[http https])}\z/
+        str =~ url_regex ? true : false
+      end
+
       def query_string(id)
         return "isrc=#{id}" if id.size == ISRC_LENGTH
 

data/lib/songstats/api/label.rb

@@ -4,8 +4,6 @@ module Songstats
   module Api
     # Label class for the Songstats API
     class Label < Base
-      include Singleton
-
       # override because the label id is either songstats_label_id or beatport_label_id
       def query_string(id)
         return "songstats_label_id=#{id}" if id.size == SONG_STATS_ID_LENGTH
@@ -80,6 +78,24 @@ module Songstats
         # https://docs.songstats.com/docs/api/f684183faa3b9-delete-label-link
         delete path(id, "/labels/link_request", link: link)
       end
+
+      def add_track(id, track_id)
+        # https://docs.songstats.com/docs/api/sf9lrzr189m48-add-label-track
+        options = {}
+        options[:isrc] = track_id if track_id.size == ISRC_LENGTH
+        options[:spotify_track_id] = track_id if track_id.size > ISRC_LENGTH && !url?(track_id)
+        options[:link] = track_id if url? track_id
+        post path(id, "/labels/track_request", options)
+      end
+
+      def delete_track(id, track_id)
+        # https://docs.songstats.com/docs/api/l0xhrjijnktgf-remove-label-link
+        options = {}
+        options[:isrc] = track_id if track_id.size == ISRC_LENGTH
+        options[:songstats_track_id] = track_id if track_id.size == SONG_STATS_ID_LENGTH
+        options[:spotify_track_id] = track_id if track_id.size > ISRC_LENGTH
+        delete path(id, "/labels/track_request", options)
+      end
     end
   end
 end

data/lib/songstats/api/track.rb

@@ -4,8 +4,6 @@ module Songstats
   module Api
     # Track class for the Songstats API
     class Track < Base
-      include Singleton
-
       def initialize
         super
         @type = "track"

data/lib/songstats/api/version.rb

@@ -2,6 +2,6 @@
 
 module Songstats
   module Api
-    VERSION = "1.1.0"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: songstats-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daryl Findlay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty