unbabel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4005346914d2c63457a1b5c7169bd58cee40aee5
+  data.tar.gz: 3ed086012c74df6dcafe171638fc7f430fffc7d4
+SHA512:
+  metadata.gz: 6d7a90a752d671182df26361902d00975f3aaa6439d9ff27d060abd237f5199c8c79fb8b3534bfe52638f3340c4bd056ec4f8b09d25440c082129c859d746a21
+  data.tar.gz: ad5da31135058fbf4d5cb64534e4fda5c2e1b5125501a6c99637a0d95102db192ceb01a9ca8226b2de73ab26b8dd01d823f6dfa3e3b49bbdcb27969bc6d35a6b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.3

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'pry'
+  gem 'pry-nav'
+  gem 'rspec'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    unbabel (0.0.1)
+      unirest (~> 1.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (10.3.2)
+    rdoc (4.1.2)
+      json (~> 1.4)
+    rest-client (1.6.8)
+      mime-types (~> 1.16)
+      rdoc (>= 2.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    slop (3.6.0)
+    unirest (1.1.2)
+      addressable (~> 2.3.5)
+      json (~> 1.8.1)
+      rest-client (~> 1.6.7)
+    webmock (1.20.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  pry
+  pry-nav
+  rake (~> 10.0)
+  rspec
+  unbabel!
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 David Silva
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Unbabel Ruby Wrapper
+
+[Unbabel](https://unbabel.com/) is a translation as a service, this is a ruby wrapper around their [API](https://github.com/Unbabel/unbabel_api).
+
+Happy Translations!
+
+
+## Configuration
+
+```ruby
+
+client = Unbabel::Client.new do |conf|
+  conf.username = ENV['UNBABEL_USERNAME']
+  conf.token    = ENV['UNBABEL_TOKEN']
+end
+
+```
+
+# Sandbox mode
+
+If you want to help developing this library user the following ENV variable.
+
+```shell
+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
+```
+
+### Sample
+
+```
+irb(main):009:0> 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"}}]
+```
+
+## Available soon
+
+- Ability of bulk request translations
+
+## Contributing
+
+1. Fork it ( https://github.com/davidslv/unbabel-ruby-wrapper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/unbabel/client.rb

@@ -0,0 +1,46 @@
+module Unbabel
+  class Client
+    TEST_MODE = ENV['UNBABEL_SANDBOX'] == 'true'
+    SANDBOX   = 'http://sandbox.unbabel.com/tapi/v2'
+    ENDPOINT  = TEST_MODE ? SANDBOX : 'https://unbabel.com/tapi/v2'
+
+    include Unbabel::LanguangePair
+    include Unbabel::Topic
+    include Unbabel::Tone
+    include Unbabel::Translation
+
+    attr_accessor :username, :token
+
+
+    def initialize(options = {})
+      @username = options[:username]
+      @token    = options[:token]
+
+      yield(self) if block_given?
+      validate_credentials!
+      Unirest.default_header('Content-Type', 'application/json')
+      Unirest.default_header('Authorization', "ApiKey #{@username}:#{@token}")
+    end
+
+    def credentials
+      {
+        username: username,
+        token:    token
+      }
+    end
+
+    def credentials?
+      credentials.values.all?
+    end
+
+    private
+    # Ensures that all necessary credentials
+    # are set during configuration.
+    def validate_credentials!
+      credentials.each do |credential, value|
+        next if !value.nil? && value.is_a?(String)
+        fail(ArgumentError.new("Invalid #{credential}, it's value: #{value.inspect} must be a string."))
+      end
+    end
+  end
+end

data/lib/unbabel/language_pair.rb

@@ -0,0 +1,8 @@
+module Unbabel
+  module LanguangePair
+    def language_pairs
+      response = Unirest.get("#{Unbabel::Client::ENDPOINT}/language_pair")
+      response.body['objects']
+    end
+  end
+end

data/lib/unbabel/tone.rb

@@ -0,0 +1,8 @@
+module Unbabel
+  module Tone
+    def tones
+      response = Unirest.get("#{Unbabel::Client::ENDPOINT}/tone")
+      response.body['objects']
+    end
+  end
+end

data/lib/unbabel/topic.rb

@@ -0,0 +1,8 @@
+module Unbabel
+  module Topic
+    def topics
+      response = Unirest.get("#{Unbabel::Client::ENDPOINT}/topic")
+      response.body['objects']
+    end
+  end
+end

data/lib/unbabel/translation.rb

@@ -0,0 +1,38 @@
+module Unbabel
+  module Translation
+
+    # finds a translation by it's unique id
+    def find(uid)
+      response = Unirest.get("#{Unbabel::Client::ENDPOINT}/translation/#{uid}")
+      response.body
+    end
+
+    # 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.
+    def request(params = {})
+      response = Unirest.post("#{Unbabel::Client::ENDPOINT}/translation/",
+                        parameters: params.to_json)
+      response.body
+    end
+
+    # status are
+    # '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)
+    def translations(status = nil)
+      status = "?#{status}" if status
+
+      response = Unirest.get("#{Unbabel::Client::ENDPOINT}/translation/#{status}")
+      response.body['objects']
+    end
+  end
+end

data/lib/unbabel/version.rb

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

data/lib/unbabel.rb

@@ -0,0 +1,10 @@
+require 'unbabel/version'
+require 'unirest'
+
+module Unbabel
+  require 'unbabel/language_pair'
+  require 'unbabel/tone'
+  require 'unbabel/topic'
+  require 'unbabel/translation'
+  require 'unbabel/client'
+end

data/spec/lib/unbabel/client_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Unbabel::Client do
+  subject { described_class }
+
+  describe '#new' do
+    context 'when there is username' do
+      it 'should raise an ArgumentError' do
+        expect {
+          subject.new
+        }.to raise_error(ArgumentError, /username/)
+      end
+    end
+
+    context 'when there is no token' do
+      it 'should raise an ArgumentError' do
+        expect {
+          subject.new(username: 'd')
+        }.to raise_error(ArgumentError, /token/)
+      end
+    end
+
+    context 'when there is username and token' do
+      it 'should not raise any ArgumentError' do
+        expect {
+          subject.new(username: 'd', token: '123')
+        }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/lib/unbabel/topic_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Unbabel::Topic do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+require 'pry'
+
+require_relative '../lib/unbabel'
+
+require 'webmock/rspec'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/unbabel.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unbabel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unbabel"
+  spec.version       = Unbabel::VERSION
+  spec.authors       = ["David Silva"]
+  spec.email         = ["davidslv@gmail.com"]
+  spec.summary       = %q{A wrapper for Unbabel API.}
+  spec.description   = %q{Unbabel is a translation as a service, this is a ruby wrapper around their API.}
+  spec.homepage      = "http://davidslv.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "rspec", '~> 3.1', '>= 3.1.0'
+
+  spec.add_runtime_dependency 'unirest', '~> 1.1', '>= 1.1.2'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: unbabel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: unirest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Unbabel is a translation as a service, this is a ruby wrapper around
+  their API.
+email:
+- davidslv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/unbabel.rb
+- lib/unbabel/client.rb
+- lib/unbabel/language_pair.rb
+- lib/unbabel/tone.rb
+- lib/unbabel/topic.rb
+- lib/unbabel/translation.rb
+- lib/unbabel/version.rb
+- spec/lib/unbabel/client_spec.rb
+- spec/lib/unbabel/topic_spec.rb
+- spec/spec_helper.rb
+- unbabel.gemspec
+homepage: http://davidslv.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A wrapper for Unbabel API.
+test_files:
+- spec/lib/unbabel/client_spec.rb
+- spec/lib/unbabel/topic_spec.rb
+- spec/spec_helper.rb
+has_rdoc: