words_to_image 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cca0cf3ff67d38ada24d0e54af212cb0d441b0b6
+  data.tar.gz: e083dc22715bb2b12551fe524c6e476ad9403385
+SHA512:
+  metadata.gz: 71428f5b5562691eba5ac2afcae5507109ea5586d844e95b3472d98cc1d4b50a4866e6d144791edb0a53e6fe8ffb0e1b05be6a076b0d0a1550de8305482598cc
+  data.tar.gz: a1634ec4b5725c5b85c58fa7d1e8bc417861ea88e5f20e9406f8f64dc85e3b4cdcb7d89555f8939844255db69545c1a7fb245a442e56d17bd8cb752244262754

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.jpg
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Alona Mekhovova
+
+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,22 @@
+# Wokds To Image
+
+TODO: Write a gem description
+
+## Installation
+---------------> don't forget an instruction for ImageMagick
+Add this line to your application's Gemfile:
+
+    gem 'words_to_image'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install words_to_image
+
+## Usage
+
+TODO: Write usage instructions here
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec
+

data/collage.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib/words_to_image', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "words_to_image"
+  spec.version       = "0.0.2"
+  spec.authors       = ["Alona Mekhovova"]
+  spec.email         = ["alona.tarasova@gmail.com"]
+  spec.summary       = "A collage maker based on flickr search results"
+  spec.description   = %q{
+    command line application that
+
+    * accepts a list of search keywords as arguments
+    * queries the Flickr API for the top-rated image for each keyword
+    * downloads the results
+    * crops them rectangularly
+    * assembles a collage grid from ten images and
+    * writes the result to a user-supplied filename
+
+    If given less than ten keywords, or if any keyword fails to
+    result in a match, retrieve random words from a dictionary
+    source such as `/usr/share/dict/words`. Repeat as necessary
+    until you have gathered ten images.
+  }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["config", "lib/words_to_image"]
+
+  spec.add_runtime_dependency "flickraw"
+  spec.add_runtime_dependency "mini_magick"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/config/defaults.rb

@@ -0,0 +1,8 @@
+module WordsToImage
+  DEFAULT_SETTINGS = {
+    images_count:     10,
+    max_row_width:    750,
+    dictionary_path:  '/usr/share/dict/words',
+    result_path:      'collage.jpg'
+  }
+end

data/config/flickr_init.rb

@@ -0,0 +1,4 @@
+require "flickraw"
+
+FlickRaw.api_key = "8fca6afb87df44c1c3c5dd5e47f22434"
+FlickRaw.shared_secret = "382bf25da4b58e3d"

data/lib/words_to_image/collage.rb

@@ -0,0 +1,53 @@
+require 'defaults'
+
+module WordsToImage
+  class Collage
+    def initialize(path, max_row_width, images_count)
+      @path             = valid_path(path)
+      @img_per_row      = [(max_row_width / 150).to_i, images_count].min
+      @rows_count       = (images_count / @img_per_row.to_f).ceil
+
+      @images_connected = 0
+      get_collage_file
+    end
+
+    def +( image )
+      img = MiniMagick::Image.new(@path)
+      second_image = MiniMagick::Image.new(image.filename)
+
+      img = img.composite(second_image) do |i|
+        i.compose "Over"
+        i.geometry "+#{horizontal_offset}+#{vertical_offset}"
+      end
+      img.write(@path)
+
+      @images_connected += 1
+      self
+    end
+
+    private
+    def get_collage_file
+      `convert -size #{@img_per_row * 150}x#{@rows_count * 150} canvas:white #{@path}`
+    end
+
+    def horizontal_offset
+      (@images_connected % @img_per_row) * 150
+    end
+
+    def vertical_offset
+      (@images_connected / @img_per_row) * 150
+    end
+
+    def valid_path(path)
+      dir, base = File.split(path)
+
+      base += ".jpg" unless base[/\.\w+$/]
+
+      raise "Directory unwritable" unless File.writable?(dir)
+
+      "#{dir}/#{base}"
+    rescue => e
+      raise ArgumentError, "invalid result file path: #{e.message}"
+    end
+  end
+end

data/lib/words_to_image/dictionary.rb

@@ -0,0 +1,23 @@
+module WordsToImage
+  class Dictionary
+    def initialize(path)
+      @path = path
+    end
+
+    def get_word
+      words.delete(words.sample)
+    end
+
+    private
+    def words
+      @words ||= read_content
+    end
+
+    def read_content
+      contents = File.read(@path)
+      contents.split
+    rescue => e
+      raise IOError, "Dictionary file unreadable: #{e.message}"
+    end
+  end
+end

data/lib/words_to_image/flickr.rb

@@ -0,0 +1,15 @@
+require "flickraw"
+require "flickr_init"
+
+module WordsToImage
+  class Flickr
+    def self.fetch(keyword)
+      photo = flickr.photos.search(text: keyword, media: :photos, per_page: 1, sort: "interestingness-desc").first
+      return if photo.nil?
+
+      FlickRaw.url_q OpenStruct.new(photo.to_hash)
+    rescue => e
+      raise "problem connecting to flickr API: #{e.message}"
+    end
+  end
+end

data/lib/words_to_image/image.rb

@@ -0,0 +1,55 @@
+require 'mini_magick'
+
+module WordsToImage
+  class Image
+    def initialize(path)
+      @path = path
+      @square_size = 150 #px
+    end
+
+    def squarize!
+      img = MiniMagick::Image.new(filename)
+
+      w_original, h_original = [img[:width].to_f, img[:height].to_f]
+
+      # check proportions
+      if w_original < h_original
+        bigger_side = (h_original * @square_size / w_original).to_i
+        remove = "0x#{ ((bigger_side - @square_size)/2.0).to_i }"
+      else
+        bigger_side = (w_original * @square_size / h_original).to_i
+        remove = "#{ ((bigger_side - @square_size)/2.0).to_i }x0"
+      end
+      op_resize = [bigger_side, bigger_side].join("x")
+
+      img.resize(op_resize)
+      img.shave(remove)
+
+      self
+    rescue => e
+      raise IOError, "failed to modify an image: #{e.message}"
+    end
+
+    def download
+      open(URI.parse(@path)) { |image|
+        File.open(filename, "wb") do |file|
+          file.puts image.read
+        end
+      }
+
+      self
+    rescue => e
+      raise IOError, "image download error: #{e.message}"
+    end
+
+    def filename
+      @filename ||= "img_#{Time.now.to_f}#{@path[/\.\w+$/]}"
+    end
+
+    def delete!
+      File.delete(filename)
+    rescue
+      puts "! could not delete temporary file: #{filename}"
+    end
+  end
+end

data/lib/words_to_image/processor.rb

@@ -0,0 +1,41 @@
+require 'defaults'
+
+module WordsToImage
+  class Processor
+    def initialize(local_settings={})
+      @images_count    = local_settings[:images_count] || DEFAULT_SETTINGS[:images_count]
+      @dictionary_path = local_settings[:dictionary_path] || DEFAULT_SETTINGS[:dictionary_path]
+      @result_path     = local_settings[:result_path] || DEFAULT_SETTINGS[:result_path]
+      @max_row_width   = [local_settings[:max_row_width] || DEFAULT_SETTINGS[:max_row_width], 150].max
+
+      @images, @words  = [], []
+      @dictionary      = Dictionary.new(@dictionary_path)
+    end
+
+    def get_images(keywords=[])
+      while !collection_complete?
+        keyword = keywords.shift || @dictionary.get_word
+        raise ArgumentError, "not enough words to complete a collage" unless keyword
+
+        next unless image = Flickr.fetch( keyword )
+        @images << image
+        @words << keyword
+      end
+    end
+
+    def create_collage
+      @result = Collage.new(@result_path, @max_row_width, @images.count)
+
+      @images.each do |path|
+        image = Image.new(path).download.squarize!
+        @result += image
+        image.delete!
+      end
+    end
+
+    private
+    def collection_complete?
+      @images.count == @images_count
+    end
+  end
+end

data/spec/fixtures/sample_dict

@@ -0,0 +1,15 @@
+part
+jelly
+play
+tough
+bear
+include
+stretch
+applaud
+right
+unit
+hover
+hobbies
+defeated
+things
+useless

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+Dir.glob('lib/**/*.rb') {|file| require File.basename(file)}
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :documentation
+  config.before { allow(FlickRaw::Flickr).to receive(:new).and_return(OpenStruct.new(photos: {})) }
+end

data/spec/words_to_image/collage_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe WordsToImage::Collage do
+  let(:collage) { WordsToImage::Collage.new('path', 333, 5) }
+  let(:image) {double("mini_magick image")}
+
+  before do
+    allow_any_instance_of(WordsToImage::Collage).to receive(:get_collage_file)
+    allow(MiniMagick::Image).to receive(:new).and_return(image)
+  end
+
+  describe "#initialize" do
+    it "should fix the path given" do
+      expect(collage.instance_variable_get(:"@path")).to eq("./path.jpg")
+    end
+
+    context "inexisting path" do
+      it "should raise an error" do
+        expect {
+          WordsToImage::Collage.new('/inexisting/directory/file', 333, 5)
+        }.to raise_error(ArgumentError, /Directory unwritable/)
+      end
+    end
+  end
+
+  describe "#+" do
+    it "should connect an image to collage" do
+      expect(image).to receive(:composite).and_return(double("image", write: {}))
+
+      collage + WordsToImage::Image.new('path')
+    end
+  end
+end

data/spec/words_to_image/dictionary_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe WordsToImage::Dictionary do
+  SAMPLE_PATH = 'spec/fixtures/sample_dict'
+
+  describe "#get_word" do
+    let(:dictionary) { WordsToImage::Dictionary.new(SAMPLE_PATH) }
+
+    it "should return one word from the set" do
+      words = File.read(SAMPLE_PATH).split
+
+      words.count.times do
+        expect(words).to include(dictionary.get_word)
+      end
+    end
+
+    it "should return words in random order" do
+      dict2 = WordsToImage::Dictionary.new(SAMPLE_PATH)
+
+      words = (1..5).map { dictionary.get_word }
+      words2 = (1..5).map { dict2.get_word }
+
+      expect(words).not_to eq words2
+    end
+
+    context "no words left" do
+      before do
+        allow(dictionary).to receive(:read_content).and_return([])
+      end
+
+      it "should return nil" do
+        expect(dictionary.get_word).to be_nil
+      end
+    end
+
+    context "file unreadable" do
+      let(:inexisting_dict) { WordsToImage::Dictionary.new('/inexisting/path') }
+
+      it "should raise an exception with verbose description" do
+        expect{inexisting_dict.get_word}.to raise_error(IOError)
+      end
+    end
+  end
+end

data/spec/words_to_image/flickr_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe WordsToImage::Flickr do
+  describe ".fetch" do
+    context "image found" do
+      before do
+        photo_info = {id: 123, server: 456, title: "Pure beauty"}
+
+        allow(flickr.photos).to receive("search").and_return([photo_info])
+        allow(FlickRaw).to receive("url_q").with(OpenStruct).and_return("http://image_url")
+      end
+
+      it "should fetch an image using flickr API" do
+        expect(WordsToImage::Flickr.fetch("weihnachten")).to eq "http://image_url"
+      end
+    end
+
+    context "nothing found" do
+      before do
+        allow(flickr.photos).to receive("search").and_return([])
+      end
+
+      it "should return nil if nothing fetched" do
+        expect(WordsToImage::Flickr.fetch("weihnachten")).to be_nil
+      end
+    end
+
+    context "fetch is impossible" do
+      before do
+        allow(flickr.photos).to receive("search").and_raise(StandardError, "no internet")
+      end
+
+      it "should raise an error" do
+        expect{WordsToImage::Flickr.fetch("weihnachten")}.to raise_error(RuntimeError, "problem connecting to flickr API: no internet")
+      end
+    end
+  end
+end

data/spec/words_to_image/image_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe WordsToImage::Image do
+  let(:image) { WordsToImage::Image.new('http://image.jpg') }
+  let(:image_file) { double("image file", shave: nil, resize: nil) }
+  before do
+    allow(MiniMagick::Image).to receive(:new).and_return(image_file)
+  end
+
+  describe "#squarize!" do
+    context "initially square image" do
+      before do
+        allow(image_file).to receive(:[]).with(:width).and_return(300)
+        allow(image_file).to receive(:[]).with(:height).and_return(300)
+      end
+
+      it "should resize the image" do
+        expect(image_file).to receive(:resize).with("150x150")
+
+        image.squarize!
+      end
+
+      it "should NOT crop the image" do
+        expect(image_file).to receive(:shave).with("0x0")
+
+        image.squarize!
+      end
+    end
+
+    context "image has landscape layout" do
+      before do
+        allow(image_file).to receive(:[]).with(:width).and_return(400)
+        allow(image_file).to receive(:[]).with(:height).and_return(300)
+      end
+
+      it "should resize the image by longer part" do
+        expect(image_file).to receive(:resize).with("200x200")
+
+        image.squarize!
+      end
+
+      it "should crop the image horizontally" do
+        expect(image_file).to receive(:shave).with("25x0")
+
+        image.squarize!
+      end
+    end
+
+    context "image has portrait layout" do
+      before do
+        allow(image_file).to receive(:[]).with(:width).and_return(200)
+        allow(image_file).to receive(:[]).with(:height).and_return(400)
+      end
+
+      it "should resize the image by longer part" do
+        expect(image_file).to receive(:resize).with("300x300")
+
+        image.squarize!
+      end
+
+      it "should crop the image vertically" do
+        expect(image_file).to receive(:shave).with("0x75")
+
+        image.squarize!
+      end
+    end
+
+  end
+end

data/spec/words_to_image/processor_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe WordsToImage::Processor do
+  let(:processor) { WordsToImage::Processor.new }
+
+  describe "#initialize" do
+    it "should set all default configs" do
+      WordsToImage::DEFAULT_SETTINGS.each_pair do |setting, value|
+        expect(processor.instance_variable_get(:"@#{setting}")).to eq value
+      end
+    end
+
+    it "should setup the user input vars with higher prio" do
+      local_settings = {
+        images_count:     3,
+        dictionary_path:  'other path',
+        result_path:      'my secret place'
+      }
+
+      processor1 = WordsToImage::Processor.new(local_settings)
+      local_settings.each_pair do |setting, value|
+        expect(processor1.instance_variable_get(:"@#{setting}")).to eq value
+      end
+    end
+  end
+
+  describe "#get_images" do
+    let(:processor) { WordsToImage::Processor.new(images_count: 5) }
+
+    before do
+      allow(WordsToImage::Flickr).to receive(:fetch).and_return("http://image_url")
+    end
+
+    it "should fetch enough images using keywords" do
+      processor.get_images(["word1", "word2", "word3", "word4", "word5"])
+
+      expect(processor.instance_variable_get(:"@images").count).to eq 5
+    end
+
+    it "should use the dictionary it additional words needed" do
+      expect_any_instance_of(WordsToImage::Dictionary).to receive(:get_word).exactly(3).times.and_return("random word")
+
+      processor.get_images(["word1", "word2"])
+    end
+
+    context "not enough words available" do
+      before do
+        allow_any_instance_of(WordsToImage::Dictionary).to receive(:words).and_return([])
+      end
+
+      it "should raise an error" do
+        expect{processor.get_images}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: words_to_image
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alona Mekhovova
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-28 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: mini_magick
+  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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    command line application that\n\n    * accepts a list of search
+  keywords as arguments\n    * queries the Flickr API for the top-rated image for
+  each keyword\n    * downloads the results\n    * crops them rectangularly\n    *
+  assembles a collage grid from ten images and\n    * writes the result to a user-supplied
+  filename\n\n    If given less than ten keywords, or if any keyword fails to\n    result
+  in a match, retrieve random words from a dictionary\n    source such as `/usr/share/dict/words`.
+  Repeat as necessary\n    until you have gathered ten images.\n  "
+email:
+- alona.tarasova@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- collage.gemspec
+- config/defaults.rb
+- config/flickr_init.rb
+- lib/words_to_image/collage.rb
+- lib/words_to_image/dictionary.rb
+- lib/words_to_image/flickr.rb
+- lib/words_to_image/image.rb
+- lib/words_to_image/processor.rb
+- spec/fixtures/sample_dict
+- spec/spec_helper.rb
+- spec/words_to_image/collage_spec.rb
+- spec/words_to_image/dictionary_spec.rb
+- spec/words_to_image/flickr_spec.rb
+- spec/words_to_image/image_spec.rb
+- spec/words_to_image/processor_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- config
+- lib/words_to_image
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A collage maker based on flickr search results
+test_files:
+- spec/fixtures/sample_dict
+- spec/spec_helper.rb
+- spec/words_to_image/collage_spec.rb
+- spec/words_to_image/dictionary_spec.rb
+- spec/words_to_image/flickr_spec.rb
+- spec/words_to_image/image_spec.rb
+- spec/words_to_image/processor_spec.rb