Download fb botmill - download do código-fonte fb botmill

FB-BotMill – Estrutura incrível para construir bots no Facebook

O FB-BotMill foi projetado para facilitar o processo de desenvolvimento, design e execução de bots que existem dentro do Facebook.

Ele fornece uma API Java semântica que pode ser importada em seu projeto Java EE para enviar e receber mensagens do Facebook para que os desenvolvedores possam se concentrar no desenvolvimento do aplicativo real em vez de lidar com terminais da API do Facebook.

Começando

O FB-BotMill pode ser importado como dependência via 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'

Legal

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

Outras maneiras de importar, visite o site de repositório central do Maven

Criando seu primeiro ChatBot do Facebook com Fb-BotMill

Depois de importar a API. Você precisa registrar o FbBotMillServlet. Para fazer isso, adicione o seguinte ao seu 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 >

Anote o mapeamento de URL , pois ele será usado na configuração do seu webhook no Facebook.

Criando sua definição de bot.

A definição do bot é o coração do seu Facebook ChatBot. É aqui que colocamos todos os outros manipuladores de eventos e respostas do chatbot.

1º: Configure o token da página e o token de validação. Crie o arquivo botmill.properties em seu classpath e adicione seus tokens.

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

Observe que você pode criptografar o arquivo de propriedades usando nossa criptografia integrada baseada em jaspyt. Acesse nosso Wiki aqui sobre como configurar seu arquivo botmill.properties criptografado.

2º: Configure sua classe de criptografia. Nós incentivamos estritamente o uso do Jaspyt para criptografar os tokens, para isso, precisamos ter certeza de que você criou sua própria classe de criptografia Jaspyt. Para fazer isso, crie o seguinte em seu projeto.

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

A senha é com você e pode ser obtida em qualquer lugar (via https ou ftp). O principal aqui é que este texto é o que o Jaspyt usará para descriptografar seu arquivo botmill.properties.

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

Depois de fazer isso, precisamos usar o projeto botmill-crypto-util para criar a versão criptografada do token de sua página e do token de validação. Baixe o botmill-crypto-util [aqui] (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) e execute o seguinte 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 <validação_token>

Isso irá cuspir a versão criptografada do seu arquivo de texto. Modifique seu botmill.properties com esses valores, mas certifique-se de colocá-lo dentro do ENC(***)

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

Reimplante e você estará pronto para prosseguir.

3º: Configure seu BotConfiguration A classe BotConfiguration cuidará dos processos únicos que precisam acontecer (menus persistentes, autenticação de API do Facebook, etc.). Crie um FbBotConfiguration abaixo e coloque toda a sua configuração inicial (configuração única) no construtor. Isso também inicializará a autenticação do 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 );
		
    }
    
}

4º: Configure as classes/classes do FbBot. Nossa estrutura torna fácil e direto definir um comportamento de bot do Facebook marcando classes como objetos de comportamento.

 @ 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" ));
	}
}

pegue um padrão e responda com uma resposta 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 );
		}
	});
}

ou responda com um botão

 @ 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 nossos documentos para obter uma lista completa de EventTypes e Response.

Componentes principais na construção do seu ChatBot

@Bot - anotar uma classe com @Bot marcará a classe como um comportamento do Facebook ChatBot.
@BotEncryption - use para criar uma classe Java isolada para lidar com criptografia.
@BotConfiguration - use para criar uma classe Java isolada para lidar com processos únicos que precisam acontecer antes de qualquer bot ser criado.
@FbBotMillInit - pode ser usado para anotar um método e invocá-lo antes de qualquer método anotado por @FbBotMillController.
@FbBotMillController - Use para criar um método que captura eventos específicos orientados pelo usuário (como o usuário inserindo uma mensagem, selecionando uma resposta rápida etc.
FbBot.reply() - permite que os desenvolvedores criem uma resposta baseada no evento @FbBotMillController. Para a lista de todos os eventos e respostas, acesse nossa página Wiki aqui
FbBot.botMillSession() - permite armazenar e acessar dados. Observe que você precisa configurar uma conexão mongodb para fazer isso funcionar. A configuração da conexão mongodb também pode ser definida via botmill.properties . Para obter mais informações sobre isso, visite nosso [guia BotMillSession aqui]https://github.com/BotMill/fb-botmill/wiki/Developing-with-FB-BotMill).

Contribuição

Adoraríamos envolver mais pessoas no projeto. Estamos procurando mantenedores entusiasmados que possam colocar nosso framework em outro nível e adoraríamos ouvir suas ideias sobre isso. Sinta-se à vontade para conversar conosco via Gitter para começar!

Expandir