microsoft_translator 0.1.1 → 0.2.0

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.3-p125@microsoft_translator --create
+rvm use 1.9.3@microsoft_translator --create

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+
+script: "bundle exec rspec spec/lib/**/*_spec.rb"

data/README.md

@@ -1,9 +1,30 @@
-# MicrosoftTranslator
+# MicrosoftTranslator [![Build Status](https://secure.travis-ci.org/ikayzo/microsoft_translator.png?branch=master)](http://travis-ci.org/ikayzo/microsoft_translator)
 
-TODO: Write a gem description
+Ruby wrapper for Microsoft Translate HTTP API.
+
+Still a work-in-progress. Currently only supports translating one string
+of text at a time.
 
 ## Installation
 
+Before translating things from your ruby application you first need to
+sign up for the Microsoft Translator API in the Windows Azure
+Datamarket.  
+
+https://datamarket.azure.com/dataset/1899a118-d202-492c-aa16-ba21c33c06cb
+
+Don't worry, they have a free tier! (up to 2 million translated characters/month) Once you sign up for the Translator
+API you will also need to register your application with the Azure
+Datamarket.  
+
+https://datamarket.azure.com/developer/applications/
+
+Also, you shouldn't stress about what to put for the _*Redirect URI*_. For the purposes of
+this gem you won't be using it so your project's homepage will work just
+fine.  You'll use the _*Client ID*_ and _*Client secret*_ to authenticate
+your requests to the API.  Once this is done you'll install it like you
+would any other gem...
+
 Add this line to your application's Gemfile:
 
     gem 'microsoft_translator'
@@ -18,10 +39,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a MicrosoftTranslator::Client with your Client ID & secret.
+
+```ruby
+translator = MicrosoftTranslator::Client.new('your_client_id', 'your_client_secret')
+```
+
+### Translation
+
+To translate pass in the foreign text along with the language codes for
+the language you are going from/to and the content type. The content
+type is either "text/plain" or "text/html"
+
+```ruby
+spanish = "hasta luego muchacha"
+translator.translate(spanish,"es","en","text/html")
+   # =>  "until then girl"
+```
+
+### Language Detection
+
+To detect the language simply pass in the foreign text. The language
+code will be returned.
+
+```ruby
+translator.detect("Quiero un burrito")
+   # =>  "es"
+```
+That's about it!  This is a list of the supported languages by the Microsoft 
+Translate API http://www.microsofttranslator.com/help/?FORM=R5FD and
+here are all the language codes as a helpful reference.
+http://www.loc.gov/standards/iso639-2/php/code_list.php
 
 ## Contributing
 
+There are still quiet a few other methods available in the API that need
+to be covered.  http://msdn.microsoft.com/en-us/library/ff512419.aspx
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/lib/microsoft_translator/client.rb

@@ -10,11 +10,27 @@ module MicrosoftTranslator
     end
 
     def translate(text, from_lang, to_lang, content_type)
-      response = RestClient.get(
-        "http://api.microsofttranslator.com/V2/Http.svc/Translate",
-        translate_params(text, from_lang, to_lang, content_type)
-      )
-      parse_xml(response.body)
+      begin
+        response = RestClient.get(
+          "http://api.microsofttranslator.com/V2/Http.svc/Translate",
+          translate_params(text, from_lang, to_lang, content_type)
+        )
+        parse_xml(response.body)
+      rescue RestClient::BadRequest
+        false
+      end
+    end
+
+    def detect(text)
+      begin
+        response = RestClient.get(
+          "http://api.microsofttranslator.com/V2/Http.svc/Detect",
+          detect_params(text)
+        )
+        parse_xml(response.body)
+      rescue RestClient::BadRequest
+        false
+      end
     end
 
     private
@@ -31,7 +47,14 @@ module MicrosoftTranslator
         "to" => to_lang,
         "contentType" => content_type
       })
-      puts hash
+      hash
+    end
+
+    def detect_params(text)
+      hash = base_params
+      hash.store(:params,{
+        "text" => text
+      })
       hash
     end
 

data/lib/microsoft_translator/version.rb

@@ -1,3 +1,3 @@
 module MicrosoftTranslator
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microsoft_translator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -85,6 +85,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Use Microsoft Translate API in your ruby program