soundyoink 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44338e66fa50ed872f5aaee2d60c482da066483d
-  data.tar.gz: b5fe3e15da55618790d4cda49c0e07faec259ffc
+  metadata.gz: af141f8ba90235d457f3c120e1972a672526ab8f
+  data.tar.gz: 2b11d488db76fb48c5fbc42f52bfb2d122e09fff
 SHA512:
-  metadata.gz: b49a98655467d3b23743cb57aaa576e3767fb3b41b4cd60a6f84383867fa9057417fa5c24d607aa0a767b2ac4d176c4cf13ea47cbb0f3126a3db8de0165115d8
-  data.tar.gz: 17fea527c1af979408455e7dd8313cde3a6bae10c0e69e6256cc736923fe5a952aba316a11dfe58edbf0fde7a786bb99d753e17bd99e1141896c9f3e099d290f
+  metadata.gz: 827ad6d4c2a90483d817062a46e008114d0e6635a08375b0fea74cf61547b1ea991af87df0b0a6f7d31ae018091cfd19d90f55a5810c720aaf46002d74e8ae45
+  data.tar.gz: 113a092feb781c40fc895546efab2737b5870d41f24c9c2e36e8307f49b518a0dfba0728e653429ca3d115be6b11e864434694bc6f5a09d7eef62549bae24cc2

data/lib/soundyoink/audio.rb

@@ -1,9 +1,14 @@
 module Soundyoink
+
+  # Represents an audio post; given only a link, can name the file intelligently
+  # and write it to disk, as well as check whether the file has already been
+  # downloaded.
   class Audio
+
+    # Drawing the title from the URL is a little uglier than drawing it from
+    # the page text itself, but lets us skip files we already have without
+    # having to request the page. This saves a ton of time on user profiles.
     def initialize(url)
-      # Drawing the title from the URL is a little uglier than drawing it from
-      # the page text itself, but lets us skip files we already have without
-      # having to request the page. This saves a ton of time on user profiles.
       user = url.match(%r{\/u\/(.+)\/})[1]
       title = url.match(%r{\/u\/.+\/(.+)})[1]
       @filename = "#{user} - #{title}.m4a"
@@ -12,6 +17,8 @@ module Soundyoink
       end
     end
 
+    # Writes the file to disk (in the form _author - title.m4a_) unless
+    # it already exists and is over 10 KB.
     def download
       return nil if already_exists?
       puts "Downloading #{@filename}..." if $stdout.isatty
@@ -20,9 +27,10 @@ module Soundyoink
       end
     end
 
+    # Check that not only does the file exist, but that it is over 10 KB, so
+    # that we can overwrite files that were opened but never written properly.
+    # @return [Boolean]
     def already_exists?
-      # We check that not only does the file exist, but that it is over 10 KB,
-      # so that we overwrite files that were opened but never written properly.
       File.exist?(@filename) && File.size(@filename) > 10_000
     end
   end

data/lib/soundyoink/downloader.rb

@@ -1,14 +1,19 @@
 module Soundyoink
+
+  # Manages a queue of Audio instances to be downloaded, and knows how to
+  # create many Audio instances from a user profile link.
   class Downloader
+
+    # @param workers [Integer] Number of threads to use to work the download queue.
     def initialize(workers: 2)
-      # +workers+ will be the number of threads downloading audios in parallel.
       @audios = Queue.new
       @workers = workers
     end
 
+    # If given a link to an audio page, adds it to the queue.
+    # If given a user profile link, adds each individual audio to the queue.
+    # @param link [String] Link to either an individual audio or a user profile.
     def add(link)
-      # If we were given a user profile link, we'll pass it to the +add_profile+
-      # method.
       if link =~ %r{^https://.+[.net]/u/[^/]+$}
         add_profile(link)
       else
@@ -16,15 +21,17 @@ module Soundyoink
       end
     end
 
+    # Find every audio link on a user's profile and add them to the queue.
+    # @param profile [String] Link to a user's profile page.
     def add_profile(profile)
-      # Find every audio link on a user's profile and add them to the queue.
-      open(profile).read.scan(%r{(https://[^.]+[.]net/u/[^"]+)}).flatten.each do |audio|
+      open(profile).read.scan(%r{(https://[^.]+[.]net/u/[^"]+)}).flat_map do |audio|
         @audios << Audio.new(audio)
       end
     end
 
+    # +@workers+ number of threads work on the +@audios+ queue in parallel.
+    # @see Soundyoink::Audio#download
     def download
-      # +@workers+ number of threads work on the +@audios+ queue in parallel.
       worker_threads = []
       @workers.times do
         worker_threads << Thread.new do
@@ -33,5 +40,7 @@ module Soundyoink
       end
       worker_threads.map(&:join)
     end
+
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soundyoink
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ryan Plant
@@ -34,7 +34,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -47,3 +47,4 @@ signing_key:
 specification_version: 4
 summary: SG audio downloader.
 test_files: []
+has_rdoc: