flickr-collage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b53e05a81dd42eb4b3083f46e759e95c01e4bb25
+  data.tar.gz: 5796d580f2d19050ac641e19dd0600210f819086
+SHA512:
+  metadata.gz: ed06228f36c26c195b10fb3bec0909e440065caaaa7b0605436bf05ccf030c67d49cb5afe8e2e33ece02066071f02f96c3298b5ad14e0253da611831c8bbdc8a
+  data.tar.gz: b1df8c3557ad9897bf1466c0662a6aba3adf659220ce7fc005cc89c7539524deeee8c44d2d9a329159ad6f3db7a70be8bb34735d6d3d464f74adb05fa89e8fc3

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## 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
+
+.idea
+config/flickr-collage.yml

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dieter.pisarewski@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dieter Pisarewski
+
+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,79 @@
+# Flickr::Collage
+
+## Installation
+
+Follow [Prerequisits](https://github.com/rmagick/rmagick#prerequisites) section for [RMagick](https://github.com/rmagick/rmagick) in order to install image processor.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flickr-collage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flickr-collage
+
+## Usage
+
+### From command line: 
+
+Getting help.
+
+    flickr-collage
+
+Save credentials for [Flickr API](https://www.flickr.com/services/api/).
+
+    flickr-collage config --api_key YOUR_API_KEY --secret YOUR_SECRET
+    
+Create a collage.
+
+    flickr-collage create [FILENAME] [--amount=N] [--columns=N] [--keywords=ONE "SECOND KEYWORD" THIRD] [--thumb_widht=N] [--api_key YOUR_API_KEY] [--secret YOUR_SECRET]
+    
+Defaults:
+ 
+    filename    - collage.png
+    amount      - 10
+    columns     - 5
+    keywords    - random keywords from `/usr/share/dict/words`
+    thumb_width - 300
+    
+### Using Flickr::Collage API
+
+Save credentials for [Flickr API](https://www.flickr.com/services/api/).
+
+    Flickr::Collage.config.save(api_key: YOUR_KEY, secret: YOUR_SECRET)
+    
+Create a collage.
+
+    service = Flickr::Collage::Service.new(NUMBER_OF_PHOTOS) #NUMBER_OF_PHOTOS is optional, default is 10.
+    service.top_photos(KEYWORDS)  #KEYWORDS is optional, by default it picks random words
+    maker = Flickr::Collage::Maker.new(service)
+    maker.create(options)
+    
+Options:
+    
+    output        - filename for output, default is `collage.png`   
+    amount        - number of photos on the collage, default is 10
+    columns       - number of columns on the collage, default is 5
+    thumb_width   - width of thumbnails, default is 300
+    scale_range   - default is 0.2
+    rotate_angle  - default is 0
+    background    - background color, default is 'white'
+    border        - border color, default is '#DDDDDD'
+    
+    
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/flickr-collage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

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

data/config/flickr-collage.sample.yml

@@ -0,0 +1,2 @@
+api_key:
+secret:

data/exe/flickr-collage

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+Bundler.require(:default)
+
+require 'thor'
+require 'hashie'
+require 'flickr/collage'
+
+module Flickr
+  module Collage
+    class CLI < Thor
+      class_option :verbose,  type: :boolean
+      class_option :api_key,  type: :string
+      class_option :secret,   type: :string
+
+      desc 'config', 'Save configuration options to the configuration file'
+      option :api_key,  type: :string
+      option :secret,   type: :string
+      def config
+        Collage.config.save(options)
+      end
+
+      desc 'create FILENAME', 'Creates a collage for given keywords'
+      option :amount,       type: :numeric, desc: 'Number of photos on the collage'
+      option :thumb_width,  type: :numeric, desc: 'Width of thumbnails on the collage'
+      option :keywords,     type: :array,  desc: 'Keywords to search on Flickr'
+      option :columns,      type: :numeric, desc: 'Number of columns on the collage'
+      def create(filename = nil)
+        Collage.verbose! if options[:verbose]
+
+        opts = Hashie::Mash.new(options.to_h)
+        opts.merge!(output: filename) if filename
+
+        Collage.config.settings = opts if opts[:api_key] and opts[:secret]
+
+        service = Service.new(opts[:amount])
+        maker   = Maker.new(service)
+        service.top_photos(*opts[:keywords])
+        maker.create(opts)
+      end
+    end
+  end
+end
+
+Flickr::Collage::CLI.start(ARGV)

data/flickr-collage.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flickr/collage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flickr-collage'
+  spec.version       = Flickr::Collage::VERSION
+  spec.authors       = ['Dieter Pisarewski']
+  spec.email         = ['dieter.pisarewski@gmail.com']
+
+  spec.summary       = "A command line tool to create a collage from flickr photos."
+  spec.description   = "Finds the most interesting photos on flickr by given keywords and creates a photo collage from the photos."
+  spec.homepage      = 'https://github.com/dpisarewski/flickr-collage'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency 'flickraw', '~> 0.9.8'
+  spec.add_runtime_dependency 'rmagick-screwdrivers', '~> 0.2.0'
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
+  spec.add_runtime_dependency 'hashie', '~> 3.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/flickr/collage.rb

@@ -0,0 +1,39 @@
+require 'logger'
+
+module Flickr
+  module Collage
+    LOGGER       = Logger.new(STDOUT)
+    LOGGER.level = Logger::WARN
+
+    def self.root
+      File.expand_path('../..', File.dirname(__FILE__))
+    end
+
+    def self.config
+      Config.instance
+    end
+
+    def self.logger
+      LOGGER
+    end
+
+    def self.verbose!
+      logger.level = Logger::DEBUG
+    end
+
+    def self.silence_warnings(&block)
+      warn_level = $VERBOSE
+      $VERBOSE = nil
+      result = block.call
+      $VERBOSE = warn_level
+      result
+    end
+  end
+end
+
+require 'flickr/collage/version'
+require 'flickr/collage/config'
+require 'flickr/collage/dictionary'
+require 'flickr/collage/photo'
+require 'flickr/collage/service'
+require 'flickr/collage/maker'

data/lib/flickr/collage/config.rb

@@ -0,0 +1,41 @@
+require 'singleton'
+require 'hashie'
+require 'yaml'
+require 'forwardable'
+
+module Flickr
+  module Collage
+    class Config
+      extend Forwardable
+      include Singleton
+
+      DEFAULT_CONFIG_FILENAME = 'flickr-collage.yml'
+      DEFAULT_CONFIG_PATH     = File.join(Collage.root, 'config', DEFAULT_CONFIG_FILENAME)
+      CONFIG_OPTIONS          = %w[api_key secret]
+
+      attr_accessor :data
+      delegate CONFIG_OPTIONS => :settings
+
+      def settings
+        self.data ||= load
+      end
+
+      def settings=(hash)
+        filtered = hash.reject{ |k, v| !CONFIG_OPTIONS.include?(k.to_s) }
+        self.data = Hashie::Mash.new(filtered)
+      end
+
+      def load(config_path = DEFAULT_CONFIG_PATH)
+        self.data = Hashie::Mash.new(YAML.load_file(config_path))
+      end
+
+      def save(hash, config_path = DEFAULT_CONFIG_PATH)
+        self.settings = hash
+
+        File.open(config_path, 'w') do |file|
+          file.write(YAML.dump(data.to_hash))
+        end
+      end
+    end
+  end
+end

data/lib/flickr/collage/dictionary.rb

@@ -0,0 +1,30 @@
+module Flickr
+  module Collage
+    class Dictionary
+      DEFAULT_DICT_FILE = '/usr/share/dict/words'
+      attr_accessor :dict_filename
+
+      def initialize(dict_filename = nil)
+        self.dict_filename = dict_filename || DEFAULT_DICT_FILE
+      end
+
+      def size
+        @size ||= File.open(dict_filename).inject(0) { |c, line| c + 1 }
+      end
+
+      def random_word
+        prng    = Random.new
+        number  = prng.rand(1..size).to_i
+
+        File.open(dict_filename) do |file|
+          #WARNING: too many IO operations
+          #TODO: For small files only, load the the contents into memory. For large files, index lines or use database.
+          #skip n - 1 lines
+          (number - 1).times{ file.gets }
+          #read line number and close the file
+          next file.gets.chomp
+        end
+      end
+    end
+  end
+end

data/lib/flickr/collage/maker.rb

@@ -0,0 +1,29 @@
+require 'hashie'
+
+Flickr::Collage.silence_warnings do
+  require 'rmagick/screwdrivers'
+end
+
+module Flickr
+  module Collage
+    class Maker
+      DEFAULT_FILENAME = 'collage.png'
+      DEFAULT_OPTIONS  = {output: DEFAULT_FILENAME, columns: 5, rotate_angle: 0, scale_range: 0.2, thumb_width: 300}
+      attr_accessor :service
+
+      def initialize(service)
+        self.service = service
+      end
+
+      def create(options = {})
+        options = Hashie::Mash.new(options).reverse_merge(DEFAULT_OPTIONS)
+        options = Hashie::Extensions::SymbolizeKeys.symbolize_keys(options.to_h)
+
+        Dir.mktmpdir do |dir|
+          service.download(dir)
+          Magick::Screwdrivers.collage(dir, options).write(options[:output])
+        end
+      end
+    end
+  end
+end

data/lib/flickr/collage/photo.rb

@@ -0,0 +1,9 @@
+module Flickr
+  module Collage
+    class Photo < Hashie::Mash
+      def filename
+        File.basename(url)
+      end
+    end
+  end
+end

data/lib/flickr/collage/service.rb

@@ -0,0 +1,60 @@
+require 'flickraw'
+require 'open-uri'
+require 'forwardable'
+
+module Flickr
+  module Collage
+    class Service
+      extend Forwardable
+
+      DEFAULT_PHOTOS_AMOUNT = 10
+      attr_accessor :photos, :photos_amount
+
+      def initialize(photos_amount = nil)
+        self.photos_amount  = photos_amount || DEFAULT_PHOTOS_AMOUNT
+        self.photos         = []
+        FlickRaw.api_key        = Collage.config.api_key
+        FlickRaw.shared_secret  = Collage.config.secret
+      end
+
+      def top_photos(*keywords)
+        self.photos = []
+        buffer  = keywords.compact.dup
+        dict    = Dictionary.new
+
+        while photos.size < photos_amount
+          buffer << dict.random_word if buffer.empty?
+          keyword = buffer.shift
+          Collage.logger.info("New keyword: #{keyword}")
+          photo   = top_photo(keyword)
+          photos << photo if photo
+        end
+
+        photos
+      end
+
+      def top_photo(keyword)
+        #option :text returns better results than :tags
+        options = {text: keyword, per_page: 1, page: 1, sort: 'interestingness-desc', content_type: 1, media: :photos}
+        list    = flickr.photos.search(options)
+        return if list.to_a.empty?
+
+        photo_info  = flickr.photos.getInfo(photo_id: list.first['id'])
+        photo       = Photo.new(photo_info.to_hash)
+        photo.url   = FlickRaw.url_b(photo_info)
+        photo
+      end
+
+      def download(dir)
+        fail('No photos available') if photos.empty?
+
+        photos.each do |photo|
+          file = open(photo.url)
+          File.open(File.join(dir, photo.filename), 'wb') do |f|
+            f.write(file.read)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flickr/collage/version.rb

@@ -0,0 +1,5 @@
+module Flickr
+  module Collage
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: flickr-collage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dieter Pisarewski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-05 00:00:00.000000000 Z
+dependencies:
+- !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-screwdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: '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'
+description: Finds the most interesting photos on flickr by given keywords and creates
+  a photo collage from the photos.
+email:
+- dieter.pisarewski@gmail.com
+executables:
+- flickr-collage
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/flickr-collage.sample.yml
+- exe/flickr-collage
+- flickr-collage.gemspec
+- lib/flickr/collage.rb
+- lib/flickr/collage/config.rb
+- lib/flickr/collage/dictionary.rb
+- lib/flickr/collage/maker.rb
+- lib/flickr/collage/photo.rb
+- lib/flickr/collage/service.rb
+- lib/flickr/collage/version.rb
+homepage: https://github.com/dpisarewski/flickr-collage
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A command line tool to create a collage from flickr photos.
+test_files: []