{"id":15608978,"url":"https://github.com/sirius248/simple_boggle_api","last_synced_at":"2026-04-28T20:04:31.392Z","repository":{"id":148483205,"uuid":"104376964","full_name":"sirius248/simple_boggle_api","owner":"sirius248","description":null,"archived":false,"fork":false,"pushed_at":"2017-09-22T09:56:15.000Z","size":230,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-04T15:28:28.236Z","etag":null,"topics":["ruby","ruby-on-rails"],"latest_commit_sha":null,"homepage":"https://simple-boggle-api.herokuapp.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sirius248.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-21T17:15:19.000Z","updated_at":"2023-03-04T05:57:39.000Z","dependencies_parsed_at":null,"dependency_job_id":"cbfe7bb9-eea9-452d-8a03-127c92f69c08","html_url":"https://github.com/sirius248/simple_boggle_api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius248%2Fsimple_boggle_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius248%2Fsimple_boggle_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius248%2Fsimple_boggle_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sirius248%2Fsimple_boggle_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sirius248","download_url":"https://codeload.github.com/sirius248/simple_boggle_api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246195115,"owners_count":20738804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ruby","ruby-on-rails"],"created_at":"2024-10-03T05:40:40.364Z","updated_at":"2025-11-11T21:15:29.027Z","avatar_url":"https://github.com/sirius248.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simple Boggle API\n\n[![Code Climate](https://codeclimate.com/github/kimquy/simple_boggle_api/badges/gpa.svg)](https://codeclimate.com/github/kimquy/simple_boggle_api)\n\n[![Build Status](https://travis-ci.org/kimquy/simple_boggle_api.svg?branch=master)](https://travis-ci.org/kimquy/simple_boggle_api)\n\n## Main files\n\n```ruby\n# The main implementation will be inside the following files\n\napp/controllers/boggles_controller.rb\napp/models/boggle.rb\napp/models/node.rb\napp/services/board_factory.rb\napp/services/boggle_checker.rb\napp/services/boggle_finder.rb\napp/services/null_boggle.rb\napp/services/play_boggle.rb\nlib/boggle_dictionary.rb\ndb/migration\nconfig/routes.rb\n\n# All the unit tests inside the following folder\nspec/\n```\n\n## API\n\n```ruby\n# Create new boggle\nPOST /boggles\n{\n  data: \"T, A, P, *, E, A, K, S, O, B, R, S, S, *, X, D\"\n}\n\n# Query current boggle board\nGET /boggles/current_board\n\n# Check if a word in current boggle board\nGET /boggles/check\n{\n  query: 'tap'\n}\n\n# Get all found words for current board\nGET /boggles/found_words\n\n# To Play a boggle game\n# The timer will be in second. If user don't pass the timer then the default will be 1 minutes. Or if the user pass timer more than 3 minutes then it will be 3 minutes.\nGET /boggle/play_game\n{\n  timer: 5\n}\n\n```\n\n\n## Test with Curl\n\n```ruby\n# Test if a word in current board\ncurl -H \"Content-Type: application/json\" -X GET -d '{\"query\":\"tap\"}' https://simple-boggle-api.herokuapp.com/boggles/check\n\n\n# Get the current board\ncurl -H \"Content-Type: application/json\" -X GET https://simple-boggle-api.herokuapp.com/boggles/current_board\n\n# Create new boggle\n\ncurl -H \"Content-Type: application/json\" -X POST -d '{\"data\":\"T, A, P, *, E, A, K, S, O, B, R, S, S, *, X, D\"}' https://simple-boggle-api.herokuapp.com/boggles\n\n# Get all found words for current board\ncurl -H \"Content-Type: application/json\" -X GET https://simple-boggle-api.herokuapp.com/boggles/found_words\n\n# Play game\ncurl -H \"Content-Type: application/json\" -X GET -d '{\"timer\":\"5\"}' https://simple-boggle-api.herokuapp.com/boggles/play_game\n```\n\n## Unit tests\n\n```ruby\nbundle exec rspec\n```\n\n## Improvement\n* Clean up the algorithm for BoggleChecker\n* Add more meaningful test case\n* There're still many other thing can be improve. Such as: the API is very simple, or validation or check for bad data submit from user.\n\n## Screenshots\n![0](https://user-images.githubusercontent.com/2282642/30738627-e47fa504-9fb4-11e7-99da-783bdf6b0e14.png)\n\n![1](https://user-images.githubusercontent.com/2282642/30710069-89c5a7b6-9f2e-11e7-87b0-d2ec8675ede8.png)\n\n![2](https://user-images.githubusercontent.com/2282642/30710067-896528e6-9f2e-11e7-9be1-25d3854e39f3.png)\n\n![3](https://user-images.githubusercontent.com/2282642/30710068-899987d0-9f2e-11e7-87f1-a709fd2084f1.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsirius248%2Fsimple_boggle_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsirius248%2Fsimple_boggle_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsirius248%2Fsimple_boggle_api/lists"}