lymbix 0.4.0 → 0.4.1

data/Changelog

@@ -1,3 +1,4 @@
+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
 v0.3.6 - added end and start time to data points coming from toneaday

data/README

@@ -6,28 +6,6 @@ Lymbix gives you the ability to determine the tone of any phrase or passage.
 
 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.
 
-Some resources to help you along the way:
-
-#Add resources
-
-== Example usage
-
-Authentication:
-
-  @lymbix = Lymbix::Base.authenticate('user@example.com','secretpassword', application_id)
-
-Get the tone of words/phrases:
-
-  @lymbix.tonalize_phrase "This is a test passage"
-
-Connotative Categories:
-
-  @lymbix.all_connotative_categories
-
-Database Size:
- 
-  @lymbix.word_count
-
 
 == Authors and credits
 

data/lib/lymbix/base.rb

@@ -1,19 +1,15 @@
 module Lymbix
 
 =begin rdoc
-The Base class is the most used class in the Lymbix gem.
+The Base class is the main class used in the Lymbix gem.
 It incorporates all the methods used to tonalize.
 
-To begin using the base class, you must authenticate using one of the authenticate methods and store the results in a variable. 
-On a successful authentication, you can start calling tonalize methods immediatly.
+To begin using the base class, you must get your authentication key provided from ToneAPI.com and store the key in the @auth_key variable. 
 =end
 
   class Base
     # The user's authentication key
-    attr_accessor :auth_key      
-    # Error messages that were caught during the authentication
-    attr_accessor :error_messages        
-    # API Version
+    attr_accessor :auth_key
     
     def initialize(auth_key)
         @auth_key = auth_key
@@ -49,10 +45,10 @@ On a successful authentication, you can start calling tonalize methods immediatl
     end
     
     # Flags a phrase to be re-evaluated
-    def flag_response(phrase, api_method_requested, api_version, callback_url = nil)
+    def flag_response(reference_id, phrase, api_method_requested, api_version, callback_url = nil)
       @version = 2.1
-      response = request(:post, 'flag_response', {:phrase => phrase, :api_method_requested => api_method_requested, :api_version => api_version, :callback_url => callback_url}).data
-    end 
+      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 = {})
@@ -60,7 +56,8 @@ On a successful authentication, you can start calling tonalize methods immediatl
     end
     
     def return_fields_xml(return_fields)
-      xml = "<return_fields>"
+      xml = "<?xml version='1.0' encoding='utf-8' ?>"
+      xml << "<return_fields>"
       return_fields.each {|field| xml << "<field>" + field + "</field>"}
       xml << "</return_fields>"
       xml
@@ -71,6 +68,7 @@ On a successful authentication, you can start calling tonalize methods immediatl
     end
     
     def articles_xml(articles)
+      xml = "<?xml version='1.0' encoding='utf-8' ?>"
       xml = "<articles>"
       articles.each {|article| xml << "<article>" + article + "</article>"}
       xml << "</articles>"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lymbix
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Patrick Roy