ffi-gphoto2 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b41989c0a0a69883e01f7f220c8afc02a7f14a6
-  data.tar.gz: 437b613df85ec51ef13c28b160e0614bd84019ff
+  metadata.gz: f540e98f060027da7173c2025502331090f5a24c
+  data.tar.gz: 27555b84f07e26724da18c72500e6c7483ec6916
 SHA512:
-  metadata.gz: 7b0ad2ed9e8ca01acbbee01466196f787e12c2472eefbe5dc51b56ae8abafa1598546310a7dca52eb464d681f688790c8650b950d1459ce40157fc0233430e48
-  data.tar.gz: 9030436814f22ad5d8af8065cb8918c8f7503968afa44d745dd81720a2e4a38097ea21af371b42aa5c75289931cd13704fde8a83136211dd9a0504b57bf62f19
+  metadata.gz: f7fc0ad08a779b3de0b29a54b2624b367a350b4203b7ab174e1089955fd171a67645943227954fd78730a95eb4754a572bed4a788a35aba51bf654b567aff31f
+  data.tar.gz: 355b62d70d3c67322631093a1c4d32ee84bdcfbd5bd2b5ba1eafda2171e99d9e38245c799b1daed6c1e59795d0514f0d6406098c58f9cd7dd92aa3163a013e0a

data/README.md

@@ -36,6 +36,10 @@ canonical Ruby way.
     # ...or even search by model name
     camera = GPhoto2::Camera.where(/nikon/i).first
 
+    # check camera abilities
+    camera.can? :capture_image
+    # => true
+
     # list camera configuration names
     camera.config.keys
     # => ['autofocusdrive', 'manualfocusdrive', 'controlmode', ...]

data/examples/list_config.rb

@@ -0,0 +1,37 @@
+require 'gphoto2'
+
+def visit(widget, level = 0)
+  indent = '  ' * level
+
+  puts "#{indent}#{widget.name}"
+
+  if widget.type == :window || widget.type == :section
+    widget.children.each { |child| visit(child, level + 1) }
+    return
+  end
+
+  indent << '  '
+
+  puts "#{indent}type: #{widget.type}"
+
+  return if widget.type == :menu
+
+  puts "#{indent}value: #{widget.value}"
+
+  case widget.type
+  when :range
+    range = widget.range
+    step = (range.size > 1) ? range[1] - range[0] : 1.0
+    puts "#{indent}options: #{range.first}..#{range.last}:step(#{step})"
+  when :radio
+    puts "#{indent}options: #{widget.choices.inspect}"
+  end
+end
+
+camera = GPhoto2::Camera.first
+
+begin
+  visit(camera.window)
+ensure
+  camera.finalize
+end

data/examples/record_movie.rb

@@ -18,10 +18,8 @@ begin
   # stop recording
   camera.update(movie: false)
 
-  # wait for the camera to finish with the file
-  begin
-    event = camera.wait
-  end until event.type == :file_added
+  # block until the camera finishes with the file
+  event = camera.wait_for(:file_added)
 
   # the event data has a camera file that can be saved
   event.data.save

data/lib/gphoto2/camera.rb

@@ -2,7 +2,7 @@ module GPhoto2
   class Camera
     include FFI::GPhoto2
 
-    attr_reader :context, :port
+    attr_reader :context, :model, :port
 
     def self.all
       context = Context.new
@@ -12,7 +12,7 @@ module GPhoto2
 
       entries = cameras.to_a.map do |entry|
         model, port = entry.name, entry.value
-        Camera.new(port, model)
+        Camera.new(model, port)
       end
 
       context.finalize
@@ -26,8 +26,8 @@ module GPhoto2
       entries.first
     end
 
-    def self.open(port, model = nil)
-      camera = new(port, model)
+    def self.open(model, port)
+      camera = new(model, port)
 
       if block_given?
         begin
@@ -40,12 +40,14 @@ module GPhoto2
       end
     end
 
-    def self.where(pattern)
-      all.select { |c| c.model.match(pattern) }
+    def self.where(condition)
+      name = condition.keys.first
+      pattern = condition.values.first
+      all.select { |c| c.send(name).match(pattern) }
     end
 
-    def initialize(port, model = nil)
-      @port, @model = port, model
+    def initialize(model, port)
+      @model, @port = model, port
       @dirty = false
     end
 
@@ -76,17 +78,12 @@ module GPhoto2
       wait_for_event(timeout)
     end
 
-    def model
-      @model ||= begin
-        abilities = CameraAbilitiesList.new(context).detect
-        cameras = abilities.detect
+    def wait_for(event_type)
+      begin
+        event = wait
+      end until event.type == event_type
 
-        entry = cameras.map(&:value).find { |port| port == @port }
-
-        raise RuntimeError, "no camera found on port #{@port}" if entry.nil?
-
-        entry.name
-      end
+      event
     end
 
     def ptr
@@ -149,6 +146,10 @@ module GPhoto2
       @dirty
     end
 
+    def can?(operation)
+      (abilities[:operations] & CameraOperation[operation]) != 0
+    end
+
     def save
       return false unless dirty?
       set_config

data/lib/gphoto2/camera_widgets/camera_widget.rb

@@ -41,7 +41,7 @@ module GPhoto2
     def children
       count_children.times.map { |i| get_child(i) }
     end
-    
+
     def flatten(map = {})
       case type
       when :window, :section

data/lib/gphoto2/camera_widgets/text_camera_widget.rb

@@ -10,5 +10,11 @@ module GPhoto2
       GPhoto2.check!(rc)
       val_ptr.read_pointer.read_string
     end
+
+    def set_value(text)
+      val = FFI::MemoryPointer.from_string(text)
+      rc = gp_widget_set_value(ptr, val)
+      GPhoto2.check!(rc)
+    end
   end
 end

data/lib/gphoto2/camera_widgets/toggle_camera_widget.rb

@@ -5,6 +5,7 @@ module GPhoto2
     def get_value
       val = FFI::MemoryPointer.new(:int)
       rc = gp_widget_get_value(ptr, val)
+      GPhoto2.check!(rc)
       (val.read_int == 1)
     end
 

data/lib/gphoto2/version.rb

@@ -1,3 +1,3 @@
 module GPhoto2
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/gphoto2/camera_spec.rb

@@ -2,12 +2,13 @@ require 'spec_helper'
 
 module GPhoto2
   describe Camera do
+    let(:model) { 'Nikon DSC D5100 (PTP mode)' }
     let(:port) { 'usb:250,006' }
 
     describe '.all' do
       let(:abilities_list) { double('camera_abilities_list') }
       let(:camera_list) { double('camera_list') }
-      let(:camera) { Camera.new(port) }
+      let(:camera) { Camera.new(model, port) }
 
       before do
         Context.stub(:stub)
@@ -26,7 +27,7 @@ module GPhoto2
     describe '.first' do
       context 'when devices are automatically detected' do
         it 'returns a new Camera using the first entry' do
-          camera = Camera.new(port)
+          camera = Camera.new(model, port)
           Camera.stub(:all).and_return([camera])
           expect(Camera.first).to be_kind_of(Camera)
         end
@@ -47,33 +48,51 @@ module GPhoto2
       context 'when a block is given' do
         it 'yeilds a new camera instance' do
           expect(Camera).to receive(:open).and_yield(camera)
-          Camera.open(port) { |c| }
+          Camera.open(model, port) { |c| }
         end
 
         it 'finalizes the camera when the block terminates' do
           expect(camera).to receive(:finalize)
-          Camera.open(port) { |c| }
+          Camera.open(model, port) { |c| }
         end
       end
 
       context 'when no block is given' do
         it 'returns a new camera instance' do
-           expect(Camera.open(port)).to eq(camera)
+           expect(Camera.open(model, port)).to eq(camera)
         end
       end
     end
 
     describe '.where' do
-      it 'filters all detected cameras by model' do
-        cameras = %w[cheese toast wine].map { |model| double('camera', model: model) }
+      let(:cameras) do
+        cameras = []
+        cameras << double('camera', model: 'Canon EOS 5D Mark III', port: 'usb:250,004')
+        cameras << double('camera', model: 'Nikon DSC D800', port: 'usb:250,005')
+        cameras << double('camera', model: 'Nikon DSC D5100', port: 'usb:250,006')
+        cameras
+      end
+
+      before do
         Camera.stub(:all).and_return(cameras)
-        expect(Camera.where(/e/)).to match_array([cameras[0], cameras[2]])
+      end
+
+      it 'filters all detected cameras by model' do
+        actual = Camera.where(model: /nikon/i)
+        expected = [cameras[1], cameras[2]]
+        expect(actual).to match_array(expected)
+      end
+
+      it 'filters all detected cameras by port' do
+        actual = Camera.where(port: 'usb:250,004')
+        expected = [cameras[0]]
+        expect(actual).to match_array(expected)
       end
     end
 
     describe '#exit' do
       it 'closes the camera connection' do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub(:_exit)
         expect(camera).to receive(:_exit)
         camera.exit
@@ -81,7 +100,7 @@ module GPhoto2
     end
 
     describe '#capture' do
-      let(:camera) { Camera.new(port) }
+      let(:camera) { Camera.new(model, port) }
       let(:path) { double('camera_file_path', folder: 'folder', name: 'name') }
 
       before do
@@ -100,7 +119,7 @@ module GPhoto2
     end
 
     describe '#preview' do
-      let(:camera) { Camera.new(port) }
+      let(:camera) { Camera.new(model, port) }
       let(:file) { double('camera_file') }
 
       before do
@@ -119,8 +138,8 @@ module GPhoto2
     end
 
     describe '#wait' do
-      let(:camera) { Camera.new(port) }
-      let(:event) { :capture_complete }
+      let(:camera) { Camera.new(model, port) }
+      let(:event) { double('camera_event') }
 
       before do
         camera.stub(:wait_for_event).and_return(event)
@@ -136,8 +155,26 @@ module GPhoto2
       end
     end
 
+    describe '#wait_for' do
+      let(:camera) { Camera.new(model, port) }
+      let(:event) { double('camera_event', type: :capture_complete) }
+
+      before do
+        camera.stub(:wait).and_return(event)
+      end
+
+      it 'blocks until a given event is returned from #wait' do
+        expect(camera).to receive(:wait)
+        camera.wait_for(:capture_complete)
+      end
+
+      it 'returns the first event of the given type' do
+        expect(camera.wait_for(:capture_complete)).to eq(event)
+      end
+    end
+
     describe '#window' do
-      let(:camera) { Camera.new(port) }
+      let(:camera) { Camera.new(model, port) }
       let(:window) { double('camera_widget') }
 
       it 'always returns the same CameraWidget instance' do
@@ -149,7 +186,7 @@ module GPhoto2
 
     describe '#config' do
       it 'returns a map of configuration widgets' do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         window = double('camera_widget')
         camera.stub(:window).and_return(window)
         window.stub(:flatten).and_return({ 'iso' => window })
@@ -159,7 +196,7 @@ module GPhoto2
     end
 
     describe '#filesystem' do
-      let(:camera) { Camera.new(port) }
+      let(:camera) { Camera.new(model, port) }
 
       context 'when a path is passed' do
         let(:path) { '/store_00010001' }
@@ -185,7 +222,7 @@ module GPhoto2
 
     describe '#file' do
       it 'retrieves a file from the camera' do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub(:file_get)
         expect(camera).to receive(:file_get)
         camera.file(double('camera_file'))
@@ -194,7 +231,7 @@ module GPhoto2
 
     describe '#delete' do
       it 'deletes a file from the camera' do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub(:file_delete)
         expect(camera).to receive(:file_delete)
         camera.delete(double('camera_file'))
@@ -205,7 +242,7 @@ module GPhoto2
       let(:window) { double('camera_widget') }
 
       let(:camera) do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub(:config).and_return({ 'iso' => window })
         camera
       end
@@ -231,7 +268,7 @@ module GPhoto2
       end
 
       let(:camera) do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub(:[]).and_return(window)
         camera
       end
@@ -252,7 +289,7 @@ module GPhoto2
 
     describe '#update' do
       let(:camera) do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub(:[]=)
         camera.stub(:save)
         camera
@@ -272,7 +309,7 @@ module GPhoto2
     describe '#dirty?' do
       context 'when the configuration changed' do
         it 'returns true' do
-          camera = Camera.new(port)
+          camera = Camera.new(model, port)
           camera.stub_chain(:[], :value=)
 
           camera['iso'] = 400
@@ -283,15 +320,38 @@ module GPhoto2
 
       context 'when the configuration has not changed' do
         it 'returns false' do
-          camera = Camera.new(port)
+          camera = Camera.new(model, port)
           expect(camera).not_to be_dirty 
         end
       end
     end
 
+    describe '#can?' do
+      let(:camera) { Camera.new(model, port) }
+      let(:operations) { FFI::GPhoto2::CameraOperation[:capture_image] }
+
+      before do
+        camera.stub_chain(:abilities, :[])
+          .with(:operations)
+          .and_return(operations)
+      end
+
+      context 'when the camera does not have the ability perform an operation' do
+        it 'return false' do
+          expect(camera.can?(:capture_audio)).to be_false
+        end
+      end
+
+      context 'when the camera does have the ability to perform an operation' do
+        it 'returns true' do
+          expect(camera.can?(:capture_image)).to be_true
+        end
+      end
+    end
+
     describe '#save' do
       let(:camera) do
-        camera = Camera.new(port)
+        camera = Camera.new(model, port)
         camera.stub_chain(:[], :value=)
         camera.stub(:set_config)
         camera

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-gphoto2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Macias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-05 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - examples/intervalometer.rb
+- examples/list_config.rb
 - examples/live_view.rb
 - examples/record_movie.rb
 - ffi-gphoto2.gemspec
@@ -171,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - libgphoto2 >= 2.5.0
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: A Ruby FFI for common functions in libgphoto2