Merge pull request #1 from pedrokost/meta

Metaprogrammed version

Author: marloncarvalho

README.md

@@ -1,15 +1,28 @@
 Ruby Datumbox Wrapper
 =====================
 
-It's a simple Ruby Datumbox Wrapper. It has only one class, called Datumbox (datumbox.rb), which makes all the work for you. We use the RestClient library to make remote calls to the Datumbox API. This class has one method to each available service provided by the Datumbox.
+It's a simple Ruby Datumbox Wrapper. It has only one class, called Datumbox (`datumbox.rb`), which makes all the work for you. We use the RestClient library to make remote calls to the Datumbox API. This class has one method to each available service provided by the Datumbox.
 
 
-First off, remember to get your API Key accessing and registering yourself at Datumbox website. Second, create a new instance of the Datumbox class passing your API Key as parameter to its constructor. Like this:
+First off, remember to get your API Key accessing and registering yourself at the [Datumbox website](http://www.datumbox.com/). Second, create a new instance of the Datumbox class passing your API Key as parameter to its constructor. Like this:
 
+`datumbox = Datumbox.new('YOUR API KEY GOES HERE')`
 
-Datumbox.new('YOUR API KEY GOES HERE').
-         document_similarity("This document is unique.", "No, bastard! This document here is unique!.")
-         
-         
-http://www.datumbox.com/
+## Usage:
 
+datumbox = Datumbox.new('YOUR API KEY GOES HERE')
+
+datumbox.language_detection(text: 'El paraguas es de mi color favorito')
+
+datumbox.response = subject.keyword_extraction(text: 'Banana split', n: 1)
+
+datumbox.document_similarity(original: 'This document is unique.',
+         					 copy: 'No, bastard! This document here is unique!.')
+
+## Methods
+
+You can call any method from the Datumbox API by writing it in underscore. For example the method `TopicClassification` should be called as `topic_classification`.
+
+For a list of all the available methods, read the [Datumbox API documentation](http://www.datumbox.com/api-sandbox/)
+
+When new methods are added to the API, this wrapper will automatically work with them.

datumbox.rb

@@ -1,14 +1,51 @@
 require 'rest_client'
+require 'json'
 
 # Datumbox Wrapper.
 # Before use it, you must register yourself at Datumbox site
 # and get your API Key.
 #
 # Create an instance of this class calling "Datumbox.create(api_key)".
 #
-# Author: Marlon Silva Carvalho
+# Author: Pedro Damian Kostelec
+# 
+# Some of the available methods are:
+# (See the API documentation [http://www.datumbox.com/api-sandbox/] for an exhaustive list of methods)
+#
+# sentiment_analysis(text)
+#   Classifies "text" as positive, negative or neutral.
+#
+# subjective_analysis(text)
+#   Categorizes "text" as subjective or objective based on writing style.
+#   Texts that express personal opinions are labeled as subjective and the others as objective.
+#
+# spam_detection(text)
+#   Labels documents as spam or nospam by taking into account their context.
+#
+# adult_content_detection(text)
+#   Classifies documents as adult or noadult based on their context.
+#
+# topic_classification(text)
+#   Assigns documents in 12 thematic categories based on ther keywords, idioms and jargon.
+#
+# language_detection(text)
+#   Identifies the natural language of the given text based on its words and context.
+#
+# twitter_sentiment_analysis(text)
+#   Classifies "text" as positive, negative or neutral.
+#
+# keyword_extraction(text, n)
+#   Enables you to extract from an arbitrary document all the keywords and word
+#   combinations along with their occurrences in the text.
+#
+# document_similarity(original, copy)
+#   Estimates the degree of similarity between two documents.
+
 class Datumbox
 
+  BASE_URI = 'http://api.datumbox.com/'
+  API_VERSION = '1.0'
+ 
   def initialize(api_key)
     @api_key = api_key
   end
@@ -20,64 +57,35 @@ def self.create(api_key)
     Datumbox.new(api_key)
   end
 
-  # Classifies "text" as positive, negative or neutral.
-  #
-  def sentiment_analysis(text)
-    RestClient.post "http://api.datumbox.com/1.0/SentimentAnalysis.json", :api_key => @api_key, :text => text
-  end
-
-  # Categorizes "text" as subjective or objective based on writing style.
-  # Texts that express personal opinions are labeled as subjective and the others as objective.
-  #
-  def subjective_analysis(text)
-    RestClient.post "http://api.datumbox.com/1.0/SubjectivityAnalysis.json", :api_key => @api_key, :text => text
+  def request(method, opts)
+    options = { api_key: @api_key }.merge opts
+    RestClient.post "#{BASE_URI}#{API_VERSION}/#{method}.json", options
   end
 
-  # Labels documents as spam or nospam by taking into account their context.
-  #
-  def spam_detection(text)
-    RestClient.post "http://api.datumbox.com/1.0/SpamDetection.json", :api_key => @api_key, :text => text
-  end
+  def method_missing(method_id, opts, &block)
+    begin
+      response = request(method_id.id2name.camelize, opts)
+      
+      # If the response is successful, and that API method exists
+      # and defines the method, for any future calls to be faster
+      json = JSON.parse(response)
+      self.class.send(:define_method, method_id) do |args|
+        request(method_id.id2name.camelize, args)
+      end if json['output']['status'] == 1
 
-  # Classifies documents as adult or noadult based on their context.
-  #
-  def adult_content_detection(text)
-    RestClient.post "http://api.datumbox.com/1.0/AdultContentDetection.json", :api_key => @api_key, :text => text
+      return response
+    rescue
+      super
+    end
   end
 
-  # Assigns documents in 12 thematic categories based on ther keywords, idioms and jargon.
-  #
-  def topic_classification(text)
-    RestClient.post "http://api.datumbox.com/1.0/TopicClassification.json", :api_key => @api_key, :text => text
-  end
-
-  # Identifies the natural language of the given text based on its words and context.
-  #
-  def language_detection(text)
-    RestClient.post "http://api.datumbox.com/1.0/LanguageDetection.json", :api_key => @api_key, :text => text
-  end
-
-  # Classifies "text" as positive, negative or neutral.
-  #
-  def twitter_sentiment_analysis(text)
-    RestClient.post "http://api.datumbox.com/1.0/TwitterSentimentAnalysis.json", :api_key => @api_key, :text => text
-  end
+end
 
-  # Enables you to extract from an arbitrary document all the keywords and word
-  # combinations along with their occurrences in the text.
-  #
-  def keyword_extraction(text, n)
-    RestClient.post "http://api.datumbox.com/1.0/KeywordExtraction.json", :api_key => @api_key, :text => text, :n => n
+class String
+  def camelize
+    self.split("_").each {|s| s.capitalize! }.join("")
   end
-
-  # Estimates the degree of similarity between two documents.
-  #
-  def document_similarity(original, copy)
-    RestClient.post "http://api.datumbox.com/1.0/DocumentSimilarity.json", :api_key => @api_key, :original => original, :copy => copy
+  def camelize!
+    self.replace(self.split("_").each {|s| s.capitalize! }.join(""))
   end
-
-
-end
-
-puts Datumbox.new('').
-         document_similarity("This document is unique.", "No, bastard! This document here is unique!.")
+end unless String.new.respond_to?(:camelize)

spec/datumbox_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'json'
+
+describe Datumbox do
+	
+	# If the tests fail, make you you set the API_KEY in spec_helper.rb
+	subject { Datumbox.new(API_KEY) }
+
+	describe 'sentiment_analysis' do
+		it "should reply with JSON" do
+			response = subject.sentiment_analysis text: 'Banana split'
+			expect { JSON.parse(response) }.not_to raise_error
+		end
+	end
+
+	describe 'document similarity' do
+		it "should not replay with error due to missing parameters" do
+			response = subject.document_similarity original: "This document is unique.",
+			                                       copy: "No, bastard! This document here is unique!."
+			json = JSON.parse response
+			json['output']['status'].should be 1
+		end
+	end
+
+	describe 'keyword extraction' do
+		it "should not replay with error due to missing parameters" do
+			response = subject.keyword_extraction text: 'Banana split',
+			                                      n: 1
+			json = JSON.parse response
+			json['output']['status'].should be 1
+		end
+	end
+end

spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require_relative '../datumbox'
+
+API_KEY = ''