machinereading 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6fb44360c651b2b568f12ae6bad6e54cf0df7db
-  data.tar.gz: f4bf231721bc369e7766d0d33dda28d9ed3d3f95
+  metadata.gz: 6c40b0f9f66fb65fce3b8908d17ee535c90be70f
+  data.tar.gz: 670a85b752e0b3666565eef5944dcca2f1f5d746
 SHA512:
-  metadata.gz: 8fb26fb53b20124554a5910f6c6fe3706a663bf2e2471590504cd558a47c442d9430075c002e33e92d7611341f76f5357aa0d024dee7825a7cbf25a7d8e70a95
-  data.tar.gz: 920162a05b65286a07e40c1226e0ecedbc11aad4fbbfd6120d47709dea23145d54f6404e005e288885d4c70eb94f4b9c716f547203e3619e09b96e243d1ad8f0
+  metadata.gz: de1b058178ee3f7ce953591b5e5f2f1d83fc82a867426828e7ab7f95c602c163f4bee418bd9ba4eff8af0a8e76a930d4670d336090bef8dd4aa1507faaad44c6
+  data.tar.gz: fab173e5503728b2578f86ee2629b4da0a2db794a1d5e06f2f98c36309492e2d7dab221b748f4ad74c1385512a6aa665d1808109492612a1fdb1e15496c4ceb6

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.2

data/README.md

@@ -1,6 +1,8 @@
-# Machinereading
+# [![Ruby Gem Icon](https://raw.githubusercontent.com/zenkay/machinereading-ruby/master/rubygem.png)](https://rubygems.org/gems/machinereading) MachineReading Ruby Gem
 
-Ruby gem for interaction with [Machinereading.com](http://www.machinereading.com)
+[![Code Climate](https://codeclimate.com/github/zenkay/machinereading-ruby/badges/gpa.svg)](https://codeclimate.com/github/zenkay/machinereading-ruby) [![Travis CI](https://travis-ci.org/zenkay/machinereading-ruby.svg?branch=master)](https://travis-ci.org/zenkay/machinereading-ruby) [![Gem Version](https://badge.fury.io/rb/machinereading.svg)](http://badge.fury.io/rb/machinereading)
+
+Ruby gem for interaction with Damantic's [Machinereading](http://www.machinereading.com) APIs.
 
 ## Installation
 
@@ -29,49 +31,68 @@ end
 
 ## Usage
 
+_Methods references are taken from [Machine Reading documentation](http://www.machinereading.com/documentation)._
+
+**Tokenizer**: divides text into a sequence of sentences and tokens, which roughly correspond to "words".
 
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.tokenizer
 ```
 
+**Pos Tagger Stanford**: assigns a part of speech (POS) tags to each word of the input text. Tags are mostly language independent following the Penn Treebank tag set.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.pos_tagger_stanford # default is "vertical""
 response = element.pos_tagger_stanford("horizontal")
 ```
 
+**Syntactic Parser Stanford**: takes natural language sentences in input and returns a full dependency tree describing its syntactic structure. The grammatical relations are mostly language independent.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.syntactic_parser_stanford
 ```
 
+**Lemmatizer**: is used to parse the input text and provides the lemmas for each word.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.lemmatizer
 ```
 
+**Sequence Surprisal**: assigns a "surprisal value" (probabilities range from 0 to 1) to each word and each sentence of the input text. Surprisal captures a range of sentence processing effects like syntactic difficulties.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.sequence_surprisal
 ```
 
+**Language Detector**: determines the language that any text content was written in.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", nil)
 response = element.language_detector
 ```
 
+**Keyword Extractor**: analyzes the input text and extracts the most important words and phrases (proper nouns and common nouns).
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.keyword_extractor # default is 15
 response = element.keyword_extractor(50)
 ```
 
+**Automatic Categorization**: auto-categorizes and organizes huge sets of text into relevant categories (IPTC) based on automatically detected themes and content.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.automatic_categorization
 ```
 
+**Voice Tags**: extracts additional information about the meaning of the text. It can be identifies when there are values in the text as "adversative", "hypothesis", "reason or cause". Voice Tags also extracts positive and negative words of the input text as a starting point for building your own sentiment analysis system.
+
 ```
 element = Machinereading::Element.new("Questo è un testo di esempio", "it")
 response = element.voice_tags

data/lib/machinereading/element.rb

@@ -62,8 +62,7 @@ module Machinereading
         response = conn.post "/#{endpoint}", params
         response.body
       rescue Exception => e
-        puts e.inspect
-        #raise Machinereading::BadResponse(response.body)
+        raise Machinereading::BadResponse
       end
     end
 

data/lib/machinereading/version.rb

@@ -1,3 +1,3 @@
 module Machinereading
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/element_spec.rb

@@ -4,9 +4,9 @@ vcr_options = { :cassette_name => "machinereading_element", :record => :new_epis
 
 describe Machinereading::Element, vcr: vcr_options do
   
-  before(:all) do
+  before(:each) do
     Machinereading.configure do |c|
-      c.api_key = "uf8t28vY4U6w0cU7269O0zORI4h5yz7uhfzBmvBUPJeSVlvmJE" # a.mostosi@thefool.it
+      c.api_key = "uf8t28vY4U6w0cU7269O0zORI4h5yz7uhfzBmvBUPJeSVlvmJE"
       c.endpoint = "http://www.machinereading.com"
     end
     @sample_content = "Mio padre che mi spinge a mangiare e guai se non finisco mio padre che vuol farmi guidare mi frena con il fischio il bambino più grande mi mena davanti a tutti gli altri lui che passa per caso mi salva e mi condanna per sempre mio padre di spalle sul piatto si mangia la vita e poi sulla pista da ballo fa un valzer dentro il suo nuovo vestito  Per sempre solo per sempre cosa sarà mai porvarvi dentro solo tutto il tempo per sempre solo per sempre c'è un istante che rimane lì piantato eternamente E lei che non si lascia afferrare si piega indietro e ride e lei che dice quanto mi ama e io che mi fido e lei che mi toccava per prima la sua mano bambina vuole che le giuri qualcosa le si gonfia una vena e lei che era troppo più forte sicura di tutto e prima di andarsene mi dà il profilo con un movimento perfetto Per sempre solo per sempre cosa sarà mai portarvi dentro solo tutto il tempo per sempre solo per sempre c'è un istante che rimane lì piantato eternamente per sempre solo per sempre Mia madre che prepara la cena cantando sanremo carezza la testa a mio padre gli dice vedrai che ce la faremo Per sempre solo per sempre cosa sarà mai portarvi dentro solo tutto il tempo per sempre solo per sempre c'è un istante che rimane lì piantato eternamente per sempre solo per sempre"
@@ -113,4 +113,14 @@ describe Machinereading::Element, vcr: vcr_options do
     expect(response["voice_tags"]).to be_an_instance_of(Hash)
   end
 
+  it "raise exception on wrong config parameters" do
+    Machinereading.configure do |c|
+      c.api_key = "bad-api-key"
+      c.endpoint = "not-an-url-endpoint"
+    end
+    element = Machinereading::Element.new(@sample_content, @sample_content_lang)
+    # raise Machinereading::BadResponse
+    expect { element.tokenizer }.to raise_error
+  end
+
 end

data/spec/spec_helper.rb

@@ -15,5 +15,5 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.order = 'random'
-  config.color_enabled = true
+  # config.color_enabled = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: machinereading
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrea Mostosi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -138,6 +139,7 @@ files:
 - lib/machinereading/element.rb
 - lib/machinereading/version.rb
 - machinereading.gemspec
+- rubygem.png
 - spec/cassettes/machinereading_element.yml
 - spec/element_spec.rb
 - spec/spec_helper.rb