added new features

Author: alash3al

README.md

@@ -8,6 +8,7 @@ Features
 - Embedded a tiny `Expression Engine` to support simple scripting
 - Supports the following tags `meta, text, label, p, line, inline, span, embed, resource, media, div, menu, nav, dialog, form, template`
 - Supports custom replies from custom templates
+- Automatically paginate long `Menus` to be compatible with messenger `max-items-limit`
 
 Status
 ====
@@ -31,6 +32,9 @@ Demo
         <!-- here we define the main-menu element, `main` is the id of the main menu -->
         <meta name="main-menu" content="main" />
 
+	    <!-- here we define the welcome menu "after pressing get started button" -->
+		<meta name="welcome-menu" content="welcome" />
+
         <!-- whether the bkit server should verify the incoming request "from messenger itself" or not -->
         <meta name="messenger-verify" content="true" />
 
@@ -53,6 +57,11 @@ Demo
 			<a href="#collect" reset="true">Collect Data</a>
         </menu>
 
+        <menu id="welcome" inline="true">
+            <a href="#about">Click Here 1</a>
+            <a href="#about">Click Here 2</a>
+        </menu>
+
         <div id="about">
             <text>I'm bkit, the bots-kit engine</text>
             <text>;)</text>

bot.go

@@ -18,6 +18,7 @@ type Menu struct {
 	Title   string
 	If      string
 	Buttons []*Button
+	Inline  bool
 }
 
 type Button struct {

messenger_session.go

@@ -84,15 +84,16 @@ func (m *MessengerSession) SendInput(input *Input) error {
 		return nil
 	}
 	if input.Type == "options" {
-		callToActions := []messenger.StructuredMessageButton{}
-		for _, btn := range input.Options {
-			cta := messenger.StructuredMessageButton{}
-			cta.Title = btn.Title
-			cta.Type = "postback"
-			cta.Payload = btn.Href
-			callToActions = append(callToActions, cta)
-		}
-		return m.response.ButtonTemplate(input.Title, &callToActions, messenger.MessagingType("RESPONSE"))
+		return m.SendInlineButtons(input.Title, input.Options)
+		// callToActions := []messenger.StructuredMessageButton{}
+		// for _, btn := range input.Options {
+		// 	cta := messenger.StructuredMessageButton{}
+		// 	cta.Title = btn.Title
+		// 	cta.Type = "postback"
+		// 	cta.Payload = btn.Href
+		// 	callToActions = append(callToActions, cta)
+		// }
+		// return m.response.ButtonTemplate(input.Title, &callToActions, messenger.MessagingType("RESPONSE"))
 	}
 	return nil
 }
@@ -102,6 +103,9 @@ func (m *MessengerSession) SendBasicMenu(menu *Menu) error {
 	if menu == nil {
 		return nil
 	}
+	if menu.Inline {
+		return m.SendInlineButtons(menu.Title, menu.Buttons)
+	}
 	callToActions := []messenger.StructuredMessageButton{}
 	for _, btn := range menu.Buttons {
 		cta := messenger.StructuredMessageButton{}
@@ -119,6 +123,19 @@ func (m *MessengerSession) SendBasicMenu(menu *Menu) error {
 	return m.response.ButtonTemplate(menu.Title, &callToActions, messenger.MessagingType("RESPONSE"))
 }
 
+// SendOptions - send a menu to the user
+func (m *MessengerSession) SendInlineButtons(title string, btns []*Button) error {
+	callToActions := []messenger.QuickReply{}
+	for _, btn := range btns {
+		cta := messenger.QuickReply{}
+		cta.Title = btn.Title
+		cta.ContentType = "text"
+		cta.Payload = fmt.Sprintf("trgt=%s&btn=%s", btn.Href[1:], btn.ID)
+		callToActions = append(callToActions, cta)
+	}
+	return m.response.TextWithReplies(title, callToActions, messenger.MessagingType("RESPONSE"))
+}
+
 // SendNodesOf - send the child nodes of the specified node
 func (m *MessengerSession) SendNodesOf(s *goquery.Selection) error {
 	var err error

messenger_wrapper.go

@@ -37,7 +37,7 @@ func NewMessenger(b *Bot) *Messenger {
 }
 
 // SendGreeting - send the greeting data/messages
-func (m Messenger) SendGreeting() error {
+func (m Messenger) SetGreeting() error {
 	if desc, ok := m.bot.Configs["description"]; ok {
 		return m.client.GreetingSetting(desc)
 	}
@@ -55,7 +55,7 @@ func (m Messenger) GetMainMenu() *Menu {
 }
 
 // SendMainMenu - sending the main messenger menu
-func (m Messenger) SendMainMenu(menu *Menu) error {
+func (m Messenger) SetMainMenu(menu *Menu) error {
 	if menu == nil {
 		return nil
 	}
@@ -73,19 +73,33 @@ func (m Messenger) SendMainMenu(menu *Menu) error {
 		}
 		callToActions = append(callToActions, cta)
 	}
-	return m.client.CallToActionsSetting("existing_thread", callToActions)
+	err := m.client.CallToActionsSetting("existing_thread", callToActions)
+	if err != nil {
+		return err
+	}
+	return m.client.CallToActionsSetting("new_thread", []messenger.CallToActionsItem{
+		{
+			Title:   "Get Started ^_^",
+			Type:    "postback",
+			Payload: "get_started",
+		},
+	})
+}
+
+func (m Messenger) GetWelcomeMenu() *Menu {
+	return m.bot.Menus[m.bot.Configs["welcome-menu"]]
 }
 
 // Boot - Setup the default handlers
 func (m Messenger) Boot() {
 	// send the main menu
-	if err := m.SendMainMenu(m.GetMainMenu()); err != nil {
+	if err := m.SetMainMenu(m.GetMainMenu()); err != nil {
 		log.Println(err)
 		return
 	}
 
 	// send greetings
-	if err := m.SendGreeting(); err != nil {
+	if err := m.SetGreeting(); err != nil {
 		log.Println(err)
 		return
 	}
@@ -146,12 +160,12 @@ func (m Messenger) Boot() {
 
 		// get started button ?
 		if p.Payload == "get_started" {
-			if err := m.SendGreeting(); err != nil {
-				log.Println("[greeting]", err)
+			if err := m.SetGreeting(); err != nil {
+				log.Println("[greeting-message]", err)
 				return
 			}
-			if err := session.SendBasicMenu(m.GetMainMenu()); err != nil {
-				log.Println("[menu]", err)
+			if err := session.SendBasicMenu(m.GetWelcomeMenu()); err != nil {
+				log.Println("[welcome-menu]", err)
 				return
 			}
 			return
@@ -187,7 +201,6 @@ func (m Messenger) Boot() {
 			log.Println("[sending menu] has error?", session.SendBasicMenu(m.bot.Menus[trgt.AttrOr("id", "")]))
 		default:
 			r.Text("Sorry, I couldn't understand you", messenger.MessagingType("RESPONSE"))
-			log.Println("[unknown]", "undefined node type", needle.Get("trgt"))
 		}
 	})
 }

parser.go

@@ -29,30 +29,58 @@ func NewBotFromReader(r io.Reader) (*Bot, error) {
 	doc.Find("meta").Each(func(_ int, s *goquery.Selection) {
 		key, _ := s.Attr("name")
 		value, _ := s.Attr("content")
-
+		if key == "" {
+			return
+		}
 		bot.Configs[key] = value
 	})
 
+	// paginate the menu/navs buttons
+	// messanger maximum navigation links are 3 - 4, we will make them 3 by maximum.
+	doc.Find("menu,nav").Each(func(_ int, m *goquery.Selection) {
+		m.SetAttr("inline", m.AttrOr("inline", "false"))
+		if m.AttrOr("inline", "false") == "true" {
+			return
+		}
+		if m.AttrOr("id", "") == bot.Configs["main-menu"] {
+			return
+		}
+		p, cnt := m, 1
+		m.Find("a,button").Each(func(i int, b *goquery.Selection) {
+			if (i > 0) && (i%2 == 0) && m.Find("a,button").Length() > 3 {
+				newId := fmt.Sprintf("%s-%d", m.AttrOr("id", ""), cnt)
+				p.AppendHtml(fmt.Sprintf("<a href='#%s'>%s</a>", newId, "More"))
+				p.AfterHtml(fmt.Sprintf("<menu id='%s' title='%s'></menu>", newId, m.AttrOr("title", "")))
+				p = bot.Document.Find("#" + newId)
+				cnt++
+			}
+			if p != m {
+				p.AppendSelection(b.Clone())
+				b.Remove()
+			}
+		})
+	})
+
 	// populate the navs
 	doc.Find("menu,nav").Each(func(i int, m *goquery.Selection) {
 		menu := &Menu{}
 		menu.ID = m.AttrOr("id", fmt.Sprintf("menu%d", i))
-		menu.Title = m.AttrOr("title", "?")
+		menu.Title = m.AttrOr("title", "Choose")
 		menu.Buttons = []*Button{}
+		menu.Inline = (m.AttrOr("inline", "false") == "true")
 		m.Find("a,button").Each(func(i int, b *goquery.Selection) {
 			btn := &Button{}
 			btn.ID = b.AttrOr("id", fmt.Sprintf("button%d", len(bot.Buttons)+1))
 			btn.Title = b.Text()
 			btn.Href = b.AttrOr("href", "")
 			btn.Embed = b.AttrOr("embed", "false")
 			btn.Reset = (b.AttrOr("reset", "false") == "true")
-
 			menu.Buttons = append(menu.Buttons, btn)
 			bot.Buttons[btn.ID] = btn
-
 			b.SetAttr("id", btn.ID)
 		})
 		m.SetAttr("id", menu.ID)
+		m.SetAttr("title", menu.Title)
 		bot.Menus[menu.ID] = menu
 	})