dandelionapi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60d3e32d3e0ace88c7ac96380733d7b3968e1175
-  data.tar.gz: 648a796836193a56970191832d2f617f6616f029
+  metadata.gz: e24257bbcc32e368db80064ce40f9ddd15c2c6a8
+  data.tar.gz: bc758810bdfb49dbb0767b5f2018e13730ca234d
 SHA512:
-  metadata.gz: 38e9f41a10552bb8eb437ac5c5e861d78023258faec7dd6fda4410dea1281b69644936016b45684e4186f0857f41483589532286c88b27cca5909b2633f0ec04
-  data.tar.gz: d3279f1b0da0686284b87db77f835b94ba90615c5e3cf677b9a17b79cfce495809da31537ec86312bb06cbb97fb43ad2d04b36555e9845f14547f747372ae68f
+  metadata.gz: a0408cdf917450acb12259956dd8852654cd154cd0f0fd5b7d482a7773c305985fd3300677a62461903d7d52eee1357215c5efd6372c641f10298dee607a74ea
+  data.tar.gz: b9696acda5c66d2c2c5cd17817010b52d88adc09f3bb23340a157b70c5db8312e291c07096145a0ecb76e8b1adb1d66847ab8548db614928a85fc67352c1075d

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.gem
+*.gem
+.DS_Store

data/.travis.yml

@@ -8,6 +8,3 @@ rvm:
   - rbx-2.4.1
   - rbx-2.5.2
 before_install: gem install bundler -v 1.10.5
-addons:
-  code_climate:
-    repo_token: c29ce9f7996f73f58b0d180bf8f0432e1f7ab65950bef51e33bc44e1db244d8d

data/README.md

@@ -31,23 +31,44 @@ end
 
 _Methods references are taken from [Dandelion API's documentation](https://dandelion.eu/docs/)._
 
-**[Entity Extraction API](https://dandelion.eu/docs/api/datatxt/nex/v1/)**: is a named entity extraction & linking API that performs very well even on short texts, on which many other similar services do not. dataTXT-NEX currently works on English, French, German, Italian and Portuguese texts. With this API you will be able to automatically tag your texts, extracting Wikipedia entities and enriching your data.
+**[Entity Extraction API](https://dandelion.eu/docs/api/datatxt/nex/v1/)**: This is a named entity extraction & linking API that performs very well even on short texts, on which many other similar services do not. It currently works on English, French, German, Italian and Portuguese texts. With this API you will be able to automatically tag your texts, extracting Wikipedia entities and enriching your data.
 
 ```
 element = Dandelionapi::EntityExtraction.new
 response = element.analyze(text: "This is a test")
 ```
 
-**[Text Similarity API](https://dandelion.eu/docs/api/datatxt/sim/v1/)**: is a semantic sentence similarity API optimized on short sentences. With this API you will be able to compare two sentences and get a score of their semantic similarity. It works even if the two sentences don't have any word in common.
+**[Text Similarity API](https://dandelion.eu/docs/api/datatxt/sim/v1/)**: This API is a semantic sentence similarity API optimized on short sentences. With this API you will be able to compare two sentences and get a score of their semantic similarity. It works even if the two sentences don't have any word in common.
 
 ```
 element = Dandelionapi::TextSimilarity.new
 response = element.analyze(text1: "This is a test", text2: "This is another test")
 ```
 
-**[Language Detection API](https://dandelion.eu/docs/api/datatxt/li/v1/)**: is a simple language identification API; it is a tool that may be useful when dealing with texts, so we decided to open it to all our users. It currently supports more than 50 languages.
+**[Language Detection API](https://dandelion.eu/docs/api/datatxt/li/v1/)**: 
+Language Detection API is a simple language identification API; it is a tool that may be useful when dealing with texts, so we decided to open it to all our users. It currently supports more than 96 languages.
 
 ```
 element = Dandelionapi::LanguageDetection.new
 response = element.analyze(text: "Questo è un test")
 ```
+
+**[Sentiment Analysis API](https://dandelion.eu/docs/api/datatxt/sent/v1/)**: This API analyses a text and tells whether the expressed opinion is positive, negative, or neutral. Given a short sentence, it returns a label representing the identified sentiment, along with a numeric score ranging from strongly positive (1.0) to extremely negative (-1.0).
+
+```
+element = Dandelionapi::SentimentAnalysis.new
+response = element.analyze(text: "I'm really disappointed")
+```
+
+## About the DandelionAPI project
+
+This library is part of a larger group of libraries used to explore best strategies to build packages among multiple languages. Each library is written using conventions about coding style, filesystem structure, testing, documentation and distribution typical of the language enviroment but preserve the library main concepts. This version use the following conventions:
+
+- Tested using [RSpec](http://rspec.info/)
+- Documented using [YARD](http://yardoc.org/)
+- Packed using [Bundler](http://bundler.io/) and [Gem](https://rubygems.org/)
+- Distributed over [RubyGems](https://rubygems.org/) as [dandelionapi](https://rubygems.org/gems/dandelionapi)
+
+----
+
+Here is the complete list of libraries available: [Ruby](https://github.com/zenkay/dandelionapi-ruby), [PHP](https://github.com/zenkay/dandelionapi-php), [Node](https://github.com/zenkay/dandelionapi-node)

data/dandelionapi.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 1.21"
   spec.add_development_dependency "simplecov", "~> 0.10"
   spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "yard", "~> 0.8"
 end

data/lib/dandelionapi.rb

@@ -6,20 +6,41 @@ require "dandelionapi/base"
 require "dandelionapi/entity_extraction"
 require "dandelionapi/text_similarity"
 require "dandelionapi/language_detection"
+require "dandelionapi/sentiment_analysis"
 
 module Dandelionapi
+
+  # Class method to set up configuration parameters
+  #
+  # @example
+  #   Dandelionapi.configure do |c|
+  #     c.app_id = "test"
+  #   end
+  #
   def self.configure(&block)
     yield @config ||= Configuration.new
   end
 
+  # Return configuration parameters
+  #
+  # @example
+  #   Dandelionapi.config.app_id
+  #
   def self.config
     @config
   end
 
+  # Container for configuration parameters
+  #
   class Configuration
     attr_accessor :app_id, :app_key, :endpoint
   end
 
+  # Exception raised for connection error
+  #  
   class BadResponse < Exception; end
+
+  # Exception raised when a mandatory parameter is missing
+  #  
   class MissingParameters < Exception; end
 end

data/lib/dandelionapi/sentiment_analysis.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Dandelionapi
+
+  class SentimentAnalysis < Base
+
+    ENDPOINT = "/datatxt/sent/v1"
+
+    attr_accessor :text, :url, :html, :html_fragment, :lang
+
+    def analyze(options)
+
+      raise MissingParameters.new("Please provide one of the following parameters: text, url, html or html_fragment") if ([:text, :url, :html, :html_fragment] & options.keys).empty?
+
+      params = options
+      call(ENDPOINT, params)
+    end
+
+  end
+
+end

data/lib/dandelionapi/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Dandelionapi
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dandelionapi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrea Mostosi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-04 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -148,6 +148,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: 'Ruby Gem for Dandelion API service. Available endpoint: Entity Extraction,
   Text Similarity and Language Detection'
 email:
@@ -171,6 +185,7 @@ files:
 - lib/dandelionapi/base.rb
 - lib/dandelionapi/entity_extraction.rb
 - lib/dandelionapi/language_detection.rb
+- lib/dandelionapi/sentiment_analysis.rb
 - lib/dandelionapi/text_similarity.rb
 - lib/dandelionapi/version.rb
 - rubygem.png