jarvisbot_songfinder 1.0.2 → 1.0.3

data/lib/jarvisbot_songfinder/helpers/reply_message.rb

@@ -1,30 +1,34 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
+  # contains all the messages gem might use in a single place
   module ReplyMessage
+    # :nodoc:
     module Request
       def self.usage
         "Usage: '!sr $url'"
       end
-      
+
       def self.queue_closed
         "Song queue is closed. Please wait until Dan opens it."
       end
-      
+
       def self.submitted_successfully(request)
         "Your request: #{request} successfully submitted"
       end
-      
+
       def self.already_requested(request)
         "#{request} already exists in the queue"
       end
-      
+
       def self.user_already_requested(request)
         "You already have #{request} in the queue, use '!replace url/search term' to replace"
       end
-      
+
       def self.invalid_url(request)
         "#{request} is invalid"
       end
-      
+
       def self.too_long
         "Your request is too long, please stick to videos not longer than 10 minutes"
       end
@@ -32,74 +36,77 @@ module JarvisbotSongfinder
       def self.too_short
         "Your request is too short, troll requests or gnoming will not fly here"
       end
-      
+
       def self.invalid_category
         "Your request is not in Music category"
       end
-      
+
       def self.replaced_successfully(request)
         "Your previous request was replaced with #{request}"
       end
-      
+
       def self.nothing_to_replace
         "Nothing to replace. Use '!sr url/search term' to request something"
       end
-      
+
       def self.nothing_to_remove
         "Nothing to remove. Use '!sr url/search term' to request something"
       end
-      
+
       def self.removed_successfully
         "Your request removed from the queue successfully"
       end
-      
+
       def self.region_restricted
         "This video is not availible in the US"
       end
-      
+
       def self.invalid_video_id
         "Invalid video ID"
       end
-      
+
       def self.promoted_successfully(request)
         "Request: #{request} was promoted successfully"
       end
-      
+
       def self.promoted_unsuccessfully
         "Cannot promote"
       end
-      
+
       def self.demoted_successfully(request)
         "Request: #{request} was demoted successfully"
       end
-      
+
       def self.demoted_unsuccessfully
         "Cannot demote"
       end
-      
+
       def self.unknown_provider
-        "Unknown provider. Available providers: #{JarvisbotSongfinder::Provider.available_providers}"
+        "Unknown provider. Available providers: " +
+          JarvisbotSongfinder::Provider.available_providers.to_s
       end
-      
+
       def self.song_banned
         "Song was banned by Dan, request something else"
       end
     end
-    
+
+    # :nodoc:
     module Song
       def self.currently_playing(song)
         "#{song} is currently playing"
       end
-      
+
       def self.not_playing
         "Nothing is currently playing"
       end
     end
-    
+
+    # :nodoc:
     module Search
       def self.not_found
         "Nothing is found, check your spelling"
       end
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/helpers/search_query.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
-  class SearchQuery  
+  # Reponsible for handling search (words) based requests
+  #   JarvisbotSongfinder::SearchQuery.new("Paramore Misery").track.length
+  #   # => 211
+  class SearchQuery
     def initialize(query)
       @query = query
       @provider = select_provider
@@ -18,4 +23,4 @@ module JarvisbotSongfinder
       provider.nil? ? UnknownSearchProvider.new : provider.from_search(@query)
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/helpers/url_query.rb

@@ -1,22 +1,26 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
+  # Responsible for handling URL based requests
+  #   UrlQuery.new("https://www.youtube.com/watch?v=QSBco8kVuZM").track.length
+  #   # => 172
   class UrlQuery
     def initialize(url)
       @url = url
       @provider = select_provider
     end
-  
+
     def track
       @provider
     end
-  
+
     private
-  
+
     def select_provider
-      # TODO: redo with .find instead of .select
-      provider = Provider.available_providers.find do |p| 
+      provider = Provider.available_providers.find do |p|
         p::URL_REGEX.match @url
       end
       provider.nil? ? UnknownProvider.new : provider.new(@url)
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/providers/bandrequest.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
+  # Pseudo-provider for internal use, pretty much a remnant of the past
+  # i'm too lazy to extract into my rails app
   class Bandrequest < Provider
     def initialize(band)
       super()
@@ -33,4 +37,4 @@ module JarvisbotSongfinder
       true
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/providers/provider.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
+  # Abstract class for concrete providers to inherit from (Template Method Pattern)
   class Provider
     @available_providers ||= []
     class << self
@@ -27,7 +30,8 @@ module JarvisbotSongfinder
     end
 
     def valid?
-      return false if @errors.any? 
+      return false if @errors.any?
+
       available_in_region? && length_valid? && in_music_category?
     end
 
@@ -38,7 +42,7 @@ module JarvisbotSongfinder
     def explicit?
       raise NotImplementedError
     end
-    
+
     private
 
     def add_error(error)
@@ -75,4 +79,4 @@ module JarvisbotSongfinder
       raise NotImplementedError
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/providers/spotify_api.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
   class SpotifyAPI < Provider
     Provider.available_providers << self
-    ID_REGEX = /\Ahttps?:\/\/(?:embed\.|open\.)(?:spotify\.com\/)(?:track\/|\?uri=spotify:track:)((\w|-){22})/
-    URL_REGEX = /spotify\.com/
+    ID_REGEX = %r{\Ahttps?:\/\/(?:embed\.|open\.)(?:spotify\.com\/)(?:track\/|\?uri=spotify:track:)((\w|-){22})}.freeze
+    URL_REGEX = %r{spotify\.com/}.freeze
 
     def initialize(url)
       super()
@@ -12,23 +14,23 @@ module JarvisbotSongfinder
     end
 
     def self.from_search(query)
-      results = RSpotify::Track.search(query)
+      results = RSpotify::Track.search(query, market: JarvisbotSongfinder.configuration.region)
       if results.any?
         link = "https://open.spotify.com/track/#{results.first.id}"
-        return self.new(link)
+        return new(link)
       else
         return nil
       end
     end
-    
+
     def length
       @track.duration_ms / 1000
     end
-    
+
     def title
       @track.name
     end
-    
+
     def artist
       @track.artists.first.name
     end
@@ -44,44 +46,42 @@ module JarvisbotSongfinder
     def explicit?
       @track.explicit
     end
-    
-    private 
+
+    private
 
     # :nocov:
     def get_track_id(url)
       if !ID_REGEX.match(url)
         add_error ReplyMessage::Request.invalid_video_id
-        return nil
+        nil
       else
         ID_REGEX.match(url)[1]
       end
     end
-    
+
     def check_id_validity
-      begin
-        @track = RSpotify::Track.find(@track_id)
-      rescue RestClient::BadRequest => e
-        add_error ReplyMessage::Request.invalid_video_id
-      end
+      @track = RSpotify::Track.find(@track_id, market: JarvisbotSongfinder.configuration.region)
+    rescue RestClient::BadRequest
+      add_error ReplyMessage::Request.invalid_video_id
     end
     # :nocov:
-    
-    def in_music_category? 
+
+    def in_music_category?
       true
     end
-    
+
     def not_too_long?
       if length < 600
-        return true
+        true
       else
         add_error ReplyMessage::Request.too_long
-        return false
+        false
       end
     end
-    
+
     def available_in_region?
       return true if @track.available_markets.empty?
-      
+
       if @track.available_markets.include? JarvisbotSongfinder.configuration.region
         return true
       else
@@ -89,5 +89,5 @@ module JarvisbotSongfinder
         return false
       end
     end
-  end  
-end
+  end
+end

data/lib/jarvisbot_songfinder/providers/unknown_provider.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
+  # NullObject for handling cases where none of the providers matched request
+  # with their URL_REGEX
   class UnknownProvider
     attr_reader :errors
 

data/lib/jarvisbot_songfinder/providers/unknown_search_provider.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
+  # NullObject for handling cases where searching any other provider did not
+  # found anything
   class UnknownSearchProvider
     attr_reader :errors
 
@@ -10,4 +14,4 @@ module JarvisbotSongfinder
       false
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/providers/youtube_api.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
   class YoutubeAPI < Provider
     Provider.available_providers << self
-    ID_REGEX = /\A((?:https?:)?\/\/)?((?:www|m)\.)?((?:youtube\.com|youtu\.be))(\/(?:[\w\-]+\?v=|embed\/|v\/)?)([\w\-]+)(\S+)?/
-    URL_REGEX = /youtube\.com|youtu\.be/
-    
+    ID_REGEX = /\A((?:https?:)?\/\/)?((?:www|m)\.)?((?:youtube\.com|youtu\.be))(\/(?:[\w\-]+\?v=|embed\/|v\/)?)([\w\-]+)(\S+)?/.freeze
+    URL_REGEX = /youtube\.com|youtu\.be/.freeze
+
     def initialize(url)
       super()
       @track_id = get_track_id(url)
@@ -14,19 +16,19 @@ module JarvisbotSongfinder
 
     def self.from_search(query)
       videos = Yt::Collections::Videos.new
-      params = {q: query, order: "relevance", video_category_id: 10}
+      params = { q: query, order: "relevance", video_category_id: 10 }
       if track_id = videos.where(params)&.first&.id
         link = "https://www.youtube.com/watch?v=#{track_id}"
-        return self.new(link)
+        return new(link)
       else
         return nil
       end
     end
-    
+
     def title
       @track.title
     end
-    
+
     def length
       @track.duration
     end
@@ -47,91 +49,89 @@ module JarvisbotSongfinder
       # no way to know
       false
     end
-    
+
     private
 
     # :nocov:
     def get_track_id(url)
       if !ID_REGEX.match(url)
         add_error ReplyMessage::Request.invalid_video_id
-        return nil
+        nil
       else
         ID_REGEX.match(url)[5]
       end
     end
-    
+
     def check_id_validity
-      begin
-        @track.empty?
-      rescue Yt::Errors::NoItems => e
-        add_error ReplyMessage::Request.invalid_video_id
-      end
+      @track.empty?
+    rescue Yt::Errors::NoItems => e
+      add_error ReplyMessage::Request.invalid_video_id
     end
-    
+
     def not_too_long?
       if @track.duration < 600
-        return true
+        true
       else
         add_error ReplyMessage::Request.too_long
-        return false
+        false
       end
     end
-    
+
     def in_music_category?
       if @track.category_id == "10"
-        return true
-      else 
+        true
+      else
         add_error ReplyMessage::Request.invalid_category
-        return false
+        false
       end
     end
-    
+
     def available_in_region?
       # TODO: refactor this into proper methods, this can be a guard clause
       if listed?
         if allowed_list_exists?
           if in_allowed_list?
-            return true
+            true
           else
             add_error ReplyMessage::Request.region_restricted
-            return false
+            false
           end
         else
           if in_blocked_list?
             add_error ReplyMessage::Request.region_restricted
-            return false
+            false
           else
-            return true
+            true
           end
         end
       else
-        return true
+        true
       end
     end
-    
+
     def listed?
       !!@track.content_detail.data&.dig('regionRestriction')
     end
-    
+
     def allowed_list_exists?
       !!@track.content_detail.data&.dig('regionRestriction', 'allowed')
     end
-    
+
     def in_allowed_list?
       if allowed_list = @track.content_detail.data&.dig('regionRestriction', 'allowed')
         allowed_list.include?(JarvisbotSongfinder.configuration.region)
       else
-        return false
+        false
       end
     end
-    
+
     def in_blocked_list?
       if blocked_list = @track.content_detail.data&.dig('regionRestriction', 'blocked')
         blocked_list.include?(JarvisbotSongfinder.configuration.region)
       else
-        return false
+        false
       end
     end
   end
   # :nocov:
-end
+end

data/lib/jarvisbot_songfinder/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JarvisbotSongfinder
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/lib/jarvisbot_songfinder.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# :nodoc:
 module JarvisbotSongfinder
   require "jarvisbot_songfinder/version"
   require "jarvisbot_songfinder/configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jarvisbot_songfinder
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Nick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-06 00:00:00.000000000 Z
+date: 2019-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.16'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -123,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: yt
+  name: rspotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
-  name: rspotify
+  name: yt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 0.29.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 0.29.1
 description: Gem jarvissongbot uses to take user input and transform it into queryable
   music track found on enabled providers (youtube, spotify), validating it afterwards
 email:
@@ -179,19 +179,17 @@ files:
 - fixtures/vcr_cassettes/spotify_invalid_region_restricted.yml
 - fixtures/vcr_cassettes/spotify_invalid_search.yml
 - fixtures/vcr_cassettes/spotify_invalid_too_long.yml
+- fixtures/vcr_cassettes/spotify_invalid_url_relinked.yml
 - fixtures/vcr_cassettes/spotify_valid.yml
 - fixtures/vcr_cassettes/spotify_valid_clean_or_unknown.yml
 - fixtures/vcr_cassettes/spotify_valid_explicit.yml
 - fixtures/vcr_cassettes/spotify_valid_search.yml
-- fixtures/vcr_cassettes/spotify_vcr_test.yml
 - fixtures/vcr_cassettes/url_query_known_provider.yml
 - fixtures/vcr_cassettes/youtube_invalid.yml
 - fixtures/vcr_cassettes/youtube_invalid_region_restricted.yml
-- fixtures/vcr_cassettes/youtube_invalid_regionrestricted.yml
 - fixtures/vcr_cassettes/youtube_invalid_search.yml
 - fixtures/vcr_cassettes/youtube_invalid_too_long.yml
 - fixtures/vcr_cassettes/youtube_invalid_wrong_category.yml
-- fixtures/vcr_cassettes/youtube_invalid_wrongcategory.yml
 - fixtures/vcr_cassettes/youtube_valid.yml
 - fixtures/vcr_cassettes/youtube_valid_search.yml
 - jarvisbot_songfinder.gemspec
@@ -230,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Take user input and return music track