vizi_translator 0.2.0 → 0.3.0

data/README.rdoc

@@ -1,54 +1,56 @@
-= ViziTranslator
-
-== Introduction
-
-This gem module provides a classes to support the language translation of text files or text strings.
-The Frengly on-line service requires registration and prvoides access with a username and password.
-The gem module uses the NET::HTTP library to access the Frengly service.
-Find out more about the translation service at www.frengly.com.
-  
-== Installation
-
-Just run:
-
-    gem install vizi_translator
-
-This sample application will read a text file for translation.
-
-The sample text file is a index markdown file written in English.
-The English markdown file provides content for Vizitrax's home page.
-The translated file can be used to replace the English content with content for another language.
-
-== Usage
-
-	require 'vizi_translator'
-  
-# Set username and password. Username must be registered at Frengly
-	username = "akivi"
-	password = "welcome123"
-	
-# Set target language for translation
-	targetlanguage = "fr"
-
-	begin
-# 	Open test file for translation
-		@test = File.read(Dir.pwd+'./data/index.md')
-
-# 	Initiate Translator class        
-		translator = Vizi::Translator.new
-#		Get array with available language codes
-		@langcodes = translator.getcodes
-#		Get hashed list of languages and language codes
-		@langlist = translator.getlist
-    
-#		Call method to do the translation
-		@testnew = translator.gettext(username, password, @test, targetlanguage)
-		
-	end
-	
-
-== License
-
-This code is made available under the MIT license.
-
-All users of this code should read and follow the acceptable use policies for the Frengly translation service.
+= ViziTranslator
+
+== Introduction
+
+This gem module provides a classes to support the language translation of text files or text strings.
+The Frengly on-line service requires registration and prvoides access with a username and password.
+The gem module uses the NET::HTTP library to access the Frengly service.
+Find out more about the translation service at www.frengly.com.
+  
+== Installation
+
+Just run:
+
+    gem install vizi_translator
+
+The following gems are required 'net/http', 'uri' and 'xmlsimple'. You can install xmlsimple with 'get install xml-simple'
+
+This sample application will read a text file for translation.
+
+The sample text file is a index markdown file written in English.
+The English markdown file provides content for Vizitrax's home page.
+The translated file can be used to replace the English content with content for another language.
+
+== Usage
+
+	require 'vizi_translator'
+  
+# Set username and password. Username must be registered at Frengly
+	username = "your_username"
+	password = "your_password"
+	
+# Set target language for translation
+	targetlanguage = "fr"
+
+	begin
+# 	Open test file for translation
+		@test = File.read(Dir.pwd+'./data/index.md')
+
+# 	Initiate Translator class        
+		translator = Vizi::Translator.new
+#		Get array with available language codes
+		@langcodes = translator.getcodes
+#		Get hashed list of languages and language codes
+		@langlist = translator.getlist
+    
+#		Call method to do the translation
+		@testnew = translator.gettext(username, password, @test, targetlanguage)
+		
+	end
+	
+
+== License
+
+This code is made available under the MIT license.
+
+All users of this code should read and follow the acceptable use policies for the Frengly translation service.

data/README.rdoc.old

@@ -0,0 +1,56 @@
+= ViziTranslator
+
+== Introduction
+
+This gem module provides a classes to support the language translation of text files or text strings.
+The Frengly on-line service requires registration and prvoides access with a username and password.
+The gem module uses the NET::HTTP library to access the Frengly service.
+Find out more about the translation service at www.frengly.com.
+  
+== Installation
+
+Just run:
+
+    gem install vizi_translator
+
+The following gems are required 'net/http', 'uri' and 'xmlsimple'. You can install xmlsimple with 'get install xml-simple'
+
+This sample application will read a text file for translation.
+
+The sample text file is a index markdown file written in English.
+The English markdown file provides content for Vizitrax's home page.
+The translated file can be used to replace the English content with content for another language.
+
+== Usage
+
+	require 'vizi_translator'
+  
+# Set username and password. Username must be registered at Frengly
+	username = "your_username"
+	password = "your_password"
+	
+# Set target language for translation
+	targetlanguage = "fr"
+
+	begin
+# 	Open test file for translation
+		@test = File.read(Dir.pwd+'./data/index.md')
+
+# 	Initiate Translator class        
+		translator = Vizi::Translator.new
+#		Get array with available language codes
+		@langcodes = translator.getcodes
+#		Get hashed list of languages and language codes
+		@langlist = translator.getlist
+    
+#		Call method to do the translation
+		@testnew = translator.gettext(username, password, @test, targetlanguage)
+		
+	end
+	
+
+== License
+
+This code is made available under the MIT license.
+
+All users of this code should read and follow the acceptable use policies for the Frengly translation service.

data/doc/classes/Vizi/Translator.html

@@ -0,0 +1,200 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Vizi::Translator</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Vizi::Translator</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/vizi/vizi_translator_rb.html">
+                lib/vizi/vizi_translator.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+This class includes a set of methods to translate using the Frengly service
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000002">getcodes</a>&nbsp;&nbsp;
+      <a href="#M000003">getlist</a>&nbsp;&nbsp;
+      <a href="#M000004">gettext</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SUPPORTED_LANG_CODES</td>
+          <td>=</td>
+          <td class="context-item-value">['fr','de','es','pt','it','nl','tl','fi','el','iw','pl','ru','sv']</td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">SUPPORTED_LANG_LIST</td>
+          <td>=</td>
+          <td class="context-item-value">{&quot;English&quot; =&gt; &quot;en&quot;, &quot;French&quot; =&gt; &quot;fr&quot;, &quot;German&quot; =&gt; &quot;de&quot;, &quot;Spanish&quot; =&gt; &quot;es&quot;, 
                         &quot;Portuguese&quot; =&gt; &quot;pt&quot;, &quot;Italian&quot; =&gt; &quot;it&quot;, &quot;Filipino&quot; =&gt; &quot;tl&quot;,&quot;Finnish&quot; =&gt; &quot;fi&quot;,&quot;Greek&quot; =&gt; &quot;el&quot;,
                         &quot;Hebrew&quot; =&gt; &quot;iw&quot;, &quot;Polish&quot; =&gt; &quot;pl&quot;, &quot;Russian&quot; =&gt; &quot;ru&quot;, &quot;Swedish&quot; =&gt; &quot;sv&quot;}</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="Translator.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('Translator.src/M000002.html');return false;">
+          <span class="method-name">getcodes</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+method to get array of language codes
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="Translator.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('Translator.src/M000003.html');return false;">
+          <span class="method-name">getlist</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+method to get hash list of languages
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="Translator.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Translator.src/M000004.html');return false;">
+          <span class="method-name">gettext</span><span class="method-args">(username, password, input_text, output_code)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+method to translate from one language to another
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Vizi/Translator.src/M000002.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>getcodes (Vizi::Translator)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/vizi/vizi_translator.rb, line 28</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getcodes</span>
+                        <span class="ruby-identifier">result</span> = <span class="ruby-constant">SUPPORTED_LANG_CODES</span>
+                <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Vizi/Translator.src/M000003.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>getlist (Vizi::Translator)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/vizi/vizi_translator.rb, line 33</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">getlist</span>
+                        <span class="ruby-identifier">result</span> = <span class="ruby-constant">SUPPORTED_LANG_LIST</span>
+                <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Vizi/Translator.src/M000004.html

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>gettext (Vizi::Translator)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/vizi/vizi_translator.rb, line 38</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">gettext</span>(<span class="ruby-identifier">username</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">input_text</span>, <span class="ruby-identifier">output_code</span>)
+                        <span class="ruby-identifier">default_src</span> = <span class="ruby-value str">'en'</span>
+                        <span class="ruby-identifier">default_action</span> = <span class="ruby-value str">'translateREST'</span>
+                
+                        <span class="ruby-identifier">input_text</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">input_text</span>)
+                        <span class="ruby-keyword kw">begin</span>
+                                <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnSupportedLanguage</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">SUPPORTED_LANG_CODES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">output_code</span>)                 
+                                <span class="ruby-identifier">site_url</span> = <span class="ruby-value str">'www.syslang.com'</span>
+                                <span class="ruby-identifier">uri_method</span> = <span class="ruby-value str">'/frengly/controller?'</span>
+                                <span class="ruby-identifier">uri_string</span> = <span class="ruby-value str">'action='</span><span class="ruby-operator">+</span><span class="ruby-identifier">default_action</span><span class="ruby-operator">+</span><span class="ruby-value str">'&amp;src='</span><span class="ruby-operator">+</span><span class="ruby-identifier">default_src</span><span class="ruby-operator">+</span><span class="ruby-value str">'&amp;dest='</span><span class="ruby-operator">+</span><span class="ruby-identifier">output_code</span><span class="ruby-operator">+</span><span class="ruby-value str">'&amp;text='</span><span class="ruby-operator">+</span><span class="ruby-identifier">input_text</span><span class="ruby-operator">+</span><span class="ruby-value str">'&amp;username='</span><span class="ruby-operator">+</span><span class="ruby-identifier">username</span><span class="ruby-operator">+</span><span class="ruby-value str">'&amp;password='</span><span class="ruby-operator">+</span><span class="ruby-identifier">password</span>
+                                <span class="ruby-identifier">response</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get_response</span>(<span class="ruby-identifier">site_url</span>, <span class="ruby-identifier">uri_method</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">uri_string</span>)
+                                <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;200&quot;</span>
+                                        <span class="ruby-identifier">xml_data</span> = <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
+                                        <span class="ruby-identifier">data</span> = <span class="ruby-constant">XmlSimple</span>.<span class="ruby-identifier">xml_in</span>(<span class="ruby-identifier">xml_data</span>)
+                                        <span class="ruby-identifier">result</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value str">&quot;translation&quot;</span>][<span class="ruby-value">0</span>]                                            
+                                <span class="ruby-keyword kw">else</span>
+                                        <span class="ruby-identifier">puts</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
+                                        <span class="ruby-identifier">raise</span> <span class="ruby-constant">StandardError</span>, <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
+                                <span class="ruby-keyword kw">end</span>
+                        <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">UnSupportedLanguage</span>
+                                <span class="ruby-identifier">raise</span> <span class="ruby-constant">UnSupportedLanguage</span>.<span class="ruby-identifier">new</span>
+                        <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">err_msg</span>
+                                <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;#{err_msg}&quot;</span>
+                        <span class="ruby-keyword kw">end</span>
+                <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/classes/Vizi/UnSupportedLanguage.html

@@ -0,0 +1,150 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Vizi::UnSupportedLanguage</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Vizi::UnSupportedLanguage</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/vizi/vizi_translator_rb.html">
+                lib/vizi/vizi_translator.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                RuntimeError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">new</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">msg</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="UnSupportedLanguage.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('UnSupportedLanguage.src/M000001.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(message='')</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/Vizi/UnSupportedLanguage.src/M000001.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>new (Vizi::UnSupportedLanguage)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/vizi/vizi_translator.rb, line 15</span>
+                <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">message</span>=<span class="ruby-value str">''</span>)
+                        <span class="ruby-ivar">@msg</span> = <span class="ruby-value str">&quot;Language pair not supported yet.&quot;</span>
+                <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>