biilabs-test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aec13f13de0ee724bdbda24f4626b1d6c84340fe537d94bb92ff9ffd6456945b
+  data.tar.gz: 312ef68ee19761b1a7a9066127d6adf368e5cc38e2c2d4343586c1e8d9b5fa8a
+SHA512:
+  metadata.gz: 962e9c76611d99f158b807393596bf85a16139cea1ca5f2e9b3caba21e72035aebd325dfdbf7344ef25a665b695c27d3519c5ad76692285d642d8f4e48453da2
+  data.tar.gz: a542c97c4bf68c6751dbce3f4f65581418f03617ad1ea43e3cf315e3ee0682756a77ec51aa69a7ab13f7135eca6d05afda1e2944f94377557d0aac04764dfdeb

data/lib/biilabs.rb

@@ -0,0 +1,10 @@
+require 'biilabs/version'
+require 'biilabs/client'
+require 'biilabs/default_tryter'
+require 'biilabs/configuration'
+require 'biilabs/base'
+
+module Biilabs
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/biilabs/base.rb

@@ -0,0 +1,8 @@
+module Biilabs
+  class Base
+    attr_accessor :config
+    def initialize(option={})
+      @config = option[:config] || Biilabs.config
+    end
+  end
+end

data/lib/biilabs/client.rb

@@ -0,0 +1,134 @@
+require 'faraday'
+require 'json'
+require 'biilabs/default_tryter.rb'
+require 'biilabs/configuration.rb'
+require 'biilabs/base.rb'
+
+# TODO : need more info about response status
+module Biilabs
+  class Client < Base
+
+    # API_HOST = 'http://node0.puyuma.org:5566'
+    SAVE_PATH = '/transaction'
+    GET_BY_ID_PATH = '/transaction'
+    GET_BY_TAG_PATH = '/tag'
+
+    def initialize(option={})
+      @show_raw_data = false
+      super(option)
+    end
+
+    def show_raw_data(show=true)
+      @show_raw_data = show
+    end
+
+    def save(tag: 'default', message:)
+      # TODO : check max length of tag & message (27 trytes)
+      # max length of message is 2187 ?
+
+      data     = biilabs_put_format(tag: tag, message: message)
+      response = http_put_tangle(data)
+      raw_data = JSON.parse(response.body)
+      info     = node_summary(raw_data)
+
+      return_result(
+        response: response,
+        info: info,
+        raw_data: raw_data
+      )
+    end
+
+    def get(node_id)
+      response = http_get_tangle(node_id)
+      raw_data = JSON.parse(response.body)
+      info     = node_summary(raw_data)
+      
+      return_result(
+        response: response,
+        info:     info,
+        raw_data: raw_data
+      )
+    end
+
+    def get_by_tag(tag)
+      tryte_tag = tryter.to_trytes(tag)
+      response  = http_tag_get_tangle(tryte_tag)
+      raw_data  = JSON.parse(response.body)
+      info      = nodes_summary(raw_data)
+      
+      return_result(
+        response: response,
+        info:     info,
+        raw_data: raw_data
+      )
+    end
+
+    private
+
+    def tryter
+      @tryter ||= DefaultTryter.new
+    end
+
+    def connection
+      @connection ||= Faraday.new(url: config.host) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger                  # log requests and responses to $stdout
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def return_result(response:, info:, raw_data:)
+      result = {
+        status: response.status,
+        info: info
+      }
+      result[:raw_data] = raw_data if @show_raw_data
+      result
+    end
+
+    def biilabs_put_format(tag: ,message:)
+      trytes_tag     = tryter.to_trytes(tag)
+      trytes_message = tryter.to_trytes(message)
+      { tag: trytes_tag, message: trytes_message }.to_json
+    end
+
+    KEY_MESSAGE = 'signature_and_message_fragment'
+    KEY_TAG     = 'tag'
+    KEY_NODE_ID = 'hash'
+    KEY_CREATED_AT = 'attachment_timestamp'
+    def node_summary(result)
+      {
+        message:    tryter.from_trytes(result[KEY_MESSAGE]),
+        tag:        tryter.from_trytes(result[KEY_TAG]),
+        node_id:    result[KEY_NODE_ID],
+        created_at: result[KEY_NODE_ID]
+      }
+    end
+
+    def nodes_summary(result_of_nodes)
+      result_of_nodes['transactions'].map do |result_of_node|
+        node_summary(result_of_node)
+      end
+    end
+
+    def http_put_tangle(trytes_data)
+      connection.post do |req|
+        req.url SAVE_PATH
+        req.headers['Content-Type'] = 'application/json'
+        req.body = trytes_data
+      end
+    end
+
+    def http_get_tangle(node_id)
+      connection.get do |req|
+        req.url "#{GET_BY_ID_PATH}/#{node_id}"
+      end
+    end
+
+    def http_tag_get_tangle(tag)
+      connection.get do |req|
+        req.url "#{GET_BY_TAG_PATH}/#{tag}"
+      end
+    end
+  end
+end

data/lib/biilabs/configuration.rb

@@ -0,0 +1,21 @@
+module Biilabs
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    yield config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.reset
+    @config = Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :host
+  end
+end

data/lib/biilabs/default_tryter.rb

@@ -0,0 +1,75 @@
+# You can write other function to map string to TRYTE_VALUES
+#
+# !!!!!!! Waring !!!!!!
+# for this map-function
+# all input chars must be a "ASCII character"
+
+module Biilabs
+  class DefaultTryter
+    TRYTE_VALUES = '9ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+    TRYTE_REGEX = /^[9A-Z]*$/
+
+    def is_string(input)
+      input.kind_of? String
+    end
+
+    def is_trytes(input)
+      is_string(input) && TRYTE_REGEX.match?(input)
+    end
+
+    # ==== biilabs format example ====
+    # raw message                      : 'p'
+    # message after method "to_trytes" : 'PC'
+    # message store on BiiLabs         : 'PC9999...999' (2187 chars)
+    #
+    # 
+    # 1. ignore 99 in method "from_trytes"
+    # 2. "output of mehtod to_trytes" is a string (even-length)
+    #    "message store on BiiLabs"   is a string (odd-length)
+    # ================================
+
+    # input must be a "ASCII character"
+    def to_trytes(input)
+      return nil if !is_string(input)
+      trytes = ''
+
+      (0...input.length).step(1) do |i|
+        char = input[i]
+        asciiValue = char.bytes.sum
+
+        # If not recognizable ASCII character, return null
+        return nil if asciiValue > 255
+
+        firstValue = asciiValue % 27
+        secondValue = (asciiValue - firstValue) / 27
+
+        trytesValue = TRYTE_VALUES[firstValue] + TRYTE_VALUES[secondValue]
+
+        trytes += trytesValue
+      end
+
+      trytes
+    end
+
+    def from_trytes(input)
+      return nil if !is_trytes(input)
+
+      outputString = ''
+
+      # "length - 1" to avoid odd-length-input
+      (0...(input.length - 1)).step(2) do |i|
+          trytes = input[i] + input[i + 1]
+          break if trytes == '99'
+
+          firstValue = TRYTE_VALUES.index(trytes[0])
+          secondValue = TRYTE_VALUES.index(trytes[1])
+
+          decimalValue = firstValue + secondValue * 27
+
+          outputString += decimalValue.chr
+      end
+
+      outputString
+    end
+  end
+end

data/lib/biilabs/version.rb

@@ -0,0 +1,3 @@
+module Biilabs
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: biilabs-test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gsx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- gsx@kdanmobile.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/biilabs.rb
+- lib/biilabs/base.rb
+- lib/biilabs/client.rb
+- lib/biilabs/configuration.rb
+- lib/biilabs/default_tryter.rb
+- lib/biilabs/version.rb
+homepage: 
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem to work with "BiiLabs" Tangle.
+test_files: []