🔧 FIXES #4 调整变量和配置变为webchaty风格

Author: jcai

wechaty-hostie/src/main/scala/wechaty/hostie/Configuration.scala

@@ -6,6 +6,6 @@ package wechaty.hostie
   * @since 2020-06-02
   */
 object Configuration {
-  lazy val WechatyPuppetHostieToken = sys.props.get("WECHATY_PUPPET_HOSTIE_TOKEN")
-  lazy val WechatyPuppetHostieEndpoint= sys.props.get("WECHATY_PUPPET_HOSTIE_ENDPOINT")
+  lazy val WECHATY_PUPPET_HOSTIE_TOKEN: Option[String] = sys.props.get("WECHATY_PUPPET_HOSTIE_TOKEN")
+  lazy val WECHATY_PUPPET_HOSTIE_ENDPOINT: Option[String] = sys.props.get("WECHATY_PUPPET_HOSTIE_ENDPOINT")
 }

wechaty-hostie/src/main/scala/wechaty/hostie/PuppetHostie.scala

@@ -2,7 +2,8 @@ package wechaty.hostie
 
 import wechaty.hostie.support.{ContactRawSupport, GrpcEventSupport, GrpcSupport, MessageRawSupport}
 import wechaty.puppet.schemas.Puppet
-import wechaty.puppet.{LoggerSupport, Puppet, PuppetOption}
+import wechaty.puppet.schemas.Puppet.PuppetOptions
+import wechaty.puppet.{LoggerSupport, Puppet}
 
 import scala.io.Source
 
@@ -11,7 +12,7 @@ import scala.io.Source
   * @author <a href="mailto:[email protected]">Jun Tsai</a>
   * @since 2020-06-02
   */
-class PuppetHostie(option:PuppetOption) extends Puppet
+class PuppetHostie(option:PuppetOptions) extends Puppet
   with GrpcSupport
   with LoggerSupport
   with ContactRawSupport
@@ -21,19 +22,19 @@ class PuppetHostie(option:PuppetOption) extends Puppet
   init()
   private def init(): Unit ={
     if(option.token.isEmpty){
-      option.token = Configuration.WechatyPuppetHostieToken
+      option.token = Configuration.WECHATY_PUPPET_HOSTIE_TOKEN
     }
-    if(option.endpoint.isEmpty){
-      option.endpoint = Configuration.WechatyPuppetHostieEndpoint
+    if(option.endPoint.isEmpty){
+      option.endPoint = Configuration.WECHATY_PUPPET_HOSTIE_ENDPOINT
     }
-    if(option.endpoint.isEmpty){
-      option.endpoint = discoverHostieEndPoint()
+    if(option.endPoint.isEmpty){
+      option.endPoint= discoverHostieEndPoint()
     }
-    if(option.endpoint.isEmpty)
+    if(option.endPoint.isEmpty)
       throw new IllegalStateException("hostie endpoint not found")
   }
   def start(): Unit ={
-    startGrpc(option.endpoint.get)
+    startGrpc(option.endPoint.get)
   }
   def stop(): Unit = {
     stopGrpc()

wechaty-hostie/src/main/scala/wechaty/hostie/support/GrpcEventSupport.scala

@@ -21,7 +21,7 @@ trait GrpcEventSupport extends StreamObserver[EventResponse] {
       if (v.getType != EventType.EVENT_TYPE_HEARTBEAT) {
         val hearbeat = new EventHeartbeatPayload
         hearbeat.data = "onGrpcStreamEvent(%s)".format(v.getType)
-        EventEmitter.emit(EventName.PuppetEventNameHeartbeat, hearbeat)
+        EventEmitter.emit(PuppetEventName.HEARTBEAT, hearbeat)
       }
       v.getType match {
         case EventType.EVENT_TYPE_UNSPECIFIED =>

wechaty-puppet/src/main/scala/wechaty/puppet/PuppetOption.scala

@@ -1,6 +1,6 @@
 package wechaty.puppet.events
 
-import wechaty.puppet.schemas.Events.{EventName, EventPayload}
+import wechaty.puppet.schemas.Events.{PuppetEventName, EventPayload}
 
 /**
   * global event
@@ -10,9 +10,9 @@ import wechaty.puppet.schemas.Events.{EventName, EventPayload}
   */
 object EventEmitter {
   type Listener[T<:EventPayload] = T => Unit
-  private var listeners: Map[EventName.Type, List[Listener[_<:EventPayload]]] = Map()
+  private var listeners: Map[PuppetEventName.Type, List[Listener[_<:EventPayload]]] = Map()
 
-  def emit[T<:EventPayload](event: EventName.Type, data: T):Unit={
+  def emit[T<:EventPayload](event: PuppetEventName.Type, data: T):Unit={
     val eventListenerOpts = listeners.get(event)
     eventListenerOpts match {
       case Some(eventListeners) =>
@@ -22,7 +22,7 @@ object EventEmitter {
     }
   }
 
-  def addListener[T<:EventPayload](event: EventName.Type, listener: Listener[T]): Unit = {
+  def addListener[T<:EventPayload](event: PuppetEventName.Type, listener: Listener[T]): Unit = {
     listeners.get(event) match {
       case Some(eventListeners) => listeners += event -> (eventListeners :+ listener)
       case _ => listeners += event -> List(listener)

wechaty-puppet/src/main/scala/wechaty/puppet/events/EventEmitter.scala

@@ -9,25 +9,25 @@ import com.fasterxml.jackson.annotation.{JsonGetter, JsonSetter}
   */
 object Events {
 
-  object EventName extends Enumeration {
+  object PuppetEventName extends Enumeration {
     type Type = Value
-    val PuppetEventNameUnknown: Value = Value("unkown")
-    val PuppetEventNameFriendship: Value = Value("friendship")
-    val PuppetEventNameLogin: Value = Value("login")
-    val PuppetEventNameLogout: Value = Value("logout")
-    val PuppetEventNameMessage: Value = Value("message")
-    val PuppetEventNameRoomInvite: Value = Value("room-invite")
-    val PuppetEventNameRoomJoin: Value = Value("room-join")
-    val PuppetEventNameRoomLeave: Value = Value("room-leave")
-    val PuppetEventNameRoomTopic: Value = Value("room-topic")
-    val PuppetEventNameScan: Value = Value("scan")
-    val PuppetEventNameDong: Value = Value("dong")
-    val PuppetEventNameError: Value = Value("error")
-    val PuppetEventNameHeartbeat: Value = Value("heartbeat")
-    val PuppetEventNameReady: Value = Value("ready")
-    val PuppetEventNameReset: Value = Value("reset")
-    val PuppetEventNameStop: Value = Value("stop")
-    val PuppetEventNameStart: Value = Value("start")
+    val UNKNOWN: Value = Value(0)
+    val FRIENDSHIP: Value = Value(1)
+    val LOGIN: Value = Value(2)
+    val LOGOUT: Value = Value(3)
+    val MESSAGE: Value = Value(4)
+    val INVITE: Value = Value(5)
+    val ROOM_JOIN: Value = Value(6)
+    val ROOM_LEAVE: Value = Value(7)
+    val ROOM_TOPIC: Value = Value(8)
+    val SCAN: Value = Value(9)
+    val DONG: Value = Value(10)
+    val ERROR: Value = Value(11)
+    val HEARTBEAT: Value = Value(12)
+    val READY: Value = Value(13)
+    val RESET: Value = Value(14)
+    val STOP: Value = Value(15)
+    val START: Value = Value(16)
   }
 
   object ScanStatus extends Enumeration {

wechaty-puppet/src/main/scala/wechaty/puppet/schemas/Events.scala

@@ -3,7 +3,7 @@ package wechaty.puppet.schemas
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.module.scala.DefaultScalaModule
 import io.github.wechaty.grpc.puppet.Event.EventType
-import wechaty.puppet.schemas.Events.EventName
+import wechaty.puppet.schemas.Events.PuppetEventName
 
 /**
   *
@@ -22,22 +22,22 @@ object Puppet {
     om.registerModule(DefaultScalaModule)
   }
 
-  val pbEventType2PuppetEventName = Map[EventType,EventName.Type](
-    EventType.EVENT_TYPE_DONG->        EventName.PuppetEventNameDong,
-    EventType.EVENT_TYPE_ERROR->       EventName.PuppetEventNameError,
-    EventType.EVENT_TYPE_HEARTBEAT->   EventName.PuppetEventNameHeartbeat,
-    EventType.EVENT_TYPE_FRIENDSHIP->  EventName.PuppetEventNameFriendship,
-    EventType.EVENT_TYPE_LOGIN->       EventName.PuppetEventNameLogin,
-    EventType.EVENT_TYPE_LOGOUT->      EventName.PuppetEventNameLogout,
-    EventType.EVENT_TYPE_MESSAGE->     EventName.PuppetEventNameMessage,
-    EventType.EVENT_TYPE_READY->       EventName.PuppetEventNameReady,
-    EventType.EVENT_TYPE_ROOM_INVITE-> EventName.PuppetEventNameRoomInvite,
-    EventType.EVENT_TYPE_ROOM_JOIN->   EventName.PuppetEventNameRoomJoin,
-    EventType.EVENT_TYPE_ROOM_LEAVE->  EventName.PuppetEventNameRoomLeave,
-    EventType.EVENT_TYPE_ROOM_TOPIC->  EventName.PuppetEventNameRoomTopic,
-    EventType.EVENT_TYPE_SCAN->        EventName.PuppetEventNameScan,
-    EventType.EVENT_TYPE_RESET->       EventName.PuppetEventNameReset,
-    EventType.EVENT_TYPE_UNSPECIFIED-> EventName.PuppetEventNameUnknown
+  val pbEventType2PuppetEventName = Map[EventType,PuppetEventName.Type](
+    EventType.EVENT_TYPE_DONG->        PuppetEventName.DONG,
+    EventType.EVENT_TYPE_ERROR->       PuppetEventName.ERROR,
+    EventType.EVENT_TYPE_HEARTBEAT->   PuppetEventName.HEARTBEAT,
+    EventType.EVENT_TYPE_FRIENDSHIP->  PuppetEventName.FRIENDSHIP,
+    EventType.EVENT_TYPE_LOGIN->       PuppetEventName.LOGIN,
+    EventType.EVENT_TYPE_LOGOUT->      PuppetEventName.LOGOUT,
+    EventType.EVENT_TYPE_MESSAGE->     PuppetEventName.MESSAGE,
+    EventType.EVENT_TYPE_READY->       PuppetEventName.READY,
+    EventType.EVENT_TYPE_ROOM_INVITE-> PuppetEventName.INVITE,
+    EventType.EVENT_TYPE_ROOM_JOIN->   PuppetEventName.ROOM_JOIN,
+    EventType.EVENT_TYPE_ROOM_LEAVE->  PuppetEventName.ROOM_LEAVE,
+    EventType.EVENT_TYPE_ROOM_TOPIC->  PuppetEventName.ROOM_TOPIC,
+    EventType.EVENT_TYPE_SCAN->        PuppetEventName.SCAN,
+    EventType.EVENT_TYPE_RESET->       PuppetEventName.RESET,
+    EventType.EVENT_TYPE_UNSPECIFIED-> PuppetEventName.UNKNOWN
   )
 
   def isBlank(value:String): Boolean = value == null || value.trim.length ==0

wechaty-puppet/src/main/scala/wechaty/puppet/schemas/Puppet.scala

@@ -1,23 +1,44 @@
 package wechaty
 
+import wechaty.helper.ImplicitHelper._
 import wechaty.hostie.PuppetHostie
 import wechaty.puppet.events.EventEmitter
-import wechaty.puppet.schemas.Events.{EventLoginPayload, EventMessagePayload, EventName, EventScanPayload}
+import wechaty.puppet.schemas.Events._
 import wechaty.puppet.schemas.Puppet.PuppetOptions
-import wechaty.puppet.{LoggerSupport, PuppetOption}
+import wechaty.puppet.LoggerSupport
 import wechaty.user.{Contact, Message}
 
 import scala.language.implicitConversions
 
 
 /**
+  **
+  * Main bot class.
   *
+  * A `Bot` is a WeChat client depends on which puppet you use.
+  *
+  * See more:
+  * - [What is a Puppet in Wechaty](https://github.com/wechaty/wechaty-getting-started/wiki/FAQ-EN#31-what-is-a-puppet-in-wechaty)
+  *
+  * > If you want to know how to send message, see [Message](#Message) <br>
+  * > If you want to know how to get contact, see [Contact](#Contact)
+  *
+  * @example <caption>The World's Shortest ChatBot Code: 6 lines of Scala</caption>
+  * val options = new WechaytOptions
+  * val bot = Wechaty.instance(options)
+  * bot.onScan(payload => println("['https://api.qrserver.com/v1/create-qr-code/?data=',encodeURIComponent(qrcode),'&size=220x220&margin=20',].join('')"))
+  * bot.onLogin(user => println("User ${user} logged in"))
+  * bot.onMessage(message => println("Message: ${message}"))
+  * bot.start()
   * @author <a href="mailto:[email protected]">Jun Tsai</a>
   * @since 2020-06-01
   */
 object Wechaty {
+  private var globalInstance:Wechaty = _
   def instance(options: WechatyOptions): Wechaty = {
-    new Wechaty(options)
+    if (options != null && globalInstance != null) throw new Error("instance can be only initialized once by options !")
+    if (globalInstance == null) globalInstance = new Wechaty(options)
+    globalInstance
   }
 }
 
@@ -28,28 +49,31 @@ class WechatyOptions {
   var ioToken: Option[String] = None
 }
 
-class Wechaty(options: WechatyOptions) extends LoggerSupport{
+class Wechaty(private val options: WechatyOptions) extends LoggerSupport{
   private implicit var hostie:PuppetHostie = _
 
   def onScan(listener: EventScanPayload=>Unit): Wechaty = {
-    EventEmitter.addListener(EventName.PuppetEventNameScan,listener)
+    EventEmitter.addListener(PuppetEventName.SCAN,listener)
     this
   }
   def onLogin(listener:Contact =>Unit):Wechaty={
-    EventEmitter.addListener[EventLoginPayload](EventName.PuppetEventNameLogin,listener)
+    EventEmitter.addListener[EventLoginPayload](PuppetEventName.LOGIN,listener)
     this
   }
   def onMessage(listener:Message =>Unit):Wechaty={
-    EventEmitter.addListener[EventMessagePayload](EventName.PuppetEventNameMessage,listener)
+    EventEmitter.addListener[EventMessagePayload](PuppetEventName.MESSAGE,listener)
     this
   }
-  def onLogout(listener:EventLoginPayload=>Unit):Wechaty={
-    EventEmitter.addListener(EventName.PuppetEventNameLogout,listener)
+  def onLogout(listener:Contact=>Unit):Wechaty={
+    EventEmitter.addListener[EventLogoutPayload](PuppetEventName.LOGOUT,listener)
     this
   }
 
   def start(): Unit = {
-    val option = new PuppetOption
+    val option = options.puppetOptions match{
+      case Some(o) => o
+      case _ => new PuppetOptions
+    }
     this.hostie = new PuppetHostie(option)
     this.hostie.start()
     Runtime.getRuntime.addShutdownHook(new Thread(new Runnable {
@@ -60,12 +84,6 @@ class Wechaty(options: WechatyOptions) extends LoggerSupport{
     }))
 
   }
-  implicit def toMessage(messageListener: Message=>Unit):EventMessagePayload=>Unit ={
-    messagePayload:EventMessagePayload => messageListener(new Message(messagePayload.messageId))
-  }
-  implicit def toContact(contactListener: Contact=>Unit):EventLoginPayload=>Unit ={
-    payload:EventLoginPayload => contactListener(new Contact(payload.contactId))
-  }
 }
 
 

wechaty/src/main/scala/wechaty/Wechaty.scala

@@ -0,0 +1,27 @@
+package wechaty.helper
+
+import wechaty.puppet.Puppet
+import wechaty.puppet.schemas.Events.{EventLoginPayload, EventLogoutPayload, EventMessagePayload}
+import wechaty.user.{Contact, Message}
+
+import scala.language.implicitConversions
+
+/**
+  * convert event payload to user class
+  * @author <a href="mailto:[email protected]">Jun Tsai</a>
+  * @since 2020-06-04
+  */
+object ImplicitHelper {
+  private[wechaty] implicit def toMessage(messageListener: Message => Unit)(implicit puppet: Puppet): EventMessagePayload => Unit = {
+    messagePayload: EventMessagePayload => messageListener(new Message(messagePayload.messageId))
+  }
+
+  private[wechaty] implicit def toContact(contactListener: Contact => Unit)(implicit puppet: Puppet): EventLoginPayload => Unit = {
+    payload: EventLoginPayload => contactListener(new Contact(payload.contactId))
+  }
+
+  private[wechaty] implicit def logoutToContact(contactListener: Contact => Unit)(implicit puppet: Puppet): EventLogoutPayload => Unit = {
+    payload: EventLogoutPayload => contactListener(new Contact(payload.contactId))
+  }
+
+}