media-organizer 0.1.4 → 0.1.5

data/lib/filescanner.rb

@@ -19,6 +19,7 @@ module MediaOrganizer
   #This will return a list of all music and image files contained in /path/to/files/ and it's
   class Filescanner
     class FileNotValidError < StandardError ; end
+    class FileNotFoundError < StandardError ; end
 
 
     attr_reader :root_nodes
@@ -93,13 +94,13 @@ module MediaOrganizer
     #
     #===Inputs
     #
-    #   *Optional Arguments Hash:
-    #     *:mode => (:single, :multiple) 
-    #     *:music => (true, false) -- if true, music files will be included in the scan. Set to false to exclude music files. Defaults to true
-    #     *:image => (true, false) -- if true, image files will be included in the scan. Set to false to exclude image files. Defaults to true
+    # @param [Hash] args Optional Arguments Hash:
+    # @option args [Symbol] :mode sets the mode to :single or :multiple 
+    # @option args [Boolean] :music => (true, false) -- if true, music files will be included in the scan. Set to false to exclude music files. Defaults to true
+    # @option args [Boolean] :image => (true, false) -- if true, image files will be included in the scan. Set to false to exclude image files. Defaults to true
     #
     #===Outputs
-    #Array of strings, where each string is a file URI for a music or image file.
+    # @return [Array<String>] Array of strings, where each string is a file URI for a music or image file.
     #
     def multiscan(args = {})
       @root_nodes.each do |uri|

data/lib/scrapers/image.rb

@@ -5,7 +5,10 @@ module MediaOrganizer
 	module Image
 		SUPPORTED_FILETYPES = %w{.jpg .tif}
 		class FileNotFoundError < StandardError ; end
-
+		#
+		# @param [String] file URI for the file from which to pull metadata
+		#
+		# @return [Hash] metadata fields associated with the file provided as input
 		def Image.getJpegData(file)
 			meta = EXIFR::JPEG.new(file)
 			return meta.to_hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media-organizer
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors: