applied 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14b98e71134bfd46b00b8fc161382faa3e680708
-  data.tar.gz: 4e1f85664c0eeb6e68427c43a8457c170ccab40f
+  metadata.gz: 8a3cf39a6d9282c7914f90ecf9205e8e42c4eb5f
+  data.tar.gz: 257bf3953365209c281b6012d2ef2ab79a2938f9
 SHA512:
-  metadata.gz: d5262e492fd0e3837593aa979e0147fb5074c9535ad04413222cda826a9d9083a35d7a2083c806c935922d44de6458df9289944d668edf3ee62247d140cfc24f
-  data.tar.gz: 563b4113e79ed379682fd4101b928694a8c7e3c5a2b088025b834a694c6e7c0e8132584f10226a09026e1d010a72a95d6743ed8fd18981f275683406b41c110b
+  metadata.gz: 7df7c4cbde9618000c100924b973267e6eba93512a7d041189371dabfb3303760d9a8e5ff999a1936b17ead84b31e018554a3c06fbafc1d8229761de64eb0b45
+  data.tar.gz: d6944efa7baf8f07bb0bd3e35143d439e983da78c9d9bf3f71ca11ecc6f97e8b74dc6dce30ab1eb86dacb38b00f17d5a2a992717e8b7da5f857124c76ed4cbc3

data/README.md

@@ -1,29 +1,75 @@
-# Applied
+# [![Ruby Gem Icon](https://raw.githubusercontent.com/zenkay/ai-applied-ruby/master/rubygem.png)](https://rubygems.org/gems/applied) AI Applied Ruby Gem
 
-TODO: Write a gem description
+[![Code Climate](https://codeclimate.com/github/zenkay/ai-applied-ruby/badges/gpa.svg)](https://codeclimate.com/github/zenkay/ai-applied-ruby) [![Travis CI](https://travis-ci.org/zenkay/ai-applied-ruby.svg?branch=master)](https://travis-ci.org/zenkay/applied-ruby) [![Gem Version](https://badge.fury.io/rb/applied.svg)](http://badge.fury.io/rb/applied) [![Coverage Status](https://coveralls.io/repos/zenkay/ai-applied-ruby/badge.png?branch=master)](https://coveralls.io/r/zenkay/ai-applied-ruby?branch=master)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'applied'
+```
+gem 'applied'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle install
+```
+## Setup
 
-Or install it yourself as:
+Setup configuration parameters
 
-    $ gem install applied
+```
+Applied.configure do |c|
+  c.api_key = "your-api-key-for-applied-account"
+  c.endpoint = "http://api.ai-applied.nl/"
+end
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Sentiment API
 
-## Contributing
+- [Class Documentation](docs/sentiment_details.md)
+- [Usage Examples](docs/sentiment_examples.md)
+
+```
+element = Applied::Sentiment.new
+
+options = {return_original: false, classifier: "default"}
+
+data = [
+  {text: "Sono molto contento di quello che è successo", language_iso: "ita", id: 42},
+  {text: "Sono molto arrabbiato per quello che è successo", language_iso: "ita", id: 69},
+  {text: "Sono molto indifferente a quello che è successo", language_iso: "ita", id: 99}
+]
+
+response = element.analyze(data, options)
+```
+
+- _[Official documentation](http://ai-applied.nl/api-documentation/2013/10/5/sentiment-analysis-api-documentation)_
+
+### Text Analysis API
+
+Coming Soon
+
+### Text Extract API
+
+Coming Soon
+
+### Data Miner API
+
+Coming Soon
+
+### Text Label API
+
+Coming Soon
+
+### Demographics API
+
+Coming Soon
+
+### Language Detection API
+
+Coming Soon
 
-1. Fork it ( https://github.com/[my-github-username]/applied/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

data/docs/sentiment_details.md

@@ -0,0 +1,95 @@
+# Sentiment API Documentation
+
+- [Setup](#setup)
+- [Parameters](#parameters)
+- [Response](#response)
+
+## Setup
+
+First you need to configure your account adding your API key. Endpoint sohould be always the same but I keep it configurable.
+
+```
+Applied.configure do |c|
+  c.api_key = "your-api-key-for-applied-account"
+  c.endpoint = "http://api.ai-applied.nl/"
+end
+```
+
+Then you need to create a new ```Sentiment``` object
+
+```
+element = Applied::Sentiment.new
+```
+
+## Parameters
+
+The ```analyze``` method takes two parameters: ```data``` and ```options```.
+
+### data
+
+The ```data``` parameter contains text you need to analyze with additional informations. Here is an example item:
+
+```
+{
+  text: "Sono molto contento di quello che è successo",
+  language_iso: "ita",
+  id: 42
+}
+```
+
+| Parameter | Mandatory | Description |
+| --------- | --------- | ----------- |
+| text | yes | The message text as a string |
+| language_iso | yes | Specifying the language of this individual message (```eng``` for English, ```nld``` for Dutch, ```deu``` for German, ```fra``` for French, ```spa``` for Spanish, ```ita``` for Italian, ```rus``` for Russian) |
+| id | yes | Unique message ID as a string or an integer you could use to identify your messages into response |
+
+Data item should be placed into an Array.
+You could send more than one message in a single call.
+
+```
+data = [
+  {text: "Sono molto contento di quello che è successo", language_iso: "ita", id: 42},
+  {text: "Sono molto arrabbiato per quello che è successo", language_iso: "ita", id: 69},
+  {text: "Sono molto indifferente a quello che è successo", language_iso: "ita", id: 99}
+]
+```
+
+### options
+
+The ```options``` parameter set configuration of the analysis.
+
+| Parameter | Mandatory | Default | Description |
+| --------- | --------- | ------- | ----------- |
+| return_original | yes | false | Return full posted messages (true) together with the language annotation or only the message id's (false) annotated with language |
+| classifier | yes | "default" | Specifies which classifier to use. Sentiment Analysis API offers two standard classifiers, "default" and "subjective". The "default" classifier provides a two-class classification ("positive"/"negative"), while the "subjective" classifier provides the "neutral" class as well. |
+
+```
+options = {
+  return_original: false, 
+  classifier: "default"
+}
+```
+
+## Response
+
+```
+response = element.analyze(data, options)
+```
+
+Ai Applied return a JSON data that is parsed to a Ruby Hash.
+
+```
+{
+  "status" => 1, 
+  "id" => nil, 
+  "response" => {
+    "data" => [
+      {"confidence_sentiment" => 0.735094833636812, "sentiment_class" => "positive", "id" => 42}, 
+      {"confidence_sentiment" => 0.9914339753287233, "sentiment_class" => "negative", "id" => 69}, 
+      {"confidence_sentiment" => 0.7537000605846166, "sentiment_class" => "negative", "id" => 99}
+    ], 
+    "description" => "OK: Call processed.", 
+    "success" => true
+  }
+}
+```

data/docs/sentiment_examples.md

@@ -0,0 +1 @@
+# Sentiment API Examples

data/lib/applied/sentiment.rb

@@ -7,11 +7,49 @@ module Applied
   class Sentiment
 
     ENDPOINT = "/api/sentiment_api/"
+    PERMITTED_OPTIONS = [:return_original, :classifier]
+    CLASSIFIERS = ["default", "subjective"]
+    AVAILABLE_LANGUAGES = ["eng", "nld", "deu", "fra", "spa", "ita", "rus"]
+
+    DATA_MUST_BE_ARRAY = "Data must be and Array"
+    TEXT_MISSING = "Missing text parameter, it is mandatory"
+    ID_MISSING = "Missing ID parameter, it is mandatory"
+    LANGUAGE_MISSING = "Missing language parameter, it is mandatory"
+    BAD_RETURN = "Bad value for return_original parameter. Allowed values are: true, false"
+    BAD_CLASSIFIER = "Bad value for classifier parameter. Allowed values are: 'default', 'subjective'"
 
     attr_accessor :return_original, :classifier
 
-    def analyze(data, options)
-      params = options
+    def analyze(data, options = {})
+
+      # checks on data
+
+      raise Applied::BadData.new(DATA_MUST_BE_ARRAY) unless data.instance_of? Array
+
+      data.each do |d|
+        raise Applied::BadData.new(TEXT_MISSING) if d[:text].nil? or d[:text].empty?
+        raise Applied::BadData.new(ID_MISSING) unless [Fixnum, String].include? d[:id].class
+        raise Applied::BadData.new(LANGUAGE_MISSING) if d[:language_iso].nil? or d[:language_iso].empty? or not AVAILABLE_LANGUAGES.include? d[:language_iso]
+      end
+
+      # checks on options
+
+      unless options[:return_original].nil?
+        raise Applied::BadOptions.new(BAD_RETURN) unless [true, false].include? options[:return_original]
+      else
+        options[:return_original] = false
+      end 
+
+      unless options[:classifier].nil?
+        raise Applied::BadOptions.new(BAD_CLASSIFIER) unless CLASSIFIERS.include? options[:classifier]
+      else
+        options[:classifier] = "default"
+      end
+
+      # options cleanup
+
+      options.delete_if {|o| not PERMITTED_OPTIONS.include? o}
+
       call(ENDPOINT, data, options)
     end
 
@@ -43,4 +81,9 @@ module Applied
 
   end
 
+  class BadOptions < Exception; end
+
+  class BadData < Exception; end
+
+
 end

data/lib/applied/version.rb

@@ -1,3 +1,3 @@
 module Applied
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/sentiment_spec.rb

@@ -22,7 +22,26 @@ describe Applied::Sentiment, vcr: vcr_options do
     options = {return_original: false, classifier: "default"}
     data = [{text: "Sono molto contento di quello che è successo", language_iso: "ita", id: 42}]
     response = element.analyze(data, options)
+    expect(response).not_to be_empty
+    expect(response["status"]).to eq 1
+    expect(response["response"]).to be_a Hash
+    expect(response["response"]["data"]).to be_a Array
+    response["response"]["data"].each do |d|
+      expect(d["sentiment_class"]).to match /positive|negative|unknown/
+      expect(d["id"]).to be 42
+      expect(d["confidence_sentiment"]).to be_between(0.0, 1.0)
+    end
+  end
 
+  it "make multiple request sentiment of an italian sentence" do
+    element = Applied::Sentiment.new
+    options = {return_original: false, classifier: "default"}
+    data = [
+      {text: "Sono molto contento di quello che è successo", language_iso: "ita", id: 42},
+      {text: "Sono molto arrabbiato per quello che è successo", language_iso: "ita", id: 69},
+      {text: "Sono molto indifferente a quello che è successo", language_iso: "ita", id: 99}
+    ]
+    response = element.analyze(data, options)
     expect(response).not_to be_empty
     expect(response["status"]).to eq 1
     expect(response["response"]).to be_a Hash
@@ -34,13 +53,53 @@ describe Applied::Sentiment, vcr: vcr_options do
     end
   end
 
-  it "raise exception on wrong config parameters" do
+  it "make a request sentiment of an italian sentence using default options" do
+    element = Applied::Sentiment.new
+    data = [{text: "Sono molto contento di quello che è successo", language_iso: "ita", id: 42}]
+    response = element.analyze(data)
+    expect(response).not_to be_empty
+    expect(response["status"]).to eq 1
+    expect(response["response"]).to be_a Hash
+    expect(response["response"]["data"]).to be_a Array
+    response["response"]["data"].each do |d|
+      expect(d["sentiment_class"]).to match /positive|negative|unknown/
+      expect(d["id"]).to be 42
+      expect(d["confidence_sentiment"]).to be_between(0.0, 1.0)
+    end
+  end
+
+  it "raise BadData on missing text" do
+    element = Applied::Sentiment.new
+    expect { element.analyze([{language_iso: "ita", id: 42}]) }.to raise_error(Applied::BadData)
+  end
+
+  it "raise BadData on missing language" do
+    element = Applied::Sentiment.new
+    expect { element.analyze([{text: "test", id: 42}]) }.to raise_error(Applied::BadData)
+  end
+
+  it "raise BadData on missing text" do
+    element = Applied::Sentiment.new
+    expect { element.analyze([{text: "test", language_iso: "ita"}]) }.to raise_error(Applied::BadData)
+  end
+
+  it "raise BadOptions on wrong return_original" do
+    element = Applied::Sentiment.new
+    expect { element.analyze([{text: "test", language_iso: "ita", id: 42}], {return_original: "maybe"}) }.to raise_error(Applied::BadOptions)
+  end
+
+  it "raise BadOptions on wrong classifier" do
+    element = Applied::Sentiment.new
+    expect { element.analyze([{text: "test", language_iso: "ita", id: 42}], {classifier: "cool"}) }.to raise_error(Applied::BadOptions)
+  end
+
+  it "raise BadResponse on wrong config parameters" do
     Applied.configure do |c|
       c.api_key = "bad-app-id"
       c.endpoint = "not-an-url-endpoint"
     end
     element = Applied::Sentiment.new
-    expect { element.analyze({text: "test"}, []) }.to raise_error(Applied::BadResponse)
+    expect { element.analyze([{text: "test", language_iso: "ita", id: 42}]) }.to raise_error(Applied::BadResponse)
   end
 
 end

metadata

@@ -1,151 +1,151 @@
 --- !ruby/object:Gem::Specification
 name: applied
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrea Mostosi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 description: Ruby Gem for AI Applied service (ai-applied.nl)
@@ -155,16 +155,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - applied.gemspec
+- docs/sentiment_details.md
+- docs/sentiment_examples.md
 - lib/applied.rb
 - lib/applied/sentiment.rb
 - lib/applied/version.rb
+- rubygem.png
 - spec/cassettes/applied_sentiment.yml
 - spec/sentiment_spec.rb
 - spec/spec_helper.rb
@@ -178,12 +181,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -196,3 +199,4 @@ test_files:
 - spec/cassettes/applied_sentiment.yml
 - spec/sentiment_spec.rb
 - spec/spec_helper.rb
+has_rdoc: