ruby-ipfs-api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ed5bd942765642e4bd3c2d5288cabc376fc63fd
-  data.tar.gz: a4b6662afce323e336b7b5e89837e13a148c3d76
+  metadata.gz: b88f45e74fc2a1d52cbb1ddb1475d99a8d90c958
+  data.tar.gz: a437843901b0627e9df05bf2eddd39829bcc025c
 SHA512:
-  metadata.gz: 911bf26795481cac044b2d68f572f197a6b96deffd9ac35862d3ee8897424f4cb67bce6800b69b6b32b90d69c0c10b945629f66d11334688791839c59ab2ade1
-  data.tar.gz: 6912913ce0388053688d9308748023bacb37b1e0ca42c18d110852ef6b7561a02bb4923de45613c070e11bd0d2afc2abcfd725cd73f8ec6d832d7f01e5702b69
+  metadata.gz: '0584b5117850f444ad8c496ebba5045692ba7d0c9885d448f2d3e714d84e1481462abbe8031721fe981a0a5a5f6d4bf87539f1ca911cc05d56cd89e73ebb4e67'
+  data.tar.gz: 7526273d89114e60ecc224e4484abc641c033b54ae52fce7d9075c836275a9e5682cbee49a04835f53caff2c051c391684cf9af282fcea834d94f4526d7e2874

data/lib/api/files/cat.rb

@@ -6,7 +6,7 @@ module Ipfs
       PATH = '/cat'
 
       def self.build_request(multihash)
-        Command.build_request(PATH, multihash: Ipfs::Multihash.new(multihash))
+        Command.build_request(PATH, multihash: multihash)
       end
 
       def self.parse_response(response)

data/lib/client.rb

@@ -1,37 +1,141 @@
-require_relative './http_api'
+require 'http'
+require 'uri'
+
+require_relative './errors'
 require_relative './api/command'
-require_relative './multihash'
+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
-    def initialize(server = {})
-      @http_api = HttpApi.new server
-    end
+    # @api private
+    DEFAULT_BASE_PATH = '/api/v0'
+    # @api private
+    CONNECTION_METHODS = [
+      Connection::Default,
+      Connection::IpfsConfig,
+      Connection::Unreachable
+    ]
 
-    def id
-      execute Command::Id
-    end
+    # @api private
+    class << self
+      def initialize
+        attempt_connection
 
-    def version
-      execute Command::Version
-    end
+        retrieve_ids
+        retrieve_daemon_version
 
-    def cat(multihash)
-      execute Command::Cat, multihash
-    end
+        ObjectSpace.define_finalizer(self, proc { @@connection.close })
+      end
 
-    def ls(multihash)
-      execute Command::Ls, multihash
-    end
 
-    def add(filepath)
-      execute Command::Add, filepath
-    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
 
-    private
+      # 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
 
-    def execute(command, *args)
-      command.parse_response @http_api.call command.build_request *args
+      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
+end

data/lib/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/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/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/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/dagstream.rb

@@ -6,14 +6,14 @@ module Ipfs
 
     def initialize(response)
       if response.status.code == 200
-        @content = response
+        @content = response.body.to_s
       else
         raise Error::InvalidDagStream, JSON.parse(response.body)['Message']
       end
     end
 
     def to_s
-      @content.body.to_s
+      @content
     end
 
     alias to_str to_s

data/lib/errors.rb

@@ -5,5 +5,8 @@ module Ipfs
 
     class InvalidMultihash < StandardError
     end
+
+    class UnreachableDaemon < StandardError
+    end
   end
 end

data/lib/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/ipfs_api.rb

@@ -1,7 +1,6 @@
 require_relative './client'
+require_relative './file'
 
 module Ipfs
-  class Client
-    VERSION = '0.5.0'
-  end
-end
+  VERSION = '0.5.1'
+end

data/lib/multihash.rb

@@ -11,6 +11,10 @@ module Ipfs
 
     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])

data/lib/request/basic_request.rb

@@ -10,7 +10,7 @@ module Ipfs
 
     def options
       @multihash \
-        ? { params: { arg: @multihash.raw } }
+        ? { params: { arg: @multihash.raw } } \
         : {}
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ipfs-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tom Benett
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2019-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -39,15 +39,19 @@ files:
 - lib/api/generic/version.rb
 - lib/base.rb
 - lib/client.rb
+- lib/connection/base.rb
+- lib/connection/default.rb
+- lib/connection/ipfs_config.rb
+- lib/connection/unreachable.rb
 - lib/dagstream.rb
 - lib/errors.rb
-- lib/http_api.rb
+- lib/file.rb
 - lib/ipfs_api.rb
 - lib/multihash.rb
 - lib/request/basic_request.rb
 - lib/request/file_upload_request.rb
 - lib/request/request.rb
-homepage: https://github.com/mahloun/ruby-ipfs-api
+homepage: https://github.com/tbenett/ruby-ipfs-api
 licenses:
 - MIT
 metadata: {}

data/lib/http_api.rb

@@ -1,36 +0,0 @@
-require 'http'
-require 'uri'
-
-module Ipfs
-  class HttpApi
-    attr_reader :host, :port, :base_path
-
-    DEFAULT_HOST = 'localhost'
-    DEFAULT_PORT = 5001
-    DEFAULT_BASE_PATH = '/api/v0'
-
-    def initialize(**api_server)
-      @host = api_server[:host] || DEFAULT_HOST
-      @port = api_server[:port] || DEFAULT_PORT
-      @base_path = api_server[:base_path] || DEFAULT_BASE_PATH
-    end
-
-    def call(command)
-      HTTP.request(
-        command.verb,
-        url(command.path),
-        command.options
-      )
-    end
-
-    private
-
-    def url(command_path)
-      URI::HTTP.build(
-        host: @host,
-        port: @port,
-        path: @base_path + command_path
-      )
-    end
-  end
-end