libgfapi-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0669cfea34e893de481678cc8e1b9a67e795cbf4
-  data.tar.gz: 1b71461efff897518ebcfa0dc06c7e3c2f9c3e29
+  metadata.gz: 218fc8b79c32f5db3573e1714cba7376906d2328
+  data.tar.gz: fa6b48a3b70348aa703cc68cbee7a2802ae52f92
 SHA512:
-  metadata.gz: ba03a9428231f95351eb74732df8c33240453bc59a3a051aadae9f5d9c074ce5ecb698fcc7bc55a280de11498aaa810b959fb72e9e322d139d1ede07057f4921
-  data.tar.gz: 04db7ce3f2046076f6af679d02eea68f17a0da9ac086031321fe6c0aa97dc81f72f0524fb0f1952ebec100d7f6da6cecf12a34a9b6e151584de700b6d100d323
+  metadata.gz: 7804714a56eaf5364e9fb24cfd86d3f278ef92ef835b3356a60e29572d88b18d2257b37cb8387a023f27ae4cdc3135afe2991bf83d5069810c9757aaad550b90
+  data.tar.gz: 0c31210229bc5b178e2a586507f49da15e6616eee3496ecfe2d61370aae72c60f07795052fd2e689db4b60dc21a43f5ad915c9ea3592e7a0802aaf980bae935f

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Vagrantfile
+.vagrant

data/README.md

@@ -3,6 +3,10 @@
 Ruby bindings for [libgfapi](https://github.com/gluster/glusterfs/blob/master/api/src/glfs.h)
 (GlusterFS API).
 
+## Warning
+
+This library is currently under active development, and is not ready for production yet.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,24 +27,27 @@ Or install it yourself as:
 require 'glusterfs'
 
 # Create virtual mount
-fs = GlusterFS.new 'my_volume'
-GlusterFS.set_volfile_server fs, 'tcp', '1.2.3.4', 24007
-GlusterFS.init fs
+volume =  GlusterFS::Client.mount('my_volume', '1.2.3.4')
 
-# Make a new directory
-GlusterFS.mkdir fs, '/some_dir', 0755
+# Make a new directory (raw)
+GlusterFS.mkdir(volume.fs, '/some_dir', 0755)
 
 # Write a file
-file = File.open('/some/file')
-size = GlusterFS::File.write(fs, '/gfs/file/path', file)
+file = GlusterFS::File.new(volume, '/gfs/file/path')
+size = file.write(data)
 puts "Written #{size} bytes"
 
 # Read a file
-file = GlusterFS::File.read(fs, '/gfs/file/path')
+file = GlusterFS::File.new(volume, '/gfs/file/path')
 contents = file.read
+contents = file.read
+
+# Delete a file
+file = GlusterFS::File.new(volume, '/gfs/file/path')
+file.unlink
 
-# Destroy virtual mount
-GlusterFS.fini fs
+# Unmount virtual mount
+volume.unmount
 ```
 
 ## Contributing

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task default: :spec

data/lib/glusterfs.rb

@@ -1,340 +1,12 @@
+require "ffi"
 require "glusterfs/version"
+require "glusterfs/bindings"
+require "glusterfs/error"
 require "glusterfs/file"
-require "ffi"
+require "glusterfs/directory"
+require "glusterfs/volume"
+require "glusterfs/client"
+require "glusterfs/stat"
 
 module GlusterFS
-  extend FFI::Library
-
-  # https://github.com/gluster/glusterfs/blob/master/api/src/glfs.h
-  ffi_lib 'gfapi'
-
-=begin
-  SYNOPSIS
-
-  glfs_new: Create a new 'virtual mount' object.
-
-  DESCRIPTION
-
-  This is most likely the very first function you will use. This function
-  will create a new glfs_t (virtual mount) object in memory.
-
-  On this newly created glfs_t, you need to be either set a volfile path
-  (glfs_set_volfile) or a volfile server (glfs_set_volfile_server).
-
-  The glfs_t object needs to be initialized with glfs_init() before you
-  can start issuing file operations on it.
-
-  PARAMETERS
-
-  @volname: Name of the volume. This identifies the server-side volume and
-            the fetched volfile (equivalent of --volfile-id command line
-      parameter to glusterfsd). When used with glfs_set_volfile() the
-      @volname has no effect (except for appearing in log messages).
-
-  RETURN VALUES
-
-  NULL   : Out of memory condition.
-  Others : Pointer to the newly created glfs_t virtual mount object.
-
-  glfs_t *glfs_new (const char *volname) __THROW;
-=end
-  attach_function :new, :glfs_new, [:string], :pointer
-
-=begin
-  SYNOPSIS
-
-  glfs_set_volfile: Specify the path to the volume specification file.
-
-  DESCRIPTION
-
-  If you are using a static volume specification file (without dynamic
-  volume management abilities from the CLI), then specify the path to
-  the volume specification file.
-
-  This is incompatible with glfs_set_volfile_server().
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be configured with the volume
-       specification file.
-
-  @volfile: Path to the locally available volume specification file.
-
-  RETURN VALUES
-
-   0 : Success.
-  -1 : Failure. @errno will be set with the type of failure.
-
-  int glfs_set_volfile (glfs_t *fs, const char *volfile);
-=end
-  attach_function :set_volfile, :glfs_set_volfile, [:pointer, :string], :int
-
-=begin
-  SYNOPSIS
-
-  glfs_set_volfile_server: Specify the address of management server.
-
-  DESCRIPTION
-
-  This function specifies the address of the management server (glusterd)
-  to connect, and establish the volume configuration. The @volname
-  parameter passed to glfs_new() is the volume which will be virtually
-  mounted as the glfs_t object. All operations performed by the CLI at
-  the management server will automatically be reflected in the 'virtual
-  mount' object as it maintains a connection to glusterd and polls on
-  configuration change notifications.
-
-  This is incompatible with glfs_set_volfile().
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be configured with the volume
-       specification file.
-
-  @transport: String specifying the transport used to connect to the
-              management daemon. Specifying NULL will result in the usage
-        of the default (tcp) transport type. Permitted values
-        are those what you specify as transport-type in a volume
-        specification file (e.g "tcp", "rdma", "unix".)
-
-  @host: String specifying the address of where to find the management
-         daemon. Depending on the transport type this would either be
-   an FQDN (e.g: "storage01.company.com"), ASCII encoded IP
-   address "192.168.22.1", or a UNIX domain socket path (e.g
-   "/tmp/glusterd.socket".)
-
-  @port: The TCP port number where gluster management daemon is listening.
-         Specifying 0 uses the default port number GF_DEFAULT_BASE_PORT.
-   This parameter is unused if you are using a UNIX domain socket.
-
-  RETURN VALUES
-
-   0 : Success.
-  -1 : Failure. @errno will be set with the type of failure.
-
-  int glfs_set_volfile_server (glfs_t *fs, const char *transport,
-                               const char *host, int port) __THROW;
-=end
-  attach_function :set_volfile_server, :glfs_set_volfile_server,
-    [:pointer, :string, :string, :int], :int
-
-=begin
-  SYNOPSIS
-
-  glfs_set_logging: Specify logging parameters.
-
-  DESCRIPTION
-
-  This function specifies logging parameters for the virtual mount.
-  Default log file is /dev/null.
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be configured with the logging parameters.
-
-  @logfile: The logfile to be used for logging. Will be created if it does not
-            already exist (provided system permissions allow). If NULL, a new
-            logfile will be created in default log directory associated with
-            the glusterfs installation.
-
-  @loglevel: Numerical value specifying the degree of verbosity. Higher the
-             value, more verbose the logging.
-
-  RETURN VALUES
-
-   0 : Success.
-  -1 : Failure. @errno will be set with the type of failure.
-
-  int glfs_set_logging (glfs_t *fs, const char *logfile, int loglevel) __THROW;
-=end
-  attach_function :set_logging, :glfs_set_logging, [:pointer, :string, :int], :int
-
-=begin
-  SYNOPSIS
-
-  glfs_init: Initialize the 'virtual mount'
-
-  DESCRIPTION
-
-  This function initializes the glfs_t object. This consists of many steps:
-  - Spawn a poll-loop thread.
-  - Establish connection to management daemon and receive volume specification.
-  - Construct translator graph and initialize graph.
-  - Wait for initialization (connecting to all bricks) to complete.
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be initialized.
-
-  RETURN VALUES
-
-   0 : Success.
-  -1 : Failure. @errno will be set with the type of failure.
-
-  int glfs_init (glfs_t *fs) __THROW;
-=end
-  attach_function :init, :glfs_init, [:pointer], :int
-
-=begin
-  SYNOPSIS
-
-  glfs_fini: Cleanup and destroy the 'virtual mount'
-
-  DESCRIPTION
-
-  This function attempts to gracefully destroy glfs_t object. An attempt is
-  made to wait for all background processing to complete before returning.
-
-  glfs_fini() must be called after all operations on glfs_t is finished.
-
-  IMPORTANT
-
-  IT IS NECESSARY TO CALL glfs_fini() ON ALL THE INITIALIZED glfs_t
-  OBJECTS BEFORE TERMINATING THE PROGRAM. THERE MAY BE CACHED AND
-  UNWRITTEN / INCOMPLETE OPERATIONS STILL IN PROGRESS EVEN THOUGH THE
-  API CALLS HAVE RETURNED. glfs_fini() WILL WAIT FOR BACKGROUND OPERATIONS
-  TO COMPLETE BEFORE RETURNING, THEREBY MAKING IT SAFE FOR THE PROGRAM TO
-  EXIT.
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be destroyed.
-
-  RETURN VALUES
-
-   0 : Success.
-
-  int glfs_fini (glfs_t *fs) __THROW;
-=end
-  attach_function :fini, :glfs_fini, [:pointer], :int
-
-=begin
-  PER THREAD IDENTITY MODIFIERS
-
-  The following operations enable to set a per thread identity context
-  for the glfs APIs to perform operations as. The calls here are kept as close
-  to POSIX equivalents as possible.
-
-  NOTES:
-
-   - setgroups is a per thread setting, hence this is named as fsgroups to be
-     close in naming to the fs(u/g)id APIs
-   - Typical mode of operation is to set the IDs as required, with the
-     supplementary groups being optionally set, make the glfs call and post the
-     glfs operation set them back to eu/gid or uid/gid as appropriate to the
-     caller
-   - The groups once set, need to be unset by setting the size to 0 (in which
-     case the list argument is a do not care)
-   - Once a process for a thread of operation choses to set the IDs, all glfs
-     calls made from that thread would default to the IDs set for the thread.
-     As a result use these APIs with care and ensure that the set IDs are
-     reverted to global process defaults as required.
-
-  int glfs_setfsuid (uid_t fsuid) __THROW;
-  int glfs_setfsgid (gid_t fsgid) __THROW;
-  int glfs_setfsgroups (size_t size, const gid_t *list) __THROW;
-=end
-  attach_function :setfsuid, :glfs_setfsuid, [:int], :int
-  attach_function :setfsgid, :glfs_setfsgid, [:int], :int
-  attach_function :setfsgroups, :glfs_setfsgroups, [:uint, :pointer], :int
-
-=begin
-  SYNOPSIS
-
-  glfs_open: Open a file.
-
-  DESCRIPTION
-
-  This function opens a file on a virtual mount.
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be initialized.
-
-  @path: Path of the file within the virtual mount.
-
-  @flags: Open flags. See open(2). O_CREAT is not supported.
-          Use glfs_creat() for creating files.
-
-  RETURN VALUES
-
-  NULL   : Failure. @errno will be set with the type of failure.
-  Others : Pointer to the opened glfs_fd_t.
-
-  glfs_fd_t *glfs_open (glfs_t *fs, const char *path, int flags) __THROW;
-=end
-  attach_function :open, :glfs_open, [:pointer, :string, :int], :pointer
-
-=begin
-  SYNOPSIS
-
-  glfs_creat: Create a file.
-
-  DESCRIPTION
-
-  This function opens a file on a virtual mount.
-
-  PARAMETERS
-
-  @fs: The 'virtual mount' object to be initialized.
-
-  @path: Path of the file within the virtual mount.
-
-  @mode: Permission of the file to be created.
-
-  @flags: Create flags. See open(2). O_EXCL is supported.
-
-  RETURN VALUES
-
-  NULL   : Failure. @errno will be set with the type of failure.
-  Others : Pointer to the opened glfs_fd_t.
-
-  glfs_fd_t *glfs_creat (glfs_t *fs, const char *path, int flags,
-           mode_t mode) __THROW;
-=end
-  attach_function :creat, :glfs_creat, [:pointer, :string, :int, :int], :pointer
-
-=begin
-  int glfs_close (glfs_fd_t *fd) __THROW;
-=end
-  attach_function :close, :glfs_close, [:pointer], :int
-
-=begin
-  // glfs_{read,write}[_async]
-
-  ssize_t glfs_read (glfs_fd_t *fd, void *buf,
-                     size_t count, int flags) __THROW;
-  ssize_t glfs_write (glfs_fd_t *fd, const void *buf,
-                      size_t count, int flags) __THROW;
-  int glfs_read_async (glfs_fd_t *fd, void *buf, size_t count, int flags,
-           glfs_io_cbk fn, void *data) __THROW;
-  int glfs_write_async (glfs_fd_t *fd, const void *buf, size_t count, int flags,
-            glfs_io_cbk fn, void *data) __THROW;
-=end
-  attach_function :read, :glfs_read, [:pointer, :pointer, :uint, :int], :uint
-  attach_function :write, :glfs_write, [:pointer, :pointer, :uint, :int], :uint
-  # TODO async
-
-=begin
-  int glfs_mkdir (glfs_t *fs, const char *path, mode_t mode) __THROW;
-=end
-  attach_function :mkdir, :glfs_mkdir, [:pointer, :string, :int], :int
-
-=begin
-  int glfs_unlink (glfs_t *fs, const char *path) __THROW;
-=end
-  attach_function :unlink, :glfs_unlink, [:pointer, :string], :int
-
-=begin
-  int glfs_rmdir (glfs_t *fs, const char *path) __THROW;
-=end
-  attach_function :rmdir, :glfs_rmdir, [:pointer, :string], :int
-
-=begin
-  int glfs_rename (glfs_t *fs, const char *oldpath, const char *newpath) __THROW;
-=end
-  attach_function :rename, :glfs_rename, [:pointer, :string, :string], :int
-
-  # TODO the rest
-
 end

data/lib/glusterfs/bindings.rb

@@ -0,0 +1,343 @@
+module GlusterFS
+  extend FFI::Library
+
+  # https://github.com/gluster/glusterfs/blob/master/api/src/glfs.h
+  ffi_lib 'gfapi'
+
+=begin
+  SYNOPSIS
+
+  glfs_new: Create a new 'virtual mount' object.
+
+  DESCRIPTION
+
+  This is most likely the very first function you will use. This function
+  will create a new glfs_t (virtual mount) object in memory.
+
+  On this newly created glfs_t, you need to be either set a volfile path
+  (glfs_set_volfile) or a volfile server (glfs_set_volfile_server).
+
+  The glfs_t object needs to be initialized with glfs_init() before you
+  can start issuing file operations on it.
+
+  PARAMETERS
+
+  @volname: Name of the volume. This identifies the server-side volume and
+            the fetched volfile (equivalent of --volfile-id command line
+      parameter to glusterfsd). When used with glfs_set_volfile() the
+      @volname has no effect (except for appearing in log messages).
+
+  RETURN VALUES
+
+  NULL   : Out of memory condition.
+  Others : Pointer to the newly created glfs_t virtual mount object.
+
+  glfs_t *glfs_new (const char *volname) __THROW;
+=end
+  attach_function :new, :glfs_new, [:string], :pointer
+
+=begin
+  SYNOPSIS
+
+  glfs_set_volfile: Specify the path to the volume specification file.
+
+  DESCRIPTION
+
+  If you are using a static volume specification file (without dynamic
+  volume management abilities from the CLI), then specify the path to
+  the volume specification file.
+
+  This is incompatible with glfs_set_volfile_server().
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be configured with the volume
+       specification file.
+
+  @volfile: Path to the locally available volume specification file.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_set_volfile (glfs_t *fs, const char *volfile);
+=end
+  attach_function :set_volfile, :glfs_set_volfile, [:pointer, :string], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_set_volfile_server: Specify the address of management server.
+
+  DESCRIPTION
+
+  This function specifies the address of the management server (glusterd)
+  to connect, and establish the volume configuration. The @volname
+  parameter passed to glfs_new() is the volume which will be virtually
+  mounted as the glfs_t object. All operations performed by the CLI at
+  the management server will automatically be reflected in the 'virtual
+  mount' object as it maintains a connection to glusterd and polls on
+  configuration change notifications.
+
+  This is incompatible with glfs_set_volfile().
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be configured with the volume
+       specification file.
+
+  @transport: String specifying the transport used to connect to the
+              management daemon. Specifying NULL will result in the usage
+        of the default (tcp) transport type. Permitted values
+        are those what you specify as transport-type in a volume
+        specification file (e.g "tcp", "rdma", "unix".)
+
+  @host: String specifying the address of where to find the management
+         daemon. Depending on the transport type this would either be
+   an FQDN (e.g: "storage01.company.com"), ASCII encoded IP
+   address "192.168.22.1", or a UNIX domain socket path (e.g
+   "/tmp/glusterd.socket".)
+
+  @port: The TCP port number where gluster management daemon is listening.
+         Specifying 0 uses the default port number GF_DEFAULT_BASE_PORT.
+   This parameter is unused if you are using a UNIX domain socket.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_set_volfile_server (glfs_t *fs, const char *transport,
+                               const char *host, int port) __THROW;
+=end
+  attach_function :set_volfile_server, :glfs_set_volfile_server,
+    [:pointer, :string, :string, :int], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_set_logging: Specify logging parameters.
+
+  DESCRIPTION
+
+  This function specifies logging parameters for the virtual mount.
+  Default log file is /dev/null.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be configured with the logging parameters.
+
+  @logfile: The logfile to be used for logging. Will be created if it does not
+            already exist (provided system permissions allow). If NULL, a new
+            logfile will be created in default log directory associated with
+            the glusterfs installation.
+
+  @loglevel: Numerical value specifying the degree of verbosity. Higher the
+             value, more verbose the logging.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_set_logging (glfs_t *fs, const char *logfile, int loglevel) __THROW;
+=end
+  attach_function :set_logging, :glfs_set_logging, [:pointer, :string, :int], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_init: Initialize the 'virtual mount'
+
+  DESCRIPTION
+
+  This function initializes the glfs_t object. This consists of many steps:
+  - Spawn a poll-loop thread.
+  - Establish connection to management daemon and receive volume specification.
+  - Construct translator graph and initialize graph.
+  - Wait for initialization (connecting to all bricks) to complete.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be initialized.
+
+  RETURN VALUES
+
+   0 : Success.
+  -1 : Failure. @errno will be set with the type of failure.
+
+  int glfs_init (glfs_t *fs) __THROW;
+=end
+  attach_function :init, :glfs_init, [:pointer], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_fini: Cleanup and destroy the 'virtual mount'
+
+  DESCRIPTION
+
+  This function attempts to gracefully destroy glfs_t object. An attempt is
+  made to wait for all background processing to complete before returning.
+
+  glfs_fini() must be called after all operations on glfs_t is finished.
+
+  IMPORTANT
+
+  IT IS NECESSARY TO CALL glfs_fini() ON ALL THE INITIALIZED glfs_t
+  OBJECTS BEFORE TERMINATING THE PROGRAM. THERE MAY BE CACHED AND
+  UNWRITTEN / INCOMPLETE OPERATIONS STILL IN PROGRESS EVEN THOUGH THE
+  API CALLS HAVE RETURNED. glfs_fini() WILL WAIT FOR BACKGROUND OPERATIONS
+  TO COMPLETE BEFORE RETURNING, THEREBY MAKING IT SAFE FOR THE PROGRAM TO
+  EXIT.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be destroyed.
+
+  RETURN VALUES
+
+   0 : Success.
+
+  int glfs_fini (glfs_t *fs) __THROW;
+=end
+  attach_function :fini, :glfs_fini, [:pointer], :int
+
+=begin
+  PER THREAD IDENTITY MODIFIERS
+
+  The following operations enable to set a per thread identity context
+  for the glfs APIs to perform operations as. The calls here are kept as close
+  to POSIX equivalents as possible.
+
+  NOTES:
+
+   - setgroups is a per thread setting, hence this is named as fsgroups to be
+     close in naming to the fs(u/g)id APIs
+   - Typical mode of operation is to set the IDs as required, with the
+     supplementary groups being optionally set, make the glfs call and post the
+     glfs operation set them back to eu/gid or uid/gid as appropriate to the
+     caller
+   - The groups once set, need to be unset by setting the size to 0 (in which
+     case the list argument is a do not care)
+   - Once a process for a thread of operation choses to set the IDs, all glfs
+     calls made from that thread would default to the IDs set for the thread.
+     As a result use these APIs with care and ensure that the set IDs are
+     reverted to global process defaults as required.
+
+  int glfs_setfsuid (uid_t fsuid) __THROW;
+  int glfs_setfsgid (gid_t fsgid) __THROW;
+  int glfs_setfsgroups (size_t size, const gid_t *list) __THROW;
+=end
+  attach_function :setfsuid, :glfs_setfsuid, [:int], :int
+  attach_function :setfsgid, :glfs_setfsgid, [:int], :int
+  attach_function :setfsgroups, :glfs_setfsgroups, [:uint, :pointer], :int
+
+=begin
+  SYNOPSIS
+
+  glfs_open: Open a file.
+
+  DESCRIPTION
+
+  This function opens a file on a virtual mount.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be initialized.
+
+  @path: Path of the file within the virtual mount.
+
+  @flags: Open flags. See open(2). O_CREAT is not supported.
+          Use glfs_creat() for creating files.
+
+  RETURN VALUES
+
+  NULL   : Failure. @errno will be set with the type of failure.
+  Others : Pointer to the opened glfs_fd_t.
+
+  glfs_fd_t *glfs_open (glfs_t *fs, const char *path, int flags) __THROW;
+=end
+  attach_function :open, :glfs_open, [:pointer, :string, :int], :pointer
+
+=begin
+  SYNOPSIS
+
+  glfs_creat: Create a file.
+
+  DESCRIPTION
+
+  This function opens a file on a virtual mount.
+
+  PARAMETERS
+
+  @fs: The 'virtual mount' object to be initialized.
+
+  @path: Path of the file within the virtual mount.
+
+  @mode: Permission of the file to be created.
+
+  @flags: Create flags. See open(2). O_EXCL is supported.
+
+  RETURN VALUES
+
+  NULL   : Failure. @errno will be set with the type of failure.
+  Others : Pointer to the opened glfs_fd_t.
+
+  glfs_fd_t *glfs_creat (glfs_t *fs, const char *path, int flags,
+           mode_t mode) __THROW;
+=end
+  attach_function :creat, :glfs_creat, [:pointer, :string, :int, :int], :pointer
+
+=begin
+  int glfs_close (glfs_fd_t *fd) __THROW;
+=end
+  attach_function :close, :glfs_close, [:pointer], :int
+
+=begin
+  // glfs_{read,write}[_async]
+
+  ssize_t glfs_read (glfs_fd_t *fd, void *buf,
+                     size_t count, int flags) __THROW;
+  ssize_t glfs_write (glfs_fd_t *fd, const void *buf,
+                      size_t count, int flags) __THROW;
+  int glfs_read_async (glfs_fd_t *fd, void *buf, size_t count, int flags,
+           glfs_io_cbk fn, void *data) __THROW;
+  int glfs_write_async (glfs_fd_t *fd, const void *buf, size_t count, int flags,
+            glfs_io_cbk fn, void *data) __THROW;
+=end
+  attach_function :read, :glfs_read, [:pointer, :pointer, :uint, :int], :uint
+  attach_function :write, :glfs_write, [:pointer, :pointer, :uint, :int], :uint
+  # TODO async
+
+=begin
+  int glfs_mkdir (glfs_t *fs, const char *path, mode_t mode) __THROW;
+=end
+  attach_function :mkdir, :glfs_mkdir, [:pointer, :string, :int], :int
+
+=begin
+  int glfs_unlink (glfs_t *fs, const char *path) __THROW;
+=end
+  attach_function :unlink, :glfs_unlink, [:pointer, :string], :int
+
+=begin
+  int glfs_rmdir (glfs_t *fs, const char *path) __THROW;
+=end
+  attach_function :rmdir, :glfs_rmdir, [:pointer, :string], :int
+
+=begin
+  int glfs_rename (glfs_t *fs, const char *oldpath, const char *newpath) __THROW;
+=end
+  attach_function :rename, :glfs_rename, [:pointer, :string, :string], :int
+
+=begin
+  int glfs_lstat (glfs_t *fs, const char *path, struct stat *buf) __THROW;
+  int glfs_stat (glfs_t *fs, const char *path, struct stat *buf) __THROW;
+  int glfs_fstat (glfs_fd_t *fd, struct stat *buf) __THROW;
+=end
+  attach_function :lstat, :glfs_lstat, [:pointer, :string, :pointer], :int
+
+  # TODO the rest
+
+end

data/lib/glusterfs/client.rb

@@ -0,0 +1,13 @@
+class GlusterFS::Client
+  class << self
+    def mount(volume_name, host, port = 24007, protocol = 'tcp')
+      volume = GlusterFS::Volume.new(volume_name)
+      volume.mount(host, port, protocol)
+      volume
+    end
+
+    def unmount(volume)
+      GlusterFS.fini(volume.fs)
+    end
+  end
+end

data/lib/glusterfs/directory.rb

@@ -0,0 +1,2 @@
+class GlusterFS::Directory
+end

data/lib/glusterfs/error.rb

@@ -0,0 +1,2 @@
+class GlusterFS::Error < StandardError
+end

data/lib/glusterfs/file.rb

@@ -1,25 +1,70 @@
 require "tempfile"
 class GlusterFS::File
-  class << self
-    def read(fs, path, buf_size = 4092)
-      fd = GlusterFS.open(fs, path, 0)
-      temp = Tempfile.new(path.gsub('/', '-'))
-      buff = FFI::MemoryPointer.new(:char, buf_size)
-      res = 1
-      while res > 0
-        res = GlusterFS.read(fd, buff, buf_size, 0)
-        temp.write(buff.get_bytes(0, res)) if res > 0
-      end
-      GlusterFS.close(fd)
-      temp.rewind
-      temp
+  attr_reader :volume, :path
+  def initialize(volume, path)
+    @volume = volume
+    @path = path
+  end
+
+  def read_file(buf_size = 4092)
+    raise GlusterFS::Error, "File is empty or does not exist: #{@path}" if lstat[:st_size] < 1
+    fd = GlusterFS.open(@volume.fs, @path, 0)
+    temp = Tempfile.new(path.gsub('/', '-'))
+    buff = FFI::MemoryPointer.new(:char, buf_size)
+    res = 1
+    while res > 0
+      res = GlusterFS.read(fd, buff, buf_size, 0)
+      temp.write(buff.get_bytes(0, res)) if res > 0
     end
+    GlusterFS.close(fd)
+    temp.rewind
+    temp
+  end
 
-    def write(fs, path, file, perms = 0644)
-      fd = GlusterFS.creat(fs, path, 2, perms)
-      res = GlusterFS.write(fd, file.read, file.size, 0)
-      GlusterFS.close(fd)
-      res
+  def read(buf_size = 4092)
+    fd = GlusterFS.open(@volume.fs, @path, 0)
+    temp = ''
+    buff = FFI::MemoryPointer.new(:char, buf_size)
+    res = 1
+    lstat
+    while res > 0
+      res = GlusterFS.read(fd, buff, buf_size, 0)
+      temp << buff.get_bytes(0, res) if res > 0
     end
+    GlusterFS.close(fd)
+    temp
+  end
+
+  def write_file(file, perms = 0644)
+    fd = GlusterFS.creat(@volume.fs, path, 2, perms)
+    res = GlusterFS.write(fd, file.read, file.size, 0)
+    GlusterFS.close(fd)
+    res
+  end
+
+  def write(data, perms = 0644)
+    fd = GlusterFS.creat(@volume.fs, path, 2, perms)
+    res = GlusterFS.write(fd, data, data.size, 0)
+    GlusterFS.close(fd)
+    res
+  end
+
+  def unlink
+    GlusterFS.unlink(@volume.fs, @path)
+  end
+
+  def lstat
+    data = GlusterFS::Stat.new
+    GlusterFS.lstat(@volume.fs, @path, data)
+    data
+  end
+
+  def exists?
+    lstat[:st_blocks] > 0
+  end
+
+  def size
+    lstat[:st_size]
   end
+
 end

data/lib/glusterfs/stat.rb

@@ -0,0 +1,18 @@
+class GlusterFS::Stat < FFI::Struct
+  layout :st_dev,       :dev_t,
+         :st_ino,       :ino_t,
+         :st_nlink,     :nlink_t,
+         :st_mode,      :mode_t,
+         :st_uid,       :uid_t,
+         :st_gid,       :gid_t,
+         :st_rdev,      :dev_t,
+         :st_size,      :ulong,
+         :st_blksize,   :ulong,
+         :st_blocks,    :quad_t,
+         :st_atime,     :ulong,
+         :st_atimesec,  :ulong,
+         :st_mtime,     :ulong,
+         :st_mtimesec,  :ulong,
+         :st_ctime,     :ulong,
+         :st_ctimesec,  :ulong
+end

data/lib/glusterfs/version.rb

@@ -1,3 +1,3 @@
 module GlusterFS
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/glusterfs/volume.rb

@@ -0,0 +1,30 @@
+class GlusterFS::Volume
+  attr_reader :name, :fs, :mounted
+
+  def initialize(name)
+    @name = name
+    @fs = GlusterFS.new(@name)
+  end
+
+  def mount(host, port = 24007, protocol = 'tcp')
+    GlusterFS.set_volfile_server(@fs, protocol, host, port)
+    result = GlusterFS.init(@fs)
+    if result != 0
+      raise GlusterFS::Error,
+        "Failed to mount volume '#{volume_name}' on #{protocol}://#{host}:#{port}"
+    end
+    @mounted = true
+  end
+
+  def mounted?
+    @mounted
+  end
+
+  def unmount
+    if mounted?
+      GlusterFS.fini(@fs)
+      @mounted = false
+      true
+    end
+  end
+end

data/libgfapi-ruby.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "ffi", "~> 1.9"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rspec"
 end

data/spec/glusterfs/client_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+module GlusterFS
+  describe GlusterFS::Client do
+    it 'mounts volume' do
+      volume = GlusterFS::Client.mount(GFS_VOLUME, GFS_SERVER_HOST)
+      volume.name.should == GFS_VOLUME
+    end
+  end
+end

data/spec/glusterfs/file_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+module GlusterFS
+  describe File do
+    let(:volume) { Client.mount(GFS_VOLUME, GFS_SERVER_HOST) }
+    let(:file_name) { "test-#{Time.now.to_i}" }
+    let(:file) { File.new(volume, file_name) }
+    let(:data) { '123' }
+
+    after do
+      file.unlink
+      volume.unmount
+    end
+
+    context '#read' do
+      before { file.write(data) }
+      subject { file.read }
+      it { should == data }
+    end
+
+    context '#read_file' do
+      before { file.write(data) }
+      let(:result) { file.read_file }
+      specify 'result is correctly formed tempfile' do
+        result.should be_a Tempfile
+        result.read.should == data
+        result.close
+      end
+    end
+
+    context '#write' do
+      context 'writes file' do
+        subject { file.write(data) }
+        it('returns bytes written') { should == data.length }
+      end
+
+      context 'overwrites file' do
+        let(:file2) { File.new(volume, file_name) }
+        let(:data2) { '1234' }
+
+        before { file.write(data) }
+        after { file2.unlink }
+
+        subject { file2.write(data2) }
+        it('returns bytes written') { should == data2.length }
+      end
+    end
+
+    context '#write_file' do
+      let(:data) do
+        d = Tempfile.new('test')
+        d.write '12345'
+        d.rewind
+        d
+      end
+      after { data.close }
+
+      context 'writes file' do
+        subject { file.write_file(data) }
+        it('returns bytes written') { should == data.length }
+      end
+
+      context 'overwrites file' do
+        let(:file2) { File.new(volume, file_name) }
+        let(:data2) do
+          d = Tempfile.new('test2')
+          d.write '7890'
+          d.rewind
+          d
+        end
+
+        before { file.write_file(data) }
+        after do
+          file2.unlink
+          data2.close
+        end
+
+        subject { file2.write_file(data2) }
+        it('returns bytes written') { should == data2.length }
+      end
+    end
+
+    context '#unlink' do
+      before do
+        file.write(data)
+        file.unlink
+      end
+      subject { file.exists? }
+      it('deletes the file') { should_not be_true }
+    end
+
+    context '#exist?' do
+      context 'on existing file' do
+        before { file.write(data) }
+        subject { file.exists? }
+        it { should be_true }
+      end
+
+      context 'on non-existing file' do
+        subject { file.exists? }
+        it { should_not be_true }
+      end
+    end
+
+    context '#lstat' do
+      context 'on existing file' do
+        before { file.write(data) }
+        let(:lstat) { file.lstat }
+        specify 'lstat response is as expected' do
+          lstat[:st_dev].should_not == 0
+          lstat[:st_ino].should_not == 0
+          lstat[:st_nlink].should_not == 0
+          lstat[:st_mode].should_not == 0
+          lstat[:st_uid].should == 0
+          lstat[:st_gid].should == 0
+          lstat[:st_rdev].should == 0
+          lstat[:st_size].should == data.size
+          lstat[:st_blksize].should_not == 0
+          lstat[:st_blocks].should == 1
+          lstat[:st_atime].should_not == 0
+          lstat[:st_mtime].should_not == 0
+          lstat[:st_ctime].should_not == 0
+          lstat[:st_atimesec].should_not == 0
+          lstat[:st_mtimesec].should_not == 0
+          lstat[:st_ctimesec].should_not == 0
+        end
+      end
+
+      context 'on non-existing file' do
+        let(:lstat) { file.lstat }
+        specify 'lstat response is as expected' do
+          lstat[:st_dev].should == 0
+          lstat[:st_ino].should == 0
+          lstat[:st_nlink].should == 0
+          lstat[:st_mode].should == 0
+          lstat[:st_uid].should == 0
+          lstat[:st_gid].should == 0
+          lstat[:st_rdev].should == 0
+          lstat[:st_size].should == 0
+          lstat[:st_blksize].should == 0
+          lstat[:st_blocks].should == 0
+          lstat[:st_atime].should == 0
+          lstat[:st_mtime].should == 0
+          lstat[:st_ctime].should == 0
+          lstat[:st_atimesec].should == 0
+          lstat[:st_mtimesec].should == 0
+          lstat[:st_ctimesec].should == 0
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'glusterfs'
+require 'pry'
+require 'pry-nav'
+
+GFS_SERVER_HOST = '127.0.0.1'
+GFS_SERVER_PORT = 24007
+GFS_VOLUME = 'dist-volume'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libgfapi-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tomas Varaneckas
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby bindings for libgfapi (GlusterFS API)
 email:
 - tomas.varaneckas@gmail.com
@@ -65,9 +93,18 @@ files:
 - README.md
 - Rakefile
 - lib/glusterfs.rb
+- lib/glusterfs/bindings.rb
+- lib/glusterfs/client.rb
+- lib/glusterfs/directory.rb
+- lib/glusterfs/error.rb
 - lib/glusterfs/file.rb
+- lib/glusterfs/stat.rb
 - lib/glusterfs/version.rb
+- lib/glusterfs/volume.rb
 - libgfapi-ruby.gemspec
+- spec/glusterfs/client_spec.rb
+- spec/glusterfs/file_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/spajus/libgfapi-ruby
 licenses:
 - MIT
@@ -92,5 +129,8 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for libgfapi (GlusterFS API)
-test_files: []
+test_files:
+- spec/glusterfs/client_spec.rb
+- spec/glusterfs/file_spec.rb
+- spec/spec_helper.rb
 has_rdoc: