ipfs-http-client 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c484d383e82fbda6adc76d1be04f4c435b3c3fdc88dfb104137ccb6040da8bf
+  data.tar.gz: 051171d83d847886ca6324d58b4c45b994ee1f8032591fffff3a28159567f9de
+SHA512:
+  metadata.gz: 0d022faa8431d19fd449102fc96cc852cb39d2c0ffdfc4762f6e6743e0275af49e06d8ecebef30af567619866e98efd29bc2563c895d4484cc2eb289ea64424a
+  data.tar.gz: a9e7afacf2587b67d32fe9961c50c78a1397608c5ed0c5f8cd287bb306613c6a3d645c70860b6598621b31a76e9193700e46cc4280f280bbbd858666aa7ea2ce

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/.idea/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ipfs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pierpaolo Frasa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# 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'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipfs
+
+## 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"]}
+```
+
+## 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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ipfs-http-client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ipfs-http-client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ipfs-http-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ipfs-http-client'
+  spec.version       = Ipfs::VERSION
+  spec.authors       = ['Pierpaolo Frasa', 'Jingyang']
+  spec.email         = ['pfrasa@gmail.com', 'simple.continue@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'IPFS HTTP client'
+  spec.description   = 'Ruby HTTP client for the Interplanetary File System'
+  spec.homepage      = 'https://ipfs.io'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'http', '~> 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'byebug', '~> 9'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'webmock', '~> 3'
+  spec.add_development_dependency 'sinatra', '~> 2'
+end

data/lib/ipfs-http-client.rb

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

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'ipfs-http-client/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
+  end
+end

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

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

data/lib/ipfs-http-client/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 = http_get(client, "/add", {form: {file: HTTP::FormData::File.new(file)}})
+        parse(response.body)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client/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 = http_get(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/commands/base.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'json'
+require 'http/form_data'
+
+module Ipfs
+  module Commands
+    class Base
+      def self.http_get(client, path_with_query, args = nil)
+        url = "#{client.base_url}#{path_with_query}"
+        response = HTTP.get(*[url, args].compact)
+        yield response if block_given?
+        response
+      end
+
+      def self.parse(str)
+        JSON.parse(str)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client/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)
+        http_get(client, "/cat?arg=#{node}").to_s
+      end
+    end
+  end
+end

data/lib/ipfs-http-client/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)
+        http_get(client, "/cat?arg=#{node}") do |response|
+          begin
+            file = File.open(path, 'wb')
+            while (chunk = response.body.readpartial)
+              file.write chunk
+            end
+          ensure
+            file.close if file
+          end
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/ipfs-http-client/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 = http_get(client, "/ls?arg=#{node}")
+        parse(response.body)
+      end
+    end
+  end
+end

data/lib/ipfs-http-client/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 = http_get client, "/pin/rm?arg=#{node}&recursive=#{recursive}"
+        parse(response.body)
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: ipfs-http-client
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Pierpaolo Frasa
+- Jingyang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Ruby HTTP client for the Interplanetary File System
+email:
+- pfrasa@gmail.com
+- simple.continue@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ipfs-http-client.gemspec
+- lib/ipfs-http-client.rb
+- lib/ipfs-http-client/client.rb
+- lib/ipfs-http-client/commands.rb
+- lib/ipfs-http-client/commands/add.rb
+- lib/ipfs-http-client/commands/add_dir.rb
+- lib/ipfs-http-client/commands/base.rb
+- lib/ipfs-http-client/commands/cat.rb
+- lib/ipfs-http-client/commands/cat_to_file.rb
+- lib/ipfs-http-client/commands/ls.rb
+- lib/ipfs-http-client/commands/pin_rm.rb
+- lib/ipfs-http-client/version.rb
+homepage: https://ipfs.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: IPFS HTTP client
+test_files: []