mixin_bot 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed2fac4118078dffd141f4147ffd7dfea3bc529180cea2a6136622ceafe1b70b
-  data.tar.gz: cd147227f703ecb292819e137cf6c625563bb339fc7da996a2adbc1db0cc466a
+  metadata.gz: 59e234762e65de8e0858a88eaae1c25a8951076345728b20e65d2c15294fc831
+  data.tar.gz: 190b8385d4501ff7e603751670f160257f69651679cb4572f4037c4d7c955a67
 SHA512:
-  metadata.gz: 982f3caa95756397116ea9c3a559f574dc1881be80325d02961c2f8f62943273726714d54f5bf019d4d599be31f8200637822b5f0229a0857253e62add6f69ce
-  data.tar.gz: 2f433ee6e767e1c8a3176f55c8806687dbae560cc4376ca9f2b110644fe444976a209e81f9dab475a1ed28068ac351ca17706e3581cea82784636767a50888d0
+  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'
@@ -54,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/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/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/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.7'
+  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.7
+  version: 0.3.8
 platform: ruby
 authors:
 - an-lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 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