Descargar fb botmill - descarga del código fuente fb botmill

FB-BotMill: marco impresionante para crear bots de Facebook

FB-BotMill está diseñado para facilitar el proceso de desarrollo, diseño y ejecución de bots que existen dentro de Facebook.

Proporciona una API de Java semántica que se puede importar en su proyecto Java EE para enviar y recibir mensajes de Facebook, de modo que los desarrolladores puedan concentrarse en desarrollar la aplicación real en lugar de lidiar con los puntos finales de la API de Facebook.

Empezando

El FB-BotMill se puede importar como una dependencia a través de Maven.

 <dependency>
  <groupId>co.aurasphere.botmill</groupId>
  <artifactId>fb-botmill</artifactId>
  <version>2.0.0-RC3</version>
</dependency>

Gradle

 compile 'co.aurasphere.botmill:fb-botmill:2.0.0-RC3'

maravilloso

 @Grapes( 
    @Grab(group='co.aurasphere.botmill', module='fb-botmill', version='2.0.0-RC3') 
)

Otras formas de importar, visite el sitio de repositorio central de Maven

Creando tu primer ChatBot de Facebook con Fb-BotMill

Una vez que haya importado la API. Debe registrar FbBotMillServlet. Para hacer eso, agregue lo siguiente a su web.xml.

< servlet >
	< servlet-name >myFbBot</ servlet-name >
	< servlet-class >co.aurasphere.botmill.fb.FbBotMillServlet</ servlet-class >
</ servlet >
< servlet-mapping >
	< servlet-name >myFbBot</ servlet-name >
	< url-pattern >/myFbBot</ url-pattern >
</ servlet-mapping >

Tome nota de la asignación de URL , ya que se utilizará en la configuración de su webhook en Facebook.

Creando tu definición de bot.

La definición de bot es el corazón de tu ChatBot de Facebook. Aquí es donde colocamos todos los demás controladores de eventos y respuestas del chatbot.

Primero: configurar el token de página y el token de validación. Cree el archivo botmill.properties en su classpath y agregue sus tokens.

 fb.page.token =<PAGE_TOKEN>
fb.validation.token =<VALIDATION_TOKEN>

Tenga en cuenta que puede cifrar el archivo de propiedades utilizando nuestro cifrado integrado basado en jaspyt. Vaya a nuestra Wiki aquí sobre cómo configurar su archivo botmill.properties cifrado.

2do: Configure su clase de cifrado. Impulsamos estrictamente el uso de Jaspyt para cifrar los tokens; para ello, debemos asegurarnos de crear su propia clase de cifrado Jaspyt. Para hacer esto, cree lo siguiente en su proyecto.

 @ BotEncryption
public class DefaultEncryption {
	public DefaultEncryption () {
		StandardPBEStringEncryptor enc = new StandardPBEStringEncryptor ();
		enc . setPassword ( "password" ); // can be sourced out
		ConfigurationUtils . loadEncryptedConfigurationFile ( enc , "botmill.properties" );
	}
}

La contraseña depende de usted y puede obtenerla en cualquier lugar (a través de https o ftp). La clave aquí es que este texto es lo que Jaspyt utilizará para descifrar su archivo botmill.properties.

...
enc . setPassword ( "https://mydomain.com/encryptionpassword/password.txt" ); // can be sourced out
..

Una vez que haya hecho esto, debemos usar el proyecto botmill-crypto-util para crear la versión cifrada del token de su página y del token de validación. Descargue botmill-crypto-util [aquí] (https://oss.sonatype.org/content/repositories/snapshots/co/aurasphere/botmill/botmill-crypto-util/0.0.1-SNAPSHOT/botmill-crypto-util -0.0.1-20170228.035750-1-jar-with-dependencies.jar) y ejecute el siguiente comando:

java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependencies.jar enc <page_token> java -jar botmill-crypto-util-0.0.1-20170228.035750-1-jar-with-dependencies .jar enc <token_validación>

Esto generará la versión cifrada de su archivo de texto. Modifique su botmill.properties con estos valores pero asegúrese de colocarlo dentro de ENC(***)

 fb.page.token =ENC(<ENCRYPTED_PAGE_TOKEN>)
fb.validation.token =ENC(<ENCRYPTED_VALIDATION_TOKEN>)

Vuelva a implementarlo y estará listo para comenzar.

Tercero: Configure su BotConfiguration La clase BotConfiguration se encargará de los procesos únicos que deben realizarse (menús persistentes, autenticación de API de Facebook, etc.). Cree una configuración de FbBot a continuación y coloque toda su configuración inicial (configuración única) en el constructor. Esto también inicializará la autenticación de Facebook.

 @ BotConfiguration
public class MyBotConfiguration extends FbBotConfiguration {

    public MyBotConfiguration () {
    
		MessengerProfileApi . setGetStartedButton ( "get_started" );
		MessengerProfileApi . setGreetingMessage ( "Hello!" );
		
		List < PersistentMenu > persistentMenus = new ArrayList < PersistentMenu >();
		PersistentMenu persistentMenu = new PersistentMenu ( "default" , false );
		
		persistentMenu . addCallToAction ( ButtonFactory . createPostbackButton ( "Menu 1" , "menu1" ));
		persistentMenu . addCallToAction ( ButtonFactory . createPostbackButton ( "Menu 2" , "menu2" ));
		
		CallToActionNested theNestedMenu = new CallToActionNested ( "Menu 3 Nested" );
		theServices . addCallToActionButton ( ButtonFactory . createPostbackButton ( "Nested1" , "nested1" ));
		theServices . addCallToActionButton ( ButtonFactory . createPostbackButton ( "Nested2" , "nested2" ));
		theServices . addCallToActionButton ( ButtonFactory . createPostbackButton ( "Nested3" , "nested3" ));
		persistentMenu . addCallToAction ( theNestedMenu );
		
		persistentMenus . add ( persistentMenu );
		
		MessengerProfileApi . setPersistentMenus ( persistentMenus );
		
		HomeUrl homeUrl = new HomeUrl ();
		homeUrl . setInTest ( true );
		homeUrl . setUrl ( "https://extensionlink.co" );
		homeUrl . setWebviewHeightRatio ( WebViewHeightRatioType . TALL );
		homeUrl . setWebviewShareButton ( WebViewShareButton . SHOW );
		
		MessengerProfileApi . setHomeUrl ( homeUrl );
		
    }
    
}

4to: Configurar la Clase/Clases de FbBot. Nuestro marco hace que sea fácil y directo definir el comportamiento de un bot de Facebook etiquetando clases como objetos de comportamiento.

 @ Bot
public class MyBotClass extends FbBot {
	
	@ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE , text = "Hi" , caseSensitive = true )
	public void sendMessage ( MessageEnvelope envelope ) {
		reply ( new MessageAutoReply ( "Hello World!" ));
	}
}

@ Bot ( state = BotBeanState . PROTOTYPE ) // creates a new instance per call
public class MyBotClass1 extends FbBot {
	
	@ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE , text = "Hi" , caseSensitive = true )
	public void sendMessage ( MessageEnvelope envelope ) {
		reply ( new MessageAutoReply ( "Hello World on BotClass1" ));
	}
}

@ Bot ( state = BotBeanState . SINGLETON ) // uses the same reference/instance (this is the default).
public class MyBotClass2 extends FbBot {
	
	@ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE , text = "Hi" , caseSensitive = true )
	public void sendMessage ( MessageEnvelope envelope ) {
		reply ( new MessageAutoReply ( "Hello World on BotClass2" ));
	}
}

capta un patrón y responde con una respuesta rápida

 @ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE_PATTERN , pattern = "(?i:hi)|(?i:hello)|(?i:hey)|(?i:good day)|(?i:home)" )
public void replyWithQuickReply ( MessageEnvelope envelope ) {
	reply ( new AutoReply () {
		@ Override
		public FbBotMillResponse createResponse ( MessageEnvelope envelope ) {
			return ReplyFactory . addTextMessageOnly ( "Text message with quick replies" )
					. addQuickReply ( "Quick reply 1" , "Payload for quick reply 1" ). build ( envelope );
		}
	});
}

o responder con un botón

 @ FbBotMillController ( eventType = FbBotMillEventType . MESSAGE_PATTERN , pattern = "(?i:hi)|(?i:hello)|(?i:hey)|(?i:good day)|(?i:home)" )
public void replyWithButtonTemplate ( MessageEnvelope envelope ) {
	reply ( new AutoReply () {
		@ Override
		public FbBotMillResponse createResponse ( MessageEnvelope envelope ) {
			return ReplyFactory . addButtonTemplate ( "Test button template" )
					. addPostbackButton ( "postback button" , "postback button payload" )
					. addPhoneNumberButton ( "phone number button" , "+123456789" )
					. addUrlButton ( "web url button" , "https://github.com/BotMill/fb-botmill" ). build ( envelope );
		}
	});
}

Visite nuestros documentos para obtener una lista completa de tipos de eventos y respuestas.

Componentes clave en la construcción de su ChatBot

@Bot: anotar una clase con @Bot marcará la clase como un comportamiento de ChatBot de Facebook.
@BotEncryption: se utiliza para crear una clase Java aislada para manejar el cifrado.
@BotConfiguration: se utiliza para crear una clase Java aislada para manejar procesos únicos que deben realizarse antes de que se creen los bots.
@FbBotMillInit: se puede utilizar para anotar un método e invocarlo antes de cualquier método anotado por @FbBotMillController.
@FbBotMillController: se utiliza para crear un método que detecte un evento específico impulsado por el usuario (como que el usuario ingrese un mensaje, seleccione una respuesta rápida, etc.).
FbBot.reply(): permite a los desarrolladores crear una respuesta basada en el evento @FbBotMillController. Para obtener la lista de todos los eventos y responder, vaya a nuestra página Wiki aquí
FbBot.botMillSession(): le permite almacenar y acceder a datos. Tenga en cuenta que necesita configurar una conexión mongodb para que esto funcione; la configuración de la conexión mongodb también se puede configurar a través de botmill.properties . Para obtener más información sobre esto, visite nuestra [guía de BotMillSession aquí]https://github.com/BotMill/fb-botmill/wiki/Developing-with-FB-BotMill).

Contribución

Nos encantaría involucrar a más personas en el proyecto. Estamos buscando mantenedores entusiastas que puedan llevar nuestro marco a otro nivel y nos encantaría escuchar sus ideas al respecto. ¡No dudes en chatear con nosotros a través de Gitter para comenzar!

Expandir