dia 1.0 → 1.1.pre

data/NEWS.md

@@ -0,0 +1,12 @@
+## NEWS
+
+### 1.1.pre
+
+* A person reported that ffi 0.6.0 does not work with dia ..  
+  Supplied an explicit dependency on ffi 0.5.4 until I figure it out.
+    
+* You can run a block of ruby under a sandbox now but I had to change the order of arguments in the constructer ..  
+  First argument is the profile, and (optionally) the second is the application path.  
+  If you're running a block of ruby, you can forget about the second.
+  
+* I documented my methods!

data/README.md

@@ -13,7 +13,7 @@
 ## How?
 FFI, and the C header "sandbox.h" (found on OSX).
 
-## Example?
+## Example 1 (Running an application under a sandbox)
 
     require 'rubygems'
     require 'dia'
@@ -22,13 +22,23 @@ FFI, and the C header "sandbox.h" (found on OSX).
     sandbox.run
     puts "Launched #{sandbox.app_path} with a pid of #{sandbox.pid} using the profile #{sandbox.profile}"
 
+## Example 2 (Running ruby under a sandbox)
+
+    require 'rubygems'
+    require 'dia'
+    require 'open-uri'
+    
+    sandbox = Dia::SandBox.new(Dia::Profiles::NO_OS_SERVICES)
+    sandbox.run_with_block do
+      open(URI.parse('http://www.google.com')).read
+      exit!
+    end
+    
 ## Install?
 
-Right now, the github repository is where you can install "Dia" from.  
-There is a "gemspec" in the root of the project.  
-    gem build *.gemspec; 
-    gem install *.gem 
-... after cloning the repository.
+It's on gemcutter.  
+
+    gem install dia
 
 ## License(MIT)
 

data/lib/dia/sandbox.rb

@@ -8,12 +8,23 @@ module Dia
     attr_accessor :profile
     attr_accessor :pid
     
-    def initialize app_path, profile
+    # @param  [Constant]     Profile      The profile to be used when creating a sandbox.
+    # @param  [String]       Application  The path to an application you want to sandbox. Optional.
+    # @return [Dia::SandBox] Returns an instance of Dia::SandBox
+    def initialize(profile = Dia::Profiles::NO_OS_SERVICES, app_path=nil)
       @app_path = app_path
       @profile = profile
     end
     
+    # The run method will spawn a child process and run the supplied application in a sandbox.
+    #  
+    # @raise  [ArgumentError]         Will raise an ArgumentError if an application has not been supplied to 
+    #                                 the constructer.
+    # @raise  [Dia::SandBoxException] Will raise Dia::SandBoxException if the sandbox could not be initiated.
+    # @return [Fixnum] The Process ID(PID) that the sandboxed application is being run under.
     def run
+      raise ArgumentError, "No application path supplied"  if @app_path.nil?
+      
       @pid = fork do
         unless ( ret = sandbox_init(@profile, 0x0001, error = FFI::MemoryPointer.new(:pointer)) ) == 0
           raise Dia::SandBoxException, "Couldn't sandbox #{@app_path}, sandbox_init returned #{ret} with error message: '#{error.get_pointer(0).read_string}'"
@@ -22,6 +33,24 @@ module Dia
       end
     end
   
+    # The run\_with\_block method will spawn a child process and run a supplied block of ruby code in a sandbox.
+    #
+    # It may raise any number of exceptions if the sandbox could be initiated ..  
+    # It depends on the restrictions of the sandbox and if the block actually violates a restriction imposed by 
+    # the sandbox .. In any case, the parent process will not be affected and if you want to catch an exception you
+    # should do so in your block.
+    #
+    # @raise  [Dia::SandBoxException] Will raise Dia::SandBoxException if the sandbox could not be initiated. 
+    # @return [Fixnum] The Process ID(PID) that the sandboxed block of code is being run under.
+    def run_with_block &blk
+      @pid = fork do
+         unless ( ret = sandbox_init(@profile, 0x0001, error = FFI::MemoryPointer.new(:pointer)) ) == 0
+           raise Dia::SandBoxException, "Couldn't sandbox #{@app_path}, sandbox_init returned #{ret} with error message: '#{error.get_pointer(0).read_string}'"
+         end
+         yield
+      end
+    end
+    
   end
   
 end

data/lib/dia.rb

@@ -1,3 +1,4 @@
+gem 'ffi', '=0.5.4'
 require 'ffi'
 require File.join(File.dirname(__FILE__), 'dia/profiles.rb')
 require File.join(File.dirname(__FILE__), 'dia/commonapi.rb')

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: dia
 version: !ruby/object:Gem::Version 
-  version: "1.0"
+  version: 1.1.pre
 platform: ruby
 authors: 
-- Robert
-- Gleeson
+- Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-31 00:00:00 +00:00
+date: 2010-02-12 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,9 +18,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.5.4
     version: 
 description: Dia allows you to sandbox applications on the OSX platform
 email: rob@flowof.info
@@ -32,6 +31,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- NEWS.md
 - README.md
 - lib/dia/commonapi.rb
 - lib/dia/profiles.rb
@@ -41,7 +41,19 @@ has_rdoc: true
 homepage: 
 licenses: []
 
-post_install_message: 
+post_install_message: " Dia\n\
+  -----\n\
+  Thanks for taking the time to try out the prereleae of Dia 1.1\n\n\
+  For people who had problems with Dia and FFI 0.6.0, I have added an explicit \n\
+  dependency on 0.5.4 ..\n\n\
+  Slight API changes alter the way Dia behaves .. \n\
+  The change is minor, but worth noting because it breaks code written for 1.0\n\n\
+  For more information: \n\
+  http://github.com/robgleeson/Dia/blob/experimental/NEWS.md\n\
+  http://github.com/robgleeson/Dia/blob/experimental/README.md\n\n\
+  Please report bugs if you find any! \n\
+  http://github.com/robgleeson/dia/issues\n\n\
+  Rob\n"
 rdoc_options: []
 
 require_paths: 
@@ -54,9 +66,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      version: "0"
+      version: 1.3.1
   version: 
 requirements: []