nehm 1.6.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aa2bd91903adaec7cb6b378a83d169944a23e3a
-  data.tar.gz: 6fcea548ac666b3bef9ea038f0de23f1992d9eb4
+  metadata.gz: 642f53e571f554b780f52a641af8fdfe81f0a05c
+  data.tar.gz: d7eef194b669c2915a4ee53ddf7e8049b3e46058
 SHA512:
-  metadata.gz: c5d5e134ee8b62dcb0ee356e5b4fcca17b64652c1581090f552bdb5f303f9d96e5f8a0c012f4617c2b1efca7973b7de5e2372e8422f955d3d9ca412ec2a72f9c
-  data.tar.gz: 1de3a085d88651abb6a3a8f16fd6d17116f3ee1ef8c7ba7baf1f4026eeca4203d43fe3cb79908dff1229e409a6ac145902a71c4d84d5c889792de0665083da9c
+  metadata.gz: d5926b9ad5deabd35d73a8caff482596e37a2083ad048dc203fc6171c8758e0b3cb769f6a838e919938598cd25f650d97606df580de9764f590600ef232f870e
+  data.tar.gz: 8097e9ef27791c75a04fa6841c1fea3d537426fda0551808702aba9fcc0376e4d2791e67aa0cd095462c38c554aef350188147038c99165ca6ddaf46063edfd7

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # nehm change log
 
+## 2.0.1
+* Make gem size smaller
+
+## 2.0
+* Add 'select' and 'search' commands *(more info in README and `nehm help`)*
+* Many performance improvements *(changes in application structure)*
+* More stable *(Many bug fixes and error handling)*
+* Less dependencies *(Remove 4 dependencies)*
+* Prettier README
+
 ## 1.6.1
 * Fix nehm's fails when download tracks from url
 

data/README.md

@@ -1,17 +1,35 @@
-# nehm
+<div align="center">
+<img src="https://raw.github.com/bogem/nehm/master/Pictures/logo.png" alt="Logo"></img>
 
-![ScreenShot](https://raw.github.com/bogem/nehm/master/Screenshots/screenshot.png)
 
-*nehm* is a console tool, which downloads, sets IDv3 tags and adds to your iTunes library your SoundCloud posts or likes in convenient way
+<p><b><i>nehm</i></b> is a console tool, which downloads, sets IDv3 tags and adds to your iTunes library your SoundCloud posts or likes in convenient way</p>
 
-[![Gem Version](https://badge.fury.io/rb/nehm.svg)](http://badge.fury.io/rb/nehm)
-[![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)
+<a href="http://badge.fury.io/rb/nehm"><img src="https://badge.fury.io/rb/nehm.svg" alt="Gem Version"></img></a>
+<a href="https://gemnasium.com/bogem/nehm"><img src="https://gemnasium.com/bogem/nehm.svg" alt="Dependency staus"></img></a>
+<a href="https://codeclimate.com/github/bogem/nehm"><img src="https://codeclimate.com/github/bogem/nehm/badges/gpa.svg" alt="Code climate"></img></a>
+</div>
 
-## DISCLAIMER
-***For personal use only***
+---
+<div align="center">
+<a href="https://www.dropbox.com/s/m4heiyq7vbpc4qs/1help.png" target="_blank"><img src="https://raw.github.com/bogem/nehm/master/Pictures/1help.png" alt="Help"></img></a>
+<a href="https://www.dropbox.com/s/b68flm7hv5myhk4/2get.png" target="_blank"><img src="https://raw.github.com/bogem/nehm/master/Pictures/2get.png" alt="Select"></img></a>
+<a href="https://www.dropbox.com/s/5gy6c5nzrsvhlv0/3select.png" target="_blank"><img src="https://raw.github.com/bogem/nehm/master/Pictures/3select.png" alt="Select"></img></a>
+<a href="https://www.dropbox.com/s/ynn9kb0ykcdishp/4search.png" target="_blank"><img src="https://raw.github.com/bogem/nehm/master/Pictures/4search.png" alt="Search"></img></a>
+
+<p><b>(clickable screenshots)</b></p>
+
+</div>
+
+***
+
+<div align="center">
+<h2>DISCLAIMER</h2>
+
+<b><i><p>For personal use only</p>
+
+Nehm developer doesn't responsible for any illegal usage of this program</i></b>
+</div>
 
-***Nehm developer doesn't responsible for any illegal usage of this program***
 
 ## Installation
 
@@ -48,57 +66,56 @@ Before using the nehm, you should set it up:
 Enter path to desirable download directory (press enter to set it to ...
 ```
 
-## Usage
+## Usage Examples
 
-**!!nehm doesn't add tracks to iTunes library, if you use Linux!!**
+Type `nehm help` to list of all available commands or `nehm help COMMAND` for specific command
 
-* Get (download to download directory, set tags and add to iTunes library) your last like
+Also commands and arguments (but **NOT** options) may be abbreviated, so long as they are unambiguous.
 
-  `nehm get like`
+#### Get (download to default directory, set tags and add to iTunes library) your last like
 
-* Get your last post (last track or repost from your profile)
+  `$ nehm get like` = `$ nehm g l`
 
-  `nehm get post`
+#### Get your last post (last track or repost from your profile)
 
-   ***(nehm doesn't get and download playlists. It just skips them)***
+  `$ nehm get post` = `$ nehm g p`
 
-* Get multiple last posts or likes
+#### Get multiple last posts or likes
 
-  `nehm get 3 posts` or `nehm get 3 likes`
+  `$ nehm get 3 posts` = `$ nehm get 3 ps`
 
-* Just download and set tags any track
+  `$ nehm get 5 likes` = `$ nehm get 5 ls`
 
-  `nehm dl post` or `nehm dl like` or `nehm dl 3 likes`
+#### Just download and set tags any track
 
-* Get tracks from another user
+  `$ nehm dl post` = `$ nehm d p`
 
-  `nehm get post from nasa` or `nehm dl like from bogem`
+#### Get tracks from another user
 
-* Get tracks to another directory
+  `$ nehm get post from nasa` or `$ nehm d l from bogem`
 
-  `nehm get post to ~/Downloads` or `nehm dl like from bogem to .`
+#### Get tracks to another directory
 
-* Get tracks to another iTunes playlist
+  `$ nehm g p to ~/Downloads` or `$ nehm d l from bogem to .`
 
-  `nehm get post playlist MyPlaylist`
+#### Get tracks to another iTunes playlist
 
-* Get or download track from url
+  `$ nehm g p pl MyPlaylist`
 
-  `nehm get https://soundcloud.com/nasa/delta-iv-launch`
+#### Get or download track from url
 
-  or
+  `$ nehm g https://soundcloud.com/nasa/delta-iv-launch`
 
-  `nehm dl https://soundcloud.com/nasa/delta-iv-launch`
+#### Select likes or posts and download them
 
-* Configure (change download directory, permalink, playlist)
+  `$ nehm select likes` = `$ nehm sel l`
 
-  `nehm configure`
+#### Search for tracks and download them
 
-* Help
+  `$ nehm search kanye west` = `$ nehm sea kanye west`
 
-  `nehm help`
 
-##FAQ
+## FAQ
 
 **Q: What is permalink?**
 

data/Rakefile

@@ -1,21 +1,71 @@
-require_relative 'lib/nehm/version.rb'
-task default: %w(build install delete)
+require 'bundler'
+require 'colored'
+require 'nehm/ui'
+require 'rake'
 
-file = 'nehm-' + Nehm::VERSION + '.gem'
+Bundler::GemHelper.install_tasks
+task default: %w(install)
 
-task :build do
-  system('gem build nehm.gemspec')
-end
+file = 'pkg/nehm-' + Nehm::VERSION + '.gem'
 
-task :install do
-  system('gem install ./' + file)
-end
+##
+# Push to rubygems
 
-task :delete do
+task :push => :build do
+  `gem push #{file}`
   File.delete('./' + file)
 end
 
-task :push => :build do
-  system('gem push ' + file)
-  File.delete('./' + file)
+##
+# Add command with boilerplate code
+#
+# For example, you want to add 'get' command
+# For that you should input 'rake nc[get]'
+
+task :nc, [:cmd] do |_, args|
+  cmd = args[:cmd]
+  cmd_file = "lib/nehm/commands/#{cmd}_command.rb"
+
+  puts "Making #{cmd} command..."
+
+  code = <<-EOF
+module Nehm
+
+  ##
+  # Write here description for command
+
+  class #{cmd.capitalize}Command < Command
+
+    ##
+    # Add all command's options in 'initialize' method
+
+    def initialize
+      super
+    end
+
+    def execute
+    end
+
+    def arguments
+    end
+
+    def program_name
+      'nehm #{cmd}'
+    end
+
+    def summary
+    end
+
+    def usage
+    end
+
+  end
+end
+  EOF
+
+  # Write to file
+  File.open(cmd_file, 'w') { |f| f.write(code) }
+
+  Nehm::UI.success "Successfully made #{cmd} command!"
+  Nehm::UI.warning "Don't forget to add the name of command to CommandManager::COMMANDS"
 end

data/bin/nehm

@@ -8,7 +8,6 @@ $stderr = STDOUT
 begin
   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}"

data/lib/nehm.rb

@@ -1,50 +1,72 @@
 require 'colored'
-require 'highline'
 
 require 'nehm/client'
 require 'nehm/cfg'
 require 'nehm/command_manager'
+require 'nehm/os'
 require 'nehm/path_manager'
 require 'nehm/playlist_manager'
+require 'nehm/track_manager'
 require 'nehm/ui'
 require 'nehm/user_manager'
 
 module Nehm
 
-  # TODO: add rake tests
-  # TODO: add search command
-  # TODO: add select command
-
   def self.start(args)
+    if args.empty?
+      UI.say HELP
+      UI.term
+    end
+
     init unless initialized?
 
     CommandManager.run(args)
   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
+
+#{'Available 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
+  #{'search'.green}     Search tracks, print them nicely and download selected tracks
+  #{'select'.green}     Get likes or posts from your account, nicely print them and download selected tracks
+  #{'version'.green}    Show version of installed nehm
+
+See #{'nehm help COMMAND'.yellow} to read about a specific command
+
+Commands and arguments (but NOT options) may be abbreviated, so long as they are unambiguous.
+e.g. 'nehm g l' is short for 'nehm get like'.
+EOF
+
   module_function
 
   def init
-    UI.success 'Hello!'
+    UI.say 'Hello!'.green
     UI.say 'Before using the nehm, you should set it up:'
     Cfg.create unless Cfg.exist?
 
     PathManager.set_dl_path
     UI.newline
 
-    unless OS.linux?
+    UserManager.set_uid
+    UI.newline
+
+    if OS.mac?
       PlaylistManager.set_playlist
       UI.newline
     end
 
-    UserManager.set_uid
+    UI.success "Now you can use nehm!"
     UI.newline
 
-    UI.success "Now you can use nehm!\n"
-    sleep(1)
+    sleep(UI::SLEEP_PERIOD)
   end
 
   def initialized?
-    File.exist?(Cfg::FILE_PATH)
+    Cfg.exist?
   end
 
 end

data/lib/nehm/cfg.rb

@@ -1,4 +1,4 @@
-require 'bogy'
+require 'yaml'
 
 module Nehm
 
@@ -8,18 +8,18 @@ module Nehm
   module Cfg
 
     FILE_PATH = File.join(ENV['HOME'], '.nehmconfig')
-    CONFIG_FILE = Bogy.new(file: FILE_PATH)
 
     def self.[](key)
-      CONFIG_FILE[key.to_s]
+      config_hash[key.to_s]
     end
 
     def self.[]=(key, value)
-      CONFIG_FILE[key.to_s] = value
+      config_hash[key.to_s] = value
+      write
     end
 
     def self.create
-      File.open(FILE_PATH, 'w+') { |f| f.write("---\napp: nehm") }
+      File.new(FILE_PATH, 'w+')
     end
 
     def self.exist?
@@ -27,7 +27,20 @@ module Nehm
     end
 
     def self.key?(key)
-      CONFIG_FILE.to_h.key?(key.to_s)
+      config_hash.key?(key.to_s)
+    end
+
+    module_function
+
+    def config_hash
+      @config_hash ||= YAML.load_file(FILE_PATH)
+      @config_hash ||= {} unless @config_hash
+
+      @config_hash
+    end
+
+    def write
+      IO.write(FILE_PATH, config_hash.to_yaml)
     end
 
   end

data/lib/nehm/client.rb

@@ -1,12 +1,11 @@
 require 'certifi'
-require 'faraday'
-require 'json'
-require 'soundcloud'
+require 'nehm/http_client'
 
 module Nehm
 
   ##
   # Client module contains all SC API interaction methods
+  # Also it forms urls und send them to HTTPClient
 
   module Client
 
@@ -16,14 +15,9 @@ module Nehm
     ENV['SSL_CERT_FILE'] = Certifi.where
 
     ##
-    # SoundCloud API client ID
+    # HTTP client object
 
-    CLIENT_ID = '11a37feb6ccc034d5975f3f803928a32'
-
-    ##
-    # SoundCloud client object
-
-    SC_CLIENT = Soundcloud.new(client_id: CLIENT_ID)
+    HTTP_CLIENT = HTTPClient.new
 
     ##
     # Max limit of tracks for correct SoundCloud requests
@@ -33,7 +27,7 @@ module Nehm
     ##
     # Returns raw array of likes or posts (depends on argument 'type')
 
-    def self.tracks(count, type, uid)
+    def self.tracks(count, offset, type, uid)
       UI.term "Invalid number of #{type}" if count == 0
 
       iterations = count.to_f / TRACKS_LIMIT
@@ -47,48 +41,51 @@ module Nehm
         tracks +=
           case type
           when :likes
-            likes(limit, i * TRACKS_LIMIT, uid)
+            likes(limit, i * TRACKS_LIMIT + offset, uid)
           when :posts
-            posts(limit, i * TRACKS_LIMIT, uid)
+            posts(limit, i * TRACKS_LIMIT + offset, uid)
           end
       end
       tracks
     end
 
+    def self.search(query, limit, offset)
+      uri = "/tracks?q=#{query}&limit=#{limit}&offset=#{offset}"
+      HTTP_CLIENT.get(1, uri)
+    end
+
     ##
-    # Returns user hash from SoundCloud or nil if user doesn't exist
+    # Returns track hash from SoundCloud by specified uri
 
-    def self.user(permalink)
-      SC_CLIENT.get('/resolve', url: "https://soundcloud.com/#{permalink}")
-      rescue SoundCloud::ResponseError => e
-        return nil if e.message =~ /404/
+    def self.track(uri)
+      HTTP_CLIENT.resolve(uri)
     end
 
     ##
-    # Returns track hash from SoundCloud by specified url
+    # Returns user hash from SoundCloud or nil if user doesn't exist
 
-    def self.track(url)
-      SC_CLIENT.get('/resolve', url: url)
+    def self.user(permalink)
+      url = "http://soundcloud.com/#{permalink}"
+      begin
+        HTTP_CLIENT.resolve(url)
+      rescue HTTPClient::Status404
+        return nil
+      rescue HTTPClient::ConnectionError
+        UI.term "Connection error. Check your internet connection\nSoundCloud can also be down"
+      end
     end
 
     module_function
 
     def likes(limit, offset, uid)
-      SC_CLIENT.get("/users/#{uid}/favorites?limit=#{limit}&offset=#{offset}")
+      uri = "/users/#{uid}/favorites?limit=#{limit}&offset=#{offset}"
+      HTTP_CLIENT.get(1, uri)
     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']
+      uri = "/profile/soundcloud:users:#{uid}?limit=#{limit}&offset=#{offset}"
+      response = HTTP_CLIENT.get(2, uri)
+      response['collection']
     end
 
   end