etfc 1.0.0

data/lib/etfc/cli.rb

@@ -0,0 +1,32 @@
+require 'thor'
+require 'etfc'
+
+module ETFC
+  class CLI < Thor
+    desc 'collage [filename]', 'create a collage for keywords'
+    long_desc <<-LONG
+    ETFC is your friendly flickr collage creator.
+
+    You give it a few keywords like 'butter', 'rick sanchez' and 'purpose';
+    ETFC will then go and fetch the most interesting related pictures from
+    flickr and create a collage of 5x2 images.  You can supply as many keywords
+    as you wish, however only ten images will be displayed in the collage. If
+    you supply less than ten words, random words will be taken from the
+    dictionary.
+
+    Example usage:
+
+    etfc collage best_collage_ever.jpg --keywords=butter 'rick sanchez' purpose
+    LONG
+    option :keywords, type: :array, required: true
+    def collage(result = 'collage.jpg')
+      ETFC::Runner.run(options[:keywords], result)
+    rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+           EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
+           Net::ProtocolError, Errno::ECONNREFUSED
+      puts 'There was a problem with the network connection. Please check ' \
+           'your network and try again.'
+      exit 1
+    end
+  end
+end

data/lib/etfc/collage.rb

@@ -0,0 +1,35 @@
+require 'rmagick'
+
+module ETFC
+  module Collage
+    module_function
+
+    # Public: Creates a collage of 10 images in a 5x2 grid
+    #
+    # imgs   - array of 10 images (paths to the images)
+    # output - name of the resulting collage
+    #
+    # Examples:
+    #
+    #  create(['1.jpg', '2.jpg', ...], 'collage.jpg')
+    #  #=> 'Magick::ImageList...'
+    #
+    # Returns Magick::ImageList, can be discarded. The resulting collage will
+    # be written to the provided file name.
+    def create(imgs, output)
+      list = Magick::ImageList.new
+      imgs.each do |img|
+        list << Magick::Image.read(img)[0]
+      end
+
+      # https://rmagick.github.io/ilist.html#montage
+      montage = list.montage do
+        self.geometry = Magick::Geometry.new(300, 300)
+        self.tile = '5x2'
+        self.stroke = 'transparent'
+      end
+
+      montage.write(output)
+    end
+  end
+end

data/lib/etfc/dictionary.rb

@@ -0,0 +1,59 @@
+module ETFC
+  class Dictionary
+    def initialize
+      init
+    end
+
+    # Private: Memorize 20 words from the system dictionary
+    def init
+      @words = dictionary.sample(20).map(&:strip)
+    end
+
+    # Public: Returns a random word
+    #
+    # Example:
+    #
+    #   random
+    #   #=> 'mephitical'
+    #
+    # Returns a random word (String)
+    def random
+      init if @words.empty?
+
+      @words.pop
+    end
+
+    # Private: Returns a dictionary
+    #
+    # Checks for a words file and fallsback to a minimal dictionary
+    # https://en.wikipedia.org/wiki/Words_(Unix)
+    def dictionary
+      if File.file?('/usr/share/dict/words')
+        words_file('/usr/share/dict/words')
+      elsif File.file?('/usr/dict/words')
+        words_file('/usr/dict/words')
+      else
+        %w(
+          this is a jury rigged dictionary banana monkey apple pear peach
+          computers are so great robot dance
+        )
+      end
+    end
+
+    # Private: Retrieve all 3 to 9 letter words from a provided file
+    #
+    # words - words file
+    #
+    # Example:
+    #
+    #  words_file('/usr/share/dict/words')
+    #  #=> ['banana', ...]
+    #
+    # Retruns a list of words
+    def words_file(words)
+      File.read(words).lines.select do |l|
+        (3..9).cover?(l.strip.size)
+      end
+    end
+  end
+end

data/lib/etfc/flickr.rb

@@ -0,0 +1,38 @@
+require 'flickraw'
+
+module ETFC
+  module Flickr
+    module_function
+
+    # Flickr requires authentication for API interaction
+    FlickRaw.api_key = ETFC::FLICKR_API_KEY
+    FlickRaw.shared_secret = ETFC::FLICKR_SHARED_SECRET
+
+    # Public: Search for the most interesting image on flickr for a keyword
+    #
+    # keyword - the keyword to search for
+    #
+    # Examples:
+    #
+    #   search('something interesting')
+    #   #=> 'http://farm9.staticflickr.com/1234/11111111111_2222222222_b.jpg'
+    #
+    #   search('something that totally wont match')
+    #   #=> nil
+    #
+    # Returns a String (URL) for an image or `nil` if no image was found
+    def search(keyword)
+      # See https://www.flickr.com/services/api/flickr.photos.search.html /
+      # http://hanklords.github.io/flickraw/FlickRaw/Flickr/Photos.html#method-i-search
+      results = flickr.photos.search(sort: 'interestingness-desc',
+                                     text: keyword,
+                                     page: 1,
+                                     per_page: 1,
+                                     media: 'photos',
+                                     content_type: 1,
+                                     extras: 'url_l')
+
+      results.first['url_l'] if results.size > 0
+    end
+  end
+end

data/lib/etfc/image.rb

@@ -0,0 +1,45 @@
+require 'open-uri'
+require 'rmagick'
+
+module ETFC
+  module Image
+    module_function
+
+    # Public: Download a file and save it to the temporary folder
+    #
+    # url  - URL of the file that shall be downloaded
+    # name - name for the to be downloaded file
+    #
+    # Examples:
+    #
+    #   download('http://example.com/abc.jpg', '123.jpg')
+    #   #=> "/var/tmp/111/222/123.jpg"
+    #
+    # Returns String with the location of the downloaded file
+    def download(url, name)
+      path = "#{ETFC::TMP_DIR}/#{name}"
+      download = open(url)
+      IO.copy_stream(download, path)
+      path
+    end
+
+    # Public: Crop an image destructively
+    #
+    # image  - path of the image that shall be cropped
+    # width  - OPTIONAL width,  defaults to 300
+    # height - OPTIONAL height, defaults to 300
+    #
+    # Examples:
+    #
+    #  crop('/abc/123.jpg')
+    #  #=> #<Magick::Image:70103481521220> => /abc/123.jpg JPEG
+    #                      800x600=>300x300 800x600+250+150 DirectClass 8-bit
+    #
+    # Returns Magick::Image with the crop transformation queued
+    def crop(image, width = 300, height = 300)
+      img = Magick::Image.read(image)[0]
+      img.crop!(Magick::CenterGravity, width, height)
+      img.write(image)
+    end
+  end
+end

data/lib/etfc/runner.rb

@@ -0,0 +1,65 @@
+module ETFC
+  module Runner
+    module_function
+
+    # Public: create a collage of images found on flickr for a list of keywords
+    #
+    # keywords - array of keywords (up to 10)
+    # output   - name of the resulting collage
+    #
+    # Example:
+    #
+    #  run(['banana', 'monkey'], 'collage.jpg')
+    #  # the collage will be saved to collage.jpg in your current directory
+    #
+    # Returns Magick::ImageList; can be discarded as the collage will be saved
+    # to the supplied file name on disk
+    def run(keywords, output)
+      check_api_credentials
+
+      images_urls = ten_img_urls(keywords)
+
+      images_urls.each_with_index do |url, idx|
+        Image.download(url, "#{idx}.jpg")
+      end
+
+      img_list = Dir[TMP_DIR + '/**.jpg']
+
+      img_list.each { |img| Image.crop(img) }
+
+      Collage.create(img_list, output)
+    end
+
+    # Public: get ten image urls for keywords; if less than 10 keywords are
+    # supplied, random keywords will be selected from the system dictionary
+    #
+    # keywords - array of keywords (up to 10)
+    #
+    # Example:
+    #
+    #  ten_img_urls(['banana'])
+    #  #=> ['http://example.com/123.jpog', '...]
+    #
+    # Returns an array of ten image URLs
+    def ten_img_urls(keywords)
+      images = keywords.map do |keyword|
+        Flickr.search(keyword)
+      end.reject(&:nil?)
+
+      dict = Dictionary.new
+      while images.length < 10
+        result = Flickr.search(dict.random)
+        images << result unless result.nil?
+      end
+
+      images.take(10)
+    end
+
+    def check_api_credentials
+      return if ETFC::FLICKR_API_KEY || ETFC::FLICKR_SHARED_SECRET
+      puts 'Please set FLICKR_API_KEY and FLICKR_SHARED_SECRET as ' \
+           'environment variables'
+      exit 1
+    end
+  end
+end

data/lib/etfc/version.rb

@@ -0,0 +1,3 @@
+module ETFC
+  VERSION = '1.0.0'.freeze
+end

data/lib/etfc.rb

@@ -0,0 +1,15 @@
+require 'tmpdir'
+
+module ETFC
+  FLICKR_API_KEY = ENV['FLICKR_API_KEY']
+  FLICKR_SHARED_SECRET = ENV['FLICKR_SHARED_SECRET']
+
+  TMP_DIR = Dir.mktmpdir
+end
+
+require 'etfc/version'
+require 'etfc/flickr'
+require 'etfc/image'
+require 'etfc/collage'
+require 'etfc/dictionary'
+require 'etfc/runner'

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: etfc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maximilian Haack
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+description: ETFC is a tool to create collages from flickr images based upon user
+  provided keywords.
+email:
+- mxhaack@gmail.com
+executables:
+- etfc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- etfc.gemspec
+- exe/etfc
+- fixtures/images/1.jpg
+- fixtures/images/10.jpg
+- fixtures/images/2.jpg
+- fixtures/images/3.jpg
+- fixtures/images/4.jpg
+- fixtures/images/5.jpg
+- fixtures/images/6.jpg
+- fixtures/images/7.jpg
+- fixtures/images/8.jpg
+- fixtures/images/9.jpg
+- fixtures/vcr_cassettes/collage.yml
+- fixtures/vcr_cassettes/download_blank_image.yml
+- fixtures/vcr_cassettes/flickr_search_match.yml
+- fixtures/vcr_cassettes/flickr_search_no_match.yml
+- fixtures/vcr_cassettes/ten_images.yml
+- lib/etfc.rb
+- lib/etfc/cli.rb
+- lib/etfc/collage.rb
+- lib/etfc/dictionary.rb
+- lib/etfc/flickr.rb
+- lib/etfc/image.rb
+- lib/etfc/runner.rb
+- lib/etfc/version.rb
+- sample_collage.jpg
+homepage: https://www.github.com/coffeejunk/etfc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A flickr collage maker
+test_files: []