songstats-api 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a6d73f1bc7dae4d2a9f13b8b9a6e79ffc1d7eae7f439bc6cc11b11d83f74a20
-  data.tar.gz: a1e58fb1fece05588a000aa3127a76107a361ef889d375b8fe99998683984c46
+  metadata.gz: 4435e46748e62f3669e038f19ea0f03205f601de6bec3563b0a5ec909843151b
+  data.tar.gz: 258b58b810715353304066ac1ab2b6d34946eed0d2571d81ebd27d77d2ff540a
 SHA512:
-  metadata.gz: 8ce059265973ec4d7f7d2e9f0848a3f2495a6e9285012d8328df0daee47741ef5d1a9e49ab73c592cb4cc8056ae19900d4fd658f3f9eede8afe4b471eb58d42c
-  data.tar.gz: 687bf1a1f80075abd4b1f23425160d6ec42530a56c3504c8af09bebc5ba04c918969b52180e2dfb215f77532a4640ef5120e161afed27fcbd3a1a09d20f1c637
+  metadata.gz: 457df44f7cdc558acc43684787b70034c1f90576e8e0c1471a69b1f1b1f6b6b7e43cb5527d17c67a42a5db9ba09817bdb7937bad544343b3c0bf3bf421c3535d
+  data.tar.gz: 676eabfa8b92ba961877b68a1a9bbca39c10314cd721681215b7b84eab4f3a7abe25d2e756ca2c89c02a5b44f1caa85cfc38cb2faf0cd54d1dcc30cd1e780783

data/.env.example

@@ -1 +1,2 @@
 SONGSTATS_API_KEY=
+SONGSTATS_CHARTS_API_KEY=

data/.env.test

@@ -1 +1,2 @@
 SONGSTATS_API_KEY=test-1234-5678-9012-3456
+SONGSTATS_CHARTS_API_KEY=test-1234-5678-9012-3456

data/Gemfile.lock

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

data/README.md

@@ -26,6 +26,8 @@ Or install it yourself as:
 
 To use this gem ensure that `SONGSTATS_API_KEY` is set as an env variarble.
 
+To use `Songstats:Api::Charts` ensure `SONGSTATS_CHARTS_API_KEY` is set as an env variable. This is billed differently than other endpoints so it needs its own api key.
+
 This is a wrapper around Song Stats API - [you can find their docs here](https://docs.songstats.com/docs/api/e80265bb8b01b-songstats-api).
 
 

data/lib/songstats/api/artist.rb

@@ -73,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

@@ -16,11 +16,16 @@ module Songstats
       def initialize
         @api_key = ENV.fetch "SONGSTATS_API_KEY", nil
 
-        raise "Missing SongStats API key" if @api_key.nil?
+        raise Songstats::Api::Error, "Missing SongStats API key" if @api_key.nil?
       end
 
       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
 
@@ -49,21 +54,21 @@ module Songstats
         response = self.class.get path, headers: { "apiKey" => @api_key }
         return response.parsed_response if response.success?
 
-        raise response.parsed_response
+        raise Songstats::Api::Error, response.parsed_response
       end
 
       def post(path, body)
         response = self.class.post path, body: body, headers: { "apiKey" => @api_key }
         return response.parsed_response if response.success?
 
-        raise response.parsed_response
+        raise Songstats::Api::Error, response.parsed_response
       end
 
       def delete(path)
         response = self.class.delete path, headers: { "apiKey" => @api_key }
         return response.parsed_response if response.success?
 
-        raise response.parsed_response
+        raise Songstats::Api::Error, response.parsed_response
       end
     end
   end

data/lib/songstats/api/chart.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "httparty"
+
+module Songstats
+  module Api
+    # Chart class for the Songstats API
+    class Chart < Base
+      include HTTParty
+
+      base_uri "https://api.songstats.com/enterprise/v1"
+
+      def initialize
+        @api_key = ENV.fetch "SONGSTATS_CHARTS_API_KEY", nil
+
+        raise Songstats::Api::Error, "Missing SongStats Charts API key" if @api_key.nil?
+      end
+
+      def tracks(options = {})
+        options[:source] = "all" unless options.key? :source
+        options[:country_code] = "US" unless options.key? :country_code
+
+        fetch path("/charts/tracks", options)
+      end
+
+      private
+
+      def path(path, options = {})
+        query_params = options.map { |key, value| "#{key}=#{value}" }.join("&")
+        return "#{path}?#{query_params}" unless query_params.empty?
+
+        path
+      end
+
+      def fetch(path)
+        response = self.class.get path, headers: { "apiKey" => @api_key }
+        return response.parsed_response if response.success?
+
+        raise Songstats::Api::Error, response.parsed_response
+      end
+    end
+  end
+end

data/lib/songstats/api/label.rb

@@ -78,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/version.rb

@@ -2,6 +2,6 @@
 
 module Songstats
   module Api
-    VERSION = "1.2.0"
+    VERSION = "1.4.0"
   end
 end

data/lib/songstats/api.rb

@@ -11,5 +11,6 @@ module Songstats
     autoload :Artist, "songstats/api/artist"
     autoload :Track, "songstats/api/track"
     autoload :Label, "songstats/api/label"
+    autoload :Chart, "songstats/api/chart"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: songstats-api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Daryl Findlay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -49,6 +49,7 @@ files:
 - lib/songstats/api.rb
 - lib/songstats/api/artist.rb
 - lib/songstats/api/base.rb
+- lib/songstats/api/chart.rb
 - lib/songstats/api/label.rb
 - lib/songstats/api/track.rb
 - lib/songstats/api/version.rb