<commit_before>= tweethook

A simple Ruby wrapper for accessing Tweethook's API.

= required gems

* tyhpoeus
* json

= required ENV variables

* TWEETHOOK_API_USER
* TWEETHOOK_API_PASS
* TWEETHOOK_SIGNATURE

See http://docs.heroku.com/config-vars for the how and why.

= Usage

There are three main classes 

* Tweethook::Search
* Tweethook::Post
* Tweethook::Result


= Creating a new search

search = Tweethook::Search.create('my keyword, :webhook => 'http://mysite.com/callback')

All the properties are accessible as instance methods

search.id => 12560301
search.search => 'my keyword'
search.webhook => 'http://mysite.com/callback'
search.format => 'json' # this lib only works w/ the JSON format<commit_msg>fixed typo<commit_after>= tweethook

A simple Ruby wrapper for accessing Tweethook's API.

= required gems

* tyhpoeus
* json

= required ENV variables

* TWEETHOOK_API_USER
* TWEETHOOK_API_PASS
* TWEETHOOK_SIGNATURE

See http://docs.heroku.com/config-vars for the how and why.

= Usage

There are three main classes 

* Tweethook::Search
* Tweethook::Post
* Tweethook::Result


= Creating a new search

search = Tweethook::Search.create('my keyword', :webhook => 'http://mysite.com/callback')

All the properties are accessible as instance methods

search.id => 12560301
search.search => 'my keyword'
search.webhook => 'http://mysite.com/callback'
search.format => 'json' # this lib only works w/ the JSON format
{'fraction_non_alphanumeric': 0.1057422969187675, 'fraction_numerical': 0.011204481792717087, 'mean_word_length': 4.670634920634921, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 13, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6556021', 'n_tokens_mistral': 505, 'n_tokens_neox': 472, 'n_words': 140}