ffi-gphoto2 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06a37e1529e44e76317ee65554d7c1ddacea1cec
-  data.tar.gz: fd9cb5732c86302822891de0530a3b6dd822c078
+  metadata.gz: 83f9c14b8b7006440420e875c32d4a93b809ce28
+  data.tar.gz: 9e3ccef87bc4565c88c4750e64d09ccde23f3330
 SHA512:
-  metadata.gz: 63f6a9cc345afbc0c9e90fd4396927d054e24825c6579de635e0a12ab97fce77606960c0c9a79771b005b08e91537a262decef0e7015c3aa60010fa51b1bed3b
-  data.tar.gz: e1cd250dc551227e6425991e8aabe5e1dcb92452186caa6f33980081784f33c5733e96aadb99806abca94697c3090e2cd898dc6fa140d582655b0f2155ada2fc
+  metadata.gz: 9d90104862dfccd44685aefa3870d83cde93e23a0aab57df6a7eb5a7feb2d9e712ca8c3125260b36f18b090df6ea8fce60726e913b667617f551180058c12397
+  data.tar.gz: f8536cef9cf2d3d7c9cfedb71fa0e7079280a7a7a0e7f579e1b886c4cba8e37e9316504e2298f1aabc0358638a3cd7f0ef5d20e5c87eee95ea4e15d82acef454

data/.rspec

@@ -1,3 +1,2 @@
 --color
---warnings
 --require spec_helper

data/README.md

@@ -2,7 +2,7 @@
 
 **ffi-gphoto2** provides an FFI for common functions in [libgphoto2][1].
 It also includes a facade to interact with the library in a more
-canonical Ruby way.
+idiomatic Ruby way.
 
 ## Installation
 
@@ -17,82 +17,94 @@ canonical Ruby way.
 
 ## Usage
 
-    require 'gphoto2'
+```ruby
+require 'gphoto2'
 
-    # list available cameras
-    cameras = GPhoto2::Camera.all
-    # => [#<GPhoto2::Camera>, ...]
+# list available cameras
+cameras = GPhoto2::Camera.all
+# => [#<GPhoto2::Camera>, ...]
 
-    # list found cameras by model and port path
-    cameras.map { |c| [c.model, c.port] }
-    # => [['Nikon DSC D5100 (PTP mode)', 'usb:250,006'], ...]
+# list found cameras by model and port path
+cameras.map { |c| [c.model, c.port] }
+# => [['Nikon DSC D5100 (PTP mode)', 'usb:250,006'], ...]
 
-    # use the first camera
-    camera = cameras.first
+# use the first camera
+camera = cameras.first
 
-    # ...or more conveniently
-    camera = GPhoto2::Camera.first
+# ...or more conveniently
+camera = GPhoto2::Camera.first
 
-    # ...or even search by model name
-    camera = GPhoto2::Camera.where(model: /nikon/i).first
+# ...or even search by model name
+camera = GPhoto2::Camera.where(model: /nikon/i).first
 
-    # check camera abilities
-    camera.can? :capture_image
-    # => true
+# check camera abilities (see `FFI::GPhoto2::CameraOperation.symbols`)
+camera.can? :capture_image
+# => true
 
-    # list camera configuration names
-    camera.config.keys
-    # => ['autofocusdrive', 'manualfocusdrive', 'controlmode', ...]
+# list camera configuration names
+camera.config.keys
+# => ['autofocusdrive', 'manualfocusdrive', 'controlmode', ...]
 
-    # read the current configuration value of an option
-    camera['whitebalance']
-    # => "Automatic"
+# read the current configuration value of an option
+camera['expprogram'].value
+# => "M"
+camera['whitebalance'].value
+# => "Automatic"
 
-    # list valid choices of a configuration option
-    camera['whitebalance'].choices
-    # => ['Automatic', 'Daylight', 'Fluorescent', 'Tungsten', ...]
+# list valid choices of a configuration option
+camera['whitebalance'].choices
+# => ["Automatic", "Daylight", "Fluorescent", "Tungsten", ...]
 
-    # check if the configuration has changed
-    camera.dirty?
-    # => false
+# check if the configuration has changed
+camera.dirty?
+# => false
 
-    # change camera configuration
-    camera['iso'] = 800
-    camera['f-number'] = 'f/4.5'
-    camera['shutterspeed2'] = '1/30'
+# change camera configuration
+camera['iso'] = 800
+camera['f-number'] = 'f/4.5'
+camera['shutterspeed2'] = '1/30'
 
-    # check if the configuration has changed
-    camera.dirty?
-    # => true
+# check if the configuration has changed
+camera.dirty?
+# => true
 
-    # apply the new configuration on the device
-    camera.save
+# apply the new configuration to the device
+camera.save
 
-    # take a photo
-    file = camera.capture
+# alternatively, update the camera configuration in one go
+camera.update(iso: 200, shutterspeed2: '1/60', 'f-number' => 'f/1.8')
 
-    # ...and save it to the current working directory
-    file.save
+# take a photo
+file = camera.capture
 
-    # traverse the camera filesystem
-    folder = camera/'store_00010001/DCIM/100D5100'
+# ...and save it to the current working directory
+file.save
 
-    # list files
-    files = folder.files
-    folder.files.map(&:name)
-    => ["DSC_0001.JPG", "DSC_0002.JPG", ...]
+# ...or to a specific pathname
+file.save('/tmp/out.jpg')
 
-    # save a file
-    file = files.first
-    file.save
+# traverse the camera filesystem
+folder = camera/'store_00010001/DCIM/100D5100'
 
-    # and delete it
-    file.delete
+# list files
+files = folder.files
+folder.files.map(&:name)
+# => ["DSC_0001.JPG", "DSC_0002.JPG", ...]
 
-    # close the camera
-    camera.finalize
+# copy a file from the camera
+file = files.first
+file.save
 
-More examples can be found in [`examples/`][2].
+# ...and then delete it from the camera
+file.delete
+
+# close the camera
+camera.finalize
+```
+
+More examples can be found in [`examples/`][2]. YARD documentation can be
+generated using the `rake yard` task or [browsed online][3].
 
 [1]: http://www.gphoto.org/
 [2]: https://github.com/zaeleus/ffi-gphoto2/tree/master/examples
+[3]: http://www.rubydoc.info/gems/ffi-gphoto2/frames

data/examples/list_config.rb

@@ -15,9 +15,6 @@ def visit(widget, level = 0)
   indent << '  '
 
   puts "#{indent}type: #{widget.type}"
-
-  return if widget.type == :menu
-
   puts "#{indent}value: #{widget.value}"
 
   case widget.type
@@ -25,7 +22,7 @@ def visit(widget, level = 0)
     range = widget.range
     step = (range.size > 1) ? range[1] - range[0] : 1.0
     puts "#{indent}options: #{range.first}..#{range.last}:step(#{step})"
-  when :radio
+  when :radio, :menu
     puts "#{indent}options: #{widget.choices.inspect}"
   end
 end

data/ffi-gphoto2.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
   spec.add_development_dependency 'yard', '~> 0.8.7'
 
   spec.add_dependency 'ffi', '~> 1.9.0'

data/lib/gphoto2/camera/configuration.rb

@@ -29,6 +29,16 @@ module GPhoto2
       #
       # All unsaved changes will be lost.
       #
+      # @example
+      #   camera['iso']
+      #   # => 800
+      #
+      #   camera['iso'] = 200
+      #   camera.reload
+      #
+      #   camera['iso']
+      #   # => 800
+      #
       # @return [void]
       def reload
         @window.finalize if @window
@@ -67,6 +77,13 @@ module GPhoto2
 
       # Updates the configuration on the camera.
       #
+      # @example
+      #   camera['iso'] = 800
+      #   camera.save
+      #   # => true
+      #   camera.save
+      #   # => false (nothing to update)
+      #
       # @return [Boolean] whether setting the configuration was attempted
       def save
         return false unless dirty?

data/lib/gphoto2/camera/event.rb

@@ -30,7 +30,7 @@ module GPhoto2
         rc = gp_camera_wait_for_event(ptr, timeout, type, data_ptr, context.ptr)
         GPhoto2.check!(rc)
 
-        type = CameraEventType[type.read_int]
+        type = FFI::GPhoto2::CameraEventType[type.read_int]
         data = data_ptr.read_pointer
 
         data =

data/lib/gphoto2/camera.rb

@@ -56,7 +56,7 @@ module GPhoto2
       raise RuntimeError, 'no devices detected' if entries.empty?
       camera = entries.first
       autorelease(camera, &blk)
-   end
+    end
 
     # @example
     #   model = 'Nikon DSC D5100 (PTP mode)'
@@ -139,6 +139,7 @@ module GPhoto2
     #   camera.can? :capture_image
     #   # => true
     #
+    # @see FFI::GPhoto2::CameraOperation
     # @param [CameraOperation] operation
     # @return [Boolean]
     def can?(operation)

data/lib/gphoto2/camera_widgets/camera_widget.rb

@@ -63,8 +63,6 @@ module GPhoto2
       case type
       when :window, :section
         children.each { |child| child.flatten(map) }
-      when :menu
-        # noop
       else
         map[name] = self
       end

data/lib/gphoto2/camera_widgets/menu_camera_widget.rb

@@ -1,4 +1,4 @@
 module GPhoto2
-  class MenuCameraWidget < CameraWidget
+  class MenuCameraWidget < RadioCameraWidget
   end
 end

data/lib/gphoto2/version.rb

@@ -1,3 +1,3 @@
 module GPhoto2
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/lib/gphoto2.rb

@@ -8,9 +8,9 @@ require 'ffi/gphoto2_port'
 require 'gphoto2/struct'
 
 require 'gphoto2/camera_widgets/camera_widget'
+require 'gphoto2/camera_widgets/radio_camera_widget'
 require 'gphoto2/camera_widgets/date_camera_widget'
 require 'gphoto2/camera_widgets/menu_camera_widget'
-require 'gphoto2/camera_widgets/radio_camera_widget'
 require 'gphoto2/camera_widgets/range_camera_widget'
 require 'gphoto2/camera_widgets/section_camera_widget'
 require 'gphoto2/camera_widgets/text_camera_widget'

data/spec/gphoto2/camera_widgets/date_camera_widget_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module GPhoto2
   describe DateCameraWidget do
-    it_behaves_like CameraWidget, DateCameraWidget
+    it_behaves_like CameraWidget
 
     describe '#value' do
       it 'has a Time return value' do

data/spec/gphoto2/camera_widgets/radio_camera_widget_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module GPhoto2
   describe RadioCameraWidget do
-    it_behaves_like CameraWidget, RadioCameraWidget
+    it_behaves_like CameraWidget
 
     describe '#value' do
       it 'has a String return value' do

data/spec/gphoto2/camera_widgets/range_camera_widget_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module GPhoto2
   describe RangeCameraWidget do
-    it_behaves_like CameraWidget, RangeCameraWidget
+    it_behaves_like CameraWidget
 
     describe '#value' do
       it 'has a Float return value' do

data/spec/gphoto2/camera_widgets/text_camera_widget_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module GPhoto2
   describe TextCameraWidget do
-    it_behaves_like CameraWidget, TextCameraWidget
+    it_behaves_like CameraWidget
 
     describe '#value' do
       it 'has a String return value' do

data/spec/gphoto2/camera_widgets/toggle_camera_widget_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module GPhoto2
   describe ToggleCameraWidget do
-    it_behaves_like CameraWidget, ToggleCameraWidget
+    it_behaves_like CameraWidget
 
     describe '#value' do
       it 'can have a TrueClass return value' do

data/spec/spec_helper.rb

@@ -3,3 +3,13 @@ require 'gphoto2'
 
 __dir__ ||= File.dirname(__FILE__)
 Dir[File.join(__dir__, 'support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/shared_examples/camera_widget_examples.rb

@@ -1,4 +1,6 @@
-shared_examples_for GPhoto2::CameraWidget do |klass|
+shared_examples_for GPhoto2::CameraWidget do
+  let(:klass) { described_class }
+
   describe '#name' do
     it 'returns the name of the widget' do
       name = 'name'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-gphoto2
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Michael Macias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-16 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - libgphoto2 >= 2.5.0
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Ruby FFI for common functions in libgphoto2