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

alchemy-api-rb 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/lib/alchemy-api/sentiment_analysis.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module AlchemyAPI
+  class SentimentAnalysis < Base
+    Config.add_mode :sentiment_analysis, self
+    def web_method
+      "#{method_prefix}GetTextSentiment"
+    end
+    private
+    def indexer
+      "docSentiment"
+    end
+  end
+end

data/lib/alchemy-api/text_categorization.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module AlchemyAPI
+  class TextCategorization < Base
+    Config.add_mode :text_categorization, self
+    def web_method
+      "#{method_prefix}GetCategory"
+    end
+    private
+    def supported_search_types
+      # TODO: fix html
+      [:text, :url]
+    end
+    def indexer
+      nil
+    end
+  end
+end

data/lib/alchemy-api/text_extraction.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module AlchemyAPI
+  class TextExtraction < Base
+    Config.add_mode :text_extraction, self
+    def web_method
+      "#{method_prefix}GetText"
+    end
+    private
+    def supported_search_types
+      [:url, :html]
+    end
+    def indexer
+      "text"
+    end
+  end
+end

data/lib/alchemy-api/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module AlchemyAPI
+  VERSION = "0.1.0"
+end

data/spec/alchemy_api_spec.rb ADDED Viewed

@@ -0,0 +1,70 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI do
+  subject() { AlchemyAPI }
+  it "knows the alchemy api url" do
+    AlchemyAPI::BASE_URL.must_be :==, "http://access.alchemyapi.com/calls/"
+  end
+  it "allows you to set the key directly" do
+    key = "xxxxxxxx"
+    AlchemyAPI.key = key
+    AlchemyAPI.key.must_be :==, key
+  end
+  describe AlchemyAPI::Config do
+    describe ".add_mode" do
+      it "allows classes to register themselves" do
+        class Foo
+          AlchemyAPI::Config.add_mode :foo, self
+        end
+        AlchemyAPI::Config.modes[:foo].must_be :==, Foo
+      end
+    end
+    describe ".output_mode" do
+      after do
+        AlchemyAPI.configure do |config|
+          config.output_mode = :json
+        end
+      end
+      it "allows output mode to be set" do
+        AlchemyAPI.configure do |config|
+          config.output_mode = :xml
+        end
+        AlchemyAPI.config.output_mode.must_be :==, :xml
+      end
+      it "errors on invalid output mode" do
+        -> {
+          AlchemyAPI.configure do |config|
+            config.output_mode = :xls
+          end
+        }.must_raise AlchemyAPI::InvalidOutputMode
+      end
+    end
+  end
+  describe ".search" do
+    it "needs an api key" do
+      AlchemyAPI::Config.apikey = nil
+      -> {
+        AlchemyAPI.search(:keyword_extraction, :text => "foo")
+      }.must_raise AlchemyAPI::InvalidAPIKey
+    end
+    it "needs a valid mode" do
+      AlchemyAPI::Config.apikey = "xxxxxxxxxxx"
+      -> {
+        AlchemyAPI.search(:foo, :text => "hello")
+      }.must_raise AlchemyAPI::InvalidSearchMode
+    end
+  end
+end

data/spec/author_extraction_spec.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "author_extraction" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::AuthorExtraction.new }
+  describe "#search" do
+    {
+      :html => "<html><body>Google is a large, by Joe Smith</body></html>",
+      :url => "http://blog.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("author_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("author_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result["author"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/base_spec.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI::Base do
+  subject() { AlchemyAPI::Base.new }
+  describe "#connection" do
+    it "creates a connection" do
+      subject.send(:connection).wont_be_nil
+    end
+  end
+  describe "#merge_options" do
+    it "combines default options with user provided" do
+      opts = { extra: "extra" }
+      expected = { outputMode: :json }.merge(opts)
+      subject.merged_options(opts).must_be :==, expected
+    end
+  end
+end

data/spec/concept_tagging_spec.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "concept_extraction" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::ConceptTagging.new }
+  describe "#search" do
+    {
+      :text => "Google is a large company",
+      :html => "<html><body>Google is a large company</body></html>",
+      :url => "http://www.alchemy.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("concept_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result.must_be_instance_of Array
+            end
+          end
+          it "includes the keyword text and relavence" do
+            VCR.use_cassette("concept_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)[0]
+              result["text"].wont_be_nil
+              result["relevance"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/entity_extraction_spec.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "entity_extraction" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::EntityExtraction.new }
+  describe "#search" do
+    {
+      :text => "Google is a large company",
+      :html => "<html><body>Google is a large company</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("entity_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result.must_be_instance_of Array
+            end
+          end
+          it "includes the keyword text and relavence" do
+            VCR.use_cassette("entity_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)[0]
+              result["text"].wont_be_nil
+              result["type"].wont_be_nil
+              result["count"].wont_be_nil
+              result["relevance"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/keyword_extraction_spec.rb ADDED Viewed

@@ -0,0 +1,50 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "keyword_extraction" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::KeywordExtraction.new }
+  # WTF?!?
+  # let(:searches) do
+  #   {
+  #     :text => "lorem ipsum",
+  #     :html => "<html><body>foo bar</body></html>"
+  #   }
+  # end
+  describe "#search" do
+    {
+      :text => "lorem ipsum",
+      :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("keyword_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result.must_be_instance_of Array
+            end
+          end
+          it "includes the keyword text and relavence" do
+            VCR.use_cassette("keyword_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)[0]
+              result["text"].wont_be_nil
+              result["relevance"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/language_detection_spec.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "language_detection" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::LanguageDetection.new }
+  describe "#search" do
+    {
+      :text => "Lorem ipsum dolor sit amet.",
+      :html => "<html><body>Lorem ipsum dolor sit amet.</body></html>",
+      :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("language_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("language_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result["language"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/relation_extraction_spec.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "relation_extraction" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::RelationExtraction.new }
+  describe "#search" do
+    {
+      :text => "Google is a large company",
+      :html => "<html><body>Google is a large company</body></html>",
+      :url => "http://www.alchemy.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("relation_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result.must_be_instance_of Array
+            end
+          end
+          it "includes the keyword text and relavence" do
+            VCR.use_cassette("relation_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)[0]
+              result["subject"].wont_be_nil
+              result["action"].wont_be_nil
+              result["object"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/sentiment_analysis_spec.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+describe AlchemyAPI, "sentiment_analysis" do
+  before do
+    AlchemyAPI::Config.apikey = API_KEY
+  end
+  subject() { AlchemyAPI::SentimentAnalysis.new }
+  describe "#search" do
+    {
+      :text => "Alchemy is cool",
+      :html => "<html><body>Alchemy is cool</body></html>",
+      :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("sentiment_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("sentiment_basic_#{type}_#{output_mode}_search") do
+              result = subject.search(type => value)
+              result["type"].wont_be_nil
+              result["score"].wont_be_nil
+            end
+          end
+        end
+      end
+    end
+  end
+end