seekr-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2702b21ccb5e5c2a221ebe11a1928e8edb4006c
+  data.tar.gz: 6737c33c134d4fc089707c9e9cd5aba017748707
+SHA512:
+  metadata.gz: 34306866f588550c3c78f71101e94c785cdf1c1d5437140e2904233ec4e5a4b6ce91682018f5e4139a50ad1b52abd7c5e95dbecfb66d8455d1974c443f3e774d
+  data.tar.gz: fd71d4da8b550e7e3c92d41703d8017b507a981b5f2b9740d6e0c3e9c9afa71d5b91463bfcd2a8b2b01d5d47ce5ea1991c45286eb956d5dbffc2bea6eb938fa8

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+sekr-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "2.2.0"
+  - "1.9.3"
+
+addons:
+  code_climate:
+    repo_token: 39dd34a749a1e3a5e4a1e08f97d454ee71fb2b079f8a447447d27e8c1ea1867d

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seekr-ruby.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Rodrigo Pinto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rodrigo Pinto
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,202 @@
+# Seekr::Ruby
+
+[![Build Status][travis_badge]][travis]
+[![Code Climate][codeclimate_badge]][codeclimate]
+[![Test Coverage][test_badge]][test]
+
+Ruby client for [Seekr Monitor][seekr] API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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:
+
+```ruby
+Seekr.configure do |config|
+  config.api_key = "<API-KEY>"
+  config.api_secret = "<API-SECRET>"
+end
+```
+
+### Searching for monitors
+
+Run:
+
+```ruby
+monitor = Seekr::Monitor.new
+monitor.all
+```
+
+It results:
+
+```json
+{
+  "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:
+
+```ruby
+monitor = Seekr::Monitor.new
+monitor.find(9999)
+```
+
+It results:
+
+```json
+{
+  "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:
+
+```ruby
+monitor = Seekr::Monitor.new
+monitor.tags(9999)
+```
+
+It results:
+
+```json
+{
+  "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:
+
+```ruby
+report = Seekr::Report.new(9999)
+report.general
+```
+
+It results:
+
+```json
+{
+  "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
+
+1. Fork it ( https://github.com/rodrigopinto/seekr-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[travis]: https://travis-ci.org/rodrigopinto/seekr-ruby
+[travis_badge]: https://travis-ci.org/rodrigopinto/seekr-ruby.svg?branch=master
+
+[codeclimate]: https://codeclimate.com/github/rodrigopinto/seekr-ruby
+[codeclimate_badge]: https://codeclimate.com/github/rodrigopinto/seekr-ruby/badges/gpa.svg
+
+[test]: https://codeclimate.com/github/rodrigopinto/seekr-ruby
+[test_badge]:https://codeclimate.com/github/rodrigopinto/seekr-ruby/badges/coverage.svg
+
+[seekr]: http://seekr.com.br/

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+
+rescue LoadError
+  # no rspec available
+end

data/lib/seekr.rb

@@ -0,0 +1,34 @@
+require "seekr/client"
+require "seekr/configuration"
+require "seekr/errors"
+require "seekr/monitor"
+require "seekr/occurrence"
+require "seekr/report"
+require "seekr/version"
+
+require 'active_support/core_ext/time'
+
+Time.zone = "Brasilia"
+
+module Seekr
+
+  def self.configure(&block)
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Seekr::Configuration.new
+  end
+
+  def self.api_key
+    configuration.api_key
+  end
+
+  def self.api_secret
+    configuration.api_secret
+  end
+
+  def self.reset
+    @configuration = nil
+  end
+end

data/lib/seekr/client.rb

@@ -0,0 +1,40 @@
+require 'rest-client'
+
+module Seekr
+  module Client
+
+    BASE_URL = "http://monitoramento.seekr.com.br/api"
+
+    def get(method, params={})
+      url = build_url(method, params)
+      _get(url)
+    end
+
+    private
+      def _get(url)
+        RestClient.get url do |response, request, result, &block|
+          case response.code
+          when 200
+            response
+          when 403
+            raise Seekr::HTTPForbidden
+          end
+        end
+      end
+
+      def build_url(method, params={})
+        query_params = default_params.merge(params).to_param
+        "#{BASE_URL}#{method}.json?#{query_params}"
+      end
+
+      def default_params
+        timestamp = Time.zone.now.to_i
+        hash = Digest::SHA1.hexdigest("#{Seekr.api_secret}#{timestamp}")
+        {
+          key: Seekr.api_key,
+          ts: timestamp,
+          hash: hash
+        }
+      end
+  end
+end

data/lib/seekr/configuration.rb

@@ -0,0 +1,6 @@
+module Seekr
+  class Configuration
+    attr_accessor :api_key
+    attr_accessor :api_secret
+  end
+end

data/lib/seekr/errors.rb

@@ -0,0 +1,4 @@
+module Seekr
+  class Error < StandardError; end
+  class HTTPForbidden < Error; end
+end

data/lib/seekr/monitor.rb

@@ -0,0 +1,17 @@
+module Seekr
+  class Monitor
+    include Seekr::Client
+
+    def all
+      get("/searches")
+    end
+
+    def find(id)
+      get("/search", search_id: id)
+    end
+
+    def tags(id)
+      get("/tags", search_id: id)
+    end
+  end
+end

data/lib/seekr/occurrence.rb

@@ -0,0 +1,10 @@
+module Seekr
+  class Occurrence
+    include Seekr::Client
+
+    def find_for(monitor_id, options = {})
+      params = { search_id: monitor_id, per_page: 100 }.merge(options)
+      get("/search_results", params)
+    end
+  end
+end

data/lib/seekr/report.rb

@@ -0,0 +1,39 @@
+module Seekr
+  class Report
+    include Seekr::Client
+
+    def initialize(monitor_id)
+      @monitor_id = monitor_id
+    end
+
+    def general(filters={})
+      fetch("/report", filters)
+    end
+
+    def by_cities(filters={})
+      fetch("/report_cities", filters)
+    end
+
+    def by_tags(filters={})
+      fetch("/report_tags", filters)
+    end
+
+    def by_states(filters={})
+      fetch("/report_states", filters)
+    end
+
+    def by_words(filters={})
+      fetch("/report_words", filters)
+    end
+
+    def by_people(filters={})
+      fetch("/report_users", filters)
+    end
+
+    private
+    def fetch(report, filters)
+      filters.merge!({ search_id: @monitor_id })
+      get(report, filters)
+    end
+  end
+end

data/lib/seekr/version.rb

@@ -0,0 +1,3 @@
+module Seekr
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: seekr-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rodrigo Pinto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.3
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+description: Ruby client for Seekr Monitor API.
+email:
+- rodrigopqn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/seekr.rb
+- lib/seekr/client.rb
+- lib/seekr/configuration.rb
+- lib/seekr/errors.rb
+- lib/seekr/monitor.rb
+- lib/seekr/occurrence.rb
+- lib/seekr/report.rb
+- lib/seekr/version.rb
+homepage: http://github.com/rodrigopinto/seekr-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for Seekr Monitor API.
+test_files: []