ruby-ipfs-http-client 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1728edc46e1056ee5b94ccc057f3c68ae4eabfab20518d54cb52ecd0fb1944bc
+  data.tar.gz: a7125b526b11263bb2e4b67100f64530b5d9633a2c503def3cb307488e4afebd
+SHA512:
+  metadata.gz: 7131e40d3fd1b7634bb7af59b1b264cdac9136d906d83672db68471f18a314bcdbca32bc1e868c744b34fdc572262735d5dcbf52177a9d6a9cd4d627bb75a46b
+  data.tar.gz: 0ce36826dc172a6d5b72681aa448d69aba62b81a7c50b58848038e269d42067c68b781bd48541098728ad59e24f55d43359ac35a208b2c8776daa83cb9ca7a19

data/lib/ipfs.rb

@@ -0,0 +1,5 @@
+require_relative './ruby-ipfs-http-client/client'
+require_relative './ruby-ipfs-http-client/file'
+
+module Ipfs
+end

data/lib/ruby-ipfs-http-client/api/command.rb

@@ -0,0 +1,26 @@
+require_relative '../multihash'
+
+require_relative '../request/basic_request'
+require_relative '../request/file_upload_request'
+
+require_relative './generic/id'
+require_relative './generic/version'
+require_relative './files/cat'
+require_relative './files/ls'
+require_relative './files/add'
+
+module Ipfs
+  module Command
+    def self.build_request(path, **arguments)
+      keys = arguments.keys
+
+      if keys.include?(:multihash)
+        BasicRequest.new(path, multihash: arguments[:multihash])
+      elsif keys.include?(:filepath)
+        FileUploadRequest.new(path, arguments[:filepath])
+      else
+        BasicRequest.new(path)
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/api/files/add.rb

@@ -0,0 +1,15 @@
+module Ipfs
+  module Command
+    class Add
+      PATH = '/add'
+
+      def self.build_request(filepath)
+        Command.build_request(PATH, filepath: filepath)
+      end
+
+      def self.parse_response(response)
+        JSON.parse response
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/api/files/cat.rb

@@ -0,0 +1,17 @@
+require_relative '../../dagstream'
+
+module Ipfs
+  module Command
+    class Cat
+      PATH = '/cat'
+
+      def self.build_request(multihash)
+        Command.build_request(PATH, multihash: multihash)
+      end
+
+      def self.parse_response(response)
+        DagStream.new response
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/api/files/ls.rb

@@ -0,0 +1,15 @@
+module Ipfs
+  module Command
+    class Ls
+      PATH = '/ls'
+
+      def self.build_request(multihash)
+        Command.build_request(PATH, multihash: Ipfs::Multihash.new(multihash))
+      end
+
+      def self.parse_response(response)
+        JSON.parse(response.body)['Objects'][0]['Links']
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/api/generic/id.rb

@@ -0,0 +1,15 @@
+module Ipfs
+  module Command
+    class Id
+      PATH = '/id'
+
+      def self.build_request
+        Command.build_request(PATH)
+      end
+
+      def self.parse_response(response)
+        JSON.parse response
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/api/generic/version.rb

@@ -0,0 +1,15 @@
+module Ipfs
+  module Command
+    class Version
+      PATH = '/version'
+
+      def self.build_request
+        Command.build_request(PATH)
+      end
+
+      def self.parse_response(response)
+        JSON.parse response
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/base.rb

@@ -0,0 +1,43 @@
+module Ipfs
+  class Base58
+    ALPHABET = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
+    BASE = ALPHABET.length
+
+    def self.decode(number)
+      valid?(number) \
+        ? to_base10(number)
+        : 0
+    end
+
+    def self.to_base10(base58_number)
+      base58_number
+        .reverse
+        .split(//)
+        .each_with_index
+        .reduce(0) do |base10_number, (base58_numeral, index)|
+        base10_number + ALPHABET.index(base58_numeral) * (BASE**index)
+      end
+    end
+
+    def self.valid?(number)
+      number.match?(/\A[#{ALPHABET}]+\z/)
+    end
+
+    def self.encode(base10_number)
+      base10_number.is_a?(Integer) \
+        ? to_base58(base10_number) \
+        : ''
+    end
+
+    def self.to_base58(base10_number)
+      base58_number = ''
+
+      begin
+        base58_number << ALPHABET[base10_number % BASE]
+        base10_number /= BASE
+      end while base10_number > 0
+
+      base58_number.reverse
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/client.rb

@@ -0,0 +1,141 @@
+require 'http'
+require 'uri'
+
+require_relative './errors'
+require_relative './api/command'
+require_relative './api/generic/id'
+
+require_relative './connection/default'
+require_relative './connection/ipfs_config'
+require_relative './connection/unreachable'
+
+module Ipfs
+  # The client is not intended to be manipulated. It is a singleton class used
+  # to route commands and their corresponding requests.
+  #
+  # However, it contains certain, read-only, information that can be useful for
+  # debugging purposes.
+  class Client
+    # @api private
+    DEFAULT_BASE_PATH = '/api/v0'
+    # @api private
+    CONNECTION_METHODS = [
+      Connection::Default,
+      Connection::IpfsConfig,
+      Connection::Unreachable
+    ]
+
+    # @api private
+    class << self
+      def initialize
+        attempt_connection
+
+        retrieve_ids
+        retrieve_daemon_version
+
+        ObjectSpace.define_finalizer(self, proc { @@connection.close })
+      end
+
+
+      # @api private
+      def execute(command, *args)
+        command.parse_response call command.build_request *args
+      end
+
+      # Various debugging information concerning the Ipfs node itself
+      #
+      # @example
+      #   Ipfs::Client.id
+      #   #=> {
+      #     peer_id: 'QmVnLbr9Jktjwx...',
+      #     addresses: [
+      #       "/ip4/127.0.0.1/tcp/4001/ipfs/QmVwxnW4Z8JVMDfo1jeFMNqQor5naiStUPooCdf2Yu23Gi",
+      #       "/ip4/192.168.1.16/tcp/4001/ipfs/QmVwxnW4Z8JVMDfo1jeFMNqQor5naiStUPooCdf2Yu23Gi",
+      #       "/ip6/::1/tcp/4001/ipfs/QmVwxnW4Z8JVMDfo1jeFMNqQor5naiStUPooCdf2Yu23Gi",
+      #       "/ip6/2a01:e34:ef8d:2940:8f7:c616:...5naiStUPooCdf2Yu23Gi",
+      #       "/ip6/2a01:e34:ef8d:2940:...5naiStUPooCdf2Yu23Gi",
+      #       "/ip4/78.248.210.148/tcp/13684/ipfs/Qm...o1jeFMNqQor5naiStUPooCdf2Yu23Gi"
+      #     ],
+      #     public_key: "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwgg...AgMBAAE=",
+      #     agent_version: "go-ipfs/0.4.13/3b16b74"
+      #   }
+      #
+      # @return [Hash{Symbol => String, Array<String>}]
+      def id
+        @@id
+      end
+
+      # Various debugging information concerning the running Ipfs daemon
+      # and this library
+      #
+      # @example
+      #   Ipfs::Client.daemon
+      #   #=> {
+      #     :version: "0.4.13",
+      #     commit: "cc01b7f",
+      #     repo: "6",
+      #     system: "amd64/darwin",
+      #     golang: "go1.9.2"
+      #   }
+      #
+      # @return [Hash{Symbol => String}]
+      def daemon
+        @@daemon
+      end
+
+      private
+
+      def call(command)
+        begin
+          @@connection.request(
+            command.verb,
+            "#{DEFAULT_BASE_PATH}#{command.path}",
+            command.options
+          )
+        rescue HTTP::ConnectionError
+          raise Ipfs::Error::UnreachableDaemon, "IPFS is not reachable."
+        end
+      end
+
+      def attempt_connection
+        find_up = ->(connections) {
+          connections.each { |connection|
+            co = connection.new
+
+            return co if co.up?
+          }
+        }
+
+        @@connection = find_up.call(CONNECTION_METHODS).make_persistent
+      end
+
+      def retrieve_ids
+        (execute Command::Id).tap do |ids|
+          @@id = {
+            peer_id: ids['ID'],
+            addresses: ids['Addresses'],
+            public_key: ids['PublicKey'],
+            agent_version: ids['AgentVersion'],
+          }
+        end
+      end
+
+      def retrieve_daemon_version
+        (execute Command::Version).tap do |version|
+          @@daemon = {
+            version: version['Version'],
+            commit: version['Commit'],
+            repo: version['Repo'],
+            system: version['System'],
+            golang: version['Golang'],
+            api: DEFAULT_BASE_PATH.split('/')[-1]
+          }
+        end
+      end
+    end
+
+    initialize
+
+    private_class_method :new
+  end
+end

data/lib/ruby-ipfs-http-client/connection/base.rb

@@ -0,0 +1,28 @@
+require 'http'
+require 'uri'
+
+module Ipfs
+  module Connection
+    class Base
+      DEFAULT_BASE_PATH = '/api/v0'
+      attr_reader :host, :port
+
+      def build_uri
+        URI::HTTP.build(host: @host, port: @port)
+      end
+
+      def up?
+        begin
+          HTTP.get("http://#{@host}:#{@port}#{DEFAULT_BASE_PATH}/id")
+          true
+        rescue HTTP::ConnectionError
+          false
+        end
+      end
+
+      def make_persistent
+        HTTP.persistent build_uri
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/connection/default.rb

@@ -0,0 +1,12 @@
+require_relative './base'
+
+module Ipfs
+  module Connection
+    class Default < Base
+      def initialize
+        @host = 'localhost'
+        @port = 5001
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/connection/ipfs_config.rb

@@ -0,0 +1,27 @@
+require_relative './base'
+
+module Ipfs
+  module Connection
+    class IpfsConfig < Base
+      CONFIG_FILEPATH = "#{ENV['HOME']}/.ipfs/config"
+
+      def initialize
+        parse_config.tap { |location|
+          @host = location[:host]
+          @port = location[:port]
+        }
+      end
+
+      private
+
+      def parse_config
+        %r{.*API.*/ip4/(.*)/tcp/(\d+)}.match(::File.read CONFIG_FILEPATH) do |matched_data|
+          {
+            host: matched_data[1],
+            port: matched_data[2].to_i
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/connection/unreachable.rb

@@ -0,0 +1,12 @@
+require_relative './base'
+require_relative '../errors'
+
+module Ipfs
+  module Connection
+    class Unreachable < Base
+      def up?
+        raise Ipfs::Error::UnreachableDaemon, "IPFS is not reachable."
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/dagstream.rb

@@ -0,0 +1,21 @@
+require_relative './errors'
+
+module Ipfs
+  class DagStream
+    attr_reader :content
+
+    def initialize(response)
+      if response.status.code == 200
+        @content = response.body.to_s
+      else
+        raise Error::InvalidDagStream, JSON.parse(response.body)['Message']
+      end
+    end
+
+    def to_s
+      @content
+    end
+
+    alias to_str to_s
+  end
+end

data/lib/ruby-ipfs-http-client/errors.rb

@@ -0,0 +1,12 @@
+module Ipfs
+  module Error
+    class InvalidDagStream < StandardError
+    end
+
+    class InvalidMultihash < StandardError
+    end
+
+    class UnreachableDaemon < StandardError
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/file.rb

@@ -0,0 +1,112 @@
+require_relative './multihash'
+require_relative './api/files/add'
+require_relative './api/files/cat'
+
+module Ipfs
+  # @attr_reader [String] path The file's path.
+  # @attr_reader [Ipfs::Multihash] multihash The file's multihash as returned by Ipfs.
+  # @attr_reader [Integer] size The file's size in bytes as returned by Ipfs.
+  # @attr_reader [String] name The file's name as returned by Ipfs.
+  class File
+    attr_reader :path, :multihash, :size, :name
+
+    # Create an Ipfs file object, either from a Multihash or from a filepath
+    # allowing a file to be added to and be retrieved from Ipfs.
+    #
+    # @example given a filepath
+    #   Ipfs::File.new(path: 'path/to/file')
+    #   #=> #<Ipfs::File @path="path/to/file", @added=false>
+    # @example given a multihash
+    #   Ipfs::File.new(multihash: 'QmVfpW2rKzzahcxt5LfYyNnnKvo1L7XyRF8Ykmhttcyztv')
+    #   #=> #<Ipfs::File @added=false, @multihash=#<Ipfs::Multihash ....>>
+    #
+    # @param attributes [Hash{Symbol => String}]
+    #
+    # @return [Ipfs::File]
+    #
+    # @raise [Error::InvalidMultihash, Errno::ENOENT] Whether the path leads to
+    #   a non-file entity or the multihash may be invalid,
+    #   an error is thrown.
+    def initialize(**attributes)
+      attributes.each { |name, value|
+        instance_variable_set("@#{name}".to_sym, send("init_#{name}", value))
+      }
+
+      @added = false
+    end
+
+    # Add a file to the Ipfs' node.
+    #
+    # @note the call to Ipfs completes data about the added file.
+    #   See {#multihash}, {#size} and {#name}.
+    #
+    # An {#Ipfs::File} instantiated from a multihash will not be added to Ipfs
+    # (as the presence of the multihash already suppose its addition to a node).
+    # In such case, the object is still returned but no call to Ipfs occurs.
+    #
+    # @example file not being added to Ipfs
+    #   file = Ipfs::File.new(path: 'path/to/file')
+    #   file.cat
+    #   #=> ''
+    #   file.multihash
+    #   #=> nil
+    #   file.name
+    #   #=> nil
+    #   file.size
+    #   #=> nil
+    # @example file being added
+    #  file = Ipfs::File.new(path: 'path/to/file').add
+    #  file.cat
+    #  #=> 'file content'
+    #  file.multihash
+    #  #=> #<Ipfs::Multihash ...>
+    #  file.name
+    #  #=> 'file'
+    #  file.size
+    #  #=> 20
+    #
+    # @return [Ipfs::File] Returns the object on which the method was call.
+    def add
+      tap {
+        Ipfs::Client.execute(Command::Add, @path).tap { |response|
+          @added = true
+
+          @multihash = init_multihash(response['Hash'])
+          @size = response['Size'].to_i
+          @name = response['Name']
+        } if !@added
+      }
+    end
+
+    # Use the {#multihash} to get the content of a file from Ipfs and returns it.
+    #
+    # @note the file must be added first or have a multihash. See {#add} and {#multihash}.
+    #
+    # @example
+    #   Ipfs::File.new(path: 'path/to/file').add.cat
+    #   #=> 'file content'
+    #
+    # @return [String] The content is returned.
+    def cat
+      begin
+        Ipfs::Client.execute(Command::Cat, @multihash).to_s if @multihash
+      rescue Ipfs::Error::InvalidDagStream
+        ''
+      end
+    end
+
+    private
+
+    def init_multihash(multihash)
+      multihash.is_a?(Multihash) ? multihash : Multihash.new(multihash)
+    end
+
+    def init_path(path)
+      if ::File.file? path
+        path
+      else
+        raise Errno::ENOENT, 'no such file or directory'
+      end
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/multihash.rb

@@ -0,0 +1,53 @@
+require_relative './base'
+require_relative './errors'
+
+module Ipfs
+  class Multihash
+    attr_reader :hash_func_type, :digest_length
+
+    FUNCTIONS = [
+      { name: :sha256, type_code: 0x12, digest_length: 0x20 }
+    ]
+
+    def initialize(multihash)
+      @base58_encoded = multihash
+
+      raise Error::InvalidMultihash,
+            "The hash '#{@base58_encoded}' is invalid." unless @base58_encoded.is_a?(String)
+
+      @bytes_encoded = to_bytes
+
+      @function = find_hash_function(@bytes_encoded[0])
+
+      raise Error::InvalidMultihash, "The hash func type could not be found" if @function.nil?
+
+      @hash_func_type = @function[:name]
+      @digest_length = @function[:digest_length]
+
+      raise Error::InvalidMultihash,
+            "The hash '#{@base58_encoded}' is invalid." unless correct_length?
+    end
+
+    def to_bytes
+      [Base58.decode(@base58_encoded).to_s(16)]
+        .pack('H*')
+        .unpack('C*')
+    end
+
+    def raw
+      @base58_encoded
+    end
+
+    alias to_s raw
+
+    private
+
+    def find_hash_function(func_type_code)
+      FUNCTIONS.find { |function| function[:type_code] == func_type_code }
+    end
+
+    def correct_length?
+      @digest_length == @bytes_encoded[2..-1].length
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/request/basic_request.rb

@@ -0,0 +1,17 @@
+require_relative './request'
+
+module Ipfs
+  class BasicRequest < Request
+    def initialize(path, **arguments)
+      super(path, :get)
+
+      @multihash = arguments[:multihash]
+    end
+
+    def options
+      @multihash \
+        ? { params: { arg: @multihash.raw } } \
+        : {}
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/request/file_upload_request.rb

@@ -0,0 +1,19 @@
+require_relative './request'
+
+module Ipfs
+  class FileUploadRequest < Request
+    def initialize(path, filepath)
+      super(path, :post)
+
+      @filepath = filepath
+    end
+
+    def options
+      {
+        form: {
+          arg: HTTP::FormData::File.new(@filepath)
+        }
+      }
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/request/request.rb

@@ -0,0 +1,14 @@
+module Ipfs
+  class Request
+    attr_reader :path, :verb
+
+    def initialize(path, verb)
+      @path = path
+      @verb = verb
+    end
+
+    def options
+      {}
+    end
+  end
+end

data/lib/ruby-ipfs-http-client/version.rb

@@ -0,0 +1,3 @@
+module Ipfs
+  VERSION = '0.5.1'
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ruby-ipfs-http-client
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Tom Benett
+- Neil Nilou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+description: A client library for the IPFS HTTP API, implemented in Ruby
+email: tom@benett.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ipfs.rb
+- lib/ruby-ipfs-http-client/api/command.rb
+- lib/ruby-ipfs-http-client/api/files/add.rb
+- lib/ruby-ipfs-http-client/api/files/cat.rb
+- lib/ruby-ipfs-http-client/api/files/ls.rb
+- lib/ruby-ipfs-http-client/api/generic/id.rb
+- lib/ruby-ipfs-http-client/api/generic/version.rb
+- lib/ruby-ipfs-http-client/base.rb
+- lib/ruby-ipfs-http-client/client.rb
+- lib/ruby-ipfs-http-client/connection/base.rb
+- lib/ruby-ipfs-http-client/connection/default.rb
+- lib/ruby-ipfs-http-client/connection/ipfs_config.rb
+- lib/ruby-ipfs-http-client/connection/unreachable.rb
+- lib/ruby-ipfs-http-client/dagstream.rb
+- lib/ruby-ipfs-http-client/errors.rb
+- lib/ruby-ipfs-http-client/file.rb
+- lib/ruby-ipfs-http-client/multihash.rb
+- lib/ruby-ipfs-http-client/request/basic_request.rb
+- lib/ruby-ipfs-http-client/request/file_upload_request.rb
+- lib/ruby-ipfs-http-client/request/request.rb
+- lib/ruby-ipfs-http-client/version.rb
+homepage: https://github.com/tbenett/ruby-ipfs-http-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: ipfs client
+test_files: []