visioner 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfb460875ffcf77f13a494ce40b05e1dc089fc9c
-  data.tar.gz: ba23dfdae48c61b58fc88e8bda5c3d0e15c9de1c
+  metadata.gz: 751787ddc448eff5b61ed2980e6019dd754d2c7c
+  data.tar.gz: 68b9330468e2a53a066d771de4fbfd5f58573fdd
 SHA512:
-  metadata.gz: 72d6f000b32cbbb60675d483b452d35cec3b176cfbcab02eee5b99d94c1c3b331f5a9da8100491813410f53786f9a1517d0b084e5ffc13bbb1b94fce887ef072
-  data.tar.gz: 050e98a0ef8f60b2d4dd8512fd6388b4db22d5c5c08f3505a996687be1adef043cb0d51f26bec33c0fb86d76384885c5cdfdaaccb8c2876b275dd63ca8b0101e
+  metadata.gz: 93b4dbb190ea6cec388289d7cbfe5b36c9ccc4e9038bed721d7ffd0925a72e6e697aedc3908227a842d27c64ae66c7d682efc886aad665e4f35ccd0891258648
+  data.tar.gz: c1c07d5fd8b62c1841de6c296fa9236d83a947debf525ab53c8b3317151b3f79490eaaf802c327993969d03ffaf28b6ada01a5ec5867c5be7a0a9788679bcfdb

data/README.md

@@ -14,32 +14,29 @@ Automatically rename your pictures using Google Vision API and metadata.
 
 **Options:**
 
--c, --country                    Adds country to the new filename (ex: south-korea)
-
--i, --city                    Adds city to the new filename (ex: seoul)
-
--d, --date                       Adds date to the new filename (ex: 29/07/2016)
+-f, --format FORMAT              Desired format for the new filenames
 
 -h, --help                       Displays help
 
+Format directives:
+   label - uses google vision API to find a label
+   locality - uses metadata to find the locality / city
+   country - uses metadata to find the country
+   date - uses metadata to find the original date
+Format example: date_country_label
+
 **Examples:**
 
     $ export GOOGLE_VISION_API_KEY=BI34SyB5DhqV5ReVnkmIM79812yux9UFazNdynD
 
-    $ bin/visioner /Desktop/travel-south-korea-2016-2/*.jpg
+    $ bin/visioner --format label /Desktop/travel-south-korea-2016-2/*.jpg
       /Desktop/travel-south-korea-2016-2/IMG_213.jpg -> sea.jpg
       /Desktop/travel-south-korea-2016-2/IMG_214.jpg -> tower.jpg
       /Desktop/travel-south-korea-2016-2/IMG_215.jpg -> people.jpg
       /Desktop/travel-south-korea-2016-2/IMG_216.jpg -> sea2.jpg
 
-    $ bin/visioner --date /Desktop/travel-south-korea-2016-3/*.jpg
-      /Desktop/travel-south-korea-2016-3/IMG_213.jpg -> 02-28-2015_sea.jpg
-      /Desktop/travel-south-korea-2016-3/IMG_214.jpg -> 02-15-2015_tower.jpg
-      /Desktop/travel-south-korea-2016-3/IMG_215.jpg -> 03-28-2015_people.jpg
-      /Desktop/travel-south-korea-2016-3/IMG_216.jpg -> 04-02-2015_sea2.jpg
-
-    $ bin/visioner --country --date /Desktop/travel-south-korea-2016-4/*.jpg
-      /Desktop/travel-south-korea-2016-4/IMG_213.jpg -> south-korea_02-28-2015_sea.jpg
-      /Desktop/travel-south-korea-2016-4/IMG_214.jpg -> south-korea_03-15-2015_tower.jpg
-      /Desktop/travel-south-korea-2016-4/IMG_215.jpg -> south-korea_03-28-2015_people.jpg
-      /Desktop/travel-south-korea-2016-4/IMG_216.jpg -> south-korea_04-02-2015_sea2.jpg
+    $ bin/visioner --format country_locality_date_label /Desktop/travel-south-korea-2016-4/*.jpg
+      /Desktop/travel-south-korea-2016-4/IMG_213.jpg -> south-korea_seoul_02-28-2015_sea.jpg
+      /Desktop/travel-south-korea-2016-4/IMG_214.jpg -> south-korea_seoul_03-15-2015_tower.jpg
+      /Desktop/travel-south-korea-2016-4/IMG_215.jpg -> south-korea_seoul_03-28-2015_people.jpg
+      /Desktop/travel-south-korea-2016-4/IMG_216.jpg -> south-korea_seoul_04-02-2015_sea2.jpg

data/bin/visioner

@@ -6,18 +6,12 @@ require 'optparse'
 options = {}
 opts = OptionParser.new
 
-opts.banner = "Visioner automatically renames your pictures using Google API Visioner and metadata.\nMake sure you have set GOOGLE_API_KEY in your env.\n\nUsage: visioner [options] image ..."
+opts.banner = "Visioner automatically renames your pictures using Google API Visioner and metadata.\n"
+opts.banner = opts.banner + "Make sure you have set GOOGLE_API_KEY in your env.\n"
+opts.banner = opts.banner + "Usage: visioner [options] image ..."
 
-opts.on("-c", "--country", "Adds country to the new filename (ex: south-korea)") do |c|
-  options[:country] = c
-end
-
-opts.on("-l", "--locality", "Adds locality / city to the new filename (ex: seoul)") do |l|
-  options[:locality] = l
-end
-
-opts.on("-d", "--date", "Adds date to the new filename (ex: 29/07/2016)") do |d|
-  options[:date] = d
+opts.on("-f", "--format FORMAT", "Desired format for the new filenames") do |f|
+  options[:format] = f
 end
 
 opts.on("-h", "--help", "Displays help") do
@@ -27,7 +21,17 @@ end
 
 opts.parse!
 
-if ARGV.empty?
+if options[:format].nil?
+  puts "Missing option: format"
+  puts "Format directives:"
+  puts "   label - uses google vision API to find a label"
+  puts "   locality - uses metadata to find the locality / city"
+  puts "   country - uses metadata to find the country"
+  puts "   date - uses metadata to find the original date"
+  puts "Format example: date_country_label"
+  puts opts
+  exit 1
+elsif ARGV.empty?
   puts opts
   exit 1
 else

data/lib/visioner/version.rb

@@ -1,3 +1,3 @@
 module Visioner
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/visioner.rb

@@ -32,6 +32,52 @@ module Visioner
     return place
   end
 
+  def self.get_label(image_name)
+    # Convert image to Base 64
+    begin
+      b64_data = Base64.encode64(File.open(image_name, "rb").read)
+    rescue
+      puts "Error: can't read file. Exiting..."
+    end
+
+    # Prepare request
+    api_key = ENV['GOOGLE_API_KEY']
+    content_type = "Content-Type: application/json"
+    url = "https://vision.googleapis.com/v1/images:annotate?key=#{api_key}"
+    data = {
+      "requests": [
+        {
+          "image": {
+            "content": b64_data
+          },
+          "features": [
+            {
+              "type": "LABEL_DETECTION",
+              "maxResults": 1
+            }
+          ]
+        }
+      ]
+    }.to_json
+    url = URI(url)
+    req = Net::HTTP::Post.new(url, initheader = {'Content-Type' =>'application/json'})
+    req.body = data
+    res = Net::HTTP.new(url.host, url.port)
+    res.use_ssl = true
+
+    label = 'unknown'
+    res.start do |http|
+      resp = http.request(req)
+      json = JSON.parse(resp.body)
+      if json && json["responses"] && json["responses"][0]["labelAnnotations"] && json["responses"][0]["labelAnnotations"][0]["description"]
+        label = json['responses'][0]['labelAnnotations'][0]['description']
+        label = label.tr(" ", "-")
+      end
+    end
+
+    return label
+  end
+
   def self.rename_all(images, options)
     images.each do |image_name|
 
@@ -41,81 +87,46 @@ module Visioner
         next
       end
 
-
-      # Convert image to Base 64
-      begin
-        b64_data = Base64.encode64(File.open(image_name, "rb").read)
-      rescue
-        puts "Error: can't read file. Exiting..."
+      label = ''
+      if options[:format].include? 'label'
+        label = 'unknown' # Fallback
+        label = self.get_label(image_name)
       end
 
-      # Prepare request
-      api_key = ENV['GOOGLE_API_KEY']
-      content_type = "Content-Type: application/json"
-      url = "https://vision.googleapis.com/v1/images:annotate?key=#{api_key}"
-      data = {
-        "requests": [
-          {
-            "image": {
-              "content": b64_data
-            },
-            "features": [
-              {
-                "type": "LABEL_DETECTION",
-                "maxResults": 1
-              }
-            ]
-          }
-        ]
-      }.to_json
-      url = URI(url)
-      req = Net::HTTP::Post.new(url, initheader = {'Content-Type' =>'application/json'})
-      req.body = data
-      res = Net::HTTP.new(url.host, url.port)
-      res.use_ssl = true
-
-      # Rename file
-      name = ""
-      res.start do |http|
-        resp = http.request(req)
-        json = JSON.parse(resp.body)
-        if json && json["responses"] && json["responses"][0]["labelAnnotations"] && json["responses"][0]["labelAnnotations"][0]["description"]
-          name = json['responses'][0]['labelAnnotations'][0]['description']
-          name = name.tr(" ", "-")
-        end
+      date = ''
+      if options[:format].include? 'date'
+        date = File.mtime(image_name).strftime('%m-%d-%Y') # Fallback
+        exif = EXIFR::JPEG.new(image_name)
+        date = exif.date_time_original.strftime('%m-%d-%Y') if exif && exif.date_time_original
       end
 
-      unless name.empty?
-        counter = nil
-        while File.exist?(File.dirname(image_name) + "/" + name + counter.to_s + File.extname(image_name)) do
-          counter = 1 if counter == nil
-          counter = counter.to_i + 1
-        end
-
+      country = ''
+      if options[:format].include? 'country'
+        country = 'unknown' # Fallback
         exif = EXIFR::JPEG.new(image_name)
+        country = self.get_place(exif.gps.latitude, exif.gps.longitude, 'country') if exif && exif.gps_latitude && exif.gps_longitude
+      end
 
-        date = ''
-        if options[:date]
-          date = File.mtime(image_name).strftime('%m-%d-%Y') # Fallback
-          date = exif.date_time_original.strftime('%m-%d-%Y') + '_' if exif.date_time_original
-        end
+      locality = ''
+      if options[:format].include? 'locality'
+        locality = 'unknown' # Fallback
+        locality = self.get_place(exif.gps.latitude, exif.gps.longitude, 'locality') if exif.gps_latitude && exif.gps_longitude
+      end
 
-        country = ''
-        if options[:country]
-          country = 'unknown' # Fallback
-          country = self.get_place(exif.gps.latitude, exif.gps.longitude, 'country') + '_' if exif.gps_latitude && exif.gps_longitude
-        end
+      options[:format].sub! 'label', label
+      options[:format].sub! 'date', date
+      options[:format].sub! 'locality', locality
+      options[:format].sub! 'country', country
 
-        locality = ''
-        if options[:locality]
-          locality = 'unknown' # Fallback
-          locality = self.get_place(exif.gps.latitude, exif.gps.longitude, 'locality') + '_' if exif.gps_latitude && exif.gps_longitude
-        end
+      counter = nil
+      while File.exist?(File.dirname(image_name) + "/" + options[:format] + counter.to_s + File.extname(image_name)) do
+        counter = 1 if counter == nil
+        counter = counter.to_i + 1
+      end
 
-        puts "#{image_name} -> #{country + locality + date + name + counter.to_s + File.extname(image_name)}"
+      puts "#{image_name} -> #{options[:format] + counter.to_s + File.extname(image_name)}"
 
-        File.rename(image_name, File.dirname(image_name) + "/" + country + locality + date + name + counter.to_s + File.extname(image_name))
-      end
+      File.rename(image_name, File.dirname(image_name) + "/" + options[:format] + counter.to_s + File.extname(image_name))
 
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visioner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Pierre-Jean Bergeron