ipfs-http-client-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d09bf89ae84e1ce2363b4ada3831ab5b1ce57022b05ba49853d42c783214436a
+  data.tar.gz: 13b450716eea62fc7cea55b931d34554aec5378b55f6f076bdd04cf0888e5b94
+SHA512:
+  metadata.gz: 135ea9bf170b2819701ec028737dd830594ff133d4a66edb08ae275751215a1539c806701fe825e926c536cf18e99b41bd3571fb406b89979285926539cfa0fd
+  data.tar.gz: ea93ed525cd5f5f79ef3fb27532209e343acc5bcde8b6edbd9c7d336ec7208f4fad2133d854a246651d4c63caf30f09547dfaef7e82ed03004ce21e3610f8002

data/README.md

@@ -0,0 +1,92 @@
+# IPFS HTTP Client for Ruby
+
+![](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)
+
+> This gem provides IPFS HTTP client for Ruby, see [https://ipfs.io](https://ipfs.io).
+
+**Work in progress.**
+
+## Installation
+Requires Ruby >= 2.1, since it uses the new required keyword arguments syntax.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ipfs-http-client-rb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipfs-http-client-rb
+
+## Usage
+### Initialize client
+
+```
+pry(main)> client = Ipfs::Client.new 'http://localhost:5001'
+=> #<Ipfs::Client:0x00007fb6ec459610 @endpoint="http://localhost:5001">
+
+```
+
+### add
+#### Add a file
+
+```
+pry(main)> client.add "a.txt"
+{"Name"=>"a.txt", "Hash"=>"Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9", "Size"=>"10"}
+```
+
+#### Add a directory
+```
+pry(main)> client.add_dir "~/ipfs"
+=> [{"Name"=>"ipfs/sub/txt.txt", "Hash"=>"QmVpJWKCh3QbJYGWyPXXBY4t95B89uEMNT7VUoD2JtkpH9", "Size"=>"12"},
+ {"Name"=>"ipfs/xx.txt", "Hash"=>"QmUFgREzM1tEKTvUHdo5hTQhxn9j1qHM1ZwR4u8e8Srgji", "Size"=>"13"},
+ {"Name"=>"ipfs/sub", "Hash"=>"QmdcJi9C6Gy2yCXGhevEmuAn4o4c57PsL8Va3b22TXpBRV", "Size"=>"65"},
+ {"Name"=>"ipfs", "Hash"=>"QmVwpFxhz1HJ96DbrXhgFBxPj4RkGT5snw6pACXkVwPbSw", "Size"=>"175"}]
+```
+
+### ls
+
+```
+pry(main)> client.ls "Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9"
+=> {"Objects"=>[{"Hash"=>"Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9", "Links"=>[]}]
+```
+
+### cat
+#### Cat a file
+```
+pry(main)> client.cat "Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9"
+=> "The file content.\n"
+```
+
+#### Cat a file and write to disk
+```
+pry(main)> client.cat_to_file "Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9", "~/ipfs/a.txt"
+=> true
+```
+
+### pin rm
+```
+pry(main)> client.pin_rm "Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9"
+=> {"Pins"=>["Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9"]}
+```
+
+### pin add
+```
+pry(main)> client.pin_add "Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9"
+=> {"Pins"=>["Qmbvkmk9LFsGneteXk3G7YLqtLVME566ho6ibaQZZVHaC9"]}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/Fryie/ipfs-ruby).

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "ipfs-http-client-rb/version"
+require "ipfs-http-client-rb/commands"
+require "ipfs-http-client-rb/client"

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'ipfs-http-client-rb/commands'
+
+module Ipfs
+  class Client
+    DEFAULT_ENDPOINT = 'http://localhost:5000'.freeze
+    API_VERSION = 'v0'.freeze
+
+    attr_reader :endpoint
+
+    def self.default
+      new(DEFAULT_ENDPOINT)
+    end
+
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    def base_url
+      "#{endpoint}/api/#{API_VERSION}"
+    end
+
+    def ls(node)
+      Commands::Ls.call self, node
+    end
+
+    def cat(node)
+      Commands::Cat.call self, node
+    end
+
+    def cat_to_file(node, path)
+      Commands::CatToFile.call self, node, path
+    end
+
+    def add(file)
+      Commands::Add.call self, file
+    end
+
+    def add_dir(dir)
+      Commands::AddDir.call self, dir
+    end
+
+    def pin_rm(node, recursive: true)
+      Commands::PinRm.call self, node, recursive: recursive
+    end
+
+    def pin_add(node, recursive: true)
+      Commands::PinAdd.call self, node, recursive: recursive
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+require 'ipfs-http-client-rb/commands/base'
+require 'ipfs-http-client-rb/commands/ls'
+require 'ipfs-http-client-rb/commands/cat'
+require 'ipfs-http-client-rb/commands/cat_to_file'
+require 'ipfs-http-client-rb/commands/add'
+require 'ipfs-http-client-rb/commands/add_dir'
+require 'ipfs-http-client-rb/commands/pin_rm'
+require 'ipfs-http-client-rb/commands/pin_add'

data/lib/ipfs-http-client-rb/commands/add.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class Add < Ipfs::Commands::Base
+      def self.call(client, file)
+        response = request(client, "/add", {form: {file: HTTP::FormData::File.new(file)}})
+        parse(response.body)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client-rb/commands/add_dir.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class AddDir < Ipfs::Commands::Base
+      def self.call(client, dir)
+        root = File.dirname dir
+
+        form_files = []
+        form_files << HTTP::FormData::Part.new(
+          "",
+          content_type: 'application/x-directory',
+          filename: File.basename(dir)
+        )
+
+        Dir["#{dir}/**/*"].each do |file|
+          filename = file[(root.size + 1)..file.size]
+
+          if File.directory?(file)
+            form_files << HTTP::FormData::Part.new(
+              "",
+              content_type: 'application/x-directory',
+              filename: filename
+            )
+          else
+            form_files << HTTP::FormData::File.new(file, filename: filename)
+          end
+        end
+
+        response = request(client, "/add?recursive=true",
+                 {form: {file: form_files }})
+
+        response.body.to_s.split("\n").map { |s| JSON.parse s }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'json'
+require 'http/form_data'
+
+module Ipfs
+  module Commands
+    class Error < StandardError; end
+
+    class Base
+      def self.request(client, path_with_query, args = nil)
+        url = "#{client.base_url}#{path_with_query}"
+        response = HTTP.get(*[url, args].compact)
+        if response.code >= 200 && response.code <= 299
+          response
+        else
+          raise Error, response.body
+        end
+      end
+
+      def self.parse(str)
+        JSON.parse(str)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client-rb/commands/cat.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class Cat < Ipfs::Commands::Base
+      def self.call(client, node)
+        request(client, "/cat?arg=#{node}").to_s
+      end
+    end
+  end
+end

data/lib/ipfs-http-client-rb/commands/cat_to_file.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class CatToFile < Ipfs::Commands::Base
+      def self.call(client, node, path)
+        response = request(client, "/cat?arg=#{node}")
+
+        begin
+          file = File.open(path, 'wb')
+          while (chunk = response.body.readpartial)
+            file.write chunk
+          end
+        ensure
+          file.close if file
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/ipfs-http-client-rb/commands/ls.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class Ls < Ipfs::Commands::Base
+      def self.call(client, node)
+        response = request(client, "/ls?arg=#{node}")
+        parse(response.body)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client-rb/commands/pin_add.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class PinAdd < Ipfs::Commands::Base
+      def self.call(client, node, recursive: false)
+        response = request(client, "/pin/add?arg=#{node}&recursive=#{recursive}")
+        parse(response.body)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client-rb/commands/pin_rm.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Ipfs
+  module Commands
+    class PinRm < Ipfs::Commands::Base
+      def self.call(client, node, recursive: false)
+        response = request(client, "/pin/rm?arg=#{node}&recursive=#{recursive}")
+        parse(response.body)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ipfs
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: ipfs-http-client-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dongri Jin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.16
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Ruby HTTP client for the Interplanetary File System
+email:
+- dongrify@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ipfs-http-client-rb.rb
+- lib/ipfs-http-client-rb/client.rb
+- lib/ipfs-http-client-rb/commands.rb
+- lib/ipfs-http-client-rb/commands/add.rb
+- lib/ipfs-http-client-rb/commands/add_dir.rb
+- lib/ipfs-http-client-rb/commands/base.rb
+- lib/ipfs-http-client-rb/commands/cat.rb
+- lib/ipfs-http-client-rb/commands/cat_to_file.rb
+- lib/ipfs-http-client-rb/commands/ls.rb
+- lib/ipfs-http-client-rb/commands/pin_add.rb
+- lib/ipfs-http-client-rb/commands/pin_rm.rb
+- lib/ipfs-http-client-rb/version.rb
+homepage: https://github.com/dongri/ipfs-http-client-rb
+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.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: IPFS HTTP client
+test_files: []