fccc 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79bc017cdb587c605747522ec0b5f1986b61b511
+  data.tar.gz: a2dd7933534c9859a4760a29c381bd49137e0e86
+SHA512:
+  metadata.gz: bc62dcfc92434dc2da86ed4961879c73ba360a035c88a560d3b511edda582baf5b0a0ca0f50fc6506377deb77c6a2f42a6eaea7ec287b94d5e2b2699fa8b05ce
+  data.tar.gz: 1d432d0108f552faa6231a78e3a546110c542855aa0d5d14a038c3082376540f52a618cd5aa6e7ebca084c0592c53cd7935845c08d290c34fe507d058b179fe4

data/.gitignore

@@ -0,0 +1,113 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/
+Rakefile
+LiCENSE.txt
+/spec/reports/
+/tmp/
+*.jpg
+.rspec
+.travis.yml
+/release/
+credentials.yml
+
+# Created by https://www.gitignore.io/api/vim,ruby,osx
+
+### Vim ###
+# swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fccc.gemspec
+# gemspec
+
+gem 'thor', '~> 0.19.1'
+gem 'flickraw', '~> 0.9.8'
+gem 'rmagick', '~> 2.15', '>= 2.15.4'
+gem 'random-word', '~> 1.3'

data/README.md

@@ -0,0 +1,120 @@
+# fccc - Flickr Collage Coding Challenge
+
+[![Code Climate](https://codeclimate.com/github/AkihikoITOH/fccc/badges/gpa.svg)](https://codeclimate.com/github/AkihikoITOH/fccc)
+
+## Features
+
+### Basic
+Ruby command line application that
+
+* [x] accepts a list of search keywords as arguments
+* [x] queries the Flickr API for the top-rated image for each keyword
+* [x] downloads the results
+* [x] crops them rectangularly
+* [x] assembles a collage grid from ten images and
+* [x] writes the result to a user-supplied filename
+* [x] adds suffix to filename if user-supplied one already exists.
+* [x] If given less than ten keywords, or if any keyword fails to result in a match, retrieves random words from a dictionary source and repeats as necessary until it has gathered ten images.
+
+### Additional features
+
+* [x] Wrapped in a Gem and installable from Github repo.
+* [x] You can provide keywords either as arguments or from a file.
+
+## Installation
+
+### Requirements
+
+- Ruby `2.2.x` or `2.3.x`
+  * `apt-get install ruby ruby-dev` (Ubuntu)
+- [ImageMagick](http://www.imagemagick.org/script/binary-releases.php)
+  * `brew install imagemagick && brew install pkg-config` (Mac OSX)
+  * `apt-get install imagemagick libmagickcore-dev libmagickwand-dev` (Ubuntu)
+- [Bundler](http://bundler.io/)
+  * `gem install bundler`
+
+### Install fccc
+There are three ways to install fccc:
+
+- Install from Github (Recommended)
+- Install locally
+- Just as a Ruby script
+
+#### Install from Github
+First, create `Gemfile` in your current directory.
+`Gemfile` should be like this.
+```ruby
+# Gemfile
+source 'https://rubygems.org'
+gem 'fccc', :git => 'http://github.com/AkihikoITOH/fccc.git'
+```
+
+Then, run
+```bash
+$ bundle install
+```
+to install fccc.
+
+#### Install locally
+You can also build gem and install it locally.
+```bash
+$ git clone https://github.com/AkihikoITOH/fccc.git
+$ cd fccc && gem build fccc.gemspec
+$ gem install fccc-0.1.0.gem
+```
+
+#### Just as a ruby script
+You can also use fccc by simply downloading file from Github.
+```bash
+$ git clone https://github.com/AkihikoITOH/fccc.git
+$ cd fccc
+$ ruby lib/fccc.rb
+```
+
+## Usage
+
+First, you need to put `credentials.yml` containing `api_key` and `shared_secret` of Flickr API in your current directory(in which you will run `fccc` command).
+
+`credentials.yml` should be like this.
+```yaml
+api_key: yourapikeyhere
+shared_secret: yoursecretkeyhere
+```
+
+```bash
+# As a command line application
+$ fccc collage [keyword1, keyword2, ..., keyword10] --output [output_filename]
+# If it doesn't work, you can try another way
+$ bundle exec fccc collage [keyword1, keyword2, ..., keyword10] --output [output_filename]
+
+# As a Ruby script
+$ cd fccc/
+$ ruby lib/fccc.rb collage keyword1, keyword2, ..., keyword10 --output filename
+```
+
+### Example
+```bash
+# Basic
+$ fccc collage dog, cat, lion, tiger, beetle, bee, salmon, mackerel, Kyoto, Hamburg --output mycollage
+
+# If you have a list of keywords in a file, you can use it as input instead of giving them as arguments.
+$ fccc collage --input keywords.txt --credential credentials.yml --output mycollage
+```
+
+`keywords.txt` should be like this.
+```
+dog
+cat
+lion
+tiger
+beetle
+bee
+salmon
+mackerel
+Kyoto
+Hamburg
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fccc"
+
+# 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/fccc

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby -wU
+# -*- encoding: utf-8 -*-
+
+require 'fccc'

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/fccc

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "fccc"

data/fccc.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fccc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fccc"
+  spec.version       = Fccc::VERSION
+  spec.authors       = ["Akihiko ITOH"]
+  spec.email         = ["itoh@ai.soc.i.kyoto-u.ac.jp"]
+
+  spec.summary       = "Search images on Flickr for given keywords and create a collage with them."
+  spec.description   = "Description: Search images on Flickr for given keywords and create a collage with them."
+  spec.homepage      = "https://github.com/AkihikoITOH/fccc"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "flickraw", "~> 0.9.8"
+  spec.add_dependency "rmagick", "~> 2.15", ">= 2.15.4"
+  spec.add_dependency "random-word", "~> 1.3"
+end

data/keywords.txt

@@ -0,0 +1,10 @@
+dog
+cat
+lion
+tiger
+beetle
+bee
+salmon
+mackerel
+Kyoto
+Hamburg

data/lib/fccc.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+$:.unshift File.dirname(__FILE__)
+require 'fccc/version'
+require 'fccc/cli'
+
+Fccc::CLI.start(ARGV)

data/lib/fccc/cli.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+$:.unshift File.dirname(__FILE__)
+require 'time'
+require 'thor'
+require 'utils'
+
+SMALL_WIDTH = 160
+SMALL_HEIGHT = 160
+COLLAGE_WIDTH = 5
+COLLAGE_HEIGHT = 2
+NUM_KEYWORDS = 10 # Expected number of keywords
+
+module Fccc
+  class CLI < Thor
+    desc "collage keyword1, keyword2, ..., keyword#{NUM_KEYWORDS}", "This will search a top-rated image for each keyword and create collage with them."
+    option :output
+    option :input
+    def collage(*keywords)
+      collage = Utils::Collage.new(SMALL_WIDTH, SMALL_HEIGHT, COLLAGE_WIDTH, COLLAGE_HEIGHT, NUM_KEYWORDS)
+      if !options[:input].nil?
+        # Get keywords from a file
+        keywords = File.readlines(File.join(Dir.pwd, "#{options[:input]}")).map do |line|
+          line.strip if line.strip != ""
+        end
+      end
+      # Clean up keywords
+      keywords = keywords.map do |kw|
+        kw.gsub(/[,]/ ,"").strip
+      end
+      # Force resize keywords array.
+      # If it has more than NUM_KEYWORDS elements, just ignore extra elements.
+      # If it has less than NUM_KEYWORDS elements, fill the rest with nil.
+      keywords = Array.new(NUM_KEYWORDS).zip(keywords).map(&:last)
+      # Download images
+      collage.download_images_by_keywords(keywords)
+      # Create and save collage
+      output = options[:output]
+      if output.nil?
+        # Default filename with timestamp
+        output_file = File.join(Dir.pwd, "collage-#{Time.now.utc.iso8601.gsub(/[:]/ ,"-")}.jpg")
+      else
+        # User-supplied filename
+        output_file = File.join(Dir.pwd, "#{output}.jpg")
+        while File.exist?(output_file) do
+          # Increment suffix if the file exists
+          output_file = Utils.increment_filename(output_file)
+        end
+      end
+      collage.create_collage(output_file)
+    end
+  end
+end

data/lib/fccc/utils.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'yaml'
+require 'flickraw'
+require 'rmagick'
+require 'random-word'
+
+CREDENTIALS_PATH = File.join(Dir.pwd, "credentials.yml")
+
+module Utils
+  class Collage
+    def initialize(small_width, small_height, collage_width, collage_height, num_images)
+      # Size of each image in collage in pixel
+      @small_width = small_width
+      @small_height = small_height
+      # Number of columns and rows of a collage
+      @collage_width = collage_width
+      @collage_height = collage_height
+      @num_images = num_images
+      Utils.load_credentials(CREDENTIALS_PATH)
+    end
+
+    def download_images_by_keywords(keywords)
+      # Get image url for each keyword
+      img_urls = Array.new()
+      keywords.each do |kw|
+        # Apparently no image without keyword
+        kw.nil? ? img = nil : img = flickr.photos.search(text: kw, per_page: 1)[0]
+        while img.nil? do
+          # Randomly pick an English word and search top-rated image for the word
+          puts "*** Image for '#{kw}' not found. Trying a randomly picked word. ***"
+          kw = RandomWord.nouns.next.strip
+          img = flickr.photos.search(text: kw, per_page: 1)[0]
+        end
+        url = FlickRaw.url(img)
+        puts "Image for '#{kw}' => #{url}"
+        img_urls.push(url)
+      end
+      # Download images
+      puts "Downloading images..."
+      @images = img_urls.map do |url|
+        Magick::Image.read(url).first
+      end
+    end
+
+    def create_collage(output_path)
+      # Create collage
+      puts "Creating collage..."
+      # Prepare a base image
+      @collage = Magick::Image.new(@small_width * @collage_width, @small_height * @collage_height) do
+        self.background_color = "black"
+      end
+      # Add rectangularly resized images to the base image
+      @images.each_with_index do |img, idx|
+        @collage.composite!(img.resize_to_fill!(@small_width, @small_height),
+                           @small_width * (idx % @collage_width),
+                           @small_height * (idx / @collage_width),
+                           Magick::OverCompositeOp
+                          )
+      end
+      # Save collage to a designated path
+      @collage.write(output_path)
+      puts "Collage saved to #{output_path} ."
+    end
+  end
+
+  def self.increment_filename(path)
+    _, filename, count, extension = *path.match(/(\A.*?)(?:_#(\d+))?(\.[^.]*)?\Z/)
+    count = (count || '0').to_i + 1
+    return "#{filename}_##{count}#{extension}"
+  end
+
+  def self.load_credentials(path)
+    credentials = YAML.load_file(path)
+    FlickRaw.api_key = credentials["api_key"]
+    FlickRaw.shared_secret = credentials["shared_secret"]
+  end
+end

data/lib/fccc/version.rb

@@ -0,0 +1,3 @@
+module Fccc
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fccc
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Akihiko ITOH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-01 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.4
+- !ruby/object:Gem::Dependency
+  name: random-word
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 'Description: Search images on Flickr for given keywords and create a
+  collage with them.'
+email:
+- itoh@ai.soc.i.kyoto-u.ac.jp
+executables:
+- fccc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- README.md
+- bin/console
+- bin/fccc
+- bin/setup
+- exe/fccc
+- fccc.gemspec
+- keywords.txt
+- lib/fccc.rb
+- lib/fccc/cli.rb
+- lib/fccc/utils.rb
+- lib/fccc/version.rb
+homepage: https://github.com/AkihikoITOH/fccc
+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.1
+signing_key: 
+specification_version: 4
+summary: Search images on Flickr for given keywords and create a collage with them.
+test_files: []