skynet_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f090c4c97ad8488468ba123da7dca5c76a1d58f0cac3b8a0b4c87a11d4bcde9f
+  data.tar.gz: 0e6e21eb7d267053fe89620c4357ea627e93d77c2864421f0eedb0bdb6a94538
+SHA512:
+  metadata.gz: 0cad41376522ac2e360d83a054e82bed619c8e07b201d0099837caf752d11c757be897fb991986341fdb1d962640f63467c25757a975db72283b122805ce8de2
+  data.tar.gz: 8461824f5cdfeb5d6bc78043a615a179619d659e25e2523a59a5452b75d683ef9e9946af4f4e7f5d8c2fbd439461a52b6f6ec367fa8a52759e121c3195b29f33

data/.gitignore

@@ -0,0 +1,5 @@
+.solargraph.yml
+.rvmrc
+.yardoc
+.rspec_status
+.byebug_history

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# This is the configuration used to check the rubocop source code.
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - '.git/**/*'
+    - 'bin/*'
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+
+Metrics/AbcSize:
+  Enabled: False
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sia_skynet.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'typhoeus', '~> 1.4.0'
+gem 'mimemagic', '~> 0.4.3'
+gem 'multipart_body', '~> 0.2.1'
+gem 'thor', '~> 1.1.0'
+
+group :test, :development do
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '~> 1.13.0'
+  gem 'rubocop-rspec', '~> 2.2.0'
+  gem 'byebug', require: 'byebug'
+end
+
+group :test do
+  gem "webmock", '~> 3.12.0'
+  gem 'rspec-json_expectations'
+end

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    sia_skynet (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.0)
+    hashdiff (1.0.1)
+    mimemagic (0.4.3)
+      nokogiri (~> 1)
+      rake
+    mini_portile2 (2.5.1)
+    multipart_body (0.2.1)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-json_expectations (2.2.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.13.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  mimemagic (~> 0.4.3)
+  multipart_body (~> 0.2.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rspec-json_expectations
+  rubocop (~> 1.13.0)
+  rubocop-rspec (~> 2.2.0)
+  sia_skynet!
+  thor (~> 1.1.0)
+  typhoeus (~> 1.4.0)
+  webmock (~> 3.12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Christoph Klocker
+
+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,83 @@
+# Skynet
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sia_skynet`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sia_skynet'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sia_skynet
+
+## Usage
+
+    require 'skynet'
+
+### Uploading to a Skynet portal
+
+#### Uploading a single file
+
+    client = Skynet::Client.new
+    client.upload_file '/path/to/file.pdf'
+    => "sia://ZAAZyxRQ7Ixzd3zujn1ly8RA..."
+
+    # if you want to get the full response
+    client.upload_file '/path/to/file.pdf', full_response: true
+    => {
+         "skylink"=>"ZAAZyxRQ7Ixzd3zujn1ly8RA...",
+         "merkleroot"=>"19cb1450ec8981fcc63c73777cee8e7d65cbc44",
+         "bitfield"=>100,
+         "sialink"=>"sia://ZAAZyxRQ7Ixzd3zujn1ly8RA"
+       }
+
+#### Uploading a directory:
+
+    client.upload_directory '/path/to/directory'
+
+#### Downloading a file or directory:
+
+This function downloads a skylink using HTTP streaming. The call blocks until the data is received. There is a 30s default timeout applied to downloading a skylink. If the data can not be found within this 30s time constraint, a 404 error will be returned. This timeout is configurable.
+
+A directory will be downloaded as zip file, otherwise as regular file.
+
+    client.download_file("/path/foo.zip", skylink)
+
+#### Getting Metadata
+
+Returns the metadata of an upload. Currently quite often no metadata is returned and a `Skynet::NoMetadataError` exception will be raised.
+
+    client.get_metadata "ZAAZyxRQ7ImB_...."
+
+## Progress
+
+☑ Uploading a file\
+☑ Uploading a directory\
+☑ Downloading a file\
+☑ Downloading a directory\
+☑ Getting Metadata\
+☐ SkyDB\
+☐ Registry\
+☐ MySky\
+
+## Contributing
+
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/corck/sia_skynet.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Copyright 2021, by Christoph Klocker.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'skynet'
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/skynet.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'skynet/version'
+require 'skynet/client'
+
+module Skynet
+  class Error < StandardError; end
+
+  class NoMetadataError < Skynet::Error; end
+end

data/lib/skynet/client.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'typhoeus'
+require 'multipart_body'
+require 'mimemagic'
+
+module Skynet
+  # Client for interacting with Skynet
+  #
+  # Default portal is set to https://siasky.net
+  #
+  class Client
+    DEFAULT_SKYNET_PORTAL_URL = 'https://siasky.net'
+    DEFAULT_SKYNET_PORTAL_PATH = '/skynet/skyfile'
+    URI_SKYNET_PREFIX = 'sia://'
+    DEFAULT_USER_AGENT = 'Sia-Agent'
+
+    attr_reader :user_agent
+    attr_accessor :config
+
+    # Initializes the client, allows to set a custom portal or uses siasky.net as default
+    #
+    # @param [Hash] config the configuration options to initialize the client with
+    # @option config [String] :api_key The API password used for authentication.
+    # @option config [String] :user_agent Allows changing the User Agent, as some portals may reject user agents
+    #  that are not `Sia-Agent` for security reasons.
+    # @option config [String] :on_upload_progress Optional callback to track upload progress. (Not implemented yet)
+    # @option config [String] :portal url to a custom portal, defaults to https://siasky.net
+    # @option config [String] :dirname Optional directory name on skynet
+    # @option config [Boolean] :verbose Set to true to log network requests
+
+    def initialize(custom_config = {})
+      @config = default_upload_options
+      @config.merge!(custom_config)
+      @api_key = config[:api_key] || nil
+      Typhoeus::Config.user_agent = config[:user_agent]
+      @on_upload_progress = config[:on_upload_progress]
+      Typhoeus::Config.verbose = true if custom_config[:verbose]
+    end
+
+    # Takes a file path and uploads it
+    #
+    # @param [String] file File or file path where the file is located
+    #
+    # @param [Hash] custom_opts additional upload options
+    # @option custom_opts [String] :portal_file_field_name The field name for files on the portal.
+    #   Usually should not need to be changed.
+    # @option custom_opts [String] :portal_directory_file_field_name The field name for directories on the portal.
+    #   Usually should not need to be changed.
+    # @option custom_opts [String] :filename Custom filename.
+    #   This is the filename that will be returned when downloading the file in a browser
+    # @option custom_opts [String] :custom_dirname Custom dirname. If this is empty,
+    #   the base name of the directory being uploaded will be used by default.
+    # @option custom_opts [String] :timeout_seconds Custom filename. The timeout in seconds.
+    # @option custom_opts [Boolean] :full_response Returns full hash with skylink, merkleroot and bitfield
+    #
+    # @return [String] Returns the sialink (sia://AABBCC) by default
+    # @return [Hash] Response Hash with full response from skynet including skylink, merkleroot
+    #  bitfield and sialink if :full_response option is given
+    #  @option response [String] :skylink
+    #
+    # @example Default response:
+    #  sia://KAA54bKo-YqFRj345xGXdo9h15k.....
+    #
+    # @example Full response as hash
+    #   {
+    #     "skylink"=>"KAA54bKo-YqFRjDxRxGXdo9h15k8......",
+    #     "merkleroot"=>"39e1b2a....",
+    #     "bitfield"=>40,
+    #     "sialink"=>"sia://KAA54bKo-YqFRjDxRxGXdo9h15k8...."
+    #   }
+    #
+    #
+    def upload_file(file, custom_opts = {})
+      res = upload(file, config.merge(custom_opts)).run
+
+      format_response(res, custom_opts)
+    end
+
+    def upload_directory(directory, opts = {})
+      custom_options = filter_upload_options(config.merge(opts))
+
+      multipart = prepare_multipart_body(directory)
+      header = default_headers.merge({ 'Content-Type' => "multipart/form-data; boundary=#{multipart.boundary}" })
+
+      res = Typhoeus::Request.new(
+        "#{portal}#{portal_path}",
+        method: :post,
+        params: custom_options.merge(filename: File.basename(directory)),
+        headers: header,
+        body: multipart.to_s
+      ).run
+
+      format_response(res, custom_options)
+    end
+
+    # Download a file
+    # @param [String] path The local path where the file should be downloaded to.
+    # @param [String] skylink The skylink that should be downloaded. The skylink can contain an optional path.
+    #
+    # @return [String] path Path of the downloaded file
+    def download_file(path, skylink)
+      skylink = strip_uri_prefix(skylink)
+
+      f = File.open(path, 'wb')
+      begin
+        request = Typhoeus::Request.new("#{portal}/#{skylink}", headers: default_headers)
+        request.on_headers do |response|
+          raise 'Request failed' if response.code != 200
+        end
+        request.on_body do |chunk|
+          f.write(chunk)
+        end
+        request.on_complete do |_response|
+          f.close
+        end
+        request.run
+      ensure
+        f.close
+      end
+
+      path
+    end
+
+    # Downloads the metadata of a skylink
+    #
+    # @param [String] skylink Skylink of the file
+    #
+    # @return [Hash]
+    #
+    # @example Response
+    #   {
+    #     'filename' => 'foo.pdf',
+    #     'length' => 21_977,
+    #     'subfiles' =>
+    #     { 'foo.pdf' =>
+    #       { 'filename' => 'foo.pdf',
+    #         'contenttype' => 'application/octet-stream',
+    #         'len' => 21_977 } }
+    #   }
+    def get_metadata(skylink)
+      skylink = strip_uri_prefix(skylink)
+      res = Typhoeus::Request.head(
+        "#{portal}/#{skylink}", headers: default_headers
+      )
+
+      raise Skynet::NoMetadataError, 'No metadata returned' unless res.headers['skynet-file-metadata']
+
+      JSON.parse res.headers['skynet-file-metadata']
+    end
+
+    private
+
+    # Return all files recursively, exclude directories
+    #
+    def files_to_upload(path)
+      Dir.glob("#{path}/**/*")
+         .reject { |fn| File.directory?(fn) }
+         .map do |f|
+        { path: f, relative_path: f.gsub(%r{#{path}/}, '') }
+      end
+    end
+
+    # Returns default upload options
+    def default_upload_options
+      opts = {}
+      opts[:portal] = DEFAULT_SKYNET_PORTAL_URL
+      opts[:portal_path] = DEFAULT_SKYNET_PORTAL_PATH
+      opts[:user_agent] = DEFAULT_USER_AGENT
+      opts[:portal_file_fieldname] = 'file'
+      opts[:portal_directory_file_fieldname] = 'files[]'
+      opts[:filename] = 'file'
+      opts[:dirname] = ''
+      opts
+    end
+
+    def portal_path
+      File.join(config[:portal_path], config[:dirname])
+    end
+
+    def portal
+      config[:portal]
+    end
+
+    def upload(file, opts = {})
+      custom_opts = config.merge(opts)
+      params = custom_opts.filter { |k| default_upload_options.keys.include?(k) }
+
+      begin
+        f = File.open(file, 'rb')
+
+        Typhoeus::Request.new(
+          "#{portal}#{portal_path}",
+          method: :post,
+          params: params,
+          body: {
+            file: f
+          }
+        )
+      ensure
+        f&.close
+      end
+    end
+
+    # Filter by available upload options
+    def filter_upload_options(opts)
+      opts.filter { |k| default_upload_options.keys.include?(k) }
+    end
+
+    def default_headers
+      { "User-Agent": DEFAULT_USER_AGENT }
+    end
+
+    def format_response(res, custom_opts = {})
+      json = JSON.parse res.body
+      sialink = "#{URI_SKYNET_PREFIX}#{json['skylink']}"
+
+      custom_opts[:full_response] == true ? json.merge({ 'sialink' => sialink }) : sialink
+    end
+
+    def prepare_multipart_body(directory)
+      files = files_to_upload(directory)
+
+      file_parts = files.inject([]) do |parts, file|
+        ct = MimeMagic.by_path(file[:path])&.type
+        begin
+          f = File.open(file[:path], 'r')
+          parts << Part.new(name: config[:portal_directory_file_fieldname],
+                            body: f.read,
+                            filename: file[:relative_path],
+                            content_type: ct)
+        ensure
+          f.close
+        end
+      end
+
+      MultipartBody.new(file_parts)
+    end
+
+    def strip_uri_prefix(skylink)
+      skylink.delete_prefix(URI_SKYNET_PREFIX)
+    end
+  end
+end

data/lib/skynet/version.rb

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

data/sia_skynet.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/skynet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'skynet_ruby'
+  spec.version       = Skynet::VERSION
+  spec.authors       = ['Christoph Klocker']
+  spec.email         = ['christoph@vedanova.com']
+
+  spec.summary       = 'Skynet client to interact with Sia Skynet'
+  spec.description   = 'Skynet is a decentralized storage solution built on the Sia blockchain'
+  spec.homepage      = 'https://siasky.net'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/corck/sia_skynet'
+  # spec.metadata["changelog_uri"] = "https://github.com/corck/sia_skynet"
+
+  # 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.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: skynet_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Klocker
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-06-14 00:00:00.000000000 Z
+dependencies: []
+description: Skynet is a decentralized storage solution built on the Sia blockchain
+email:
+- christoph@vedanova.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/skynet.rb
+- lib/skynet/client.rb
+- lib/skynet/version.rb
+- sia_skynet.gemspec
+homepage: https://siasky.net
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://siasky.net
+  source_code_uri: https://github.com/corck/sia_skynet
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.20
+signing_key:
+specification_version: 4
+summary: Skynet client to interact with Sia Skynet
+test_files: []