carrot2 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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Carrot2
+
+Ruby client for Carrot2 - the **awesome** open-source document clustering server
+
+## Usage
+
+Download and run the Carrot2 server. [Great instructions here](http://project.carrot2.org/download-dcs.html)
+
+```ruby
+require "carrot2"
+
+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
+carrot2.cluster(documents)
+```
+
+returns
+
+```ruby
+{
+  "processing-time-total"=>1,
+  "clusters"=> [
+    {
+      "id"=>0,
+      "size"=>3,
+      "phrases"=>["Coupon"],
+      "score"=>0.06462323710740674,
+      "documents"=>[0, 1, 2],
+      "attributes"=>{"score"=>0.06462323710740674}
+    },
+    {
+      "id"=>1,
+      "size"=>2,
+      "phrases"=>["Exclusive"],
+      "score"=>0.05873148311034013,
+      "documents"=>[0, 1],
+      "attributes"=>{"score"=>0.05873148311034013}
+    },
+    {
+      "id"=>2,
+      "size"=>1,
+      "phrases"=>["Other Topics"],
+      "score"=>0.0,
+      "documents"=>[3],
+      "attributes"=>{"other-topics"=>true, "score"=>0.0}
+    }
+  ],
+  "processing-time-algorithm"=>1,
+  "query"=>nil
+}
+```
+
+Documents are numbered in the order provided, starting with 0.
+
+To specify the Carrot2 endpoint, use
+
+```ruby
+carrot2 = Carrot2.new("http://localhost:8080/dcs/rest") # default
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/carrot2.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+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.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
+
+  gem.add_dependency "builder"
+  gem.add_dependency "rest-client"
+end

data/lib/carrot2.rb

@@ -0,0 +1,37 @@
+require "carrot2/version"
+require "builder"
+require "rest-client"
+require "json"
+
+class Carrot2
+
+  def initialize(endpoint = "http://localhost:8080/dcs/rest")
+    @endpoint = endpoint
+  end
+
+  def cluster(documents)
+    xml = Builder::XmlMarkup.new
+    xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+    xml.searchresult do |s|
+      documents.each do |document|
+        s.document do |d|
+          d.title document
+        end
+      end
+    end
+
+    params = {
+      "dcs.output.format" => "JSON",
+      "dcs.clusters.only" => true,
+      "dcs.c2stream" => xml.target!,
+      :multipart => true
+    }
+    response = RestClient.post @endpoint, params
+    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

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

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: carrot2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-21 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'
+description: Ruby client for Carrot2
+email:
+- acekane1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- carrot2.gemspec
+- lib/carrot2.rb
+- lib/carrot2/version.rb
+homepage: ''
+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: 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
+signing_key: 
+specification_version: 3
+summary: Ruby client for Carrot2
+test_files: []