etfc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9d06ef4e2f1d924cabcdaf2ce052046b677a26f
+  data.tar.gz: f79f45a8e4c78688bec0fafd5ed8a5854b643b16
+SHA512:
+  metadata.gz: bc202f668ef564ce20319069c0ae3e0a11165b171839a674ece60c048305142701a76acf8ab4454ddfb16a1a91029adadf520405cad54815515d7ad0edc9d3fb
+  data.tar.gz: f230c7bdcba8413eebefccf790cd5584bcdf71dcf87f70246581152e0fd73ffbaeef00c2c7f3cff5553b5fd42f3d72ef5bc1b8ee1667c77ab004d0999617cc4c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+collage.jpg

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Documentation:
+  Enabled: false
+
+ZeroLengthPredicate:
+  Exclude:
+    # the returned list doesn't respond_to? empty?
+    - 'lib/etfc/flickr.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mxhaack@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in etfc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Maximilian Haack
+
+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,98 @@
+# ETFC
+
+ETFC is your friendly flickr collage creator. You give it a few keywords like
+'butter', 'rick sanchez' and 'purpose'; ETFC will then go and fetch the most
+interesting related pictures from flickr and create a collage of 5x2 images.
+
+![Sample Collage](sample_collage.jpg)
+
+## Prerequisites
+
+### Software
+
+ImageMagick needs to be installed, check http://www.imagemagick.org/ for
+instructions.
+
+Though not strictly necessary, the user is advised to ensure a [words
+file](https://en.wikipedia.org/wiki/Words_(Unix)) is present.
+
+### Flickr API Key
+
+Flickr requires an API Key and Shared Secret for communication with their API,
+unfortunately we can't distribute these with the source code and thus you will
+have to go through their simple registration process to receive these. Simply
+go to [Flickr's App Garden](https://www.flickr.com/services/apps/create) and
+register an application of your own.
+
+## Installation
+
+You probably want to use ETFC from your command line, in order to do so simply
+install the gem:
+
+    $ gem install etfc
+
+Alternatively you can use ETFC's functionality from your own application. Add
+this line to your application's Gemfile:
+
+```ruby
+gem 'etfc'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+As mentioned under the [Prerequisites](#prerequisites), you will need an API
+Key and Shared Secret. Place these as environment variables in your terminal
+environment:
+
+  $ export FLICKR_API_KEY=abcdef12341abcdef 
+  $ export FLICKR_SHARED_SECRET=fedcba321 
+
+### CLI usage
+
+To create a collage use the following command:
+
+  $ etfc collage best_collage_ever.jpg --keywords=butter 'rick sanchez' purpose
+
+### API usage
+
+You can use ETFC as a gem in your application and (re-)use it's functionality
+for your own purposes. ETFC consist of several modules each serving a singular
+purpose: 
+
+- `ETFC::Flickr`     -> Flickr search
+- `ETFC::Image`      -> Image download and cropping
+- `ETFC::Collage`    -> Collage creation
+- `ETFC::Dictionary` -> Random word selection from the (system) dictionary
+
+Refer to the individual module's documentation for usage details, or have
+a look at the `ETFC::Runner` on how to tie them all together.
+
+## Development
+
+After checking out the repo, run `bin/setup` 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/coffeejunk/etfc. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  task default: :rubocop
+rescue LoadError
+  warn 'RuboCop not available, quality task not provided.'
+end

data/bin/console

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

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'etfc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'etfc'
+  spec.version       = ETFC::VERSION
+  spec.authors       = ['Maximilian Haack']
+  spec.email         = ['mxhaack@gmail.com']
+
+  spec.summary       = 'A flickr collage maker'
+  spec.description   = 'ETFC is a tool to create collages from flickr ' \
+                       'images based upon user provided keywords.'
+  spec.homepage      = 'https://www.github.com/coffeejunk/etfc'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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.9'
+  spec.add_runtime_dependency 'rmagick', '~> 2.16.0'
+  spec.add_runtime_dependency 'thor', '~> 0.19.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.46.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'webmock', '~> 2.3.1'
+  spec.add_development_dependency 'vcr', '~> 3.0.3'
+end

data/exe/etfc

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