filecoin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d03183ddc001622fb243e928ca9258cb3c8771439b9dbfdb745146e3d5197b31
+  data.tar.gz: 3f3e4cc8ca7a6bd4eef92dcb0055849147bd8c67ba730648a72a13b51f0410e5
+SHA512:
+  metadata.gz: ccd108d4b698c768f773c912cce6b14802ccd7b3d21e084b75c4ba0ff394b43329c21d7c1c48576ceec70ffee11727dd8debd9413343f1224716415fed3083c8
+  data.tar.gz: 1b736355b8757696ab368d4815bdf263d0a3414c04cbc2c6453a686bf0f1aa1deca77756a8b9f184adee877a5872ecac26bbf52163dbc37d52811fde563b5099

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,99 @@
+inherit_mode:
+  merge:
+    - Include
+    - Exclude
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7.1
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Naming/PredicateName:
+  ForbiddenPrefixes:
+    - is_
+    - have_
+
+# `described_class` makes tests harder to read. When using tools that allow
+# jumping between definitions and the respective tests in a Rails project, or
+# using global search, the class `described_class` refers to might not be clear
+# to the reader. By avoiding the shortcut, we make sure the test stands on its
+# own with as much information as possible.
+RSpec/DescribedClass:
+  Enabled: false
+
+# Examples should be informative and explicit. While longer examples are
+# generally hard to read, the value should be adjusted as reasonable for a
+# project.
+RSpec/ExampleLength:
+  Max: 10
+
+# Examples should focus on testing one thing, but that does not necessarily
+# translate into a single expectation. For instance, testing validations in
+# a Rails model should assert (1) the model is invalid, (2) the model has
+# validation errors, and (3) these errors not only include the target field
+# but also the target error message. Another example would be testing
+# side-effects are contained.
+#
+# Similarly, not limiting the number of expectations in an example invites
+# colaborators (and consequently reviewers) to forget the rule of testing one
+# thing only, or to simply ignore it due over the "simplicity" and comfort of
+# checking for everything in a single test.
+#
+# Therefore, this cop should remain enabled, but its value should be adjusted 
+# as reasonable for the project.
+#
+RSpec/MultipleExpectations:
+  Max: 3
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog], and this project adheres to
+[Semantic Versioning].
+
+
+Unreleased
+----------
+
+- Add `Filecoin::Client` with `#chain_head` matching the `Filecoin.ChainHead`
+  method in the Filecoin Lotus Node API.
+
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
+

data/Gemfile

@@ -0,0 +1,15 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in filecoin.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+
+group :test do
+  gem "faker", "~> 2.12"
+  gem "permafrost", "~> 1.0"
+  gem "rspec", "~> 3.0"
+  gem "rubocop", "~> 0.84.0"
+  gem "rubocop-performance", "~> 1.6.0"
+  gem "rubocop-rspec", "~> 1.39.0"
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    filecoin (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    faker (2.12.0)
+      i18n (>= 1.6, < 2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    permafrost (1.0.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-performance (1.6.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker (~> 2.12)
+  filecoin!
+  permafrost (~> 1.0)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.84.0)
+  rubocop-performance (~> 1.6.0)
+  rubocop-rspec (~> 1.39.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Subvisual, Lda
+
+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,97 @@
+filecoin-ruby
+=============
+
+Interface to the Filecoin network APIs in Ruby.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "filecoin", "~> 0.1.0"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install filecoin
+
+
+Usage
+-----
+
+Clients are initialized with the URI to the target API server. This URI can be
+provided as a `URI` object, or as a `String`. If omitted, `Filecoin::Client`
+defaults to the value of the `FILECOIN_URL` environment variable.
+
+```ruby
+# with a URI object
+Filecoin::Client.new(uri: URI("https://filecoin.example.com:1234"))
+
+# with a String
+Filecoin::Client.new(uri: "https://filecoin.example.com:1234")
+
+# from the FILECOIN_URL environment variable
+Filecoin::Client.new
+```
+
+For each available method in the [Filecoin Node API] use the respective method
+in `Filecoin::Client`. For instance, to call `Filecoin.ChainHead` use
+`Filecoin::Client#chain_head`.
+
+```ruby
+client = Filecoin::Client.new
+client.chain_head # => => {"jsonrpc"=>"2.0", "result"=>{...}, ...}
+```
+
+All methods return the server's JSON parsed response as a plain `Hash`.
+
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake` to run the linter and 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].
+
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/subvisual/filecoin-ruby.
+
+
+License
+-----
+
+filecoin-ruby is copyright © 2020 Subvisual, Lda.
+
+It is open-source, made available for free, and is subject to the terms in
+its [license].
+
+
+About
+-----
+
+filecoin-ruby was created and is maintained with :heart: by
+[Subvisual][subvisual].
+
+[![Subvisual][subvisual-logo]][subvisual]
+
+
+[license]: ./LICENSE.txt
+[rubygems.org]: https://rubygems.org
+[subvisual]: http://subvisual.com
+[subvisual-logo]: https://raw.githubusercontent.com/subvisual/guides/master/github/templates/logos/blue.png
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
+
+task default: %i[lint spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "filecoin"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+# Exit if any command fails
+set -e
+
+# Install the required languages
+asdf install
+asdf reshim
+
+# Install the Ruby dependencies
+bundle install

data/filecoin.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/filecoin/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "filecoin"
+  spec.version       = Filecoin::VERSION
+  spec.authors       = ["Pedro Costa"]
+  spec.email         = ["pedro@subvisual.co"]
+
+  spec.summary       = "Interact with the Filecoin network"
+  spec.description   = <<~DESCRIPTION
+    Filecoin (https://filecoin.io/) is a distributed storage network based on a
+    blockchain mechanism.  Filecoin miners provide storage capacity for the
+    network, earning FIL by periodically prooving the specified capacity is
+    provided to the network.
+
+    The Filecoin blockchain maintains the ledger for FIL transactions, and
+    implements the Filecoin VM for the execution of contracts and market
+    mechanisms. These include storage deals, where clients pay miners to store
+    data in the network.
+
+    This gem makes use of the JSON RPC API made available by Lotus
+    (https://lotu.sh/), the official implementation of the network.
+  DESCRIPTION
+  spec.homepage = "https://github.com/subvisual/filecoin-ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/subvisual/filecoin-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/subvisual/filecoin-ruby/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.start_with?("spec/") }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/filecoin.rb

@@ -0,0 +1,4 @@
+require "filecoin/version"
+
+module Filecoin
+end

data/lib/filecoin/client.rb

@@ -0,0 +1,38 @@
+require "filecoin/client/node"
+require "filecoin/http"
+
+module Filecoin
+  class Client
+    include Filecoin::Client::Node
+
+    attr_reader :uri
+
+    def initialize(uri: nil)
+      @uri = initialize_uri(uri)
+    end
+
+    private
+
+    def initialize_uri(uri)
+      uri ||= ENV["FILECOIN_URL"]
+
+      return if uri.nil?
+
+      URI(uri)
+    end
+
+    def json_rpc_call(method, *params)
+      @json_rpc_call_id ||= 0
+      @json_rpc_call_id += 1
+
+      body = {
+        jsonrpc: "2.0",
+        method: method,
+        params: params,
+        id: @json_rpc_call_id,
+      }
+
+      Http.post(uri, body)
+    end
+  end
+end

data/lib/filecoin/client/node.rb

@@ -0,0 +1,9 @@
+module Filecoin
+  class Client
+    module Node
+      def chain_head
+        json_rpc_call "Filecoin.ChainHead"
+      end
+    end
+  end
+end

data/lib/filecoin/http.rb

@@ -0,0 +1,29 @@
+require "json"
+require "net/http"
+
+module Filecoin
+  module Http
+    module ClassMethods
+      def post(uri, data)
+        return if uri.nil?
+
+        req = Net::HTTP::Post.new(uri)
+        req["Content-Type"] = "application/json"
+        req.body = data.to_json
+
+        response = request(req)
+        JSON.parse(response.body)
+      end
+
+      def request(request)
+        uri = request.uri
+
+        return if uri.nil?
+
+        Net::HTTP.new(uri.host, uri.port).request(request)
+      end
+    end
+
+    extend ClassMethods
+  end
+end

data/lib/filecoin/version.rb

@@ -0,0 +1,3 @@
+module Filecoin
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: filecoin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Costa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-04 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Filecoin (https://filecoin.io/) is a distributed storage network based on a
+  blockchain mechanism.  Filecoin miners provide storage capacity for the
+  network, earning FIL by periodically prooving the specified capacity is
+  provided to the network.
+
+  The Filecoin blockchain maintains the ledger for FIL transactions, and
+  implements the Filecoin VM for the execution of contracts and market
+  mechanisms. These include storage deals, where clients pay miners to store
+  data in the network.
+
+  This gem makes use of the JSON RPC API made available by Lotus
+  (https://lotu.sh/), the official implementation of the network.
+email:
+- pedro@subvisual.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- filecoin.gemspec
+- lib/filecoin.rb
+- lib/filecoin/client.rb
+- lib/filecoin/client/node.rb
+- lib/filecoin/http.rb
+- lib/filecoin/version.rb
+homepage: https://github.com/subvisual/filecoin-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/subvisual/filecoin-ruby
+  source_code_uri: https://github.com/subvisual/filecoin-ruby
+  changelog_uri: https://github.com/subvisual/filecoin-ruby/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Interact with the Filecoin network
+test_files: []