https://github.com/tomibennett/ruby-ipfs-http-client

A client library for the IPFS HTTP API, implemented in Ruby.
https://github.com/tomibennett/ruby-ipfs-http-client

api api-client client ipfs

Last synced: 3 months ago
JSON representation

A client library for the IPFS HTTP API, implemented in Ruby.

• Host: GitHub
• URL: https://github.com/tomibennett/ruby-ipfs-http-client
• Owner: tomibennett
• License: mit
• Created: 2017-05-27T13:28:03.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-01T16:52:25.000Z (about 1 year ago)
• Last Synced: 2025-01-26T20:33:27.770Z (3 months ago)
• Topics: api, api-client, client, ipfs
• Language: Ruby
• Homepage:
• Size: 158 KB
• Stars: 29
• Watchers: 3
• Forks: 8
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Gem Version](https://badge.fury.io/rb/ruby-ipfs-http-client.svg)](https://badge.fury.io/rb/ruby-ipfs-http-client)

[![Build Status](https://travis-ci.org/tbenett/ruby-ipfs-http-client.svg?branch=master)](https://travis-ci.org/tbenett/ruby-ipfs-http-client)

# ruby-ipfs-http-client

> A client library for the IPFS HTTP API, implemented in Ruby.

Summary:

Make sure the Ipfs daemon is running, otherwise

the client will not be able to connect.

You'll get an error `Ipfs::UnreachableDaemon` and the program

execution will stop if daemon is not present.

The client will make a persistent connection to the API.

To access the library from your source file:

```ruby

require 'ipfs'

```

> TODO: use a configuration file and/or environment variables to specify the http http-client url.

Those are hard-coded at the moment :(

## Ipfs::File

This class is intended to manipulate files through Ipfs.

Methods are documented [here](https://www.rubydoc.info/gems/ruby-ipfs-http-client/Ipfs/File)

# Want to Contribute

You can have an overview of the library's design in [CONTRIBUTING.md](./CONTRIBUTING.md).