ipfs-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32a495dceb347f115f780d7356734ebe1fc5b55b
-  data.tar.gz: 2343699171c0f73806649cfbf4b7e23e25255164
+  metadata.gz: 6b33b926a8240b157a5cfa1e14d35093d0f9a4ed
+  data.tar.gz: '0596fee2ce4d0a8a20226a1dbacb8bd47bdaf348'
 SHA512:
-  metadata.gz: 71434462b2967da13a0c311bdfc3344e60460aebf60b1e690291789bad53fe73b20bf699fa8bba816b225cd95632746b65081699d11bd4c9d8b6858133909627
-  data.tar.gz: d5d72049af5af1d706eba6bfee86d53f3e1950a7016531bc7ee793ff478a6d9dde28ab672eb6588e3a13fe23822885ab0a66568ee17d6ba2e22aa24daf0e3b2a
+  metadata.gz: 2723b6ec115c399d23c4fb0cc3fd4af506fcc83a3d2675a58f42139b755ef012563cb4bd4f81e34c6f2693016334548fa94bf819816f4ca5576a8314f329c074
+  data.tar.gz: 2849a2ef6807c906c622cd869b16a527b18965d433c9e0e9d5515e2c054d7aa8e653fcc0ac65b1d73e3e40bc96723bbbca8dfbd2df29c9df6841be18333ed28a

data/README.md

@@ -1,71 +1,66 @@
 # Overview
 
-IPFS4R is a client library to access the [Interplanetary Filesystem (IPFS)](https://ipfs.io) from Ruby.
+IPFS-API for Ruby is a client library to access the [Interplanetary Filesystem (IPFS)](https://ipfs.io) from Ruby.
 
 You can find more examples in the
 [examples directory](https://github.com/hjoest/ruby-ipfs-api/tree/master/examples).
 
 ## Installation
 
-Use ``gem`` to install it
+You need an [IPFS daemon](https://ipfs.io/docs/install/) running
 
-```bash
-gem install ipfs-api
-```
+    ipfs daemon
+
+To install this gem, run
+
+    gem install ipfs-api
 
 or simply add this line to your ``Gemfile``
 
-```ruby
-gem 'ipfs-api', '~> 0.1.0'
-```
+    gem 'ipfs-api', '~> 0.3.0'
 
 ## Basic examples
 
 This example will add a directory to *IPFS*. The directory ``data``
 must exist or otherwise an ``Errno::ENOENT`` error will be raised.
 
-```ruby
-require 'ipfs-api'
+    require 'ipfs-api'
 
-ipfs = IPFS::Connection.new
-ipfs.add Dir.new('data')
-```
+    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
+    require 'ipfs-api'
+
+    ipfs = IPFS::Connection.new
 
-# retrieve contents of a file
-print ipfs.cat('QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG')
+    # retrieve contents of a file
+    print ipfs.cat('QmfM2r8seH2GiRaC4esTjeraXEachRt8ZsSeGaWTPLyMoG')
 
-# retrieve the whole directory
-ipfs.get('QmSh4Xjoy16v6XmnREE1yCrPM1dnizZc2h6LfrqXsnbBV7', 'copy-of-data')
-```
+    # retrieve the whole directory and make a copy of it in ``copy-of-data``
+    ipfs.get('QmSh4Xjoy16v6XmnREE1yCrPM1dnizZc2h6LfrqXsnbBV7', 'copy-of-data')
 
 ## Advanced
 
 Dynamically add folders and files to *IPFS*, without creating them
 on the local file system:
 
-```ruby
-require 'ipfs-api'
-
-ipfs = IPFS::Connection.new
-folder = IPFS::Upload.folder('test') do |test|
-  test.add_file('hello.txt') do |fd|
-    fd.write 'Hello'
-  end
-  test.add_file('world.txt') do |fd|
-    fd.write 'World'
-  end
-end
-ipfs.add folder do |node|
-  # display each uploaded node:
-  print "#{node.name}: #{node.hash}\n" if node.finished?
-end
-```
+    require 'ipfs-api'
+
+    ipfs = IPFS::Connection.new
+    folder = IPFS::Upload.folder('test') do |test|
+      test.add_file('hello.txt') do |fd|
+        fd.write 'Hello'
+      end
+      test.add_file('world.txt') do |fd|
+        fd.write 'World'
+      end
+    end
+    ipfs.add folder do |node|
+      # display each uploaded node:
+      print "#{node.name}: #{node.hash}\n" if node.finished?
+    end
 
 ## License
 

data/Rakefile

@@ -52,7 +52,7 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   s.extra_rdoc_files = RDOC_FILES
   s.rdoc_options = RDOC_OPTIONS
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 2.0.0"
 end
 
 # also keep the gemspec up to date each time we package a tarball or gem

data/ipfs-api.gemspec

@@ -20,17 +20,15 @@ Gem::Specification.new do |s|
  "lib/ipfs-api/io.rb",
  "lib/ipfs-api/upload.rb",
  "lib/ipfs-api/version.rb",
- "test/common.rb",
  "test/samples.rb",
  "test/test_cmd_add.rb",
  "test/test_cmd_cat.rb",
  "test/test_cmd_get.rb",
  "test/test_cmd_id.rb",
  "test/test_cmd_ls.rb",
- "test/test_cmd_name.rb",
  "test/test_io.rb",
  "test/test_upload.rb"]
-  s.full_name = "ipfs-api-0.2.0"
+  s.full_name = "ipfs-api-0.3.0"
   s.has_rdoc = true
   s.homepage = "http://hjoest.github.io/ruby-ipfs-api"
   s.licenses = ["MIT"]
@@ -38,11 +36,11 @@ Gem::Specification.new do |s|
   s.platform = "ruby"
   s.rdoc_options = ["--title", "Interplanetary File System for Ruby", "--quiet", "--main", "lib/ipfs-api.rb"]
   s.require_paths = ["lib"]
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 2.0.0"
   s.required_rubygems_version = ">= 0"
   s.rubyforge_project = "ipfs-api"
-  s.rubygems_version = "2.4.8"
+  s.rubygems_version = "2.6.10"
   s.specification_version = 4
   s.summary = "Interplanetary File System for Ruby"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 end

data/lib/ipfs-api.rb

@@ -1,10 +1,10 @@
-# =IPFS4R - Interplanetary Filesystem Library for Ruby
+# =IPFS API for Ruby
 # License:: MIT (see the LICENSE file)
 # Website:: https://hjoest.github.io/ruby-ipfs-api
 #
 # ==Introduction
 #
-# IPFS4R is an IPFS[https://ipfs.io] library for Ruby.
+# IPFS API for Ruby is an IPFS[https://ipfs.io] library for Ruby.
 #
 require 'ipfs-api/version'
 require 'ipfs-api/io'

data/lib/ipfs-api/connection.rb

@@ -11,66 +11,70 @@ module IPFS
     end
 
     def add nodes, &block
-      boundaries = [ generate_boundary ]
-      headers = {
-        'Content-Disposition' => 'form-data: name="files"',
-        'Content-Type' => "multipart/form-data; boundary=#{boundaries[0]}"
-      }
-      walker = Upload::TreeWalker.depth_first(nodes)
+      boundary = generate_boundary
+      tree_walker = Upload::TreeWalker.depth_first(nodes)
       node_map = {}
-      stream = IO::ReadFromWriterIO.new do |buf|
-        next if walker.nil?
-        begin
-          node, depth = walker.next
-          node_map[node.path] = node
-        rescue StopIteration
-          depth = -1
-          walker = nil
-        end
-        while boundaries.size > depth+1 && boundary = boundaries.shift
-          buf << %Q{\
---#{boundary}--\r\n\
+      producer = IO::StreamProducer.new do |buf|
+        buf << %Q{\
+--#{boundary}\r\n\
+Content-Disposition: file; filename="root"\r\n\
+Content-Type: application/x-directory\r\n\
 \r\n\
 \r\n\
 }
-        end
-        next if walker.nil?
-        if node.folder?
-          boundaries.unshift generate_boundary
-          buf << %Q{\
---#{boundaries[1]}\r\n\
-Content-Disposition: form-data; name="file"; filename="#{node.path}"\r\n\
-Content-Type: multipart/mixed; boundary=#{boundaries[0]}\r\n\
+        tree_walker.each do |node, depth|
+          node_map[node.path] = node
+          if node.folder?
+            buf << %Q{\
+--#{boundary}\r\n\
+Content-Disposition: file; filename="root#{node.path.gsub('/', '%2F')}"\r\n\
+Content-Type: application/x-directory\r\n\
 \r\n\
 \r\n\
 }
-        elsif node.file?
-          buf << %Q{\
---#{boundaries[0]}\r\n\
-Content-Disposition: file; filename="#{node.path}"\r\n\
+          elsif node.file?
+            buf << %Q{\
+--#{boundary}\r\n\
+Content-Disposition: file; filename="root#{node.path.gsub('/', '%2F')}"\r\n\
 Content-Type: application/octet-stream\r\n\
 \r\n\
 #{node.content}\r\n\
 }
-        else
-          raise "Unknown node type: #{node}"
+          else
+            raise "Unknown node type: #{node}"
+          end
         end
+        buf << %Q{\
+--#{boundary}\r\n\
+}
       end
-      nodes = []
+      headers = {
+        'Content-Type' => "multipart/form-data; boundary=#{boundary}"
+      }
+      stream = producer.stream
+      uploaded_nodes = []
       post("add?encoding=json&r=true&progress=true", stream, headers) do |chunk|
         next if chunk.empty?
-        upload = JSON.parse(chunk)
+        upload = nil
+        begin
+          upload = JSON.parse(chunk)
+        rescue JSON::ParserError
+        end
+        next if upload.nil?
         path, bytes, hash = ['Name', 'Bytes', 'Hash'].map { |p| upload[p] }
+        next if not path.start_with?('root/')
+        path = path[4..-1]
         node = node_map[path]
+        next if not node
         node.bytes = bytes if bytes
         node.hash = hash if hash
         if block_given?
           block.call(node)
         elsif hash
-          nodes << node
+          uploaded_nodes << node
         end
       end
-      block_given? ? nil : nodes
+      block_given? ? nil : uploaded_nodes
     end
 
     def cat path
@@ -82,16 +86,16 @@ Content-Type: application/octet-stream\r\n\
     end
 
     def get path, destination = nil
-      stream = IO::ReadFromWriterIO.new do |buf|
+      producer = IO::StreamProducer.new do |buf|
         post("get?arg=#{CGI.escape(path)}") do |chunk|
           buf << chunk
         end
         buf.close
       end
       if destination.nil?
-        return stream
+        return producer.stream
       else
-        return IO::Tar.extract(stream, destination)
+        return IO::Tar.extract(producer.stream, destination)
       end
     end
 

data/lib/ipfs-api/io.rb

@@ -1,59 +1,28 @@
-require 'stringio'
+require 'tempfile'
 require 'rubygems/package'
 
 module IPFS; end
 module IPFS::IO # :nodoc:
 
-  class ReadFromWriterIO # :nodoc:
+  class StreamProducer # :nodoc:
 
     def initialize &block
       @block = block
-      @stream = StringIO.new
-      @d = @p = 0
-      @eof = false
-      fetch_data
     end
 
-    def read length = nil, outbuf = ''
-      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, 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
+    def stream
+      io = Tempfile.new('ruby-ipfs')
+      begin
+        @block.call io
+      ensure
+        io.close
       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, @d = 0, @d + @p
-      @stream.string = ''
-      @block.call @stream if not @stream.closed?
+      File.open(io.path, 'r')
     end
 
   end
 
-  module Tar
+  module Tar # :nodoc:
 
     def extract stream, destination
       Gem::Package::TarReader.new(stream) do |tar|

data/lib/ipfs-api/upload.rb

@@ -63,8 +63,8 @@ module IPFS::Upload
 
       def inspect
         s = "<#{@name}"
-        s << ":#{@bytes}" if @bytes
-        s << ":#{@hash}" if @hash
+        s << ":#{@bytes}" if defined?(@bytes)
+        s << ":#{@hash}" if defined?(@hash)
         s << '>'
       end
 

data/lib/ipfs-api/version.rb

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

data/test/samples.rb

@@ -1,5 +1,19 @@
 require 'tmpdir'
-require 'test/common'
+require 'minitest/autorun'
+begin
+  Minitest.const_get('Test')
+rescue
+  module Minitest
+    Test = Unit::TestCase
+  end
+end
+if ENV['DEBUG']
+  require 'byebug'
+else
+  def byebug; end
+end
+
+$:.unshift File.expand_path('../../lib', __FILE__)
 require 'ipfs-api/upload'
 
 module Samples

data/test/test_cmd_add.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/samples'
+require 'samples'
 require 'ipfs-api'
 
 include IPFS

data/test/test_cmd_cat.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/samples'
+require 'samples'
 require 'ipfs-api'
 
 include IPFS

data/test/test_cmd_get.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/samples'
+require 'samples'
 require 'ipfs-api'
 
 include IPFS

data/test/test_cmd_id.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/common'
+require 'samples'
 require 'ipfs-api'
 
 include IPFS

data/test/test_cmd_ls.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/samples'
+require 'samples'
 require 'ipfs-api'
 
 include IPFS

data/test/test_io.rb

@@ -1,22 +1,21 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/samples'
+require 'samples'
 require 'ipfs-api/io'
 
 include IPFS::IO
 
-class ReadFromWriterIOTest < Minitest::Test
+class StreamProducerTest < Minitest::Test
 
   def setup
     @parts = Samples.some_byte_sequences
     enum = @parts.each
-    @reader = ReadFromWriterIO.new do |writer|
-      begin
-        writer << enum.next
-      rescue StopIteration
-        writer.close
+    producer = StreamProducer.new do |writer|
+      enum.each do |part|
+        writer << part
       end
     end
+    @reader = producer.stream
   end
 
   def test_read_byte_wise
@@ -24,7 +23,6 @@ class ReadFromWriterIOTest < Minitest::Test
     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

data/test/test_upload.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path('../..', __FILE__)
+$:.unshift File.expand_path('..', __FILE__)
 
-require 'test/samples'
+require 'samples'
 require 'ipfs-api/upload'
 
 class NodeTest < Minitest::Test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipfs-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Holger Joest
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-03 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies: []
 description: This is a client library to access the IPFS from Ruby
 email: holger@joest.org
@@ -30,14 +30,12 @@ files:
 - lib/ipfs-api/io.rb
 - lib/ipfs-api/upload.rb
 - lib/ipfs-api/version.rb
-- test/common.rb
 - test/samples.rb
 - test/test_cmd_add.rb
 - test/test_cmd_cat.rb
 - test/test_cmd_get.rb
 - test/test_cmd_id.rb
 - test/test_cmd_ls.rb
-- test/test_cmd_name.rb
 - test/test_io.rb
 - test/test_upload.rb
 homepage: http://hjoest.github.io/ruby-ipfs-api
@@ -57,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -65,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ipfs-api
-rubygems_version: 2.4.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Interplanetary File System for Ruby

data/test/common.rb

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

data/test/test_cmd_name.rb

@@ -1,22 +0,0 @@
-$:.unshift File.expand_path('../..', __FILE__)
-
-require 'test/common'
-require 'ipfs-api'
-
-include IPFS
-
-class CommandNameTest < Minitest::Test
-
-  def test_name_resolve
-    ipfs = Connection.new
-    resolved = ipfs.name.resolve
-    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