youtube_dlhelper 0.1.9.4

data/etc/youtube_dlhelper.conf

@@ -0,0 +1,8 @@
+# Config file for youtube_dlhelper
+# Change this variable to your Musicdir (Without /home/youruser)
+musicdir = 'Musik'
+
+# Use ogg: If you accept a ogg file you can leave this
+# setting. If you just want to have MP3s set this to false
+# default: true
+ogg_file_accept = true

data/lib/youtube_dlhelper.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# Youtube converter main class
+#
+# Copyright (C) 2013-2015  Sascha Manns <samannsml@directbox.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Dependencies
+# rubocop:disable Metrics/LineLength
+require File.expand_path(File.join(File.dirname(__FILE__), 'youtube_dlhelper/version'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'youtube_dlhelper/checker'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'youtube_dlhelper/downloader'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'youtube_dlhelper/import_config'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'youtube_dlhelper/ripper'))
+require 'highline/import'
+require 'fileutils'
+require 'parseconfig'
+require 'addressable/uri'
+require 'viddl-rb'
+require 'streamio-ffmpeg'
+require 'rainbow/ext/string'
+
+# The main class YoutubeDlhelper
+class YoutubeDlhelper
+  puts 'Running initialize process...'
+  puts 'Gets version...'
+  # @note Version variable
+  version = YoutubeDlhelperVersion::Version::STRING
+
+  puts 'Gets own process name...'
+  # @note Name of the App
+  my_name = File.basename($PROGRAM_NAME)
+
+  puts 'Getting command line arguments...'
+  # @note Command line aguments
+  argv = ARGV[0].to_s
+
+  puts 'Checking parsed URL if its valid...'
+  # @note Checks if the URL is valid
+  # @param [String] argv Given
+  url = Checker.external_url_is_valid?(argv)
+
+  puts 'Checking if your .youtube_dlhelper.conf is available...'
+  # @note Check oldconfig
+  Checker.oldconfig_exists?
+
+  puts 'Getting variables from your .youtube_dlhelper.conf...'
+  # @note Imports the configuration
+  home = Dir.home
+  music_dir_get, ogg_file_accept = Import.import_config
+  music_dir = "#{home}/#{music_dir_get}"
+
+  puts 'Initialized...'
+  puts 'Launching ...'
+  puts "Script: #{my_name}".color(:yellow)
+  puts "Version: #{version}".color(:yellow)
+  puts
+  puts 'Copyright (C) 2013-2015 Sascha Manns <Sascha-Manns@web.com>'
+  puts 'Description: This script can download music from YouTube'
+  puts "converts it to OGG/MP3 and places it in #{music_dir}."
+  puts 'License: See LICENSE file'
+  puts ''
+  puts 'This program is free software: you can redistribute it and/or modify'
+  puts 'it under the terms of the GNU General Public License as published by'
+  puts 'the Free Software Foundation, either version 3 of the License, or'
+  puts '(at your option) any later version.'
+  puts ''
+  puts 'This program is distributed in the hope that it will be useful,'
+  puts 'but WITHOUT ANY WARRANTY; without even the implied warranty of'
+  puts 'MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the'
+  puts 'GNU General Public License for more details.'
+  puts 'You should have received a copy of the GNU General Public License'
+  puts 'along with this program.  If not, see <http://www.gnu.org/licenses/>.'
+  puts 'File bugreports and feature requests there:'
+  puts 'http://saigkill-bugs.myjetbrains.com/youtrack/issues'
+
+  # Check which decoder should used
+  ffmpeg_binary = Checker.which_decoder?
+
+  puts 'CHECKING TARGET'.color(:yellow)
+  # @note Checks if target directory is present. Otherwise it creates one
+  folder = Checker.check_target
+
+  # @note Prints out which targetfolder is choosen.
+  puts 'SEARCHING FOR TARGETDIR'
+  puts "Your present Targetfolder is: #{music_dir}/#{folder}".color(:yellow)
+  puts 'You can choose another one directly in the configfile.'
+  puts 'Checking now, if your targetdirectory exists...'
+  # @param [String] music_dir Path to the music directory
+  # @param [String] folder Path to the targetfolder
+  Checker.check_dir(music_dir, folder)
+
+  # @note Using FileUtils to enter the generated directory
+  puts 'SWITCHING TO TARGETDIR'.color(:yellow)
+  # @param [String] music_dir Path to the music directory
+  # @param [String] folder Path to the targetfolder
+  FileUtils.cd("#{music_dir}/#{folder}") do
+    puts "Now we are switched to directory #{Dir.pwd}".color(:yellow)
+    puts 'DOWNLOADING YOUR VIDEO'
+
+    # @param [String] url Is the given URL to the Youtube file
+    filename, filenameold = Downloader.get(url)
+
+    # @param [String] filename The filename
+    # @param [String] ogg_file_accept OGG file as end file accepted?
+    # (true/false)
+    # @param [String] ffmpeg_binary Path to the ffmpeg binary
+    filenamenew, extension = Ripper.rip_prepare(filename, ogg_file_accept,
+                                                ffmpeg_binary)
+
+    # @param [String] filenamenew The new produced filename
+    Checker.cleanup(filenamenew, filenameold)
+
+    puts "Now you can find your file in #{music_dir}/#{folder}/#{filenamenew}.#{extension}".color(:yellow)
+    puts "Thank you for using #{my_name} #{version}".color(:yellow)
+  end
+end

data/lib/youtube_dlhelper/checker.rb

@@ -0,0 +1,160 @@
+# Youtube Converter for Ruby
+# Description: Downloads a file from a YT URL transcodes them to MP3 and places
+# it into a choosen folder
+# Module: Checker
+# Work: This Module provides different checker methods
+# Class Documentation:
+# http://www.rubydoc.info/github/saigkill/youtube_dlhelper/Checker
+#
+# Copyright (C) 2013-2015  Sascha Manns <samannsml@directbox.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# Dependencies
+require 'rainbow/ext/string'
+require 'fileutils'
+require 'net/http'
+require 'uri'
+
+# The Checker module contains different methods to check anything
+module Checker
+  # @note This method checks if a url is valid
+  # This method smells of :reek:TooManyStatements
+  # @param [String] url Is the given URL to the Youtube file
+  # @return [String] url
+  def self.external_url_is_valid?(url)
+    puts 'Checking prefix'.color(:green)
+    puts url
+    if url.include? 'https'
+      puts 'Checking if https URL is valid'.color(:green)
+      https_url_valid?(url)
+      return url
+    else
+      puts 'Checking if http URL is valid'.color(:green)
+      http_url_valid?(url)
+      return url
+    end
+  end
+
+  # Method to check https
+  # @param [String] url Is the given URL to the Youtube file
+  def self.https_url_valid?(url)
+    # @param [String] url Is the given URL to the Youtube file
+    uri = URI.parse(url)
+    response = Net::HTTP.start(uri.host, uri.port,
+                    :use_ssl => uri.scheme == 'https') do |http|
+      http.head(uri.path)
+    end
+    response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPRedirection)
+  end
+
+  # Method to check http
+  # @param [String] url Is the given URL to the Youtube file
+  def self.http_url_valid?(url)
+    # @param [String] url Is the given URL to the Youtube file
+    uri = URI.parse(url)
+    response = Net::HTTP.start(uri.host, uri.port) do |http|
+      http.head(uri.path)
+    end
+    response.is_a?(Net::HTTPSuccess) || response.is_a?(Net::HTTPRedirection)
+  end
+
+  # rubocop:disable Metrics/LineLength
+  # This method smells of :reek:TooManyStatements
+  # Ask for names, creates the folders and puts all into a $folder variable
+  # @return [String] folder
+  def self.check_target
+
+    entry = ask 'What kind of entry do you have? (Interpret or Group)'
+
+    subdir = case entry
+             when 'Interpret'
+               [
+                 ask('Whats the surname of your interpret?'),
+                 ask('Whats the first name of your interpret?')
+               ].join('_')
+
+             when 'Group'
+               ask 'Whats the name of the group?'
+
+             else
+               puts 'Just the entries "Interpret" or "Group" are allowed'.color(:red)
+               abort('Aborted')
+             end
+    subdir.gsub(/ /, '_')
+    folder = "#{ subdir }/Youtube-Music"
+    return folder
+  end
+
+  # Checks if the targetdirectory are present. If not, it creates one
+  # @param [String] music_dir Path to the music directory
+  # @param [String] folder Path to the targetfolder
+  def self.check_dir(music_dir, folder)
+    # @note Checking if musicdir exists
+    if Dir.exist?("#{music_dir}/#{folder}")
+      puts 'Found directory. Im using it.'.color(:green)
+    else
+      puts 'No directory found. Im creating it.'.color(:green)
+      # @note Creates the new directory in $music_dir/$folder
+      FileUtils.mkdir_p("#{music_dir}/#{folder}")
+      if Dir.exist?("#{music_dir}/#{folder}")
+        puts 'Created new directory...'.color(:green)
+      else
+        fail('Cant create directory')
+      end
+    end
+  end
+
+  # This method checks if a oldconfig is available
+  # @return [String] true or false
+  def self.oldconfig_exists?
+    home = Dir.home
+    if File.exist?("#{home}/.youtube_dlhelper/youtube_dlhelper.conf")
+      puts 'Found configuration file and using it...'.color(:yellow)
+    else
+      # @raise
+      puts 'Please run rake setup'.color(:red)
+      fail('Exiting now..').color(:red)
+    end
+  end
+
+  # This method checks which decoder is available
+  # This method smells of :reek:TooManyStatements
+  # @return [String] ffmpeg_binary
+  def self.which_decoder?
+    getavconv = `which avconv`
+    getffmpeg = `which ffmpeg`
+    avconv = p getavconv.chomp
+    ffmpeg = p getffmpeg.chomp
+    ffmpeg_binary = ffmpeg if ffmpeg != ''
+    ffmpeg_binary = avconv if avconv != ''
+    return ffmpeg_binary
+  end
+
+  # Cleaner method for unneeded files
+  # This method smells of :reek:TooManyStatements
+  # @param [String] filename The name of the new produced file
+  def self.cleanup(filename, filenameold)
+    puts 'Cleaning up directory'.color(:green)
+    # @note Cleanup the temp files
+    File.delete("#{filename}.mp4") if File.exist?("#{filename}.mp4")
+    File.delete("#{filename}.m4a") if File.exist?("#{filename}.m4a")
+    File.delete("#{filename}.webm") if File.exist?("#{filename}.webm")
+    File.delete("#{filenameold}.mp4") if File.exist?("#{filenameold}.mp4")
+    File.delete("#{filenameold}.m4a") if File.exist?("#{filenameold}.m4a")
+    File.delete("#{filenameold}.webm") if File.exist?("#{filenameold}.webm")
+    puts 'Finished cleaning up'.color(:green)
+  end
+end

data/lib/youtube_dlhelper/downloader.rb

@@ -0,0 +1,80 @@
+# Youtube Converter for Ruby
+# Description: Downloads a file from a YT URL transcodes them to MP3 or OGG and
+# places it into a choosen folder
+# Module: Downloader
+# Work: It downloads a *.mp4 file from Youtube, then extracts audio to *.m4a
+# Class Documentation:
+# http://www.rubydoc.info/github/saigkill/youtube_dlhelper/Downloader
+#
+# Copyright (C) 2013-2015  Sascha Manns <samannsml@directbox.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# Dependencies
+require 'viddl-rb'
+require 'rainbow/ext/string'
+require 'fileutils'
+
+# Module for all Downloading things
+module Downloader
+  # Accessing the url with get(url) via viddl-rb
+  # @param [String] url Is the given URL to the Youtube file
+  def self.get(url)
+    puts 'Downloading file...'.color(:green)
+    system('viddl-rb', '-e', "#{url}")
+    puts 'Downloading done...'.color(:green)
+    rename(url)
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  # This method smells of :reek:TooManyStatements
+  # This method smells of :reek:UncommunicativeVariableName
+  # Method for renaming the orig file with blanks to underscores
+  # @param [String] url Is the given URL to the Youtube file
+  # @return [String] filenamenew The fixed filename with underscores
+  def self.rename(url)
+    file = ViddlRb.get_names(url)
+    file.first
+    extn = File.extname file.first.to_s # .mp4
+    # Culture Beat           Mr. Vain
+    filename = File.basename file.first.to_s, extn
+    ext = file_exist_ogg_m4a(filename)
+    # @note Replacing blanks with underscrores and delete non standard chars in
+    # filename
+    filenamenew0 = filename.gsub(/ /, '_')
+    pattern = /[a-zA-Z0-9\-\s\_]/
+    # Culture_Beat___________Mr_Vain
+    filenamenew = filenamenew0.split(//).keep_if do |chr|
+      chr =~ pattern
+    end.join
+    puts 'Renaming the downloaded file'.color(:green)
+    FileUtils.mv("#{filename}.#{ext}", "#{filenamenew}.#{ext}")
+    [filenamenew, filename]
+  end
+
+  # It checks what old file are available
+  # @param [String] filename
+  # @return ext
+  def self.file_exist_ogg_m4a(filename)
+    if File.exist?("#{filename}.ogg")
+      ext = 'ogg'
+    elsif File.exist?("#{filename}.m4a")
+      ext = 'm4a'
+    elsif File.exist?("#{filename}.webm")
+      ext = 'webm'
+    end
+    return ext
+  end
+end

data/lib/youtube_dlhelper/get.rb

@@ -0,0 +1,43 @@
+# Youtube Converter for Ruby
+# Description: Downloads a file from a YT URL transcodes them to MP3 or OGG and
+# places it into a choosen folder
+# Module: Downloader
+# Work: It downloads a *.mp4 file from Youtube, then extracts audio to *.m4a
+# Class Documentation:
+# http://www.rubydoc.info/github/saigkill/youtube_dlhelper/Downloader
+#
+# Copyright (C) 2013-2015  Sascha Manns <samannsml@directbox.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Class for methods who getting informations
+module YoutubeDlhelperGet
+
+  # Method for getting the url
+  # @return [String] urlchecked
+  def self.url
+    # @note Put the yad input
+    urlinput = `yad --entry --button="Go" --title="URL" --text="Place your URL:"`
+    puts urlinput
+    return urlinput
+  end
+
+  # Method for getting the type of the musicans
+  # def self.type
+  #   # @note Put the yad input
+  #   type = `yad --title="Create documentation" --center --on-top --text="Is it a group or a single interpret" --button="Group" --button="Interpret"`
+  #   puts type
+  #
+  # end
+end

data/lib/youtube_dlhelper/import_config.rb

@@ -0,0 +1,42 @@
+# Youtube Converter for Ruby
+# Description: Downloads a file from a YT URL transcodes them to MP3 and places
+# it into a choosen folder
+# Module: Parses the configfile and imports the config
+# Work: This file contains some standard methods for YoutubeDlhelper
+# Class Documentation:
+# http://www.rubydoc.info/github/saigkill/youtube_dlhelper/Import
+# Copyright (C) 2013-2015  Sascha Manns <samannsml@directbox.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# Dependencies
+require 'parseconfig'
+
+# Module for Importing Informations
+module Import
+  # This Module parses the youtube_dlhelper.conf
+  # @return [Array] music_dir, ogg_file_accept, ffmpeg_binary
+  def self.import_config
+    home = Dir.home
+    config = ParseConfig.new(File.join(File.dirname(home),
+                                       '.youtube_dlhelper/youtube_dlhelper.conf'))
+    # @note Saving the variable musiddir
+    music_dir = config['musicdir'].to_s
+    # @note Saving the variable ogg_file_accept
+    ogg_file_accept = config['ogg_file_accept'].to_s
+    # @note It returns a array with music_dir, ogg_file_accept, ffmpeg_binary
+    [music_dir, ogg_file_accept]
+  end
+end