songstats-api 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66741cd74c3ee019128ba6db6949579b1f53b952f3ddb4e10a50983611b9f42a
-  data.tar.gz: 908d890645fa89d1ef8cb44d79992ace241ffb8e6bb08b44ac982ef755d6c738
+  metadata.gz: 9a6d73f1bc7dae4d2a9f13b8b9a6e79ffc1d7eae7f439bc6cc11b11d83f74a20
+  data.tar.gz: a1e58fb1fece05588a000aa3127a76107a361ef889d375b8fe99998683984c46
 SHA512:
-  metadata.gz: a35f5bb1e66c5d4f5a34f639023cb91d5d04f6d78218c1a698fbab51dea0f59fd4b94d02321b7560c7c9d5575d53a6e55d8c77e75fb24ab6f837541d5405de7c
-  data.tar.gz: e8d2da614c14d5fe10a5339ced1521ea1319bef67f26f708455c2e37bf50f96c3cb44a49bc5424bf28bbdbaa10f35971cd41850e993ac39b24040edb2787eca8
+  metadata.gz: 8ce059265973ec4d7f7d2e9f0848a3f2495a6e9285012d8328df0daee47741ef5d1a9e49ab73c592cb4cc8056ae19900d4fd658f3f9eede8afe4b471eb58d42c
+  data.tar.gz: 687bf1a1f80075abd4b1f23425160d6ec42530a56c3504c8af09bebc5ba04c918969b52180e2dfb215f77532a4640ef5120e161afed27fcbd3a1a09d20f1c637

data/Gemfile.lock

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

data/README.md

@@ -1,5 +1,7 @@
 # Songstats::Api
 
+[![Ruby](https://github.com/songtradr/songstats-api/actions/workflows/main.yml/badge.svg)](https://github.com/songtradr/songstats-api/actions/workflows/main.yml)
+
 The Songstats API Gem is a lightweight tool for developers to interact with the Songstats REST API. With this gem, you can integrate Songstats' music data into your Ruby applications, making it easy to access information about tracks, artists, and more.
 
 To experiment with that code, run `bin/console` for an interactive prompt.
@@ -22,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"
@@ -62,10 +58,10 @@ module Songstats
         fetch path(id, "/artists/top_playlists", options)
       end
 
-      def search(id, query, options = {})
+      def search(query, options = {})
         # https://docs.songstats.com/docs/api/d761545339f09-search-artist
         options[:q] = query
-        fetch path(id, "/artists/search", options)
+        fetch path("", "/artists/search", options)
       end
 
       def add_link(id, link)

data/lib/songstats/api/base.rb

@@ -21,17 +21,28 @@ module Songstats
 
       private
 
+      def query_string(id)
+        return "isrc=#{id}" if id.size == ISRC_LENGTH
+
+        return "songstats_#{@type}_id=#{id}" if id.size == SONG_STATS_ID_LENGTH
+
+        return "" if id.size.zero?
+
+        "spotify_#{@type}_id=#{id}"
+      end
+
       def path(id, path, options = {})
-        path += case id.size
-                when ISRC_LENGTH
-                  "?isrc=#{id}"
-                when SONG_STATS_ID_LENGTH
-                  "?songstats_#{@type}_id=#{id}"
-                else
-                  "?spotify_#{@type}_id=#{id}"
-                end
-        options.each { |key, value| path += "&#{key}=#{value}" }
-        path
+        query_params = options.map { |key, value| "#{key}=#{value}" }.join("&")
+
+        query_string = query_string(id)
+
+        if query_string.empty?
+          "#{path}?#{query_params}"
+        else
+          return "#{path}?#{query_string}" if query_params.empty?
+
+          "#{path}?#{query_string}&#{query_params}"
+        end
       end
 
       def fetch(path)

data/lib/songstats/api/label.rb

@@ -4,13 +4,13 @@ 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 path(id, path, options = {})
-        path += id.size == SONG_STATS_ID_LENGTH ? "?songstats_label_id=#{id}" : "?beatport_label_id=#{id}"
-        options.each { |key, value| path += "&#{key}=#{value}" }
-        path
+      def query_string(id)
+        return "songstats_label_id=#{id}" if id.size == SONG_STATS_ID_LENGTH
+
+        return "" if id.size.zero?
+
+        "beatport_label_id=#{id}"
       end
 
       def info(id)
@@ -63,10 +63,10 @@ module Songstats
         fetch path(id, "/labels/top_playlists", options)
       end
 
-      def search(id, query, options = {})
+      def search(query, options = {})
         # https://docs.songstats.com/docs/api/c934a2909ba0f-search-label
         options[:q] = query
-        fetch path(id, "/labels/search", options)
+        fetch path("", "/labels/search", options)
       end
 
       def add_link(id, link)

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"
@@ -34,10 +32,10 @@ module Songstats
         fetch path(id, "/tracks/historic_stats", options)
       end
 
-      def search(id, query, options = {})
+      def search(query, options = {})
         # https://docs.songstats.com/docs/api/1f2e4f9b3b1d1-search-track
         options[:q] = query
-        fetch path(id, "/tracks/search", options)
+        fetch path("", "/tracks/search", options)
       end
 
       def add_link(id, link)

data/lib/songstats/api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: songstats-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Daryl Findlay