sentiment 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+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 sentiment.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,54 @@
+# Sentiment
+
+Sentiment is a simple gem which allows you to get the sentiment of a string. It returns 1 for positive words or sentences, -1 for negative ones and 0 if neutral.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sentiment'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sentiment
+
+## Basic usage
+
+Sentiment Analysis
+
+require 'sentiment'
+client = Sentiment::Client.new("8w7d64oqweryiqweo87qnxtqwi47xqn3i4tisq7")
+
+sentiment = client.sentiment("I love Ruby!","en")  
+`=> 1`
+
+or
+sentiment = client.sentiment("amore","it")
+
+`=> 1`  
+
+At this time the API supports the following languages:  
+* English (en)  
+* German (de)  
+* Italian (it)  
+* Spanish (es)  
+* French (fr)  
+* Turkish (tr)  
+
+
+KNOWN ISSUE:
+In case you get a `"NoMethodError: undefined method `stringify_keys' for #<HTTParty::Response:0x007fa9231ab1b0>"`
+- It's telling you that the api key is invalid and therefore can't handle the server response. Please get a valid api key. The key in this document can be used for limited testing as well. 
+
+
+## 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/sentiment.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'mash'
+require 'mash'
+gem 'httparty'
+require 'httparty'
+
+
+class APIKeyNotSet   < StandardError; end
+
+module Sentiment
+  
+  # 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, 'sentiment', 'client')

data/lib/sentiment/client.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+module Sentiment
+  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 ||= Sentiment.api_key
+      @api_path = ''
+    end
+
+    def sentiment(body, lang)
+      options = {:body => {:body => body, :lang => lang}, :query => self.default_options}
+      results = Mash.new(self.class.post('/sentiments', options))
+      
+      sentiment = results.response.polarity
+    end
+
+
+    protected
+
+    def default_options
+      {:api_key => @api_key}
+    end
+
+  end
+end

data/lib/sentiment/version.rb

@@ -0,0 +1,3 @@
+module Sentiment
+  VERSION = "0.0.2"
+end

data/sentiment.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sentiment/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nikolai Manek"]
+  gem.email         = ["niko.manek@gmail.com"]
+  gem.description   = %q{A very simple to use sentiment analysis tool}
+  gem.summary       = %q{Sentiment analysis}
+  gem.homepage      = "https://github.com/nikoma/sentiment"
+
+  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          = "sentiment"
+  gem.require_paths = ["lib"]
+  gem.version       = Sentiment::VERSION  
+  gem.add_runtime_dependency "httparty"
+  gem.add_runtime_dependency "mash"
+  gem.add_development_dependency "test/unit"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency "webmock"
+end

data/test/client_test.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'test/unit'
+require 'vcr'
+require 'webmock'
+require 'sentiment'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+
+end
+
+class VCRTest < Test::Unit::TestCase
+  $client = Sentiment::Client.new("8w7d64oqweryiqweo87qnxtqwi47xqn3i4tisq7")
+
+  def test_sentiment_positive
+    VCR.use_cassette('sentiment_positive') do
+      sample = "I love ruby"
+      sentiment = $client.sentiment(sample, "en")
+      assert_equal 1, sentiment
+    end
+  end
+  def test_sentiment_negative
+    VCR.use_cassette('sentiment_negative') do
+      sample = "I hate some random thing"
+      sentiment = $client.sentiment(sample, "en")
+      assert_equal -1, sentiment
+    end
+  end
+  def test_sentiment_neutral
+    VCR.use_cassette('sentiment_neutral') do
+      sample = "Today it's 20 degrees outside and that's it"
+      sentiment = $client.sentiment(sample, "en")
+      assert_equal 0, sentiment
+    end
+  end
+  def test_sentiment_positive_de_umlauts
+    VCR.use_cassette('sentiment_positive_de_umlauts') do
+      sample = "Wir freuen uns über Umlaute die Sätze ändern"
+      sentiment = $client.sentiment(sample, "de")
+      assert_equal 1, sentiment
+    end
+  end
+
+end

data/test/fixtures/vcr_cassettes/sentiment_negative.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.apphera.com/1/sentiments?api_key=8w7d64oqweryiqweo87qnxtqwi47xqn3i4tisq7
+    body:
+      encoding: UTF-8
+      string: body=I%20hate%20some%20random%20thing&lang=en
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Thu, 02 Aug 2012 16:38:53 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '48'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"45fc0357c8bd5b70db4f8bce584b7df5"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - d4c7705b2052a740f711365f74dc22f6
+      X-Runtime:
+      - '0.005970'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: UTF-8
+      string: ! '{"response":{"polarity":-1,"sentiment":-0.0625}}'
+    http_version: 
+  recorded_at: Thu, 02 Aug 2012 16:38:53 GMT
+recorded_with: VCR 2.2.4

data/test/fixtures/vcr_cassettes/sentiment_neutral.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.apphera.com/1/sentiments?api_key=8w7d64oqweryiqweo87qnxtqwi47xqn3i4tisq7
+    body:
+      encoding: UTF-8
+      string: body=Today%20it's%2020%20degrees%20outside%20and%20that's%20it&lang=en
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Thu, 02 Aug 2012 16:38:54 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '43'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"3c1d01e46834ab4bec5b8aec9135ef7c"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 4fc8089f40269153def66becb77b2b82
+      X-Runtime:
+      - '0.005184'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: UTF-8
+      string: ! '{"response":{"polarity":0,"sentiment":0.0}}'
+    http_version: 
+  recorded_at: Thu, 02 Aug 2012 16:38:54 GMT
+recorded_with: VCR 2.2.4

data/test/fixtures/vcr_cassettes/sentiment_positive.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.apphera.com/1/sentiments?api_key=8w7d64oqweryiqweo87qnxtqwi47xqn3i4tisq7
+    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:
+      - Thu, 02 Aug 2012 16:36:49 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:
+      - da82d22d527b08d4527998d5dae2e1e5
+      X-Runtime:
+      - '0.005299'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: UTF-8
+      string: ! '{"response":{"polarity":1,"sentiment":0.325}}'
+    http_version: 
+  recorded_at: Thu, 02 Aug 2012 16:36:49 GMT
+recorded_with: VCR 2.2.4

data/test/fixtures/vcr_cassettes/sentiment_positive_de_umlauts.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.apphera.com/1/sentiments?api_key=8w7d64oqweryiqweo87qnxtqwi47xqn3i4tisq7
+    body:
+      encoding: UTF-8
+      string: body=Wir%20freuen%20und%20%C3%BCber%20Umlaute%20die%20S%C3%A4tze%20%C3%A4ndern&lang=de
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Date:
+      - Thu, 02 Aug 2012 16:41:21 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '46'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ua-Compatible:
+      - IE=Edge,chrome=1
+      Etag:
+      - ! '"16a9bceff8483260f21ce3bf113968bb"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - d178c5dcd8af6c2d624607c5b30e2942
+      X-Runtime:
+      - '0.005309'
+      X-Rack-Cache:
+      - invalidate, pass
+    body:
+      encoding: UTF-8
+      string: ! '{"response":{"polarity":1,"sentiment":0.2198}}'
+    http_version: 
+  recorded_at: Thu, 02 Aug 2012 16:41:21 GMT
+recorded_with: VCR 2.2.4

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: sentiment
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  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'
+- !ruby/object:Gem::Dependency
+  name: test/unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A very simple to use sentiment analysis tool
+email:
+- niko.manek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sentiment.rb
+- lib/sentiment/client.rb
+- lib/sentiment/version.rb
+- sentiment.gemspec
+- test/client_test.rb
+- test/fixtures/vcr_cassettes/sentiment_negative.yml
+- test/fixtures/vcr_cassettes/sentiment_neutral.yml
+- test/fixtures/vcr_cassettes/sentiment_positive.yml
+- test/fixtures/vcr_cassettes/sentiment_positive_de_umlauts.yml
+homepage: https://github.com/nikoma/sentiment
+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: Sentiment analysis
+test_files:
+- test/client_test.rb
+- test/fixtures/vcr_cassettes/sentiment_negative.yml
+- test/fixtures/vcr_cassettes/sentiment_neutral.yml
+- test/fixtures/vcr_cassettes/sentiment_positive.yml
+- test/fixtures/vcr_cassettes/sentiment_positive_de_umlauts.yml