wgif 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29562cbe754b572ffd1fc5e20a397b96405a703b
+  data.tar.gz: 3c7307a0a239c7867d2d6a205c14153e8b7c44f3
+SHA512:
+  metadata.gz: 5953cef31a710c37e9d99e229673005c4737f20952150b398a678088b45ee67b61835d5311a1271a0aaae454b9299de2e3c1253efd135bdcc3b9ed65c22024b1
+  data.tar.gz: bfb4c0a042e3baefaca3f35621787041e0870f4c98a2cfba4cac5cb4e4cb0ec939a6b8ee941d1752588268cc3b748a8ac8fb38ea4b9c110363179e72e50f2ee5

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+install:
+  - sudo apt-get update
+  - sudo apt-get install ffmpeg
+  - sudo apt-get install imagemagick
+  - bundle install
+command: bundle exec rake
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/Brewfile

@@ -0,0 +1,2 @@
+install ffmpeg
+install imagemagick

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wgif.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Connor Mendenhall
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# WGif
+![Travis Build](https://travis-ci.org/ecmendenhall/wgif.png?branch=master)
+
+WGif is a command line tool for creating animated GIFs from YouTube videos.
+
+##TL;DR
+```
+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)
+    -w, --width pixels        Width of the gif in pixels. (Default 480px)
+
+Example:
+
+    $ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif -s 00:03:30 -d 2 -w 400
+```
+
+## Installation (Mac OS X)
+To install from Rubygems:
+
+```sh
+$ gem install wgif
+```
+
+To install from source, run
+
+```sh
+$ gem build wgif.gemspec
+```
+
+and
+
+```sh
+$ gem install wgif-0.0.1.pre.gem
+```
+
+to install the executable.
+
+WGif uses FFmpeg for video transcoding and ImageMagick to optimize GIFs.
+To install dependencies with [Homebrew](http://brew.sh/), just run
+
+```sh
+$ wgif install
+```
+
+## Making a GIF
+WGif expects two arguments: a YouTube video URL and a name for the GIF it creates. So,
+
+```sh
+$ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif
+```
+
+Is enough to create a GIF of [Bjork explaining her television](https://www.youtube.com/watch?v=1A78yTvIY1k). Without any extra parameters, WGif starts at
+the beginning of the video, and creates a 20-frame, 480px GIF of the first second. Since GIFs are more
+art than science, you'll probably want to tweak the size, duration, and number of frames.
+
+Start by isolating the section of the video you'd like to GIF. Bjork starts her advice about dishonest
+Icelandic poets around 3 minutes 30 seconds, and it lasts about two seconds. Pass the start timestamp with
+`-s` or `--start` and the duration with `-d` or `--duration`:
+
+```sh
+$ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif --start 00:03:30 -d 2
+```
+
+A good start, but the GIF is way too big: around 5.6 megabytes. We can pass `-f` or `--frames` to specify the
+total number of frames in the finished GIF. This defaults to 20, so let's drop a few to reduce the file size:
+
+```sh
+$ 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:
+
+```sh
+$ wgif https://www.youtube.com/watch?v=1A78yTvIY1k bjork.gif --start 00:03:30 -d 2 -f 18 --width 350
+```
+
+And here it is:
+
+![Bjork](http://i.imgur.com/NZXWwey.gif)
+### "You shouldn't let poets lie to you."
+
+## Contributions
+Are welcome via pull request.
+
+## License
+This project is MIT licensed. See [LICENSE.txt](https://github.com/ecmendenhall/wgif/blob/master/LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/wgif

@@ -0,0 +1,4 @@
+#!/usr/bin/env/ruby
+
+require 'wgif/cli'
+WGif::CLI.new.make_gif ARGV

data/lib/wgif.rb

@@ -0,0 +1,9 @@
+require "wgif/cli"
+require "wgif/download_bar"
+require "wgif/downloader"
+require "wgif/exceptions"
+require "wgif/gif_maker"
+require "wgif/installer"
+require "wgif/version"
+require "wgif/video"
+require "wgif/video_cache"

data/lib/wgif/cli.rb

@@ -0,0 +1,125 @@
+require 'optparse'
+require 'wgif/exceptions'
+require 'wgif/downloader'
+require 'wgif/gif_maker'
+require 'wgif/installer'
+
+module WGif
+  class CLI
+
+    attr_accessor :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_tail('-h',
+                     '--help',
+                     'Print help information.') {
+                       print_help
+                       exit
+                     }
+      end
+    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(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]
+    end
+
+    def make_gif(cli_args)
+      WGif::Installer.new.run if cli_args[0] == 'install'
+      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])
+      end
+    end
+
+    private
+
+    def rescue_errors
+      begin
+        yield
+      rescue WGif::InvalidUrlException
+        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."
+      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."
+      rescue SystemExit => e
+        raise e
+      rescue Exception => e
+        print_error <<-error
+Something went wrong creating your GIF. The details:
+
+#{e}
+#{e.backtrace.join("\n")}
+
+Please open an issue at: https://github.com/ecmendenhall/wgif/issues/new
+error
+      end
+    end
+
+    def print_error(message)
+      puts message, "\n"
+      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

@@ -0,0 +1,28 @@
+require 'ruby-progressbar'
+
+module WGif
+  class DownloadBar
+
+    FORMAT = '==> %p%% |%B|'
+    SMOOTHING = 0.8
+
+    attr_reader :progress_bar
+
+    def initialize
+      @progress_bar = ProgressBar.create(
+        format: FORMAT,
+        smoothing: SMOOTHING,
+        total: @size
+      )
+    end
+
+    def update_total(size)
+      @progress_bar.total = size
+    end
+
+    def increment_progress(size)
+      @progress_bar.progress += size
+    end
+
+  end
+end

data/lib/wgif/downloader.rb

@@ -0,0 +1,84 @@
+require 'viddl-rb'
+require 'typhoeus'
+require 'wgif/download_bar'
+require 'wgif/exceptions'
+require 'wgif/video'
+require 'wgif/video_cache'
+require 'uri'
+require 'cgi'
+
+module WGif
+  class Downloader
+
+    def initialize
+      @cache = WGif::VideoCache.new
+    end
+
+    def video_url youtube_url
+      begin
+        urls = ViddlRb.get_urls(youtube_url)
+        urls.first
+      rescue
+        raise WGif::VideoNotFoundException
+      end
+    end
+
+    def video_id youtube_url
+      begin
+        uri = URI(youtube_url)
+        params = CGI.parse(uri.query)
+        params['v'].first
+      rescue
+        raise WGif::InvalidUrlException
+      end
+    end
+
+    def get_video youtube_url
+      id = video_id youtube_url
+      if cached_clip = @cache.get(id)
+        return cached_clip
+      else
+        temp = load_clip(id, youtube_url)
+        video = WGif::Video.new(id, temp.path)
+        video
+      end
+    end
+
+    private
+
+    def create_progress_bar request, output_file
+      size = nil
+      download_bar = WGif::DownloadBar.new
+
+      request.on_headers do |response|
+        size = response.headers['Content-Length'].to_i
+        download_bar.update_total(size)
+      end
+
+      request.on_body do |chunk|
+          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
+      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"
+      temp = File.open("/tmp/wgif/#{id}", 'wb')
+      begin
+        clip = request_clip(youtube_url, temp)
+        raise WGif::VideoNotFoundException unless clip.response_code == 200
+      ensure
+        temp.close
+      end
+      temp
+    end
+
+  end
+end

data/lib/wgif/exceptions.rb

@@ -0,0 +1,24 @@
+module WGif
+
+  class InvalidUrlException < Exception
+  end
+
+  class InvalidTimestampException < Exception
+  end
+
+  class InvalidDurationException < Exception
+  end
+
+  class InvalidFramesException < Exception
+  end
+
+  class MissingOutputFileException < Exception
+  end
+
+  class VideoNotFoundException < Exception
+  end
+
+  class ClipEncodingException < Exception
+  end
+
+end