mixin_bot 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29930a091b973b490ea096e14f6344a0bc95f67b5023f081ac47fca36bc78adb
-  data.tar.gz: eb58283464badcf4573f417ad8108e06216811bce36e0990bf10022d8e4802c8
+  metadata.gz: 7d2493d906df4d0e0619c860f2b8260cb7b461e0c0aff489706e38d2126cf52a
+  data.tar.gz: a8106a0086282b5f8eb09feab36f1885715ba51c09285413dabc66d8fcd6f00d
 SHA512:
-  metadata.gz: 51e9e665540a634c383ee266d7b12ce67824c11a06a67fce43f66d3666a317d7c80e1ec974f7401ddb634230a73d0163702792876789c28210e91b8a43c68871
-  data.tar.gz: 7e503ad0ca5116e99cf36423049b3017109e1d4c2ced08b1625630c55448cc5fbbe4047d0fb3c4ea4bf4abdfa7b7ffc89592671116e8d4d0739bfef9b05c1f52
+  metadata.gz: 30442db3e5c4ac450500fb6c0b09023ac36c249c4b12fa2226bbd438076d7e6f9708ac4a93665524cdc28890d0ff22886ef317f1cac1ff38a393e69ca8e127be
+  data.tar.gz: 827e08df53317fbfb3441ecb476b4d665013eaaff843e6a7ef6f2776da24979ddb72544976efbf28fad4035a34f8ad1d5968df15ecbf4b0f03ba934853db5174

data/bin/mixinbot

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/mixin_bot'
+
+MixinBot::CLI.start(ARGV)

data/lib/mixin_bot.rb

@@ -1,15 +1,21 @@
 # frozen_string_literal: true
 
-require 'http'
+require 'English'
 require 'base64'
-require 'openssl'
-require 'jwt'
+require 'digest'
+require 'faye/websocket'
+require 'http'
 require 'jose'
+require 'msgpack'
+require 'open3'
+require 'openssl'
 require_relative './mixin_bot/api'
+require_relative './mixin_bot/cli'
+require_relative './mixin_bot/version'
 
 module MixinBot
   class<< self
-    attr_accessor :client_id, :client_secret, :session_id, :pin_token, :private_key, :scope
+    attr_accessor :client_id, :client_secret, :session_id, :pin_token, :private_key, :scope, :api_host, :blaze_host
   end
 
   def self.api

data/lib/mixin_bot/api.rb

@@ -2,10 +2,14 @@
 
 require_relative './client'
 require_relative './errors'
+require_relative './api/app'
+require_relative './api/attachment'
 require_relative './api/auth'
+require_relative './api/blaze'
 require_relative './api/conversation'
 require_relative './api/me'
 require_relative './api/message'
+require_relative './api/multisig'
 require_relative './api/payment'
 require_relative './api/pin'
 require_relative './api/snapshot'
@@ -15,27 +19,61 @@ require_relative './api/withdraw'
 
 module MixinBot
   class API
-    attr_reader :client_id, :client_secret, :session_id, :pin_token, :private_key
-    attr_reader :client
+    attr_reader :client_id, :client_secret, :session_id, :pin_token, :private_key, :client, :blaze_host, :schmoozer
 
     def initialize(options = {})
       @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.decode64 options[:pin_token] || MixinBot.pin_token
-      @private_key = OpenSSL::PKey::RSA.new options[:private_key] || MixinBot.private_key
-      @client = Client.new
+      @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'
+      _private_key = options[:private_key] || MixinBot.private_key
+      @private_key =
+        if /^-----BEGIN RSA PRIVATE KEY-----/.match? _private_key
+          _private_key.gsub('\\r\\n', "\n").gsub("\r\n", "\n")
+        else
+          Base64.urlsafe_decode64 _private_key
+        end
     end
 
+    # Use a mixin software to implement transaction build
+    def build_transaction(json)
+      ensure_mixin_command_exist
+      command = format("mixin signrawtransaction --raw '%<arg>s'", arg: json)
+
+      output, error = Open3.capture3(command)
+      raise error unless error.empty?
+
+      output.chomp
+    end
+
+    include MixinBot::API::App
+    include MixinBot::API::Attachment
     include MixinBot::API::Auth
+    include MixinBot::API::Blaze
     include MixinBot::API::Conversation
     include MixinBot::API::Me
     include MixinBot::API::Message
+    include MixinBot::API::Multisig
     include MixinBot::API::Payment
     include MixinBot::API::Pin
     include MixinBot::API::Snapshot
     include MixinBot::API::Transfer
     include MixinBot::API::User
     include MixinBot::API::Withdraw
+
+    private
+
+    def ensure_mixin_command_exist
+      return if command?('mixin')
+
+      raise '`mixin` command is not valid!'
+    end
+
+    def command?(name)
+      `which #{name}`
+      $CHILD_STATUS.success?
+    end
   end
 end

data/lib/mixin_bot/api/app.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MixinBot
+  class API
+    module App
+      def add_favorite_app(app_id, access_token: nil)
+        path = format('/apps/%<id>s/favorite', id: app_id)
+
+        access_token ||= access_token('POST', path, {})
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization })
+      end
+
+      def remove_favorite_app(app_id, access_token: nil)
+        path = format('/apps/%<id>s/unfavorite', id: app_id)
+
+        access_token ||= access_token('POST', path, '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization })
+      end
+
+      def favorite_apps(user_id, access_token: nil)
+        path = format('/users/%<id>s/apps/favorite', id: user_id)
+
+        access_token ||= access_token('GET', path, '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.get(path, headers: { 'Authorization': authorization })
+      end
+    end
+  end
+end

data/lib/mixin_bot/api/attachment.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MixinBot
+  class API
+    module Attachment
+      # https://developers.mixin.one/api/beta-mixin-message/create-attachment/
+      # Sample Response
+      # {
+      #   "data":{
+      #     "type":"attachment",
+      #     "attachment_id":"7a54e394-1626-4cd4-b967-543932c2a032",
+      #     "upload_url":"https://moments-shou-tv.s3.amazonaws.com/mixin/attachments/xxx",
+      #     "view_url":"https://moments.shou.tv/mixin/attachments/1526305123xxxx"
+      #   }
+      # }
+      # Once get the upload_url, use it to upload the your file via PUT request
+      def create_attachment
+        path = '/attachments'
+        access_token ||= access_token('POST', path, {}.to_json)
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.post(path, headers: { 'Authorization': authorization }, json: {})
+      end
+
+      def read_attachment(attachment_id)
+        path = format('/attachments/%<id>s', id: attachment_id)
+        access_token ||= access_token('GET', path, '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        client.get(path, headers: { 'Authorization': authorization })
+      end
+    end
+  end
+end

data/lib/mixin_bot/api/auth.rb

@@ -3,7 +3,7 @@
 module MixinBot
   class API
     module Auth
-      def access_token(method, uri, body = '', exp_in = 600)
+      def access_token(method, uri, body = '', exp_in: 600, scp: 'FULL')
         sig = Digest::SHA256.hexdigest(method + uri + body)
         iat = Time.now.utc.to_i
         exp = (Time.now.utc + exp_in).to_i
@@ -14,9 +14,19 @@ module MixinBot
           iat: iat,
           exp: exp,
           jti: jti,
-          sig: sig
+          sig: sig,
+          scp: scp
         }
-        JWT.encode payload, private_key, 'RS512'
+        if pin_token.size == 32
+          jwk = JOSE::JWK.from_okp [:Ed25519, private_key]
+          jws = JOSE::JWS.from({ 'alg' => 'EdDSA' })
+        else
+          jwk = JOSE::JWK.from_pem private_key
+          jws = JOSE::JWS.from({ 'alg' => 'RS512' })
+        end
+
+        jwt = JOSE::JWT.from payload
+        JOSE::JWT.sign(jwk, jws, jwt).compact
       end
 
       def oauth_token(code)
@@ -34,7 +44,7 @@ module MixinBot
       end
 
       def request_oauth(scope = nil)
-        scope ||= (MixinBot.scope || 'PROFILE:READ+PHONE:READ')
+        scope ||= (MixinBot.scope || 'PROFILE:READ')
         format(
           'https://mixin.one/oauth/authorize?client_id=%<client_id>s&scope=%<scope>s',
           client_id: client_id,

data/lib/mixin_bot/api/blaze.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MixinBot
+  class API
+    module Blaze
+      def blaze
+        access_token = access_token('GET', '/', '')
+        authorization = format('Bearer %<access_token>s', access_token: access_token)
+        Faye::WebSocket::Client.new(
+          format('wss://%<host>s/', host: blaze_host),
+          ['Mixin-Blaze-1'],
+          headers: { 'Authorization' => authorization },
+          ping: 60
+        )
+      end
+
+      def start_blaze_connect(reconnect: true, &_block)
+        ws ||= blaze
+        yield if block_given?
+
+        ws.on :open do |event|
+          if defined? on_open
+            on_open ws, event
+          else
+            p [Time.now.to_s, :open]
+            ws.send list_pending_message
+          end
+        end
+
+        ws.on :message do |event|
+          if defined? on_message
+            on_message ws, event
+          else
+            raw = JSON.parse read_ws_message(event.data)
+            p [Time.now.to_s, :message, raw&.[]('action')]
+
+            ws.send acknowledge_message_receipt(raw['data']['message_id']) unless raw&.[]('data')&.[]('message_id').nil?
+          end
+        end
+
+        ws.on :error do |event|
+          if defined? on_error
+            on_error ws, event
+          else
+            p [Time.now.to_s, :error]
+          end
+        end
+
+        ws.on :close do |event|
+          if defined? on_close
+            on_close ws, event
+          else
+            p [Time.now.to_s, :close, event.code, event.reason]
+          end
+
+          ws = nil
+          start_blaze_connect(&block) if reconnect
+        end
+      end
+    end
+  end
+end

data/lib/mixin_bot/api/conversation.rb

@@ -33,14 +33,15 @@ module MixinBot
         client.post(path, headers: { 'Authorization': authorization }, json: payload)
       end
 
-      def unique_conversation_id(user_id)
+      def unique_conversation_id(user_id, opponent_id = nil)
+        opponent_id ||= client_id
         md5 = Digest::MD5.new
-        md5 << [user_id, client_id].min
-        md5 << [user_id, client_id].max
+        md5 << [user_id, opponent_id].min
+        md5 << [user_id, opponent_id].max
         digest = md5.digest
         digest6 = (digest[6].ord & 0x0f | 0x30).chr
         digest8 = (digest[8].ord & 0x3f | 0x80).chr
-        cipher = digest[0...6] + digest6 + digest[7] + digest8 + digest[9..-1]
+        cipher = digest[0...6] + digest6 + digest[7] + digest8 + digest[9..]
         hex = cipher.unpack1('H*')
 
         format(
@@ -49,7 +50,7 @@ module MixinBot
           second: hex[8..11],
           third: hex[12..15],
           forth: hex[16..19],
-          fifth: hex[20..-1]
+          fifth: hex[20..]
         )
       end
     end

data/lib/mixin_bot/api/me.rb

@@ -4,9 +4,9 @@ module MixinBot
   class API
     module Me
       # https://developers.mixin.one/api/beta-mixin-message/read-profile/
-      def read_me
+      def read_me(access_token: nil)
         path = '/me'
-        access_token = access_token('GET', path, '')
+        access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end
@@ -14,37 +14,37 @@ module MixinBot
       # https://developers.mixin.one/api/beta-mixin-message/update-profile/
       # avatar_base64:
       # String: Base64 of image, supports format png, jpeg and gif, base64 image size > 1024.
-      def update_me(full_name:, avatar_base64: nil)
+      def update_me(full_name:, avatar_base64: nil, access_token: nil)
         path = '/me'
         payload = {
           full_name: full_name,
           avatar_base64: avatar_base64
         }
-        access_token = access_token('POST', path, payload.to_json)
+        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
 
       # https://developers.mixin.one/api/alpha-mixin-network/read-assets/
-      def read_assets
+      def read_assets(access_token: nil)
         path = '/assets'
-        access_token = access_token('GET', path, '')
+        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)
+      def read_asset(asset_id, access_token: nil)
         path = format('/assets/%<asset_id>s', asset_id: asset_id)
-        access_token = access_token('GET', path, '')
+        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
+      def read_friends(access_token: nil)
         path = '/friends'
-        access_token = access_token('GET', path, '')
+        access_token ||= access_token('GET', path, '')
         authorization = format('Bearer %<access_token>s', access_token: access_token)
         client.get(path, headers: { 'Authorization': authorization })
       end

data/lib/mixin_bot/api/message.rb

@@ -41,6 +41,22 @@ module MixinBot
         base_message_params(options)
       end
 
+      # {
+      #   "id": "UUID // generated by client",
+      #   "action":  "CREATE_MESSAGE",
+      #   "params": {
+      #     "conversation_id": "UUID",
+      #     "category": "PLAIN_POST",
+      #     "status": "SENT",
+      #     "message_id": "UUID // generated by client",
+      #     "data": "Base64 encoded data content is markdown" ,
+      #   }
+      # }
+      def plain_post(options)
+        options.merge!(category: 'PLAIN_POST')
+        base_message_params(options)
+      end
+
       # {
       #   "id": "UUID",
       #   "action": "CREATE_MESSAGE",
@@ -203,15 +219,29 @@ module MixinBot
         base_message_params(options)
       end
 
+      def recall_message_params(message_id, options)
+        raise 'recipient_id is required!' if options[:recipient_id].nil?
+
+        options.merge!(
+          category: 'MESSAGE_RECALL',
+          data: {
+            message_id: message_id
+          }
+        )
+        base_message_params(options)
+      end
+
       # base format of message params
-      def base_message_params(conversation_id:, category:, data:, quote_message_id: nil, message_id: nil)
-        data = data.is_a?(String) ? data : data.to_json
+      def base_message_params(options)
+        data = options[:data].is_a?(String) ? options[:data] : options[:data].to_json
         {
-          conversation_id: conversation_id,
-          category: category,
+          conversation_id: options[:conversation_id],
+          recipient_id: options[:recipient_id],
+          representative_id: options[:representative_id],
+          category: options[:category],
           status: 'SENT',
-          quote_message_id: quote_message_id,
-          message_id: message_id || SecureRandom.uuid,
+          quote_message_id: options[:quote_message_id],
+          message_id: options[:message_id] || SecureRandom.uuid,
           data: Base64.encode64(data)
         }
       end
@@ -227,7 +257,7 @@ module MixinBot
       end
 
       # gzip the message for websocket
-      def write_ws_message(action: 'CREATE_MESSAGE', params:)
+      def write_ws_message(params:, action: 'CREATE_MESSAGE')
         msg = {
           id: SecureRandom.uuid,
           action: action,
@@ -246,6 +276,10 @@ module MixinBot
         send_message plain_text(options)
       end
 
+      def send_post_message(options)
+        send_message plain_post(options)
+      end
+
       def send_contact_message(options)
         send_message plain_contact(options)
       end
@@ -258,6 +292,10 @@ module MixinBot
         send_message app_button_group(options)
       end
 
+      def recall_message(message_id, options)
+        send_message [recall_message_params(message_id, options)]
+      end
+
       # {
       #   "id": "UUID",
       #   "action": "CREATE_PLAIN_MESSAGES",
@@ -276,9 +314,8 @@ module MixinBot
       #     ]
       #   }
       # }
-      # not verified yet
       def send_plain_messages(messages)
-        send_message(messages: messages)
+        send_message messages
       end
 
       # http post request