flickr_collager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 723b3acc6258a9217c868acbc4117f68547e95d21983b5b4626662c0a9374656
+  data.tar.gz: 62383cf3bbe4e0c023e3d4a5c4b2e638b9a21bb6cad6ca82009ef47378a78995
+SHA512:
+  metadata.gz: b2b24e7f2e8fcebe702e20830baa7b16b33335bb5164fb20c7c6435387c8c5fc70131b9917b1591006f8580b213e2191b3ee944a70c2b9faaa45ebd94729541e
+  data.tar.gz: ecbdb075230314daa83599e7b5b22d0f521119ac45c5d41c4475c60f82167341cf2694748df9b0081e562d5a723daa600a037b36bc749d1f53325da76c1e1dea

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    flickr_collager (0.0.1)
+      minitest (= 5.9.0)
+      rake (>= 12.3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.9.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flickr_collager!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,14 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.
+

data/README.md

@@ -0,0 +1,32 @@
+#Flickr Collager
+
+## Flickr image search and Collage Creator.
+
+
+## To build
+There is a rakefile for all the tests, the list of all Rake tasks available can be
+seen by :
+
+```rake -T```
+
+Also the project can be made into a gem
+
+by doing a ```bundle``` and then building the gem by executing ```gem build flickr_collager.gemspec```
+
+Once the gem in built it can be installed by :
+
+```gem install flickr_collager-0.0.1.gem```
+
+## Prerequisites : 
+
+Before Installing the gem make sure Imagemagick is installed.
+
+```brew install imagemagick```
+
+Once the gem is installed into installs a executable called ```collage``` which can used as follows :
+
+## Usage :
+
+```collage -w pen,pencil,rose,women,brizil,everest,sunshine --out-file collage.png```
+
+The project compensates for missing search terms if less than 10 from a dictionary.

data/Rakefile

@@ -0,0 +1,45 @@
+namespace :app do
+  namespace :test do
+    task :collage do
+      desc 'Tests collage'
+      system 'ruby spec/test_collage.rb'
+    end
+
+    task :flickr do
+      desc 'Test Flickr Search API'
+      system 'ruby spec/test_flickr_search.rb'
+    end
+
+    task :magick do
+      desc 'Test ImageMagick interface API'
+      system 'ruby spec/test_magick_collage.rb'
+    end
+  end
+
+  namespace :gem do
+    task :build do
+      desc "Build The Flickr Collager 'gem'."
+      system 'gem build flickr_collager.gemspec'
+    end
+  end
+
+  task all: [
+    'app:test:collage', 'app:test:flickr',
+    'app:test:magick', 'app:gem:build'
+  ]
+end
+
+desc 'All Tasks'
+task default: 'app:all'
+
+desc 'Test Collage'
+task 'test:collage' => 'app:test:collage'
+
+desc 'Test Flickr Search API'
+task 'test:flickr' => 'app:test:flickr'
+
+desc 'Test ImageMagick inetrface API'
+task 'test:magick' => 'app:test:magick'
+
+desc "Build the Flickr Collager 'gem'"
+task 'gem:build' => 'app:gem:build'

data/bin/collage

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require_relative '../loader'
+
+class CollageParser
+  def self.parse(params)
+    args = {}
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: collage -w word1,word2..wordN -o outfile.png'
+      opts.on('-w', '--words ', Array, 'Flickr Search Words') do |w|
+        args[:words] = w
+      end
+
+      opts.on('-o', '--out-file ', String, 'Output File') do |f|
+        args[:outfile] = f
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+    end.parse! params
+    args
+  end
+end
+
+args = if ARGV.empty?
+         %w(--help)
+       else
+         ARGV
+       end
+
+options = CollageParser.parse args
+collage = Collage.new options[:words]
+collage.download_images.build options[:outfile]
+
+if RUBY_PLATFORM.downcase =~ /darwin/
+  fork { system "open #{options[:outfile]}" }
+elsif  RUBY_PLATFORM.downcase =~ /linux/
+  fork { system "eog  #{options[:outfile]}" }
+elsif RUBY_PLATFORM.downcase =~ /mswin/
+  puts 'Dude Seriously, Windows?'
+end

data/config.yaml

@@ -0,0 +1,22 @@
+#Collage Search app config options.
+
+options:
+  MIN_WORD_COUNT: 10
+  DICT_PATH: '/usr/share/dict/words'
+
+flickr:
+  API_KEY: '2ee12fb262a51e63f4e3c04f092bec55'
+  API_SECRET: '6002a6a1481c6fe0'
+  API_URL: 'https://api.flickr.com/services/rest/?'
+  API_FORMAT: 'json'
+  API_METHOD: 'flickr.photos.search'
+  API_SORT: 'relevance'
+  TEMP_DIR: '/tmp/collage'
+
+imagemagick:
+  ROWS: 2
+  COLUMNS: 5
+  BG_COLOR: 'white'
+  BORDR_SIZE: '+5+5'
+  IMG_SIZE: 1000
+  

data/flickr_collager.gemspec

@@ -0,0 +1,22 @@
+require_relative 'lib/string_refinements'
+require_relative 'lib/app_config'
+require 'fileutils'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'flickr_collager'
+  gem.version       = AppConfig::Version::STRING
+  gem.authors       = ['Pankaj Doharey']
+  gem.email         = ['pankajdoharey@gmail.com']
+  gem.licenses      = ['WTFPL']
+  gem.description   = 'Collage Builder'
+  gem.summary       = 'Flickr based Collage builder'
+  gem.homepage      = 'http://selfdotsend.com'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  gem.add_dependency 'rake', '>= 12.3.3'
+  gem.add_dependency 'minitest', '5.9.0'
+  gem.post_install_message = AppConfig::PostInstall.message
+end

data/lib/app_config.rb

@@ -0,0 +1,28 @@
+# Main Container module to namespace the application and its various parts
+# are submodules inside this module.
+module AppConfig
+  using Camelizer
+
+  def self.included(klass)
+    config = YAML.load_file(path_finder)
+
+    Dir.glob File.expand_path('../app_config/*.rb', __FILE__) do |file|
+      require file
+
+      # Set app configration from config.yaml
+      file_basename = File.basename(file, '.rb')
+      (klass.const_get file_basename.camelize).options config
+    end
+  end
+
+  def self.path_finder
+    if File.exist?('config.yaml')
+      'config.yaml'
+    else
+      File.expand_path('~/.collage/config.yaml', __FILE__)
+    end
+  end
+end
+
+require_relative 'version'
+require_relative 'post_install'

data/lib/app_config/flickr_search.rb

@@ -0,0 +1,74 @@
+module AppConfig
+  module FlickrSearch
+    def self.options(config)
+      config['flickr'].each do |key, val|
+        const_set(key, val)
+      end
+    end
+
+    def search_and_save_flickr_image(text)
+      uri = URI(search_flickr_for(text))
+      download_and_write_to_file uri
+    end
+
+    def search_flickr_for(search_term)
+      response_body = build_query_for(search_term).read_body
+      response_data = response_body.to_s.match(/\[([^\}]+)\}/)[0]
+                      .sub(/^\[/, '')
+      json_response = JSON.parse response_data
+      construct_image_url_from json_response
+    rescue JSON::ParserError
+      puts "\nJSON Parser Error Detected. Retrying ..."
+      search_flickr_for(new_word)
+    end
+
+    def image_list
+      Dir[TEMP_DIR + '/*']
+    end
+
+    private
+
+    def download_and_write_to_file(uri)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        filepath = File.join(TEMP_DIR, File.basename(uri.path))
+        open(filepath, 'wb') do |file|
+          file.write http.get(uri).read_body
+          file.close
+        end
+      end
+    rescue URI::InvalidURIError
+      puts 'URI::InvalidURIError Detected'
+    end
+
+    def build_query_for(word)
+      uri = uri_for word
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new uri
+        http.request request
+      end
+    end
+
+    def uri_for(search_text)
+      URI(
+        uri_builder(
+          url: API_URL, format: API_FORMAT, sort: API_SORT,
+          method: API_METHOD, text: search_text,
+          tag_mode: :all, api_key: API_KEY
+        )
+      )
+    end
+
+    def uri_builder(params = {})
+      url = params[:url]
+      params.reject! { |k, _| k == :url }
+      url + params.each_pair.map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    def construct_image_url_from(json)
+      <<-URL.gsub(/\s+/, '').strip
+         https://farm#{json['farm']}.staticflickr.com/
+         #{json['server']}/#{json['id']}_#{json['secret']}.jpg
+      URL
+    end
+  end
+end

data/lib/app_config/magick_collage.rb

@@ -0,0 +1,30 @@
+module AppConfig
+  module MagickCollage
+    def self.options(config)
+      config['imagemagick'].each do |key, val|
+        const_set(key, val)
+      end
+    end
+
+    def build(file = 'collage.jpg')
+      crop_images
+      system <<-COMMAND.gsub(/\s+|\n/, ' ')
+        montage #{::AppConfig::FlickrSearch::TEMP_DIR}/cropped*.png
+        -geometry #{IMG_SIZE / COLUMNS}x#{IMG_SIZE / COLUMNS}#{BORDR_SIZE}
+        background #{BG_COLOR}
+        -tile #{COLUMNS}x#{ROWS} #{file}
+        2>/dev/null
+      COMMAND
+    end
+
+    def crop_images
+      system <<-COMMAND.gsub(/\s+|\n/, ' ')
+        convert
+        #{::AppConfig::FlickrSearch::TEMP_DIR}/*.jpg -gamma .45455
+        -crop #{IMG_SIZE / COLUMNS}x#{IMG_SIZE / COLUMNS}+0+0 +repage
+        -gamma 2.2 #{::AppConfig::FlickrSearch::TEMP_DIR}/cropped.png
+        2>/dev/null
+        COMMAND
+    end
+  end
+end

data/lib/app_config/options.rb

@@ -0,0 +1,9 @@
+module AppConfig
+  module Options
+    def self.options(config)
+      config['options'].each do |key, val|
+        const_set(key, val)
+      end
+    end
+  end
+end

data/lib/collage.rb

@@ -0,0 +1,60 @@
+# Collage is the main class that kicks off various code for searching,
+# downloading and stitching together images to produce collage
+class Collage
+  attr_reader :search_words
+
+  def initialize(words)
+    create_and_clean_temp_directory
+    @search_words = fill_missing words
+  end
+
+  def download_images
+    Thread.new { animate_cursor }.run
+    @search_words.each_slice(COLUMNS) do |slice|
+      slice.map do |word|
+        Thread.new do
+          search_and_save_flickr_image word
+          print "**"
+        end.run
+      end.each(&:join)
+    end
+    self
+  end
+
+  private
+
+  def create_and_clean_temp_directory
+    FileUtils.remove_dir(TEMP_DIR) if File.directory?(TEMP_DIR)
+    FileUtils.mkdir(TEMP_DIR)
+  end
+
+  def fill_missing(words)
+    if words.count < MIN_WORD_COUNT
+      (MIN_WORD_COUNT - words.count).times { words << new_word }
+    end
+    words
+  end
+
+  def new_word
+    word = DICTIONARY.sample
+    if ascii?(word)
+      word
+    else
+      puts "\nNon-Ascii Word Detected : #{word}. Retrying ..."
+      new_word
+    end
+  end
+
+  def ascii?(word)
+    word.force_encoding('UTF-8').ascii_only?
+  end
+
+  def animate_cursor
+    char = %w(| / - \\).cycle
+    loop do
+      print "\b"
+      print "#{char.next}"
+      sleep 0.05
+    end
+  end
+end

data/lib/dictionary.rb

@@ -0,0 +1,7 @@
+module AppConfig
+  module Dictionary
+    def self.included(klass)
+      klass.const_set(:DICTIONARY, File.read(klass::DICT_PATH).split("\n"))
+    end
+  end
+end

data/lib/post_install.rb

@@ -0,0 +1,14 @@
+module AppConfig
+  module PostInstall
+    def self.message
+      unless File.directory?(File.expand_path('~/.collage', __FILE__))
+        FileUtils.mkdir(File.expand_path('~/.collage/'))
+        FileUtils.cp('config.yaml', File.expand_path('~/.collage/config.yaml'))
+        puts <<-MESSAGE
+      A basic Yaml Configuration file has been copied to ~/.collage/config.yaml
+      you modify that to change some setting.
+      MESSAGE
+      end
+    end
+  end
+end

data/lib/string_refinements.rb

@@ -0,0 +1,7 @@
+module Camelizer
+  refine String do
+    def camelize
+      split('_').map(&:capitalize).join
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+module AppConfig
+  module Version
+    STRING = '0.0.1'.freeze
+  end
+end

data/loader.rb

@@ -0,0 +1,20 @@
+['../lib', '../lib/app_config'].each do |dir|
+  $LOAD_PATH << File.expand_path(dir, __FILE__)
+end
+
+require 'yaml'
+require 'net/http'
+require 'json'
+require 'fileutils'
+require 'string_refinements'
+require 'app_config'
+require 'dictionary'
+require 'collage'
+
+class Collage
+  include AppConfig
+  include Options
+  include Dictionary
+  include FlickrSearch
+  include MagickCollage
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require_relative '../loader'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride' # Colorful tests
+
+def sample_10_words
+  ARGV[0..9] = 'cat', 'dog', 'crow', 'cow', 'elephant',
+               'tree_snake', 'women', 'red', 'tower', 'beach'
+end
+
+def sample_8_words
+  ARGV[0..7] = 'cat', 'dog', 'crow', 'cow', 'elephant',
+               'tree_snake', 'women', 'red'
+end
+
+def sample_5_words
+  ARGV[0..5] = 'cat', 'dog', 'crow', 'cow', 'elephant'
+end
+
+def sample_2_words
+  ARGV[0..1] = 'cat', 'dog'
+end

data/spec/test_collage.rb

@@ -0,0 +1,30 @@
+require_relative '../loader'
+require_relative 'spec_helper'
+
+describe Collage do
+  before do
+    @collage = Collage.new(sample_10_words)
+  end
+  it 'should be able to read the words as commandline options and store them' do
+    @collage.search_words.count.must_equal 10
+  end
+
+  it 'should have 10 exact words in ARGV' do
+    @collage.search_words.must_equal ARGV[0..9]
+  end
+
+  it 'should verify the search wordcount and add 2 more words if required' do
+    @collage = Collage.new(sample_8_words)
+    @collage.search_words.count.must_equal 10
+  end
+
+  it 'should verify the search wordcount and add 5 more words if required' do
+    @collage = Collage.new(sample_5_words)
+    @collage.search_words.count.must_equal 10
+  end
+
+  it 'should verify the search wordcount and add 8 more words if required' do
+    @collage = Collage.new(sample_2_words)
+    @collage.search_words.count.must_equal 10
+  end
+end

data/spec/test_flickr_search.rb

@@ -0,0 +1,18 @@
+require_relative '../loader'
+require_relative 'spec_helper'
+
+describe ::AppConfig::FlickrSearch do
+  before do
+    @collage = Collage.new(sample_10_words)
+    @dict = File.read('/usr/share/dict/words').split("\n")
+  end
+
+  it 'should be able to search flickr api for a given search term' do
+    @collage.search_and_save_flickr_image(@dict.sample)
+    @collage.get_image_list.count.must_equal 1
+  end
+
+  it 'should search flickr api with sample words and store all images' do
+    @collage.download_images.get_image_list.count.must_equal 10
+  end
+end

data/spec/test_magick_collage.rb

@@ -0,0 +1,14 @@
+require_relative '../loader'
+require_relative 'spec_helper'
+
+describe ::AppConfig::MagickCollage do
+  before do
+    @collage = Collage.new(sample_5_words)
+  end
+
+  it 'should crop the images' do
+    @collage.download_images
+    @collage.crop_images
+    @collage.get_image_list.select { |i| i =~ /cropped/ }.count.must_equal 10
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: flickr_collager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pankaj Doharey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.9.0
+description: Collage Builder
+email:
+- pankajdoharey@gmail.com
+executables:
+- collage
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/collage
+- config.yaml
+- flickr_collager.gemspec
+- lib/app_config.rb
+- lib/app_config/flickr_search.rb
+- lib/app_config/magick_collage.rb
+- lib/app_config/options.rb
+- lib/collage.rb
+- lib/dictionary.rb
+- lib/post_install.rb
+- lib/string_refinements.rb
+- lib/version.rb
+- loader.rb
+- spec/spec_helper.rb
+- spec/test_collage.rb
+- spec/test_flickr_search.rb
+- spec/test_magick_collage.rb
+homepage: http://selfdotsend.com
+licenses:
+- WTFPL
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Flickr based Collage builder
+test_files:
+- spec/spec_helper.rb
+- spec/test_collage.rb
+- spec/test_flickr_search.rb
+- spec/test_magick_collage.rb