Merge pull request #157 from julwrites/staging

Functionality updates

Author: julwrites

README.md

@@ -4,6 +4,13 @@
 
 This Telegram bot hopes to make the Bible more accessible, and hopefully to give a timely answer to those looking for it. 
 
+### Features
+*   **Bible Passage**: Get any Bible passage by typing the reference (e.g., "John 3:16").
+*   **Bible Search**: Search for words in the Bible using `/search` (e.g., `/search grace`).
+*   **Bible Ask**: Ask questions about the Bible using `/ask` (e.g., `/ask Who is Moses?`).
+*   **Devotionals**: Get daily reading material with `/devo`.
+*   **TMS**: Get Topical Memory System verses with `/tms`.
+
 ### Feedback
 Star this repo if you found it useful. Use the github issue tracker to give
 feedback on this repo.

pkg/app/api_client.go

@@ -66,7 +66,7 @@ func getAPIConfig() (string, string) {
 
 // SubmitQuery sends the QueryRequest to the Bible API and unmarshals the response into result.
 // result should be a pointer to the expected response struct.
-func SubmitQuery(req QueryRequest, result interface{}, projectID string) error {
+func SubmitQuery(req QueryRequest, result interface{}) error {
 	apiURL, apiKey := getAPIConfig()
 	if apiURL == "" {
 		return fmt.Errorf("BIBLE_API_URL environment variable is not set")

pkg/app/api_client_test.go

@@ -20,7 +20,7 @@ func TestSubmitQuery(t *testing.T) {
 			Context: QueryContext{User: UserContext{Version: "NIV"}},
 		}
 		var resp VerseResponse
-		err := SubmitQuery(req, &resp, "")
+		err := SubmitQuery(req, &resp)
 		if err != nil {
 			t.Errorf("Unexpected error: %v", err)
 		}
@@ -36,7 +36,7 @@ func TestSubmitQuery(t *testing.T) {
 
 		req := QueryRequest{}
 		var resp VerseResponse
-		err := SubmitQuery(req, &resp, "")
+		err := SubmitQuery(req, &resp)
 		if err == nil {
 			t.Error("Expected error when BIBLE_API_URL is unset")
 		}

pkg/app/ask.go

@@ -6,11 +6,14 @@ import (
 	"strings"
 
 	"github.com/julwrites/BotPlatform/pkg/def"
-	"github.com/julwrites/ScriptureBot/pkg/secrets"
 	"github.com/julwrites/ScriptureBot/pkg/utils"
 )
 
 func GetBibleAsk(env def.SessionData) def.SessionData {
+	return GetBibleAskWithContext(env, nil)
+}
+
+func GetBibleAskWithContext(env def.SessionData, contextVerses []string) def.SessionData {
 	if len(env.Msg.Message) > 0 {
 		config := utils.DeserializeUserConfig(env.User.Config)
 
@@ -22,12 +25,12 @@ func GetBibleAsk(env def.SessionData) def.SessionData {
 				User: UserContext{
 					Version: config.Version,
 				},
+				Verses: contextVerses,
 			},
 		}
 
 		var resp OQueryResponse
-		projectID, _ := secrets.Get("GCLOUD_PROJECT_ID")
-		err := SubmitQuery(req, &resp, projectID)
+		err := SubmitQuery(req, &resp)
 		if err != nil {
 			log.Printf("Error asking bible: %v", err)
 			env.Res.Message = "Sorry, I encountered an error processing your question."

pkg/app/bible_reference.go

@@ -15,12 +15,12 @@ var BibleBooks = map[string]string{
 	"joshua": "Joshua", "josh": "Joshua", "jos": "Joshua",
 	"judges": "Judges", "judg": "Judges", "jdg": "Judges",
 	"ruth": "Ruth", "ru": "Ruth", "rth": "Ruth",
-	"1 samuel": "1 Samuel", "1 sam": "1 Samuel", "1 sa": "1 Samuel", "1sam": "1 Samuel", "1sa": "1 Samuel", "i sam": "1 Samuel",
-	"2 samuel": "2 Samuel", "2 sam": "2 Samuel", "2 sa": "2 Samuel", "2sam": "2 Samuel", "2sa": "2 Samuel", "ii sam": "2 Samuel",
-	"1 kings": "1 Kings", "1 kgs": "1 Kings", "1 ki": "1 Kings", "1kings": "1 Kings", "i kgs": "1 Kings",
-	"2 kings": "2 Kings", "2 kgs": "2 Kings", "2 ki": "2 Kings", "2kings": "2 Kings", "ii kgs": "2 Kings",
-	"1 chronicles": "1 Chronicles", "1 chron": "1 Chronicles", "1 chr": "1 Chronicles", "1 ch": "1 Chronicles", "1chronicles": "1 Chronicles", "i chron": "1 Chronicles",
-	"2 chronicles": "2 Chronicles", "2 chron": "2 Chronicles", "2 chr": "2 Chronicles", "2 ch": "2 Chronicles", "2chronicles": "2 Chronicles", "ii chron": "2 Chronicles",
+	"1 samuel": "1 Samuel", "1 sam": "1 Samuel", "1 sa": "1 Samuel", "1sam": "1 Samuel", "1sa": "1 Samuel", "i sam": "1 Samuel", "i samuel": "1 Samuel", "1st samuel": "1 Samuel",
+	"2 samuel": "2 Samuel", "2 sam": "2 Samuel", "2 sa": "2 Samuel", "2sam": "2 Samuel", "2sa": "2 Samuel", "ii sam": "2 Samuel", "ii samuel": "2 Samuel", "2nd samuel": "2 Samuel",
+	"1 kings": "1 Kings", "1 kgs": "1 Kings", "1 ki": "1 Kings", "1kings": "1 Kings", "i kgs": "1 Kings", "i kings": "1 Kings", "1st kings": "1 Kings",
+	"2 kings": "2 Kings", "2 kgs": "2 Kings", "2 ki": "2 Kings", "2kings": "2 Kings", "ii kgs": "2 Kings", "ii kings": "2 Kings", "2nd kings": "2 Kings",
+	"1 chronicles": "1 Chronicles", "1 chron": "1 Chronicles", "1 chr": "1 Chronicles", "1 ch": "1 Chronicles", "1chronicles": "1 Chronicles", "i chron": "1 Chronicles", "i chronicles": "1 Chronicles", "1st chronicles": "1 Chronicles",
+	"2 chronicles": "2 Chronicles", "2 chron": "2 Chronicles", "2 chr": "2 Chronicles", "2 ch": "2 Chronicles", "2chronicles": "2 Chronicles", "ii chron": "2 Chronicles", "ii chronicles": "2 Chronicles", "2nd chronicles": "2 Chronicles",
 	"ezra": "Ezra", "ezr": "Ezra",
 	"nehemiah": "Nehemiah", "neh": "Nehemiah", "ne": "Nehemiah",
 	"esther": "Esther", "est": "Esther", "esth": "Esther",
@@ -54,25 +54,25 @@ var BibleBooks = map[string]string{
 	"john": "John", "jn": "John", "jhn": "John", "joh": "John",
 	"acts": "Acts", "ac": "Acts", "act": "Acts",
 	"romans": "Romans", "rom": "Romans", "ro": "Romans", "rm": "Romans",
-	"1 corinthians": "1 Corinthians", "1 cor": "1 Corinthians", "1 co": "1 Corinthians", "1cor": "1 Corinthians", "i cor": "1 Corinthians",
-	"2 corinthians": "2 Corinthians", "2 cor": "2 Corinthians", "2 co": "2 Corinthians", "2cor": "2 Corinthians", "ii cor": "2 Corinthians",
+	"1 corinthians": "1 Corinthians", "1 cor": "1 Corinthians", "1 co": "1 Corinthians", "1cor": "1 Corinthians", "i cor": "1 Corinthians", "i corinthians": "1 Corinthians", "1st corinthians": "1 Corinthians",
+	"2 corinthians": "2 Corinthians", "2 cor": "2 Corinthians", "2 co": "2 Corinthians", "2cor": "2 Corinthians", "ii cor": "2 Corinthians", "ii corinthians": "2 Corinthians", "2nd corinthians": "2 Corinthians",
 	"galatians": "Galatians", "gal": "Galatians", "ga": "Galatians",
 	"ephesians": "Ephesians", "eph": "Ephesians", "ep": "Ephesians",
 	"philippians": "Philippians", "phil": "Philippians", "php": "Philippians",
 	"colossians": "Colossians", "col": "Colossians",
-	"1 thessalonians": "1 Thessalonians", "1 thess": "1 Thessalonians", "1 th": "1 Thessalonians", "1thess": "1 Thessalonians", "i thess": "1 Thessalonians",
-	"2 thessalonians": "2 Thessalonians", "2 thess": "2 Thessalonians", "2 th": "2 Thessalonians", "2thess": "2 Thessalonians", "ii thess": "2 Thessalonians",
-	"1 timothy": "1 Timothy", "1 tim": "1 Timothy", "1 ti": "1 Timothy", "1tim": "1 Timothy", "i tim": "1 Timothy",
-	"2 timothy": "2 Timothy", "2 tim": "2 Timothy", "2 ti": "2 Timothy", "2tim": "2 Timothy", "ii tim": "2 Timothy",
+	"1 thessalonians": "1 Thessalonians", "1 thess": "1 Thessalonians", "1 th": "1 Thessalonians", "1thess": "1 Thessalonians", "i thess": "1 Thessalonians", "i thessalonians": "1 Thessalonians", "1st thessalonians": "1 Thessalonians",
+	"2 thessalonians": "2 Thessalonians", "2 thess": "2 Thessalonians", "2 th": "2 Thessalonians", "2thess": "2 Thessalonians", "ii thess": "2 Thessalonians", "ii thessalonians": "2 Thessalonians", "2nd thessalonians": "2 Thessalonians",
+	"1 timothy": "1 Timothy", "1 tim": "1 Timothy", "1 ti": "1 Timothy", "1tim": "1 Timothy", "i tim": "1 Timothy", "i timothy": "1 Timothy", "1st timothy": "1 Timothy",
+	"2 timothy": "2 Timothy", "2 tim": "2 Timothy", "2 ti": "2 Timothy", "2tim": "2 Timothy", "ii tim": "2 Timothy", "ii timothy": "2 Timothy", "2nd timothy": "2 Timothy",
 	"titus": "Titus", "tit": "Titus", "ti": "Titus",
 	"philemon": "Philemon", "philem": "Philemon", "phlm": "Philemon", "phm": "Philemon",
 	"hebrews": "Hebrews", "heb": "Hebrews", "he": "Hebrews",
 	"james": "James", "jas": "James", "jm": "James",
-	"1 peter": "1 Peter", "1 pet": "1 Peter", "1 pe": "1 Peter", "1 pt": "1 Peter", "1peter": "1 Peter", "i pet": "1 Peter",
-	"2 peter": "2 Peter", "2 pet": "2 Peter", "2 pe": "2 Peter", "2 pt": "2 Peter", "2peter": "2 Peter", "ii pet": "2 Peter",
-	"1 john": "1 John", "1 jn": "1 John", "1jn": "1 John", "1john": "1 John", "i jn": "1 John",
-	"2 john": "2 John", "2 jn": "2 John", "2jn": "2 John", "2john": "2 John", "ii jn": "2 John",
-	"3 john": "3 John", "3 jn": "3 John", "3jn": "3 John", "3john": "3 John", "iii jn": "3 John",
+	"1 peter": "1 Peter", "1 pet": "1 Peter", "1 pe": "1 Peter", "1 pt": "1 Peter", "1peter": "1 Peter", "i pet": "1 Peter", "i peter": "1 Peter", "1st peter": "1 Peter",
+	"2 peter": "2 Peter", "2 pet": "2 Peter", "2 pe": "2 Peter", "2 pt": "2 Peter", "2peter": "2 Peter", "ii pet": "2 Peter", "ii peter": "2 Peter", "2nd peter": "2 Peter",
+	"1 john": "1 John", "1 jn": "1 John", "1jn": "1 John", "1john": "1 John", "i jn": "1 John", "i john": "1 John", "1st john": "1 John",
+	"2 john": "2 John", "2 jn": "2 John", "2jn": "2 John", "2john": "2 John", "ii jn": "2 John", "ii john": "2 John", "2nd john": "2 John",
+	"3 john": "3 John", "3 jn": "3 John", "3jn": "3 John", "3john": "3 John", "iii jn": "3 John", "iii john": "3 John", "3rd john": "3 John",
 	"jude": "Jude", "jud": "Jude", "jd": "Jude",
 	"revelation": "Revelation", "rev": "Revelation", "re": "Revelation",
 }
@@ -110,63 +110,15 @@ func init() {
 // ParseBibleReference parses a string to identify and normalize a Bible reference.
 // It returns the normalized reference string and a boolean indicating validity.
 func ParseBibleReference(input string) (string, bool) {
-	trimmedInput := strings.TrimSpace(input)
-	if trimmedInput == "" {
+	ref, consumedLen, ok := ParseBibleReferenceFromStart(input)
+	if !ok {
 		return "", false
 	}
-	lowerInput := strings.ToLower(trimmedInput)
-
-	var foundBook string
-	var bookName string
-	var remainder string
-
-	// 1. Try exact match (Greedy)
-	for _, key := range sortedBookKeys {
-		if strings.HasPrefix(lowerInput, key) {
-			matchLen := len(key)
-			if len(lowerInput) > matchLen {
-				nextChar := lowerInput[matchLen]
-				if isLetter(nextChar) {
-					continue
-				}
-			}
-
-			foundBook = key
-			bookName = BibleBooks[key]
-			remainder = strings.TrimSpace(trimmedInput[matchLen:])
-			break
-		}
-	}
-
-	// 2. If no exact match, try fuzzy matching
-	if foundBook == "" {
-		fBook, matchLen := findFuzzyMatch(trimmedInput) // Pass original case for splitting, but logic handles case
-		if fBook != "" {
-			bookName = fBook
-			foundBook = fBook // Mark as found
-			remainder = strings.TrimSpace(trimmedInput[matchLen:])
-		}
-	}
-
-	if foundBook == "" {
+	// Verify that we consumed the entire string (ignoring whitespace)
+	if len(strings.TrimSpace(input[consumedLen:])) > 0 {
 		return "", false
 	}
-
-	// Check remainder
-	if remainder == "" {
-		if SingleChapterBooks[bookName] {
-			return bookName, true
-		}
-		// Multi-chapter book defaults to chapter 1
-		return bookName + " 1", true
-	}
-
-	// Remainder validation
-	if isValidReferenceSyntax(remainder) {
-		return bookName + " " + remainder, true
-	}
-
-	return "", false
+	return ref, true
 }
 
 func findFuzzyMatch(input string) (string, int) {
@@ -246,19 +198,147 @@ func isLetter(c byte) bool {
 	return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
 }
 
-func isValidReferenceSyntax(s string) bool {
-	hasDigit := false
-	for _, r := range s {
-		switch {
-		case r >= '0' && r <= '9':
-			hasDigit = true
-		case r == ' ' || r == ':' || r == '-' || r == '.' || r == ',' || r == '\t':
+// ExtractBibleReferences extracts all valid Bible references from a text.
+func ExtractBibleReferences(input string) []string {
+	var refs []string
+
+	startIdx := 0
+	length := len(input)
+
+	for startIdx < length {
+		// If we are at a whitespace, advance.
+		if input[startIdx] == ' ' || input[startIdx] == '\t' || input[startIdx] == '\n' || input[startIdx] == '\r' {
+			startIdx++
+			continue
+		}
+
+		ref, consumed, ok := ParseBibleReferenceFromStart(input[startIdx:])
+		if ok {
+			refs = append(refs, ref)
+			startIdx += consumed
+		} else {
+			// Advance to next word
+			nextSpace := strings.IndexAny(input[startIdx:], " \t\n\r")
+			if nextSpace == -1 {
+				break
+			}
+			startIdx += nextSpace
+		}
+	}
+	return refs
+}
+
+// ParseBibleReferenceFromStart attempts to parse a Bible reference at the beginning of the string.
+// Returns the normalized reference, the length of text consumed from input, and whether a match was found.
+func ParseBibleReferenceFromStart(input string) (string, int, bool) {
+	// 1. Skip leading whitespace
+	startOffset := 0
+	for startOffset < len(input) && (input[startOffset] == ' ' || input[startOffset] == '\t' || input[startOffset] == '\n' || input[startOffset] == '\r') {
+		startOffset++
+	}
+	if startOffset == len(input) {
+		return "", 0, false
+	}
+
+	currentInput := input[startOffset:]
+	lowerInput := strings.ToLower(currentInput)
+
+	var foundBook string
+	var bookName string
+	var matchLen int // Length in currentInput
+
+	// 1. Try exact match (Greedy)
+	for _, key := range sortedBookKeys {
+		if strings.HasPrefix(lowerInput, key) {
+			mLen := len(key)
+			// Ensure whole word match
+			if len(lowerInput) > mLen {
+				nextChar := lowerInput[mLen]
+				if isLetter(nextChar) {
+					continue
+				}
+			}
+
+			foundBook = key
+			bookName = BibleBooks[key]
+			matchLen = mLen
+			break
+		}
+	}
+
+	// 2. If no exact match, try fuzzy matching
+	if foundBook == "" {
+		fBook, mLen := findFuzzyMatch(currentInput)
+		if fBook != "" {
+			bookName = fBook
+			foundBook = fBook
+			matchLen = mLen
+		}
+	}
+
+	if foundBook == "" {
+		return "", 0, false
+	}
+
+	// We found a book. Now parse the numbers (remainder).
+	remainderStart := matchLen
+	// Skip spaces after book
+	for remainderStart < len(currentInput) && (currentInput[remainderStart] == ' ' || currentInput[remainderStart] == '\t') {
+		remainderStart++
+	}
+
+	remainder := currentInput[remainderStart:]
+
+	// Consume valid reference syntax
+	syntax, syntaxLen := consumeReferenceSyntax(remainder)
+
+	totalConsumed := startOffset + remainderStart + syntaxLen
+
+	if syntax == "" {
+		if SingleChapterBooks[bookName] {
+			return bookName, totalConsumed, true
+		}
+		// Multi-chapter book defaults to chapter 1
+		return bookName + " 1", totalConsumed, true
+	}
+
+	if hasDigit(syntax) {
+		return bookName + " " + syntax, totalConsumed, true
+	}
+
+	if SingleChapterBooks[bookName] {
+		return bookName, startOffset + matchLen, true // Don't consume the invalid syntax
+	}
+	return bookName + " 1", startOffset + matchLen, true
+}
+
+func consumeReferenceSyntax(s string) (string, int) {
+	lastDigit := -1
+
+	for i, r := range s {
+		if r >= '0' && r <= '9' {
+			lastDigit = i
+		} else if r == ':' || r == '-' || r == '.' || r == ',' || r == ' ' || r == '\t' {
 			continue
-		default:
-			return false // Invalid character
+		} else {
+			break
+		}
+	}
+
+	if lastDigit == -1 {
+		return "", 0
+	}
+
+	return s[:lastDigit+1], lastDigit+1
+}
+
+func hasDigit(s string) bool {
+	for _, r := range s {
+		if r >= '0' && r <= '9' {
+			return true
 		}
 	}
-	return hasDigit
+	return false
 }
 
 func levenshteinDistance(s1, s2 string) int {

pkg/app/bible_reference_test.go

@@ -66,3 +66,31 @@ func TestParseBibleReference(t *testing.T) {
 		}
 	}
 }
+
+func TestExtractBibleReferences(t *testing.T) {
+	tests := []struct {
+		input    string
+		expected []string
+	}{
+		{"Read John 3:16", []string{"John 3:16"}},
+		{"Compare Gen 1:1 and Ex 20", []string{"Genesis 1:1", "Exodus 20"}},
+		{"What does it say in Mark 5?", []string{"Mark 5"}},
+		{"I like Genesis", []string{"Genesis 1"}}, // Defaults to 1? Yes, per current logic.
+		{"No references here", nil},
+		{"John said hello", []string{"John 1"}}, // False positive risk, but per logic.
+		{"Read 1 John 3 and 2 John", []string{"1 John 3", "2 John"}},
+	}
+
+	for _, tt := range tests {
+		result := ExtractBibleReferences(tt.input)
+		if len(result) != len(tt.expected) {
+			t.Errorf("ExtractBibleReferences(%q) length = %d, want %d", tt.input, len(result), len(tt.expected))
+			continue
+		}
+		for i, ref := range result {
+			if ref != tt.expected[i] {
+				t.Errorf("ExtractBibleReferences(%q)[%d] = %q, want %q", tt.input, i, ref, tt.expected[i])
+			}
+		}
+	}
+}