flickrage 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf60b6c67ea4268d0d646cdd9b6b475744c49af2
+  data.tar.gz: 9e529fabe4ab52ace9e86add2d03a6b238c85b6f
+SHA512:
+  metadata.gz: 161e305af9402fef2d2af2c0dc24349d014b47087db640da2d79511f66a68b624db902b2f5be22010fc3582cb73fc2e171243977b6a724b15d2aed3b3592dbc9
+  data.tar.gz: e5436fba5048ff0ad7ae1c0ea6bdb73f1e0a053930a864557045c2a6a0b7d1b3cc46091f90dd0c8d2156ce4ef303f0e70fb92144d10d12b3fb4af11e851e58bd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/*
+!/tmp/.keep
+.irb_history
+/log/*
+!/log/.keep
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,50 @@
+LineLength:
+  Max: 200
+
+HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Disabled: true
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'tasks/**/*'
+    - 'Rakefile'

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+notifications:
+  email:
+    - api@mrcr.ru
+script:
+    - bundle exec rake
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install imagemagick libmagickcore-dev libmagickwand-dev
+  - sudo apt-get install -qq graphicsmagick
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rubocop', '~> 0.42.0', require: false
+end
+
+group :test do
+  gem 'tins', '~> 1.6'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Alexander Merkulov
+
+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,188 @@
+# Flickrage CLI, your Flickr Collage. 
+
+[![Gem Version](https://badge.fury.io/rb/flickrage.svg)](http://badge.fury.io/rb/flickrage)
+[![Build Status](https://travis-ci.org/merqlove/flickrage.svg?branch=master)](https://travis-ci.org/merqlove/flickrage)
+
+Little tool with idea of downloading random top-n pictures from the Flickr, resize it properly & build collage from them!
+
+Here are some features:
+
+- Search at Flickr with words from your own dictionary or provide just a few words :).
+- Multiple threads out of the box, no matter how many images you want.
+- Auto-cleanup (optional).
+- Logging into a file (optional).
+- Predefined timeouts for long requests (unresponding links or similar).
+- Verbose mode for research (optional).
+- Quiet mode for silence (optional).
+
+## Compatibility
+
+Ruby versions 2.3.0 and higher.
+
+<a href="https://raw.githubusercontent.com/merqlove/flickrage/prepare/assets/collage.jpg" target="_blank"><img src="https://raw.githubusercontent.com/merqlove/flickrage/prepare/assets/collage.jpg" style="max-width:50%" alt="Flickrage collage example"></a>
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install flickrage
+    
+System Wide Install (OSX, *nix):
+  
+    $ sudo gem install flickrage          
+    
+## Usage
+
+It's pretty simple at the start:
+
+    $ flickrage -k some nice grapefruit
+
+### Setup 
+
+You'll need to get/generate an API keys from your Flickr profile at https://www.flickr.com/account/sharing
+    
+Next you can export Flickr API keys as ENV variables:  
+
+    $ export FLICKR_API_KEY="SOMEKEY"
+    $ export FLICKR_SHARED_SECRET="SOMESECRET"
+        
+Or set keys with arguments:
+
+    $ flickrage --flickr-api-key SOMELONGKEY --flickr-shared-secret SOMELONGSECRET
+    
+### How-To 
+
+Select output folder:
+
+    $ flickrage -k some nice grapefruit -o ./tmp
+
+Enter collage file_name:
+
+    $ flickrage -k some nice grapefruit --file-name some.jpg
+
+Get collage of top 10 images:
+
+    $ flickrage -k some nice grapefruit --max 10
+
+Get collage of top 20 images:
+
+    $ flickrage -k some nice grapefruit --max 20
+
+Get collage of top 10 images custom width & height:
+
+    $ flickrage -k some nice grapefruit --max 10 --width 160 --height 120
+
+Provide your own words dictionary:
+
+    $ flickrage -k some nice grapefruit --dict-path /usr/share/dict/words
+
+### All options:    
+
+    > $ flickrage help c 
+    
+    Options:
+      -k, --keywords=some nice grapefruit                
+          [--max=10]                                     # Select number of files.
+                                                         # Default: 10
+                                                         # Possible values: 1, ..., 20
+          [--grid=2]                                     # Select grid base number.
+          [--width=120]                                  # Set width for resize downloaded images.
+          [--height=80]                                  # Set height for resize downloaded images.
+      -l, [--log=/Users/someone/.flickrage/main.log]     # Log file path. By default logging is disabled.
+      -o, [--output=./tmp]                               # Output directory, where all data will be stored.
+          [--file-name=./some.png]                       # Name for the file with collage.
+          [--dict-path=/usr/share/dict/words]            # Path to the file with multiline words (dictionary).
+      -c, [--cleanup], [--no-cleanup]                    # Cleanup files before collage.
+      -v, [--verbose], [--no-verbose]                    # Verbose mode.
+      -q, [--quiet], [--no-quiet]                        # Quiet mode. If don't need any messages and in console.
+          [--flickr-api-key=YOURLONGAPIKEY]              # FLICKR_API_KEY. if you can't use environment.
+          [--flickr-shared-secret=YOURLONGSHAREDSECRET]  # FLICKR_SHARED_SECRET. if you can't use environment.
+  
+    `flickrage` is a tool which loves search on the Flickr & making collages from findings.
+    
+    You have to enter name of the output file and a max number of downloading files.
+    
+    Parameters helps you specify rectangle size for each image, collage name, it's location, ..., and well the grid base size.
+
+### Screenshot:
+
+<img src="https://raw.githubusercontent.com/merqlove/flickrage/prepare/assets/example.png" style="max-width:100%" alt="Flickrage example">
+
+### Real world example
+
+    $ flickrage c -k one two three --cleanup --flickr-api-key ************ --flickr-shared-secret ***********
+      Thank you for choosing Flickrage, you will find me as your Flickr collage companion :)
+                    
+      Received keywords: [one, two, three, archencephalic, trub, soiree, barring, Cestodaria, readorn, Thurnia]
+      [+] Searching (found image ID#15415535811)
+                    
+      Found 10 images:
+      keyword      id           url                                                               title                              width  height
+      one          16214454241  https://farm9.staticflickr.com/8618/16214454241_3ab4ae73c7_b.jpg  First Snowfall                      1024     687
+      ...
+      tightfisted   8757535743  https://farm4.staticflickr.com/3786/8757535743_1c8c6b57d9_b.jpg   Teasels at the Sixteen Foot         1024     696
+      achete       15415535811  https://farm3.staticflickr.com/2949/15415535811_4eedddc4b4_b.jpg  Une nouvelle, page 12 on 17         1024    1024
+                    
+      Scheduled to download 10 images
+      Please enter the path of the output directory: ./tmp
+      [+] Downloaded image ID#8757535743
+                    
+      Downloaded 10 images:
+      keyword      id           path                                                                      downloaded?
+      one          16214454241  /Users/some/path/tmp/16214454241_3ab4ae73c7_b.jpg  true
+      ...
+      achete       15415535811  /Users/some/path/tmp/15415535811_4eedddc4b4_b.jpg  true
+                    
+      Please enter image resize width: 200
+      Please enter image resize height: 100
+      [+] Resized image 15415535811
+                    
+      Resized 10 images:
+      keyword      id           path                                                                              resized?
+      one          16214454241  /Users/some/path/tmp/resized.16214454241_3ab4ae73c7_b.jpg  true
+      ...
+      tightfisted   8757535743  /Users/some/path/tmp/resized.8757535743_1c8c6b57d9_b.jpg   true
+      achete       15415535811  /Users/some/path/tmp/resized.15415535811_4eedddc4b4_b.jpg  true
+                    
+      Please enter the collage file name: some.png
+      [+] Collage making
+      10 images composed
+                    
+      Congrats! You can find composed collage at /Users/some/path/tmp/some.png
+
+### Dict
+
+**Ubuntu**:
+
+If not installed, install or provide your own:
+
+    $ apt-get install --reinstall wamerican
+    
+**OSX**:
+
+By default: `/usr/share/dict/words`
+
+## Dependencies:
+
+- [Concurrent Ruby](https://github.com/ruby-concurrency/concurrent-ruby) lots of awesome tools.
+- [Thor](https://github.com/erikhuda/thor) for CLI base.
+- [Tty Spinner](https://github.com/piotrmurach/tty-spinner) wonderful Spinner.
+- [Flickraw](https://github.com/hanklords/flickraw) for Flickr API access.
+- [MiniMagick](https://github.com/minimagick/minimagick) as well as ImageMagick on your machine.
+- ...
+
+## Contributing
+
+1. Fork it ( https://github.com/merqlove/flickrage/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### Testing
+
+    $ rake spec 
+
+Copyright (c) 2016 Alexander Merkulov
+
+MIT License

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+
+PROJECT_ROOT = File.expand_path('..', __FILE__)
+$:.unshift "#{PROJECT_ROOT}/lib"
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # The test gem group fails to install on the platform for some reason
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'flickrage'
+
+# 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/flickrage

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Signal.trap('INT') { exit 1 }
+
+require 'pathname'
+bin_file = Pathname.new(__FILE__).realpath
+
+$LOAD_PATH.unshift File.expand_path('../../lib', bin_file)
+
+require 'flickrage/cli'
+
+Flickrage::CLI.start(ARGV)

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/flickrage.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flickrage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flickrage'
+  spec.version       = Flickrage::VERSION
+  spec.authors       = ['Alexander Merkulov']
+  spec.email         = ['sasha@merqlove.ru']
+
+  spec.summary       = %q{Another one Flickr collage maker.}
+  spec.description   = %q{Little tool with idea of downloading random top-n pictures from the Flickr, resize it properly & build collage from them!}
+  spec.homepage      = 'https://github.com/merqlove/flickrage'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|assets|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.licenses      = ['MIT']
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'flickraw', '~> 0.9.9'
+  spec.add_dependency 'mini_magick', '~> 4.5.1'
+  spec.add_dependency 'dry-configurable', '~> 0.1.7'
+  spec.add_dependency 'dry-types', '~> 0.8.1'
+  spec.add_dependency 'concurrent-ruby-edge'
+  spec.add_dependency 'tty-spinner', '~> 0.3.0'
+  spec.add_dependency 'pastel', '~> 0.6.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'json', '~> 1.8.1'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rspec-core', '~> 3.5.0'
+  spec.add_development_dependency 'rspec-expectations', '~> 3.5.0'
+  spec.add_development_dependency 'rspec-mocks', '~> 3.5.0'
+  spec.add_development_dependency 'webmock', '~> 2.1.0'
+  spec.add_development_dependency 'coveralls', '~> 0.8.15'
+end

data/lib/flickrage.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+require 'flickrage/version'
+require 'dry-configurable'
+require 'dry-types'
+
+module Flickrage
+  autoload :Log,      'flickrage/log'
+  autoload :Helpers,  'flickrage/helpers'
+  autoload :Types,    'flickrage/types'
+  autoload :Entity,   'flickrage/entity'
+  autoload :Service,  'flickrage/service'
+  autoload :Worker,   'flickrage/worker'
+  autoload :Pipeline, 'flickrage/pipeline'
+
+  extend Dry::Configurable
+
+  MAX_DICT_LINES = 1_000_000
+
+  setting :logger
+  setting :logger_level, Logger::INFO
+
+  setting :verbose, false
+  setting :quiet,   false
+  setting :cleanup, false
+
+  setting :resize_file_prefix, 'resized.'
+
+  setting :width
+  setting :height
+
+  setting :pool_size, 5
+  setting :pool
+
+  setting :grid, 5
+  setting :max, 10
+  setting :output
+
+  setting :dict_path, '/usr/share/dict/words'
+  setting :dict
+
+  setting :flickr_api_key
+  setting :flickr_shared_secret
+
+  class << self
+    attr_accessor :logger
+
+    def cleanup
+      logger.close if logger
+    end
+
+    def api_keys?
+      config.flickr_api_key && config.flickr_shared_secret
+    end
+
+    def pool=(value)
+      config.pool = value
+    end
+
+    def dict
+      return config.dict if config.dict
+      _read_dict
+    end
+
+    def _read_dict
+      logger.debug('Caching lines from the Dict')
+
+      raise DictError, "Not found #{config.dict_path}" unless File.exist?(config.dict_path)
+      @dict_file = File.open(config.dict_path, 'r')
+
+      configure do |c|
+        c.dict = @dict_file.each_line.first(MAX_DICT_LINES)
+      end
+      config.dict
+    rescue => e
+      raise DictError, e.message
+    ensure
+      @dict_file.close if @dict_file.respond_to?(:close)
+    end
+  end
+
+  # Standard Request Exception. When we don't need droplet instance id.
+  #
+  class BaseError < StandardError; end
+
+  # Time is going over...
+  #
+  class SystemTimeout < BaseError
+    def initialize(*args)
+      Flickrage.logger.error 'Timeout, something going wrong...'
+      super
+    end
+  end
+
+  # User did few mistakes with output path...
+  #
+  class PathError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error 'Please provide existing output path...'
+      super
+    end
+  end
+
+  # User did few mistakes with file_name...
+  #
+  class FileNameError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error 'Please provide right file_name...'
+      super
+    end
+  end
+
+  # User system has no/wrong default words dict...
+  #
+  class DictError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error 'Please provide existing path to the dict...'
+      super
+    end
+  end
+
+  # User did few mistakes with size input...
+  #
+  class NumberError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error "Flickrage support for dimensions only numbers in range: #{args[0]}..."
+      super
+    end
+  end
+
+  # Download error rises when Flickr down...
+  #
+  class SearchError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error "Cannot find something...: #{args[0]}"
+      super
+    end
+  end
+
+  # Download error rises when Flickr down...
+  #
+  class DownloadError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error "Connection is down or something goes wrong...: #{args[0]}"
+      super
+    end
+  end
+
+  # Every call must have token in environment or via params.
+  #
+  class NoKeysError < BaseError
+    def initialize(*_args)
+      Flickrage.logger.error 'Please enter Flickr keys'
+      super
+    end
+  end
+
+  # Can't find output path?
+  #
+  class SaveError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error "Something wrong with output path: #{args[0]}"
+      super
+    end
+  end
+
+  # Here is something with imagemagick?
+  #
+  class ResizeError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error "Something wrong with resize tools: #{args[0]}"
+      super
+    end
+  end
+
+  # Here is something with imagemagick?
+  #
+  class CollageError < BaseError
+    def initialize(*args)
+      Flickrage.logger.error "Something wrong with collage tools: #{args[0]}"
+      super
+    end
+  end
+end