gps_extractor 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33ef2db79a9d06cdf6eca32b2935ad45025cd8dfbffcf643f775474255eaa589
+  data.tar.gz: f6c57166e7b36b9db3ec3e797a8877daa90fa8c4b5c5228f33a71daeedc81d64
+SHA512:
+  metadata.gz: a4b81d7f134ecab31bd578b8457d9cdfa2ad9cade505833e71f560b361d7062fe281c30ee3aa70efc343748042729051d9ae8a981223e966b10323abfc9135f2
+  data.tar.gz: aa239b760f08ff5f09da50861f4558bfbc5fa9c3bc5bd62fe208f40404b75862cc86188043b29738b2acc562d8d9f18bddcd7dc1a6da8dd2c4bf5ab03d95a141

data/lib/extractor.rb

@@ -0,0 +1,78 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'pathname'
+require 'template'
+require 'file_scanner'
+
+class Extractor
+  def perform(options, args)
+    show_throughput('Setting directory', options[:verbose])
+    dir = get_directory(args)
+
+    show_throughput('Create output file', options[:verbose])
+    output_file = op_file(dir, options)
+
+    begin
+      show_throughput('Scan Started', options[:verbose])
+      FileScanner.new(dir, output_file, options[:verbose]).begin_scan
+    rescue SystemCallError => e
+      show_error('Unable to scan this directory', e)
+    rescue StandardError => e
+      show_error('', e)
+    end
+    show_throughput('Scan Completed', options[:verbose])
+
+    show_throughput('Finalising O/P File', options[:verbose])
+    output_file.close
+
+    show_throughput('Exit', options[:verbose])
+    show_throughput("OutPut Recorded in file: #{output_file.file_name}", true)
+    exit
+  end
+
+  def get_directory(args)
+    begin
+      case args.count
+        when 0
+          Dir.pwd
+        when 1
+          File.absolute_path(args.first)
+        else
+          raise ArgumentError, 'Arguments limit breached'
+      end
+    rescue ArgumentError => e
+      show_error('Unable to set directory', e)
+    end
+  end
+
+  def op_file(dir,options)
+    begin
+      attr_labels = %w[directory file_name latitude longitude]
+      dir_name = File.basename(dir)
+      if options[:html]
+        Template::Html.new(dir_name, attr_labels)
+      else
+        Template::Csv.new(dir_name, attr_labels)
+      end
+
+    rescue SystemCallError => e
+      STDERR.puts 'Unable to initialize the output file'
+      STDERR.puts 'Make sure you have write permission to your pwd'
+      if options[:html]
+        STDERR.puts 'If you have not installed the gem, check your config file'
+      end
+      STDERR.puts e.message
+      exit
+    end
+  end
+
+  def show_throughput(msg, verbose)
+    puts msg if verbose
+  end
+
+  def show_error(msg, e)
+    STDERR.puts msg
+    STDERR.puts e.message
+    exit
+  end
+end

data/lib/file_scanner.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'pathname'
+require 'image_reader'
+require 'extractor'
+
+class FileScanner
+  def initialize(directory, output_file, verbose)
+    @directory = Pathname.new(directory)
+    @output_file = output_file
+    @verbose = verbose
+    @allowed_formats = %w{.jpg .jpeg}
+  end
+
+  def begin_scan
+    directory_scanning(@directory)
+  end
+
+  private
+
+  # Recursively scans directory searching for image files
+  def directory_scanning(dir)
+    Extractor.new.show_throughput("scanning path: #{dir}", @verbose)
+
+    dir.children.each do |child|
+      if child.file? && @allowed_formats.include?(File.extname(child).downcase)
+        begin
+          @output_file.insert(ImageReader.new(child.to_path).restructure)
+        rescue EXIFR::MalformedJPEG => e
+          Extractor.new.show_throughput("Unprocessable image: #{child.to_path}", @verbose)
+          Extractor.new.show_throughput(e.message, @verbose)
+        rescue SystemCallError => e
+          Extractor.new.show_throughput("An error occurred while processing image: #{child.to_path}", @verbose)
+          raise SystemCallError, "The error received was: #{e}"
+        end
+      elsif child.directory?
+        begin
+          directory_scanning(child)
+        rescue SystemCallError => e
+          Extractor.new.show_throughput("Unable to scan sub directory: #{child.to_path}", @verbose)
+          Extractor.new.show_throughput(e.message, @verbose)
+        end
+      end
+    end
+  end
+end

data/lib/gps_extractor.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require "gps_extractor/version"
+require 'optparse'
+require 'extractor'
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.on('-html', 'Output HTML file') do
+    options[:html] = true
+  end
+
+  opts.on('-v', '--verbose', 'Run verbosely') do |v|
+    options[:verbose] = v
+  end
+end
+
+begin
+  parser.parse!
+rescue OptionParser::InvalidOption => e
+  STDERR.puts e.message
+  STDERR.puts parser
+  exit
+end
+
+Extractor.new.perform(options, ARGV)

data/lib/gps_extractor/version.rb

@@ -0,0 +1,3 @@
+module GpsExtractor
+  VERSION = "0.1.1"
+end

data/lib/template.rb

@@ -0,0 +1,83 @@
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'erb'
+require 'gps_extractor/version'
+
+module Template
+
+
+  # handles creating and writing CSV output files
+  class Csv
+    attr_reader :file_name
+
+    # dir: basename of root directory
+    # attr_labels: array of attributes labels as strings
+    def initialize(dir, attr_labels)
+      @file_name = "tmp/output/#{dir}_#{Time.now.to_i}.csv"
+      @file = File.new(@file_name, 'w')
+      @file.puts(attr_labels.join(','))
+    end
+
+    # Writes data row to file
+    def insert(img_attrs)
+      @file.puts(img_attrs.join(','))
+    end
+
+    def close
+      @file.close
+    end
+  end
+
+
+  # This Class handles creating and writing HTML output files
+  class Html
+    attr_reader :file_name
+
+    # dir: basename of root directory
+    # attr_labels: array of attributes labels as strings
+    def initialize(dir, attr_labels)
+      @file_name = "tmp/output/#{dir}_#{Time.now.to_i}.html"
+      @file = File.new(@file_name, 'w')
+      @template_path = set_template_path
+      append_header(dir, attr_labels)
+    end
+
+    # Writes data row to file
+    def insert(img_attrs)
+      @img_attrs = img_attrs
+      row = File.read("#{@template_path}_row.html.erb")
+      partial = ERB.new(row, nil, '-').result(binding)
+      @file.write(partial)
+    end
+
+    # Writes footer to file and closes it
+    def close
+      footer = File.read("#{@template_path}_footer.html.erb")
+      partial = ERB.new(footer).result(binding)
+      @file.write(partial)
+      @file.close
+    end
+
+    private
+
+    # locate path to templates
+    def set_template_path
+      template_path = 'lib/templates/html/'
+      gem_path = "#{Gem.dir}/gems/gps_extractor-#{GpsExtractor::VERSION}/"
+      if File.exists?(gem_path)
+        return File.join(gem_path, template_path)
+      else
+        template_path
+      end
+    end
+
+    # Writes the header component of the HTML file
+    def append_header(dir, attr_labels)
+      @title = "Image GPS Scan for: #{dir}"
+      @attr_labels = attr_labels
+      header = File.read("#{@template_path}_header.html.erb")
+      partial = ERB.new(header, nil, '-').result(binding)
+      @file.write(partial)
+    end
+  end
+end

data/lib/templates/html/_footer.html.erb

@@ -0,0 +1,4 @@
+      </tbody>
+    </table>
+  </body>
+</html>

data/lib/templates/html/_header.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @title %></title>
+  </head>
+  <body>
+    <h1><%= @title %></h1>
+    <table>
+      <thead>
+        <tr>
+        <%- @attr_labels.each do |label| -%>
+          <th><%= label %></th>
+        <%- end -%>
+        </tr>
+      </thead>
+      <tbody>

data/lib/templates/html/_row.html.erb

@@ -0,0 +1,5 @@
+<tr>
+  <% @img_attrs.each do |attribute| %>
+    <td><%= attribute %></td>
+  <% end %>
+</tr>

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: gps_extractor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Aashish Saini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: exifr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: "\n    A command line application that recursively reads all of the images
+  from the supplied directory of images,\n    extracts their EXIF GPS data (longitude
+  and latitude), and then writes the name of that image and any\n    GPS co-ordinates
+  it finds to a CSV file.\n\n    Results are written to a file in the pwd as the scan
+  runs. CSV files will be\n    produced by default, use -html for HTML files instead.
+  If the app is not\n    installed as a gem, HTML output requires configuration.\n
+  \ "
+email:
+- aashusaini2684@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/extractor.rb
+- lib/file_scanner.rb
+- lib/gps_extractor.rb
+- lib/gps_extractor/version.rb
+- lib/template.rb
+- lib/templates/html/_footer.html.erb
+- lib/templates/html/_header.html.erb
+- lib/templates/html/_row.html.erb
+homepage: https://github.com/aashishsaini/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aashishsaini/
+  source_code_uri: https://github.com/aashishsaini/gps_extractor
+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.7.6
+signing_key: 
+specification_version: 4
+summary: CL app to find JPEGs and extract their GPS coordinates
+test_files: []