carrot2 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df9af6b5e399ac7f765c9d63d868c75414e0ff0a
+  data.tar.gz: 86addac3d8e7f071be5c04c3bd23d67ddb472acd
+SHA512:
+  metadata.gz: e7606bd9caf52138a4e25f50d0019495bd8a9fc9ec7c0a79ca85789a8869a2490ff6275d2f72dca160a78c4cb5056bd5c317255416f5fe308e74259822b4570e
+  data.tar.gz: ec8b17439d0a30259d6791cd5d2f287f03e36f485457e1551038925e43c76bc146a6ecb16ed1de4bbddbb3e0c34c2c276244503e52dd49c505c2efc22d165d04

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.1.0
+
+- Added support for env var
+- Added tests
+
+## 0.0.1
+
+- First version

data/Gemfile

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

data/README.md

@@ -1,14 +1,20 @@
 # Carrot2
 
-Ruby client for Carrot2 - the **awesome** open-source document clustering server
+Ruby client for [Carrot2](http://project.carrot2.org/) - the open-source document clustering server
 
-## Usage
+## Installation
 
-Download and run the Carrot2 server. [Great instructions here](http://project.carrot2.org/download-dcs.html)
+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`.
+
+Then add this line to your application’s Gemfile:
 
 ```ruby
-require "carrot2"
+gem 'carrot2'
+```
 
+## How to Use
+
+```ruby
 documents = [
   "Sign up for an exclusive coupon.",
   "Exclusive members get a free coupon.",
@@ -58,16 +64,35 @@ returns
 
 Documents are numbered in the order provided, starting with 0.
 
-To specify the Carrot2 endpoint, use
+To specify the Carrot2 server, set `ENV["CARROT2_URL"]` or use:
 
 ```ruby
-carrot2 = Carrot2.new("http://localhost:8080/dcs/rest") # default
+Carrot2.new(url: "http://localhost:8080")
 ```
 
+## Heroku
+
+Carrot2 can be easily deployed to Heroku thanks to support for [WAR deployment](https://devcenter.heroku.com/articles/war-deployment).
+
+You can find the `.war` file in the `war` directory in the dcs download. Then run:
+
+```sh
+heroku plugins:install heroku-cli-deploy
+heroku create <app_name>
+heroku war:deploy carrot2-dcs.war --app <app_name>
+```
+
+And set `ENV["CARROT2_URL"]` in your application.
+
+## History
+
+View the [changelog](https://github.com/ankane/carrot2/blob/master/CHANGELOG.md)
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/carrot2/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/carrot2/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -1,2 +1,9 @@
-#!/usr/bin/env rake
 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,20 +1,24 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/carrot2/version', __FILE__)
+require File.expand_path("../lib/carrot2/version", __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Andrew Kane"]
-  gem.email         = ["acekane1@gmail.com"]
-  gem.description   = %q{Ruby client for Carrot2}
-  gem.summary       = %q{Ruby client for Carrot2}
-  gem.homepage      = ""
+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"
 
-  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          = "carrot2"
-  gem.require_paths = ["lib"]
-  gem.version       = Carrot2::VERSION
+  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
 
-  gem.add_dependency "builder"
-  gem.add_dependency "rest-client"
+  spec.add_dependency "builder"
+  spec.add_dependency "rest-client"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/lib/carrot2.rb

@@ -4,14 +4,16 @@ require "rest-client"
 require "json"
 
 class Carrot2
+  def initialize(url: nil)
+    @url = url || ENV["CARROT2_URL"] || "http://localhost:8080"
 
-  def initialize(endpoint = "http://localhost:8080/dcs/rest")
-    @endpoint = endpoint
+    # add dcs/rest
+    @url = "#{@url.sub(/\/\z/, "")}/dcs/rest"
   end
 
-  def cluster(documents)
+  def cluster(documents, opts = {})
     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|
@@ -24,14 +26,14 @@ class Carrot2
       "dcs.output.format" => "JSON",
       "dcs.clusters.only" => true,
       "dcs.c2stream" => xml.target!,
-      :multipart => true
+      "MultilingualClustering.defaultLanguage" => opts[:language] || "ENGLISH",
+      multipart: true
     }
-    response = RestClient.post @endpoint, params
+    response = RestClient.post(@url, params) { |response, request, result| response }
     if response.code == 200
       JSON.parse(response.body)
     else
       raise "Bad response code from Carrot2 server: #{response.code}"
     end
   end
-
 end

data/lib/carrot2/version.rb

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

data/test/carrot2_test.rb

@@ -0,0 +1,15 @@
+require_relative "test_helper"
+
+class Carrot2Test < Minitest::Test
+  def test_basic
+    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."
+    ]
+
+    carrot2 = Carrot2.new
+    assert_equal ["Coupon", "Exclusive", "Other Topics"], carrot2.cluster(documents)["clusters"].map { |c| c["phrases"].first }
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -1,56 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: carrot2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby client for Carrot2
 email:
-- acekane1@gmail.com
+- andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -58,34 +96,31 @@ files:
 - carrot2.gemspec
 - lib/carrot2.rb
 - lib/carrot2/version.rb
-homepage: ''
+- test/carrot2_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ankane/carrot2
 licenses: []
+metadata: {}
 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: 389504047466366044
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 389504047466366044
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.6.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby client for Carrot2
-test_files: []
+test_files:
+- test/carrot2_test.rb
+- test/test_helper.rb