nehm 1.5.6.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a98659a7401715be66c19d94584b6b4cf61a6ee
-  data.tar.gz: 4894022da20fef8bb3d91ab7725da2d6dd0c950c
+  metadata.gz: 0aa2bd91903adaec7cb6b378a83d169944a23e3a
+  data.tar.gz: 6fcea548ac666b3bef9ea038f0de23f1992d9eb4
 SHA512:
-  metadata.gz: d102f1031a4224852a677e43074a72ebd5887c92089e6d0dae37fc3236784d7bcd454972537768c872b0de062ee08dd5b0f81237910d62f3141bd7da9fd5456e
-  data.tar.gz: 6baaf1609ac27cbace77a748037c497b34c8161364f5446ca56ee51d131049b7e059d87e2166bb81607051a7e747355e3eaff79004b12f52e72d0f5655351fe2
+  metadata.gz: c5d5e134ee8b62dcb0ee356e5b4fcca17b64652c1581090f552bdb5f303f9d96e5f8a0c012f4617c2b1efca7973b7de5e2372e8422f955d3d9ca412ec2a72f9c
+  data.tar.gz: 1de3a085d88651abb6a3a8f16fd6d17116f3ee1ef8c7ba7baf1f4026eeca4203d43fe3cb79908dff1229e409a6ac145902a71c4d84d5c889792de0665083da9c

data/.gitignore

@@ -8,3 +8,5 @@
 /spec/reports/
 /tmp/
 .DS_Store
+*.swp
+*.gem

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # nehm change log
 
+## 1.6.1
+* Fix nehm's fails when download tracks from url
+
+## 1.6
+* Rewritten about 90% of code to make it more comfortable to read (improve code climate from 2.9 to 3.6)
+* Add newlines before and after downloading track
+* Clearer 'help' command
+
 ## 1.5.6.2
 * Excluding space and dash from removing in track's file name
 

data/README.md

@@ -8,6 +8,11 @@
 [![Dependency Status](https://gemnasium.com/bogem/nehm.svg)](https://gemnasium.com/bogem/nehm)
 [![Code Climate](https://codeclimate.com/github/bogem/nehm/badges/gpa.svg)](https://codeclimate.com/github/bogem/nehm)
 
+## DISCLAIMER
+***For personal use only***
+
+***Nehm developer doesn't responsible for any illegal usage of this program***
+
 ## Installation
 
 **1. Install `taglib` library**
@@ -71,9 +76,7 @@ Enter path to desirable download directory (press enter to set it to ...
 
 * Get tracks to another directory
 
-  `nehm get post from nasa to ~/Downloads` or `nehm dl like from bogem to current`
-
-  *(if you type `to current`, `nehm` will get track to current working directory)*
+  `nehm get post to ~/Downloads` or `nehm dl like from bogem to .`
 
 * Get tracks to another iTunes playlist
 
@@ -95,10 +98,6 @@ Enter path to desirable download directory (press enter to set it to ...
 
   `nehm help`
 
-## TODO
-
-* Getting/downloading playlists from posts
-
 ##FAQ
 
 **Q: What is permalink?**

data/bin/nehm

@@ -3,8 +3,13 @@ nehm_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(nehm_dir) unless $LOAD_PATH.include?(nehm_dir)
 require 'nehm'
 
+$stderr = STDOUT
+
 begin
-  Nehm::App.do(ARGV)
+  Nehm.start(ARGV)
 rescue Interrupt # SIGINT
   puts "\nGoodbye!"
+  Nehm::UI.term
+rescue StandardError, Timeout::Error => ex
+  Nehm::UI.term "While executing nehm ... (#{ex.class})\n    #{ex}"
 end

data/lib/nehm.rb

@@ -1,67 +1,50 @@
+require 'colored'
 require 'highline'
-require 'paint'
 
-require 'nehm/applescript'
-require 'nehm/artwork'
-require 'nehm/cfg'
-require 'nehm/configure'
 require 'nehm/client'
-require 'nehm/get'
-require 'nehm/help'
-require 'nehm/os'
+require 'nehm/cfg'
+require 'nehm/command_manager'
 require 'nehm/path_manager'
-require 'nehm/playlist'
 require 'nehm/playlist_manager'
-require 'nehm/track'
-require 'nehm/user'
+require 'nehm/ui'
 require 'nehm/user_manager'
-require 'nehm/version'
 
 module Nehm
-  module App
-    def self.do(args)
-      init unless initialized?
 
-      command = args.shift
-      case command
-      when 'get'
-        Get[:get, args]
-      when 'dl'
-        Get[:dl, args]
-      when 'configure'
-        Configure.menu
-      when 'version'
-        puts Nehm::VERSION
-      when 'help', nil
-        Help.show(args.first)
-      else
-        puts Paint["Invalid command '#{command}'", :red]
-        puts "Input #{Paint['nehm help', :yellow]} for all avalaible commands"
-      end
-    end
+  # TODO: add rake tests
+  # TODO: add search command
+  # TODO: add select command
 
-    module_function
+  def self.start(args)
+    init unless initialized?
 
-    def init
-      puts Paint['Hello!', :green]
-      puts 'Before using the nehm, you should set it up:'
-      Cfg.create unless Cfg.exist?
+    CommandManager.run(args)
+  end
 
-      PathManager.set_dl_path
-      puts "\n"
+  module_function
 
-      unless OS.linux?
-        PlaylistManager.set_playlist
-        puts "\n"
-      end
+  def init
+    UI.success 'Hello!'
+    UI.say 'Before using the nehm, you should set it up:'
+    Cfg.create unless Cfg.exist?
 
-      UserManager.log_in
+    PathManager.set_dl_path
+    UI.newline
 
-      puts Paint["Now you can use nehm!\n", :green]
+    unless OS.linux?
+      PlaylistManager.set_playlist
+      UI.newline
     end
 
-    def initialized?
-      File.exist?(Cfg::FILE_PATH)
-    end
+    UserManager.set_uid
+    UI.newline
+
+    UI.success "Now you can use nehm!\n"
+    sleep(1)
+  end
+
+  def initialized?
+    File.exist?(Cfg::FILE_PATH)
   end
+
 end

data/lib/nehm/applescript.rb

@@ -1,6 +1,10 @@
 module Nehm
-  # Module which works with AppleScript scripts
+
+  ##
+  # AppleScript module calls all AppleScript scripts and returns results
+
   module AppleScript
+
     def self.add_track_to_playlist(track_path, playlist_name)
       `osascript \"#{script_path(:add_track_to_playlist)}\" \"#{track_path}\" \"#{playlist_name}\" > /dev/null`
     end
@@ -18,7 +22,8 @@ module Nehm
 
     def script_path(script_name)
       applescripts_path = File.expand_path(File.join(File.dirname(__FILE__), 'applescripts'))
-      File.join(applescripts_path, "#{script_name.to_s}.applescript")
+      File.join(applescripts_path, "#{script_name}.applescript")
     end
+
   end
 end

data/lib/nehm/artwork.rb

@@ -1,6 +1,10 @@
 module Nehm
-  # Artwork objects contains all needed information of track's artwork
+
+  ##
+  # Artwork objects contains all information of track's artwork
+
   class Artwork
+
     def initialize(track)
       @track = track
     end
@@ -9,11 +13,6 @@ module Nehm
       File.join('/tmp', "#{@track.id}.jpg")
     end
 
-    # Use in Get.dl
-    def name
-      'artwork'
-    end
-
     def suicide
       File.delete(file_path)
     end
@@ -28,5 +27,6 @@ module Nehm
         end
       url.sub('large', 't500x500')
     end
+
   end
 end

data/lib/nehm/cfg.rb

@@ -1,9 +1,12 @@
 require 'bogy'
 
-
 module Nehm
+
+  ##
   # Cfg module manipulates with nehm's config file (~/.nehmconfig)
+
   module Cfg
+
     FILE_PATH = File.join(ENV['HOME'], '.nehmconfig')
     CONFIG_FILE = Bogy.new(file: FILE_PATH)
 
@@ -26,5 +29,6 @@ module Nehm
     def self.key?(key)
       CONFIG_FILE.to_h.key?(key.to_s)
     end
+
   end
 end

data/lib/nehm/client.rb

@@ -1,23 +1,95 @@
 require 'certifi'
+require 'faraday'
+require 'json'
 require 'soundcloud'
 
 module Nehm
-  # Soundcloud API client.
+
+  ##
+  # Client module contains all SC API interaction methods
+
   module Client
-    # Set a SSL certificate file path for SC API
+
+    ##
+    # SSL certificate file path for SC API
+
     ENV['SSL_CERT_FILE'] = Certifi.where
 
+    ##
     # SoundCloud API client ID
+
     CLIENT_ID = '11a37feb6ccc034d5975f3f803928a32'
 
-    def self.get(*args)
-      sc_client.get(*args)
+    ##
+    # SoundCloud client object
+
+    SC_CLIENT = Soundcloud.new(client_id: CLIENT_ID)
+
+    ##
+    # Max limit of tracks for correct SoundCloud requests
+
+    TRACKS_LIMIT = 200
+
+    ##
+    # Returns raw array of likes or posts (depends on argument 'type')
+
+    def self.tracks(count, type, uid)
+      UI.term "Invalid number of #{type}" if count == 0
+
+      iterations = count.to_f / TRACKS_LIMIT
+      iterations = iterations.ceil
+
+      tracks = []
+      iterations.times do |i|
+        limit = count < TRACKS_LIMIT ? count : TRACKS_LIMIT
+        count -= TRACKS_LIMIT
+
+        tracks +=
+          case type
+          when :likes
+            likes(limit, i * TRACKS_LIMIT, uid)
+          when :posts
+            posts(limit, i * TRACKS_LIMIT, uid)
+          end
+      end
+      tracks
+    end
+
+    ##
+    # Returns user hash from SoundCloud or nil if user doesn't exist
+
+    def self.user(permalink)
+      SC_CLIENT.get('/resolve', url: "https://soundcloud.com/#{permalink}")
+      rescue SoundCloud::ResponseError => e
+        return nil if e.message =~ /404/
+    end
+
+    ##
+    # Returns track hash from SoundCloud by specified url
+
+    def self.track(url)
+      SC_CLIENT.get('/resolve', url: url)
     end
 
     module_function
 
-    def sc_client
-      @client ||= Soundcloud.new(client_id: CLIENT_ID)
+    def likes(limit, offset, uid)
+      SC_CLIENT.get("/users/#{uid}/favorites?limit=#{limit}&offset=#{offset}")
+    end
+
+    ##
+    # Stantard SoundCloud Ruby wrapper doesn't support reposts if user
+    # isn't authorized
+    # But api-v2.soundcloud.com supports it
+
+    # TODO: use net/http instead of Faraday
+
+    def posts(limit, offset, uid)
+      conn = Faraday.new(url: 'https://api-v2.soundcloud.com/')
+      response = conn.get("/profile/soundcloud:users:#{uid}?limit=#{limit}&offset=#{offset}")
+      parsed = JSON.parse(response.body)
+      parsed['collection']
     end
+
   end
 end

data/lib/nehm/command.rb

@@ -0,0 +1,123 @@
+require 'nehm/option_parser'
+
+module Nehm
+
+  ##
+  # Base class for all Nehm commands. When creating a new nehm command, define
+  # #initialize, #execute, #arguments, #program_name, #summary and #usage
+  # (as appropriate).
+  # See the above mentioned methods for details.
+
+  class Command
+
+    ##
+    # Hash with options of the command.
+
+    attr_accessor :options
+
+    ##
+    # Hash with descriptions of each options.
+
+    attr_accessor :options_descs
+
+    ##
+    # In 'initialize' should be defined all options by method 'add_option'.
+    #
+    # See get_command.rb as example.
+
+    def initialize
+      @options = {}
+    end
+
+    ##
+    # Invoke the command with the given list of arguments.
+
+    def invoke(args)
+      handle_options(args)
+      execute
+    end
+
+    ##
+    # Handle the given list of arguments by parsing them and recording the
+    # results.
+
+    def handle_options(args)
+      parser = OptionParser.new(args, self)
+      parser.parse
+    end
+
+    ##
+    # Override to provide command handling.
+    #
+    # #options will be filled in with your parsed options, unparsed options will
+    # be left in #options[:args].
+
+    def execute
+    end
+
+    ##
+    # Override to provide details of the arguments a command takes.
+    #
+    # For example:
+    #
+    #   def usage
+    #     "#{program_name} COMMAND"
+    #   end
+    #
+    #   def arguments
+    #     ['COMMAND', 'name of command to show help']
+    #   end
+
+    def arguments
+      {}
+    end
+
+    ##
+    # The name of the command for command-line invocation.
+
+    def program_name
+    end
+
+    ##
+    # Override to display a short description of what this command does.
+
+    def summary
+    end
+
+    ##
+    # Override to display the usage for an individual nehm command.
+    #
+    # The text "[options]" is automatically appended to the usage text.
+
+    def usage
+    end
+
+    ##
+    # Add a command-line option.
+    #
+    # Nehm don't use options with dashes to be more user-friendly.
+    #
+    # See 'get_command.rb' as example.
+
+    def add_option(option, usage, desc)
+      @options_descs ||= {}
+
+      @options[option] = nil
+      @options_descs[usage] = desc
+    end
+
+    HELP = <<-EOF
+#{'nehm'.green} is a console tool, which downloads, sets IDv3 tags and adds to your iTunes library your SoundCloud posts or likes in convenient way
+
+#{'Avalaible nehm commands:'.yellow}
+  #{'get'.green}        Download, set tags and add to your iTunes library last post or like from your profile
+  #{'dl'.green}         Download and set tags last post or like from your profile
+  #{'configure'.green}  Configure application
+  #{'help'.green}       Show help for specified command
+  #{'version'.green}    Show version of installed nehm
+
+See #{'nehm help [command]'.yellow} to read about a specific subcommand
+    EOF
+
+  end
+end