RubyGems - alchemy-api-rb - Versions diffs - 0.1.0 - Mend

alchemy-api-rb 0.1.0

Files changed (57) hide show

data/.gitignore +19 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/README.md +80 -0
data/Rakefile +11 -0
data/alchemy-api-rb.gemspec +24 -0
data/lib/alchemy-api.rb +47 -0
data/lib/alchemy-api/author_extraction.rb +21 -0
data/lib/alchemy-api/base.rb +78 -0
data/lib/alchemy-api/concept_tagging.rb +16 -0
data/lib/alchemy-api/config.rb +34 -0
data/lib/alchemy-api/entity_extraction.rb +15 -0
data/lib/alchemy-api/keyword_extraction.rb +15 -0
data/lib/alchemy-api/language_detection.rb +17 -0
data/lib/alchemy-api/relation_extraction.rb +16 -0
data/lib/alchemy-api/sentiment_analysis.rb +16 -0
data/lib/alchemy-api/text_categorization.rb +21 -0
data/lib/alchemy-api/text_extraction.rb +19 -0
data/lib/alchemy-api/version.rb +3 -0
data/spec/alchemy_api_spec.rb +70 -0
data/spec/author_extraction_spec.rb +43 -0
data/spec/base_spec.rb +20 -0
data/spec/concept_tagging_spec.rb +44 -0
data/spec/entity_extraction_spec.rb +44 -0
data/spec/keyword_extraction_spec.rb +50 -0
data/spec/language_detection_spec.rb +43 -0
data/spec/relation_extraction_spec.rb +44 -0
data/spec/sentiment_analysis_spec.rb +43 -0
data/spec/spec_helper.rb +13 -0
data/spec/text_categorization_spec.rb +43 -0
data/spec/text_extraction_spec.rb +32 -0
data/spec/vcr_cassettes/author_basic_html_json_search.yml +46 -0
data/spec/vcr_cassettes/author_basic_url_json_search.yml +47 -0
data/spec/vcr_cassettes/category_basic_html_json_search.yml +43 -0
data/spec/vcr_cassettes/category_basic_text_json_search.yml +46 -0
data/spec/vcr_cassettes/category_basic_url_json_search.yml +46 -0
data/spec/vcr_cassettes/concept_basic_html_json_search.yml +54 -0
data/spec/vcr_cassettes/concept_basic_text_json_search.yml +55 -0
data/spec/vcr_cassettes/concept_basic_url_json_search.yml +75 -0
data/spec/vcr_cassettes/entity_basic_html_json_search.yml +61 -0
data/spec/vcr_cassettes/entity_basic_text_json_search.yml +60 -0
data/spec/vcr_cassettes/entity_basic_url_json_search.yml +71 -0
data/spec/vcr_cassettes/keyword_basic_html_json_search.yml +48 -0
data/spec/vcr_cassettes/keyword_basic_text_json_search.yml +48 -0
data/spec/vcr_cassettes/keyword_basic_url_json_search.yml +67 -0
data/spec/vcr_cassettes/language_basic_html_json_search.yml +49 -0
data/spec/vcr_cassettes/language_basic_text_json_search.yml +49 -0
data/spec/vcr_cassettes/language_basic_url_json_search.yml +49 -0
data/spec/vcr_cassettes/relation_basic_html_json_search.yml +53 -0
data/spec/vcr_cassettes/relation_basic_text_json_search.yml +53 -0
data/spec/vcr_cassettes/relation_basic_url_json_search.yml +58 -0
data/spec/vcr_cassettes/sentiment_basic_html_json_search.yml +48 -0
data/spec/vcr_cassettes/sentiment_basic_text_json_search.yml +48 -0
data/spec/vcr_cassettes/sentiment_basic_url_json_search.yml +48 -0
data/spec/vcr_cassettes/text_basic_html_json_search.yml +47 -0
data/spec/vcr_cassettes/text_basic_url_json_search.yml +47 -0
metadata +196 -0

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'turn/autorun'
+require 'vcr'
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/alchemy-api'))
+API_KEY = File.read('./.keys').chomp
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/vcr_cassettes'
+  c.hook_into :fakeweb
+end

data/spec/text_categorization_spec.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "text_categorization" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::TextCategorization.new }
+  describe "#search" do
+    {
+      :text => "lorem ipsum",
+      :url => "http://www.alchemyapi.com/"
+    }.each do |type,value|
+      [:json].each do |output_mode|
+        before do
+          AlchemyAPI::Config.output_mode = output_mode
+        end
+        describe "#{type} search with #{output_mode} results" do
+          it "returns an array of results" do
+            VCR.use_cassette("category_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result.must_be_instance_of Hash
+            end
+          end
+          it "includes the keyword text and relavence" do
+            VCR.use_cassette("category_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result["url"].wont_be_nil
+              result["category"].wont_be_nil
+              result["score"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/text_extraction_spec.rb ADDED Viewed

@@ -0,0 +1,32 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "text_extraction" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::TextExtraction.new }
+  describe "#search" do
+    {
+      :html => "<html><body>foo bar</body></html>",
+      :url => "http://www.google.com"
+    }.each do |type,value|
+      [:json].each do |output_mode|
+        before do
+          AlchemyAPI::Config.output_mode = output_mode
+        end
+        describe "#{type} search with #{output_mode} results" do
+          it "returns an array of results" do
+            VCR.use_cassette("text_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result.must_be_instance_of String
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/vcr_cassettes/author_basic_html_json_search.yml ADDED Viewed

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/html/HTMLGetAuthor
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&html=<html><body>Google
+        is a large, by Joe Smith</body></html>&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 04:44:42 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '310'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"ERROR\",\r\n    \"statusInfo\": \"author-not-found:cannot-locate\",\r\n
+        \   \"usage\": \"By accessing AlchemyAPI or using information generated by
+        AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"\",\r\n    \"author\": \"\"\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 03:46:41 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/author_basic_url_json_search.yml ADDED Viewed

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/url/URLGetAuthor
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&url=http://googleblog.blogspot.com/2012/06/find-out-what-people-are-searching-for.html&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 04:44:43 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '392'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"ERROR\",\r\n    \"statusInfo\": \"author-not-found:cannot-locate\",\r\n
+        \   \"usage\": \"By accessing AlchemyAPI or using information generated by
+        AlchemyAPI, you are agreeing to be bound by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"http://googleblog.blogspot.com/2012/06/find-out-what-people-are-searching-for.html\",\r\n
+        \   \"author\": \"\"\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 03:46:42 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/category_basic_html_json_search.yml ADDED Viewed

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/html/HTMLGetCategory
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&html=<html><body>foo
+        bar</body></html>&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 04:10:32 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '63'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"ERROR\",\r\n    \"statusInfo\": \"invalid-url\"\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 03:12:32 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/category_basic_text_json_search.yml ADDED Viewed

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/text/TextGetCategory
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&text=lorem ipsum&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 04:10:33 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '317'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"OK\",\r\n    \"usage\": \"By accessing AlchemyAPI
+        or using information generated by AlchemyAPI, you are agreeing to be bound
+        by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"\",\r\n    \"language\": \"english\",\r\n    \"category\":
+        \"unknown\",\r\n    \"score\": \"0.400001\"\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 03:12:32 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/category_basic_url_json_search.yml ADDED Viewed

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/url/URLGetCategory
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&url=http://www.alchemyapi.com/&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 04:10:33 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '353'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"OK\",\r\n    \"usage\": \"By accessing AlchemyAPI
+        or using information generated by AlchemyAPI, you are agreeing to be bound
+        by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"http://www.alchemyapi.com/\",\r\n    \"language\": \"english\",\r\n
+        \   \"category\": \"computer_internet\",\r\n    \"score\": \"0.781348\"\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 03:12:32 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/concept_basic_html_json_search.yml ADDED Viewed

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/html/HTMLGetRankedConcepts
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&html=<html><body>Google
+        is a large company</body></html>&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 03:39:12 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '880'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"OK\",\r\n    \"usage\": \"By accessing AlchemyAPI
+        or using information generated by AlchemyAPI, you are agreeing to be bound
+        by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"\",\r\n    \"language\": \"english\",\r\n    \"concepts\":
+        [\r\n        {\r\n            \"text\": \"Criticism of Google\",\r\n            \"relevance\":
+        \"0.863093\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Criticism_of_Google\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f80000000055d4613\",\r\n
+        \           \"yago\": \"http://mpii.de/yago/resource/Criticism_of_Google\"\r\n
+        \       },\r\n        {\r\n            \"text\": \"Googol\",\r\n            \"relevance\":
+        \"0.713045\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Googol\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f8000000000019f35\"\r\n
+        \       }\r\n    ]\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 02:41:11 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/concept_basic_text_json_search.yml ADDED Viewed

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/text/TextGetRankedConcepts
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&text=Google is a large
+        company&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 03:39:12 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '880'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"OK\",\r\n    \"usage\": \"By accessing AlchemyAPI
+        or using information generated by AlchemyAPI, you are agreeing to be bound
+        by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"\",\r\n    \"language\": \"english\",\r\n    \"concepts\":
+        [\r\n        {\r\n            \"text\": \"Criticism of Google\",\r\n            \"relevance\":
+        \"0.863093\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Criticism_of_Google\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f80000000055d4613\",\r\n
+        \           \"yago\": \"http://mpii.de/yago/resource/Criticism_of_Google\"\r\n
+        \       },\r\n        {\r\n            \"text\": \"Googol\",\r\n            \"relevance\":
+        \"0.713045\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Googol\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f8000000000019f35\"\r\n
+        \       }\r\n    ]\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 02:41:11 GMT
+recorded_with: VCR 2.2.0

data/spec/vcr_cassettes/concept_basic_url_json_search.yml ADDED Viewed

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://access.alchemyapi.com/calls/url/URLGetRankedConcepts
+    body:
+      encoding: US-ASCII
+      string: apikey=cbc80670767f2e9ccecc9a6f4df6f45f207d9cda&url=http://www.alchemy.com&outputMode=json
+    headers:
+      content-type:
+      - application/x-www-form-urlencoded
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+      connection:
+      - close
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx
+      date:
+      - Sun, 17 Jun 2012 03:39:13 GMT
+      content-type:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '2623'
+      cache-control:
+      - no-cache
+      access-control-allow-origin:
+      - ! '*'
+      - ! '*'
+    body:
+      encoding: US-ASCII
+      string: ! "{\r\n    \"status\": \"OK\",\r\n    \"usage\": \"By accessing AlchemyAPI
+        or using information generated by AlchemyAPI, you are agreeing to be bound
+        by the AlchemyAPI Terms of Use: http://www.alchemyapi.com/company/terms.html\",\r\n
+        \   \"url\": \"http://www.alchemy.com/\",\r\n    \"language\": \"english\",\r\n
+        \   \"concepts\": [\r\n        {\r\n            \"text\": \"Open source\",\r\n
+        \           \"relevance\": \"0.930718\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Open_source\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f8000000005bcd984\"\r\n
+        \       },\r\n        {\r\n            \"text\": \"Free software\",\r\n            \"relevance\":
+        \"0.909806\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Free_software\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f8000000000016cef\",\r\n
+        \           \"yago\": \"http://mpii.de/yago/resource/Free_software\"\r\n        },\r\n
+        \       {\r\n            \"text\": \"Open content\",\r\n            \"relevance\":
+        \"0.885892\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Open_content\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f800000000002c60f\",\r\n
+        \           \"yago\": \"http://mpii.de/yago/resource/Open_content\"\r\n        },\r\n
+        \       {\r\n            \"text\": \"Computer program\",\r\n            \"relevance\":
+        \"0.840013\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Computer_program\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f800000000000dd3a\"\r\n
+        \       },\r\n        {\r\n            \"text\": \"Arithmetic mean\",\r\n
+        \           \"relevance\": \"0.6736\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Arithmetic_mean\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f8000000000003dd5\"\r\n
+        \       },\r\n        {\r\n            \"text\": \"Memory leak\",\r\n            \"relevance\":
+        \"0.648\",\r\n            \"dbpedia\": \"http://dbpedia.org/resource/Memory_leak\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f80000000000276cf\",\r\n
+        \           \"yago\": \"http://mpii.de/yago/resource/Memory_leak\"\r\n        },\r\n
+        \       {\r\n            \"text\": \"Sun Microsystems\",\r\n            \"relevance\":
+        \"0.645431\",\r\n            \"website\": \"http://www.oracle.com/sun\",\r\n
+        \           \"dbpedia\": \"http://dbpedia.org/resource/Sun_Microsystems\",\r\n
+        \           \"freebase\": \"http://rdf.freebase.com/ns/guid.9202a8c04000641f80000000000357a2\",\r\n
+        \           \"yago\": \"http://mpii.de/yago/resource/Sun_Microsystems\",\r\n
+        \           \"crunchbase\": \"http://www.crunchbase.com/company/sun-microsystems\",\r\n
+        \           \"semanticCrunchbase\": \"http://cb.semsol.org/company/sun-microsystems.rdf\"\r\n
+        \       }\r\n    ]\r\n}\r\n"
+    http_version: '1.1'
+  recorded_at: Sun, 17 Jun 2012 02:41:12 GMT
+recorded_with: VCR 2.2.0