Code Monkey home page Code Monkey logo

detectlanguage-ruby's Introduction

Detect Language API Ruby Client

Gem Version Build Status

Detects language of the given text. Returns detected language codes and scores.

Before using Detect Language API client you have to setup your personal API key. You can get it by signing up at https://detectlanguage.com

Installation

Add this line to your application's Gemfile:

gem 'detect_language'

Or install it yourself as:

gem install detect_language

Configuration

If you are using Rails, create initializer config/initializers/detect_language.rb and add following code there. Otherwise just integrate following code into your apps configuration.

DetectLanguage.configure do |config|
  config.api_key = "YOUR API KEY"

  # enable secure mode (SSL) if you are passing sensitive data
  # config.secure = true
end

Usage

Language detection

DetectLanguage.detect("Buenos dias señor")

Result

[{"language"=>"es", "isReliable"=>true, "confidence"=>6.62}]

Simple language detection

If you need just a language code you can use simple_detect. It returns just the language code.

DetectLanguage.simple_detect("Buenos dias señor")

Result

"es"

Batch detection

It is possible to detect language of several texts with one request. This method is significantly faster than doing one request per text. To use batch detection just pass array of texts to detect method.

DetectLanguage.detect(["Buenos dias señor", "Labas rytas"])

Result

Result is array of detections in the same order as the texts were passed.

[ [{"language"=>"es", "isReliable"=>true, "confidence"=>6.62}], 
  [{"language"=>"lt", "isReliable"=>true, "confidence"=>6.82}] ]

Getting your account status

DetectLanguage.user_status

Result

{"date"=>"2013-11-17", "requests"=>95, "bytes"=>2223, "plan"=>"FREE", "plan_expires"=>nil,
 "daily_requests_limit"=>5000, "daily_bytes_limit"=>1048576, "status"=>"ACTIVE"}

Getting list supported languages

DetectLanguage.languages

Result

Array of language codes and names.

License

Detect Language API Client is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

detectlanguage-ruby's People

Contributors

laurynas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

detectlanguage-ruby's Issues

Exception handling class should use StandardError

This request is to convert the DetectLanguage Exception handling class to StandardError. Ruby exception handling in classes (IMUnderstanding) should be based on StandardError and not ::Exception.

Almost all rescue blocks around Gem calls are coded "rescue => e" which defaults to StandardError. Exceptions from DetectLanguage are not rescued in this case and the programmer must then figure out that "rescue DetectLanguage::Exception => e" does indeed catch errors.

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

  spec.license = 'MIT'
  # or
  spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Faulty detection with "UI Designer"

Hi! I'm trying to use your service to validate that the input written by the user is in English. Since this particual input is used for users to describe their background and specialty, the term "UI Designer" is very frequently used... But I'm not able to validate it correctly with your service since it defaults to consider it Portuguese. Any chance this could be corrected?

image

NoMethodError: undefined method `[]' for nil:NilClass

Hi, thank you for your work! :)

My app raised this error sometimes when I use DetectLanguage.detect method.
I think it's the API that return unexpected format like empty array or empty body.
I will make a Pull request with this correction for this particular error, it might fix the error and return nil if the data is not well formated.

I can't see what string I send to the gem, The API seems to return at least {"data":{"detections":[]}} but maybe there is a special case.

def detect(data)
  key = data.is_a?(Array) ? 'q[]' : 'q'
  result = client.post(:detect, key => data)
  result.fetch('data', {}).fetch('detections', nil)
end

let me know if you have another idea or if this seems not good for you :)

(Sorry if my english is not correct)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.