jarvisbot_songfinder 1.0.0 → 1.1.2

data/lib/jarvisbot_songfinder/helpers/url_query.rb

@@ -1,22 +1,27 @@
+# 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)
+    def initialize(url, config: JarvisbotSongfinder.configuration)
+      @config = config
       @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)
+      provider.nil? ? UnknownProvider.new : provider.new(@url, config: @config)
     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
@@ -6,7 +9,8 @@ module JarvisbotSongfinder
     end
 
     attr_reader :errors
-    def initialize
+    def initialize(config: JarvisbotSongfinder.configuration)
+      @config = config
       @errors = []
     end
 
@@ -27,8 +31,9 @@ module JarvisbotSongfinder
     end
 
     def valid?
-      return false if @errors.any? 
-      available_in_region? && not_too_long? && in_music_category?
+      return false if @errors.any?
+
+      available_in_region? && length_valid? && in_music_category?
     end
 
     def url
@@ -38,7 +43,7 @@ module JarvisbotSongfinder
     def explicit?
       raise NotImplementedError
     end
-    
+
     private
 
     def add_error(error)
@@ -49,8 +54,22 @@ module JarvisbotSongfinder
       raise NotImplementedError
     end
 
+    def length_valid?
+      not_too_long? && not_too_short?
+    end
+
     def not_too_long?
-      length < 600
+      unless length < @config.length_max
+        add_error(JarvisbotSongfinder::ReplyMessage::Request.too_long)
+      end
+      length < @config.length_max
+    end
+
+    def not_too_short?
+      unless length > @config.length_min
+        add_error(JarvisbotSongfinder::ReplyMessage::Request.too_short)
+      end
+      length > @config.length_min
     end
 
     def in_music_category?
@@ -61,4 +80,4 @@ module JarvisbotSongfinder
       raise NotImplementedError
     end
   end
-end
+end

data/lib/jarvisbot_songfinder/providers/spotify_api.rb

@@ -1,34 +1,38 @@
+# 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)
+    def initialize(url, config: JarvisbotSongfinder.configuration)
       super()
+      @config = config
       @track_id = get_track_id(url)
       check_id_validity
       valid? unless @errors.any?
     end
 
-    def self.from_search(query)
-      results = RSpotify::Track.search(query)
+    def self.from_search(query, config: JarvisbotSongfinder.configuration)
+      @config = config
+      results = RSpotify::Track.search(query, market: @config.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,50 +48,39 @@ 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: @config.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
-      else
-        add_error ReplyMessage::Request.too_long
-        return false
-      end
-    end
-    
+
     def available_in_region?
       return true if @track.available_markets.empty?
-      
-      if @track.available_markets.include? JarvisbotSongfinder.configuration.region
+
+      if @track.available_markets.include? @config.region
         return true
       else
-        add_error ReplyMessage::Request.region_restricted
+        add_error ReplyMessage::Request.region_restricted(@config.region)
         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,32 +1,36 @@
+# 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/
-    
-    def initialize(url)
+    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, config: JarvisbotSongfinder.configuration)
       super()
+      @config = config
       @track_id = get_track_id(url)
       @track = Yt::Video.new(id: @track_id) # unless @track_id.nil?
       check_id_validity
       valid? unless @errors.any?
     end
 
-    def self.from_search(query)
+    def self.from_search(query, config: JarvisbotSongfinder.configuration)
+      @config = config
       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 +51,60 @@ 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
-    end
-    
-    def not_too_long?
-      if @track.duration < 600
-        return true
-      else
-        add_error ReplyMessage::Request.too_long
-        return false
-      end
+      @track.empty?
+    rescue Yt::Errors::NoItems => e
+      add_error ReplyMessage::Request.invalid_video_id
     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
-          else
-            add_error ReplyMessage::Request.region_restricted
-            return false
-          end
-        else
-          if in_blocked_list?
-            add_error ReplyMessage::Request.region_restricted
-            return false
-          else
-            return true
-          end
-        end
-      else
-        return true
-      end
+      return true if !listed? || in_allowed_list? || !in_blocked_list?
+      add_error ReplyMessage::Request.region_restricted(@region)
+      return false
     end
-    
+
     def listed?
-      !!@track.content_detail.data&.dig('regionRestriction')
-    end
-    
-    def allowed_list_exists?
-      !!@track.content_detail.data&.dig('regionRestriction', 'allowed')
+      @track.content_detail.data&.dig('regionRestriction')
     end
-    
+
     def in_allowed_list?
       if allowed_list = @track.content_detail.data&.dig('regionRestriction', 'allowed')
-        allowed_list.include?(JarvisbotSongfinder.configuration.region)
+        allowed_list.include?(@config.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)
+        blocked_list.include?(@config.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.0"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jarvisbot_songfinder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Nick
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2019-09-07 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:
@@ -168,6 +168,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
+- fixtures/vcr_cassettes/query_customconfig.yml
+- fixtures/vcr_cassettes/query_customconfig_short_track.yml
 - fixtures/vcr_cassettes/query_text.yml
 - fixtures/vcr_cassettes/query_track_delegation.yml
 - fixtures/vcr_cassettes/query_youtube_url.yml
@@ -178,19 +181,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
@@ -213,7 +214,7 @@ licenses:
 metadata:
   homepage_uri: https://gitlab.com/DoubleJarvis/jarvisbot_songfinder
   source_code_uri: https://gitlab.com/DoubleJarvis/jarvisbot_songfinder
-  changelog_uri: https://gitlab.com/DoubleJarvis/jarvisbot_songfinder/changelog.md
+  changelog_uri: https://gitlab.com/DoubleJarvis/jarvisbot_songfinder/blob/master/changelog.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -229,8 +230,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.4
 signing_key: 
 specification_version: 4
 summary: Take user input and return music track