songstats-api 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d8df26fc2d79b94ae28d7c834c6d6d05faf8b48e7eeca5b66fb0c0c3916cab6
-  data.tar.gz: 0db44faaaea2e1738aaf0bb31a0c498ec840e2d9dca342aecc540807803f28ff
+  metadata.gz: 9a6d73f1bc7dae4d2a9f13b8b9a6e79ffc1d7eae7f439bc6cc11b11d83f74a20
+  data.tar.gz: a1e58fb1fece05588a000aa3127a76107a361ef889d375b8fe99998683984c46
 SHA512:
-  metadata.gz: 23ffaa30f77ef53d95556ce21a7f702f1c225c7d91b9a1dd217d2956b6a9efcf387bde7550ec3ba263605820c04c8081be63421686f36edd6176c367465cc9eb
-  data.tar.gz: 6613a579154f5b7e718909a0f417884619cd159dd6073644960056bcf0c522f89e31c45fed0c51a5c4c53f9b9604af344041868c7ee5b583b60a260c1c7fd83d
+  metadata.gz: 8ce059265973ec4d7f7d2e9f0848a3f2495a6e9285012d8328df0daee47741ef5d1a9e49ab73c592cb4cc8056ae19900d4fd658f3f9eede8afe4b471eb58d42c
+  data.tar.gz: 687bf1a1f80075abd4b1f23425160d6ec42530a56c3504c8af09bebc5ba04c918969b52180e2dfb215f77532a4640ef5120e161afed27fcbd3a1a09d20f1c637

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    songstats-api (1.1.0)
+    songstats-api (1.2.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"

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

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.2.0"
   end
 end

metadata

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