text_razor 0.0.1

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 text_razor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomer Elmalem
+
+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,42 @@
+# TextRazor
+
+TextRazor gem implements the TextRazor API for easy natural language processing of unstructed text. For more info about the API visit their website at textrazor.com.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'text_razor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install text_razor
+
+## Usage
+
+Usage is pretty simple but pretty limited at the moment as not all features of the API are supported.
+
+Start by initializing a new ``TextRazor`` object like this:
+
+```
+tr = TextRazor.new(api_key: '123456', text: 'This should be a huge body of text that you really really really want to process', extractors: 'entities')
+
+```
+
+Note that you are passing in a hash of three things: your API key from textrazor.com, the text you want to process, and the extractors you want to use. At the moment only entities, topics, coarse topics, and words are supported.
+
+Once you initialize your object, call ``#process`` on it to get your data from the API:
+
+```
+tr.process # calls the api
+tr.entities # returns all of the entities
+tr.topics # returns all of the topics
+tr.coarse_topics # returns all of the coarse topics
+tr.words # returns all of the words
+```
+
+For more information on the data getting returned for those extractors, visit the documentation at http://www.textrazor.com/documentation_rest

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/text_razor.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'rest-client'
+require 'text_razor/version'
+require 'text_razor/entity'
+require 'text_razor/topic'
+require 'text_razor/coarse_topic'
+require 'text_razor/sentence'
+require 'text_razor/word'
+
+class TextRazor
+  attr_reader :entities, :topics, :coarse_topics, :sentences
+
+  URL = 'http://api.textrazor.com'
+
+  def initialize(options={})
+    @api_key    = options[:api_key]
+    @text       = options[:text]
+    @extractors = options[:extractors]
+    @json       = nil
+  end
+
+  def process
+    response = RestClient.post URL, {apiKey: @api_key, text: @text, extractors: @extractors}
+    @json = JSON.parse(response)['response']
+
+    create_entities(@json['entities'])
+    create_topics(@json['topics'])
+    create_coarse_topics(@json['coarseTopics'])
+    create_sentences(@json['sentences'])
+  end
+
+  def language
+    @json['language']
+  end
+
+  def is_reliable?
+    @json['languageIsReliable']
+  end
+
+  def create_entities(entities)
+    @entities = entities.collect {|entity| Entity.new(entity)} if entities
+  end
+
+  def create_topics(topics)
+    @topics = topics.collect{|topic| Topic.new(topic)} if topics
+  end
+
+  def create_coarse_topics(coarse_topics)
+    @coarse_topics = coarse_topics.collect{|coarse_topic| CoarseTopic.new(coarse_topic)} if coarse_topics
+  end
+
+  def create_sentences(sentences)
+    @sentences = sentences.collect{|sentence| Sentence.new(sentence)} if sentences
+  end
+end

data/lib/text_razor/coarse_topic.rb

@@ -0,0 +1,11 @@
+class TextRazor
+  class CoarseTopic
+    attr_reader :label, :score, :wiki_link
+
+    def initialize(options={})
+      @label = options['label']
+      @score = options['score']
+      @wiki_link = options['wiki_link']
+    end
+  end
+end

data/lib/text_razor/entity.rb

@@ -0,0 +1,21 @@
+class TextRazor
+  class Entity
+    attr_reader :confidence_score, :ending_pos, :entity_english_id, :entity_id,
+                  :freebase_id, :freebase_types, :matching_text, :matching_tokens, 
+                  :relevance_score, :starting_pos, :wiki_link
+
+    def initialize(options={})
+      @confidence_score = options['confidenceScore']
+      @ending_pos = options['endingPos']
+      @entity_english_id = options['entityEnglishId']
+      @entity_id = options['entityId']
+      @freebase_id = options['freebaseId']
+      @freebase_types = options['freebaseTypes']
+      @matching_text = options['matchingText']
+      @matching_tokens = options['matchingTokens']
+      @relevance_score = options['relevanceScore']
+      @starting_pos = options['startingPos']
+      @wiki_link = options['wikiLink']
+    end
+  end
+end

data/lib/text_razor/sentence.rb

@@ -0,0 +1,10 @@
+class TextRazor
+  class Sentence
+    attr_reader :position, :words
+
+    def initialize(options={})
+      @position = options['position']
+      @words = options['words'].collect {|word| Word.new(word)}
+    end
+  end
+end

data/lib/text_razor/topic.rb

@@ -0,0 +1,11 @@
+class TextRazor
+  class Topic
+    attr_reader :label, :score, :wiki_link
+
+    def initialize(options={})
+      @label = options['label']
+      @score = options['score']
+      @wiki_link = options['wiki_link']
+    end
+  end
+end

data/lib/text_razor/version.rb

@@ -0,0 +1,3 @@
+class TextRazor
+  VERSION = "0.0.1"
+end

data/lib/text_razor/word.rb

@@ -0,0 +1,18 @@
+class TextRazor
+  class Word
+    attr_reader :parent_position, :relation_to_parent, :position, :stem, :lemma,
+                :token, :part_of_speech, :starting_pos, :ending_pos
+
+    def initialize(options={})
+      @parent_position    = options['parentPosition']
+      @relation_to_parent = options['relationToParent']
+      @position           = options['position']
+      @stem               = options['stem']
+      @lemma              = options['lemma']
+      @token              = options['token']
+      @part_of_speech     = options['partOfSpeech']
+      @starting_pos       = options['starting_pos']
+      @ending_pos         = options['ending_pos']
+    end
+  end
+end

data/spec/sentences_spec.rb

@@ -0,0 +1,12 @@
+require 'text_razor/sentence'
+
+describe TextRazor::Sentence do
+  it 'creates words when initializing a new sentence' do
+    json = {"position" => 1,
+            "words"    => [{"position"=>0, "startingPos"=>0, "endingPos"=>3, "stem"=>"see", "lemma"=>"see", "token"=>"See", "partOfSpeech"=>"VB"},
+                           {"position"=>1, "startingPos"=>3, "endingPos"=>4, "stem"=>"?",   "lemma"=>"?",   "token"=>"?",   "partOfSpeech"=>"." }]}
+    sentence = TextRazor::Sentence.new(json)
+    sentence.words.first.class.should eql TextRazor::Word
+    sentence.words.count.should eql 2
+  end
+end

data/spec/text_razor_spec.rb

@@ -0,0 +1,44 @@
+require 'text_razor'
+
+describe TextRazor do
+  before do
+    @textrazor = TextRazor.new(api_key: 'abc123', text: 'This is a test sentence', extractors: 'entities')
+  end
+
+  it 'does not raise an error if the response is empty' do
+    RestClient.stub(:post).and_return({'response' => {}}.to_json)
+    expect { @textrazor.process }.to_not raise_error
+  end
+
+  it 'sets and creates entities' do
+    json = [{"id"=>0, "type"=>["WrittenWork"], "matchingTokens"=>[5],  "entityId"=>"The New York Times", "confidenceScore"=>2.43203, "matchedText"=>"the new york times"},
+            {"id"=>1, "type"=>["Person"],      "matchingTokens"=>[15], "entityId"=>"Nick Bilton",        "confidenceScore"=>0.5,     "matchedText"=>"Nick Bilton"}]
+    @textrazor.create_entities(json)
+    @textrazor.entities.first.class.should eql TextRazor::Entity
+    @textrazor.entities.count.should eql 2
+  end
+
+  it 'sets and creates topics' do
+    json = [{"id"=>0, "label"=>"Advertising", "wikiLink"=>"http://en.wikipedia.org/Advertising", "score"=>0.426667},
+            {"id"=>1, "label"=>"Algorithm",   "wikiLink"=>"http://en.wikipedia.org/Algorithm",   "score"=>0.506667}]
+    @textrazor.create_topics(json)
+    @textrazor.topics.first.class.should eql TextRazor::Topic
+    @textrazor.topics.count.should eql 2
+  end
+
+  it 'sets and creates coarse topics' do
+    json = [{"id"=>0, "label"=>"Advertising", "wikiLink"=>"http://en.wikipedia.org/Advertising", "score"=>0.426667},
+            {"id"=>1, "label"=>"Algorithm",   "wikiLink"=>"http://en.wikipedia.org/Algorithm",   "score"=>0.506667}]
+    @textrazor.create_coarse_topics(json)
+    @textrazor.coarse_topics.first.class.should eql TextRazor::CoarseTopic
+    @textrazor.coarse_topics.count.should eql 2
+  end
+
+  it 'sets and creates sentences' do
+    json = [{"position"=>1, "words"=> [{},{}]},
+            {"position"=>2, "words"=> [{},{}]}]
+    @textrazor.create_sentences(json)
+    @textrazor.sentences.first.class.should eql TextRazor::Sentence
+    @textrazor.sentences.count.should eql 2
+  end
+end

data/text_razor.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'text_razor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "text_razor"
+  gem.version       = TextRazor::VERSION
+  gem.authors       = ["Tomer Elmalem"]
+  gem.email         = ["telmalem@gmail.com"]
+  gem.description   = %q{TextRazor API gem}
+  gem.summary       = %q{An API wrapper for TextRazor's Natural Language Processing API}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "rest-client"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: text_razor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tomer Elmalem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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: pry
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: TextRazor API gem
+email:
+- telmalem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/text_razor.rb
+- lib/text_razor/coarse_topic.rb
+- lib/text_razor/entity.rb
+- lib/text_razor/sentence.rb
+- lib/text_razor/topic.rb
+- lib/text_razor/version.rb
+- lib/text_razor/word.rb
+- spec/sentences_spec.rb
+- spec/text_razor_spec.rb
+- text_razor.gemspec
+homepage: ''
+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.25
+signing_key: 
+specification_version: 3
+summary: An API wrapper for TextRazor's Natural Language Processing API
+test_files:
+- spec/sentences_spec.rb
+- spec/text_razor_spec.rb