wgif 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c2b920dfa55567f79e781514cdbec115e06c044
-  data.tar.gz: 9e8dea99fdfd3f316538be45f6f5508e77470aed
+  metadata.gz: eda7edccc313c6f58f2bb806200b69011f1904c1
+  data.tar.gz: a2197e273c936b595a8b498e0c43deb43527ef23
 SHA512:
-  metadata.gz: 2eeab9f6ee176bf8b412f72a722dfd9dcc8156107f760591602465a63bbee4f86dc8ae0ad7ba3d7c9c1ddbd0d282b763015eb5ba060ed61d8116be542811b9a5
-  data.tar.gz: e5c3125c238f0b92b25531371287170b87084ee7e80392521c32134f4c4e8082f03fd6a9bcee811f6bae6115b423310be3fd46fce64aacca6975d3b52310634a
+  metadata.gz: e08a6c50358d79233771a2202991d0ed46eeffdfe723911b95dc97880a8583a407c62e7d3a24a15cb8aa53b9e7eb91d824e7c94e4b8717bf5c935f645525c92e
+  data.tar.gz: d8af1629380d458440a01bd496310bffc597892ec3f68b0ebdec8cc7af2712241b9ffb833ac4f93577a232a06a99382bf36c0f1b3d39de32cf3e527f3676ba33

data/.travis.yml

@@ -4,6 +4,7 @@ install:
   - sudo apt-get install ffmpeg
   - sudo apt-get install imagemagick
   - bundle install
+env: 'CODECLIMATE_REPO_TOKEN=8849fed07a5273771df2257c579724d8eef91699fa482cf212afd1d2607a85fa'
 command: bundle exec rake
 rvm:
   - 2.1.0

data/README.md

@@ -1,5 +1,6 @@
 # WGif
 [![Build Status](https://travis-ci.org/ecmendenhall/wgif.svg?branch=master)](https://travis-ci.org/ecmendenhall/wgif)
+[![Code Climate](https://codeclimate.com/github/ecmendenhall/wgif.png)](https://codeclimate.com/github/ecmendenhall/wgif)
 
 WGif is a command line tool for creating animated GIFs from YouTube videos.
 
@@ -7,11 +8,13 @@ WGif is a command line tool for creating animated GIFs from YouTube videos.
 ```
 Usage: wgif [YouTube URL] [output file] [options]
 
-    -f, --frames N            Number of frames in the final gif. (Default 20)
-    -s, --start HH:MM:SS      Start creating gif from input video at this timestamp. (Default 00:00:00)
-    -d, --duration seconds    Number of seconds of input video to capture. (Default 1)
-    -u, --upload              Upload finished GIF to Imgur
-    -w, --width pixels        Width of the gif in pixels. (Default 480px)
+    -f, --frames N          Number of frames in the final gif. (Default 20)
+    -s, --start HH:MM:SS    Start creating gif from input video at this timestamp. (Default 00:00:00)
+    -d, --duration seconds  Number of seconds of input video to capture. (Default 1)
+    -w, --width pixels      Width of the gif in pixels. (Default 480px)
+    -u, --upload            Upload finished gif to Imgur
+    -p, --preview           Preview finished gif with Quick Look
+    -h, --help              Print help information.
 
 Example:
 
@@ -34,7 +37,7 @@ $ gem build wgif.gemspec
 and
 
 ```sh
-$ gem install wgif-0.2.0.gem
+$ gem install wgif-0.3.0.gem
 ```
 
 to install the executable.
@@ -72,14 +75,24 @@ total number of frames in the finished GIF. This defaults to 20, so let's drop a
 $ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif --start 00:03:30 -d 2 -f 18
 ```
 
-Down to 2.2 megabytes, but still not small enough to post on my Sugarcubes fan-Tumblr. Let's scale it down a little
-with the `-w` or `--width` flag:
+To preview the output in a Quick Look window, add the `--preview` flag:
+
+```sh
+$ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif --start 00:03:30 -d 2 -f 18 --preview
+```
+
+You'll see a preview pop up in a Quick Look window like this one:
+
+![Preview](http://i.imgur.com/cccOnpY.png)
+
+Dropping frames shrunk the file to 2.2 megabytes, but it's still not small enough to post on my Sugarcubes fan-Tumblr.
+Let's scale it down a little with the `-w` or `--width` flag:
 
 ```sh
 $ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif --start 00:03:30 -d 2 -f 18 --width 350
 ```
 
-And finally, now that everything's completed add the `--upload` flag to automatically post it to Imgur:
+And finally, now that everything's completed, let's add the `--upload` flag to automatically post it to Imgur:
 
 ```sh
 $ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif --start 00:03:30 -d 2 -f 18 --width 350 --upload
@@ -88,12 +101,16 @@ Finished. GIF uploaded to Imgur at http://i.imgur.com/iA28DuR.gif
 
 And here it is:
 
-![Bjork](http://i.imgur.com/iA28DUR.gif)
+![Bjork](http://i.imgur.com/iA28DuR.gif)
 ### "You shouldn't let poets lie to you."
 
 ## Changes
+- v0.3.0, 2014/4/20: Add Quick Look preview with `--preview` flag.
 - v0.2.0, 2014/4/11: Add automatic upload to Imgur with `--upload` flag.
 
+## Contributors
+Thanks to [arlandism](https://github.com/arlandism) and [ellie007](https://github.com/ellie007) for pairing on Imgur uploads.
+
 ## Contributions
 Are welcome via pull request.
 

data/Rakefile

@@ -1,5 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
+  unless task_args[:tag] == 'integration'
+    t.rspec_opts = "--tag ~integration"
+  end
+end
+
+task default: :spec

data/lib/wgif.rb

@@ -1,10 +1,10 @@
-require "wgif/cli"
-require "wgif/download_bar"
-require "wgif/downloader"
-require "wgif/exceptions"
-require "wgif/gif_maker"
-require "wgif/installer"
-require "wgif/uploader"
-require "wgif/version"
-require "wgif/video"
-require "wgif/video_cache"
+require 'wgif/cli'
+require 'wgif/download_bar'
+require 'wgif/downloader'
+require 'wgif/exceptions'
+require 'wgif/gif_maker'
+require 'wgif/installer'
+require 'wgif/uploader'
+require 'wgif/version'
+require 'wgif/video'
+require 'wgif/video_cache'

data/lib/wgif/argument_parser.rb

@@ -0,0 +1,94 @@
+require 'optparse'
+require 'wgif/exceptions'
+
+module WGif
+  class ArgumentParser
+
+    URL = %r{\Ahttps?://.*\z}
+    TIMESTAMP = /\A\d{1,2}(?::\d{2})+(?:\.\d*)?\z/
+
+    def initialize
+      @options = {}
+      @defaults = {
+        trim_from: '00:00:00',
+        duration: 1.0,
+        dimensions: '480'
+      }
+      @parser = OptionParser.new do |opts|
+        opts.on('-f N',
+                '--frames N',
+                'Number of frames in the final gif. (Default 20)') {
+          |n|  @options[:frames] = n.to_i
+        }
+        opts.on('-s HH:MM:SS',
+                '--start HH:MM:SS',
+                'Start creating gif from input video at this timestamp. (Default 00:00:00)') {
+          |ts| @options[:trim_from] = ts
+        }
+        opts.on('-d seconds',
+                '--duration seconds',
+                'Number of seconds of input video to capture. (Default 1)') {
+          |d|  @options[:duration] = d.to_f
+        }
+        opts.on('-w pixels',
+                '--width pixels',
+                'Width of the gif in pixels. (Default 480px)') {
+          |gs| @options[:dimensions] = gs
+        }
+        opts.on('-u',
+                '--upload',
+                'Upload finished gif to Imgur') {
+          |u| @options[:upload] = u
+        }
+        opts.on('-p',
+                '--preview',
+                'Preview finished gif with Quick Look') {
+          |p| @options[:preview] = p
+        }
+        opts.on_tail('-h',
+                     '--help',
+                     'Print help information.') {
+          print_help
+          exit
+        }
+      end
+    end
+
+    def parse(args)
+      options = parse_args(args)
+      validate_args(options)
+      options
+    end
+
+    def argument_summary
+      @parser.summarize
+    end
+
+    def parse_args(args)
+      options = @defaults.merge(parse_options args)
+      options.merge(url: args[0], output: args[1])
+    end
+
+    def parse_options(args)
+      @parser.parse! args
+      @options
+    end
+
+    def validate_args(args)
+      fail WGif::InvalidUrlException unless args[:url] =~ URL
+      fail WGif::InvalidTimestampException unless args[:trim_from] =~ TIMESTAMP
+      fail WGif::MissingOutputFileException unless args[:output]
+    end
+
+    def print_help
+      puts 'Usage: wgif [YouTube URL] [output file] [options]', "\n"
+      puts argument_summary, "\n"
+      puts <<-example
+Example:
+
+    $ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif -s 00:03:30 -d 2 -w 400 --upload
+
+      example
+    end
+  end
+end

data/lib/wgif/cli.rb

@@ -1,114 +1,70 @@
-require 'optparse'
+require 'wgif/argument_parser'
 require 'wgif/exceptions'
 require 'wgif/installer'
 
 module WGif
   class CLI
 
-    attr_accessor :parser
+    attr_accessor :argument_parser
 
     def initialize
-      @options = {}
-      @defaults = {
-        trim_from: '00:00:00',
-        duration: 1.0,
-        dimensions: '480'
-      }
-      @parser = OptionParser.new do |opts|
-        opts.on('-f N',
-                '--frames N',
-                'Number of frames in the final gif. (Default 20)') {
-                  |n|  @options[:frames] = n.to_i
-                }
-        opts.on('-s HH:MM:SS',
-                '--start HH:MM:SS',
-                'Start creating gif from input video at this timestamp. (Default 00:00:00)') {
-                  |ts| @options[:trim_from] = ts
-                }
-        opts.on('-d seconds',
-                '--duration seconds',
-                'Number of seconds of input video to capture. (Default 5)') {
-                  |d|  @options[:duration] = d.to_f
-                }
-        opts.on('-w pixels',
-                '--width pixels',
-                'Width of the gif in pixels. (Default 500px)') {
-                  |gs| @options[:dimensions] = gs
-                }
-        opts.on('-u',
-                '--upload',
-                'Upload finished GIF to Imgur') {
-                  |u| @options[:upload] = !!u
-                }
+      @argument_parser = WGif::ArgumentParser.new
+    end
 
-        opts.on_tail('-h',
-                     '--help',
-                     'Print help information.') {
-                       print_help
-                       exit
-                     }
+    def make_gif(cli_args)
+      WGif::Installer.new.run if cli_args[0] == 'install'
+      load_dependencies
+      rescue_errors do
+        args = @argument_parser.parse(cli_args)
+        frames = convert_video(args)
+        GifMaker.new.make_gif(frames, args[:output], args[:dimensions])
+        upload(args)  if args[:upload]
+        preview(args) if args[:preview]
       end
     end
 
-    def parse_args(args)
-      options = @defaults.merge(parse_options args)
-      options.merge(url: args[0], output: args[1])
+    private
+
+    def preview(args)
+      Kernel.system "qlmanage -p #{args[:output]} &>/dev/null"
     end
 
-    def parse_options(args)
-      @parser.parse! args
-      @options
+    def upload(args)
+      url = Uploader.new('d2321b02db7ba15').upload(args[:output])
+      puts "Finished. GIF uploaded to Imgur at #{url}"
     end
 
-    def validate_args(parsed_args)
-      raise WGif::InvalidUrlException unless parsed_args[:url] =~ /\Ahttps?\:\/\/.*\z/
-      raise WGif::InvalidTimestampException unless parsed_args[:trim_from] =~ /\A\d{1,2}(?::\d{2})+(?:\.\d*)?\z/
-      raise WGif::MissingOutputFileException unless parsed_args[:output]
+    def convert_video(args)
+      video = Downloader.new.get_video(args[:url])
+      clip = video.trim(args[:trim_from], args[:duration])
+      clip.to_frames(frames: args[:frames])
     end
 
-    def make_gif(cli_args)
-      WGif::Installer.new.run if cli_args[0] == 'install'
+    def load_dependencies
       require 'wgif/downloader'
       require 'wgif/gif_maker'
       require 'wgif/uploader'
-      rescue_errors do
-        args = parse_args cli_args
-        validate_args(args)
-        video = Downloader.new.get_video(args[:url])
-        clip = video.trim(args[:trim_from], args[:duration])
-        frames = clip.to_frames(frames: args[:frames])
-        GifMaker.new.make_gif(frames, args[:output], args[:dimensions])
-        if args[:upload]
-          url = Uploader.new('d2321b02db7ba15').upload(args[:output])
-          puts "Finished. GIF uploaded to Imgur at #{url}"
-        end
-      end
     end
 
-    private
-
     def rescue_errors
-      begin
-        yield
+      yield
       rescue WGif::InvalidUrlException
-        print_error "That looks like an invalid URL. Check the syntax."
+        print_error 'That looks like an invalid URL. Check the syntax.'
       rescue WGif::InvalidTimestampException
-        print_error "That looks like an invalid timestamp. Check the syntax."
+        print_error 'That looks like an invalid timestamp. Check the syntax.'
       rescue WGif::MissingOutputFileException
         print_error 'Please specify an output file.'
       rescue WGif::VideoNotFoundException
         print_error "WGif can't find a valid YouTube video at that URL."
       rescue WGif::ClipEncodingException
-        print_error "WGif encountered an error transcoding the video."
+        print_error 'WGif encountered an error transcoding the video.'
       rescue WGif::ImgurException => e
         print_error <<-error
 WGif couldn't upload your GIF to Imgur. The Imgur error was:
 
 #{e}
 error
-      rescue SystemExit => e
-        raise e
-      rescue Exception => e
+      rescue StandardError => e
         print_error <<-error
 Something went wrong creating your GIF. The details:
 
@@ -117,25 +73,13 @@ Something went wrong creating your GIF. The details:
 
 Please open an issue at: https://github.com/ecmendenhall/wgif/issues/new
 error
-      end
     end
 
     def print_error(message)
       puts message, "\n"
-      print_help
+      @argument_parser.print_help
       exit 1
     end
 
-    def print_help
-      puts "Usage: wgif [YouTube URL] [output file] [options]", "\n"
-      puts @parser.summarize, "\n"
-      puts <<-example
-Example:
-
-    $ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif -s 00:03:30 -d 2 -w 400
-
-      example
-    end
-
   end
 end

data/lib/wgif/download_bar.rb

@@ -23,6 +23,5 @@ module WGif
     def increment_progress(size)
       @progress_bar.progress += size
     end
-
   end
 end

data/lib/wgif/downloader.rb

@@ -14,29 +14,26 @@ module WGif
       @cache = WGif::VideoCache.new
     end
 
-    def video_url youtube_url
-      begin
-        urls = ViddlRb.get_urls(youtube_url)
-        urls.first
-      rescue
-        raise WGif::VideoNotFoundException
-      end
+    def video_url(youtube_url)
+      urls = ViddlRb.get_urls(youtube_url)
+      urls.first
+    rescue
+      raise WGif::VideoNotFoundException
     end
 
-    def video_id youtube_url
-      begin
-        uri = URI(youtube_url)
-        params = CGI.parse(uri.query)
-        params['v'].first
-      rescue
-        raise WGif::InvalidUrlException
-      end
+    def video_id(youtube_url)
+      uri = URI(youtube_url)
+      params = CGI.parse(uri.query)
+      params['v'].first
+    rescue
+      raise WGif::InvalidUrlException
     end
 
-    def get_video youtube_url
+    def get_video(youtube_url)
       id = video_id youtube_url
-      if cached_clip = @cache.get(id)
-        return cached_clip
+      cached_clip = @cache.get(id)
+      if cached_clip
+        cached_clip
       else
         temp = load_clip(id, youtube_url)
         video = WGif::Video.new(id, temp.path)
@@ -46,7 +43,7 @@ module WGif
 
     private
 
-    def create_progress_bar request, output_file
+    def create_progress_bar(request, output_file)
       size = nil
       download_bar = WGif::DownloadBar.new
 
@@ -56,29 +53,28 @@ module WGif
       end
 
       request.on_body do |chunk|
-          output_file.write(chunk)
-          download_bar.increment_progress(chunk.size)
+        output_file.write(chunk)
+        download_bar.increment_progress(chunk.size)
       end
     end
 
-    def request_clip youtube_url, output_file
-      clip_url = self.video_url youtube_url
+    def request_clip(youtube_url, output_file)
+      clip_url = video_url(youtube_url)
       request = Typhoeus::Request.new clip_url
       create_progress_bar(request, output_file)
       request.run
     end
 
-    def load_clip id, youtube_url
-      FileUtils.mkdir_p "/tmp/wgif"
+    def load_clip(id, youtube_url)
+      FileUtils.mkdir_p '/tmp/wgif'
       temp = File.open("/tmp/wgif/#{id}", 'wb')
       begin
         clip = request_clip(youtube_url, temp)
-        raise WGif::VideoNotFoundException unless clip.response_code == 200
+        fail WGif::VideoNotFoundException unless clip.response_code == 200
       ensure
         temp.close
       end
       temp
     end
-
   end
 end