exiv2 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+Makefile
+mkmf.log
+.DS_Store
+*.gem
+*.bundle
+*.rbc
+*.a
+*.o
+*.so
+*.dSYM
+pkg
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in exiv2.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    exiv2 (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rake-compiler (0.7.5)
+      rake
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  exiv2!
+  rake-compiler
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Envato & Pete Yandell.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+= Exiv2
+
+A simple wrapper around the C++ Exiv2 libary for reading image metadata.
+
+See http://www.exiv2.org/
+
+== Usage
+
+    gem install exiv2
+
+    require 'exiv2'
+    image = Exiv2::ImageFactory.open("image.jpg")
+    image.read_metadata
+    puts image.exif_data.inspect
+    puts image.iptc_data.inspect
+
+== 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 (c) 2010 Envato & Pete Yandell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('exiv2') do |ext|
+  ext.lib_dir = "lib/exiv2"
+end
+Rake::Task[:spec].prerequisites << :compile
+
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/exiv2.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "exiv2/version"
+
+Gem::Specification.new do |s|
+  s.name        = "exiv2"
+  s.version     = Exiv2::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pete Yandell"]
+  s.email       = ["pete@envato.com"]
+  s.homepage    = "https://github.com/envato/exiv2"
+  s.summary     = %q{A simple wrapper around Exiv2}
+  s.description = %q{A simple wrapper around the C++ Exiv2 libary for reading image metadata}
+
+  s.rubyforge_project = "exiv2"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake-compiler"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "ext"]
+  s.extensions    = ["ext/exiv2/extconf.rb"]
+end

data/ext/exiv2/exiv2.cpp

@@ -0,0 +1,111 @@
+#include "exiv2/image.hpp"
+#include "ruby.h"
+
+// Create a Ruby string from a C++ std::string.
+static VALUE to_ruby_string(const std::string& string) {
+  return rb_str_new(string.data(), string.length());
+}
+
+// Create a C++ std::string from a Ruby string.
+static std::string to_std_string(VALUE string) {
+  return std::string(RSTRING(string)->ptr, RSTRING(string)->len);
+}
+
+// Extract data from an Exiv2::IptcData or an Exiv2::ExifData into a Ruby hash.
+template <class T>
+static VALUE data_to_hash(T& data) {
+  VALUE hash = rb_hash_new();
+
+  for(typename T::iterator i = data.begin(); i != data.end(); i++) {
+    VALUE key   = to_ruby_string(i->key());
+    VALUE value = to_ruby_string(i->value().toString());
+    rb_hash_aset(hash, key, value);
+  }
+
+  return hash;
+}
+
+extern "C" {
+  typedef VALUE (*Method)(...);
+
+  static VALUE exiv2_module;
+
+  static VALUE basic_error_class;
+
+  static VALUE image_class;
+  static void image_free(Exiv2::Image* image);
+  static VALUE image_read_metadata(VALUE self);
+  static VALUE image_iptc_data(VALUE self);
+  static VALUE image_exif_data(VALUE self);
+
+  static VALUE image_factory_class;
+  static VALUE image_factory_open(VALUE klass, VALUE path);
+
+
+  void Init_exiv2() {
+    exiv2_module = rb_define_module("Exiv2");
+
+    basic_error_class = rb_define_class_under(exiv2_module, "BasicError", rb_eRuntimeError);
+
+    image_class = rb_define_class_under(exiv2_module, "Image", rb_cObject);
+    rb_define_method(image_class, "read_metadata", (Method)image_read_metadata, 0);
+    rb_define_method(image_class, "iptc_data", (Method)image_iptc_data, 0);
+    rb_define_method(image_class, "exif_data", (Method)image_exif_data, 0);
+
+    image_factory_class = rb_define_class_under(exiv2_module, "ImageFactory", rb_cObject);
+    rb_define_singleton_method(image_factory_class, "open", (Method)image_factory_open, 1);
+  }
+
+  
+  // Exiv2::Image Methods
+  
+  static void image_free(Exiv2::Image* image) {
+    delete image;
+  }
+  
+  static VALUE image_read_metadata(VALUE self) {
+    Exiv2::Image* image;
+    Data_Get_Struct(self, Exiv2::Image, image);
+
+    try {
+      image->readMetadata();
+    }
+    catch (Exiv2::BasicError<char> error) {
+      rb_raise(basic_error_class, "%s", error.what());
+    }
+
+    return Qnil;
+  }
+
+  static VALUE image_exif_data(VALUE self) {
+    Exiv2::Image* image;
+    Data_Get_Struct(self, Exiv2::Image, image);
+
+    return data_to_hash<Exiv2::ExifData>(image->exifData());
+  }
+
+  static VALUE image_iptc_data(VALUE self) {
+    Exiv2::Image* image;
+    Data_Get_Struct(self, Exiv2::Image, image);
+
+    return data_to_hash<Exiv2::IptcData>(image->iptcData());
+  }
+
+
+  // Exiv2::ImageFactory methods
+
+  static VALUE image_factory_open(VALUE klass, VALUE path) {
+    Exiv2::Image* image;
+
+    try {
+      Exiv2::Image::AutoPtr image_auto_ptr = Exiv2::ImageFactory::open(to_std_string(path));
+      image = image_auto_ptr.release(); // Release the AutoPtr, so we can keep the image around.
+    }
+    catch (Exiv2::BasicError<char> error) {
+      rb_raise(basic_error_class, "%s", error.what());
+    }
+  
+    return Data_Wrap_Struct(image_class, 0, image_free, image);
+  }
+
+}

data/ext/exiv2/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+dir_config("exiv2")
+have_library("exiv2")
+create_makefile("exiv2/exiv2")

data/lib/exiv2.rb

@@ -0,0 +1 @@
+require 'exiv2/exiv2'

data/lib/exiv2/version.rb

@@ -0,0 +1,3 @@
+module Exiv2
+  VERSION = "0.0.1"
+end

data/spec/exiv2_spec.rb

@@ -0,0 +1,17 @@
+require 'exiv2'
+
+describe Exiv2 do
+  it "should read IPTC data" do
+    image = Exiv2::ImageFactory.open("spec/files/test.jpg")
+    image.read_metadata
+    image.iptc_data.should == {
+      "Iptc.Application2.Caption" => "Rhubarb rhubarb rhubard"
+    }
+  end
+
+  it "should raise an error when trying to open a non-existant file" do
+    expect {
+      Exiv2::ImageFactory.open("tmp/no-such-file.jpg")
+    }.should raise_error(Exiv2::BasicError)
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: exiv2
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pete Yandell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-24 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake-compiler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A simple wrapper around the C++ Exiv2 libary for reading image metadata
+email: 
+- pete@envato.com
+executables: []
+
+extensions: 
+- ext/exiv2/extconf.rb
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- exiv2.gemspec
+- ext/exiv2/exiv2.cpp
+- ext/exiv2/extconf.rb
+- lib/exiv2.rb
+- lib/exiv2/version.rb
+- spec/exiv2_spec.rb
+- spec/files/test.jpg
+has_rdoc: true
+homepage: https://github.com/envato/exiv2
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: exiv2
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple wrapper around Exiv2
+test_files: 
+- spec/exiv2_spec.rb
+- spec/files/test.jpg