carrot2 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33734687ea74c1750a823b92eb21648910a7c11c
-  data.tar.gz: 3683ea29b97fa311a23919048d49b2c4c3784701
+SHA256:
+  metadata.gz: 73489263c06ae2b8e9f7509570c35c052635340d8401f04d659fe4080188b049
+  data.tar.gz: 891c4d26486b4c39c1cdff7756bb97faea0ff01ae5aceaa8082ed122d4300f6c
 SHA512:
-  metadata.gz: 8c87a0029e7d304717778fc7fadeee896895cb412524e7fe0d435aec2f84308cbd9d6967481abd8493dff75303024bcdd467b33f7f25947931c8702f261d0f6c
-  data.tar.gz: 5028411dc8eb0bf3a5629824e9fba106846f2759a3c687a43fa5d19636b1cce0bc9b564daf5ab2b0e23ab2a6ca318061345584c0641db0933d7e5b834dc70e39
+  metadata.gz: 30e723899e33b4ce32463b52a65b24ac1f1a1fc7a39fec038dfd95c5fad7cdf0bb78555e24fdeff18657905ca194fcc59afded05dc292cfcb06ca7aa919eca59
+  data.tar.gz: 1dae126a035baf128cc7e4ec265259056e1817694b2a61317edc339f4b193a1f0b81c4f08bc80a8d98fda28dd69f4ef12be75f30d2450be55654f33ee8085927

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1
+
+- Added `open_timeout` and `read_timeout` options
+
 ## 0.2.0
 
 - Added `request` method

data/README.md

@@ -1,10 +1,10 @@
 # Carrot2
 
-Ruby client for [Carrot2](http://project.carrot2.org/) - the open-source document clustering server
+Ruby client for [Carrot2](https://project.carrot2.org/) - the open-source document clustering server
 
 ## Installation
 
-First, [download and run](http://project.carrot2.org/download-dcs.html) the Carrot2 server. It’s the one on [this page](https://github.com/carrot2/carrot2/releases) that begins with `carrot2-dcs`.
+First, [download and run](https://project.carrot2.org/download-dcs.html) the Carrot2 server. It’s the one on [this page](https://github.com/carrot2/carrot2/releases) that begins with `carrot2-dcs`.
 
 With Homebrew, use:
 
@@ -73,6 +73,14 @@ This returns:
 
 Documents are numbered in the order provided, starting with 0.
 
+Specify a language with:
+
+```ruby
+carrot2.cluster(documents, language: "FRENCH")
+```
+
+[All of these languages are supported](https://doc.carrot2.org/#section.faq.preliminaries.supported-languages)
+
 For other requests, use:
 
 ```ruby
@@ -89,6 +97,12 @@ To specify the Carrot2 server, set `ENV["CARROT2_URL"]` or use:
 Carrot2.new(url: "http://localhost:8080")
 ```
 
+Set timeouts [master]
+
+```ruby
+Carrot2.new(open_timeout: 3, read_timeout: 5)
+```
+
 ## Heroku
 
 Carrot2 can be easily deployed to Heroku thanks to support for [WAR deployment](https://devcenter.heroku.com/articles/war-deployment).

data/lib/carrot2.rb

@@ -6,15 +6,18 @@ require "json"
 class Carrot2
   class Error < StandardError; end
 
-  def initialize(url: nil)
+  def initialize(url: nil, open_timeout: 3, read_timeout: nil)
     @url = url || ENV["CARROT2_URL"] || "http://localhost:8080"
 
     # add dcs/rest
     @url = "#{@url.sub(/\/\z/, "")}/dcs/rest"
     @uri = URI.parse(@url)
+
+    @open_timeout = open_timeout
+    @read_timeout = read_timeout
   end
 
-  def cluster(documents, language: "ENGLISH")
+  def cluster(documents, language: "English")
     xml = Builder::XmlMarkup.new
     xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
     xml.searchresult do |s|
@@ -28,13 +31,25 @@ class Carrot2
     request(
       "dcs.clusters.only" => true,
       "dcs.c2stream" => xml.target!,
-      "MultilingualClustering.defaultLanguage" => language,
+      "MultilingualClustering.defaultLanguage" => language.upcase,
       multipart: true
     )
   end
 
   def request(params)
-    response = Net::HTTP.post_form(@uri, params.merge("dcs.output.format" => "JSON"))
+    req = Net::HTTP::Post.new(@uri)
+    req.set_form_data(params.merge("dcs.output.format" => "JSON"))
+
+    options = {
+      use_ssl: @uri.scheme == "https"
+    }
+    options[:open_timeout] = @open_timeout if @open_timeout
+    options[:read_timeout] = @read_timeout if @read_timeout
+
+    response = Net::HTTP.start(@uri.hostname, @uri.port, options) do |http|
+      http.request(req)
+    end
+
     if response.code == "200"
       JSON.parse(response.body)
     else

data/lib/carrot2/version.rb

@@ -1,3 +1,3 @@
 class Carrot2
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrot2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -66,26 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby client for Carrot2
-email:
-- andrew@chartkick.com
+description: 
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
-- Rakefile
-- carrot2.gemspec
 - lib/carrot2.rb
 - lib/carrot2/version.rb
-- test/carrot2_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/carrot2
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -95,18 +89,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for Carrot2
-test_files:
-- test/carrot2_test.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.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/Gemfile

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

data/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.warning = false
-end

data/carrot2.gemspec

@@ -1,23 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/carrot2/version", __FILE__)
-
-Gem::Specification.new do |spec|
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.description   = "Ruby client for Carrot2"
-  spec.summary       = "Ruby client for Carrot2"
-  spec.homepage      = "https://github.com/ankane/carrot2"
-
-  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^exe/}).map { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.name          = "carrot2"
-  spec.require_paths = ["lib"]
-  spec.version       = Carrot2::VERSION
-
-  spec.add_dependency "builder"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end

data/test/carrot2_test.rb

@@ -1,23 +0,0 @@
-require_relative "test_helper"
-
-class Carrot2Test < Minitest::Test
-  def test_cluster
-    documents = [
-      "Sign up for an exclusive coupon.",
-      "Exclusive members get a free coupon.",
-      "Coupons are going fast.",
-      "This is completely unrelated to the other documents."
-    ]
-
-    assert_equal ["Coupon", "Exclusive", "Other Topics"], carrot2.cluster(documents)["clusters"].map { |c| c["phrases"].first }
-  end
-
-  def test_bad_request
-    error = assert_raises(Carrot2::Error) { carrot2.request({}) }
-    assert_includes error.message, "Error 400"
-  end
-
-  def carrot2
-    @carrot2 ||= Carrot2.new
-  end
-end

data/test/test_helper.rb

@@ -1,6 +0,0 @@
-require "bundler/setup"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-
-Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)