groove-dl 0.1.0

data/MANIFEST

@@ -0,0 +1,34 @@
+.gitignore
+.rubocop.yml
+.travis.yml
+Gemfile
+LICENSE
+MANIFEST
+README.md
+Rakefile
+bin/groove-dl
+bin/groove-dl-cli
+groove-dl.gemspec
+lib/groove-dl.rb
+lib/groove-dl/app.rb
+lib/groove-dl/cli.rb
+lib/groove-dl/cli/search.rb
+lib/groove-dl/configuration.rb
+lib/groove-dl/displayer.rb
+lib/groove-dl/downloader.rb
+lib/groove-dl/errors.rb
+lib/groove-dl/version.rb
+lib/groove-dl/widgets/download/bar.rb
+lib/groove-dl/widgets/download/book.rb
+lib/groove-dl/widgets/download/list/failed.rb
+lib/groove-dl/widgets/download/list/queue.rb
+lib/groove-dl/widgets/download/list/success.rb
+lib/groove-dl/widgets/search/bar.rb
+lib/groove-dl/widgets/search/list.rb
+spec/groove-dl/cli_spec.rb
+spec/groove-dl/displayer_spec.rb
+spec/groove-dl/downloader_spec.rb
+spec/spec_helper.rb
+task/manifest.rake
+task/rubocop.rake
+task/spec.rake

data/README.md

@@ -0,0 +1,87 @@
+#Grooveshark song downloader
+
+[![Build Status](https://travis-ci.org/PierreRambaud/groove-dl.png?branch=master)](https://travis-ci.org/PierreRambaud/groove-dl)
+
+##Requirements
+
+ * Ruby 1.9.3 or newer
+
+##Installation
+
+From RubyGems
+
+```
+$ gem install groove-dl
+```
+
+From Github
+
+```
+$ git clone https://github.com/PierreRambaud/groove-dl.git
+$ cd groove-dl
+$ bundle install
+$ bundle exec rake install
+```
+
+## Usage
+
+Run `groove-dl` and a gtk app will be displayed, you can:
+
+* search for playlist or song
+* choose download directory
+* add them to queue
+* download concurrently
+
+
+In CLI mode:
+
+```bash
+$ groove-dl-cli --help
+Usage: groove-dl [COMMAND] [OPTIONS]
+
+Options:
+
+    -v, --version       Shows the current version
+    -p, --playlist      Playlist
+    -s, --song          Song
+    -o, --output        Output directory
+    -h, --help          Display this help message.
+
+Available commands:
+
+  search   Search for something on GrooveShark
+
+See `<command> --help` for more information on a specific command.
+```
+
+Search for song:
+```bash
+$ groove-dl-cli search --help
+Usage: groove-dl search [OPTIONS]
+
+Options:
+
+    -p, --playlist      Playlist
+    -s, --song          Song
+    -h, --help          Display this help message.
+```
+
+## Running tests
+
+To run unit tests:
+`$ bundle exec rake spec`
+
+To check code style:
+`$ bundle exec rake rubocop`
+
+To run all tests:
+`$ bundle exec rake`
+
+##Disclamer
+
+You must have paid the song before download it, thus I'm not responsible for any violations this script does to Grooveshark's Terms Of Use.
+This is just a project for learning how to create gtk app in ruby.
+
+
+## License
+See [LICENSE](LICENSE) file

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require 'bundler/gem_tasks'
+
+GEMSPEC = Gem::Specification.load('gemirro.gemspec')
+
+Dir['./task/*.rake'].each do |task|
+  import(task)
+end
+
+task default: [:rubocop, :spec]

data/bin/groove-dl

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../lib/groove-dl', __FILE__)
+
+require 'gtk3'
+require 'groove-dl/app'
+require 'groove-dl/widgets/download/bar'
+require 'groove-dl/widgets/download/list/queue'
+require 'groove-dl/widgets/download/list/failed'
+require 'groove-dl/widgets/download/list/success'
+require 'groove-dl/widgets/download/book'
+require 'groove-dl/widgets/search/bar'
+require 'groove-dl/widgets/search/list'
+
+Gtk.init
+GrooveDl::App.new
+Gtk.main

data/bin/groove-dl-cli

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../lib/groove-dl', __FILE__)
+
+require 'ruby-progressbar'
+require 'slop'
+require 'terminal-table'
+
+require 'groove-dl/cli'
+require 'groove-dl/cli/search'
+require 'groove-dl/displayer'
+
+options = GrooveDl::CLI.options
+puts options if options.parse.empty?

data/groove-dl.gemspec

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+require File.expand_path('../lib/groove-dl/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = 'groove-dl'
+  s.version = GrooveDl::VERSION
+  s.authors = ['Pierre Rambaud']
+  s.email = 'pierre.rambaud86@gmail.com'
+  s.license = 'GPL-3.0'
+  s.summary = 'Download grooveshark songs.'
+  s.homepage = 'http://github.com/PierreRambaud/groove-dl'
+  s.description = 'Grooveshark downloader allow you to choose' \
+                  'songs and download them.'
+  s.executables = ['groove-dl', 'groove-dl-cli']
+
+  s.files = File.read(File.expand_path('../MANIFEST', __FILE__)).split("\n")
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_dependency 'slop', '~>3.6'
+  s.add_dependency 'grooveshark', '~>0.2.12'
+  s.add_dependency 'ruby-progressbar', '~>1.7.0'
+  s.add_dependency 'terminal-table', '~>1.4.5'
+  s.add_dependency 'gtk3', '~>2.2'
+
+  s.add_development_dependency 'fakefs', '~>0.6.0'
+  s.add_development_dependency 'rake', '~>10.0'
+  s.add_development_dependency 'rack-test', '~>0.6'
+  s.add_development_dependency 'rspec', '~>3.0'
+  s.add_development_dependency 'simplecov', '~>0.9'
+  s.add_development_dependency 'rubocop', '~>0.25'
+end

data/lib/groove-dl.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+require 'logger'
+require 'grooveshark'
+
+unless $LOAD_PATH.include?(File.expand_path('../', __FILE__))
+  $LOAD_PATH.unshift(File.expand_path('../', __FILE__))
+end
+
+require 'groove-dl/configuration'
+require 'groove-dl/downloader'
+require 'groove-dl/version'
+require 'groove-dl/errors'

data/lib/groove-dl/app.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+module GrooveDl
+  # Bootstraper for the application
+  class App < Gtk::Window
+    def initialize
+      super
+
+      client = Grooveshark::Client.new
+      box = Gtk::Box.new(:vertical)
+
+      search_bar = Widgets::Search::Bar.new(:vertical, 6)
+      search_bar.load(client, self)
+
+      search_list = Widgets::Search::List.new(:vertical, 6)
+      search_list.load(client, self)
+
+      download_bar = Widgets::Download::Bar.new(:vertical, 6)
+      download_bar.load(client, self)
+
+      download_book = Widgets::Download::Book.new
+      download_book.load(client, self)
+
+      box.pack_start(search_bar, expand: false, fill: true, padding: 10)
+      box.pack_start(search_list, expand: true, fill: true, padding: 5)
+      box.pack_start(download_bar, expand: false, fill: true, padding: 10)
+      box.pack_start(download_book, expand: true, fill: true, padding: 5)
+
+      add(box)
+
+      init_default
+    end
+
+    def init_default
+      signal_connect('destroy') do
+        Gtk.main_quit
+      end
+
+      set_title('Grooveshark Downloader')
+      set_default_size(1024, 768)
+      set_window_position(:center)
+      show_all
+    end
+
+    def find_by_name(element = self, name)
+      return element if element.name == name
+      element.children.each do |child|
+        result = find_by_name(child, name)
+        return result unless result.nil?
+      end if element.respond_to?(:children)
+
+      nil
+    end
+  end
+end

data/lib/groove-dl/cli.rb

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+module GrooveDl
+  # CLI module
+  module CLI
+    ##
+    # Hash containing the default Slop options.
+    #
+    # @return [Hash]
+    #
+    SLOP_OPTIONS = {
+      strict: true,
+      help: true,
+      banner: 'Usage: groove-dl [COMMAND] [OPTIONS]'
+    }
+
+    ##
+    # @return [Slop]
+    #
+    def self.options
+      @options ||= default_options
+    end
+
+    ##
+    # @return [Slop]
+    #
+    def self.default_options
+      Slop.new(SLOP_OPTIONS.dup) do
+        separator "\nOptions:\n"
+
+        on :v, :version, 'Shows the current version' do
+          puts CLI.version_information
+        end
+
+        on :p=, :playlist=, 'Playlist', as: Integer
+        on :s=, :song=, 'Song', as: Integer
+        on :o=, :output=, 'Output directory', as: String
+
+        run do |opts|
+          next if opts[:v]
+
+          client = Grooveshark::Client.new
+          d = Downloader.new(client, opts)
+          d.playlist(opts[:p]) if opts[:p]
+          d.song(opts[:s]) if opts[:s]
+        end
+      end
+    end
+
+    ##
+    # Returns a String containing some platform/version related information.
+    #
+    # @return [String]
+    #
+    def self.version_information
+      "Groove-dl v#{VERSION} on #{RUBY_DESCRIPTION}"
+    end
+  end
+end

data/lib/groove-dl/cli/search.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+GrooveDl::CLI.options.command 'search' do
+  banner 'Usage: groove-dl search [OPTIONS]'
+  description 'Search for something on GrooveShark'
+  separator "\nOptions:\n"
+
+  on :p=, :playlist=, 'Playlist', as: String
+  on :s=, :song=, 'Song', as: String
+
+  run do |opts|
+    next if opts[:p].nil? && opts[:a].nil? && opts[:s].nil?
+    client = Grooveshark::Client.new
+
+    type = 'Songs' if opts[:s]
+    type = 'Playlists' if opts[:p]
+    query = opts[:s] if opts[:s]
+    query = opts[:p] if opts[:p]
+
+    results = client.request('getResultsFromSearch',
+                             type: type,
+                             query: query)['result']
+    results.map! do |data|
+      next Grooveshark::Song.new data if type == 'Songs'
+      data
+    end
+
+    displayer = GrooveDl::Displayer.new(results, type)
+    displayer.render
+  end
+end

data/lib/groove-dl/configuration.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+# Groove Dl module
+module GrooveDl
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Configuration class
+  class Configuration
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+end

data/lib/groove-dl/displayer.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+module GrooveDl
+  # Downloader Class
+  class Displayer
+    attr_reader :result, :type
+
+    ##
+    # Initialize Displayer
+    #
+    # @params [Array] result The result from the search
+    # @params [String] type The search type
+    #
+    # @return [Nil]
+    #
+    def initialize(result, type)
+      @result = result
+      @type = type
+    end
+
+    ##
+    # Display prompt to choose songs or playlists.
+    #
+    def render
+      table = Terminal::Table.new(headings: headers, title: @type)
+      @result.each do |data|
+        add_row(table, data)
+      end
+
+      puts table.to_s
+    end
+
+    def headers
+      return %w(Id Album Artist Song) if @type == 'Songs'
+      return %w(Id Nam Author NumSongs) if @type == 'Playlists'
+    end
+
+    ##
+    # Add row into table
+    #
+    # @params [Terminal::Table] table Table in which row will be added
+    # @params [Array] result The result from the search
+    #
+    # @return [Nil]
+    #
+    def add_row(table, data)
+      table.add_row([data['playlist_id'],
+                     data['name'],
+                     data['f_name'],
+                     data['num_songs']]) if @type == 'Playlists'
+      table.add_row([data.id,
+                     data.album,
+                     data.artist,
+                     data.name]) if @type == 'Songs'
+    end
+  end
+end

data/lib/groove-dl/downloader.rb

@@ -0,0 +1,178 @@
+# -*- coding: utf-8 -*-
+module GrooveDl
+  # Downloader Class
+  class Downloader
+    attr_accessor :type
+    attr_writer :client
+    attr_writer :download_queue
+    attr_writer :download_count
+    attr_writer :download_skip
+
+    ##
+    # Initialize download
+    #
+    # @return [Downloader]
+    #
+    def initialize(client, options = {})
+      @client = client
+      @output_directory = options[:o] || Dir.tmpdir
+      @queue = []
+      @count = 0
+      @skip = 0
+      @type = 'cli'
+    end
+
+    ##
+    # Download song
+    #
+    # @params [String] song_id Song id
+    #
+    # @return [Array]
+    #
+    def song(song_id)
+      @queue << Grooveshark::Song.new('song_id' => song_id,
+                                      'artist_name' => 'unknown',
+                                      'song_name' => 'unknown')
+      download_queue
+    end
+
+    ##
+    # Download playlist
+    #
+    # @params [String] playlist_id Playlist id
+    #
+    # @return [Array]
+    #
+    def playlist(playlist_id)
+      playlist = Grooveshark::Playlist.new(@client,
+                                           'playlist_id' => playlist_id)
+      songs = playlist.load_songs
+      return false unless songs
+      @queue += songs
+
+      download_queue
+    end
+
+    ##
+    # Download song
+    #
+    # @param [Grooveshark::Song] song Song object
+    # @param [Gtk::TreeIter/String] callback Proc
+    # function to execute during download
+    #
+    # @return [Net::HTTP]
+    #
+    def download(song, object)
+      url = URI.parse(@client.get_song_url_by_id(song.id))
+      @client.get_stream_auth_by_songid(song.id)
+
+      callback = process_gui_response(object) if @type == 'gui'
+      callback = process_cli_response(object) if @type == 'cli'
+
+      RestClient::Request
+        .execute(method: :get,
+                 url: url.to_s,
+                 block_response: callback)
+    end
+
+    ##
+    # Download queue
+    #
+    # @return [false|Array]
+    #
+    def download_queue
+      return false if @queue.empty?
+      @queue.each do |song|
+        download(song, build_path(@output_directory, song))
+      end
+
+      { skipped: @skip, downloaded: @count }
+    end
+
+    ##
+    # Build path
+    #
+    # @param [String] output_directory destination directory
+    # @param [Grooveshark::Song] song Song
+    #
+    def build_path(output_directory, song)
+      sprintf('%s/%s/%s/%s.mp3',
+              output_directory,
+              song.artist,
+              song.album,
+              song.name)
+    end
+
+    ##
+    # Process response to display a progress bar and download
+    # file into destination.
+    #
+    # @param [String] destination Destination
+    #
+    # @return [Proc]
+    #
+    def process_cli_response(destination)
+      proc do |response|
+        total_size = response['content-length'].to_i
+        if File.exist?(destination) &&
+           File.size?(destination) == total_size
+
+          @skip += 1
+          fail Errors::AlreadyDownloaded, "#{destination} already downloaded"
+        end
+
+        pbar = ProgressBar.create(title: destination.split('/').last,
+                                  format: '%a |%b>>%i| %p%% %t',
+                                  total: response['content-length'].to_i)
+        File.open(destination, 'w') do |f|
+          response.read_body do |chunk|
+            f.write(chunk)
+            pbar.progress += chunk.length
+          end
+        end
+
+        pbar.finish
+        @count += 1
+      end
+    end
+
+    ##
+    # Process response to pulse progressbar stored in the
+    # TreeIter object.
+    #
+    # @param [Gtk::TreeIter] object TreeIter
+    #
+    # @return [Proc]
+    #
+    def process_gui_response(object)
+      proc do |response|
+        pgbar_value = Widgets::Download::List::Queue::COLUMN_PGBAR_VALUE
+        pgbar_text = Widgets::Download::List::Queue::COLUMN_PGBAR_TEXT
+
+        total_size = response['content-length'].to_i
+        path = object[Widgets::Download::List::Queue::COLUMN_PATH]
+        if File.exist?(path) &&
+           File.size?(path) == total_size
+          object[pgbar_value] = 100
+          object[pgbar_text] = 'Complete'
+          fail Errors::AlreadyDownloaded, "#{path} already downloaded"
+        end
+
+        dirname = File.dirname(path)
+        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+
+        File.open(path, 'w') do |f|
+          file_size = 0
+          response.read_body do |chunk|
+            f.write(chunk)
+            file_size += chunk.length
+            result = ((file_size * 100) / total_size).to_i
+            object[pgbar_value] = result
+            object[pgbar_text] = 'Complete' if
+              object[pgbar_value] >= 100
+          end
+        end
+      end
+    end
+  end
+end