media-renamer 0.0.1

data/lib/media-renamer.rb

@@ -0,0 +1,4 @@
+#media-renamer.rb
+
+require 'renamer.rb'
+

data/lib/renamer.rb

@@ -0,0 +1,162 @@
+#renamer.rb
+#Currently configured to only rename JPG and TIF files (using EXIFR to extract metadata)
+
+require 'exifr'
+#require 'scrapers/jpg_tif.rb'
+#require 'scrapers/mp3_m4a_wav_flac_aiff.rb'
+
+class FileNotValidError < StandardError ; end
+class InvalidArgumentError < StandardError ; end
+class UnsupportedFileTypeError < StandardError ; end
+
+class Renamer
+	
+	attr_accessor	:naming_scheme 	# => array of strings and literals used to construct filenames
+
+	def initialize
+		@naming_scheme = ["Renamed-default-"]
+	end
+
+	def setNamingScheme(arr = [])
+		@naming_scheme = setScheme(arr)
+	end
+	#Input: list of URIs in the form of an array
+	#Output: hash of "file name pairs." old_file => new_file
+	#Accepts optional arguments: :scheme (array of strings and symbols specifying file naming convention)
+	def generateRenameList(uri_list = [], args = {})
+		if args[:scheme] != nil && args[:scheme].is_a?(Array) && !args[:scheme].empty?
+			scheme = setScheme(args[:scheme])
+		else
+			scheme = @naming_scheme
+		end
+		unless !uri_list.nil? && uri_list.is_a?(Array) 
+			raise InvalidArgumentError
+		end
+
+
+		filename_pairs = {}
+		uri_list.each do |i|
+			new_string = handleFile(i, scheme)
+			#If this is a valid file path, add it to the filename_pairs
+			#puts "New file rename added: #{new_string}"
+			if new_string != nil && new_string != ""
+				filename_pairs[i] = new_string
+			end
+		end
+
+		return filename_pairs
+	
+	rescue InvalidArgumentError => arg_e
+		puts arg_e
+		puts "Invalid arguments provided. Expected: uri_list = [], args = {}"
+		puts arg_e.backtrace.inspect
+	rescue => e
+		puts e 
+		puts e.message 
+		puts e.backtrace.inspect
+	end
+
+	def overwrite(renames_hash = {})
+		renames_hash.each do |old_name, new_name|
+			begin
+				#error/integrity checking on old_name and new_name
+	  			raise FileNotValidError, "Could not access specified source file: #{i}." unless old_name.is_a?(String) && File.exists?(old_name)    
+	    		raise FileNotValidError, "New file name provided is not a string" unless new_name.is_a?(String)
+	    		
+	    		File.rename(File.absolute_path(old_name),File.dirname(File.absolute_path(old_name)) + "/" + new_name)
+								
+				#check that renamed file exists
+				unless new_name.is_a?(String) && File.exists?(new_name)    
+	      			raise RenameFailedError, "Could not successfuly rename file: #{old_name} => #{new_name}."
+	    		end
+	    	rescue => e
+	    		puts "Ignoring rename for #{old_name} => #{new_name}"
+	    		puts e
+	    		puts e.backtrace.inspect
+			end
+		end
+	end
+
+	#Routes metadata scrape based on file type (currently relies on extension - future version should use MIME)
+	#currently assumes file was checked for validity in calling code
+	def	getFileMetadata(file)
+		
+		#LOAD EXIF DATA	
+		case File.extname(file)
+		when '.jpg'
+			getJpegData(file)
+		when '.tif'
+			getTiffData(file)
+		else
+			raise UnsupportedFileTypeError, "Error processing #{file}"
+		end
+		#otherwise, outsource
+	rescue UnsupportedFileTypeError => e
+		puts "Could not process file: Extension #{File.extname(file)} is not supported."
+		puts e.backtrace.inspect
+	end
+
+	def getJpegData(file)
+		meta = EXIFR::JPEG.new(file)
+		return meta.to_hash
+		#!!! Rescue from common file-related and exifr-related errors here
+	end
+
+	def getTiffData(file)
+		meta = EXIFR::TIFF.new(file)	
+		return meta.to_hash
+		#!!! Rescue from common file-related and exifr-related errors here
+	end
+
+
+	private
+	def handleFile(file, scheme)
+			#Check file is real
+	    unless file.is_a?(String) && File.exists?(file) 
+  			raise FileNotValidError, "Could not access specified file file: #{file}."
+		end
+		#convert URI (i) to absolute path
+
+		#get metadata hash for this file (i)
+		metadata = getFileMetadata(File.absolute_path(file))
+		#build URI string
+		new_string = ""
+		scheme.each do |j|
+			if j.is_a?(String) then new_string += j
+			elsif j.is_a?(Symbol) 
+				begin
+					raise EmptyMetadataError unless metadata[j] != nil
+					new_string += metadata[j].to_s
+				rescue => e 
+					puts "Could not get string for metadata tag provided in scheme: #{j} for file #{file}." 
+					puts "Ignoring file #{file}"
+					puts e.backtrace.inspect
+					return nil
+				end
+			end
+		end
+		#puts "Found file metadata: #{metadata[:date_time]}"
+		return new_string + File.extname(file)	
+	rescue FileNotValidError => e
+		puts ("Ignoring file #{file}")
+		puts e 
+		puts e.backtrace
+		return nil
+	rescue => e
+		puts e.message
+		puts e.backtrace.inspect
+		return nil
+	end
+
+	def setScheme(input_arr = [])
+		clean_scheme = []
+		input_arr.each do |i|
+			if i.is_a?(String) || i.is_a?(Symbol)
+				clean_scheme << i
+			end
+		end
+		return clean_scheme
+	end
+end
+
+

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: media-renamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephen Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Provides a set of functions for dynamically renaming files using their
+  metadata, according to a customizable taxonomy. For example, use bulk-renamer to
+  set filenames for a directory of photos to a standard such as: "<date-taken> - Ski
+  Vacation.jpg". Currently supports only JPEG and TIFF files. Future releases will
+  include support for music and additional image files.'
+email: djeserkare@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/renamer.rb
+- lib/media-renamer.rb
+homepage: http://rubygems.org/gems/bulk-renamer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rename files in bulk based on file metadata.
+test_files: []