flico 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adca32d7e5ee313f13e0ea06a104fe7f1f2fb0dee521b2997c96cd0901c67dcf
-  data.tar.gz: adf98002d3585edf868ab0ddc0a655cf48b932aa3671a079217398956b0c5705
+  metadata.gz: 473a26ece9ff8cf869ea977bdc1a96a5b800848ce82f4ee0282dad74bda96bdc
+  data.tar.gz: b4e83f8d45ea19e79e4d5884603f3941af769e279d8267dff9379f662f3acbbf
 SHA512:
-  metadata.gz: f7813fde11543901c15b0f212e81a6d36968f82be4974784f09b5a45365c13e6e83a50502ecd70b56a7a9a10acdcc071cfa00dfc330516ce14175cb3358ed704
-  data.tar.gz: cf5e50c394033d3feee1f4bbb3d74ed40c07952b440b12e2e28fd16dc9d2340d12bf80526d30a2fddb2426034fc6dee57ca0947454c709ef2ba106ad77176fc8
+  metadata.gz: 55a33bfccc1180547b859c572ef4802f4bd6b6299298319e0b21519ae381b4f040b0620ffbde06e002c9d9216d6f00b559af148aa38b93d9968b10464351c918
+  data.tar.gz: c96edd9e612f9cb0dbc1711c0d0dedf5ade8be1b1e685316055cd4d48b3bbda9bbdc6c2b8aa8eea6073a9da88f10d8589b9f1c4bfad9db033d7d20664ec3ab7a

data/flico.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'flico'
-  spec.version       = '1.0.0'
+  spec.version       = '2.0.0'
   spec.summary       = 'A CLI tool to create collage from keywords using Flickr'
   spec.homepage      = 'https://github.com/amandeepbhamra/flico'
   spec.license       = 'MIT'

data/lib/flico/app.rb

@@ -1,44 +1,51 @@
 # frozen_string_literal: true
 
+require 'flico/dictionary'
+require 'flico/collager'
+require 'flico/image_file'
+
 module Flico
   class ApplicationError < StandardError; end
-  class KeywordMissing < StandardError; end
-  class NoImage < StandardError; end
-  class FetchingError < StandardError; end
 
   class App
-    attr_reader :resources
+    KEYWORDS_COUNT = 10
+
+    attr_reader :keywords, :options
 
-    def initialize(resources)
-      @resources = resources
+    def initialize(keywords, options)
+      @keywords = add_missing_keywords(keywords)
+      @options = options
     end
 
-    def create_collage
-      image_urls = []
-      loop do
-        image_urls.push get_images
-        break unless image_urls.count < 10
-      end
-      collage(image_urls)
+    def create
+      options[:file_name] = prepare_file_name(options)
+
+      Collager.new(prepare_images, options[:file_name]).save
+
+      puts "Flicollage saved at #{options[:file_name]}"
     end
 
-    def collage(images)
-      resources.save_collage.call(resources.collager.call(images))
+    def prepare_images
+      keywords.map { |keyword| ImageFile.new(keyword).fetch_from_flickr }
     end
 
-    def get_images
-      keyword           = resources.dictionary.call
-      image_url         = resources.flickr_api.call(keyword)
-      resources.fetch_image.call(image_url)
-    rescue NoImage => e
-      puts "Image not found for keyword '#{keyword}'. Message: #{e.message}. Retrying"
-      unless (tries -= 1).positive?
-        raise ApplicationError, "Failed getting image after retrying #{MAX_KEYWORD_RETRIES} times"
-      end
-
-      retry
-    rescue FetchingError => e
-      raise ApplicationError, e.message
+    private
+
+    def add_missing_keywords(words)
+      words_count = words.size
+      return words if words_count == KEYWORDS_COUNT
+
+      words += Dictionary.new.words(KEYWORDS_COUNT - words_count)
+      puts "KEYWORDS: #{words}"
+      words
+    end
+
+    def prepare_file_name(options)
+      return options[:file_name] unless options[:file_name].nil?
+
+      puts 'Enter file name for collage (press ENTER to use default)'
+      file_name = $stdin.gets.strip
+      file_name.empty? ? "flicollage-#{Time.now.strftime('%Y%m%d%H%M%S')}.png" : file_name
     end
   end
 end

data/lib/flico/collager.rb

@@ -1,44 +1,25 @@
 # frozen_string_literal: true
 
-require 'flico/grid'
 require 'mini_magick'
 
 module Flico
   class Collager
-    attr_reader :grid
+    attr_reader :images_url, :file_name
 
-    def initialize(grid = Grid.new)
-      @grid = grid
+    def initialize(images_url, file_name)
+      @images_url = images_url
+      @file_name = file_name
     end
 
-    def call(image_urls)
-      image_urls.map { |p| MiniMagick::Image.open p.path }
-      temp_file = Tempfile.new ['collage_maker', '.png']
-      MiniMagick::Tool::Convert.new do |i|
-        i.size "#{grid.canv_width}x#{grid.canv_height}"
-        i.xc 'white'
-        i << temp_file.path
-      end
-
-      image_urls.map.with_index do |path, idx|
-        image = MiniMagick::Image.open path.path
-        image.crop(grid.crop_rectangle(idx, image.width, image.height).to_mm)
-        image.resize(grid.resize_rectangle(idx, image.width, image.height).to_mm)
-        print_to_canvas(image, grid.cell_rectangle(idx), temp_file)
-      end
-      temp_file
-    end
-
-    private
-
-    def print_to_canvas(image, rectangle, temp_file)
-      canvas = MiniMagick::Image.new temp_file.path
-      result = canvas.composite(image) do |c|
-        c.compose 'Over'
-        c.geometry rectangle.to_mm
-      end
-      result.write temp_file.path
-      temp_file.rewind
+    def save
+      montage = MiniMagick::Tool::Montage.new
+      montage.density '600'
+      montage.tile '5X2'
+      montage.geometry '+10+20'
+      montage.border '5'
+      images_url.each { |image_url| montage << image_url }
+      montage << file_name
+      montage.call
     end
   end
 end

data/lib/flico/dictionary.rb

@@ -2,23 +2,34 @@
 
 module Flico
   class Dictionary
-    def initialize(dictionary_path)
-      @dictionary_path = dictionary_path
+    PATH = '/usr/share/dict/words'
+    ALPHABETS_LOWER_LIMIT = 3
+    ALPHABETS_UPPER_LIMIT = 10
+
+    def initialize
+      @dictionary_path = validate(PATH)
       @words = []
     end
 
-    def call
-      @words.shift || dictionary_word
+    def words(count)
+      @words += pick_words(count)
     end
 
-    def append(keywords)
-      @words += keywords
+    private
+
+    def pick_words(count)
+      File.readlines(PATH).select do |word|
+        word.size > ALPHABETS_LOWER_LIMIT && word.size < ALPHABETS_UPPER_LIMIT
+      end.sample(count).map(&:strip)
     end
 
-    private
+    def validate(path)
+      unless File.exist?(path)
+        warn "Exiting due to missing dictionary at path: #{path}"
+        exit 1
+      end
 
-    def dictionary_word
-      File.readlines("/usr/share/dict/words").select { |word| word.size > 3 && word.size < 10 }.sample.strip
+      path
     end
   end
 end

data/lib/flico/flickr/base_api.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'flickraw'
+
+module Flico
+  module Flickr
+    class BaseApi
+      attr_reader :key, :secret, :api
+
+      def initialize
+        @key = ENV['FLICKR_KEY']
+        @secret = ENV['FLICKR_SECRET']
+        @api = flickraw_api
+      end
+
+      def get_photo(keyword)
+        valid_keyword?(keyword)
+
+        puts "Searching images for keyword: #{keyword}"
+
+        results = search_api(keyword)
+
+        results.count.zero? ? (warn "No Image for keyword: #{keyword}") : photo_url(results.first.id)
+      end
+
+      private
+
+      def flickraw_api
+        valid_secrets?
+
+        FlickRaw.api_key = key
+        FlickRaw.shared_secret = secret
+        FlickRaw::Flickr.new
+      end
+
+      def valid_secrets?
+        if key.nil? || secret.nil?
+          warn 'Exiting due to missing required environment variables: FLICKR_KEY or FLICKR_SECRET'
+          exit 1
+        end
+
+        true
+      end
+
+      def search_api(keyword)
+        api.photos.search({ text: keyword, per_page: 10, sort: 'interestingness-desc' })
+      end
+
+      def info_api(image)
+        api.photos.getInfo(photo_id: image)
+      end
+
+      def size_api(id)
+        api.photos.getSizes(photo_id: id)
+      end
+
+      def photo_url(id)
+        size_api(id).find { |v| v['label'] == 'Square' }['source']
+      end
+
+      def valid_keyword?(keyword)
+        warn "Missing Keywords (can't be nil)" if keyword.nil?
+      end
+    end
+  end
+end

data/lib/flico/image_file.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'flico/flickr/base_api'
+
+module Flico
+  class NoImage < StandardError; end
+  class FetchingError < StandardError; end
+
+  class ImageFile
+    attr_accessor :keyword
+
+    def initialize(keyword)
+      @keyword = keyword
+    end
+
+    def fetch_from_flickr
+      Flickr::BaseApi.new.get_photo(keyword)
+    rescue NoImage => e
+      puts "Image not found for keyword '#{keyword}'. Message: #{e.message}. Retrying"
+      unless (tries -= 1).positive?
+        raise ApplicationError, "Failed getting image after retrying #{MAX_KEYWORD_RETRIES} times"
+      end
+
+      retry
+    rescue FetchingError => e
+      raise ApplicationError, e.message
+    end
+  end
+end

data/lib/flico.rb

@@ -1,13 +1,8 @@
 # frozen_string_literal: true
 
-require 'flickraw'
 require 'ostruct'
 require 'optparse'
 require 'flico/app'
-require 'flico/flickr_command'
-require 'flico/dictionary'
-require 'flico/saver'
-require 'flico/collager'
 
 module Flico
   class CommandLineInterface
@@ -24,54 +19,7 @@ module Flico
 
     def self.start(args)
       keywords, options	= parse_args(args)
-      puts "Given Keywords: #{keywords.join(' ')} with Options: #{options}"
-      resources	= validate_resources(keywords, options)
-      App.new(resources).create_collage
-    end
-
-    def self.validate_resources(keywords, options = {})
-      dictionary = validate_dictionary
-      dictionary.append(keywords)
-      col = SaveCollage.new
-      col.output_file_name = options[:file_name]
-
-      Resource.new(flickr_api: validate_flickr_api, dictionary:, fetch_image: FetchImage.new,
-                   collager: Collager.new, save_collage: col)
-    end
-
-    def self.validate_flickr_api
-      key = ENV['FLICKR_KEY']
-      secret = ENV['FLICKR_SECRET']
-      if key.nil? && secret.nil?
-        warn 'Performing AutoExit due to missing required environment variables: FLICKR_KEY and FLICKR_SECRET'
-        exit 1
-      else
-        FlickRaw.api_key	= key
-        FlickRaw.shared_secret	= secret
-        FlickrCommand.setup(FlickRaw::Flickr.new)
-      end
-    end
-
-    def self.validate_dictionary
-      dictionary_path = '/usr/share/dict/words'
-      if File.exist?(dictionary_path)
-        Dictionary.new(dictionary_path)
-      else
-        warn "Performing AutoExit due to missing required dictionary at path: #{dictionary_path}"
-        exit 1
-      end
-    end
-  end
-
-  class Resource
-    attr_reader :flickr_api, :dictionary, :fetch_image, :collager, :save_collage
-
-    def initialize(params = {})
-      @flickr_api	= params.fetch(:flickr_api)
-      @dictionary 	= params.fetch(:dictionary)
-      @fetch_image	= params.fetch(:fetch_image)
-      @collager	= params.fetch(:collager)
-      @save_collage	= params.fetch(:save_collage)
+      App.new(keywords, options).create
     end
   end
 end

data/spec/base_api_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'flico/flickr/base_api'
+
+describe Flico::Flickr::BaseApi do
+  let(:photo_url) do
+    {
+      'label' => 'Square',
+      'width' => 75,
+      'height' => 75,
+      'source' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5_s.jpg',
+      'url' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5/sizes/sq/',
+      'media' => 'photo'
+    }
+  end
+
+  let(:subject) { described_class.new }
+
+  context 'search success' do
+    before do
+      ENV['FLICKR_KEY'] = 'FOO'
+      ENV['FLICKR_SECRET'] = 'BAR'
+    end
+
+    it 'should return image url for search keyword' do
+      allow_any_instance_of(Flico::Flickr::BaseApi).to receive(:flickraw_api).and_return(double('flickraw_api'))
+      allow_any_instance_of(Flico::Flickr::BaseApi).to receive(:get_photo).and_return(photo_url)
+
+      expect(subject.get_photo('Volkswagen Golf in Luxembourg')['source']).to eq('https://farm3.staticflickr.com/2805/33472607802_42e011bcf5_s.jpg')
+    end
+  end
+end

data/spec/dictionary_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'flico/dictionary'
+
+describe Flico::Dictionary do
+  let(:subject) { described_class.new }
+
+  context '#words' do
+    let(:count) { 3 }
+    let(:words) { subject.words(count) }
+
+    it 'should not be empty' do
+      expect(words).to_not be_empty
+    end
+
+    it 'should return 3 random words' do
+      expect(words.count).to eq count
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flico
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Amandeep Singh Bhamra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-28 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flickraw
@@ -114,13 +114,12 @@ files:
 - flico.gemspec
 - lib/flico.rb
 - lib/flico/app.rb
-- lib/flico/cell.rb
 - lib/flico/collager.rb
 - lib/flico/dictionary.rb
-- lib/flico/flickr_command.rb
-- lib/flico/grid.rb
-- lib/flico/saver.rb
-- spec/flickr_command_spec.rb
+- lib/flico/flickr/base_api.rb
+- lib/flico/image_file.rb
+- spec/base_api_spec.rb
+- spec/dictionary_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/amandeepbhamra/flico
 licenses:

data/lib/flico/cell.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Flico
-  class Cell
-    attr_reader :x, :y, :width, :height
-
-    def initialize(x = 0, y = 0, width, height)
-      @x = x
-      @y = y
-      @width = width
-      @height = height
-    end
-
-    def aspect_ratio
-      width.to_f / height
-    end
-
-    def to_mm
-      "#{width}x#{height}+#{x}+#{y}"
-    end
-
-    def ==(other)
-      other.class == self.class && other.state == state
-    end
-
-    protected
-
-    def state
-      [@x, @y, @width, @height]
-    end
-  end
-end

data/lib/flico/flickr_command.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Flico
-  class FlickrCommand
-    def initialize(search_command:, sizes_command:)
-      @search_command = search_command
-      @sizes_command = sizes_command
-    end
-
-    def self.setup(flickraw)
-      new(search_command: SearchCommand.new(flickraw), sizes_command: SizesCommand.new(flickraw))
-    end
-
-    def call(keyword)
-      if keyword.nil?
-        warn "Missing Keywords (can't be nil)"
-      else
-        puts "Searching images for keyword: #{keyword}"
-        results = @search_command.call(keyword)
-        if results.count.zero?
-          warn "No Image for keyword: #{keyword}"
-        else
-          get_image_url(results.first['id'])
-        end
-      end
-    end
-
-    private
-
-    def get_image_url(photo_id)
-      sizes	= @sizes_command.call(photo_id)
-      sizes[sizes.count / 2]['source']
-    end
-  end
-
-  class FlickrBase
-    attr_reader :api
-
-    def initialize(flickraw)
-      @api = flickraw
-    end
-  end
-
-  class SearchCommand < FlickrBase
-    def call(keyword)
-      api.photos.search({ text: keyword, per_page: 10, sort: 'interestingness-desc' })
-    end
-  end
-
-  class SizesCommand < FlickrBase
-    def call(photo_id)
-      api.photos.getSizes(photo_id:)
-    end
-  end
-end

data/lib/flico/grid.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-require 'flico/cell'
-
-module Flico
-  class Grid
-    GRID	= [[0, 1, 1, 2], [3, 4, 5, 6], [7, 8, 8, 9]].freeze
-    CANV_WIDTH 	= 1750
-    CANV_HEIGHT = 1250
-
-    def canv_width
-      CANV_WIDTH
-    end
-
-    def canv_height
-      CANV_HEIGHT
-    end
-
-    def columns
-      GRID.max_by(&:size).size
-    end
-
-    def column_cells
-      GRID.transpose
-    end
-
-    def rows
-      GRID.size
-    end
-
-    def row_cells
-      GRID
-    end
-
-    def cell_width(name)
-      cell_size(CANV_WIDTH, columns, size_multiplier(row_cells, name))
-    end
-
-    def cell_height(name)
-      cell_size(CANV_HEIGHT, rows, size_multiplier(column_cells, name))
-    end
-
-    def crop_rectangle(cell_name, image_width, image_height)
-      x = 0
-      y = 0
-      image = Cell.new(image_width, image_height)
-      cell = cell_rectangle(cell_name)
-
-      if image.aspect_ratio >= cell.aspect_ratio
-        final_width = image_width - (image.width - (image.height * cell.aspect_ratio))
-        final_height = image.height
-      else
-        final_width = image.width
-        final_height = image.height - (image.height - (image.width / cell.aspect_ratio))
-      end
-
-      Cell.new(x, y, final_width, final_height)
-    end
-
-    def resize_rectangle(cell_name, image_width, image_height)
-      Cell.new(image_width, image_height)
-      cell_rectangle(cell_name)
-    end
-
-    def cell_rectangle(name)
-      column = column_cells.find_index do |row|
-        row.include? name
-      end
-      row = row_cells.find_index { |row| row.include? name }
-      Cell.new(column * (CANV_WIDTH / columns), row * (CANV_HEIGHT / rows), cell_width(name), cell_height(name))
-    end
-
-    private
-
-    def size_multiplier(table, name)
-      table.map { |row| row.count(name) }.max
-    end
-
-    def cell_size(total, divisions, multiplier)
-      multiplier.zero? ? 0 : ((total / divisions) * multiplier)
-    end
-  end
-end

data/lib/flico/saver.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'open-uri'
-require 'tempfile'
-require 'fileutils'
-require 'date'
-
-module Flico
-  class FetchingError < StandardError; end
-
-  class FetchImage
-    def call(url)
-      tempfile = Tempfile.new 'temp_image'
-      IO.copy_stream(URI.open(url, read_timeout: 5), tempfile)
-      tempfile.rewind
-      tempfile
-    rescue OpenURI::HTTPError => e
-      raise FetchingError, "Couldn't download from: #{url} due to #{e.message}"
-    end
-  end
-
-  class SaveCollage
-    attr_accessor :output_file_name
-
-    def call(file_path)
-      file_name = output_file_name || validate_file_name
-      FileUtils.mv file_path, file_name
-      puts "Flicollage saved at #{file_name}"
-    end
-
-    private
-
-    def validate_file_name
-      puts "Enter file name for collage (press ENTER to use '#{default}')"
-      file_name = $stdin.gets.strip
-      file_name.empty? ? "flicollage-#{Time.now.strftime('%Y%m%d%H%M%S')}.png" : file_name
-    end
-  end
-end

data/spec/flickr_command_spec.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'flico/flickr_command'
-
-describe Flico::FlickrCommand do
-  let(:search_results) do
-    [
-      {
-        'id' => '33472607802',
-        'owner' => '78759190@N05',
-        'secret' => '42e011bcf5',
-        'server' => '2805',
-        'farm' => 3,
-        'title' => 'Volkswagen Golf in Luxembourg',
-        'ispublic' => 1,
-        'isfriend' => 0,
-        'isfamily' => 0
-      }
-    ]
-  end
-  let(:sizes_results) do
-    [
-      {
-        'label' => 'Square',
-        'width' => 75,
-        'height' => 75,
-        'source' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5_s.jpg',
-        'url' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5/sizes/sq/',
-        'media' => 'photo'
-      },
-      {
-        'label' => 'Large Square',
-        'width' => '150',
-        'height' => '150',
-        'source' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5_q.jpg',
-        'url' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5/sizes/q/',
-        'media' => 'photo'
-      },
-
-      {
-        'label' => 'Thumbnail',
-        'width' => '100',
-        'height' => '66',
-        'source' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5_t.jpg',
-        'url' => 'https://farm3.staticflickr.com/2805/33472607802_42e011bcf5/sizes/t/',
-        'media' => 'photo'
-      }
-    ]
-  end
-  let(:subject) { described_class.new(search_command:, sizes_command:) }
-  let(:search_command) { double('search', call: search_results) }
-  let(:sizes_command) { double('sizes', call: sizes_results) }
-
-  context 'search success' do
-    it 'should return image url for search keyword' do
-      expect(subject.call('Volkswagen Golf in Luxembourg')).to eq('https://farm3.staticflickr.com/2805/33472607802_42e011bcf5_q.jpg')
-    end
-  end
-end