textrazor 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bf3035d6e71f1f909d0369bc27cd46e582b9794
+  data.tar.gz: 8f403a7ef549ea2f740ceb3017d43ee2ddae4099
+SHA512:
+  metadata.gz: f7cfcb4275bc41a291d0df2a05d69a75d85e2502f8471b74d1c6b1ebcebb52403bf90c9ef2c3011da6ae7dd30976bc36be50b0fc3f7a1d6734627c88d795c5c5
+  data.tar.gz: 3132e5fb601f066516aeaf6b25050a25482bd24b01cf9fcf838bc18acbc5e6dcf758f542f6d0faf5dcb0ec019f3043aede30674076672f34c252e9425671a574

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/.rspec

@@ -0,0 +1 @@
+--color

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 Anuj Dutta
+
+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,67 @@
+# TextRazor
+
+This is a gem wrapper for TextRazor REST API reference.
+
+## Installation
+
+
+
+Add this line to your application's Gemfile:
+
+    gem 'textrazor', :git => 'git://github.com/andhapp/textrazor.git'
+
+And then execute:
+
+    $ bundle
+
+Or download the git repository and install it yourself as:
+
+    $ gem build textrazor.gemspec
+    $ gem install textrazor-[version].gem
+
+## Usage
+
+### When the client is persisted across different requests
+
+```
+
+client = TextRazor::Client.new('api_key')
+
+response = client.analyse('text to be analysed')
+
+response.topics # Returns an array of TextRazor::Topic instances.
+
+response.entities # Returns an array of TextRazor::Entity instances.
+
+response.words # Returns an array of TextRazor::Word instances.
+
+```
+
+### One off requests
+
+For making one off request to retrieve topics, entities or words you 
+can use the following handy method. A new client is instantiated and 
+discarded everytime you make this request.
+
+```
+TextRazor.topics('api_key', 'text')
+
+TextRazor.entities('api_key', 'text')
+
+TextRazor.words('api_key', 'text')
+
+```
+
+## Next steps
+
+Only implemented this for topics, entities, and words. Also, implement 
+it for other information that we can retrieve from the public API.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/textrazor.rb

@@ -0,0 +1,23 @@
+require "textrazor/version"
+require "textrazor/client"
+require "textrazor/request"
+require "textrazor/response"
+require "textrazor/topic"
+require "textrazor/entity"
+require "textrazor/word"
+
+module TextRazor
+
+  def self.topics(api_key, text, options = {})
+    Client.topics(api_key, text, options)
+  end
+
+  def self.entities(api_key, text, options = {})
+    Client.entities(api_key, text, options)
+  end
+
+  def self.words(api_key, text, options = {})
+    Client.words(api_key, text, options)
+  end
+
+end

data/lib/textrazor/client.rb

@@ -0,0 +1,79 @@
+module TextRazor
+
+  class Client
+
+    EmptyApiKey = Class.new(StandardError)
+    EmptyText = Class.new(StandardError)
+    TextTooLong = Class.new(StandardError)
+
+    DEFAULT_EXTRACTORS = ['entities', 'topics', 'words', 'phrases', 'dependency-trees',
+                          'relations', 'entailments', 'senses']
+
+    REQUEST_OPTIONS = [:extractors, :cleanup_html, :language, :filter_dbpedia_types, :filter_freebase_types]
+
+    attr_reader :response, :api_key, :request_options
+
+    def initialize(api_key, options = {})
+      assign_api_key(api_key)
+      assign_request_options(options)
+    end
+
+    def analyse(text)
+      assert_text(text)
+      options = {api_key: api_key}.merge(request_options)
+
+      Response.new(Request.post(text, options))
+    end
+
+    def self.topics(api_key, text, options = {})
+      new(api_key, options.merge(extractors: ['topics'])).
+        analyse(text).
+        topics
+    end
+
+    def self.entities(api_key, text, options = {})
+      new(api_key, options.merge(extractors: ['entities'])).
+        analyse(text).
+        entities
+    end
+
+    def self.words(api_key, text, options = {})
+      new(api_key, options.merge(extractors: ['words'])).
+        analyse(text).
+        entities
+    end
+
+    private
+
+    def assign_api_key(api_key)
+      if api_key.nil? || api_key.empty?
+        raise EmptyApiKey.new("API key is either nil or empty")
+      end
+
+      @api_key = api_key
+    end
+
+    def assign_request_options(options)
+      @request_options = { extractors: DEFAULT_EXTRACTORS }
+      REQUEST_OPTIONS.each do |key|
+        @request_options[key] = options[key] if options[key]
+      end
+    end
+
+    def assert_text(text)
+      if text.nil? || text.empty?
+        raise EmptyText.new("Text to be analysed is nil or empty")
+      end
+
+      if is_text_bigger_than_200_kb?(text)
+        raise TextTooLong.new("Text is more than 200kb")
+      end
+    end
+
+    def is_text_bigger_than_200_kb?(text)
+      text.bytesize/1024.0 > 200
+    end
+
+  end
+
+end

data/lib/textrazor/entity.rb

@@ -0,0 +1,32 @@
+module TextRazor
+
+  class Entity
+
+    attr_reader :id, :type, :matching_tokens, :entity_id, :freebase_types, :confidence_score,
+      :wiki_link, :matched_text, :freebase_id, :relevance_score, :entity_english_id,
+      :starting_pos, :ending_pos
+
+    def initialize(params = {})
+      @type = []
+      params.each do |k, v|
+        instance_variable_set(:"@#{k}", v) if v && self.respond_to?(:"#{k}")
+      end
+    end
+
+    def self.create_from_hash(params)
+      params = Hash[params.map {|k, v| [underscore(k), v] }]
+      new(params)
+    end
+
+    def self.underscore(text)
+      text.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+    private_class_method :underscore
+
+  end
+
+end

data/lib/textrazor/request.rb

@@ -0,0 +1,34 @@
+require 'rest_client'
+
+module TextRazor
+
+  class Request
+
+    OPTIONS_MAPPING = {
+      extractors: 'extractors',
+      cleanup_html: 'cleanupHTML',
+      language: 'languageOverride',
+      filter_dbpedia_types: 'entities.filterDbpediaTypes',
+      filter_freebase_types: 'entities.filterFreebaseTypes'
+    }
+
+    def self.post(text, options)
+      ::RestClient.post "http://api.textrazor.com/", build_query(text, options), accept_encoding: 'gzip'
+    end
+
+    private
+
+    def self.build_query(text, options)
+      query = {"text" => text, "apiKey" => options.delete(:api_key)}
+
+      options.each do |key, value|
+        value = value.join(",") if value.is_a?(Array)
+        query[OPTIONS_MAPPING[key]] = value
+      end
+
+      query
+    end
+
+  end
+
+end

data/lib/textrazor/response.rb

@@ -0,0 +1,77 @@
+require 'json'
+
+module TextRazor
+
+  class Response
+
+    BadRequest = Class.new(StandardError)
+    Unauthorised = Class.new(StandardError)
+    RequestEntityTooLong = Class.new(StandardError)
+
+    attr_reader :raw_response
+
+    def initialize(http_response)
+      code = http_response.code
+      body = http_response.body
+
+      raise BadRequest.new(body) if bad_request?(code)
+      raise Unauthorised.new(body) if unauthorised?(code)
+      raise RequestEntityTooLong.new(body) if request_entity_too_long?(code)
+
+      @raw_response = ::JSON.parse(body)["response"]
+    end
+
+    def topics
+      raw_topics = raw_response["topics"]
+      return nil if raw_topics.nil?
+
+      @topics ||= begin
+        raw_topics.map do |topic_hash|
+          Topic.create_from_hash(topic_hash)
+        end
+      end
+    end
+
+    def entities
+      raw_entities = raw_response["entities"]
+      return nil if raw_entities.nil?
+
+      @entities ||= begin
+        raw_entities.map do |entity_hash|
+          Entity.create_from_hash(entity_hash)
+        end
+      end
+    end
+
+    def words
+      raw_sentences = raw_response["sentences"]
+      return nil if raw_sentences.nil?
+
+      @words ||= begin
+        words = []
+        raw_sentences.each do |sentence_hash|
+          sentence_hash["words"].each do |word_hash|
+            words << Word.create_from_hash(word_hash)
+          end
+        end
+        words
+      end
+    end
+
+    private
+
+    def bad_request?(code)
+      code == 400
+    end
+
+    def unauthorised?(code)
+      code == 401
+    end
+
+    def request_entity_too_long?(code)
+      code == 413
+    end
+
+  end
+
+end

data/lib/textrazor/topic.rb

@@ -0,0 +1,20 @@
+module TextRazor
+
+  class Topic
+
+    attr_reader :id, :label, :wiki_link, :score
+
+    def initialize(id, label, wiki_link, score)
+      @id = id
+      @label = label
+      @wiki_link = wiki_link
+      @score = score
+    end
+
+    def self.create_from_hash(params)
+      new(params["id"], params["label"], params["wikiLink"], params["score"])
+    end
+
+  end
+
+end

data/lib/textrazor/version.rb

@@ -0,0 +1,3 @@
+module TextRazor
+  VERSION = "0.0.6"
+end

data/lib/textrazor/word.rb

@@ -0,0 +1,24 @@
+module TextRazor
+
+  class Word
+
+    attr_reader :position, :starting_pos, :ending_pos, :stem,
+                :lemma, :token, :part_of_speech
+
+    def initialize(params)
+      @position = params["position"]
+      @starting_pos = params["startingPos"]
+      @ending_pos = params["endingPos"]
+      @stem = params["stem"]
+      @lemma = params["lemma"]
+      @token = params["token"]
+      @part_of_speech = params["partOfSpeech"]
+    end
+
+    def self.create_from_hash(params)
+      new(params)
+    end
+
+  end
+
+end

data/spec/lib/textrazor/client_spec.rb

@@ -0,0 +1,181 @@
+require "spec_helper"
+
+module TextRazor
+
+  describe Client do
+
+    let(:api_key) { 'api_key' }
+    let(:client) { custom_options_client }
+    let(:nil_api_key_client) { Client.new(nil) }
+    let(:empty_api_key_client) { Client.new('') }
+    let(:custom_options_client) { Client.new(api_key, {extractors: %w(entities topics words),
+                                    cleanup_html: true, filter_dbpedia_types: %w(type1),
+                                    language: 'fre',
+                                    filter_freebase_types: %w(type2)}) }
+    let(:default_options_client) { Client.new(api_key) }
+
+    context "#initialize" do
+
+      context "valid parameters" do
+
+        it "should assign correct api_key, text and default options" do
+          expect(default_options_client.api_key).to eq(api_key)
+          expect(default_options_client.request_options).
+            to eq({extractors: %w(entities topics words phrases dependency-trees relations entailments senses)})
+        end
+
+        it "should assign correct api_key, text and passed in options" do
+          expect(custom_options_client.api_key).to eq(api_key)
+          expect(custom_options_client.request_options).
+            to eq({extractors: %w(entities topics words), cleanup_html: true, language: 'fre',
+                   filter_dbpedia_types: %w(type1), filter_freebase_types: %w(type2)})
+        end
+
+      end
+
+      context "invalid parameters" do
+
+        context "api_key" do
+
+          context "is nil" do
+
+            it "should raise an exception" do
+              expect { nil_api_key_client }.
+                to raise_error(Client::EmptyApiKey)
+            end
+
+          end
+
+          context "is empty" do
+
+            it "should raise an exception" do
+              expect { empty_api_key_client }.
+                to raise_error(Client::EmptyApiKey)
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+    context "#analyse" do
+
+      let(:very_long_text) { "L" * 201 * 1024 }
+
+      context "valid parameters" do
+
+        it "should make correct calls" do
+          request = Object.new
+
+          Request.should_receive(:post).
+            with('text', {api_key: 'api_key', extractors: %w(entities topics words), cleanup_html: true,
+                          language: 'fre', filter_dbpedia_types: %w(type1), filter_freebase_types: %w(type2)}).
+            and_return(request)
+
+          Response.should_receive(:new).with(request)
+
+          client.analyse('text')
+        end
+
+      end
+
+      context "invalid parameters" do
+
+        context "text" do
+
+          context "is nil" do
+
+            it "should raise an exception" do
+              expect { client.analyse(nil) }.
+                to raise_error(Client::EmptyText)
+            end
+
+          end
+
+          context "is empty" do
+
+            it "should raise an exception" do
+              expect { client.analyse('') }.
+                to raise_error(Client::EmptyText)
+            end
+
+          end
+
+          context "size is > 200kb" do
+
+            it "should raise an exception" do
+              expect { client.analyse(very_long_text) }.
+                to raise_error(Client::TextTooLong)
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+    context ".topics" do
+
+      it "should make correct calls" do
+        client = OpenStruct.new
+        response = OpenStruct.new topics: ['topic1']
+
+        Client.should_receive(:new).
+          with(api_key, {extractors: ['topics']}).
+          and_return(client)
+
+        client.should_receive(:analyse).
+          with("text").
+          and_return(response)
+
+        Client.topics(api_key, 'text', {})
+      end
+
+    end
+
+    context ".entities" do
+
+      it "should make correct calls" do
+        client = OpenStruct.new
+        response = OpenStruct.new entities: ['Entity1']
+
+        Client.should_receive(:new).
+          with(api_key, {extractors: ['entities']}).
+          and_return(client)
+
+        client.should_receive(:analyse).
+          with("text").
+          and_return(response)
+
+        Client.entities(api_key, 'text', {})
+      end
+
+    end
+
+    context ".words" do
+
+      it "should make correct calls" do
+        client = OpenStruct.new
+        response = OpenStruct.new words: ['Word1']
+
+        Client.should_receive(:new).
+          with(api_key, {extractors: ['words']}).
+          and_return(client)
+
+        client.should_receive(:analyse).
+          with("text").
+          and_return(response)
+
+        Client.words(api_key, 'text', {})
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/textrazor/entity_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+module TextRazor
+
+  describe Entity do
+
+    context "#create_from_hash" do
+
+      it "should create a new instance" do
+        entity_hash = {"id" => 1, "type" => ['Person'], "matchingTokens" => [1, 2], "entityId" => "Foreign minister",
+                       "freebaseTypes" => ["government/government_office_or_title"],
+                       "confidenceScore" => 0.897858, "wikiLink" => "http://en.wikipedia.org/wiki/Foreign_minister",
+                       "matchedText" => "foreign ministers", "freebaseId" => "/m/01t_55", "relevanceScore" => 0.311479,
+                       "entityEnglishId" => "Foreign minister", "startingPos" => 3, "endingPos" => 20}
+
+        entity = Entity.create_from_hash(entity_hash)
+
+        expect(entity.id).to eq(1)
+        expect(entity.type).to eq(['Person'])
+        expect(entity.matching_tokens).to eq([1,2])
+        expect(entity.entity_id).to eq("Foreign minister")
+        expect(entity.freebase_types).to eq(["government/government_office_or_title"])
+        expect(entity.confidence_score).to eq(0.897858)
+        expect(entity.wiki_link).to eq("http://en.wikipedia.org/wiki/Foreign_minister")
+        expect(entity.matched_text).to eq("foreign ministers")
+        expect(entity.freebase_id).to eq("/m/01t_55")
+        expect(entity.relevance_score).to eq(0.311479)
+        expect(entity.entity_english_id).to eq("Foreign minister")
+        expect(entity.starting_pos).to eq(3)
+        expect(entity.ending_pos).to eq(20)
+      end
+
+      it "should use sensible defaults" do
+        entity_hash = {"id" => 1, "startingPos" => 3, "endingPos" => 20}
+
+        entity = Entity.create_from_hash(entity_hash)
+
+        expect(entity.type).to eq([])
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/textrazor/request_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module TextRazor
+
+  describe Request do
+
+    context ".post" do
+
+      context "default options" do
+
+        it "should make correct calls" do
+          options = {api_key: 'api_key', extractors: %w(entities topics words dependency-trees relations entailments)}
+
+          ::RestClient.should_receive(:post).
+            with("http://api.textrazor.com/", { "text" => 'text', "apiKey" => 'api_key',
+            "extractors" => "entities,topics,words,dependency-trees,relations,entailments" }, accept_encoding: 'gzip')
+
+          Request.post('text', options)
+        end
+
+      end
+
+      context "custom options" do
+
+        it "should make correct calls" do
+          options = {api_key: 'api_key', extractors: %w(entities topics words), cleanup_html: true,
+                     language: 'fre', filter_dbpedia_types: %w(type1), filter_freebase_types: %w(type2)}
+
+          ::RestClient.should_receive(:post).
+            with("http://api.textrazor.com/", { "text" => 'text', "apiKey" => 'api_key', "extractors" => "entities,topics,words",
+            "cleanupHTML" => true, "languageOverride" => 'fre', "entities.filterDbpediaTypes" => "type1",
+            "entities.filterFreebaseTypes" => "type2" },
+             accept_encoding: 'gzip')
+
+          Request.post('text', options)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/textrazor/response_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+module TextRazor
+
+  describe Response do
+
+    context "#initialize" do
+
+      context "when HTTP response code is 200" do
+
+        it "should create an instance of Response" do
+          body = "{\"response\":\"{}\"}"
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          JSON.should_receive(:parse).
+            with(body).
+            and_return({"response"=>"{}"})
+
+          Response.new(http_response)
+        end
+
+      end
+
+      context "when HTTP response code is 400" do
+
+        it "should raise an exception" do
+          http_response = ::OpenStruct.new code: 400
+
+          expect{ Response.new(http_response) }.
+            to raise_error(Response::BadRequest)
+        end
+
+      end
+
+      context "when HTTP response code is 401" do
+
+        it "should raise an exception" do
+          http_response = ::OpenStruct.new code: 401
+
+          expect{ Response.new(http_response) }.
+            to raise_error(Response::Unauthorised)
+        end
+
+      end
+
+      context "when HTTP response code is 413" do
+
+        it "should raise an exception" do
+          http_response = ::OpenStruct.new code: 413
+
+          expect{ Response.new(http_response) }.
+            to raise_error(Response::RequestEntityTooLong)
+        end
+
+      end
+
+    end
+
+    context "#topics" do
+
+      context "if there are topics returned from api" do
+
+        it "should return topics" do
+          body = "\n    {\"time\":\"0.013219\",\"response\":{\"language\":\"eng\",\"languageIsReliable\":true,\"topics\":[{\"id\":0,\"label\":\"Airlines \",\"wikiLink\":\"http://en.wikipedia.org/Category:Airlines_by_country\",\"score\":0.199069},{\"id\":1,\"label\":\"Companies \",\"wikiLink\":\"http://en.wikipedia.org/Category:Companies_by_year_of_establishment\",\"score\":0.136068}]}} \n"
+
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          response = Response.new(http_response)
+
+          topics = response.topics
+
+          expect(topics).to_not be_nil
+          expect(topics.size).to eq(2)
+        end
+
+      end
+
+      context "if there are no topics returned from api" do
+
+        it "should return nil" do
+          body = "{\"time\":\"0.013219\",\"response\":{\"language\":\"eng\",\"languageIsReliable\":true}}"
+
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          response = Response.new(http_response)
+
+          expect(response.topics).to be_nil
+        end
+
+      end
+
+    end
+
+    context "#entities" do
+
+      context "if there are any entities returned" do
+
+        it "should return entities" do
+          body = "{\"time\":\"0.013219\",\"response\":{\"language\":\"eng\",\"languageIsReliable\":true,\"entities\":[{\"id\":0,\"matchingTokens\":[0],\"entityId\":\"European Union\",\"freebaseTypes\":[\"/award/award_winner\",\"/book/author\",\"/location/country\",\"/organization/organization_scope\",\"/book/book_subject\",\"/location/dated_location\",\"/people/ethnicity\",\"/projects/project_participant\",\"/location/statistical_region\",\"/organization/organization\",\"/organization/organization_member\",\"/government/governmental_jurisdiction\",\"/organization/membership_organization\",\"/internet/website_category\",\"/internet/website_owner\",\"business/employer\",\"/location/location\"],\"confidenceScore\":1.01581,\"wikiLink\":\"http://en.wikipedia.org/wiki/European_Union\",\"matchedText\":\"eu\",\"freebaseId\":\"/m/02jxk\",\"relevanceScore\":0.567223,\"entityEnglishId\":\"European Union\",\"startingPos\":0,\"endingPos\":2},{\"id\":1,\"matchingTokens\":[1,2],\"entityId\":\"Foreign minister\",\"freebaseTypes\":[\"government/government_office_or_title\"],\"confidenceScore\":0.897858,\"wikiLink\":\"http://en.wikipedia.org/wiki/Foreign_minister\",\"matchedText\":\"foreign ministers\",\"freebaseId\":\"/m/01t_55\",\"relevanceScore\":0.311479,\"entityEnglishId\":\"Foreign minister\",\"startingPos\":3,\"endingPos\":20}]}}"
+
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          response = Response.new(http_response)
+
+          entities = response.entities
+
+          expect(entities).to_not be_nil
+          expect(entities.size).to eq(2)
+        end
+
+      end
+
+      context "if there are no entities returned" do
+
+        it "should return nil" do
+          body = "{\"time\":\"0.013219\",\"response\":{\"language\":\"eng\",\"languageIsReliable\":true}}"
+
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          response = Response.new(http_response)
+
+          expect(response.entities).to be_nil
+        end
+
+      end
+
+    end
+
+    context "#words" do
+
+      context "if there are any words returned" do
+
+        it "should return words" do
+          body = "{\"time\":\"0.013219\",\"response\":{\"language\":\"eng\",\"languageIsReliable\":true,\"sentences\":[{\"position\":1,\"words\":[{\"position\":0,\"startingPos\":0,\"endingPos\":3,\"stem\":\"the\",\"lemma\":\"the\",\"token\":\"The\",\"partOfSpeech\":\"DT\"},{\"position\":1,\"startingPos\":4,\"endingPos\":7,\"stem\":\"two\",\"lemma\":\"two\",\"token\":\"two\",\"partOfSpeech\":\"CD\"},{\"position\":2,\"startingPos\":8,\"endingPos\":11,\"stem\":\"men\",\"lemma\":\"man\",\"token\":\"men\",\"partOfSpeech\":\"NNS\"},{\"position\":3,\"startingPos\":12,\"endingPos\":19,\"stem\":\"accus\",\"lemma\":\"accuse\",\"token\":\"accused\",\"partOfSpeech\":\"VBN\"}]}]}}"
+
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          response = Response.new(http_response)
+
+          words = response.words
+
+          expect(words).to_not be_nil
+          expect(words.size).to eq(4)
+          expect(words.first).to be_instance_of(Word)
+        end
+
+      end
+
+      context "if there are no words returned" do
+
+        it "should return nil" do
+          body = "{\"time\":\"0.013219\",\"response\":{\"language\":\"eng\",\"languageIsReliable\":true}}"
+
+          http_response = ::OpenStruct.new code: 200, body: body
+
+          response = Response.new(http_response)
+
+          expect(response.words).to be_nil
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/textrazor/topic_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+module TextRazor
+
+  describe Topic do
+
+    context "#create_from_hash" do
+
+      it "should create a new instance" do
+        topic_hash = {"id" => 1, "label" => "Sports", "wikiLink" => "link_to_wiki", 
+                      "score" => 1.03589}
+
+        topic = Topic.create_from_hash(topic_hash)
+
+        expect(topic.id).to eq(1)
+        expect(topic.label).to eq("Sports")
+        expect(topic.wiki_link).to eq("link_to_wiki")
+        expect(topic.score).to eq(1.03589)
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/textrazor/word_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+module TextRazor
+
+  describe Word do
+
+    context "#create_from_hash" do
+
+      it "should create a new instance" do
+        word_hash = {"position" => 0, "startingPos" => 0, "endingPos" => 3, "stem" => "the",
+                     "lemma" => "the", "token" => "The", "partOfSpeech" => "DT"}
+
+        word = Word.create_from_hash(word_hash)
+
+        expect(word.position).to eq(0)
+        expect(word.starting_pos).to eq(0)
+        expect(word.ending_pos).to eq(3)
+        expect(word.stem).to eq("the")
+        expect(word.lemma).to eq("the")
+        expect(word.token).to eq("The")
+        expect(word.part_of_speech).to eq("DT")
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/textrazor_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe TextRazor do
+
+  context ".topics" do
+
+    it "should make correct calls" do
+      TextRazor::Client.should_receive(:topics).
+        with('api_key', 'text', {})
+
+      TextRazor.topics('api_key', 'text', {})
+    end
+
+  end
+
+  context ".entities" do
+
+    it "should make correct calls" do
+      TextRazor::Client.should_receive(:entities).
+        with('api_key', 'text', {})
+
+      TextRazor.entities('api_key', 'text', {})
+    end
+
+  end
+
+  context ".words" do
+
+    it "should make correct calls" do
+      TextRazor::Client.should_receive(:words).
+        with('api_key', 'text', {})
+
+      TextRazor.words('api_key', 'text', {})
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "bundler"
+Bundler.require
+
+require 'ostruct'
+require 'rspec/fire'
+require File.expand_path("../../lib/textrazor" ,__FILE__)
+
+RSpec.configure do |config|
+  config.include(RSpec::Fire)
+end

data/textrazor.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'textrazor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "textrazor"
+  spec.version       = TextRazor::VERSION
+  spec.authors       = ["Anuj Dutta"]
+  spec.email         = ["anuj@andhapp.com"]
+  spec.description   = %q{Api wrapper for text razor}
+  spec.summary       = %q{An api wrapper for text razor in ruby}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "fast_open_struct"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-fire"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: textrazor
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Anuj Dutta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fast_open_struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Api wrapper for text razor
+email:
+- anuj@andhapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/textrazor.rb
+- lib/textrazor/client.rb
+- lib/textrazor/entity.rb
+- lib/textrazor/request.rb
+- lib/textrazor/response.rb
+- lib/textrazor/topic.rb
+- lib/textrazor/version.rb
+- lib/textrazor/word.rb
+- spec/lib/textrazor/client_spec.rb
+- spec/lib/textrazor/entity_spec.rb
+- spec/lib/textrazor/request_spec.rb
+- spec/lib/textrazor/response_spec.rb
+- spec/lib/textrazor/topic_spec.rb
+- spec/lib/textrazor/word_spec.rb
+- spec/lib/textrazor_spec.rb
+- spec/spec_helper.rb
+- textrazor.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An api wrapper for text razor in ruby
+test_files:
+- spec/lib/textrazor/client_spec.rb
+- spec/lib/textrazor/entity_spec.rb
+- spec/lib/textrazor/request_spec.rb
+- spec/lib/textrazor/response_spec.rb
+- spec/lib/textrazor/topic_spec.rb
+- spec/lib/textrazor/word_spec.rb
+- spec/lib/textrazor_spec.rb
+- spec/spec_helper.rb