A simple wrapper around exiv2
C++ Ruby
Switch branches/tags
Clone or download
Pull request Compare This branch is 1 commit ahead, 54 commits behind envato:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
ext/exiv2
lib
spec
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.rdoc
Rakefile
exiv2.gemspec

README.rdoc

Exiv2

A simple wrapper around the C++ Exiv2 libary for reading image metadata.

See www.exiv2.org/

Requires that the exiv2 C++ library is installed.

Usage

gem install exiv2

require 'exiv2'
image = Exiv2::ImageFactory.open("image.jpg")
image.read_metadata
image.iptc_data.each do |key, value|
  puts "#{key} = #{value}\n"
end
image.exif_data.each { ... }
image.xmp_data.each { ... }

iptc_data_hash  = image.iptc_data.to_hash
xmp_data_hash   = image.xmp_data.to_hash

Why?

None of the existing Ruby libraries for reading image metadata did quite what we wanted, so we figured it wouldn't be too hard to wrap enough of Exiv2 to meet our needs.

The intention is to just mirror the Exiv2 API in Ruby, so the path to extending this to support more of Exiv2's functionality should be straightforward. Patches are welcome.

Compatibility

Tested with Ruby 1.8.7 and Exiv2 0.21.

Developing

  • Fork the project.

  • Make your feature addition or bug fix.

  • Add tests for it. This is important so I don't break it in a future version unintentionally.

  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

  • Send me a pull request. Bonus points for topic branches.

Status

In early development. Very little of Exiv2's API is supported, and it hasn't been heavily tested.

Copyright

Copyright © 2010 Envato & Pete Yandell. See LICENSE for details.