detect_language 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc5fd49d8ac038b7cdba85373af25db35a0c2ef2
-  data.tar.gz: 32fd418fc9c9d28a4fa82009e25e1f7090a2585b
+SHA256:
+  metadata.gz: 6a4e106f6983e68e391bda11900c37879a48b4c096d4042091f55151b4f14383
+  data.tar.gz: cd9eceaf57be7d1bfe8dc08d55f291975726187c7d82aff60befd37d8a0f1471
 SHA512:
-  metadata.gz: d92c0c5af430c9c476b77b37264e3f6b55743df12c579e697976a22850291dbd82d445ff4cfa21350c234f41c8af64a95a678556d7373b92dc3badba60197779
-  data.tar.gz: 88437b1b6483416bce8e1b114dbe4674394d556f1103ae91d63eed7dc919480bdd07724327c607a8c141cf775537bbbf96614376d981a5b33ac06c4f5e496ebb
+  metadata.gz: ac0f022a7a4b7f9e0c8c2733db1e87a13b906f94ac05a3d8f650a8f07ed91b7ae9db7b5c67ede0a4fb32e1dbb1647331fd840f576e69d420220f6997c35998a7
+  data.tar.gz: 69d86e43675b5680ed4992afbb6cce417a88f96734f6af76fe111753441a29d3ca9eadf6327f496f11802601dcae76e35c6fac424962c65af5ab67cc1daa6a04

data/README.md

@@ -1,88 +1,98 @@
-Detect Language API Client 
+Detect Language API Ruby Client
 ========
 
-[![Gem](https://img.shields.io/gem/v/detect_language.svg)](https://rubygems.org/gems/detect_language)
-[![Build Status](https://secure.travis-ci.org/detectlanguage/detectlanguage-ruby.svg)](http://travis-ci.org/detectlanguage/detectlanguage-ruby)
+[![Gem Version](https://badge.fury.io/rb/detect_language.svg)](https://badge.fury.io/rb/detect_language)
+[![Build Status](https://github.com/detectlanguage/detectlanguage-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/detectlanguage/detectlanguage-ruby/actions)
 
+Detects language of the given text. Returns detected language codes and scores.
 
-Detects language of 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'
+```
+gem 'detect_language'
+```
 
-Or install it yourself as:
+### Upgrading
 
-    $ gem install detect_language
+When upgrading please check [changelog](CHANGELOG.md) for breaking changes.
 
 ### 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"
+Get your personal API key by signing up at https://detectlanguage.com
 
-      # enable secure mode (SSL) if you are passing sensitive data
-      # config.secure = true
-    end
+```ruby
+DetectLanguage.configure do |config|
+  config.api_key = 'YOUR API KEY'
+end
+```
 
 ## Usage
 
-### Language detection
+### Detect language
 
-    DetectLanguage.detect("Buenos dias señor")
+```ruby
+DetectLanguage.detect('Dolce far niente')
+```
 
 #### Result
 
-    [ {"language"=>"es", "isReliable"=>false, "confidence"=>0.3271028037383178},
-      {"language"=>"pt", "isReliable"=>false, "confidence"=>0.08356545961002786} ]
+```ruby
+[{"language" => "it", "score" => 0.5074}]
+```
 
-### Simple language detection
+### Detect single code
 
-If you need just a language code you can use `simple_detect`. It returns just the language code.
+If you need just a language code you can use `detect_code`.
 
-    DetectLanguage.simple_detect("Buenos dias señor")
+```ruby
+DetectLanguage.detect_code('Dolce far niente')
+```
 
 #### Result
 
-    "es"
-
+```ruby
+"it"
+```
 
 ### 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.
+To use batch detection just pass array of texts to `detect_batch` method.
 
-    DetectLanguage.detect(["Buenos dias señor", "Labas rytas"])
+```ruby
+DetectLanguage.detect_batch(['Dolce far niente', 'Labas rytas'])
+```
 
 #### Result
 
 Result is array of detections in the same order as the texts were passed.
 
-    [ [ {"language"=>"es", "isReliable"=>false, "confidence"=>0.3271028037383178},
-        {"language"=>"pt", "isReliable"=>false, "confidence"=>0.08356545961002786} ],
-      [ {"language"=>"lt", "isReliable"=>false, "confidence"=>0.04918032786885246},
-        {"language"=>"lv", "isReliable"=>false, "confidence"=>0.03350083752093803} ] ]
+```ruby
+[[{"language" => "it", "score" => 0.5074}], [{"language" => "lt", "score" => 0.3063}]]
+```
 
-### Getting your account status
+### Get your account status
 
-    DetectLanguage.user_status
+```ruby
+DetectLanguage.account_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"}
+```ruby
+{"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 detectable languages
+### Get list of supported languages
 
-    DetectLanguage.languages
+```ruby
+DetectLanguage.languages
+```
 
 #### Result
 

data/detect_language.gemspec

@@ -2,17 +2,20 @@
 require File.expand_path('../lib/detect_language/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Laurynas Butkus"]
-  gem.email         = ["laurynas.butkus@gmail.com"]
-  gem.description   = %q{Language Detection API Client}
-  gem.summary       = %q{Detects language of given text. Returns detected language codes and scores.}
-  gem.homepage      = "https://github.com/detectlanguage/detectlanguage-ruby"
+  gem.authors = ['Laurynas Butkus']
+  gem.email = ['laurynas.butkus@gmail.com']
+  gem.description = 'Language Detection API Client'
+  gem.summary = 'Detects language of given text. Returns detected language codes and scores.'
+  gem.homepage = 'https://github.com/detectlanguage/detectlanguage-ruby'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "detect_language"
-  gem.require_paths = ["lib"]
-  gem.version       = DetectLanguage::VERSION
-  gem.license       = 'MIT'
+  gem.files = %w(LICENSE README.md detect_language.gemspec)
+  gem.files += Dir.glob('lib/**/*.{rb}')
+
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name = 'detect_language'
+  gem.require_paths = ['lib']
+  gem.version = DetectLanguage::VERSION
+  gem.license = 'MIT'
+  gem.required_ruby_version = '>= 2.0.0'
 end

data/lib/detect_language/client.rb

@@ -1,44 +1,37 @@
-require 'cgi'
 require 'net/http'
 require 'net/https'
 require 'json'
 
 module DetectLanguage
   class Client
-    attr_reader :configuration
+    attr_reader :config
 
-    def initialize(configuration)
-      @configuration = configuration
+    def initialize(config)
+      @config = config
     end
 
-    def post(method, params = {})
-      execute(method, params, :http_method => Net::HTTP::Post)
+    def post(path, payload = {})
+      execute(Net::HTTP::Post, path, body: payload.to_json)
     end
 
-    def get(method, params = {})
-      execute(method, params, :http_method => Net::HTTP::Get)
+    def get(path)
+      execute(Net::HTTP::Get, path)
     end
 
     private
 
-    def execute(method, params, options)
-      http            = setup_http_connection
-      http_method     = options[:http_method]
-      request         = http_method.new(request_uri(method))
+    def execute(method, path, body: nil)
+      request = method.new(base_uri.path + path)
+      request.body = body
 
-      if RUBY_VERSION == '1.8.7'
-        set_form_data_18(request, params)
-      else
-        request.set_form_data(params)
-      end
-
-      request.add_field('Authorization', 'Bearer ' + configuration.api_key.to_s)
-      request.add_field('User-Agent', configuration.user_agent)
+      request['Content-Type'] = 'application/json'
+      request['Authorization'] = 'Bearer ' + config.api_key.to_s
+      request['User-Agent'] = config.user_agent
 
-      response = http.request(request)
+      response = connection.request(request)
 
       case response
-      when Net::HTTPSuccess, Net::HTTPUnauthorized then
+      when Net::HTTPSuccess, Net::HTTPUnauthorized
         parse_response(response.body)
       else
         raise(Error, "Failure: #{response.class}")
@@ -55,44 +48,28 @@ module DetectLanguage
       end
     end
 
-    def request_uri(method)
-      "/#{configuration.api_version}/#{method}"
+    def base_uri
+      @base_uri ||= URI(config.base_url)
     end
 
-    def setup_http_connection
-      http =
-        Net::HTTP::Proxy(configuration.proxy_host, configuration.proxy_port, configuration.proxy_user,
-                         configuration.proxy_pass).
-          new(configuration.host, configuration.port)
-
-      http.read_timeout = configuration.http_read_timeout
-      http.open_timeout = configuration.http_open_timeout
+    def connection
+      @connection ||= setup_connection
+    end
 
-      if configuration.secure?
-        http.use_ssl      = true
-        http.verify_mode  = OpenSSL::SSL::VERIFY_PEER
+    def setup_connection
+      http = if config.proxy
+        proxy = URI(config.proxy)
+        Net::HTTP.new(base_uri.hostname, base_uri.port, proxy.hostname, proxy.port, proxy.user, proxy.password)
       else
-        http.use_ssl      = false
+        Net::HTTP.new(base_uri.hostname, base_uri.port)
       end
 
-      http
-    end
-
-    def set_form_data_18(request, params, sep = '&')
-      request.body = params.map {|k,v|
-        if v.instance_of?(Array)
-          v.map {|e| "#{urlencode(k.to_s)}=#{urlencode(e.to_s)}"}.join(sep)
-        else
-          "#{urlencode(k.to_s)}=#{urlencode(v.to_s)}"
-        end
-      }.join(sep)
-
-      request.content_type = 'application/x-www-form-urlencoded'
-    end
+      http.use_ssl = base_uri.scheme == 'https'
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER if http.use_ssl?
+      http.read_timeout = config.http_read_timeout
+      http.open_timeout = config.http_open_timeout
 
-    def urlencode(str)
-      CGI::escape(str)
+      http
     end
-
   end
 end

data/lib/detect_language/configuration.rb

@@ -1,83 +1,28 @@
 module DetectLanguage
   class Configuration
-    # The API key for your project, found on your homepage after you login into detectlanguage.com website
-    # Defaults to 'demo', which has a limited number of requests.
+    # The API key for your project, found on your homepage after you log in into
+    # https://detectlanguage.com website
     attr_accessor :api_key
 
-    # The API version you are using (defaults to 0.2).
-    attr_accessor :api_version
+    # API base URL
+    attr_accessor :base_url
 
     # HTTP request user agent (defaults to 'Detect Language API ruby gem').
     attr_accessor :user_agent
 
-    # The host to connect to (defaults to ws.detectlanguage.com).
-    attr_accessor :host
-
-    # The port on which your DetectLanguage server runs (defaults to 443 for secure
-    # connections, 80 for insecure connections).
-    attr_accessor :port
-
-    # +true+ for https connections, +false+ for http connections.
-    attr_accessor :secure
-
     # The HTTP open timeout in seconds.
     attr_accessor :http_open_timeout
 
     # The HTTP read timeout in seconds.
     attr_accessor :http_read_timeout
 
-    # The hostname of your proxy server (if using a proxy).
-    attr_accessor :proxy_host
-
-    # The port of your proxy server (if using a proxy).
-    attr_accessor :proxy_port
-
-    # The username to use when logging into your proxy server (if using a proxy).
-    attr_accessor :proxy_user
-
-    # The password to use when logging into your proxy server (if using a proxy).
-    attr_accessor :proxy_pass
-
-    alias_method :secure?, :secure
+    # The HTTP proxy to use for requests. Example: 'http://my-proxy:8080'
+    attr_accessor :proxy
 
     def initialize
-      @api_key            = nil
-      @api_version        = "0.2"
-      @host               = "ws.detectlanguage.com"
-      @user_agent         = "Detect Language API ruby gem"
-    end
-
-    def protocol
-      if secure?
-        'https'
-      else
-        'http'
-      end
+      @api_key = nil
+      @base_url = "https://ws.detectlanguage.com/v3/"
+      @user_agent = "detectlanguage-ruby/#{VERSION}"
     end
-
-    def port
-      @port || default_port
-    end
-
-    # Allows config options to be read like a hash
-    #
-    # @param [Symbol] option Key for a given attribute
-    def [](option)
-      send(option)
-    end
-
-    private
-
-    # Determines what port should we use for sending requests.
-    # @return [Fixnum] Returns 443 if you've set secure to true in your
-    # configuration, and 80 otherwise.
-    def default_port
-      if secure?
-        443
-      else
-        80
-      end
-    end
-
   end
-end
+end

data/lib/detect_language/version.rb

@@ -1,3 +1,3 @@
 module DetectLanguage
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end

data/lib/detect_language.rb

@@ -5,44 +5,81 @@ require "detect_language/client"
 
 module DetectLanguage
   class << self
-    attr_writer :configuration
+    attr_writer :config
 
     def configure
-      yield(configuration)
+      yield(config)
     end
 
-    # The configuration object.
-    # @see DetectLanguage.configure
-    def configuration
-      @configuration ||= Configuration.new
+    def config
+      @config ||= Configuration.new
     end
 
     def client
-      Thread.current[:detect_language_client] ||= Client.new(configuration)
+      Thread.current[:detect_language_client] ||= Client.new(config)
     end
 
-    def detect(data)
-      key = data.is_a?(Array) ? 'q[]' : 'q'
-      result = client.post(:detect, key => data)
-      result['data']['detections']
+    def client=(client)
+      Thread.current[:detect_language_client] = client
     end
 
-    def simple_detect(text)
+    # @param query String
+    # @return [Array<Hash>] Array of language detections
+    def detect(query)
+      if query.is_a?(Array)
+        warn '[DEPRECATED] `DetectLanguage.detect` with an array of queries is deprecated. Use `DetectLanguage.detect_batch` instead.'
+        return detect_batch(query)
+      end
+
+      client.post('detect', q: query)
+    end
+
+    # @param queries Array<String> Array of queries to detect languages for
+    # @return [Array<Array<Hash>>] Array of language detections for each query
+    def detect_batch(queries)
+      raise(ArgumentError, 'Expected an Array of queries') unless queries.is_a?(Array)
+
+      client.post('detect-batch', q: queries)
+    end
+
+    # @param text String
+    # @return [String, nil] Detected language code or nil if no detection found
+    def detect_code(text)
       detections = detect(text)
 
-      if detections.empty?
-        nil
-      else
-        detections[0]['language']
-      end
+      return if detections.empty?
+
+      detections[0]['language']
     end
 
-    def user_status
-      client.get('user/status')
+    # @return [Hash] Account status information
+    def account_status
+      client.get('account/status')
     end
 
+    # @return [Array<Hash>] List of supported languages
     def languages
       client.get('languages')
     end
+
+    ### DEPRECATED METHODS
+
+    # @deprecated Use `DetectLanguage.config` instead
+    def configuration
+      warn '[DEPRECATED] `DetectLanguage.configuration` is deprecated. Use `DetectLanguage.config` instead.'
+      config
+    end
+
+    # @deprecated Use `detect_code` instead
+    def simple_detect(text)
+      warn '[DEPRECATED] `DetectLanguage.simple_detect` is deprecated. Use `DetectLanguage.detect_code` instead.'
+      detect_code(text)
+    end
+
+    # @deprecated Use `DetectLanguage.account_status` instead
+    def user_status
+      warn '[DEPRECATED] `DetectLanguage.user_status` is deprecated. Use `DetectLanguage.account_status` instead.'
+      account_status
+    end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: detect_language
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Laurynas Butkus
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Language Detection API Client
 email:
@@ -17,26 +16,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - detect_language.gemspec
 - lib/detect_language.rb
 - lib/detect_language/client.rb
 - lib/detect_language/configuration.rb
 - lib/detect_language/errors.rb
 - lib/detect_language/version.rb
-- spec/detect_language_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/detectlanguage/detectlanguage-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -44,18 +35,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Detects language of given text. Returns detected language codes and scores.
-test_files:
-- spec/detect_language_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,15 +0,0 @@
-rvm:
-- 1.9.3
-- 2.0.0
-- 2.1.1
-- 2.3.4
-- 2.4.1
-- 2.5.0
-- ruby-head
-- ruby-head-clang
-- jruby-1.7.26
-- jruby-9.1.9.0
-script: bundle exec rake spec
-env:
-  global:
-    secure: Xt9aOp3jO9r7e+ljIRJSIZwifiYXzirp0wZ3GbsQ8zOd5vmIjIehReu+7e4fRm1/Wfp8q85Yl5otYPxa2HOeDl67aA9WIiCvSH8cSb4QrM6jahAc9T2td5io9GSiWPWaQiA3Th8dOOuPmBaiLWgBZ9k9MzMMJ5lj1F1whW6gTEE=

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-gem 'json'
-
-group :test do
-  gem "rspec"
-end

data/Rakefile

@@ -1,7 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new
-
-task :default => :spec

data/spec/detect_language_spec.rb

@@ -1,98 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-describe DetectLanguage do
-
-  let(:api_key) { ENV['DETECTLANGUAGE_API_KEY'] }
-
-  before do
-    DetectLanguage.configuration.api_key = api_key
-  end
-
-  context "configuration" do
-    it "should have default configuration values" do
-      subject.configuration.api_version.should == '0.2'
-      subject.configuration.host.should == 'ws.detectlanguage.com'
-      subject.configuration.user_agent.should == 'Detect Language API ruby gem'
-    end
-
-    it "should allow configuring" do
-      subject.configure do |config|
-        config.user_agent = "Detect Language testing"
-      end
-
-      subject.configuration.user_agent.should == "Detect Language testing"
-    end
-  end
-
-  context 'invalid api key' do
-    let(:api_key) {'invalid'}
-
-    it "should raise exception for invalid key" do
-      lambda {
-        subject.detect("Hello world")
-      }.should raise_error(DetectLanguage::Error)
-    end
-  end
-
-  context "detection" do
-    it "should detect languages" do
-      result = subject.detect("Hello world")
-      result[0]['language'].should == "en"
-
-      result = subject.detect("Jau saulelė vėl atkopdama budino svietą")
-      result[0]['language'].should == "lt"
-    end
-
-    it "should have simple way to detect a language" do
-      subject.simple_detect("Hello world").should == "en"
-    end
-
-    it "should allow sending batch requests" do
-      result = subject.detect(["Hello world", "Jau saulelė vėl atkopdama budino svietą"])
-
-      result[0][0]['language'].should == "en"
-      result[1][0]['language'].should == "lt"
-    end
-
-    it "with empty text in the batch it detects correctly" do
-      result = subject.detect(["", "Hello", "Jau saulelė vėl atkopdama budino svietą"])
-
-      result[0].should be_empty
-      result[1][0]['language'].should == "en"
-      result[2][0]['language'].should == "lt"
-    end
-
-    context 'secure mode' do
-      before { DetectLanguage.configuration.secure = true }
-      after { DetectLanguage.configuration.secure = false }
-
-      it "detects language" do
-        result = subject.detect("Hello world")
-        result[0]['language'].should == "en"
-      end
-    end
-  end
-
-  describe '.user_status' do
-    subject(:user_status) {DetectLanguage.user_status}
-
-    it 'fetches user status' do
-      expect(user_status['date']).to be_kind_of(String)
-      expect(user_status['requests']).to be_kind_of(Integer)
-      expect(user_status['bytes']).to be_kind_of(Integer)
-      expect(user_status['plan']).to be_kind_of(String)
-      expect(user_status['daily_requests_limit']).to be_kind_of(Integer)
-      expect(user_status['daily_bytes_limit']).to be_kind_of(Integer)
-    end
-  end
-
-  describe '.languages' do
-    subject(:languages) {DetectLanguage.languages}
-
-    it 'fetches list of detectable languages' do
-      expect(languages).to include({ 'code' => 'en', 'name' => 'ENGLISH' })
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'detect_language'
-
-RSpec.configure do |config|
-
-end