linguo 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2012 Nihad Abbasov / NARKOZ
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,72 @@
+# Linguo
+
+Linguo detects the language of a given text using [Free Language Detection API](http://detectlanguage.com).
+
+[![Build Status](https://secure.travis-ci.org/NARKOZ/linguo.png)](http://travis-ci.org/NARKOZ/linguo)
+
+## Installation
+
+Install it from rubygems:
+
+```sh
+gem install linguo
+```
+
+If you're using Rails, add to your Gemfile:
+
+```ruby
+gem 'linguo'
+# gem 'linguo', :git => 'git://github.com/NARKOZ/linguo.git'
+```
+
+and run:
+
+```sh
+bundle
+```
+
+You can run `rails g linguo:config` to generate an initializer and set up API key at `config/initializers/linguo.rb`.
+
+## Usage examples
+
+You can use demo API key (`demo`) to test out any examples below.
+
+There are a few ways to set an API key. You can set default API key globally in `Linguo::Config.api_key`:
+
+```ruby
+Linguo.api_key = "your_api_key"
+```
+
+or set the environment variable `'LINGUO_API_KEY'` and Linguo will use it.
+
+You can also pass it directly:
+
+```ruby
+Linguo.detect("your text to detect", "your_api_key")
+```
+
+Identify text language and get confidence scores using the `detect` method:
+
+```ruby
+Linguo.detect("こんにちは")
+```
+
+Get a list of languages with confidence greater than 0.3:
+
+```ruby
+Linguo.detect("こんにちは").detections.map {|x| x['language'] if x['confidence'] > 0.3}.compact
+```
+
+Linguo adds `lang` method to `String` class:
+
+```ruby
+"こんにちは".lang
+```
+
+It will return an array containing detected languages.
+
+For more information, refer to [documentation](http://rubydoc.info/gems/linguo/frames).
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/linguo.rb

@@ -0,0 +1,29 @@
+require 'linguo/version'
+require 'linguo/config'
+require 'linguo/detect'
+require 'linguo/errors'
+require 'linguo/core_ext/string'
+require 'net/http'
+require 'json'
+
+module Linguo
+  # Sets API key obtained from detectlanguage.com.
+  #
+  # @see Linguo::Config
+  def self.api_key=(val)
+    Config.api_key = val
+  end
+
+  # Creates a new instance of Linguo::Detect.
+  #
+  # Note that api_key is optional and isn't required once you set
+  # <tt>Linguo::Config.api_key</tt> or <tt>ENV['LINGUO_API_KEY']</tt>.
+  #
+  # @param  [String] text The text required to detect.
+  # @param  [String] api_key The API key obtained from detectlanguage.com.
+  # @return [Linguo::Detect]
+  def self.detect(text, api_key=nil)
+    api_key = api_key || Linguo::Config.api_key || ENV['LINGUO_API_KEY']
+    Detect.new(text, api_key)
+  end
+end

data/lib/linguo/config.rb

@@ -0,0 +1,16 @@
+module Linguo
+  # Defines methods to set API key.
+  module Config
+    def self.api_key=(val)
+      @@api_key = val
+    end
+
+    def self.api_key
+      begin
+        @@api_key
+      rescue NameError
+        raise Linguo::Errors::MissingApiKey, "No API key has been set!"
+      end
+    end
+  end
+end

data/lib/linguo/core_ext/string.rb

@@ -0,0 +1,17 @@
+class String
+  # Retrieves all the languages detected for the current string
+  # sorted by confidence.
+  #
+  # Requires <tt>Linguo::Config.api_key</tt> or <tt>ENV['LINGUO_API_KEY']</tt>
+  # to be set up.
+  #
+  # @example
+  #  "simple text".lang # => ["en", "fr"]
+  # @return [Array]
+  def lang
+    l ||= Linguo.detect(self, Linguo::Config.api_key)
+    l.detections.map {|x| x['language']}
+  rescue => e
+    raise Linguo::Errors::LinguoError, e.message
+  end
+end

data/lib/linguo/detect.rb

@@ -0,0 +1,32 @@
+module Linguo
+  class Detect
+    # The URL to the API endpoint.
+    API_URL = 'http://ws.detectlanguage.com/0.2/detect'
+
+    # An array of detections.
+    attr_reader :detections
+
+    # Initializes a new Detect object and parses the API response.
+    #
+    # @param  [String] text The text required to detect.
+    # @param  [String] api_key The API key obtained from detectlanguage.com.
+    # @return [Linguo::Detect]
+    def initialize(text, api_key)
+      raise Errors::MissingApiKey, "No API key provided." unless api_key
+
+      uri = URI API_URL
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data('q' => text, 'key' => api_key)
+      res = Net::HTTP.start(uri.hostname, uri.port) {|http| http.request(req)}
+
+      if res.code.to_i == 200
+        data = JSON.parse(res.body)
+        raise Errors::ApiError, data['error']['message'] if data['error']
+        raise Errors::UnexpectedApiException if data['data'].nil?
+        @detections = data['data']['detections']
+      else
+        raise Errors::ApiConnectionError, "#{response.code} #{response.message}"
+      end
+    end
+  end
+end

data/lib/linguo/errors.rb

@@ -0,0 +1,18 @@
+module Linguo
+  module Errors
+    # Custom error class for rescuing from all Linguo errors.
+    class LinguoError < StandardError; end
+
+    # Raised when Linguo API key is missed.
+    class MissingApiKey < LinguoError; end
+
+    # Raised when API endpoint returns error.
+    class ApiError < LinguoError; end
+
+    # Raised when API endpoint doesn't return the HTTP status code 200.
+    class ApiConnectionError < LinguoError; end
+
+    # Raised when API endpoint returns unexpected response.
+    class UnexpectedApiException < LinguoError; end
+  end
+end

data/lib/linguo/version.rb

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

data/lib/rails/generators/linguo/config_generator.rb

@@ -0,0 +1,11 @@
+module Linguo
+  class ConfigGenerator < Rails::Generators::Base
+    desc "Creates a configuration file at config/initializers/linguo.rb"
+
+    # Creates a configuration file at <tt>config/initializers/linguo.rb</tt>
+    # when running <tt>rails g linguo:config</tt>.
+    def create_linguo_file
+      create_file 'config/initializers/linguo.rb', "Linguo.api_key = ENV['LINGUO_API_KEY']"
+    end
+  end
+end

data/linguo.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/linguo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nihad Abbasov", "Laurynas Butkus"]
+  gem.email         = ["mail@narkoz.me", "laurynas.butkus@gmail.com"]
+  gem.description   = %q{Language detection library for Ruby}
+  gem.summary       = %q{Linguo detects the language of a given piece of text}
+  gem.homepage      = "https://github.com/narkoz/linguo"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "linguo"
+  gem.require_paths = ["lib"]
+  gem.version       = Linguo::VERSION
+
+  gem.add_runtime_dependency 'json'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+end

data/spec/fixtures/response.json

@@ -0,0 +1 @@
+{"data":{"detections":[{"isReliable":false,"confidence":0.6,"language":"ja"},{"isReliable":false,"confidence":0.01,"language":"zh"}]}}

data/spec/fixtures/wrong_api_key.json

@@ -0,0 +1 @@
+{"error":{"code":1,"message":"Invalid API key"}}

data/spec/linguo/config_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Linguo::Config do
+  describe ".api_key" do
+    it "should raise an error when api_key is not set" do
+      expect { Linguo::Config.api_key }.
+        to raise_error Linguo::Errors::MissingApiKey
+    end
+
+    it "should return an API key when api_key is set" do
+      Linguo::Config.api_key = 'valid_api_key'
+      Linguo::Config.api_key.should == 'valid_api_key'
+    end
+  end
+end

data/spec/linguo/core_ext_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe String do
+  describe "#lang" do
+    before do
+      stub_request(:post, "http://ws.detectlanguage.com/0.2/detect").
+        with(:body => {"q"=>"こんにちは", "key"=>"valid_api_key"}).
+        to_return(:body => load_fixture("response"))
+    end
+
+    it "should return an array of detected languages" do
+      'こんにちは'.lang.should == ["ja", "zh"]
+    end
+  end
+end

data/spec/linguo/detect_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Linguo::Detect do
+  describe "#detections" do
+    context "with valid API key passed" do
+      before do
+        stub_request(:post, "http://ws.detectlanguage.com/0.2/detect").
+          with(:body => {"q"=>"こんにちは", "key"=>"valid_api_key"}).
+          to_return(:body => load_fixture("response"))
+        @linguo = Linguo.detect('こんにちは', 'valid_api_key')
+      end
+
+      it "should request the correct resource" do
+        a_request(:post, Linguo::Detect::API_URL).should have_been_made
+      end
+
+      it "should return the list of detections" do
+        @linguo.detections.should be_an Array
+        @linguo.detections.first.should be_a Hash
+        @linguo.detections.first['language'].should == "ja"
+      end
+    end
+
+    context "with invalid API key passed" do
+      before do
+        stub_request(:post, "http://ws.detectlanguage.com/0.2/detect").
+          with(:body => {"q"=>"こんにちは", "key"=>""}).
+          to_return(:body => load_fixture("wrong_api_key"))
+      end
+
+      it "should raise an API error" do
+        expect { Linguo.detect('こんにちは', '') }.
+          to raise_error Linguo::Errors::ApiError, "Invalid API key"
+        a_request(:post, Linguo::Detect::API_URL).should have_been_made
+      end
+    end
+  end
+end

data/spec/linguo_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Linguo do
+  it { Linguo.should respond_to :detect }
+  it { Linguo.should respond_to :api_key= }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'linguo'
+require 'webmock/rspec'
+
+def load_fixture(name)
+  File.new(File.dirname(__FILE__) + "/fixtures/#{name}.json")
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: linguo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nihad Abbasov
+- Laurynas Butkus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2157232700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157232700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2157232260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157232260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157231840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157231840
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &2157231360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157231360
+description: Language detection library for Ruby
+email:
+- mail@narkoz.me
+- laurynas.butkus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/linguo.rb
+- lib/linguo/config.rb
+- lib/linguo/core_ext/string.rb
+- lib/linguo/detect.rb
+- lib/linguo/errors.rb
+- lib/linguo/version.rb
+- lib/rails/generators/linguo/config_generator.rb
+- linguo.gemspec
+- spec/fixtures/response.json
+- spec/fixtures/wrong_api_key.json
+- spec/linguo/config_spec.rb
+- spec/linguo/core_ext_spec.rb
+- spec/linguo/detect_spec.rb
+- spec/linguo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/narkoz/linguo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3651711047218935527
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3651711047218935527
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Linguo detects the language of a given piece of text
+test_files:
+- spec/fixtures/response.json
+- spec/fixtures/wrong_api_key.json
+- spec/linguo/config_spec.rb
+- spec/linguo/core_ext_spec.rb
+- spec/linguo/detect_spec.rb
+- spec/linguo_spec.rb
+- spec/spec_helper.rb