flickollage 0.0.3

data/spec/fixtures/vcr_cassettes/flickr_download_not_found.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://farm1.staticflickr.com/758/not_found.jpg
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Sun, 05 Mar 2017 12:13:42 GMT
+      Content-Type:
+      - text/html; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Photo-Farm:
+      - '1'
+      P3p:
+      - policyref="https://policies.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM
+        DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND
+        PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+      X-Photo-Origin:
+      - bf1
+      Cache-Control:
+      - private, no-cache, must-revalidate
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Pragma:
+      - no-cache
+      Last-Modified:
+      - Sat, 04 Mar 2017 18:32:59 GMT
+      Age:
+      - '0'
+      Via:
+      - http/1.1 pc-pool122.flickr.bf1.yahoo.com (ApacheTrafficServer [cMsSf ]), http/1.1
+        cache112.flickr.ir2.yahoo.com (ApacheTrafficServer [cMsSf ])
+      Server:
+      - ATS
+      X-Photo-Farm-Guess:
+      - '1'
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        pc-pool122.flickr.bf1 : 404
+    http_version: 
+  recorded_at: Sun, 05 Mar 2017 12:13:42 GMT
+recorded_with: VCR 2.9.2

data/spec/fixtures/vcr_cassettes/flickr_not_found.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.flickr.com/services/rest/
+    body:
+      encoding: US-ASCII
+      string: tags=kjasbdib823&sort=interestingness-desc&per_page=1&method=flickr.photos.search&format=json&nojsoncallback=1
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - FlickRaw/0.9.9
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 05 Mar 2017 12:02:59 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '80'
+      P3p:
+      - policyref="https://policies.yahoo.com/w3c/p3p.xml", CP="CAO DSP COR CUR ADM
+        DEV TAI PSA PSD IVAi IVDi CONi TELo OTPi OUR DELi SAMi OTRi UNRi PUBi IND
+        PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA POL HEA PRE LOC GOV"
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - private
+      X-Served-By:
+      - www295.flickr.bf1.yahoo.com
+      X-Frame-Options:
+      - SAMEORIGIN
+      Vary:
+      - Accept-Encoding
+      Age:
+      - '0'
+      Via:
+      - http/1.1 fts125.flickr.bf1.yahoo.com (ApacheTrafficServer [cMsSf ]), http/1.1
+        e20.ycpi.amb.yahoo.com (ApacheTrafficServer [cMsSf ])
+      Server:
+      - ATS
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"photos":{"page":1,"pages":0,"perpage":1,"total":"0","photo":[]},"stat":"ok"}'
+    http_version: 
+  recorded_at: Sun, 05 Mar 2017 12:02:59 GMT
+recorded_with: VCR 2.9.2

data/spec/lib/collage_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Flickollage::Collage do
+  let(:subject) { described_class.new(words, options) }
+  let(:words) { %w(annapurna elbrus) }
+  let(:options) do
+    {
+      dict: fixture_file_path('mountains'),
+      number: 4,
+      width: 100,
+      height: 60,
+      rows: 2,
+      cols: 2
+    }
+  end
+
+  let(:mocked_image) { MiniMagick::Image.open(fixture_file_path('rothko.jpg')) }
+
+  before(:each) do
+    # mock downloaded image
+    allow_any_instance_of(Flickollage::Image).to receive(:search_on_flickr)
+    allow_any_instance_of(Flickollage::Image).to receive(:download)
+    allow_any_instance_of(Flickollage::Image).to receive(:image).and_return(mocked_image)
+  end
+
+  describe '#initialize' do
+    it 'initializes a dictionary' do
+      expect(subject.dictionary.words).not_to be_empty
+    end
+
+    it 'loads images' do
+      expect(subject.images.size).to eq 4
+    end
+
+    it 'crops images' do
+      allow_any_instance_of(Flickollage::Image).to receive(:crop)
+      expect(subject.images).to all have_received(:crop).with(100, 60)
+    end
+
+    context 'when image can not be loaded' do
+      before(:each) do
+        expect(Flickollage::Image)
+          .to receive(:new)
+          .and_raise(Flickollage::Image::Error).exactly(described_class::RETRY_LIMIT).times
+      end
+
+      it 'should raise Flickollage::Error after RETRY_LIMIT attempts' do
+        expect { subject }.to raise_error(Flickollage::Error)
+      end
+    end
+  end
+
+  describe '#generate_collage' do
+    let(:output) { Tempfile.new(['collage', '.jpg']).path }
+    let(:subject) { super().generate_collage(output) }
+    let(:collage) { MiniMagick::Image.new(output) }
+
+    before(:each) { subject }
+
+    it 'should compose a collage and save it into a file' do
+      expect(collage.dimensions).to eq [200, 120]
+    end
+
+    it 'should be similar to a sample image' do
+      expect(output).to be_similar_to fixture_file_path('collage.jpg')
+    end
+  end
+end

data/spec/lib/dictionary_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Flickollage::Dictionary do
+  let(:path) { fixture_file_path('mountains') }
+  let(:subject) { described_class.new(path) }
+
+  describe '#initialize' do
+    context 'with file' do
+      it 'should load all words' do
+        expect(subject.words.size).to be > 20
+      end
+
+      it 'shuffles the dictionary' do
+        dictionary2 = described_class.new(path)
+        expect(subject.words).not_to eq dictionary2.words
+      end
+
+      context 'huge file' do
+        before(:each) { stub_const('Flickollage::Dictionary::MAX_DICT_LENGTH', 5) }
+        it 'limits dictionary size' do
+          expect(subject.words.size).to eq 5
+        end
+      end
+
+      context 'file not found' do
+        let(:path) { '/not/a/file' }
+
+        it 'raise an error' do
+          expect { subject }.to raise_error Flickollage::Dictionary::Error
+        end
+      end
+    end
+
+    context 'with list of words' do
+      let(:words) { %w(apples oranges) }
+      let(:subject) { described_class.new(words) }
+      it 'should load all words' do
+        expect(subject.words.size).to eq 2
+      end
+    end
+  end
+
+  describe '#words' do
+    let(:subject) { super().words }
+
+    it 'returns the list of loaded words' do
+      expect(subject).to be_an Array
+    end
+
+    it 'does not contain empty words' do
+      expect(subject).not_to include ''
+    end
+  end
+
+  describe '#pop' do
+    let!(:dictionary) { described_class.new(path) }
+    let(:subject) { dictionary.pop }
+    it 'should return a random word' do
+      expect(subject).not_to be_empty
+    end
+
+    it 'should not be a multi-line string' do
+      expect(subject).not_to include "\n"
+    end
+
+    it 'should remove a word from the dictionary' do
+      expect { subject }.to change { dictionary.words.size }.by(-1)
+    end
+  end
+
+  describe '#append' do
+    let!(:dictionary) { described_class.new(path) }
+    let(:words) { %w(apple banana) }
+    let(:subject) { dictionary.append(words) }
+
+    it 'should append words to the dictionary' do
+      subject
+      expect(dictionary.pop).to eq 'apple'
+      expect(dictionary.pop).to eq 'banana'
+    end
+  end
+
+  describe '#default_dict_path' do
+    let(:subject) { described_class.default_dict_path }
+    it 'should return one of the common dict paths' do
+      expect(described_class::COMMON_DICT_PATHS).to include subject
+    end
+  end
+end

data/spec/lib/image_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Flickollage::Image do
+  let(:word) { 'dolomites' }
+  let(:subject) { described_class.new(word) }
+
+  let(:flickr_api_key) { ENV['FLICKR_API_KEY'] || 'key' }
+  let(:flickr_shared_key) { ENV['FLICKR_SHARED_SECRET'] || 'secret' }
+
+  before(:each) do
+    Flickollage.configure_flickraw(
+      flickr_api_key: flickr_api_key,
+      flickr_shared_secret: flickr_shared_key
+    )
+  end
+
+  describe '#initialize' do
+    it 'should retrieve image url from flickr' do
+      VCR.use_cassette('flickr') do
+        expect(subject.url).to match(/staticflickr\.com/)
+      end
+    end
+
+    context 'file not found' do
+      let(:word) { 'kjasbdib823' }
+      it 'should raise error' do
+        VCR.use_cassette('flickr_not_found') do
+          expect { subject }.to raise_error { Flickollage::Image::Error }
+        end
+      end
+    end
+  end
+
+  describe '#download' do
+    let(:image) { described_class.new(word) }
+    let(:subject) { image.download }
+    it 'should return an mini magick object' do
+      VCR.use_cassette('flickr_download') do
+        expect(subject).to be_a MiniMagick::Image
+      end
+    end
+
+    context 'file not found' do
+      before(:each) do
+        # mock Flickr request
+        allow_any_instance_of(Flickollage::Image).to receive(:search_on_flickr)
+        allow(image).to receive(:url).and_return('https://farm1.staticflickr.com/758/not_found.jpg')
+      end
+
+      it 'should raise en error' do
+        VCR.use_cassette('flickr_download_not_found') do
+          expect { subject }.to raise_error { Flickollage::Image::Error }
+        end
+      end
+    end
+  end
+
+  describe '#crop' do
+    let(:image) { described_class.new(word).tap(&:download) }
+    let(:crop_size) { [150, 100] }
+    let(:subject) { image.crop(*crop_size) }
+    before(:each) do
+      VCR.use_cassette('flickr_download') do
+        image
+      end
+    end
+    it 'crops the image' do
+      expect { subject }.to change { image.image.dimensions }.to crop_size
+    end
+
+    context 'result is bigger that the source' do
+      let(:crop_size) { [1500, 1500] }
+      it 'makes the image bigger' do
+        expect { subject }.to change { image.image.dimensions }.to crop_size
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+require 'flickollage'
+
+require 'dotenv'
+Dotenv.load
+
+# testing frameworks
+require 'rspec'
+require 'webmock/rspec'
+require 'vcr'
+
+Flickollage.init_logger
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+
+  # Removes private data
+  config.before_record do |i|
+    i.request.headers.delete('Authorization')
+  end
+end

data/spec/support/flickollage_helpers.rb

@@ -0,0 +1,11 @@
+module Flickollage
+  module SpecHelpers
+    def fixture_file_path(file_name)
+      File.join(__dir__, '..', 'fixtures', file_name)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Flickollage::SpecHelpers
+end

data/spec/support/similar_image_matcher.rb

@@ -0,0 +1,12 @@
+RSpec::Matchers.define :be_similar_to do |expected|
+  match do |actual|
+    expect do
+      $stderr = StringIO.new
+      MiniMagick::Tool::Compare.new do |compare|
+        compare.merge! %W(-metric RMSE #{actual} #{expected} null:)
+      end
+      # expect($stderr.string).to eq '0 (0)'
+      $stderr = STDERR
+    end.not_to raise_error
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: flickollage
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Aleksandr Zykov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: flickraw
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: vcr
+  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: webmock
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: Flickollage is a simple command line tool for generating collages
+email: alexandrz@gmail.com
+executables:
+- flickollage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- bin/flickollage
+- flickollage.gemspec
+- lib/flickollage.rb
+- lib/flickollage/cli.rb
+- lib/flickollage/collage.rb
+- lib/flickollage/dictionary.rb
+- lib/flickollage/image.rb
+- lib/flickollage/logger.rb
+- spec/fixtures/cities.png
+- spec/fixtures/collage.jpg
+- spec/fixtures/mountains
+- spec/fixtures/mountains.png
+- spec/fixtures/rothko.jpg
+- spec/fixtures/vcr_cassettes/flickr.yml
+- spec/fixtures/vcr_cassettes/flickr_download.yml
+- spec/fixtures/vcr_cassettes/flickr_download_not_found.yml
+- spec/fixtures/vcr_cassettes/flickr_not_found.yml
+- spec/lib/collage_spec.rb
+- spec/lib/dictionary_spec.rb
+- spec/lib/image_spec.rb
+- spec/spec_helper.rb
+- spec/support/flickollage_helpers.rb
+- spec/support/similar_image_matcher.rb
+homepage: https://github.com/alexandrz/flickollage
+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.6.9
+signing_key: 
+specification_version: 4
+summary: Flickollage Collage Generator
+test_files:
+- spec/fixtures/cities.png
+- spec/fixtures/collage.jpg
+- spec/fixtures/mountains
+- spec/fixtures/mountains.png
+- spec/fixtures/rothko.jpg
+- spec/fixtures/vcr_cassettes/flickr.yml
+- spec/fixtures/vcr_cassettes/flickr_download.yml
+- spec/fixtures/vcr_cassettes/flickr_download_not_found.yml
+- spec/fixtures/vcr_cassettes/flickr_not_found.yml
+- spec/lib/collage_spec.rb
+- spec/lib/dictionary_spec.rb
+- spec/lib/image_spec.rb
+- spec/spec_helper.rb
+- spec/support/flickollage_helpers.rb
+- spec/support/similar_image_matcher.rb