flickr_collage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d78399ff56392a3bdfacaf3244e7356d908d7cac
+  data.tar.gz: 82b1183d716173fd484273a4af791c33e266d2ee
+SHA512:
+  metadata.gz: 8a4463481021797101d80eb3f013f608557394ff939ee1d1a81247fb368eaeb9aa49aacb7ea079fab872f5a61dfd80507d3923eab0a1374dc97cd183285a54b3
+  data.tar.gz: 38ab241bd196260b65c2cf958339699ee0400e240688d122c0323595507d042d8c10e1bffa5190beea07838a0ea8fae9f132afe32a2ea9ed9a264894a7a76631

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+tmp/*
+!tmp/fruits.jpg
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ingo Plaschczek
+
+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,115 @@
+# Flickr Collage
+
+**Flickr Collage** queries the Flickr API for the top-rated image by search keywords and assembles a collage grid from this images to a new file.
+
+![](tmp/fruits.jpg)
+
+## Installation
+
+You have to install **ImageMagick**. On Ubuntu for example, you can run:
+
+```
+sudo apt-get install libmagickwand-dev
+```
+
+For more details take a look at (https://github.com/rmagick/rmagick#prerequisites).
+
+**Installing via Bundler**
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flickr_collage'
+```
+
+And then execute:
+
+```console
+bundle
+```
+
+**Installing via Rubygems**
+
+```console
+gem install flickr_collage
+```
+
+**Installing from github**
+
+```console
+git clone https://github.com/plaschczek/flickr_collage
+cd flickr_collage
+bundle
+rake install
+```
+
+## Usage
+
+First you have to initialize FlickRaw.api_key and FlickRaw.shared_secred.<br />
+For example export the following env vars:
+
+```console
+export FLICKR_API_KEY='... Your API key ...'
+export FLICKR_SHARED_SECRET='... Your shared secret ...'
+```
+
+Or in your Ruby file:
+
+```ruby
+require 'flickr_collage'
+
+FlickRaw.api_key="... Your API key ..."
+FlickRaw.shared_secret="... Your shared secret ..."
+```
+
+### Examples
+
+To create a collage with 10 random images, instantiate a new FlickrCollage and save the image:
+
+```ruby
+FlickrCollage.new.save
+```
+
+Full options example (9 images, 4 by keyword, 5 random in 2 rows as squares, saved as 'tmp/fruits_example.jpg'):
+
+```ruby
+FlickrCollage.new(
+  keywords: ['strawberry', 'kiwi', 'cherry', 'limes'],
+  filename: 'fruits_example.jpg',
+  dir: 'tmp',
+  no_of_images: 9,
+  rows: 2,
+  squares: true
+).save
+```
+
+### Command Line Examples
+
+The same full options example as before:
+
+```console
+flickr_collage -k strawberry,kiwi,cherry,limes -f fruits_example.jpg -d tmp -n 9 -r 2 -s
+```
+
+And the command line help:
+
+```console
+flickr_collage -h
+```
+
+### Options
+
+```
+FlickrCollage.new(keywords:, filename:, dir:, no_of_images:, rows:, squares:)
+
+    keywords: Array with keywords
+    filename: collage filename, default 'collage.jpg'
+         dir: directory to save the collage, has to exist, default '.'
+no_of_images: number of images, default number of keywords and without keywords 10
+        rows: number of collage rows, default sqrt(no_of_images).floor
+     squares: boolean, if true images squared
+```
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flickr_collage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/flickr_collage

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+require 'flickr_collage'
+require 'highline'
+require 'cri'
+
+command = Cri::Command.define do
+  name        'flickr_collage'
+  usage       'flickr_collage [options]'
+  summary     'Makes a collage of Flickr images by keywords'
+  description '
+    Flickr Collage queries the Flickr API for the top-rated image by search
+    keywords and assembles a collage grid from this images to a new file.
+
+    Example:
+    flickr_collage -k strawberry,kiwi,cherry,limes -f fruits.jpg -s
+  '
+
+  option :d, :dir, 'directory to store collage', argument: :optional
+  option :f, :filename, 'filename for collage', argument: :optional
+  option :k, :keywords, 'keywords to search for, comma seperated', argument: :optional
+  option :n, :no_of_images, 'number of images (default number of keywords or 10)', argument: :optional
+  option :r, :rows, "number of collage's rows", argument: :optional
+  option :s, :squares, 'images squared on collage'
+
+  flag :h, :help, 'show help for this command' do |_value, cmd|
+    puts cmd.help
+    exit 0
+  end
+
+  run do |opts, _args, _cmd|
+    cli = HighLine.new
+
+    exit 0 unless opts[:keywords] ||
+      cli.agree('Random collage without keywords? (Type `flickr_collage -h` for help.) [y/n]')
+
+    options = { keywords: opts.fetch(:keywords, '').split(',') }
+
+    options[:dir] = opts.fetch(:dir) if opts[:dir]
+    options[:filename] = opts.fetch(:filename) if opts[:filename]
+    options[:no_of_images] = opts.fetch(:no_of_images).to_i if opts[:no_of_images]
+    options[:rows] = opts.fetch(:rows).to_i if opts[:rows]
+    options[:squares] = opts.key?(:squares) if opts[:squares]
+
+    begin
+      puts 'Searching and loading images'
+      flickr_collage = FlickrCollage.new(**options)
+
+    rescue FlickrCollage::Errors::DictionaryNotFound
+      puts "Dictionary not found for #{FlickrCollage::Dictionary.path}"
+      dict_path = cli.ask('Enter path for dictionary or leave it blank to cancel.')
+      exit 0 if dict_path == ''
+      FlickrCollage::Dictionary.path = dict_path
+      retry
+
+    rescue => e
+      puts "Error while execution: #{e.message}"
+      exit 1
+    end
+
+    if flickr_collage.unsuccessful_keywords
+      keys = flickr_collage.unsuccessful_keywords.keys & options[:keywords]
+      puts "Note: No image found for the following keyword(s): #{keys.join(', ')}" if keys.any?
+    end
+
+    begin
+      flickr_collage.save
+
+    rescue FlickrCollage::Errors::DirNotFound
+      puts "Directory #{flickr_collage.dir} not found, please ensure that the directory exists."
+
+    rescue FlickrCollage::Errors::FileExist
+      if cli.agree("File exists. Overwrite #{File.join(flickr_collage.dir, flickr_collage.filename)}? [y/n]")
+        flickr_collage.save!
+      else
+        filename = cli.ask("Enter new filename (dir: #{flickr_collage.dir}) or leave it blank to cancel.")
+        exit 0 if filename == ''
+        flickr_collage.filename = filename
+        retry
+      end
+
+    rescue FlickrCollage::Errors::FileCannotBeSaved
+      puts 'Error: File could no be saved.'
+      exit 1
+
+    rescue => e
+      puts "Error while execution: #{e.message}"
+    end
+  end
+end
+
+command.run(ARGV)

data/flickr_collage.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flickr_collage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flickr_collage'
+  spec.version       = FlickrCollage::VERSION
+  spec.authors       = ['Ingo Plaschczek']
+  spec.email         = ['github@plaschczek.de']
+
+  spec.summary       = %q{Makes a collage of Flickr images by keywords}
+  spec.description   = %q{Flickr Collage queries the Flickr API for the top-rated image by search keywords and assembles a collage grid from this images to a new file.}
+  spec.homepage      = 'https://github.com/plaschczek/flickr_collage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = ['flickr_collage']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'flickraw'
+  spec.add_dependency 'rmagick'
+  spec.add_dependency 'highline'
+  spec.add_dependency 'cri'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/flickr_collage.rb

@@ -0,0 +1,94 @@
+require 'flickr_collage/version'
+require 'flickr_collage/errors'
+require 'flickr_collage/dictionary'
+require 'flickr_collage/file_loader'
+
+require 'rmagick'
+require 'flickraw'
+
+require 'flickr_collage/initializer'
+
+class FlickrCollage
+  attr_accessor :keywords, :random_keywords, :unsuccessful_keywords, :image_list, :collage, :dir, :filename, :squares
+
+  def initialize(keywords: [], filename: 'collage.jpg', dir: '.', no_of_images: nil, rows: nil, squares: false)
+    @filename = filename
+    @dir = dir
+    @squares = squares
+    @no_of_images = no_of_images || (keywords.empty? ? 10 : keywords.length)
+    assign_and_extend_keywords(keywords)
+
+    @image_list, @unsuccessful_keywords = FileLoader.image_list(@keywords)
+
+    create_collage(rows: rows || Math.sqrt(@no_of_images).floor)
+  end
+
+  def save(force: false)
+    path = prepare_and_check_path(force)
+    @collage.write(path)
+  rescue Errors::DirNotFound, Errors::FileExist
+    raise
+  rescue => e
+    raise Errors::FileCannotBeSaved, "#{e.class}: #{e.message}"
+  end
+
+  def save!
+    save(force: true)
+  end
+
+  private
+
+  def assign_and_extend_keywords(keywords)
+    @random_keywords = []
+    (@no_of_images - keywords.length).times { @random_keywords << Dictionary.words.sample }
+    @keywords = keywords + @random_keywords
+  end
+
+  def create_collage(rows: 3, width: 1200)
+    @image_list.scene = 0
+    collage_list = Magick::ImageList.new
+
+    height = 0
+    rows.times do |i|
+      row = create_image_row(no_of_images: images_per_row(rows, i))
+      collage_list << row.scale(width.to_f / row.columns)
+      collage_list.page = Magick::Rectangle.new(0, 0, 0, height)
+      height += collage_list.rows
+    end
+
+    @collage = collage_list.mosaic
+  end
+
+  def create_image_row(no_of_images:, height: 300)
+    row = Magick::ImageList.new
+
+    width = 0
+    no_of_images.times do
+      row << (@squares ? @image_list.resize_to_fill(height) : @image_list.scale(height.to_f / @image_list.rows))
+      row.page = Magick::Rectangle.new(0, 0, width, 0)
+      width += row.columns
+      increment_image_list_scene
+    end
+
+    row.mosaic
+  end
+
+  def increment_image_list_scene
+    @image_list.scene += 1
+  rescue
+    @image_list.scene = 0
+  end
+
+  def images_per_row(rows, i)
+    @no_of_images / rows + (i.positive? && i <= @no_of_images % rows ? 1 : 0)
+  end
+
+  def prepare_and_check_path(force)
+    raise Errors::DirNotFound unless File.directory?(dir.to_s)
+
+    path = File.join(dir, filename)
+    raise Errors::FileExist if !force && File.exist?(path)
+
+    path
+  end
+end

data/lib/flickr_collage/dictionary.rb

@@ -0,0 +1,20 @@
+class FlickrCollage
+  class Dictionary
+    @path = '/usr/share/dict/words'
+
+    class << self
+      attr_reader :path
+    end
+
+    def self.path=(value)
+      @words = nil
+      @path = value
+    end
+
+    def self.words
+      @words ||= File.open(@path.to_s).read.to_s.split("\n")
+    rescue
+      raise Errors::DictionaryNotFound
+    end
+  end
+end

data/lib/flickr_collage/errors.rb

@@ -0,0 +1,10 @@
+class FlickrCollage
+  class Errors
+    class DictionaryNotFound < StandardError; end
+    class DirNotFound < StandardError; end
+    class FileCannotBeSaved < StandardError; end
+    class FileExist < StandardError; end
+    class NoFlickRawURLMethod < StandardError; end
+    class NoImageFound < StandardError; end
+  end
+end

data/lib/flickr_collage/file_loader.rb

@@ -0,0 +1,51 @@
+require 'open-uri'
+
+class FlickrCollage
+  class FileLoader
+    FLICK_RAW_URL_METHODS = %w(url url_m url_s url_t url_b url_z url_q url_n url_c url_o).freeze
+
+    attr_accessor :unsuccessful_keywords
+
+    def self.image_list(keywords)
+      FileLoader.new.load_flickr_files(keywords)
+    end
+
+    def load_flickr_files(keywords, image_list: Magick::ImageList.new, url_method: 'url_b')
+      keywords.each { |k| image_list.push(load_flickr_file(k, url_method)) }
+
+      [image_list, @unsuccessful_keywords]
+    end
+
+    private
+
+    def load_flickr_file(keyword, url_method)
+      open(flickr_file_url(keyword, url_method)) do |uri|
+        raise Errors::NoImageFound unless uri.is_a? ::Tempfile
+        return Magick::Image.from_blob(uri.read).first
+      end
+    rescue Errors::NoImageFound
+      (@unsuccessful_keywords ||= {})[keyword] = Dictionary.words.sample
+      keyword = @unsuccessful_keywords[keyword]
+      retry
+    end
+
+    def flickr_file_url(keyword, url_method)
+      raise Errors::NoFlickRawURLMethod unless FLICK_RAW_URL_METHODS.include?(url_method)
+
+      FlickRaw.send(url_method, flickr_photo_search(keyword))
+    end
+
+    def flickr_photo_search(keyword)
+      photo_search = flickr.photos.search(
+        tags: [keyword],
+        sort: 'interestingness-desc',
+        content_type: 1,
+        per_page: 1
+      )
+
+      raise Errors::NoImageFound unless photo_search.first
+
+      photo_search.first
+    end
+  end
+end

data/lib/flickr_collage/initializer.rb

@@ -0,0 +1,7 @@
+# init FlickRaw
+#
+# FlickRaw.api_key="... Your API key ..."
+# FlickRaw.shared_secret="... Your shared secret ..."
+
+FlickRaw.api_key ||= ENV['FLICKR_API_KEY']
+FlickRaw.shared_secret ||= ENV['FLICKR_SHARED_SECRET']

data/lib/flickr_collage/version.rb

@@ -0,0 +1,3 @@
+class FlickrCollage
+  VERSION = '0.0.1'.freeze
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: flickr_collage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ingo Plaschczek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Flickr Collage queries the Flickr API for the top-rated image by search
+  keywords and assembles a collage grid from this images to a new file.
+email:
+- github@plaschczek.de
+executables:
+- flickr_collage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/flickr_collage
+- flickr_collage.gemspec
+- lib/flickr_collage.rb
+- lib/flickr_collage/dictionary.rb
+- lib/flickr_collage/errors.rb
+- lib/flickr_collage/file_loader.rb
+- lib/flickr_collage/initializer.rb
+- lib/flickr_collage/version.rb
+- tmp/fruits.jpg
+homepage: https://github.com/plaschczek/flickr_collage
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Makes a collage of Flickr images by keywords
+test_files: []