textrazor 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bf3035d6e71f1f909d0369bc27cd46e582b9794
-  data.tar.gz: 8f403a7ef549ea2f740ceb3017d43ee2ddae4099
+  metadata.gz: 17c7396459d35be185762cdd33e48422c550382f
+  data.tar.gz: 5162e912ea4c29574f42a291c08945d4be062f03
 SHA512:
-  metadata.gz: f7cfcb4275bc41a291d0df2a05d69a75d85e2502f8471b74d1c6b1ebcebb52403bf90c9ef2c3011da6ae7dd30976bc36be50b0fc3f7a1d6734627c88d795c5c5
-  data.tar.gz: 3132e5fb601f066516aeaf6b25050a25482bd24b01cf9fcf838bc18acbc5e6dcf758f542f6d0faf5dcb0ec019f3043aede30674076672f34c252e9425671a574
+  metadata.gz: e77134b8e36ed76bd5c779100cb203b2542cebd86d436d7054bb64b695f06aa1509077d811b838246cf86531cd90134562e9d6f225cf83b5e7e7d9b8ab797c50
+  data.tar.gz: 18b6342068846a68bd645599fb2a6c55da017320a1fe2d11cf7386ea192d4998431368cdd3acf72d360632fe9518dfe3f1b5e38af7baf774975b2df3b9c626f4

data/README.md

@@ -21,6 +21,17 @@ Or download the git repository and install it yourself as:
 
 ## Usage
 
+### Configuration
+
+By default TextRazor uses the secure SSL endpoint of the Text Razor API.
+You can use the HTTP endpoint by configuring TextRazor:
+
+```
+TextRazor.configure do |config|
+  config.secure = false
+end
+```
+
 ### When the client is persisted across different requests
 
 ```
@@ -31,6 +42,8 @@ response = client.analyse('text to be analysed')
 
 response.topics # Returns an array of TextRazor::Topic instances.
 
+response.coarse_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.
@@ -39,13 +52,15 @@ 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 
+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.coarse_topics('api_key', 'text')
+
 TextRazor.entities('api_key', 'text')
 
 TextRazor.words('api_key', 'text')
@@ -54,7 +69,7 @@ TextRazor.words('api_key', 'text')
 
 ## Next steps
 
-Only implemented this for topics, entities, and words. Also, implement 
+Only implemented this for topics, entities, and words. Also, implement
 it for other information that we can retrieve from the public API.
 
 

data/lib/textrazor.rb

@@ -1,4 +1,5 @@
 require "textrazor/version"
+require "textrazor/configuration"
 require "textrazor/client"
 require "textrazor/request"
 require "textrazor/response"
@@ -20,4 +21,20 @@ module TextRazor
     Client.words(api_key, text, options)
   end
 
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
 end

data/lib/textrazor/client.rb

@@ -31,6 +31,12 @@ module TextRazor
         topics
     end
 
+    def self.coarse_topics(api_key, text, options = {})
+      new(api_key, options.merge(extractors: ['topics'])).
+        analyse(text).
+        coarse_topics
+    end
+
     def self.entities(api_key, text, options = {})
       new(api_key, options.merge(extractors: ['entities'])).
         analyse(text).

data/lib/textrazor/configuration.rb

@@ -0,0 +1,9 @@
+module TextRazor
+  class Configuration
+    attr_accessor :secure
+
+    def initialize
+      @secure = true
+    end
+  end
+end

data/lib/textrazor/request.rb

@@ -4,6 +4,9 @@ module TextRazor
 
   class Request
 
+    HTTP_URL = 'http://api.textrazor.com/'
+    HTTPS_URL = 'https://api.textrazor.com/'
+
     OPTIONS_MAPPING = {
       extractors: 'extractors',
       cleanup_html: 'cleanupHTML',
@@ -13,7 +16,11 @@ module TextRazor
     }
 
     def self.post(text, options)
-      ::RestClient.post "http://api.textrazor.com/", build_query(text, options), accept_encoding: 'gzip'
+      ::RestClient.post url, build_query(text, options), accept_encoding: 'gzip'
+    end
+
+    def self.url
+      TextRazor.configuration.secure ? HTTPS_URL : HTTP_URL
     end
 
     private

data/lib/textrazor/response.rb

@@ -22,14 +22,11 @@ module TextRazor
     end
 
     def topics
-      raw_topics = raw_response["topics"]
-      return nil if raw_topics.nil?
+      @topics ||= parse_topics(raw_response["topics"])
+    end
 
-      @topics ||= begin
-        raw_topics.map do |topic_hash|
-          Topic.create_from_hash(topic_hash)
-        end
-      end
+     def coarse_topics
+      @coarse_topics ||= parse_topics(raw_response["coarseTopics"])
     end
 
     def entities
@@ -72,6 +69,14 @@ module TextRazor
       code == 413
     end
 
+    def parse_topics(raw_topics)
+      return nil if raw_topics.nil?
+
+      raw_topics.map do |topic_hash|
+        Topic.create_from_hash(topic_hash)
+      end
+    end
+
   end
 
 end

data/lib/textrazor/version.rb

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

data/spec/lib/textrazor/client_spec.rb

@@ -123,7 +123,26 @@ module TextRazor
 
       it "should make correct calls" do
         client = OpenStruct.new
-        response = OpenStruct.new topics: ['topic1']
+        response = OpenStruct.new topics: ['topic1'], coarseTopics: ['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 ".coarse_topics" do
+
+      it "should make correct calls" do
+        client = OpenStruct.new
+        response = OpenStruct.new topics: ['topic1'], coarseTopics: ['topic1']
 
         Client.should_receive(:new).
           with(api_key, {extractors: ['topics']}).

data/spec/lib/textrazor/configuration_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+module TextRazor
+  describe Configuration do
+    describe "#secure" do
+      it "default value is true" do
+        Configuration.new.secure = true
+      end
+    end
+
+    describe "#secure=" do
+      it "can set value" do
+        config = Configuration.new
+        config.secure = false
+        expect(config.secure).to eq(false)
+      end
+    end
+  end
+end

data/spec/lib/textrazor/request_spec.rb

@@ -4,6 +4,40 @@ module TextRazor
 
   describe Request do
 
+    describe ".url" do
+      after :each do
+        TextRazor.reset
+      end
+
+      let(:url) do
+        TextRazor::Request.url
+      end
+
+      context "with the config 'secure' set to false" do
+        before :each do
+          TextRazor.configure do |config|
+            config.secure = false
+          end
+        end
+
+        it "returns the unsecured URL" do
+          expect(url).to eq 'http://api.textrazor.com/'
+        end
+      end
+
+      context "with the config 'secure' set to true" do
+        before :each do
+          TextRazor.configure do |config|
+            config.secure = true
+          end
+        end
+
+        it "returns the unsecured URL" do
+          expect(url).to eq 'https://api.textrazor.com/'
+        end
+      end
+    end
+
     context ".post" do
 
       context "default options" do
@@ -12,7 +46,7 @@ module TextRazor
           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',
+            with("https://api.textrazor.com/", { "text" => 'text', "apiKey" => 'api_key',
             "extractors" => "entities,topics,words,dependency-trees,relations,entailments" }, accept_encoding: 'gzip')
 
           Request.post('text', options)
@@ -27,7 +61,7 @@ module TextRazor
                      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",
+            with("https://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')

data/spec/lib/textrazor/response_spec.rb

@@ -91,6 +91,41 @@ module TextRazor
 
     end
 
+    context "#coarse_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,\"coarseTopics\":[{\"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.coarse_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

data/spec/lib/textrazor_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe TextRazor do
 
-  context ".topics" do
+  describe ".topics" do
 
     it "should make correct calls" do
       TextRazor::Client.should_receive(:topics).
@@ -13,7 +13,7 @@ describe TextRazor do
 
   end
 
-  context ".entities" do
+  describe ".entities" do
 
     it "should make correct calls" do
       TextRazor::Client.should_receive(:entities).
@@ -24,7 +24,7 @@ describe TextRazor do
 
   end
 
-  context ".words" do
+  describe ".words" do
 
     it "should make correct calls" do
       TextRazor::Client.should_receive(:words).
@@ -35,4 +35,18 @@ describe TextRazor do
 
   end
 
+  describe ".reset" do
+    before :each do
+      TextRazor.configure do |config|
+        config.secure = false
+      end
+    end
+
+    it "resets the configuration" do
+      TextRazor.reset
+      config = TextRazor.configuration
+      expect(config.secure).to eq(true)
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: textrazor
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Anuj Dutta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -109,6 +109,7 @@ files:
 - Rakefile
 - lib/textrazor.rb
 - lib/textrazor/client.rb
+- lib/textrazor/configuration.rb
 - lib/textrazor/entity.rb
 - lib/textrazor/request.rb
 - lib/textrazor/response.rb
@@ -116,6 +117,7 @@ files:
 - lib/textrazor/version.rb
 - lib/textrazor/word.rb
 - spec/lib/textrazor/client_spec.rb
+- spec/lib/textrazor/configuration_spec.rb
 - spec/lib/textrazor/entity_spec.rb
 - spec/lib/textrazor/request_spec.rb
 - spec/lib/textrazor/response_spec.rb
@@ -150,6 +152,7 @@ specification_version: 4
 summary: An api wrapper for text razor in ruby
 test_files:
 - spec/lib/textrazor/client_spec.rb
+- spec/lib/textrazor/configuration_spec.rb
 - spec/lib/textrazor/entity_spec.rb
 - spec/lib/textrazor/request_spec.rb
 - spec/lib/textrazor/response_spec.rb