carrot2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df9af6b5e399ac7f765c9d63d868c75414e0ff0a
-  data.tar.gz: 86addac3d8e7f071be5c04c3bd23d67ddb472acd
+  metadata.gz: 33734687ea74c1750a823b92eb21648910a7c11c
+  data.tar.gz: 3683ea29b97fa311a23919048d49b2c4c3784701
 SHA512:
-  metadata.gz: e7606bd9caf52138a4e25f50d0019495bd8a9fc9ec7c0a79ca85789a8869a2490ff6275d2f72dca160a78c4cb5056bd5c317255416f5fe308e74259822b4570e
-  data.tar.gz: ec8b17439d0a30259d6791cd5d2f287f03e36f485457e1551038925e43c76bc146a6ecb16ed1de4bbddbb3e0c34c2c276244503e52dd49c505c2efc22d165d04
+  metadata.gz: 8c87a0029e7d304717778fc7fadeee896895cb412524e7fe0d435aec2f84308cbd9d6967481abd8493dff75303024bcdd467b33f7f25947931c8702f261d0f6c
+  data.tar.gz: 5028411dc8eb0bf3a5629824e9fba106846f2759a3c687a43fa5d19636b1cce0bc9b564daf5ab2b0e23ab2a6ca318061345584c0641db0933d7e5b834dc70e39

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.0
+
+- Added `request` method
+- Removed dependency on `rest-client`
+- Better error messages
+
 ## 0.1.0
 
 - Added support for env var

data/README.md

@@ -6,6 +6,13 @@ Ruby client for [Carrot2](http://project.carrot2.org/) - the open-source documen
 
 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`.
 
+With Homebrew, use:
+
+```sh
+brew install carrot2
+brew services start carrot2
+```
+
 Then add this line to your application’s Gemfile:
 
 ```ruby
@@ -14,6 +21,8 @@ gem 'carrot2'
 
 ## How to Use
 
+To cluster documents, use:
+
 ```ruby
 documents = [
   "Sign up for an exclusive coupon.",
@@ -26,7 +35,7 @@ carrot2 = Carrot2.new
 carrot2.cluster(documents)
 ```
 
-returns
+This returns:
 
 ```ruby
 {
@@ -64,6 +73,16 @@ returns
 
 Documents are numbered in the order provided, starting with 0.
 
+For other requests, use:
+
+```ruby
+carrot2.request(
+  "dcs.c2stream" => xml_str
+)
+```
+
+## Configuration
+
 To specify the Carrot2 server, set `ENV["CARROT2_URL"]` or use:
 
 ```ruby

data/carrot2.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
   spec.version       = Carrot2::VERSION
 
   spec.add_dependency "builder"
-  spec.add_dependency "rest-client"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

data/lib/carrot2.rb

@@ -1,19 +1,22 @@
 require "carrot2/version"
 require "builder"
-require "rest-client"
+require "net/http"
 require "json"
 
 class Carrot2
+  class Error < StandardError; end
+
   def initialize(url: nil)
     @url = url || ENV["CARROT2_URL"] || "http://localhost:8080"
 
     # add dcs/rest
     @url = "#{@url.sub(/\/\z/, "")}/dcs/rest"
+    @uri = URI.parse(@url)
   end
 
-  def cluster(documents, opts = {})
+  def cluster(documents, language: "ENGLISH")
     xml = Builder::XmlMarkup.new
-    xml.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
+    xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
     xml.searchresult do |s|
       documents.each do |document|
         s.document do |d|
@@ -22,18 +25,24 @@ class Carrot2
       end
     end
 
-    params = {
-      "dcs.output.format" => "JSON",
+    request(
       "dcs.clusters.only" => true,
       "dcs.c2stream" => xml.target!,
-      "MultilingualClustering.defaultLanguage" => opts[:language] || "ENGLISH",
+      "MultilingualClustering.defaultLanguage" => language,
       multipart: true
-    }
-    response = RestClient.post(@url, params) { |response, request, result| response }
-    if response.code == 200
+    )
+  end
+
+  def request(params)
+    response = Net::HTTP.post_form(@uri, params.merge("dcs.output.format" => "JSON"))
+    if response.code == "200"
       JSON.parse(response.body)
     else
-      raise "Bad response code from Carrot2 server: #{response.code}"
+      body = response.body.to_s
+      # try to get reason from title
+      m = body.match(/<title>(.+)<\/title>/)
+      message = m ? m[1] : body
+      raise Carrot2::Error, message
     end
   end
 end

data/lib/carrot2/version.rb

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

data/test/carrot2_test.rb

@@ -1,7 +1,7 @@
 require_relative "test_helper"
 
 class Carrot2Test < Minitest::Test
-  def test_basic
+  def test_cluster
     documents = [
       "Sign up for an exclusive coupon.",
       "Exclusive members get a free coupon.",
@@ -9,7 +9,15 @@ class Carrot2Test < Minitest::Test
       "This is completely unrelated to the other documents."
     ]
 
-    carrot2 = Carrot2.new
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrot2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement