unbabel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4005346914d2c63457a1b5c7169bd58cee40aee5
-  data.tar.gz: 3ed086012c74df6dcafe171638fc7f430fffc7d4
+  metadata.gz: 5dea7104dcb7b3d1c4d60bcf33aa261865be3b11
+  data.tar.gz: 5594de79f3d9a992e80a8f6effcfa80c23ee0519
 SHA512:
-  metadata.gz: 6d7a90a752d671182df26361902d00975f3aaa6439d9ff27d060abd237f5199c8c79fb8b3534bfe52638f3340c4bd056ec4f8b09d25440c082129c859d746a21
-  data.tar.gz: ad5da31135058fbf4d5cb64534e4fda5c2e1b5125501a6c99637a0d95102db192ceb01a9ca8226b2de73ab26b8dd01d823f6dfa3e3b49bbdcb27969bc6d35a6b
+  metadata.gz: f7403fee8ebc478568083b349af2ec80c00caf9ddd89682751eebad0c3cd29a0f92c871e2b6b84bdea0ab3809d35016269fcc5b9334bc8c54905f79b86cdf04c
+  data.tar.gz: cdbcf97279a18fcdcabd87b8f1a5c60a25d0f5ec0cc5612caf0cefff5a424f7cbe881bf949d0bf7cc5f5ed4dcc146454da7082db156684a780d97e8cfd8f9a2f

data/.gitignore

@@ -1,3 +1,4 @@
 unbabel_api/
 *.DS_Store
 creds
+*.swp

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# CHANGELOG
+
+#### version 0.0.2
+
+  - better documentation
+  - changes #request to #request_translation for readability
+  - fixes bug on #translations, now you can correctly search by status
+
+#### version 0.0.1
+
+Initial release

data/README.md

@@ -27,19 +27,50 @@ export UNBABEL_SANDBOX="true"
 ## Available methods
 
 ```ruby
-client.language_pairs           # lists available language pairs
-client.topics                   # lists available topics
-client.tones                    # lists available tones
-client.translations             # lists translations
-client.translations.find(uid)   # finds a translation by unique id
-client.translations.request     # requests a new translation
+client.language_pairs              # lists all available language pairs
+client.topics                      # lists all available topics
+client.tones                       # lists all available tones
+client.find(uid)                   # finds a translation by unique id
+client.translations                # lists all translations
+client.translations(status)        # lists translations in a given status
+client.request_translation(params) # requests a new translation
 ```
 
-### Sample
+### Translation Statuses
 
 ```
-irb(main):009:0> client.topics
+'new'         - The translation has been created and is being pre-processed
+'ready'       - The translation is ready to be processed in the unbabel platform.
+'in_progress' - The translation is being executed
+'delivered'   - The translation has already been returned to the client (either using the endpoint or query for a translation)
+```
+
+### Request Translation
+
+You will need the following to perform a translation request
+
+```
+text (required)            - the text to be translated.
+target_language (required) - the language to translate the text to.
+source_language            - the language of text. If not supplemented it will be auto detected from the text.
+text_format                - The format of the text to be translated [one of text,html].
+target_text                - initial version of the text to be post-edited.
+uid                        - A unique identifier for the job. If one is not supplied the system will provide one.
+callback_url               - Once the job is done the result will be posted to this endpoint.
+formality (optional)       - The tone that should be used in the translation.
+instructions (optional)    - Client instructions for the translator.
+topics (optional)          - List of the topics of text.
+```
+
+### Usage samples
+
+```
+irb> client.topics
 => [{"topic"=>{"name"=>"politics"}}, {"topic"=>{"name"=>"gossip"}}, {"topic"=>{"name"=>"sex & relationships"}}, {"topic"=>{"name"=>"crafts"}}, {"topic"=>{"name"=>"parenting"}}, {"topic"=>{"name"=>"startups"}}, {"topic"=>{"name"=>"tech"}}, {"topic"=>{"name"=>"sports"}}]
+
+irb> params = {:text=>"unbabel rules!", :target_language=>"pt", :source_language=>"en"}
+irb> client.request(params)
+=> {"balance"=>982.0, "client"=>"davidslv", "price"=>6.0, "source_language"=>"en", "status"=>"new", "target_language"=>"pt", "text"=>"unbabel rules!", "text_format"=>"text", "uid"=>"dbd3fea5b5"}
 ```
 
 ## Available soon

data/lib/unbabel/translation.rb

@@ -17,7 +17,7 @@ module Unbabel
     # formality (optional)       - The tone that should be used in the translation.
     # instructions (optional)    - Client instructions for the translator.
     # topics (optional)          - List of the topics of text.
-    def request(params = {})
+    def request_translation(params = {})
       response = Unirest.post("#{Unbabel::Client::ENDPOINT}/translation/",
                         parameters: params.to_json)
       response.body
@@ -29,7 +29,7 @@ module Unbabel
     # 'in_progress' - The translation is being executed
     # 'delivered'   - The translation has already been returned to the client (either using the endpoint or query for a translation)
     def translations(status = nil)
-      status = "?#{status}" if status
+      status = "?status=#{status}" if status
 
       response = Unirest.get("#{Unbabel::Client::ENDPOINT}/translation/#{status}")
       response.body['objects']

data/lib/unbabel/version.rb

@@ -1,3 +1,3 @@
 module Unbabel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/unbabel/language_pair_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Unbabel::LanguangePair do
+  include Unbabel::LanguangePair
+
+  it 'returns an array of hashes' do
+    expected = [{
+      "lang_pair"=> {
+      "source_language"=>{"name"=>"Portuguese", "shortname"=>"pt"}, 
+      "target_language"=>{"name"=>"English", "shortname"=>"en"}}
+    }].to_json
+      
+
+    stub_request(:get, "http://sandbox.unbabel.com/tapi/v2/language_pair")
+      .to_return(:body => {'objects' => expected }  )
+
+      expect(language_pairs).to eq expected
+  end
+end

data/spec/lib/unbabel/tone_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Unbabel::Tone do
+  include Unbabel::Tone
+
+  it 'returns an array of hashes' do
+    expected = [
+      {"tone"=> {"description"=>"Informal style", "name"=>"Informal"}},
+      {"tone"=> {"description"=>"Friendly style", "name"=>"Friendly"}}
+    ].to_json
+
+    stub_request(:get, "http://sandbox.unbabel.com/tapi/v2/tone")
+      .to_return(:body => {'objects' => expected }  )
+
+      expect(tones).to eq expected
+  end
+end

data/spec/lib/unbabel/topic_spec.rb

@@ -1,4 +1,17 @@
 require 'spec_helper'
 
 describe Unbabel::Topic do
+  include Unbabel::Topic
+
+  it 'returns an array of hashes' do
+    expected = [{
+      'topic' => {'name' => 'politics'},
+      'topic' => {'name' => 'gossip'}
+    }].to_json
+
+    stub_request(:get, "http://sandbox.unbabel.com/tapi/v2/topic")
+      .to_return(:body => {'objects' => expected }  )
+
+      expect(topics).to eq expected
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unbabel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - David Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -102,6 +103,8 @@ files:
 - lib/unbabel/translation.rb
 - lib/unbabel/version.rb
 - spec/lib/unbabel/client_spec.rb
+- spec/lib/unbabel/language_pair_spec.rb
+- spec/lib/unbabel/tone_spec.rb
 - spec/lib/unbabel/topic_spec.rb
 - spec/spec_helper.rb
 - unbabel.gemspec
@@ -131,6 +134,8 @@ specification_version: 4
 summary: A wrapper for Unbabel API.
 test_files:
 - spec/lib/unbabel/client_spec.rb
+- spec/lib/unbabel/language_pair_spec.rb
+- spec/lib/unbabel/tone_spec.rb
 - spec/lib/unbabel/topic_spec.rb
 - spec/spec_helper.rb
 has_rdoc: