reddit_image_downloader 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brendan Loudermilk
+
+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,109 @@
+# RedditImageDownloader
+
+RedditImageDownloader is a command line tool written in Ruby for downloading
+images from any subreddit on reddit.com.
+
+## Installation
+
+The tool is available on RubyGems:
+
+    $ gem install reddit_image_downloader
+
+## Usage
+
+Use the `reddit_image_downloader` command to download images. Specify one or
+more of the options below to customize your query.
+
+    $ reddit_image_downloader [options]
+
+### Specifying subreddit(s)
+
+You must use `--subreddits` (shorthand `-r`) to specify one or more subreddits
+as a comma-separated list. The following example will download the top images
+[/r/EarthPorn][earthporn] and [/r/awww][awww].
+
+    $ reddit_image_downloader -r EarthPorn,awww
+
+### Downloading to a specific path
+
+By default, the command will download all images into the current working
+directory of your shell. You can override this behavior with the
+`--destination` (shorthand `-d`) option. The following example will download
+images from [/r/Earthporn][earthporn] to your desktop.
+
+    $ reddit_image_downloader -r EarthPorn -d ~/Desktop
+
+### Requiring minimum dimensions
+
+You may choose to only download images which meet minimum width and height
+requirements with the `--min-width` (shorthand `-x`) and `--min-height`
+(shorthand `-y`) options respectively. The following example will download
+images from [/r/EarthPorn][earthporn] *only* if they are 1920x1080.
+
+    $ reddit_image_downloader -r EarthPorn -x 1920 -y 1080
+
+You may choose to only specify one dimension, as well.
+
+    $ reddit_image_downloader -r EarthPorn -y 1080
+
+### Choosing a page
+
+You may choose to download images from either one the of "top" (default),
+"new", or "controversial" pages with the `--page` (shorthand `-p`) option. The
+following example will download new images from [/r/awww][awww].
+
+    $ reddit_image_downloader -r awww -p new
+
+### Purging old images
+
+The initial use case for this tool was to manage a folder for wallpaper
+images. The `--max-age` (shorthand `-a`) option can be used to purge images
+older than a specified number of days. The following example will download
+images from [/r/awww][awww] then delete any images that were downloaded more
+than 14 days ago.
+
+    $ reddit_image_downloader -r awww -a 14
+
+### Need help?
+
+You can use the `--help` (shorthand `-h`) option to see a list of all the
+available options and a short description of each. The following example shows
+the help message:
+
+    $ reddit_image_downloader -h
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[earthporn]: http://reddit.com/r/EarthPorn
+[awww]: http://reddit.com/r/awww
+
+## License
+
+Copyright (c) 2013 Brendan Loudermilk
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/reddit_image_downloader

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "reddit_image_downloader"
+
+RedditImageDownloader::Processor.process!(
+  RedditImageDownloader::OptionParser.parse(ARGV)
+)

data/lib/reddit_image_downloader.rb

@@ -0,0 +1,21 @@
+# Stdlib
+require "optparse"
+require "ostruct"
+
+# Gems
+require "snoo"
+require "mechanize"
+require "dimensions"
+
+# Development Gems
+if ENV["DEV"]
+  require "pry"
+end
+
+# Self
+require "reddit_image_downloader/version"
+require "reddit_image_downloader/option_parser"
+require "reddit_image_downloader/processor"
+
+module RedditImageDownloader
+end

data/lib/reddit_image_downloader/option_parser.rb

@@ -0,0 +1,78 @@
+module RedditImageDownloader
+  module OptionParser
+    PAGES = %W[top new controversial]
+
+    DEFAULT_OPTIONS = {
+      show_help: false,
+      subreddits: [],
+      min_width: 0,
+      min_height: 0,
+      destination: Dir.pwd,
+      max_age: nil,
+      page: :top,
+    }
+
+    BANNER = "Usage: reddit_image_downloader [options]"
+
+    SUBREDDIT_FORMATS = %W[-r --subreddits=SUB1,SUB2]
+    SUBREDDIT_DESC = "List of subreddits to download from"
+
+    PATH_FORMATS = %W[-d --destination=PATH]
+    PATH_DESC = "Path to download images to (defaults to current directory)"
+
+    WIDTH_FORMATS = %W[-x --min-width=WIDTH]
+    WIDTH_DESC = "Only download images at least WIDTH wide"
+
+    HEIGHT_FORMATS = %W[-y --min-height=HEIGHT]
+    HEIGHT_DESC = "Only download images at least HEIGHT tall"
+
+    PAGE_FORMATS = %W[-p --page=PAGE]
+    PAGE_DESC = "Page to download (top [default], new, controversial)"
+
+    DAYS_FORMATS = %W[-a --max-age=DAYS]
+    DAYS_DESC = "Purge files in destination folder older than DAYS days"
+
+    HELP_FORMATS = %W[-h --help]
+    HELP_DESC = "Show this message"
+
+    def self.parse(args)
+      options = DEFAULT_OPTIONS.dup
+
+      parser = ::OptionParser.new do |parser|
+        parser.banner = BANNER
+
+        parser.on(*SUBREDDIT_FORMATS, Array, SUBREDDIT_DESC) do |subreddits|
+          options[:subreddits] += subreddits
+        end
+
+        parser.on(*PATH_FORMATS, PATH_DESC) do |destination|
+          options[:destination] = destination
+        end
+
+        parser.on(*WIDTH_FORMATS, Integer, WIDTH_DESC) do |min_width|
+          options[:min_width] = min_width
+        end
+
+        parser.on(*HEIGHT_FORMATS, Integer, HEIGHT_DESC) do |min_height|
+          options[:min_height] = min_height
+        end
+
+        parser.on(*PAGE_FORMATS, PAGES, PAGE_DESC) do |page|
+          options[:page] = page
+        end
+
+        parser.on(*DAYS_FORMATS, Integer, DAYS_DESC) do |days|
+          options[:max_age] = days
+        end
+
+        parser.on_tail(*HELP_FORMATS, HELP_DESC) do
+          options[:show_help] = true
+        end
+      end
+
+      parser.parse!(args)
+
+      options
+    end
+  end
+end

data/lib/reddit_image_downloader/processor.rb

@@ -0,0 +1,59 @@
+module RedditImageDownloader
+  class Processor < Struct.new(:options)
+    def self.process!(options)
+      new(options).process!
+    end
+
+    def process!
+      listings.each do |listing|
+        download = agent.get(listing["url"])
+
+        if download.is_a?(Mechanize::Image)
+          reader = Dimensions::Reader.new
+
+          reader << download.body
+
+          if reader.width > options[:min_width] && reader.height > options[:min_height]
+            filename = "#{listing["id"]}.#{reader.type}"
+            destination = File.join(options[:destination], filename)
+
+            unless File.exists?(destination)
+              download.save(destination)
+            end
+          end
+        end
+      end
+
+      if options[:max_age]
+        file_query = File.join(options[:destination], "*")
+
+        Dir[file_query].each do |file|
+          age = Time.now - File.ctime(file)
+          days_old = age / (24 * 3600)
+
+          if days_old > options[:max_age]
+            File.delete(file)
+          end
+        end
+      end
+    end
+
+    private
+
+    def listings
+      options[:subreddits].map do |subreddit|
+        client.get_listing(subreddit: subreddit, page: options[:page]).parsed_response["data"]["children"]
+      end.flatten.map do |listing|
+        listing["data"]
+      end
+    end
+
+    def client
+      @client ||= Snoo::Client.new
+    end
+
+    def agent
+      @agent ||= Mechanize.new
+    end
+  end
+end

data/lib/reddit_image_downloader/version.rb

@@ -0,0 +1,3 @@
+module RedditImageDownloader
+  VERSION = "0.0.1"
+end

data/reddit_image_downloader.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reddit_image_downloader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reddit_image_downloader"
+  spec.version       = RedditImageDownloader::VERSION
+  spec.authors       = ["Brendan Loudermilk"]
+  spec.email         = ["brendan@gophilosophie.com"]
+  spec.description   = %q{Download images from Reddit}
+  spec.summary       = %q{Download images from Reddit}
+  spec.homepage      = "https://github.com/bloudermilk/reddit_image_downloader"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry", "~> 0.9.12.2"
+
+  spec.add_dependency "snoo", "~> 0.1.2"
+  spec.add_dependency "mechanize", "~> 2.7.2"
+  spec.add_dependency "dimensions", "~> 1.2.0"
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: reddit_image_downloader
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Brendan Loudermilk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  type: :development
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+    none: false
+  type: :development
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+    none: false
+  type: :runtime
+  name: snoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+    none: false
+  type: :runtime
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+    none: false
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    none: false
+  type: :runtime
+  name: dimensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    none: false
+description: Download images from Reddit
+email:
+- brendan@gophilosophie.com
+executables:
+- reddit_image_downloader
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/reddit_image_downloader
+- lib/reddit_image_downloader.rb
+- lib/reddit_image_downloader/option_parser.rb
+- lib/reddit_image_downloader/processor.rb
+- lib/reddit_image_downloader/version.rb
+- reddit_image_downloader.gemspec
+homepage: https://github.com/bloudermilk/reddit_image_downloader
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Download images from Reddit
+test_files: []