ipfs-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5f308798c9180262f9aa758b6010b910142a0d9
-  data.tar.gz: 13fde3fde504683f14df8e5d891d5291ac3624ba
+  metadata.gz: 32a495dceb347f115f780d7356734ebe1fc5b55b
+  data.tar.gz: 2343699171c0f73806649cfbf4b7e23e25255164
 SHA512:
-  metadata.gz: 9932b1d74862af972ded69d873a42b719b3be8dbbd8cc2977106e746b87282d0eb84efa97f9e288b60e13ef04290b1d42eead4cdaf4f88b072b88420e7a264c6
-  data.tar.gz: e0ddc8dd3188cdce71cb4f64f738f71fc33f78d92521b03c154d6b861d427bffc77230cfa77f42111bf5154d21a803635321e496a0dbaad12b66f186851bedc9
+  metadata.gz: 71434462b2967da13a0c311bdfc3344e60460aebf60b1e690291789bad53fe73b20bf699fa8bba816b225cd95632746b65081699d11bd4c9d8b6858133909627
+  data.tar.gz: d5d72049af5af1d706eba6bfee86d53f3e1950a7016531bc7ee793ff478a6d9dde28ab672eb6588e3a13fe23822885ab0a66568ee17d6ba2e22aa24daf0e3b2a

data/README.md

@@ -31,6 +31,19 @@ ipfs = IPFS::Connection.new
 ipfs.add Dir.new('data')
 ```
 
+Afterwards, we can retrieve what we put in.
+```ruby
+require 'ipfs-api'
+
+ipfs = IPFS::Connection.new
+
+# retrieve contents of a file
+print ipfs.cat('QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG')
+
+# retrieve the whole directory
+ipfs.get('QmSh4Xjoy16v6XmnREE1yCrPM1dnizZc2h6LfrqXsnbBV7', 'copy-of-data')
+```
+
 ## Advanced
 
 Dynamically add folders and files to *IPFS*, without creating them

data/Rakefile

@@ -11,7 +11,7 @@ PKG_NAME = 'ipfs-api'
 PKG_VERSION = IPFS::VERSION
 AUTHORS = ['Holger Joest']
 EMAIL = 'holger@joest.org'
-HOMEPAGE = 'http://ruby-ipfs-api.github.io'
+HOMEPAGE = 'http://hjoest.github.io/ruby-ipfs-api'
 SUMMARY = 'Interplanetary File System for Ruby'
 DESCRIPTION = 'This is a client library to access the IPFS from Ruby'
 RDOC_OPTIONS = [ '--title', SUMMARY, '--quiet', '--main', 'lib/ipfs-api.rb' ]
@@ -32,7 +32,7 @@ RDoc::Task.new do |rd|
   rd.options = RDOC_OPTIONS
 end
 
-CLEAN.include [ "*.gem*", "pkg", "rdoc" ]
+CLEAN.include [ "*.gem*", "pkg", "rdoc", "test/tmp" ]
 
 spec = Gem::Specification.new do |s|
   s.name = PKG_NAME

data/examples/basic.rb

@@ -1,4 +1,12 @@
 require 'ipfs-api'
 
 ipfs = IPFS::Connection.new
+
+# add a directory
 ipfs.add Dir.new('data')
+
+# retrieve contents of a file
+print ipfs.cat('QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG')
+
+# retrieve the whole directory
+ipfs.get('QmSh4Xjoy16v6XmnREE1yCrPM1dnizZc2h6LfrqXsnbBV7', 'copy-of-data')

data/ipfs-api.gemspec

@@ -30,9 +30,9 @@ Gem::Specification.new do |s|
  "test/test_cmd_name.rb",
  "test/test_io.rb",
  "test/test_upload.rb"]
-  s.full_name = "ipfs-api-0.1.0"
+  s.full_name = "ipfs-api-0.2.0"
   s.has_rdoc = true
-  s.homepage = "http://ruby-ipfs-api.github.io"
+  s.homepage = "http://hjoest.github.io/ruby-ipfs-api"
   s.licenses = ["MIT"]
   s.name = "ipfs-api"
   s.platform = "ruby"
@@ -44,5 +44,5 @@ Gem::Specification.new do |s|
   s.rubygems_version = "2.4.8"
   s.specification_version = 4
   s.summary = "Interplanetary File System for Ruby"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 end

data/lib/ipfs-api.rb

@@ -1,6 +1,6 @@
 # =IPFS4R - Interplanetary Filesystem Library for Ruby
 # License:: MIT (see the LICENSE file)
-# Website:: https://ruby-ipfs-api.github.io
+# Website:: https://hjoest.github.io/ruby-ipfs-api
 #
 # ==Introduction
 #

data/lib/ipfs-api/connection.rb

@@ -81,13 +81,18 @@ Content-Type: application/octet-stream\r\n\
       result
     end
 
-    # FIXME: provides only raw response yet
-    def get path
-      result = ''
-      post("get?arg=#{CGI.escape(path)}") do |chunk|
-        result << chunk
+    def get path, destination = nil
+      stream = IO::ReadFromWriterIO.new do |buf|
+        post("get?arg=#{CGI.escape(path)}") do |chunk|
+          buf << chunk
+        end
+        buf.close
+      end
+      if destination.nil?
+        return stream
+      else
+        return IO::Tar.extract(stream, destination)
       end
-      result
     end
 
     def id
@@ -137,9 +142,13 @@ Content-Type: application/octet-stream\r\n\
         @connection = connection
       end
 
-      def resolve
+      def resolve id = nil
         @connection.instance_exec(self) do
-          JSON.parse(post('name/resolve').body)['Path']
+          if id
+            JSON.parse(post("name/resolve?arg=#{CGI.escape(id)}").body)['Path']
+          else
+            JSON.parse(post('name/resolve').body)['Path']
+          end
         end
       end
 

data/lib/ipfs-api/io.rb

@@ -1,4 +1,5 @@
 require 'stringio'
+require 'rubygems/package'
 
 module IPFS; end
 module IPFS::IO # :nodoc:
@@ -8,31 +9,84 @@ module IPFS::IO # :nodoc:
     def initialize &block
       @block = block
       @stream = StringIO.new
+      @d = @p = 0
+      @eof = false
       fetch_data
     end
 
     def read length = nil, outbuf = ''
-      return nil if @stream.size == 0
+      return '' if length == 0
       outbuf.slice!(length..-1) if !length.nil?
       q = 0
       while @stream.size > 0
         s = @stream.size - @p
         s = [length - q, s].min if !length.nil?
         outbuf[q, s] = @stream.string[@p, s]
-        @p += s
-        q += s
-        break if q == length
+        @p, q = @p + s, q + s
+        @eof = true if length.nil? and @p > 0 and @p == q
+        break if q == length or @eof
         fetch_data if @stream.size == @p
       end
+      if length.nil? || outbuf.size < length
+        @eof = true
+      end
+      if q == 0 and not length.nil?
+        outbuf = nil
+      end
       outbuf
     end
 
+    def pos
+      @d + @p
+    end
+
+    def eof?
+      @eof
+    end
+
     private
-      def fetch_data
-        @p = 0
-        @stream.string = ""
-        @block.call @stream if not @stream.closed?
+    def fetch_data
+      @p, @d = 0, @d + @p
+      @stream.string = ''
+      @block.call @stream if not @stream.closed?
+    end
+
+  end
+
+  module Tar
+
+    def extract stream, destination
+      Gem::Package::TarReader.new(stream) do |tar|
+        path = nil
+        tar.each do |entry|
+          if entry.full_name == '././@LongLink'
+            path = File.join(destination, entry.read.strip)
+            next
+          end
+          path ||= File.join(destination, entry.full_name)
+          if entry.directory?
+            if File.exist?(path) and not File.directory?(path)
+              raise IOError.new("Not a directory: #{path}")
+            end
+            FileUtils.mkdir_p path, :mode => entry.header.mode, :verbose => false
+          elsif entry.file?
+            if File.exist?(path) and not File.file?(path)
+              raise IOError.new("Not a file: #{path}")
+            end
+            File.open path, "wb" do |fd|
+              while (chunk = entry.read(1024))
+                fd.write chunk
+              end
+            end
+            FileUtils.chmod entry.header.mode, path, :verbose => false
+          end
+          path = nil
+        end
       end
+      true
+    end
+
+    module_function :extract
 
   end
 

data/lib/ipfs-api/version.rb

@@ -1,4 +1,4 @@
 module IPFS
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end
 

data/test/common.rb

@@ -1,4 +1,9 @@
+gem 'minitest' if RUBY_VERSION =~ /^1\.9/
 require 'minitest/autorun'
-require 'byebug'
+if ENV['DEBUG']
+  require 'byebug'
+else
+  def byebug; end
+end
 
 $:.unshift File.expand_path('../../lib', __FILE__)

data/test/samples.rb

@@ -4,6 +4,8 @@ require 'ipfs-api/upload'
 
 module Samples
 
+  TEMP_DIR_PREFIX = 'ruby-ipfs-api-unit-test-'
+
   include IPFS
 
   def some_virtual_folders
@@ -61,7 +63,7 @@ module Samples
   module_function :some_virtual_folders
 
   def some_filesystem_folders
-    Dir.mktmpdir('ruby-ipfs-api-unit-test-') do |root|
+    Dir.mktmpdir(TEMP_DIR_PREFIX) do |root|
       a1 = File.join(root, 'a1')
       Dir.mkdir(a1, 0755)
       b1 = File.join(a1, 'b1')
@@ -81,4 +83,10 @@ module Samples
   end
   module_function :some_filesystem_folders
 
+  def some_byte_sequences
+    s = ('a'..'z').to_a.join
+    [ s ] * 17
+  end
+  module_function :some_byte_sequences
+
 end

data/test/test_cmd_get.rb

@@ -7,12 +7,34 @@ include IPFS
 
 class CommandGetTest < Minitest::Test
 
-  def test_get
+  def test_get_as_tar_stream
     ipfs = Connection.new
     Samples.some_virtual_folders do |fixture, expectation|
       ipfs.add fixture
-      # FIXME: provides only raw response yet
-      actual = ipfs.get('QmedYJNEKn656faSHaMv5UFVkgfSzwYf9u4zsYoXqgvnch')
+      hash = 'QmedYJNEKn656faSHaMv5UFVkgfSzwYf9u4zsYoXqgvnch'
+      stream = ipfs.get(hash)
+      tar = stream.read
+      # take some samples of the TAR archive
+      assert_equal 3072, tar.length
+      [ 0x101, 0x301, 0x501 ].each do |seek|
+        assert_equal 'ustar', tar[seek..seek+4]
+      end
+      [ 0x0, 0x200, 0x400 ].each do |seek|
+        assert_equal hash, tar[seek..seek+45]
+      end
+    end
+  end
+
+  def test_get_and_extract
+    ipfs = Connection.new
+    Samples.some_virtual_folders do |fixture, expectation|
+      ipfs.add fixture
+      hash = 'QmedYJNEKn656faSHaMv5UFVkgfSzwYf9u4zsYoXqgvnch'
+      Dir.mktmpdir(Samples::TEMP_DIR_PREFIX) do |target|
+        ipfs.get hash, target
+        actual = File.read(File.join(target, hash, 'b1/hello.txt'))
+        assert_equal "Hello World!\n", actual
+      end
     end
   end
 

data/test/test_cmd_name.rb

@@ -13,4 +13,10 @@ class CommandNameTest < Minitest::Test
     assert resolved.start_with?('/ipfs/Qm')
   end
 
+  def test_name_resolve_with_id
+    ipfs = Connection.new
+    resolved = ipfs.name.resolve('ipfs.io')
+    assert resolved.start_with?('/ipfs/Qm')
+  end
+
 end

data/test/test_io.rb

@@ -7,14 +7,66 @@ include IPFS::IO
 
 class ReadFromWriterIOTest < Minitest::Test
 
-  def test_read_write_io
-    msg = ('a'..'z').to_a.join
-    reader = ReadFromWriterIO.new do |writer|
-      writer << msg
-      writer.close
+  def setup
+    @parts = Samples.some_byte_sequences
+    enum = @parts.each
+    @reader = ReadFromWriterIO.new do |writer|
+      begin
+        writer << enum.next
+      rescue StopIteration
+        writer.close
+      end
     end
-    result = reader.read
-    assert_equal msg, result
+  end
+
+  def test_read_byte_wise
+    result = ''
+    while (byte = @reader.read(1))
+      result << byte
+      assert_equal result.size, @reader.pos
+      assert_not_eof @reader
+    end
+    assert_eof @reader
+    assert_equal @parts.join, result
+  end
+
+  def test_read_larger_chunks
+    result = ''
+    while (chunk = @reader.read(199))
+      result << chunk
+      assert_equal result.size, @reader.pos
+      if chunk.size < 199
+        assert_eof @reader
+      else
+        assert_not_eof @reader
+      end
+    end
+    assert_eof @reader
+    assert_equal @parts.join, result
+  end
+
+  def test_different_variants_of_read
+    chunk = @reader.read(199)
+    assert_equal 199, chunk.size
+    assert_not_eof @reader
+    chunk = @reader.read(0)
+    assert_equal 0, chunk.size
+    assert_not_eof @reader
+    chunk = @reader.read
+    assert_equal 243, chunk.size
+    assert_eof @reader
+    chunk = @reader.read
+    assert_equal 0, chunk.size
+    assert_eof @reader
+  end
+
+  private
+  def assert_eof stream
+    assert stream.eof?, "Stream should have reached end-of-file"
+  end
+
+  def assert_not_eof stream
+    assert !stream.eof?, "Stream should not yet have reached end-of-file"
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipfs-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Holger Joest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-10 00:00:00.000000000 Z
+date: 2016-01-03 00:00:00.000000000 Z
 dependencies: []
 description: This is a client library to access the IPFS from Ruby
 email: holger@joest.org
@@ -40,7 +40,7 @@ files:
 - test/test_cmd_name.rb
 - test/test_io.rb
 - test/test_upload.rb
-homepage: http://ruby-ipfs-api.github.io
+homepage: http://hjoest.github.io/ruby-ipfs-api
 licenses:
 - MIT
 metadata: {}