biilabs-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 752b4cba9ae435509057658bcac856920171db3f0612ee5cc941e1e3bf37afd2
+  data.tar.gz: 989ff275b67bac0ad9e79a17884436aa1a00292ab9322725b011ea36306aef90
+SHA512:
+  metadata.gz: fca5cb12d477189f54b2765291bf21fcdddf005a492804c795be91e56a529d4eb67d86178a92e2705c6cc967320bc7d306d2a2b9d8064a660b4bce856d2d797c
+  data.tar.gz: 10fe5ce8262492fb95114dad535fe179cad239af49c4354094f30eb43f6c8e9c4ac26749c802044e145533015bcfbe6310cceb51a26eefa836082959d4161fb5

data/README.md

@@ -0,0 +1,64 @@
+# Biilabs Client
+
+To post/get tangles on IoTA
+
+## Install
+
+from console
+
+    gem install biilabs-client
+
+with bundler, write follwing line in your Gemfile
+
+    gem 'biilabs-client'
+
+## Usage
+setup endpoint in config/biilabs-client.yml
+check config/secret-keeper_example.yml for example
+
+
+require on demand
+
+    irb> require 'biilabs-client'
+
+convert string to trytes
+
+    irb> "Hello World".to_trytes.value
+    # "RBTC9D9DCDEAFCCDFD9DSC"
+
+convert trytes string to normal string
+
+    irb> Trytes.new("RBTC9D9DCDEAFCCDFD9DSC").to_string
+    # "Hello World"
+
+post tangle to IoTA via Biilabs
+
+    irb> BiilabsClient.new.post_tangle('my tag', 'my message')
+    # {
+    #   "hash"=>"LTSDZIYLKSLQHCOZPHWWCNUNSFZCVLTZELARIONAGR9RGY9ZXC9J9AYHUZMGEODZXI9AOMJ9PCKB99999",
+    #   "signature_and_message_fragment"=>"ADMDEAADTCGDGDPCVCTC9999...",
+    #   "tag"=>"ADMDEAHDPCVC999999999999999",
+    #   ...
+    # }
+
+get tangle from IoTA via Biilabs
+
+    irb> BiilabsClient.new.get_tangle('LTSDZIYLKSLQHCOZPHWWCNUNSFZCVLTZELARIONAGR9RGY9ZXC9J9AYHUZMGEODZXI9AOMJ9PCKB99999')
+    # {
+    #   "hash"=>"LTSDZIYLKSLQHCOZPHWWCNUNSFZCVLTZELARIONAGR9RGY9ZXC9J9AYHUZMGEODZXI9AOMJ9PCKB99999",
+    #   "signature_and_message_fragment"=>"ADMDEAADTCGDGDPCVCTC9999...",
+    #   "tag"=>"ADMDEAHDPCVC999999999999999",
+    #   ...
+    # }
+
+
+get tangles by tag from IoTA via Biilabs
+
+    irb> BiilabsClient.new.get_tangle_by_tag('ADMDEAHDPCVC999999999999999')
+    # {
+    #   "transactions"=>[{
+    #   "hash"=>"LTSDZIYLKSLQHCOZPHWWCNUNSFZCVLTZELARIONAGR9RGY9ZXC9J9AYHUZMGEODZXI9AOMJ9PCKB99999",
+    #   "signature_and_message_fragment"=>"ADMDEAADTCGDGDPCVCTC9999...",
+    #   "tag"=>"ADMDEAHDPCVC999999999999999",
+    #   ...}]
+    # }

data/lib/biilabs_client.rb

@@ -0,0 +1,106 @@
+class BiilabsClient
+  attr_reader :config
+
+  def initialize
+    config_path = 'config/biilabs-client.yml'
+    env = ENV['RAILS_ENV'] || 'development'
+    string = File.open(config_path, 'rb') { |f| f.read }
+    fail "#{config_path} not existed nor not readable" if string.nil?
+    @config = YAML.load(string)[env]
+    fail "#{config_path} incorrect or environment not exist" if @config.nil?
+  end
+
+  def post_tangle(tag, message)
+    path = '/transaction'
+    body = {
+      tag: tag.to_trytes.value,
+      message: message
+    }
+    resp = connection.post do |req|
+      req.url path
+      req.headers['Content-Type'] = 'application/json'
+      req.body = body.to_json
+    end
+    response_handler(resp)
+  end
+
+  def get_tangle(tangle_id)
+    path = "/transaction/#{tangle_id}"
+    resp = connection.get(path)
+    response_handler(resp)
+  end
+
+  def get_tangle_by_tag(tag)
+    path = "/tag/#{tag}"
+    resp = connection.get(path)
+    response_handler(resp)
+  end
+
+  private
+
+  def connection
+    @connection ||= Faraday.new(url: config['endpoint']) 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 response_handler(resp)
+    if resp.status == 200
+      JSON.load(resp.body)
+    else
+      { status: resp.status, body: resp.body }
+    end
+  end
+end
+
+class String
+  def to_trytes
+    Trytes.new(self)
+  end
+end
+
+class Trytes
+  attr_reader :value
+
+  def initialize(string)
+    @value = string
+    return if trytes?
+    @value = ''
+    string.each_char do |char|
+      asciiValue = char.unpack('c*').first
+      return if asciiValue > 255
+      firstValue = asciiValue % 27
+      secondValue = (asciiValue - firstValue) / 27
+      tryte = trytes_chars[firstValue] + trytes_chars[secondValue]
+      @value += tryte
+    end
+  end
+
+  def to_string
+    return unless trytes?
+    string = ''
+    (0..(value.length - 1)).step(2) do |i|
+      tryte = value[i] + value[i + 1]
+      break if tryte == '99'
+      firstValue = trytes_chars.index(tryte[0])
+      secondValue = trytes_chars.index(tryte[1])
+      decimalValue = firstValue + secondValue * 27
+      string += decimalValue.chr
+    end
+    string
+  end
+
+  private
+
+  def trytes_chars
+    '9ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  end
+
+  def trytes?
+    return false unless value.kind_of? String
+    return false unless /^[9A-Z]*$/.match(value)
+    true
+  end
+end

data/spec/biilabs_client_spec.rb

@@ -0,0 +1,32 @@
+describe BiilabsClient do
+  before(:all) do
+    @client = BiilabsClient.new
+    @tag = 'my tag'
+    @mssage = 'my document digest'
+  end
+  describe '.post_tangle' do
+    it 'should return tangle info' do
+      result = @client.post_tangle(@tag, @mssage)
+      expect(result['hash'].to_trytes.value).to eq(result['hash'])
+      expect(result['tag'].to_trytes.to_string).to eq(@tag)
+      expect(result['signature_and_message_fragment'].to_trytes.to_string).to eq(@mssage)
+    end
+  end
+
+  describe '.get_tangle' do
+    it 'should return tangle info' do
+      tangle_id = 'QTIQXETRPHVP9WNATWGT9CHEMMBVMEYJWXWQ9OCETLPFI9YEJEYFZMIQCPKGKNVPIQZNWDIS9FSEA9999'
+      result = @client.get_tangle(tangle_id)
+      expect(result['hash'].to_trytes.value).to eq(tangle_id)
+      expect(result['tag'].to_trytes.to_string).to eq(@tag)
+      expect(result['signature_and_message_fragment'].to_trytes.to_string).to eq(@mssage)
+    end
+  end
+
+  describe '.get_tangle_by_tag' do
+    it 'should return tangles with same tag' do
+      result = @client.get_tangle_by_tag(@tag.to_trytes.value)
+      expect(result['transactions'].first['tag'].to_trytes.to_string).to eq(@tag)
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: biilabs-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: Wrapper for BiiLabs APIs
+email: ray-lee@kdanmobile.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/biilabs_client.rb
+- spec/biilabs_client_spec.rb
+homepage: https://github.com/redtear1115/biilabs-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A gem to work with BiiLabs Tangle.
+test_files:
+- spec/biilabs_client_spec.rb