lymbix 0.4.1 → 0.4.3

data/Changelog

@@ -1,3 +1,5 @@
+v0.4.3 - can now specify which api_version to use
+v0.4.2 - added reference_id to all methods using version 2.2 BETA
 v0.4.1 - added reference_id param to flag_response
 v0.4.0 - re-factored whole gem, implemented methods for 2.1 version 
 v0.3.7 - added endpoint attribute to Base for companies implementation

data/LICENSE

@@ -1 +1,3 @@
-# Lymbix
+Copyright (c) 2010, Lymbix Inc.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README

@@ -1,14 +1,24 @@
 = Lymbix
 
-Lymbix gives you the ability to determine the tone of any phrase or passage.
+Lymbix is an easy to use wrapper for the Lymbix Tone API service to tonalize a phrase or passage.
 
-  @lymbix.tonalize_phrase "This is a test passage"
+To install the Lymbix gem see command below:
+	
+  gem install lymbix
 
-To be able to access this resource - please go to http://www.toneapi.com and create an account. You need to agree to the licensing terms, and your account needs to be approved.
+It is possible to tonalize a phrase like:
 
+  lymbix = Lymbix::Base.new(authentication_key)
+  lymbix.api_version = 2.1 (available in gem version 0.4.3)
+  lymbix.tonalize("I like ruby.")
+
+
+To be able to access this resource - please go to <a href="http://www.toneapi.com">ToneAPI.com</a> and create an account. You need to agree to the licensing terms, and your account needs to be approved. Once approved, you will be able to get your authentication key.
+
+Note: The Lymbix gem requires the rest-client gem version >= 1.4.2
 
 == Authors and credits
 
-Authors::                Pat Roy, Josh Merchant
+Authors::                Pat Roy, Josh Merchant, Matthew Lagacé, Mathieu Dargavel, Maxime Santerre
 Copyright::				 Lymbix Inc
 License::				 Subject to licensing terms - see http://www.toneapi.com

data/lib/lymbix/base.rb

@@ -9,50 +9,69 @@ To begin using the base class, you must get your authentication key provided fro
 
   class Base
     # The user's authentication key
-    attr_accessor :auth_key
+    attr_accessor :auth_key, :api_version
     
     def initialize(auth_key)
         @auth_key = auth_key
+        @api_version = 2.1 
     end
-                
-    # Tonalizes text using version 2.1 of ToneAPI
-    def tonalize(article, return_fields = [], accept_type = "application/json")
-      @version = 2.1
-      accept_type == "application/xml" ? return_fields = return_fields_xml(return_fields) : return_fields = return_fields_json(return_fields)
-      response = request(:post, 'tonalize',{:article => article, :return_fields => return_fields}, {:accept => accept_type}).data
+    
+    def terms_lookup(article)
+      response = request(:post, 'terms_lookup',{:article => article}, {:accept => "application/json"}).data
+    end
+     
+    # Tonalizes text using version 2.1,2.2 of ToneAPI
+    def tonalize(article, return_fields = nil, accept_type = nil, article_reference_id = nil)
+      return_fields = [] if return_fields == nil
+      accept_type = "application/json" if accept_type == nil
+      article_reference_id = "" if article_reference_id == nil
+      response = request(:post, 'tonalize',{:article => article, :return_fields => return_fields.to_json, :reference_id => article_reference_id.to_s}, {:accept => accept_type}).data
     end
     
     # Tonalizes text using version 2.0 of ToneAPI
     def tonalize_article(article, accept_type = "application/json")
-      @version = 2.0
+      @api_version = 2.0
       response = request(:post, 'tonalize_article',{:article => article}, {:accept => accept_type}).data
     end
         
     # Tonalizes mutliple articles using version 2.1 of ToneAPI. With the return_fields param you can now specify which field to get back from the API.
-    def tonalize_multiple(articles, return_fields = [], accept_type = "application/json")
-      @version = 2.1
-      accept_type == "application/xml" ? return_fields = return_fields_xml(return_fields) : return_fields = return_fields_json(return_fields)
-      accept_type == "application/xml" ? articles = articles_xml(articles) : articles = articles_json(articles)
-      response = request(:post, 'tonalize_multiple',{:articles => articles, :return_fields => return_fields}, {:accept => accept_type}).data
+    def tonalize_multiple(articles, return_fields = nil, accept_type = nil, article_reference_ids = nil)
+      return_fields = [] if return_fields == nil
+      accept_type = "application/json" if accept_type == nil
+      article_reference_ids = [] if article_reference_ids == nil
+      article_reference_ids.each_with_index {|article,index| article_reference_ids[index] = article.to_s} if article_reference_ids.size > 0
+      response = request(:post, 'tonalize_multiple',{:articles => articles.to_json, :return_fields => return_fields.to_json, :article_reference_ids => article_reference_ids.to_json}, {:accept => accept_type}).data
     end
     
     # Tonalizes article using version 2.1 of ToneAPI. With the return_fields param you can now specify which field to get back from the API.
     # The detailed response includes the tonalization data for the article and all sentences found in the article
-    def tonalize_detailed(article, return_fields = [], accept_type = "application/json")
-      @version = 2.1
-      accept_type == "application/xml" ? return_fields = return_fields_xml(return_fields) : return_fields = return_fields_json(return_fields)
-      response = request(:post, 'tonalize_detailed',{:article => article, :return_fields => return_fields}, {:accept => accept_type}).data
+    def tonalize_detailed(article, return_fields = nil, accept_type = nil, article_reference_id = nil)
+      return_fields = [] if return_fields == nil
+      accept_type = "application/json" if accept_type == nil
+      article_reference_id = "" if article_reference_id == nil
+      response = request(:post, 'tonalize_detailed',{:article => article, :return_fields => return_fields.to_json, :article_reference_id => article_reference_id}, {:accept => accept_type}).data
     end
     
     # Flags a phrase to be re-evaluated
     def flag_response(reference_id, phrase, api_method_requested, api_version, callback_url = nil)
-      @version = 2.1
       response = request(:post, 'flag_response', {:reference_id => reference_id, :phrase => phrase, :api_method_requested => api_method_requested, :api_version => api_version, :callback_url => callback_url}).data
     end
     
     private
     def request(action, method, data, headers = {})
-      Lymbix::Request.new(action, method, {:app_id => @app_id, :auth_key => @auth_key, :version => @version, :accept_type => headers[:accept]}, data).run
+      Lymbix::Request.new(action, method, {:app_id => @app_id, :auth_key => @auth_key, :version => @api_version, :accept_type => headers[:accept]}, data).run
+    end
+    
+    def article_reference_ids_xml(article_reference_ids)
+      xml = "<?xml version='1.0' encoding='utf-8' ?>"
+      xml << "<article_reference_ids>"
+      article_reference_ids.each {|field| xml << "<article_reference_id>" + field + "</article_reference_id>"}
+      xml << "</article_reference_ids>"
+      xml
+    end
+    
+    def article_reference_ids_json(article_reference_ids)
+      article_reference_ids.to_json
     end
     
     def return_fields_xml(return_fields)

data/lib/lymbix/request.rb

@@ -15,7 +15,8 @@ module Lymbix
     
     def connection
       options = {}
-      options[:headers] = {:accept => self.header_hash[:accept_type], :AUTHENTICATION => self.header_hash[:auth_key], :VERSION => self.header_hash[:version]}            
+      options[:timeout] = 0
+      options[:headers] = {:USER_AGENT => "Lymbix Gem - 0.4.2", :accept => self.header_hash[:accept_type], :AUTHENTICATION => self.header_hash[:auth_key], :VERSION => self.header_hash[:version]}            
       RestClient::Resource.new(self.url, options)
     end
     

metadata

@@ -1,24 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: lymbix
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 4
-  - 1
-  version: 0.4.1
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Patrick Roy
 - Josh Merchant
 - Mathieu Dargavel
 - "Matthew Lagac\xC3\xA9"
+- Maxime Santerre
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 -04:00
+date: 2010-02-16 00:00:00 -04:00
 default_executable: 
 dependencies: []