Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmrodri/wordcounter
https://github.com/jmrodri/wordcounter
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jmrodri/wordcounter
- Owner: jmrodri
- Created: 2018-10-08T23:05:48.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-10-08T23:38:57.000Z (about 6 years ago)
- Last Synced: 2024-11-06T15:58:53.572Z (about 2 months ago)
- Language: Go
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Word Counter
Simple API that counts the words per sentence and the total number of letters in
the given input.
## Build
To build `wordcounter`, you can just do a normal `go build`.
```
go get -u github.com/gorilla/mux
go get github.com/stretchr/testify
go build
```
## Run
After you run `go build`, a `wordcounter` executable will be written.
`wordcounter` listens on port 9090.
```
$ ./wordcounter
2018/10/08 19:12:04 Listening on http://localhost:9090
```
## Unit Testing
You can test the code using `go test`
```
# QUIET MODE
$ go test
PASS
ok github.com/jmrodri/wordcounter 0.003s
```
```
# VERBOSE MODE
$ go test -v
=== RUN TestSplitSentences
--- PASS: TestSplitSentences (0.00s)
=== RUN TestCountWordsPerSentence
--- PASS: TestCountWordsPerSentence (0.00s)
=== RUN TestCountCharacters
--- PASS: TestCountCharacters (0.00s)
=== RUN TestNewHandler
--- PASS: TestNewHandler (0.00s)
=== RUN TestWordCounter
--- PASS: TestWordCounter (0.00s)
=== RUN TestLetterCounter
--- PASS: TestLetterCounter (0.00s)
PASS
ok github.com/jmrodri/wordcounter 0.003s
```
## Testing API
You can connect to the API using `curl`. There are two test scripts in this
project that can be modified to test the API.
```
$ ls -l *.sh
-rwxrwxr-x. 1 jesusr jesusr 258 Oct 8 10:12 letter_counter.sh*
-rwxrwxr-x. 1 jesusr jesusr 263 Oct 8 10:15 word_per_sentence.sh*
```
Here is an example of the total letter count API. Pass in the `Content-type` and
`Accept` headers and the input data. The input is a simple key:value pair but
the key is currently ignored. The important portion is the sentence string.
```bash
#!/bin/bash -e
req='{"somekey":"This is a sentence. But is this? I KNOW THIS IS!" }'
curl \
-k \
-X POST \
-H "Content-type: application/json" \
-H "Accept: application/json" \
-d "$req" \
"http://localhost:9090/total_letter_count"
```
## NOTES
Most times I use a Makefile to build my go projects since they are usually more
complicated than this particular project. Also, dep is used for dependencies but
with only 2 external deps I chose not to use that.