locate-images 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57ac0c8925af65993d74524735893b53c8c3d7d2
+  data.tar.gz: bfc817861ffb55534a99aef4eb1bbb31009a689b
+SHA512:
+  metadata.gz: 9f8c074fa609c973d733ddc35a75a8e82ece64c28a990696a0ce5613484379e0afa571f26ea5b65e2a759759f6cb4db929320233dbec0ada320cad97586eeb3b
+  data.tar.gz: 4d605603270b77f37c34395bfe8a7c8f3274b57540a0d05537b83ec18cd9e0d43b7bcd67e6867ea352c8134896f7061fbf4dafcbef37a7ab4f2dd5b5b2188401

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/gps_images

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

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

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 pcreux@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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in locate-images.gemspec
+gemspec
+
+gem 'guard-rspec'

data/Guardfile

@@ -0,0 +1,20 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Specs are fast, let's run them all!
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec" }
+
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Philippe Creux
+
+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,45 @@
+# locate-images
+
+## This is coding challenge!
+
+Using Ruby, create a command line application that recursively reads all of the images from the supplied directory of images,
+extracts their EXIF GPS data (longitude and latitude), and then writes the name of that image and any GPS co-ordinates it finds to a CSV file.
+
+This utility should be runnable from the command line (i.e.: ‘ruby ./app.rb’) or as an executable.
+
+With no parameters, the utility should default to scanning from the current directory. It should take an optional parameter that allows any other directory to be passed in.
+
+As a bonus, output either CSV or HTML, based on a parameter passed in via the command line.
+
+Feel free to use any gem(s) you like in your submission.
+
+
+## Installation
+
+    $ gem install locate-images
+
+## Usage
+
+```
+$> locate-images
+
+Usage: locate-images [options] [directory]
+    -f, --format FORMAT              csv by default. Accepts `csv` or `html`
+    -o, --output FILE                stdout by default
+```
+
+## 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/[USERNAME]/locate-images. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "locate_images"
+
+# 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/exe/locate-images

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "locate_images"
+
+LocateImages::CLI.run

data/lib/locate_images.rb

@@ -0,0 +1,94 @@
+require 'pathname'
+require 'exifr'
+require 'csv'
+
+require "locate_images/version"
+require "locate_images/cli"
+
+module LocateImages
+  class ListImages
+    def self.call(directory: ".")
+      Dir[Pathname.new(directory) + "*"].select do |path|
+        !File.directory?(path) && [".jpg", ".jpeg"].include?(File.extname(path))
+      end
+    end
+  end
+
+  class Image
+    attr_accessor :path, :lat, :long
+
+    def initialize(path:, lat:nil, long:nil)
+      @path = path
+      @lat = lat
+      @long = long
+    end
+  end
+
+  class LoadImages
+    def self.call(image_paths:)
+      image_paths.
+        lazy.
+        map { |image_path| LoadImage.call(path: image_path) }
+    end
+  end
+
+  class LoadImage
+    def self.call(path:)
+      image = Image.new(path: path)
+
+      if gps = EXIFR::JPEG.new(path).gps
+        image.lat  = gps.latitude
+        image.long = gps.longitude
+      end
+
+      image
+    end
+  end
+
+  class OutputFormatter
+    attr_reader :images, :output
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(images:, output: $stdout)
+      @images = images
+      @output = output
+    end
+
+    def call
+      raise NotImplementedError
+    end
+  end
+
+  class GenerateCSV < OutputFormatter
+    def call
+      output.puts ["Path", "Lat", "Long"].to_csv
+
+      images.each do |image|
+        output.puts [image.path, image.lat, image.long].to_csv
+      end
+    end
+  end
+
+  class GenerateHTML < OutputFormatter
+    def call
+      output.puts "<html>"
+      output.puts "<body>"
+      output.puts "<table>"
+
+      images.each do |image|
+        output.puts "<tr>"
+        output.puts "<td>#{image.path}</td>"
+        output.puts "<td>#{image.lat}</td>"
+        output.puts "<td>#{image.long}</td>"
+        output.puts "</tr>"
+      end
+
+      output.puts "</table>"
+      output.puts "</body>"
+      output.puts "</html>"
+    end
+  end
+end

data/lib/locate_images/cli.rb

@@ -0,0 +1,58 @@
+require 'optparse'
+
+module LocateImages
+  class CLI
+    def self.run
+      new.call
+    end
+
+    def call
+      initialize_default_options
+      parse_options
+      run
+    end
+
+    def initialize_default_options
+      @directory = "."
+      @format = "csv"
+      @output = $stdout
+    end
+
+    def parse_options
+      OptionParser.new do |opts|
+        opts.banner = "Usage: locate-images [options] [directory]"
+
+        opts.on("-f", "--format FORMAT", ["csv", "html"], "csv by default. Accepts `csv` or `html`") do |f|
+          @format = f
+        end
+
+        opts.on("-o", "--output FILE", "stdout by default") do |f|
+          @output = File.open(f, 'w')
+        end
+      end.parse!
+
+      @directory = ARGV[0] if ARGV[0]
+
+      raise "You can only pass one directory" if ARGV.size > 1
+
+    rescue => e
+      puts e.message
+      exit 1
+    end
+
+    def run
+      formatter.call(images: images, output: @output)
+    end
+
+    def images
+      LoadImages.call(image_paths: ListImages.call(directory: @directory))
+    end
+
+    def formatter
+      {
+        "csv" => GenerateCSV,
+        "html" => GenerateHTML
+      }.fetch(@format)
+    end
+  end
+end

data/lib/locate_images/version.rb

@@ -0,0 +1,3 @@
+module LocateImages
+  VERSION = "0.1.0"
+end

data/locate-images.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locate_images/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locate-images"
+  spec.version       = LocateImages::VERSION
+  spec.authors       = ["Philippe Creux"]
+  spec.email         = ["pcreux@gmail.com"]
+
+  spec.summary       = %q{Locate images from a directory}
+  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_dependency "exifr"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: locate-images
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philippe Creux
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exifr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: 
+email:
+- pcreux@gmail.com
+executables:
+- locate-images
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/locate-images
+- lib/locate_images.rb
+- lib/locate_images/cli.rb
+- lib/locate_images/version.rb
+- locate-images.gemspec
+homepage: 
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Locate images from a directory
+test_files: []