mixin_bot 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73454c7aa2b41a3bcb812c89c807c22b8129e093a93d5df3233042fa1fadf261
-  data.tar.gz: 497f75d8c466cd19c1fc1bda4cafb7f63e721f35dfccc1e63dbe153492e32d58
+  metadata.gz: 59e234762e65de8e0858a88eaae1c25a8951076345728b20e65d2c15294fc831
+  data.tar.gz: 190b8385d4501ff7e603751670f160257f69651679cb4572f4037c4d7c955a67
 SHA512:
-  metadata.gz: cb44269fa17fba004e07bc45e2874bbcb2df562103d9f02f298a443007ee9ad693a4f50588b48f94d7e6b4927fd9ad744a3c3b8e2e61a4104a88b548392f9f40
-  data.tar.gz: f0759f23d6c2bb368026083eae14727aaca66a7608bd6b3fe39ca0d3adc1b8e3e17c979642352d56a0c2377b396f492c3a9377f6e54249e3ca3e59c2d33369cd
+  metadata.gz: 92d6704e15ce02a56e5f3451c75689b27caf6b7a782597a5535e736926c0c6090cc75d7f40d2190c29ddb32858b910f4b3f0bbcf7f295d474298258ae60c73d6
+  data.tar.gz: 19b4de6e5645793750091cb311b38ecedf5e5ba5b6fd0ffaa1916d0be9f2c5fd53a33be658e21e992fdaffe01bbeee83c500b2cb0223ea04fdcd5fda1db87270

data/lib/mixin_bot.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# third-party dependencies
 require 'English'
 require 'base64'
 require 'digest'
@@ -10,6 +11,7 @@ require 'msgpack'
 require 'open3'
 require 'openssl'
 require 'rbnacl'
+
 require_relative './mixin_bot/api'
 require_relative './mixin_bot/cli'
 require_relative './mixin_bot/version'
@@ -22,4 +24,10 @@ module MixinBot
   def self.api
     @api ||= MixinBot::API.new
   end
+
+  class HttpError < StandardError; end
+  class RequestError < StandardError; end
+  class ResponseError < StandardError; end
+  class UnauthorizedError < StandardError; end
+  class ForbiddenError < StandardError; end
 end

data/lib/mixin_bot/api.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative './client'
-require_relative './errors'
 require_relative './api/app'
+require_relative './api/asset'
 require_relative './api/attachment'
 require_relative './api/auth'
 require_relative './api/blaze'
@@ -25,9 +25,14 @@ module MixinBot
       @client_id = options[:client_id] || MixinBot.client_id
       @client_secret = options[:client_secret] || MixinBot.client_secret
       @session_id = options[:session_id] || MixinBot.session_id
-      @pin_token = Base64.urlsafe_decode64 options[:pin_token] || MixinBot.pin_token
       @client = Client.new(MixinBot.api_host || 'api.mixin.one')
       @blaze_host = MixinBot.blaze_host || 'blaze.mixin.one'
+      @pin_token =
+        begin
+          Base64.urlsafe_decode64 options[:pin_token] || MixinBot.pin_token
+        rescue StandardError
+          ''
+        end
       _private_key = options[:private_key] || MixinBot.private_key
       @private_key =
         if /^-----BEGIN RSA PRIVATE KEY-----/.match? _private_key
@@ -49,6 +54,7 @@ module MixinBot
     end
 
     include MixinBot::API::App
+    include MixinBot::API::Asset
     include MixinBot::API::Attachment
     include MixinBot::API::Auth
     include MixinBot::API::Blaze

data/lib/mixin_bot/api/app.rb

@@ -6,7 +6,7 @@ module MixinBot
       def add_favorite_app(app_id, access_token: nil)
         path = format('/apps/%<id>s/favorite', id: app_id)
 
-        access_token ||= access_token('POST', path, {})
+        access_token ||= access_token('POST', path)
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.post(path, headers: { 'Authorization': authorization })
       end
@@ -14,7 +14,7 @@ module MixinBot
       def remove_favorite_app(app_id, access_token: nil)
         path = format('/apps/%<id>s/unfavorite', id: app_id)
 
-        access_token ||= access_token('POST', path, '')
+        access_token ||= access_token('POST', path)
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.post(path, headers: { 'Authorization': authorization })
       end

data/lib/mixin_bot/api/asset.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MixinBot
+  class API
+    module Asset
+      # https://developers.mixin.one/api/alpha-mixin-network/read-assets/
+      def assets(access_token: nil)
+        path = '/assets'
+        access_token ||= access_token('GET', path, '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.get(path, headers: { 'Authorization': authorization })
+      end
+      alias read_assets assets
+
+      # https://developers.mixin.one/api/alpha-mixin-network/read-asset/
+      def asset(asset_id, access_token: nil)
+        path = format('/assets/%<asset_id>s', asset_id: asset_id)
+        access_token ||= access_token('GET', path, '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.get(path, headers: { 'Authorization': authorization })
+      end
+      alias read_asset asset
+
+      # https://developers.mixin.one/document/wallet/api/ticker
+      def ticker(asset_id, offset, access_token: nil)
+        offset = DateTime.rfc3339 offset if offset.is_a? String
+        offset = offset.rfc3339 if offset.is_a?(DateTime) || offset.is_a?(Time)
+        path = format('/ticker?asset=%<asset_id>s&offset=%<offset>s', asset_id: asset_id, offset: offset)
+        access_token ||= access_token('GET', path, '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.get(path, headers: { 'Authorization': authorization })
+      end
+      alias read_ticker ticker
+    end
+  end
+end

data/lib/mixin_bot/api/auth.rb

@@ -4,7 +4,7 @@ module MixinBot
   class API
     module Auth
       def access_token(method, uri, body = '', exp_in: 600, scp: 'FULL')
-        sig = Digest::SHA256.hexdigest(method + uri + body)
+        sig = Digest::SHA256.hexdigest(method + uri + body.to_s)
         iat = Time.now.utc.to_i
         exp = (Time.now.utc + exp_in).to_i
         jti = SecureRandom.uuid

data/lib/mixin_bot/api/conversation.rb

@@ -3,17 +3,19 @@
 module MixinBot
   class API
     module Conversation
-      def read_conversation(conversation_id)
+      def conversation(conversation_id)
         path = format('/conversations/%<conversation_id>s', conversation_id: conversation_id)
         access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_conversation conversation
 
-      def read_conversation_by_user_id(user_id)
+      def conversation_by_user_id(user_id)
         conversation_id = unique_conversation_id(user_id)
         read_conversation(conversation_id)
       end
+      alias read_conversation_by_user_id conversation_by_user_id
 
       def create_contact_conversation(user_id)
         path = '/conversations'
@@ -33,7 +35,7 @@ module MixinBot
         client.post(path, headers: { 'Authorization': authorization }, json: payload)
       end
 
-      def unique_conversation_id(user_id, opponent_id = nil)
+      def unique_uuid(user_id, opponent_id = nil)
         opponent_id ||= client_id
         md5 = Digest::MD5.new
         md5 << [user_id, opponent_id].min
@@ -53,6 +55,7 @@ module MixinBot
           fifth: hex[20..]
         )
       end
+      alias unique_conversation_id unique_uuid
     end
   end
 end

data/lib/mixin_bot/api/me.rb

@@ -4,12 +4,13 @@ module MixinBot
   class API
     module Me
       # https://developers.mixin.one/api/beta-mixin-message/read-profile/
-      def read_me(access_token: nil)
+      def me(access_token: nil)
         path = '/me'
         access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_me me
 
       # https://developers.mixin.one/api/beta-mixin-message/update-profile/
       # avatar_base64:
@@ -25,29 +26,14 @@ module MixinBot
         client.post(path, headers: { 'Authorization': authorization }, json: payload)
       end
 
-      # https://developers.mixin.one/api/alpha-mixin-network/read-assets/
-      def read_assets(access_token: nil)
-        path = '/assets'
-        access_token ||= access_token('GET', path, '')
-        authorization = format('Bearer %<access_token>s', access_token: access_token)
-        client.get(path, headers: { 'Authorization': authorization })
-      end
-
-      # https://developers.mixin.one/api/alpha-mixin-network/read-asset/
-      def read_asset(asset_id, access_token: nil)
-        path = format('/assets/%<asset_id>s', asset_id: asset_id)
-        access_token ||= access_token('GET', path, '')
-        authorization = format('Bearer %<access_token>s', access_token: access_token)
-        client.get(path, headers: { 'Authorization': authorization })
-      end
-
       # https://developers.mixin.one/api/beta-mixin-message/friends/
-      def read_friends(access_token: nil)
+      def friends(access_token: nil)
         path = '/friends'
         access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_friends friends
     end
   end
 end

data/lib/mixin_bot/api/multisig.rb

@@ -119,19 +119,19 @@ module MixinBot
 
       # pay to the multisig address
       # used for create multisig payment code_id
-      def create_multisig_payment(params)
+      def create_multisig_payment(**kwargs)
         path = '/payments'
         payload = {
-          asset_id: params[:asset_id],
-          amount: params[:amount].to_s,
-          trace_id: params[:trace_id] || SecureRandom.uuid,
-          memo: params[:memo],
+          asset_id: kwargs[:asset_id],
+          amount: kwargs[:amount].to_s,
+          trace_id: kwargs[:trace_id] || SecureRandom.uuid,
+          memo: kwargs[:memo],
           opponent_multisig: {
-            receivers: params[:receivers],
-            threshold: params[:threshold]
+            receivers: kwargs[:receivers],
+            threshold: kwargs[:threshold]
           }
         }
-        access_token = params[:access_token]
+        access_token = kwargs[:access_token]
         access_token ||= access_token('POST', path, payload.to_json)
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.post(path, headers: { 'Authorization': authorization }, json: payload)
@@ -166,37 +166,37 @@ module MixinBot
       end
 
       # filter utxo by members, asset_id and threshold
-      def filter_utxos(params)
-        utxos = all_multisigs(access_token: params[:access_token])
+      def filter_utxos(**kwargs)
+        utxos = all_multisigs(access_token: kwargs[:access_token])
 
-        unless params[:members].nil?
+        unless kwargs[:members].nil?
           utxos = utxos.filter(
             &lambda { |utxo|
-              utxo['members'].sort == params[:members].sort
+              utxo['members'].sort == kwargs[:members].sort
             }
           )
         end
 
-        unless params[:asset_id].nil?
+        unless kwargs[:asset_id].nil?
           utxos = utxos.filter(
             &lambda { |utxo|
-              utxo['asset_id'] == params[:asset_id]
+              utxo['asset_id'] == kwargs[:asset_id]
             }
           )
         end
 
-        unless params[:threshold].nil?
+        unless kwargs[:threshold].nil?
           utxos = utxos.filter(
             &lambda { |utxo|
-              utxo['threshold'] == params[:threshold]
+              utxo['threshold'] == kwargs[:threshold]
             }
           )
         end
 
-        unless params[:state].nil?
+        unless kwargs[:state].nil?
           utxos = utxos.filter(
             &lambda { |utxo|
-              utxo['state'] == params[:state]
+              utxo['state'] == kwargs[:state]
             }
           )
         end
@@ -204,7 +204,7 @@ module MixinBot
         utxos
       end
 
-      # params:
+      # kwargs:
       # {
       #   senders: [ uuid ],
       #   receivers: [ uuid ],
@@ -214,16 +214,16 @@ module MixinBot
       #   amount: string / float,
       #   memo: string,
       # }
-      def build_raw_transaction(params)
-        senders        = params[:senders]
-        receivers      = params[:receivers]
-        asset_id       = params[:asset_id]
-        asset_mixin_id = params[:asset_mixin_id]
-        amount         = params[:amount]
-        memo           = params[:memo]
-        threshold      = params[:threshold]
-        access_token   = params[:access_token]
-        utxos          = params[:utxos]
+      def build_raw_transaction(kwargs)
+        senders        = kwargs[:senders]
+        receivers      = kwargs[:receivers]
+        asset_id       = kwargs[:asset_id]
+        asset_mixin_id = kwargs[:asset_mixin_id]
+        amount         = kwargs[:amount]
+        memo           = kwargs[:memo]
+        threshold      = kwargs[:threshold]
+        access_token   = kwargs[:access_token]
+        utxos          = kwargs[:utxos]
 
         raise 'access_token required!' if access_token.nil? && !senders.include?(client_id)
 
@@ -261,15 +261,21 @@ module MixinBot
 
         outputs = []
         output0 = create_output(receivers: receivers, index: 0)['data']
-        output0['amount'] = format('%<amount>.8f', amount: amount)
-        output0['script'] = build_threshold_script(receivers.length)
-        outputs << output0
+        outputs << {
+          'amount': format('%<amount>.8f', amount: amount),
+          'script': build_threshold_script(receivers.length),
+          'mask': output0['mask'],
+          'keys': output0['keys']
+        }
 
         if input_amount > amount
           output1 = create_output(receivers: senders, index: 1)['data']
-          output1['amount'] = format('%<amount>.8f', amount: input_amount - amount)
-          output1['script'] = build_threshold_script(utxos[0]['threshold'].to_i)
-          outputs << output1
+          outputs << {
+            'amount': format('%<amount>.8f', amount: input_amount - amount),
+            'script': build_threshold_script(threshold.to_i),
+            'mask': output1['mask'],
+            'keys': output1['keys']
+          }
         end
 
         extra = Digest.hexencode memo.to_s.slice(0, 140)

data/lib/mixin_bot/api/snapshot.rb

@@ -3,7 +3,7 @@
 module MixinBot
   class API
     module Snapshot
-      def read_network_snapshots(options = {})
+      def network_snapshots(options = {})
         path = format(
           '/network/snapshots?limit=%<limit>s&offset=%<offset>s&asset=%<asset>s&order=%<order>s',
           limit: options[:limit],
@@ -16,8 +16,9 @@ module MixinBot
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_network_snapshots network_snapshots
 
-      def read_snapshots(options = {})
+      def snapshots(options = {})
         path = format(
           '/snapshots?limit=%<limit>s&offset=%<offset>s&asset=%<asset>s',
           limit: options[:limit],
@@ -29,14 +30,16 @@ module MixinBot
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_snapshots snapshots
 
-      def read_network_snapshot(snapshot_id, options = {})
+      def network_snapshot(snapshot_id, options = {})
         path = format('/network/snapshots/%<snapshot_id>s', snapshot_id: snapshot_id)
 
         access_token = options[:access_token] || access_token('GET', path)
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_network_snapshot network_snapshot
     end
   end
 end

data/lib/mixin_bot/api/transfer.rb

@@ -3,7 +3,10 @@
 module MixinBot
   class API
     module Transfer
-      def create_transfer(pin, options, access_token: nil)
+      TRANSFER_ARGUMENTS = %i[asset_id opponent_id amount].freeze
+      def create_transfer(pin, options = {})
+        raise ArgumentError, "#{TRANSFER_ARGUMENTS.join(', ')} are needed for create transfer" unless TRANSFER_ARGUMENTS.all? { |param| options.keys.include? param }
+
         asset_id = options[:asset_id]
         opponent_id = options[:opponent_id]
         amount = options[:amount]
@@ -21,17 +24,19 @@ module MixinBot
           memo: memo
         }
 
+        access_token = options[:access_token]
         access_token ||= access_token('POST', path, payload.to_json)
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.post(path, headers: { 'Authorization': authorization }, json: payload)
       end
 
-      def read_transfer(trace_id, access_token: nil)
+      def transfer(trace_id, access_token: nil)
         path = format('/transfers/trace/%<trace_id>s', trace_id: trace_id)
         access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
+      alias read_transfer transfer
     end
   end
 end

data/lib/mixin_bot/client.rb

@@ -29,17 +29,42 @@ module MixinBot
       begin
         response = HTTP.timeout(connect: 5, write: 5, read: 5).request(verb, uri, options)
       rescue HTTP::Error => e
-        raise Errors::HttpError, e.message
+        raise HttpError, e.message
       end
 
-      raise Errors::APIError.new(nil, response.to_s) unless response.status.success?
+      raise RequestError.new(nil, response.to_s) unless response.status.success?
 
       parse_response(response) do |parse_as, result|
         case parse_as
         when :json
-          break result if result[:errcode].nil? || result[:errcode].zero?
+          if result['error'].nil?
+            result.merge! result['data'] if result['data'].is_a? Hash
+            break result
+          end
 
-          raise Errors::APIError.new(result[:errcode], result[:errmsg])
+          errmsg = "errcode: #{result['error']['code']}, errmsg: #{result['error']['description']}"
+
+          # status code description
+          # 202	400	The request body can’t be pasred as valid data.
+          # 202	401	Unauthorized.
+          # 202	403	Forbidden.
+          # 202	404	The endpoint is not found.
+          # 202	429	Too Many Requests.
+          # 202	10006	App update required.
+          # 202	20116	The group chat is full.
+          # 500	500	Internal Server Error.
+          # 500	7000	Blaze server error.
+          # 500	7001	The blaze operation timeout.
+          case result['error']['code']
+          when 401
+            raise UnauthorizedError, errmsg
+          when 403, 20116
+            raise ForbiddenError, errmsg
+          when 400, 404, 429, 10006, 20133, 500, 7000, 7001
+            raise ResponseError, errmsg
+          else
+            raise ResponseError, errmsg
+          end
         else
           result
         end

data/lib/mixin_bot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MixinBot
-  VERSION = '0.3.3'
+  VERSION = '0.3.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixin_bot
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.8
 platform: ruby
 authors:
 - an-lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +233,7 @@ files:
 - lib/mixin_bot.rb
 - lib/mixin_bot/api.rb
 - lib/mixin_bot/api/app.rb
+- lib/mixin_bot/api/asset.rb
 - lib/mixin_bot/api/attachment.rb
 - lib/mixin_bot/api/auth.rb
 - lib/mixin_bot/api/blaze.rb
@@ -237,7 +252,6 @@ files:
 - lib/mixin_bot/cli/multisig.rb
 - lib/mixin_bot/cli/node.rb
 - lib/mixin_bot/client.rb
-- lib/mixin_bot/errors.rb
 - lib/mixin_bot/version.rb
 homepage: https://github.com/an-lee/mixin_bot
 licenses:

data/lib/mixin_bot/errors.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module MixinBot
-  module Errors
-    # 通用异常
-    Error = Class.new(StandardError)
-
-    # HTTP 异常，比如请求超时等
-    HttpError = Class.new(Error)
-
-    # API 异常，比如返回失败状态码
-    class APIError < Error
-      attr_reader :errcode, :errmsg
-
-      def initialize(errcode, errmsg)
-        @errcode = errcode
-        @errmsg = errmsg
-
-        super(format('[%<errcode>s]: %<errmsg>s', errcode: @errcode, errmsg: @errmsg))
-      end
-    end
-  end
-end