watson-language-translator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b39138220f6b7f4d9413acc03a87bc54cdb0f5a
+  data.tar.gz: 334855cff57183b0f1b215119aed7990b3001b3f
+SHA512:
+  metadata.gz: d39a67c33231a13892fde4c5b59946bbd5e46108510c10d33cf334a18bdbe988d6a8eac656f48bbd60bbfe990373f347d6e14fa2a066f6ed89f43480ff2a059c
+  data.tar.gz: 3654e853ae39259cd5e1b9ae0e6128f4797173b635fab3f8452be05c737719bf8a31db66921896941cf1b120cc1d8b5d7e5d32b2877ec9d92977f3185a61a8e9

data/README.md

@@ -0,0 +1,123 @@
+# watson-language-translator
+
+Language Translator translates text from one language to another. The service offers multiple domain-specific models that you can customize based on your unique terminology and language. Use Language Translator to take news from across the globe and present it in your language, communicate with your customers in their own language, and more.
+
+For more informations you can read [here](https://www.ibm.com/watson/developercloud/doc/language-translator/index.html)
+
+## Prerequisites
+
+To get an API username and password, you'll need to [sign up for IBM Bluemix](https://console.ng.bluemix.net/registration/). After you create an account:
+
+Log in to Bluemix and go to the AlchemyAPI service page.
+Click the "Create" button.
+Click the "Service Credentials" button from the Language Tranlator page in your Bluemix dashboard to view your API username and password.
+
+You authenticate to the Language Translator API by providing the username and password that are provided in the service credentials for the service instance that you want to use. The API uses Basic Authentication.
+
+After creating an instance of the Language Translator service, select Service Credentials from the left navigation for its dashboard to see the username and password that are associated with that instance.
+
+Note: Service credentials ("username" and "password") are different from your Bluemix account username and password.
+
+After create bluemix account and create username and passowrd credencials, you can use another gem for env variables as ([dotenv](https://github.com/bkeepers/dotenv), [figaro](https://github.com/laserlemon/figaro) or which you want to create env variables).
+
+Then in (.env) file you should add:
+
+```ruby
+language_translator_username=$your_username_from_bluemix
+language_translator_password=$your_password_from_bluemix
+```
+
+watson_langauge_translator will take your username and password and it will do request with this credencials, it's it!
+
+## Getting Started in ruby
+You can install this library
+
+`gem install 'watson-language-translator'`
+
+and use
+
+```ruby
+require 'watson-language-translator'
+```
+
+## Getting Started in Rails
+AlchemyLanguage works with Rails > 4.1 onwards. You can add it to your Gemfile with:
+
+```ruby
+gem 'rest-client'
+gem 'watson-language-translator'
+```
+
+Then run `bundle install`
+
+## Use
+
+### Models 
+  
+  All Services contain these models:
+
+  ```
+    .
+    ├── Translate
+    ├── IdentifiableLanguages
+    ├── IdentifyLanguage
+    ├── ListModels
+    ├── ModelDetails
+    ├── Model (create)
+    ├── Model (delete)
+  
+    7 models
+  ```
+
+#### Translate
+
+Translates input text from the source language to the target language.
+
+  ```ruby
+    @language_translate = WatsonLanguage::Translator.new("hello",
+      source: "en",
+      target: "es",
+      http_method: "post"
+    )
+  
+    @language_translate.result  # => {"translations"=>[{"translation"=>"Hola"}], "word_count"=>1, "character_count"=>5}
+ ```
+ 
+#### Identifiable languages
+Return the list of languages it can detect.
+
+  ```ruby
+    @identifiable_languages = WatsonLanguage::IdentifiableLanguages.fetch
+  
+    @identifiable_languages.result  # => { "languages": [ { "language": "af", "name": "Afrikaans"}, { "language": "ar", "name": "Arabic" }, ...] }
+ ```
+
+#### Identify language
+Identify the language in which a text is written.
+
+ ```ruby
+    @identify_language = WatsonLanguage::IdentifyLanguage.new("this is a text")
+  
+    @identify_language.result  # => { "languages": [ { "confidence": 0.9143, "language": "en-US" }, { "confidence": 0.0396, "language": "hu-HU" }, //... ] }
+ ```
+ 
+#### List Models 
+Lists available models for the Language translator service with option to filter by source or by target language.
+
+ ```ruby
+    @list_models = WatsonLanguage::ListModels.fetch
+  
+    @list_models.result  # => { "models": [ { "model_id ": "3e7dfdbe-f757-4150-afee-458e71eb93fb", "source": "en", "target": "es", "base_model_id": "en-es",.. }, //... ] }
+ ```
+#### Model Details
+Returns information, including training status, about a specified translation model.
+
+ ```ruby
+    @model_details = WatsonLanguage::ModelDetails.fetch(model_id: "en-es")
+  
+    @model_details.result  # => { "models": [ { "model_id ": "3e7dfdbe-f757-4150-afee-458e71eb93fb", "source": "en", "target": "es", "base_model_id": "en-es",.. }, //... ] }
+ ```
+ 
+## License
+
+This project is licensed under the MIT License

data/lib/watson-language-translator.rb

@@ -0,0 +1,29 @@
+require 'rest-client'
+require 'json'
+require "addressable/uri"
+
+module WatsonLanguage
+  class << self
+    def base_url
+      "https://gateway.watsonplatform.net/language-translator/api/v2"
+    end
+
+    def username
+      ENV['language_translator_username']
+    end
+
+    def password
+      ENV['langauge_translator_password']
+    end
+  end
+end
+
+require_relative "watson-language-translator/generator/language_request.rb"
+require_relative "watson-language-translator/active_method/extra.rb"
+require_relative "watson-language-translator/active_method/base.rb"
+require_relative "watson-language-translator/translator.rb"
+require_relative "watson-language-translator/identifiable_languages.rb"
+require_relative "watson-language-translator/identify.rb"
+require_relative "watson-language-translator/list_models.rb"
+require_relative "watson-language-translator/model_details.rb"
+require_relative "watson-language-translator/model.rb"

data/lib/watson-language-translator/active_method/base.rb

@@ -0,0 +1,37 @@
+module WatsonLanguage
+  module ActiveMethod
+    class Base < ActiveMethod::Extra
+      include WatsonLanguage::Generators::LanguageRequest
+      attr_accessor :text, :username, :password, :json_result, :options, :http_method
+
+      def initialize(text = nil, options={})
+        @text = text
+        @username = WatsonLanguage.username
+        @password = WatsonLanguage.password
+        @options = options
+        @http_method = fetch_http_method
+        @json_result = request
+      end
+
+      def request
+        json_parser(endpoint)
+      end
+
+      def params_addressable
+        uri = Addressable::URI.new
+        uri.query_values = @options
+        uri.query
+      end
+
+      def fetch_http_method
+        if @options[:http_method]
+          result = options[:http_method]
+          @options.delete(:http_method)
+        else
+          result = "get"
+        end
+        return result.to_sym
+      end
+    end
+  end
+end

data/lib/watson-language-translator/active_method/extra.rb

@@ -0,0 +1,15 @@
+module WatsonLanguage
+  module ActiveMethod
+    class Extra
+      def self.add_response_field(name)
+        define_method(name) do
+          @json_result[name.to_s]
+        end
+      end
+
+      def result
+        @json_result
+      end
+    end
+  end
+end

data/lib/watson-language-translator/generator/language_request.rb

@@ -0,0 +1,23 @@
+module WatsonLanguage
+  module Generators
+    module LanguageRequest
+      def base_url_request
+        "#{WatsonLanguage.base_url}"
+      end
+
+      def rest_client_api(request_api_url)
+        RestClient::Request.execute(
+          method: @http_method,
+          url: request_api_url,
+          user: @username,
+          password: @password,
+          :headers => {:accept => :json}
+        )
+      end
+
+      def json_parser(url)
+        JSON.parse(rest_client_api(base_url_request + "/" + url))
+      end
+    end
+  end
+end

data/lib/watson-language-translator/identifiable_languages.rb

@@ -0,0 +1,13 @@
+module WatsonLanguage
+  class IdentifiableLanguages < ActiveMethod::Base
+    add_response_field :languages
+
+    def self.fetch
+      self.new
+    end
+
+    def endpoint
+      "identifiable_languages"
+    end
+  end
+end

data/lib/watson-language-translator/identify.rb

@@ -0,0 +1,10 @@
+module WatsonLanguage
+  class Identify < ActiveMethod::Base
+    add_response_field :languages
+
+    def endpoint
+      url = "identify"
+      url << "?text=#{@text}"
+    end
+  end
+end

data/lib/watson-language-translator/list_models.rb

@@ -0,0 +1,13 @@
+module WatsonLanguage
+  class ListModels < ActiveMethod::Base
+    add_response_field :models
+
+    def self.fetch
+      self.new
+    end
+
+    def endpoint
+      "models"
+    end
+  end
+end

data/lib/watson-language-translator/model.rb

@@ -0,0 +1,21 @@
+module WatsonLanguage
+  class Model < ActiveMethod::Base
+    add_response_field :model_id
+    add_response_field :deleted
+
+    def self.create(options={})
+      self.new(nil, options)
+    end
+
+    def self.delete(options={})
+      self.new(nil, options)
+    end
+
+    def endpoint
+      return url = "models/#{@options[:model_id]}" if @options[:model_id]
+      url = "models"      
+      url << "&#{params_addressable}" unless params_addressable.empty?
+      url
+    end
+  end
+end

data/lib/watson-language-translator/model_details.rb

@@ -0,0 +1,13 @@
+module WatsonLanguage
+  class ModelDetails < ActiveMethod::Base
+  	add_response_field :models
+  	
+    def self.fetch(options={})
+      self.new(nil, options)
+    end
+
+    def endpoint
+      "models/#{@options[:model_id]}"
+    end
+  end
+end

data/lib/watson-language-translator/translator.rb

@@ -0,0 +1,14 @@
+module WatsonLanguage
+  class Translator < ActiveMethod::Base
+    add_response_field :translations
+    add_response_field :word_count
+    add_response_field :character_count
+
+    def endpoint
+      url = "translate"
+      url << "?text=#{@text}"
+      url << "&#{params_addressable}" unless params_addressable.empty?
+      url
+    end
+  end
+end

data/lib/watson-language-translator/version.rb

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: watson-language-translator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diamant
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Watson Language Translate content into multiple languages
+email:
+- diamantkolshi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/watson-language-translator.rb
+- lib/watson-language-translator/active_method/base.rb
+- lib/watson-language-translator/active_method/extra.rb
+- lib/watson-language-translator/generator/language_request.rb
+- lib/watson-language-translator/identifiable_languages.rb
+- lib/watson-language-translator/identify.rb
+- lib/watson-language-translator/list_models.rb
+- lib/watson-language-translator/model.rb
+- lib/watson-language-translator/model_details.rb
+- lib/watson-language-translator/translator.rb
+- lib/watson-language-translator/version.rb
+homepage: https://github.com/diamantkolshi/watson-language-translator
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Watson Language!
+test_files: []