jarvisbot_songfinder 1.0.0

data/lib/jarvisbot_songfinder/helpers/search_query.rb

@@ -0,0 +1,21 @@
+module JarvisbotSongfinder
+  class SearchQuery  
+    def initialize(query)
+      @query = query
+      @provider = select_provider
+    end
+
+    def track
+      @provider
+    end
+
+    private
+
+    def select_provider
+      provider = Provider.available_providers.find do |p|
+        p.from_search @query
+      end
+      provider.nil? ? UnknownSearchProvider.new : provider.from_search(@query)
+    end
+  end
+end

data/lib/jarvisbot_songfinder/helpers/url_query.rb

@@ -0,0 +1,22 @@
+module JarvisbotSongfinder
+  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| 
+        p::URL_REGEX.match @url
+      end
+      provider.nil? ? UnknownProvider.new : provider.new(@url)
+    end
+  end
+end

data/lib/jarvisbot_songfinder/providers/bandrequest.rb

@@ -0,0 +1,36 @@
+module JarvisbotSongfinder
+  class Bandrequest < Provider
+    def initialize(band)
+      super()
+      @band = band
+    end
+
+    def length
+      0
+    end
+
+    def title
+      ""
+    end
+
+    def artist
+      @band
+    end
+
+    def provider
+      "bandrequest"
+    end
+
+    def url
+      "https://www.last.fm/search?q=#{@band}"
+    end
+
+    def explicit?
+      false
+    end
+
+    def valid?
+      true
+    end
+  end
+end

data/lib/jarvisbot_songfinder/providers/provider.rb

@@ -0,0 +1,64 @@
+module JarvisbotSongfinder
+  class Provider
+    @available_providers ||= []
+    class << self
+      attr_accessor :available_providers
+    end
+
+    attr_reader :errors
+    def initialize
+      @errors = []
+    end
+
+    def length
+      raise NotImplementedError
+    end
+
+    def title
+      raise NotImplementedError
+    end
+
+    def artist
+      raise NotImplementedError
+    end
+
+    def provider
+      raise NotImplementedError
+    end
+
+    def valid?
+      return false if @errors.any? 
+      available_in_region? && not_too_long? && in_music_category?
+    end
+
+    def url
+      raise NotImplementedError
+    end
+
+    def explicit?
+      raise NotImplementedError
+    end
+    
+    private
+
+    def add_error(error)
+      @errors << error unless @errors.include? error
+    end
+
+    def available_in_region?
+      raise NotImplementedError
+    end
+
+    def not_too_long?
+      length < 600
+    end
+
+    def in_music_category?
+      raise NotImplementedError
+    end
+
+    def get_track
+      raise NotImplementedError
+    end
+  end
+end

data/lib/jarvisbot_songfinder/providers/spotify_api.rb

@@ -0,0 +1,93 @@
+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/
+
+    def initialize(url)
+      super()
+      @track_id = get_track_id(url)
+      check_id_validity
+      valid? unless @errors.any?
+    end
+
+    def self.from_search(query)
+      results = RSpotify::Track.search(query)
+      if results.any?
+        link = "https://open.spotify.com/track/#{results.first.id}"
+        return self.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
+
+    def url
+      "https://open.spotify.com/track/#{@track.id}"
+    end
+
+    def provider
+      "spotify"
+    end
+
+    def explicit?
+      @track.explicit
+    end
+    
+    private 
+
+    # :nocov:
+    def get_track_id(url)
+      if !ID_REGEX.match(url)
+        add_error ReplyMessage::Request.invalid_video_id
+        return 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
+    end
+    # :nocov:
+    
+    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
+        return true
+      else
+        add_error ReplyMessage::Request.region_restricted
+        return false
+      end
+    end
+  end  
+end

data/lib/jarvisbot_songfinder/providers/unknown_provider.rb

@@ -0,0 +1,13 @@
+module JarvisbotSongfinder
+  class UnknownProvider
+    attr_reader :errors
+
+    def initialize
+      @errors = [ReplyMessage::Request.unknown_provider]
+    end
+
+    def valid?
+      false
+    end
+  end
+end

data/lib/jarvisbot_songfinder/providers/unknown_search_provider.rb

@@ -0,0 +1,13 @@
+module JarvisbotSongfinder
+  class UnknownSearchProvider
+    attr_reader :errors
+
+    def initialize
+      @errors = [ReplyMessage::Search.not_found]
+    end
+
+    def valid?
+      false
+    end
+  end
+end

data/lib/jarvisbot_songfinder/providers/youtube_api.rb

@@ -0,0 +1,137 @@
+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)
+      super()
+      @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)
+      videos = Yt::Collections::Videos.new
+      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)
+      else
+        return nil
+      end
+    end
+    
+    def title
+      @track.title
+    end
+    
+    def length
+      @track.duration
+    end
+
+    def artist
+      @track.channel_title
+    end
+
+    def url
+      "https://www.youtube.com/watch?v=#{@track_id}"
+    end
+
+    def provider
+      "youtube"
+    end
+
+    def explicit?
+      # 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
+      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
+    end
+    
+    def in_music_category?
+      if @track.category_id == "10"
+        return true
+      else 
+        add_error ReplyMessage::Request.invalid_category
+        return 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
+    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
+      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
+      end
+    end
+  end
+  # :nocov:
+end

data/lib/jarvisbot_songfinder/version.rb

@@ -0,0 +1,3 @@
+module JarvisbotSongfinder
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: jarvisbot_songfinder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    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: webmock
+  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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: yt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: rspotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+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:
+- doublejarvis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fixtures/vcr_cassettes/query_text.yml
+- fixtures/vcr_cassettes/query_track_delegation.yml
+- fixtures/vcr_cassettes/query_youtube_url.yml
+- fixtures/vcr_cassettes/search_query_auxiliary_provider.yml
+- fixtures/vcr_cassettes/search_query_not_found.yml
+- fixtures/vcr_cassettes/search_query_preferred_and_auxiliary.yml
+- fixtures/vcr_cassettes/search_query_preferred_provider.yml
+- 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_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
+- lib/jarvisbot_songfinder.rb
+- lib/jarvisbot_songfinder/configuration.rb
+- lib/jarvisbot_songfinder/helpers/query.rb
+- lib/jarvisbot_songfinder/helpers/reply_message.rb
+- lib/jarvisbot_songfinder/helpers/search_query.rb
+- lib/jarvisbot_songfinder/helpers/url_query.rb
+- lib/jarvisbot_songfinder/providers/bandrequest.rb
+- lib/jarvisbot_songfinder/providers/provider.rb
+- lib/jarvisbot_songfinder/providers/spotify_api.rb
+- lib/jarvisbot_songfinder/providers/unknown_provider.rb
+- lib/jarvisbot_songfinder/providers/unknown_search_provider.rb
+- lib/jarvisbot_songfinder/providers/youtube_api.rb
+- lib/jarvisbot_songfinder/version.rb
+homepage: https://gitlab.com/DoubleJarvis/jarvisbot_songfinder
+licenses:
+- MIT
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Take user input and return music track
+test_files: []