ruby-ipfs-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6be77b3c8b110052ee64c9dae0041ca4a01da400
-  data.tar.gz: d667d4ceb0722a86261c88218f5c6444803659b0
+  metadata.gz: 24d678460e6540e0cdb6ba0adb78059cf62cb57c
+  data.tar.gz: 3654e0e6d008375a2a1c58ddd921dcb7992dbdeb
 SHA512:
-  metadata.gz: 2998fe01ce08f03066de75ee6d1da7b00e10214b7da5bbbf0a7b37dcf4d5af51336366b86821d0b51fa3b2560dc46af890f317eca2bb3d3e7168bade698f1baf
-  data.tar.gz: 7325c99bfbddad37937694b9496f51c06b18b9f22b2addac51d89034e83b1bce1babb0f3b027ac9db0048780d97ca29e2c43a7c4512febea64e6025c7c3647e2
+  metadata.gz: 68ebf7fc1d165de81ba34621dff8a403556fdb46e339dface000846c3d740c328d034ffdc2e6decdf6b98624a53a219e83d761d8729d6673a054a09295570627
+  data.tar.gz: c9fa6d861c4f2bb36f5e1b9341c5cf28d9532b7253d5c271b5cd6a8b8ca2cbb4b88f64b73f257801a40783734ac98abe21b2add0850eb85bdd5c5d7654d8b0f3

data/lib/api/files/cat.rb

@@ -1,4 +1,4 @@
-require_relative '../../dagnode'
+require_relative '../../dagstream'
 require_relative '../../errors'
 
 module Ipfs
@@ -6,17 +6,17 @@ module Ipfs
     class Cat
       PATH = '/cat'
 
-      def self.make_request multi_hash
+      def self.build_request(multi_hash)
         {
-          method: :get,
+          verb: :get,
           path: PATH,
-          params: { :arg => multi_hash }
+          options: { params: { arg: multi_hash.raw } }
         }
       end
 
-      def self.parse_response response
-        DagNode.new response
+      def self.parse_response(response)
+        DagStream.new response
       end
     end
   end
-end
+end

data/lib/api/files/ls.rb

@@ -0,0 +1,19 @@
+module Ipfs
+  module Command
+    class Ls
+      PATH = '/ls'
+
+      def self.build_request(multi_hash)
+        {
+          verb: :get,
+          path: PATH,
+          options: { params: { arg: multi_hash.raw } }
+        }
+      end
+
+      def self.parse_response(response)
+        JSON.parse(response.body)['Objects'][0]['Links']
+      end
+    end
+  end
+end

data/lib/api/generic/id.rb

@@ -3,16 +3,16 @@ module Ipfs
     class Id
       PATH = '/id'
 
-      def self.make_request
+      def self.build_request
         {
-          method: :get,
+          verb: :post,
           path: PATH
         }
       end
 
-      def self.parse_response response
+      def self.parse_response(response)
         JSON.parse response
       end
     end
   end
-end
+end

data/lib/api/generic/version.rb

@@ -3,14 +3,14 @@ module Ipfs
     class Version
       PATH = '/version'
 
-      def self.make_request
+      def self.build_request
         {
-          method: :get,
+          verb: :get,
           path: PATH
         }
       end
 
-      def self.parse_response response
+      def self.parse_response(response)
         JSON.parse response
       end
     end

data/lib/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/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
+      else
+        raise Error::InvalidDagStream, JSON.parse(response.body)['Message']
+      end
+    end
+
+    def to_s
+      @content.body.to_s
+    end
+
+    alias to_str to_s
+  end
+end

data/lib/errors.rb

@@ -1,6 +1,9 @@
 module Ipfs
   module Error
-    class InvalidDagNode < StandardError
+    class InvalidDagStream < StandardError
+    end
+
+    class InvalidMultihash < StandardError
     end
   end
 end

data/lib/ipfs-api.rb

@@ -2,10 +2,12 @@ require_relative './request'
 require_relative './api/generic/id'
 require_relative './api/generic/version'
 require_relative './api/files/cat'
+require_relative './api/files/ls'
+require_relative './multihash'
 
 module Ipfs
   class Client
-    def initialize server = {}
+    def initialize(server = {})
       @request = Request.new server
     end
 
@@ -17,14 +19,18 @@ module Ipfs
       execute Command::Version
     end
 
-    def cat multi_hash
-      execute Command::Cat, multi_hash
+    def cat(multi_hash)
+      execute Command::Cat, Multihash.new(multi_hash)
+    end
+
+    def ls(multi_hash)
+      execute Command::Ls, Multihash.new(multi_hash)
     end
 
     private
 
-    def execute command, *args
-      command.parse_response @request.call_api command.make_request *args
+    def execute(command, *args)
+      command.parse_response @request.call_api command.build_request *args
     end
   end
 end

data/lib/multihash.rb

@@ -0,0 +1,42 @@
+require_relative './errors'
+
+module Ipfs
+
+  class Multihash
+    attr_reader :hash_func_type, :digest_length, :digest_value
+
+    DEFAULT_LENGTH = 46
+    VALID_DIGEST_LENGTH = 'm'
+    FUNCTION_TYPE_CODE = {
+      sha256: 'Q'
+    }
+
+    def initialize(hash)
+      @hash_func_type = hash[0]
+      @digest_length = hash[1]
+      @digest_value = hash[2..-1]
+
+      raise Ipfs::Error::InvalidMultihash, "The hash '#{raw}' is invalid." unless valid?
+    end
+
+    def raw
+      "#{@hash_func_type}#{@digest_length}#{@digest_value}"
+    end
+
+    alias to_s raw
+
+    private
+
+    def valid?
+      correct_length? && encoded_digest?(:sha256)
+    end
+
+    def correct_length?
+      raw.length == DEFAULT_LENGTH
+    end
+
+    def encoded_digest?(encoding)
+      @hash_func_type == FUNCTION_TYPE_CODE[encoding]
+    end
+  end
+end

data/lib/request.rb

@@ -9,27 +9,28 @@ module Ipfs
     DEFAULT_PORT = 5001
     DEFAULT_BASE_PATH = '/api/v0'
 
-    def initialize **api_server
+    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
+      @base_path = api_server[:base_path] || DEFAULT_BASE_PATH
     end
 
-    def call_api command
+    def call_api(command)
       HTTP.request(
-        command[:method],
+        command[:verb],
         url(command[:path]),
-        params: command[:params]
+        command[:options] ? command[:options] : {}
       )
     end
 
     private
 
-    def url command_path
-      URI::HTTP.build \
+    def url(command_path)
+      URI::HTTP.build(
         host: @host,
         port: @port,
         path: @base_path + command_path
+      )
     end
   end
-end
+end

metadata

@@ -1,28 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: ruby-ipfs-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Thomas Nieto
+- Tom Benett
 - Neil Nilou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-12 00:00:00.000000000 Z
+date: 2017-11-27 00:00:00.000000000 Z
 dependencies: []
-description: A client library for the IPFS HTTP API, immplemented in Ruby
-email: thms.no@gmail.com
+description: A client library for the IPFS HTTP API, implemented in Ruby
+email: tom@benett.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/api/files/cat.rb
+- lib/api/files/ls.rb
 - lib/api/generic/id.rb
 - lib/api/generic/version.rb
-- lib/dagnode.rb
+- lib/base.rb
+- lib/dagstream.rb
 - lib/errors.rb
 - lib/ipfs-api.rb
+- lib/multihash.rb
 - lib/request.rb
 homepage: https://github.com/mahloun/ruby-ipfs-api
 licenses:
@@ -44,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: ipfs client

data/lib/dagnode.rb

@@ -1,15 +0,0 @@
-require_relative './errors'
-
-module Ipfs
-  class DagNode
-    attr_reader :content
-
-    def initialize http_response
-      if http_response.status.code == 200
-        @content = http_response.body
-      else
-        raise Error::InvalidDagNode.new JSON.parse(http_response.body)["Message"]
-      end
-    end
-  end
-end