ruby-skynet 1.1.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2b19582a200c85d2d1813aa2321e7727c0fdf5360e0d0a09bd300797d5cdb84
+  data.tar.gz: 399126445145634df99dc83db1448948701ed562f52759639828fbd421146849
+SHA512:
+  metadata.gz: fd7750bcc625d36ac9a17c5b4e668f3e5c148430e90dd3cfb25eadf605f2a3e8fc8413dfc48ddae661456ab3940510904a97f47d90f5bd017314d7b522f78ae8
+  data.tar.gz: 37a1d003f6776d2778881bc715c9632d07f6d0d8c99eba707d9a25b6e199b0e3a001aa79fbaf21cd3ca675f5c608e9e53ad246bfd13f0310729111195b630100

data/lib/skynet.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require_relative 'skynet/download.rb'
+require_relative 'skynet/upload.rb'
+
+# The entrypoint for the SDK
+class Skynet
+
+  # Prefix for the protocol
+  URI_SKYNET_PREFIX = 'sia://'
+
+  extend Download
+  extend Upload
+
+  # Removes the Skynet::URI_SKYNET_PREFIX constant from string
+  def self.strip_prefix(str)
+    if str.index(URI_SKYNET_PREFIX).nil?
+      str.delete_prefix(URI_SKYNET_PREFIX)
+    else
+      str
+    end
+  end
+end

data/lib/skynet/download.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'helper.rb'
+
+# Module for handling inbound requests
+module Download
+
+  # Array with http redirect & http permanent code
+  # Used to determine if the GET request should start downloading or follow redirect
+  HTTP_REDIRECT_PERMANENT = [301, 302].freeze
+  extend Helper::Download
+
+  # Download file from the skynet portal
+  # file_name & skylink is required, the rest is optional since they come with default values
+  def download_file(file_name, skylink, options = {}, stream = true)
+    options = Helper::Download.default_options
+    options = Helper::Download.default_options.merge(options) unless options.empty?
+
+    portal  = options[:portal_url]
+    skylink = Skynet.strip_prefix(skylink)
+    url = "#{portal}#{skylink}?attachment=#{options[:download]}"
+
+    File.open(file_name, 'w') do |file|
+      HTTParty.get(url, follow_redirects: true, stream_body: stream) do |chunk|
+        file << chunk unless HTTP_REDIRECT_PERMANENT.include? chunk.code
+      end
+    end
+
+    'Download successful!'
+  end
+end

data/lib/skynet/helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Class with general settings
+module Helper
+
+  # The default skynet portal
+  PORTAL_URL = 'https://siasky.net/'
+
+  # Module for keeping download settings
+  module Download
+
+    # Default options for the download module
+    def self.default_options
+      {
+        portal_url: Helper::PORTAL_URL,
+        download: true
+      }
+    end
+  end
+
+  # Module for keeping upload settings
+  module Upload
+
+    # Default options for the upload module
+    def self.default_options
+      {
+        portal_url: Helper::PORTAL_URL,
+        portal_upload_path: 'skynet/skyfile',
+        portal_file_fieldname: 'file',
+        portal_directory_fieldname: 'files[]',
+        custom_filename: nil,
+      }
+    end
+  end
+end

data/lib/skynet/upload.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative 'helper.rb'
+
+# Module for handling outbound requests
+module Upload
+  extend Helper::Upload
+
+  # Default headers provided for uploading files,
+  # any argument provided is merged with the default values
+  def http_post_header(data = {})
+    default_data = {
+      headers: {
+        'Accept' => 'application/octet-stream',
+        'Content-Type' => 'application/octet-stream',
+        'Transfer-Encoding' => 'gzip, chunked'
+      }
+    }
+
+    default_data.merge(data) unless data.empty?
+  end
+
+  # Uploads file to the skynet, file_path is required but options are optional since default values are provided
+  def upload_file(file_path, options = {})
+    options = Helper::Upload.default_options
+    options = Helper::Upload.default_options.merge(options) unless options.empty?
+    return "File #{file_path} does not exist!" unless File.exist?(file_path)
+
+    host = options[:portal_url]
+    path = options[:portal_upload_path]
+    filename = options[:custom_filename] || file_path
+
+    url = "#{host}#{path}?filename=#{filename}"
+    binary_content = IO.read(file_path, mode: 'rb')
+
+    header_data = http_post_header({
+      headers: {
+        'Content-Disposition' => 'attachment; filename="#{filename}"'
+      },
+      body: binary_content,
+      options[:portal_file_fieldname] => filename
+    })
+
+    upload_request = HTTParty.post(url, header_data)
+    parsed_request = upload_request.to_hash
+    "Upload successful, skylink: " + parsed_request['skylink']
+  end
+
+  # Still work in progress
+  # Uploads a whole directory to the skynet
+  # def upload_directory(directory_path, options = {})
+  #   options = Helper::Upload.default_options
+  #   options = Helper::Upload.default_options.merge(options) unless options.empty?
+  #   return "Given path is not a directory!" unless Dir.exist?(directory_path)
+
+  #   directory_entries = Dir.glob("#{directory_path}/*")
+
+  #   binary_content = IO.read(filename, mode: 'rb')
+
+  #  header_data = http_post_header({
+  #    headers: {
+  #      'Content-Disposition' => 'attachment; ' + filename
+  #    },
+  #    body: binary_content,
+  #    options[:portal_directory_fieldname] => filename
+  #  })
+
+  #   host = options[:portal_url]
+  #   path = options[:portal_upload_path]
+  #   dir_name = options[:custom_filename] || directory_path
+  #   url = "#{host}#{path}?filename=#{dir_name}"
+
+  #   upload_request = HTTParty.post(url, header_data)
+  #   parsed_request = upload_request.to_hash
+  #   "Upload successful, skylink: " + parsed_request['skylink']
+  # end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ruby-skynet
+version: !ruby/object:Gem::Version
+  version: 1.1.15
+platform: ruby
+authors:
+- beyarz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+description: Ruby gem for integrating Sias Skynet into Ruby apps
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/skynet.rb
+- lib/skynet/download.rb
+- lib/skynet/helper.rb
+- lib/skynet/upload.rb
+homepage: https://rubygems.org/gems/sia-skynet
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/beyarz/sia-skynet
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Sia skynet gem
+test_files: []