io-afc 0.0.3.2

data/lib/io/afc.rb

@@ -0,0 +1,115 @@
+require 'io/afc/version'
+require 'io/afc/afc_base'
+require 'io/afc/file'
+
+class IO
+class AFC < AFCBase
+private
+  def dict_to_hash(dict)
+    v = nil
+    dict.inject({}){|s, k|
+      unless v
+        v = k
+      else
+        v = v.to_i if v=~/^\d+$/
+        s[k.to_sym] = v
+        v = nil
+      end
+      s
+    }
+  end
+
+public
+
+  ##
+  # Connect to iOS-Device and yield block with handle if specified.
+  # @option [:uuid=>String] Target UUID. if nil, connect to default device.
+  # @option [:appid=>String] Mount application document folder if specified.
+  # @return [IO::AFC or block-result]
+  def self.connect(opt={}, &block)
+    dev = self.new(opt[:udid], opt[:appid])
+    return dev unless block_given?
+
+    begin
+      r = yield(dev)
+      dev.close
+    rescue Exception=>e
+      dev.close
+      throw e
+    end
+    r
+  end
+
+  ##
+  # Get storage info.
+  # @return [Hash]
+  #
+  # Example:
+  # afc.statfs
+  # => {:FSBlockSize=>4096,
+  # :FSFreeBytes=>27478216704,
+  # :FSTotalBytes=>30178787328,
+  # :Model=>"iPod5,1"}
+  def statfs
+    dict_to_hash(super)
+  end
+
+  ##
+  # Open file.
+  # @param [String] path for target file.
+  # @param [IO::Constants] mode for open mode. Default is IO::RDONLY.
+  def open(path, mode = IO::RDONLY, &block)
+    raise ArgumentError, "block is required." unless block_given?
+    File.open_file(self, path, mode, &block)
+  end
+
+  ##
+  # Get file/directory attribytes.
+  # @param [String] path.
+  # @return [Hash]
+  #
+  # Example:
+  # afc.getattr("/Safari")
+  # => {:st_birthtime=>2012-12-17 12:28:23 +0900,
+  # :st_mtime=>2013-06-22 20:32:01 +0900
+  # :st_ifmt=>"S_IFDIR",
+  # :st_nlink=>2,
+  # :st_blocks=>0,
+  # :st_size=>102}
+  #
+  # afc.getattr("/Safari/goog-phish-shavar.db")
+  # => {:st_birthtime=>2013-06-21 02:31:17 +0900,
+  # :st_mtime=>2013-06-21 02:31:18 +0900,
+  # :st_ifmt=>"S_IFREG",
+  # :st_nlink=>1,
+  # :st_blocks=>11256,
+  # :st_size=>5763072}
+  def getattr(path)
+    r = dict_to_hash(super(path))
+    [:st_birthtime, :st_mtime].each{|k|
+      r[k] = Time.at(r[k] / 1000000000.0)
+    }
+    r
+  end
+
+  ##
+  # Check exist
+  # @param [String] path.
+  # @return [String or nil] return type or nil.
+  def exist?(path)
+    begin
+      getattr(path)[:st_ifmt]
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+
+  ##
+  # Read symlink.
+  # @param [String] path.
+  # @return [String or nil] return symlink-target.
+  def readlink(path)
+    getattr(path)[:LinkTarget]
+  end
+end
+end

data/spec/afc_file_spec.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH << "./ext"
+$LOAD_PATH << "./lib"
+require 'spec_helper'
+require 'io/afc'
+
+
+describe IO::AFC::File do
+  before do
+    @afc = IO::AFC.connect
+  end
+
+  context "method: open, " do
+    it "should require block." do
+      expect{ @afc.open("/") }.to raise_error(ArgumentError)
+    end
+
+    it "should be open '/'" do
+      r = @afc.open("/"){|f|
+            expect(f).to be_an_instance_of(IO::AFC::File)
+            expect(f.closed?).to eq(false)
+            f
+          }
+      expect(r).to be_an_instance_of(IO::AFC::File)
+      expect(r.closed?).to eq(true)
+    end
+
+    it "should be create file and write." do
+      @afc.open("/tempfile", IO::RDWR){|f|
+        expect(f).to be_an_instance_of(IO::AFC::File)
+        expect(f.write("Hello")).to eq(5)
+      }
+    end
+  end
+
+  after do
+    @afc.unlink("/tempfile") rescue nil
+    @afc.close
+  end
+end

data/spec/afc_spec.rb

@@ -0,0 +1,87 @@
+$LOAD_PATH << "./ext"
+$LOAD_PATH << "./lib"
+require 'spec_helper'
+require 'io/afc'
+
+
+describe IO::AFC do
+  it "should be connect." do
+    r = IO::AFC.connect{|afc|
+          expect(afc).to be_an_instance_of(IO::AFC)
+          expect(afc.closed?).to eq(false)
+          afc
+        }
+    expect(r).to be_an_instance_of(IO::AFC)
+    expect(r.closed?).to eq(true)
+  end
+
+  it "should be connect without block." do
+    afc = IO::AFC.connect
+    expect(afc).to be_an_instance_of(IO::AFC)
+    expect(afc.closed?).to eq(false)
+    expect(afc.close).to be_nil
+    expect(afc.closed?).to eq(true)
+  end
+
+
+  context "test for storage methods, " do
+    before do
+      @afc = IO::AFC.connect
+    end
+
+    it "should be mkdir and unlink." do
+      expect(@afc.mkdir("/tempdir")).to be_true
+      expect(@afc.unlink("/tempdir")).to be_true
+    end
+
+    it "should be getattr for directory." do
+      attr = @afc.getattr("/Safari")
+      expect(attr).to be_an_instance_of(Hash)
+      expect(attr[:st_birthtime]).to be_an_instance_of(Time)
+      expect(attr[:st_mtime]).to be_an_instance_of(Time)
+      expect(attr[:st_ifmt]).to eq("S_IFDIR")
+    end
+
+    context "with tempdir, " do
+      before do
+        make_directory("/tempdir")
+        @now = Time.now
+      end
+
+      it "should be getattr for directory (Time)." do
+        attr = @afc.getattr("/tempdir")
+        expect(attr[:st_birthtime].to_i).to be_within(@now.to_i+10).of(@now.to_i-10)
+        expect(attr[:st_mtime].to_i).to be_within(@now.to_i+10).of(@now.to_i+10)
+      end
+
+      it "should be mkdir, rename and unlink subdir." do
+        expect(@afc.mkdir("/tempdir/subdir")).to be_true
+        expect(@afc.rename("/tempdir/subdir", "/tempdir/subdir-2")).to be_true
+        expect(@afc.unlink("/tempdir/subdir-2")).to be_true
+      end
+
+      it "should be symlink, readlink and unlink." do
+        expect(@afc.symlink("subdir", "/tempdir/subdir-2")).to be_true
+        expect(@afc.readlink("/tempdir/subdir-2")).to eq("subdir")
+        expect(@afc.unlink("/tempdir/subdir-2")).to be_true
+      end
+
+      it "should be nil if readlink to not a link." do
+        expect(@afc.readlink("/tempdir")).to be_nil
+      end
+
+      it "should be check exists." do
+        expect(@afc.exist?("/tempdir")).to be_an_instance_of(String)
+        expect(@afc.exist?("/tempdir-not-exist")).to be_nil
+      end
+
+      after do
+        remove_directory("/tempdir")
+      end
+    end
+
+    after do
+      @afc.close
+    end
+  end
+end

data/spec/basicio_filectrl_spec.rb

@@ -0,0 +1,50 @@
+$LOAD_PATH << "./ext"
+require 'io/afc/afc_base'
+require 'spec_helper'
+
+
+describe IO::AFCBase do
+  context "Basic storage I/O, " do
+    context "File control, " do
+      before do
+        @afc = IO::AFCBase.new(nil, nil)
+        f = IO::AFCBase::Descriptor.new(@afc, "/tempfile", 2)
+        begin
+          f.write("hello")
+        ensure
+          f.close
+        end
+      end
+
+      it "should be utimens." do
+        t = Time.now - 200000000
+        expect(@afc.utimens("/tempfile", t)).to be_true
+        stat = dict_to_hash(@afc.getattr("/tempfile"))
+        expect(stat["st_mtime"].to_i).to eq(t.to_i*1000_000_000)
+      end
+
+      it "should be get file size." do
+        stat = dict_to_hash(@afc.getattr("/tempfile"))
+        expect(stat["st_size"].to_i).to eq(5)
+      end
+
+      it "should be truncate." do
+        expect(@afc.truncate("/tempfile", 1)).to be_true
+        stat = dict_to_hash(@afc.getattr("/tempfile"))
+        expect(stat["st_size"].to_i).to eq(1)
+      end
+
+      it "should be create hardlink." do
+        expect(@afc.link("/tempfile", "/tempfile-2")).to be_true
+        expect(@afc.readdir("/")).to be_include("tempfile-2")
+      end
+
+      after do
+        %w{/tempfile /tempfile-2}.each{|p|
+          @afc.unlink(p) rescue nil
+        }
+        @afc.close
+      end
+    end
+  end
+end

data/spec/basicio_fileio_spec.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH << "./ext"
+require 'io/afc/afc_base'
+require 'spec_helper'
+
+
+describe IO::AFCBase do
+  context "Basic storage I/O, " do
+    context "File IO, " do
+      before do
+        @afc = IO::AFCBase.new(nil, nil)
+      end
+
+      it "should be create file and close." do
+        f = IO::AFCBase::Descriptor.new(@afc, "/tempfile", 2)
+        begin
+          expect(f).to be_an_instance_of(IO::AFCBase::Descriptor)
+          expect(f.closed?).to eq(false)
+          expect(f.write("hello")).to eq(5)
+        ensure
+          expect(f.close).to be_nil
+          expect(f.closed?).to eq(true)
+        end
+
+        f = IO::AFCBase::Descriptor.new(@afc, "/tempfile", 0)
+        begin
+          expect(f.read(-1)).to eq("hello")
+          expect(f.tell).to eq(5)
+          expect(f.seek(0, IO::SEEK_SET)).to be_true
+          expect(f.tell).to eq(0)
+        ensure
+          f.close
+        end
+
+        f = IO::AFCBase::Descriptor.new(@afc, "/tempfile", 2)
+        begin
+          expect(f.ftruncate(2)).to be_true
+        ensure
+          f.close
+        end
+        info = @afc.getattr("/tempfile")
+        size = info[info.find_index("st_size")-1].to_i
+        expect(size).to eq(2)
+      end
+
+      it "should be write 0 bytes when data is nil." do
+        f = IO::AFCBase::Descriptor.new(@afc, "/tempfile", 2)
+        begin
+          expect(f.write(nil)).to eq(0)
+        ensure
+          f.close
+        end
+      end
+
+      after do
+        @afc.unlink("/tempfile") rescue nil
+        @afc.close
+      end
+    end
+  end
+end

data/spec/basicio_spec.rb

@@ -0,0 +1,79 @@
+$LOAD_PATH << "./ext"
+require 'spec_helper'
+require 'io/afc/afc_base'
+
+
+describe IO::AFCBase do
+  context "Basic storage I/O, " do
+    it "should be connect device." do
+      expect(IO::AFCBase.new(nil, nil)).to be_an_instance_of(IO::AFCBase)
+    end
+
+    it "should be close." do
+       afc = IO::AFCBase.new(nil, nil)
+       expect(afc.closed?).to eq(false)
+       expect(afc.close).to be_nil
+       expect(afc.closed?).to eq(true)
+    end
+
+    context "After connect, " do
+      before do
+         @afc = IO::AFCBase.new(nil, nil)
+      end
+
+      it "should be get attributes." do
+        attr = @afc.getattr("/")
+        expect(attr).to be_an_instance_of(Array)
+      end
+
+      it "should be readdir." do
+        dirs = @afc.readdir("/")
+        expect(dirs).to be_an_instance_of(Array)
+      end
+
+      it "should be get statfs." do
+        stat = @afc.statfs
+        expect(stat).to be_an_instance_of(Array)
+      end
+
+      it "should be make a directory, rename, and unlink." do
+        expect(@afc.mkdir("/tmp")).to be_true
+        expect(@afc.rename("/tmp", "/temp")).to be_true
+        expect(@afc.unlink("/temp")).to be_true
+      end
+
+      it "should be crerate a symlink." do
+        expect(@afc.symlink("hello", "/tempfile-2")).to be_true
+        expect(@afc.readdir("/")).to be_include("tempfile-2")
+        stat = dict_to_hash(@afc.getattr("/tempfile-2"))
+        expect(stat["LinkTarget"]).to eq("hello")
+      end
+
+      it "should be get device udid." do
+        expect(@afc.device_udid).to be_an_instance_of(String)
+      end
+
+      it "should be get device display name." do
+        expect(@afc.device_display_name).to be_an_instance_of(String)
+      end
+
+      it "should be get application list." do
+        apps = @afc.applications
+        expect(apps).to be_an_instance_of(Hash)
+        apps.each{|app, val|
+          expect(app).to be_an_instance_of(String)
+          expect(val).to be_an_instance_of(Hash)
+          expect(val["CFBundleDisplayName"]).to be_an_instance_of(String)
+          expect([true, false]).to include(val["UIFileSharingEnabled"])
+        }
+      end
+
+      after do
+        %w{/tempfile /tempfile-2 /tmp /temp}.each{|p|
+          @afc.unlink(p) rescue nil
+        }
+        @afc.close
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require 'thread'
+require 'pry-nav'
+
+puts Process.pid
+#binding.pry
+
+
+def dict_to_hash(dict)
+  v = nil
+  h = {}
+  dict.each_index{|n|
+    case n%2
+    when 0
+      v = dict[n]
+    when 1
+      k = dict[n]
+      h[k] = v
+    end
+  }
+  h
+end
+
+
+$mutex = Mutex.new
+$dirs = {}
+def make_directory(path)
+  $mutex.synchronize{
+    unless $dirs[path]
+      IO::AFC.connect{|afc|
+        afc.mkdir(path)
+      }
+      $dirs[path] = 0
+    end
+    $dirs[path] += 1
+  }
+end
+
+def remove_directory(path)
+  $mutex.synchronize{
+    $dirs[path] -= 1
+    if $dirs[path] == 0
+      IO::AFC.connect{|afc|
+        afc.unlink(path)
+        $dirs.delete(path)
+      }
+    end
+  }
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: io-afc
+version: !ruby/object:Gem::Version
+  version: 0.0.3.2
+  prerelease: 
+platform: ruby
+authors:
+- Toshiyuki Suzumura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Access to the file system of iOS devices from Ruby.
+email:
+- suz.labo@amail.plala.or.jp
+executables: []
+extensions:
+- ext/io/afc/extconf.rb
+extra_rdoc_files: []
+files:
+- ext/io/afc/build.xcconfig
+- ext/io/afc/extconf.rb
+- ext/io/afc/ioafc.cpp
+- ext/io/afc/ioafc.h
+- ext/io/afc/ruby_wrapper.h
+- Gemfile
+- Gemfile.lock
+- io-afc.gemspec
+- io-afc.xcodeproj/project.pbxproj
+- lib/io/afc/file.rb
+- lib/io/afc/version.rb
+- lib/io/afc.rb
+- LICENSE.txt
+- pkg/io-afc-0.0.3.1.gem
+- pkg/io-afc-0.0.3.2.gem
+- Rakefile
+- README.md
+- spec/afc_file_spec.rb
+- spec/afc_spec.rb
+- spec/basicio_filectrl_spec.rb
+- spec/basicio_fileio_spec.rb
+- spec/basicio_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/suzumura-ss/ruby-io-afc
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 378568250842512408
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 378568250842512408
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Access to the file system of iOS devices from Ruby. Required 'libimobiledevice'.
+test_files:
+- spec/afc_file_spec.rb
+- spec/afc_spec.rb
+- spec/basicio_filectrl_spec.rb
+- spec/basicio_fileio_spec.rb
+- spec/basicio_spec.rb
+- spec/spec_helper.rb