imagecollage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2085f909a2cef3fa20528ea84558bce6a539155b
+  data.tar.gz: 55da02dcfb0f6886219f5de0a4578be3f330fd8f
+SHA512:
+  metadata.gz: 64b29e7810c29a8b1b0427de30c6a90d9e169ae317753c820a36169f95e87d355412ff25540c3584e6c4183f4fdc736c3956ad277dfbaafb4c3ca44cdb5b7b9f
+  data.tar.gz: 534e07eabde523f566b8756a3c6b88b09a11239e448905ef4efdc68a65915add5746612927e8951d412a620b7b9ebb99da39fcd613d9d99374c74101b8f7b12a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Metrics/LineLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Piegza
+
+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,46 @@
+# ImageCollage
+
+ImageCollage creates a collage based on images from Flickr.
+
+## Installation
+
+#### ImageMagick
+
+This gem requires [ImageMagick](http://www.imagemagick.org) in order to run. Check the
+[download section](http://www.imagemagick.org/script/download.php) at ImageMagick to get
+instructions on how to install it.
+
+Install it via homebrew (OSX):
+
+    $ brew install imagemagick@6
+
+#### ImageCollage
+
+Install it via gem:
+
+    $ gem install imagecollage
+
+If you get an error while installing `rmagick` you could try installing it with:
+
+    $ PKG_CONFIG_PATH=/usr/local/opt/imagemagick@6/lib/pkgconfig gem install rmagick
+
+## Usage
+
+Run
+
+    $ imagecollage berlin tower cat dog flower cherry
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidpiegza/imagecollage.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.verbose = false
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'imagecollage'
+
+require 'irb'
+IRB.start

data/bin/imagecollage

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'imagecollage'
+
+cli = ImageCollage::Cli.new
+
+result = cli.run
+
+exit result

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/imagecollage.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imagecollage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'imagecollage'
+  spec.version       = ImageCollage::VERSION
+  spec.authors       = ['David Piegza']
+  spec.homepage      = 'https://github.com/davidpiegza/imagecollage'
+  spec.summary       = 'ImageCollage creates a collage based on images from Flickr.'
+  spec.license       = 'MIT'
+
+  spec.post_install_message = <<-MESSAGE
+    ImageCollage has been installed successfully!
+
+    Make sure to set a Flickr api key via env variable (export FLICKR_API_KEY=api_key) or
+    provide it when running this gem.
+
+    Example:
+      imagecollage berlin naples barcelona
+  MESSAGE
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = ['imagecollage']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httparty', '~> 0.14'
+  spec.add_runtime_dependency 'rmagick', '~> 2.16'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'rubocop', '~> 0.46'
+end

data/lib/imagecollage/cli.rb

@@ -0,0 +1,61 @@
+module ImageCollage
+  class Cli
+    IMAGE_COLLAGE_DEFAULT_PATH = './collage.jpg'.freeze
+
+    def run(args = ARGV)
+      flickr_api_key = fetch_flickr_api_key
+      image_collage_path = fetch_image_collage_path
+
+      options = {
+        flickr_api_key: flickr_api_key,
+        image_collage_path: image_collage_path
+      }
+
+      runner = Runner.new(args, options)
+
+      return runner.run
+    rescue ImageCollage::Error => e
+      $stderr.puts
+      $stderr.puts "Error: #{e.message}"
+      return 2
+    rescue StandardError => e
+      $stderr.puts e.message
+      $stderr.puts e.backtrace
+      return 2
+    end
+
+    private
+
+    def fetch_flickr_api_key
+      if (api_key = ENV['FLICKR_API_KEY']).nil?
+        $stdout.puts 'Please provide a Flickr API key and set it as a'
+        $stdout.puts 'shell environment variable (FLICKR_API_KEY) or paste it here.'
+
+        api_key = ask 'Flickr API KEY:'
+
+        raise ImageCollage::Error, 'Invalid Flickr API key' if api_key.empty?
+      end
+
+      api_key
+    end
+
+    def fetch_image_collage_path
+      $stdout.puts 'Please provide a path for the generated collage image (default: current path).'
+      path = ask "Image collage path (#{IMAGE_COLLAGE_DEFAULT_PATH}):"
+      path = IMAGE_COLLAGE_DEFAULT_PATH if path.empty?
+
+      raise ImageCollage::Error, 'Invalid path' unless File.directory?(File.dirname(path))
+
+      path
+    end
+
+    def ask(message)
+      $stdout.puts
+      $stdout.print "#{message} "
+      result = $stdin.gets.chomp
+      $stdout.puts
+
+      result
+    end
+  end
+end

data/lib/imagecollage/collage_generator.rb

@@ -0,0 +1,54 @@
+require 'RMagick'
+require 'open-uri'
+
+module ImageCollage
+  class CollageGenerator
+    include Magick
+
+    def initialize(image_urls)
+      @image_urls = image_urls
+    end
+
+    def generate_image_collage(path)
+      tmp_files = []
+      @image_urls.each do |image_url|
+        tmp_file = Tempfile.new(['image_collage', '.jpg'])
+
+        open(image_url) do |image_file|
+          tmp_file.write(image_file.read)
+        end
+
+        tmp_file.rewind
+        tmp_files << tmp_file
+      end
+
+      image_list = ImageList.new(*tmp_files.map(&:path))
+
+      resize!(image_list)
+      image_list = montage(image_list)
+
+      image_list.write(path)
+    ensure
+      tmp_files.each do |tmp_file|
+        tmp_file.close
+        tmp_file.unlink
+      end
+    end
+
+    private
+
+    def resize!(image_list)
+      image_list.each do |image|
+        image.resize_to_fill!(320, 240)
+      end
+    end
+
+    def montage(image_list)
+      image_list.montage do
+        self.geometry = '320x240+0+0>'
+        rows = (image_list.size + 4) / 5
+        self.tile = Geometry.new(5,rows)
+      end
+    end
+  end
+end

data/lib/imagecollage/error.rb

@@ -0,0 +1,3 @@
+module ImageCollage
+  class Error < StandardError; end
+end

data/lib/imagecollage/flickr_api.rb

@@ -0,0 +1,59 @@
+require 'httparty'
+
+module ImageCollage
+  class FlickrApi
+    include HTTParty
+
+    base_uri 'https://api.flickr.com/services/rest'
+
+    def initialize(api_key)
+      @api_key = api_key || ''
+
+      raise ImageCollage::Error, 'Invalid Flickr API key' if @api_key.empty?
+    end
+
+    def photos_search(options = {})
+      self.class.get('', photos_search_options(options))
+    end
+
+    def parse_image_url(response)
+      ResponseParser.new(response).fetch('url_z')
+    end
+
+    private
+
+    def photos_search_options(options)
+      {
+        query: {
+          method: 'flickr.photos.search',
+          api_key: @api_key,
+          text: options[:keyword] || 'berlin',
+          extras: 'url_z',
+          per_page: 1,
+          sort: 'interestingness-desc'
+        }
+      }
+    end
+  end
+
+  class ResponseParser
+    PHOTO_PATH = ['rsp', 'photos', 'photo'].freeze
+
+    def initialize(response)
+      @response = response # TODO Wrap in a Hash if needed
+    end
+
+    def fetch(key)
+      photo_data[key]
+    end
+
+    def photo_data
+      @_photo_data ||= PHOTO_PATH.reduce(@response) do |subdata, el|
+        break unless subdata
+        subdata[el]
+      end
+
+      @_photo_data || {}
+    end
+  end
+end

data/lib/imagecollage/image_url_requester.rb

@@ -0,0 +1,50 @@
+module ImageCollage
+  class ImageUrlRequester
+    def initialize(keywords, flickr_api, options = {})
+      @keywords = keywords || []
+      @flickr_api = flickr_api
+      @options = options || {}
+
+      @image_url_count = Integer(options[:image_url_count]) || 10
+      @keywords_pool = fill_keywords_pool(@keywords)
+    end
+
+    def image_urls
+      image_urls = []
+
+      while image_urls.length < @image_url_count
+        keyword = @keywords_pool.shift || random_keyword
+
+        print "Fetching image (#{image_urls.length + 1}/#{@image_url_count}) for #{keyword}..."
+
+        response = @flickr_api.photos_search(keyword: keyword)
+        image_url = @flickr_api.parse_image_url(response.parsed_response)
+
+        if image_url
+          image_urls << image_url
+          puts 'OK'
+        else
+          puts 'FAILED'
+        end
+      end
+
+      image_urls
+    end
+
+    private
+
+    def random_keyword
+      RandomWordApi.fetch
+    end
+
+    def fill_keywords_pool(keywords)
+      keywords_pool = Array.new(keywords)
+
+      while keywords_pool.length < @image_url_count
+        keywords_pool << random_keyword
+      end
+
+      keywords_pool
+    end
+  end
+end

data/lib/imagecollage/random_word_api.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+
+module ImageCollage
+  class RandomWordApi
+    include HTTParty
+
+    base_uri 'http://www.setgetgo.com/randomword/get.php'
+
+    def self.fetch
+      get('/').parsed_response
+    end
+  end
+end

data/lib/imagecollage/runner.rb

@@ -0,0 +1,23 @@
+module ImageCollage
+  class Runner
+
+    attr_reader :keywords, :options
+
+    COLLAGE_IMAGE_COUNT = 10
+
+    def initialize(keywords, options)
+      @keywords = keywords
+      @options = options || {}
+    end
+
+    def run
+      flickr_api = ImageCollage::FlickrApi.new(@options.fetch(:flickr_api_key))
+      image_url_requester = ImageUrlRequester.new(@keywords, flickr_api, image_url_count: COLLAGE_IMAGE_COUNT)
+
+      collage_generator = CollageGenerator.new(image_url_requester.image_urls)
+      collage_generator.generate_image_collage(@options.fetch(:image_collage_path))
+
+      return 0
+    end
+  end
+end

data/lib/imagecollage/version.rb

@@ -0,0 +1,3 @@
+module ImageCollage
+  VERSION = '0.1.0'.freeze
+end

data/lib/imagecollage.rb

@@ -0,0 +1,11 @@
+require 'imagecollage/cli'
+require 'imagecollage/flickr_api'
+require 'imagecollage/random_word_api'
+require 'imagecollage/image_url_requester'
+require 'imagecollage/collage_generator'
+require 'imagecollage/runner'
+require 'imagecollage/error'
+require 'imagecollage/version'
+
+module ImageCollage
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: imagecollage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Piegza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.46'
+description: 
+email: 
+executables:
+- imagecollage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/imagecollage
+- bin/setup
+- imagecollage.gemspec
+- lib/imagecollage.rb
+- lib/imagecollage/cli.rb
+- lib/imagecollage/collage_generator.rb
+- lib/imagecollage/error.rb
+- lib/imagecollage/flickr_api.rb
+- lib/imagecollage/image_url_requester.rb
+- lib/imagecollage/random_word_api.rb
+- lib/imagecollage/runner.rb
+- lib/imagecollage/version.rb
+homepage: https://github.com/davidpiegza/imagecollage
+licenses:
+- MIT
+metadata: {}
+post_install_message: |2
+      ImageCollage has been installed successfully!
+
+      Make sure to set a Flickr api key via env variable (export FLICKR_API_KEY=api_key) or
+      provide it when running this gem.
+
+      Example:
+        imagecollage berlin naples barcelona
+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: ImageCollage creates a collage based on images from Flickr.
+test_files: []