Seekr::Ruby
Ruby client for Seekr Monitor API.
Installation
Add this line to your application's Gemfile:
gem 'seekr-ruby'And then execute:
$ bundle
Or install it yourself as:
$ gem install seekr-ruby
Usage
Configure API keys
Create a file config/initializers/seekr.rb and add:
Seekr.configure do |config|
config.api_key = "<API-KEY>"
config.api_secret = "<API-SECRET>"
endGetting all monitor occurrences
Run:
occurrence = Seekr::Occurrence.new(12345)
occurrence.all_paginatedIt results:
{
"response": {
"status": "200 OK",
"code": 200
},
"search_results": [
{
"id": 9999,
"title": "",
"text": "Some String goes here",
"url": "http://example.com/user/statuses/9999999999",
"media_id": 2412312312,
"published_on": "2014-11-07T18:40:54.000-02:00",
"user": "user",
"user_id": null,
"user_image": "https://cdn.exampl.com/profile_images/9999999999/image.png",
"attached_image_url": null,
"social_media": "twitter",
"search_term": "\"term\"",
"polarization": 0,
"reach": 15794,
"favorite": false,
"latitude": null,
"longitude": null,
"country": null,
"country_short": null,
"state": null,
"state_short": null,
"city": null,
"gender": null
},
{
"id": 9999,
"title": "",
"text": "Some String goes here",
"url": "http://example.com/user/statuses/9999999999",
"media_id": 2412312312,
"published_on": "2014-11-07T18:40:54.000-02:00",
"user": "user",
"user_id": null,
"user_image": "https://cdn.exampl.com/profile_images/9999999999/image.png",
"attached_image_url": null,
"social_media": "twitter",
"search_term": "\"term\"",
"polarization": 0,
"reach": 15794,
"favorite": false,
"latitude": null,
"longitude": null,
"country": null,
"country_short": null,
"state": null,
"state_short": null,
"city": null,
"gender": null
}
],
"tags": 1,
"medias": 4,
"active": true,
"sentiment_analysis": true
}Searching for monitors
Run:
monitor = Seekr::Monitor.new
monitor.allIt results:
{
"response": {
"status": "200 OK",
"code": 200
},
"searches": [
{
"id": 1,
"name": "Monitor one",
"search_results": 1243,
"search_terms": 2,
"tags": 7,
"medias": 3,
"active": true,
"sentiment_analysis": false
},
{
"id": 2,
"name": "Monitor two",
"search_results": 546,
"search_terms": 5,
"tags": 2,
"medias": 0,
"active": false,
"sentiment_analysis": false
}
]
}
Searching for a specific monitor
Run:
monitor = Seekr::Monitor.new
monitor.find(9999)It results:
{
"response": {
"status": "200 OK",
"code": 200
},
"search": {
"id": 11111,
"name": "[Dashboard] Cards",
"start_date": "01/11/2013",
"search_results": 10641,
"search_terms": [
{
"term": "Some Term",
"id": 1
},
{
"term": "some term",
"id": 2
}
],
"tags": 10,
"medias": 4,
"active": false,
"sentiment_analysis": true
}
}Searching for tags of a monitor
Run:
monitor = Seekr::Monitor.new
monitor.tags(9999)It results:
{
"response": {
"status": "200 OK",
"code": 200
},
"tags": [
{
"id": 1,
"name": "Awesome Tag",
"search_results": 53
},
{
"id": 2,
"name": "Another Tag",
"search_results": 37
}
]
}Report
General report
Run:
report = Seekr::Report.new(9999)
report.generalIt results:
{
"response": {
"status": "200 OK",
"code": 200
},
"report": {
"total": 2483,
"positive": 847,
"neutral": 1156,
"negative": 480,
"positive_perc": 34.4,
"neutral_perc": 46.3,
"negative_perc": 19.3
}
}Contributing
- Fork it ( https://github.com/rodrigopinto/seekr-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request