social_media_monitoring 0.0.3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in social_media_monitoring.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nikolai Manek
+
+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,79 @@
+# SocialMediaMonitoring
+
+SocialMediaMonitoring is a collection of API methods of the Apphera API. At this time it offers sentiment analysis and keyword tracking for Google search rankings.
+The API is currently in BETA. I will add more methods and documentation soon.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'social_media_monitoring'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install social_media_monitoring
+
+## Basic usage
+
+Sentiment Analysis
+
+require 'social_media_monitoring'
+client = SocialMediaMonitoring::Client.new("987634f072b7c51db349bda9fd5cd6da")
+=> #<SocialMediaMonitoring::Client:0x007fa19422d390 @api_key="987634f072b7c51db349bda9fd5cd6da", @api_path="">
+
+sentiment = client.sentiment("I love Ruby!","en")
+=> <Mash response=<Mash polarity=1 sentiment=0.325>>
+or
+sentiment = client.sentiment("amore","it")
+=> <Mash response=<Mash polarity=1 sentiment=0.325>>
+
+The sentiment analyzer returns a Mash which you can read like this:
+sentiment.response.polarity
+=> 1
+sentiment.response.sentiment
+=> 0.325
+
+At this time the API supports the following languages:
+English (en)
+German (de)
+Italian (it)
+Spanish (es)
+French (fr)
+Turk (tr)
+
+
+Keyword tracking
+
+require 'social_media_monitoring'
+client = SocialMediaMonitoring::Client.new("987634f072b7c51db349bda9fd5cd6da")
+=> #<SocialMediaMonitoring::Client:0x007fa19422d390 @api_key="987634f072b7c51db349bda9fd5cd6da", @api_path="">
+
+client.create_keyword("Ruby rulez")
+=> <Mash response=<Mash first_check="2012-07-02T23:36:32+00:00" id=553 keyword="Ruby rulez">>
+
+It responds with the keyword id, keyword and a date which tells you when you should expect results. The rankings will be updated frequently and
+the history is stored. This allows you to track keyword positions in search results over time.
+
+client.keywords
+
+=> returns a Mash with keywords you are tracking
+
+client.show_keyword(553)  #id of keyword
+
+=> returns current and historic rankings
+
+The search results are paginated
+
+You can get a free API key at https://developer.apphera.com
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/social_media_monitoring.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'mash'
+require 'mash'
+gem 'httparty'
+require 'httparty'
+
+
+class APIKeyNotSet   < StandardError; end
+
+module SocialMediaMonitoring
+  
+  # Get your API key from https://developer.apphera.com
+  def self.api_key
+    raise APIKeyNotSet if @api_key.nil?
+    @api_key
+  end
+  
+  def self.api_key=(api_key)
+    @api_key = api_key
+  end
+  
+end
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+require File.join(directory, 'social_media_monitoring', 'client')

data/lib/social_media_monitoring/client.rb

@@ -0,0 +1,44 @@
+module SocialMediaMonitoring
+  class Client
+    include HTTParty
+    base_uri 'https://api.apphera.com/1'
+    format :json
+
+    attr_reader :api_key
+
+    # Get a free api_key @ https://developer.apphera.com
+    def initialize(api_key=nil)
+      @api_key = api_key
+      @api_key ||= SocialMediaMonitoring.api_key
+      @api_path = ''
+
+    end
+
+    def keywords
+      results = Mash.new(self.class.get('/keywords', :query => self.default_options))
+    end
+
+    def create_keyword(keyword)
+      options = {:body => {:keyword => keyword}, :query => self.default_options}
+      results = Mash.new(self.class.post('/keywords/create', options))
+    end
+
+    def show_keyword(id)
+      options = {:query => self.default_options}
+      results = Mash.new(self.class.get("/keywords/#{id}", options))
+    end
+
+    def sentiment(body, lang)
+      options = {:body => {:body => body, :lang => lang}, :query => self.default_options}
+      results = Mash.new(self.class.post('/sentiments', options))
+    end
+
+
+    protected
+
+    def default_options
+      {:api_key => @api_key}
+    end
+
+  end
+end

data/lib/social_media_monitoring/version.rb

@@ -0,0 +1,3 @@
+module SocialMediaMonitoring
+  VERSION = "0.0.3"
+end

data/social_media_monitoring.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/social_media_monitoring/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nikolai Manek"]
+  gem.email         = ["niko.manek@gmail.com"]
+  gem.description   = %q{Offers sentiment analysis and search engine keyword tracking}
+  gem.summary       = %q{Keyword tracking, sentiment analysis}
+  gem.homepage      = "https://github.com/nikoma/social_media_monitoring"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "social_media_monitoring"
+  gem.require_paths = ["lib"]
+  gem.version       = SocialMediaMonitoring::VERSION
+  
+  gem.add_runtime_dependency "httparty"
+  gem.add_runtime_dependency "mash"
+end

data/test/client_test.rb

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'test/unit'
+require 'vcr'
+require 'webmock'
+require 'social_media_monitoring'
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+
+end
+
+class VCRTest < Test::Unit::TestCase
+  $client = SocialMediaMonitoring::Client.new("987634f072b7c51db349bda9fd5cd6da")
+
+  def test_keywords
+    VCR.use_cassette('keywords') do
+      response = $client.keywords.response.first.name
+      assert_match /berliner bubbletea/, response
+    end
+  end
+
+  def test_create_keyword
+    VCR.use_cassette('create_keyword') do
+      keyword = "ruby testing"
+      response = $client.create_keyword(keyword).response.keyword
+      assert_match keyword, response
+    end
+  end
+
+  def test_show_keyword
+    VCR.use_cassette('show_keyword') do
+      keyword_id = 550
+      response = $client.show_keyword(keyword_id).first[1][0].keyword
+      assert_match /berliner bubbletea/, response
+    end
+  end
+
+  def test_sentiment
+    VCR.use_cassette('sentiment') do
+      sample = "I love ruby"
+      response = $client.sentiment(sample, "en").response.polarity
+      assert_equal 1, response.to_i
+    end
+  end
+end

data/test/fixtures/vcr_cassettes/create_keyword.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.apphera.com/1/keywords/create?api_key=987634f072b7c51db349bda9fd5cd6da
+    body:
+      encoding: UTF-8
+      string: keyword=ruby%20testing
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Wed, 01 Aug 2012 22:11:58 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '90'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"627d44222eb29df3eb988c5faeac89c7"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 017c4e8c78ec7037eb77b5dfcb4232d0
+      X-Runtime:
+      - '0.508844'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: UTF-8
+      string: ! '{"response":{"keyword":"ruby testing","id":551,"first_check":"2012-08-02T22:11:58+00:00"}}'
+    http_version: 
+  recorded_at: Wed, 01 Aug 2012 22:12:02 GMT
+recorded_with: VCR 2.2.4

data/test/fixtures/vcr_cassettes/keywords.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.apphera.com/1/keywords?api_key=987634f072b7c51db349bda9fd5cd6da
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Wed, 01 Aug 2012 22:00:38 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '357'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"5a65190ea6aaeb838d0f0dd84f2a7ac3"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - a1669fc9fc6c1de25912d33fdd5604d7
+      X-Runtime:
+      - '0.010338'
+      X-Rack-Cache:
+      - miss
+    body:
+      encoding: UTF-8
+      string: ! '{"response":[{"created_at":"2012-08-01T06:19:50Z","id":550,"name":"berliner
+        bubbletea","updated_at":"2012-08-01T06:19:50Z"},{"created_at":"2012-08-01T06:19:50Z","id":550,"name":"berliner
+        bubbletea","updated_at":"2012-08-01T06:19:50Z"},{"created_at":"2012-08-01T06:19:50Z","id":550,"name":"berliner
+        bubbletea","updated_at":"2012-08-01T06:19:50Z"}],"count":3}'
+    http_version: 
+  recorded_at: Wed, 01 Aug 2012 22:00:42 GMT
+recorded_with: VCR 2.2.4

data/test/fixtures/vcr_cassettes/sentiment.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.apphera.com/1/sentiments?api_key=987634f072b7c51db349bda9fd5cd6da
+    body:
+      encoding: UTF-8
+      string: body=I%20love%20ruby&lang=en
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Wed, 01 Aug 2012 22:20:42 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '45'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"12c84abae49f81af5a943c98c44b2dc0"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 08340f5e00add1d1e0e58e48e17a55e7
+      X-Runtime:
+      - '0.005529'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: UTF-8
+      string: ! '{"response":{"polarity":1,"sentiment":0.325}}'
+    http_version: 
+  recorded_at: Wed, 01 Aug 2012 22:20:46 GMT
+recorded_with: VCR 2.2.4

data/test/fixtures/vcr_cassettes/show_keyword.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.apphera.com/1/keywords/550?api_key=987634f072b7c51db349bda9fd5cd6da
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Wed, 01 Aug 2012 22:27:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '2091'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"8e28eeb0a477fd94ac515e8acd413792"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 57caf318cb134b44241ae14d8df336f1
+      X-Runtime:
+      - '1.030111'
+      X-Rack-Cache:
+      - miss
+    body:
+      encoding: UTF-8
+      string: ! '{"response":[{"date":"2012-08-01T06:21:35+00:00","keyword_id":550,"keyword":"berliner
+        bubbletea","results":[{"ranking":1,"link_text":"Bubble''s Tea Bar - Mitte,
+        Berlin - Bubble Tea","link":"http://www.qype.com/place/1774041-Bubbles-Tea-Bar-Berlin"},{"ranking":2,"link_text":"Bubble
+        Tea in Berlin | Tipps auf Qype","link":"http://www.qype.com/de300-berlin/categories/1354-bubble-tea-in-berlin"},{"ranking":3,"link_text":"Bubble
+        Tea in Berlin: Die besten L\u00e4den f\u00fcrs Kultgetr\u00e4nk | berlin blog","link":"http://berlin.germanblogs.de/archive/2011/08/03/bubble-tea-in-berlin-die-besten-laeden-fuers-kultgetraenk.htm"},{"ranking":4,"link_text":"boobuk
+        - the bubble tea | Bubble Tea: der Tee mit Bubbles","link":"http://www.boobuk.com/"},{"ranking":5,"link_text":"Der
+        Bubble Tea Fun-Drink aus Fernost \u00bb BOBOQ","link":"http://www.boboq.de/"},{"ranking":6,"link_text":"Was
+        ist gef\u00e4hrlich an Bubble Tea? - Berliner Zeitung","link":"http://www.berliner-zeitung.de/gesundheit/warnungen-vor-modegetraenk-was-ist-gefaehrlich-an-bubble-tea-,10839396,16141164.html"},{"ranking":7,"link_text":"Berlin
+        - Alle Bubble-Tea Shops | teabubble.de Bubble Tea","link":"http://www.teabubble.de/bubble-tea-shop-ort/Berlin"},{"ranking":8,"link_text":"Bubble
+        O - Bubble Tea and Frozen Yogurt Oranienstra\u00dfe ... - Berlin","link":"http://berlin.kauperts.de/eintrag/Bubble-O-Bubble-Tea-and-Frozen-Yogurt-Oranienstrasse-38-10999-Berlin"},{"ranking":9,"link_text":"Bilder
+        zu berliner bubbletea","link":null},{"ranking":10,"link_text":"Krankenkasse
+        warnt vor Modegetr\u00e4nk Bubble Tea - Berlin.de","link":"http://www.berlin.de/special/gesundheit-und-beauty/ernaehrung/2523592-215-krankenkasse-warnt-vor-modegetraenk-bubb.html"},{"ranking":11,"link_text":"Bubble
+        Tea in Berlin? (laden, Cafe)","link":"http://www.gutefrage.net/frage/bubble-tea-in-berlin"}],"id":"W7-kbR0gSAi-Ihq3K47HrQ","_score":1.0,"_type":"results","_index":"ranks","_version":null,"sort":null,"highlight":null,"_explanation":null}],"count":1,"pagination":{"previous":null,"next":null,"current":1,"per_page":10,"count":1,"pages":1}}'
+    http_version: 
+  recorded_at: Wed, 01 Aug 2012 22:27:40 GMT
+recorded_with: VCR 2.2.4

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: social_media_monitoring
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Nikolai Manek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Offers sentiment analysis and search engine keyword tracking
+email:
+- niko.manek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/social_media_monitoring.rb
+- lib/social_media_monitoring/client.rb
+- lib/social_media_monitoring/version.rb
+- social_media_monitoring.gemspec
+- test/client_test.rb
+- test/fixtures/vcr_cassettes/create_keyword.yml
+- test/fixtures/vcr_cassettes/keywords.yml
+- test/fixtures/vcr_cassettes/sentiment.yml
+- test/fixtures/vcr_cassettes/show_keyword.yml
+homepage: https://github.com/nikoma/social_media_monitoring
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Keyword tracking, sentiment analysis
+test_files:
+- test/client_test.rb
+- test/fixtures/vcr_cassettes/create_keyword.yml
+- test/fixtures/vcr_cassettes/keywords.yml
+- test/fixtures/vcr_cassettes/sentiment.yml
+- test/fixtures/vcr_cassettes/show_keyword.yml