idzebra 0.1.1 → 0.2.0

data/bin/zebraidx_record

@@ -45,11 +45,13 @@ data = case file
   end
 
 IdZebra::API(global_opts[:config]) do |repo|
-  case cmd
-    when "add"
-      repo.add_record(data)
-    when "remove"
-      repo.delete_record(data)
+  repo.transaction do
+    case cmd
+      when "add"
+        repo.add_record(data)
+      when "remove"
+        repo.delete_record(data)
+    end
   end
   repo.commit if global_opts[:commit]
 end

data/lib/idzebra.rb

@@ -20,15 +20,21 @@ module IdZebra
 
     typedef :pointer, :zebra_handle
     typedef :pointer, :zebra_service
+    typedef :pointer, :res
     typedef :short,   :zebra_res
 
     # Yaz functions to set logging level
     attach_function :yaz_log_init_level, [:int], :void
     attach_function :yaz_log_mask_str, [:string], :int
 
+    # Res function for resource handling
+    attach_function :res_open, [:res, :res], :res
+
     attach_function :zebra_start, [:string], :zebra_service
     attach_function :zebra_stop, [:zebra_service], :zebra_res
-    attach_function :zebra_open, [:zebra_service, :pointer], :zebra_handle
+    attach_function :zebra_open, [:zebra_service, :res], :zebra_handle
+    attach_function :zebra_begin_trans, [:zebra_handle, :short], :zebra_res
+    attach_function :zebra_end_trans, [:zebra_handle], :zebra_res
     attach_function :zebra_close, [:zebra_handle], :zebra_res
 
     attach_function :zebra_init,    [:zebra_handle], :zebra_res
@@ -36,6 +42,18 @@ module IdZebra
     attach_function :zebra_commit,  [:zebra_handle], :zebra_res
     attach_function :zebra_compact, [:zebra_handle], :zebra_res
 
+    attach_function :zebra_get_resource, [
+      :zebra_handle,
+      :string,        # name
+      :string],       # default value
+      :string
+
+    attach_function :zebra_set_resource, [
+      :zebra_handle,
+      :string,        # name
+      :string],       # value
+      :string
+
     attach_function :zebra_add_record, [
       :zebra_handle,
       :string,        # buf
@@ -55,6 +73,7 @@ module IdZebra
 
   class << self
 
+    # Create a new {Repository} connection.
     def API(config_file, &block)
       extend Native
       log_level = :error
@@ -67,6 +86,7 @@ module IdZebra
       zebra_stop zs
     end
 
+    # Get the current logging level
     def log_level
       extend Native
       mask = yaz_log_mask_str('')
@@ -84,6 +104,7 @@ module IdZebra
       end
     end
 
+    # Set the logging level
     def log_level=(log_level)
       extend Native
       case log_level
@@ -96,29 +117,66 @@ module IdZebra
       when :info, :default
         yaz_log_init_level(yaz_log_mask_str('log'))
       when :debug, :all
-        yaz_log_init_level(yaz_log_mask_str('all'))
+        yaz_log_init_level(yaz_log_mask_str('all,zebraapi,flock'))
       end
     end
 
   end
 
+  # Raised when transactions are unable to be started.
+  class TransactionError < StandardError; end
+
+  # Class representing a Zebra handle to a repository.
+  #
+  # Operations are named to directly correspond to their counterparts in api.h
+  # and zebraidx, and so are not particularly Ruby-like.
+  #
+  # @see http://www.indexdata.com/zebra/dox/html/api_8h.html Zebra API
+  # @see http://www.indexdata.com/zebra/doc/zebraidx.html zebraidx
   class Repository < Struct.new(:zebra_handle)
     include Native
 
+    # Create a new repository (wiping any existing data).
     def init
       zebra_init(zebra_handle)
     end
 
+    # Attempt to save some space by compacting existing data files.
     def compact
       zebra_compact(zebra_handle)
     end
 
+    # Rollback changes in shadow files and forget changes.
     def clean
       zebra_clean(zebra_handle)
     end
 
+    # Commit the shadow files. Not designed to be run inside a transaction, but
+    # instead should be run after it.
     def commit
+      transaction
       zebra_commit(zebra_handle)
+    rescue TransactionError
+      raise TransactionError, "Commit cannot occur inside a transaction."
+    end
+
+    # Encapsulates the operation with `zebra_begin_trans` and `zebra_end_trans`
+    def transaction(read_only = false)
+      zebra_res = zebra_begin_trans(zebra_handle, read_only ? 0 : 1)
+      if zebra_res != 0
+        raise TransactionError,
+            "Unable to start transaction - probably a locking issue."
+      end
+      yield if block_given?
+      zebra_end_trans(zebra_handle)
+    end
+
+    def get_resource(name, default = nil)
+      zebra_get_resource(zebra_handle, name, default)
+    end
+
+    def set_resource(name, value)
+      zebra_set_resource(zebra_handle, name, value)
     end
 
     def add_record(record_str)
@@ -135,6 +193,11 @@ module IdZebra
         :action_delete, nil, 0, nil, nil, record_str, 0)
     end
 
+    alias :<< :update_record
+    alias :[] :get_resource
+    alias :[]=  :set_resource
+    alias :rollback :clean
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: idzebra
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2013-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby bindings for the Zebra open-source Z39.50/SRU server.
 email: tim@dettrick.net
 executables:
@@ -105,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2741384696241936114
+      hash: -4571173317423406803
 requirements:
 - idzebra-2.0
 rubyforge_project: