lingo24 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2108dfb28535b1d57e5529dba1bec79fda5cbae8
+  data.tar.gz: 988e42902edcbd3fb4ffcdbb197ae5857aaa37d6
+SHA512:
+  metadata.gz: fc81e23d638c1a3cdb20470287a242146cf84846ec151287a4275304dcbf75ec2407270c4bce46be1bba59b7b7f622f50657f510b84da4fb561918306cec25e9
+  data.tar.gz: 47431caffa64bbbc407b4abe2a0ec15499e974b91028899f9378e97bf253e3ff4d218988fafc21b4273a45681447a94267a2566d8997cd37f7597f745556e204

data/.gitignore

@@ -0,0 +1,15 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lingo24.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lingo24 Limited
+
+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,50 @@
+# Lingo24 Ruby Library for the [Lingo24 Translation API](https://developer.lingo24.com)
+
+We love languages at Lingo24. Every day we work hard to translate documents, websites, tools and products, helping people all over the world communicate with one another. 
+
+Translating your content can be challenging, but we aim to make it very simple through easy to use tools, friendly people, and great technology.
+
+In terms of translation, **[Lingo24](http://www.lingo24.com)** offers a range of professional human-translation and premium machine translation services, all of which can accessed via our translation APIs.
+
+This is a Ruby interface to make using our APIs simpler.
+
+At present the client library only provides support for our [Premium Machine Translation API](https://developer.lingo24.com/premium-machine-translation-api). Support will soon be added for our professional human-translation API.
+
+
+## Installation & Requirements
+
+Installing the Lingo24 _gem_ is trivial, simply run the following from your command line:
+
+```sh
+$ gem install lingo24
+```
+
+## Tests
+
+We have bundled a range of tests using _rspec_ which you can read to understand how to use our API.
+
+To run these tests you need to configure the _user_key_ within the specification file so you can call against the live API.
+
+## Questions, Comments, Complaints, Compliments?
+
+If you have questions or comments and would like to reach us directly, please feel free to do so at the following outlets. We love hearing from developers!
+
+* Email: api [at] lingo24 dot com
+* Forum: [Lingo24 Developer Portal](https://developer.lingo24.com/forum)
+
+If you come across any issues with the library, please file them on the project’s [Bitbucket issue tracker](https://bitbucket.org/lingo24/lingo24-ruby/issues).
+
+## Accessing Our Premium Machine Translation API
+To get started with the API you first have to authenticate. You do this by using the authentication information you received when you signed up on the [Lingo24 Developer Portal](https://developer.lingo24.com).
+
+```ruby
+require ‘lingo24’
+
+lingo24 = Lingo24::PremiumMTAPI.new('your_user_key')
+```
+If you do not have an _user_key_ please go to our [plans](https://developer.lingo24.com/plans) page to sign up for one of our access plans. This includes our free Premium Machine Translation _Taster_ plan, with free access to translate 100,000 between English, French and Spanish.
+
+
+Once you have done this you are free to use the methods exposed via the API wrapper to translate text, fetch source languages and fetch target languages.
+
+As the library is fully _rdoc_ compliant, you can browse the documentation to understand more about the methods available. You can also view the methods available on the online [Lingo24 API documentation](https://developer.lingo24.com/premium-machine-translation-api).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+end
+task :default => :spec
+

data/lib/lingo24.rb

@@ -0,0 +1,6 @@
+require_relative 'lingo24/version'
+require_relative 'lingo24/exception'
+require_relative 'lingo24/language'
+require_relative 'lingo24/premium_mt_api'
+
+

data/lib/lingo24/exception.rb

@@ -0,0 +1,24 @@
+module Lingo24
+
+  # Custom +Exception+ class for errors returned from the Lingo24 Translation APIs.
+  class Exception  < :: StandardError
+    attr_accessor :code
+
+    # Creates a new +Language+.
+    #
+    # Parameters:
+    # <tt>code</tt> - a string containing the status code of the message.
+    # <tt>msg</tt> - a string containing the exception message.
+    def initialize(code, msg)
+      @code = code
+      @message = msg
+    end
+
+    # Overrides default +message+ to return the exception's message.
+    def message
+     @message
+    end
+
+  end
+
+end

data/lib/lingo24/language.rb

@@ -0,0 +1,24 @@
+module Lingo24
+
+  # Model class for the Language's returned from the Lingo24 Translation APIs.
+  class Language
+    attr_reader :code, :name
+
+    # Creates a new +Language+.
+    #
+    # Parameters:
+    # <tt>code</tt> - a string containing the ISO-639-1 code for the language.
+    # <tt>name</tt> - a string containing the friendly name for the language.
+    def initialize(code, name)
+      @code = code
+      @name = name
+    end
+
+    # Overrides default +to_s+ to return a friendly display of the object.
+    def to_s
+      "(" + code + ": " + name + ")"
+    end
+
+  end
+
+end

data/lib/lingo24/premium_mt_api.rb

@@ -0,0 +1,127 @@
+require 'faraday'
+require 'json'
+
+module Lingo24
+
+  # +PremiumMTAPI+ is an API wrapper for the Lingo24 Premium Machine Translation API
+  # (https://developer.lingo24.com/premium-machine-translation-api).
+  #
+  # Machine Translation (MT) is a cost-effective, quick translation option for large volumes of content, or cases where
+  # it is not feasible to use a professional human translator.
+  #
+  # The Lingo24 Premium Machine Translation API provides direct, secure, high volume access to our Premium Machine
+  # Translation Engines. Encrypted using SSL and with no data storage at Lingo24, you can translate safely with no data
+  # privacy concerns.
+  #
+  # We have developed a range of Premium MT engines focusing on specific language combinations and subject areas,
+  # including Law, Information Technology, Pharmaceuticals, Business, IT and many more. This focused approach results in
+  # much higher-quality output than generic engines from big-name translators, with the API selecting the best suited
+  # engine based on the content of the text for translation.                                                                                                                                                                                                                                  Ideal for those scenarios where no post-editing is required, such as gisting (getting a basic understanding of a source text), real-time translation (tweets, IM chat, etc) or sentiment analysis, the Premium MT API enables easy access to raw machine translation.
+  #
+  class PremiumMTAPI
+    BASE_API_URL = "https://api.lingo24.com/mt/v1/"
+
+    public
+    # Creates a new API client to handle calls to the Lingo24 Premium Machine Translation API.
+    #
+    # Parameters:
+    # <tt>user_key</tt> - a string containing the user_key issued by the Lingo24 developer portal for your application.
+    def initialize(user_key)
+      @user_key = user_key
+    end
+
+    # Synchronous call to translate text using the Lingo24 Premium Machine Translation API. When calling this method
+    # the text sent is analysed and routed to the engine most likely to produce the highest quality output.
+    #
+    # NOTE: Customers who have custom engines for specific business domains will have these prioritised ahead of Lingo24
+    # vertical engines.
+    #
+    # Options:
+    # <tt>text</tt> - a string for translation
+    # <tt>source</tt> - a string containing the ISO-639-1 code for the source language
+    # <tt>target</tt> - a string containing the ISO-639-1 code for the target language
+    def translate(text, source, target)
+      params = {:q => text, :source => source, :target => target, :user_key => @user_key}
+      handle_request('translate', params, 'translation')
+    end
+
+    # Synchronous call to translate text using the Lingo24 Premium Machine Translation API. When calling this method
+    # the text sent is analysed and routed to the engine most likely to produce the highest quality output.
+    #
+    # NOTE: Customers who have custom engines for specific business domains will have these prioritised ahead of Lingo24
+    # vertical engines.
+    #
+    # Options:
+    # <tt>text</tt> - a string for translation
+    # <tt>source</tt> - a +Lingo24::Language+ containing the source language
+    # <tt>target</tt> - a +Lingo24::Language+ containing the target language
+    def translate_language(text, source, target)
+      params = {:q => text, :source => source.code, :target => target.code, :user_key => @user_key}
+      handle_request('translate', params, 'translation')
+    end
+
+    # Synchronous call to translate text using a specific Lingo24 Premium Machine Translation engine. This method is
+    # typically used by customers who have a custom engine and want to ignore the automatic classification..
+    #
+    # Options:
+    # <tt>text</tt> - a string for translation
+    # <tt>source</tt> - a +Lingo24::Language+ containing the source language
+    # <tt>target</tt> - a +Lingo24::Language+ containing the target language
+    def translate_specific(text, id)
+      params = {:q => text, :id => id, :user_key => @user_key}
+      handle_request('translate', params, 'translation')
+    end
+
+    ##
+    # Returns a list of the supported source languages for +PremiumMTAPI+. This method will return a list containing
+    # +Lingo24::Language+ objects which provide access to both the ISO-639-1 code as well as a friendly name.
+    #
+    # If the +target+ is nil, the list will contain all possible source languages.
+    # If the +target+ is set, the list will contain only the source languages that
+    # can generate the target language.
+    def get_source_langs(target = nil)
+      if (target.nil?)
+        params = { :user_key => @user_key }
+      else
+        params = { :user_key => @user_key, :target => target }
+      end
+      source_langs = handle_request('sourcelangs', params, 'source_langs')
+      source_langs.map { |code, name| Lingo24::Language.new(code, name) }
+    end
+
+    ##
+    # Returns a list of the supported target languages for +PremiumMTAPI+. This method will return a list containing
+    # +Lingo24::Language+ objects which provide access to both the ISO-639-1 code as well as a friendly name.
+    #
+    # If +source+ is nil, the list will contain all possible target languages.
+    # If +source+ is set, the list will contain only the target languages that
+    # can generate the source language.
+    def get_target_langs(source = nil)
+      if (source.nil?)
+        params = { :user_key => @user_key }
+      else
+        params = { :user_key => @user_key, :source => source }
+      end
+      target_langs = handle_request('targetlangs', params, 'target_langs')
+      target_langs.map { |code, name| Lingo24::Language.new(code, name) }
+    end
+
+    private
+    # Private method to handle the interaction between the client library and the Lingo24 API.
+    def handle_request(method, params, field)
+      response = Faraday.post BASE_API_URL + method, params do |request|
+        request.options[:timeout] = 300
+        request.options[:open_timeout] = 120
+      end
+      if (response.status.equal? '200')
+        raise Lingo24::Exception.new(response.status, response.body)
+      elsif (JSON.parse(response.body)['errors'])
+        raise Lingo24::Exception.new('500', JSON.parse(response.body)['errors'][0])
+      else
+        JSON.parse(response.body)[field]
+      end
+    end
+
+  end
+
+end

data/lib/lingo24/version.rb

@@ -0,0 +1,3 @@
+module Lingo24
+  VERSION = "0.1.0"
+end

data/lingo24.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lingo24/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lingo24"
+  spec.version       = Lingo24::VERSION
+  spec.authors       = ["David Meikle"]
+  spec.email         = ["api@lingo24.com"]
+  spec.summary       = %q{A client library for interfacing with the Lingo24's Translation APIs.}
+  spec.description   = %q{Lingo24 offer various APIs that allow you to access our translation services, including our business translation and premium machine translation services. The Lingo24 gem lets you interface with the APIs (found at https://developer.lingo24.com/) to allow you to easily integrate them within your application.}
+  spec.homepage      = "https://developer.lingo24.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{^(spec|test|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "json", "~> 1.8"
+end

data/spec/premium_mt_api_spec.rb

@@ -0,0 +1,65 @@
+require 'rspec'
+require './lib/lingo24'
+
+# Replace this with your Application's +user_key+ from the Lingo24 Developer Portal (https://developer.lingo24.com)
+USER_KEY = '<your_user_key>'
+
+# Specification file for the +Lingo24::PremiumMTAPI+ class
+describe Lingo24::PremiumMTAPI do
+
+  it 'should translate a string with source and target supplied' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    r = translator.translate('Love your language', 'en', 'es')
+    expect(r.size).to be > 0
+  end
+
+  it 'should translate a string with a specifc engine' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    r = translator.translate_specific('Love your language', 'ugc-ro-en')
+    expect(r.size).to be > 0
+  end
+
+  it 'if you translate using a specific engine but supply the wrong id, it should raise an Lingo24::Exception' do
+    begin
+      translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+      r = translator.translate_specific('Love your language', 'ugc-roen')
+      fail('No Lingo24::Exception raised')
+    rescue Lingo24::Exception => detail
+      expect(detail.code).to eql('500')
+    end
+
+  end
+
+  it 'should provide a list of available source languages' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    r = translator.get_source_langs()
+    expect(r.size).to be > 0
+  end
+
+  it 'should provide a list of available source languages, filtered by the target language' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    a = translator.get_source_langs('de')
+    b = translator.get_source_langs()
+    expect(b.size).to be > a.size
+  end
+
+  it 'should provide a list of available target languages' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    r = translator.get_target_langs()
+    expect(r.size).to be > 0
+  end
+
+  it 'should provide a list of available target languages, filtered by the source language' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    a = translator.get_target_langs('de')
+    b = translator.get_target_langs()
+    expect(b.size).to be > a.size
+  end
+
+  it 'should translate a string using Lingo24::Language objects for source and target' do
+    translator = Lingo24::PremiumMTAPI.new(USER_KEY)
+    r = translator.translate_language('Love your language', Lingo24::Language.new('en', 'English'), Lingo24::Language.new('es', 'Spanish'))
+    expect(r.size).to be > 0
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: lingo24
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Meikle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-05 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Lingo24 offer various APIs that allow you to access our translation services,
+  including our business translation and premium machine translation services. The
+  Lingo24 gem lets you interface with the APIs (found at https://developer.lingo24.com/)
+  to allow you to easily integrate them within your application.
+email:
+- api@lingo24.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lingo24.rb
+- lib/lingo24/exception.rb
+- lib/lingo24/language.rb
+- lib/lingo24/premium_mt_api.rb
+- lib/lingo24/version.rb
+- lingo24.gemspec
+- spec/premium_mt_api_spec.rb
+homepage: https://developer.lingo24.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: '0'
+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 client library for interfacing with the Lingo24's Translation APIs.
+test_files:
+- spec/premium_mt_api_spec.rb