carrot2 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7c82346a7d8fedbd0b875e1a755d5a16a1a2a28c680e7f71c1b7bebe9603ef8
-  data.tar.gz: b6493deebcce2d05039ba1c6546e4725f4fbc52d0d35f15583d1d49e6e9d086a
+  metadata.gz: e7d773ee688b36ada2bbf8e9a0995b7fc0e4de31a8f9efdcf5eb2fa339618bc2
+  data.tar.gz: 2cb79abc0d6d171a5dbc4c3b43fdfdb8584e26f662c2d73290b3397610d45a5b
 SHA512:
-  metadata.gz: 8587ddd05ff3d8c2d491b25c7a10bea228b92a198d18bdd788c03f44c40a89bdffa39cd7ac65b2ec59828c043cbceb4c2a127f2df961c83733440952e9201c23
-  data.tar.gz: f91d543e01915d25586b874970996f50c54a25ac4fd39d5a0a0bfb1a3e1aec84c992b60edea4acfc6073ffef5edef969bbce0174d7f32845bdf6d420a3b66596
+  metadata.gz: ac3db2a5e50d70846d4b67f515ec2e5d3f8d9671080ec92da482d27a5479bfe86b19e1554e32350f984f7f452fdf8eb2de09ef54a0d22729a1c45a9cd1382536
+  data.tar.gz: f781ba26e50e70b53d8fcbdbcc1641112397471cf17eee88ca5e5306cb23fcb6385246aca48c28ca76583d40df6a855673a4eecc62ead65f0e95816a765308ab

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.5.0 (2024-10-22)
+
+- Dropped support for Ruby < 3.1
+
+## 0.4.0 (2022-08-28)
+
+- Dropped support for Ruby < 2.7
+
 ## 0.3.0 (2020-07-29)
 
 - Added support for Carrot2 4

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2020 Andrew Kane
+Copyright (c) 2012-2023 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,8 +1,8 @@
-# Carrot2
+# Carrot2 Ruby
 
 Ruby client for [Carrot2](https://github.com/carrot2/carrot2) - the open-source document clustering server
 
-[![Build Status](https://travis-ci.org/ankane/carrot2.svg?branch=master)](https://travis-ci.org/ankane/carrot2)
+[![Build Status](https://github.com/ankane/carrot2-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/carrot2-ruby/actions)
 
 ## Installation
 
@@ -16,10 +16,10 @@ brew services start carrot2
 Then add this line to your application’s Gemfile:
 
 ```ruby
-gem 'carrot2'
+gem "carrot2"
 ```
 
-The latest version works with Carrot2 4. For Carrot2 3, use version 0.2.1 and [this readme](https://github.com/ankane/carrot2/blob/v0.2.1/README.md).
+The latest version works with Carrot2 4. For Carrot2 3, use version 0.2.1 and [this readme](https://github.com/ankane/carrot2-ruby/blob/v0.2.1/README.md).
 
 ## How to Use
 
@@ -33,7 +33,7 @@ documents = [
   "This is completely unrelated to the other documents."
 ]
 
-carrot2 = Carrot2.new
+carrot2 = Carrot2::Client.new
 carrot2.cluster(documents)
 ```
 
@@ -103,13 +103,13 @@ carrot2.cluster(documents, template: "lingo")
 To specify the Carrot2 server, set `ENV["CARROT2_URL"]` or use:
 
 ```ruby
-Carrot2.new(url: "http://localhost:8080")
+Carrot2::Client.new(url: "http://localhost:8080")
 ```
 
 Set timeouts
 
 ```ruby
-Carrot2.new(open_timeout: 3, read_timeout: 5)
+Carrot2::Client.new(open_timeout: 3, read_timeout: 5)
 ```
 
 ## Resources
@@ -118,22 +118,22 @@ Carrot2.new(open_timeout: 3, read_timeout: 5)
 
 ## History
 
-View the [changelog](https://github.com/ankane/carrot2/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/carrot2-ruby/blob/master/CHANGELOG.md)
 
 ## Contributing
 
 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)
+- [Report bugs](https://github.com/ankane/carrot2-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/carrot2-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 To get started with development:
 
 ```sh
-git clone https://github.com/ankane/carrot2.git
-cd carrot2
+git clone https://github.com/ankane/carrot2-ruby.git
+cd carrot2-ruby
 bundle install
 bundle exec rake test
 ```

data/lib/carrot2/client.rb

@@ -0,0 +1,74 @@
+module Carrot2
+  class Client
+    HEADERS = {
+      "Content-Type" => "application/json",
+      "Accept" => "application/json"
+    }
+
+    def initialize(url: nil, open_timeout: 3, read_timeout: nil)
+      url ||= ENV["CARROT2_URL"] || "http://localhost:8080"
+      @uri = URI.parse(url)
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = true if @uri.scheme == "https"
+      @http.open_timeout = open_timeout if open_timeout
+      @http.read_timeout = read_timeout if read_timeout
+    end
+
+    def list
+      get("service/list")
+    end
+
+    def cluster(documents, language: nil, algorithm: nil, parameters: nil, template: nil)
+      # no defaults if template
+      unless template
+        language ||= "English"
+        algorithm ||= "Lingo"
+        parameters ||= {}
+      end
+
+      # data
+      data = {
+        documents: documents.map { |v| v.is_a?(String) ? {field: v} : v }
+      }
+      data[:language] = language if language
+      data[:algorithm] = algorithm if algorithm
+      data[:parameters] = parameters if parameters
+
+      # path
+      path = "service/cluster"
+      path = "#{path}?#{URI.encode_www_form(template: template)}" if template
+
+      post(path, data)
+    end
+
+    private
+
+    def get(path)
+      handle_response do
+        @http.get("#{@uri.request_uri.chomp("/")}/#{path}", HEADERS)
+      end
+    end
+
+    def post(path, data)
+      handle_response do
+        @http.post("#{@uri.request_uri.chomp("/")}/#{path}", data.to_json, HEADERS)
+      end
+    end
+
+    def handle_response
+      begin
+        response = yield
+      rescue Errno::ECONNREFUSED => e
+        raise Carrot2::Error, e.message
+      end
+
+      unless response.kind_of?(Net::HTTPSuccess)
+        body = JSON.parse(response.body) rescue {}
+        message = body["message"] || "Bad response: #{response.code}"
+        raise Carrot2::Error, message
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/carrot2/version.rb

@@ -1,3 +1,3 @@
-class Carrot2
-  VERSION = "0.3.0"
+module Carrot2
+  VERSION = "0.5.0"
 end

data/lib/carrot2.rb

@@ -1,81 +1,15 @@
-# dependencies
+# stdlib
 require "json"
 require "net/http"
 
 # modules
-require "carrot2/version"
+require_relative "carrot2/client"
+require_relative "carrot2/version"
 
-class Carrot2
+module Carrot2
   class Error < StandardError; end
 
-  HEADERS = {
-    "Content-Type" => "application/json",
-    "Accept" => "application/json"
-  }
-
-  def initialize(url: nil, open_timeout: 3, read_timeout: nil)
-    url ||= ENV["CARROT2_URL"] || "http://localhost:8080"
-    @uri = URI.parse(url)
-    @http = Net::HTTP.new(@uri.host, @uri.port)
-    @http.use_ssl = true if @uri.scheme == "https"
-    @http.open_timeout = open_timeout if open_timeout
-    @http.read_timeout = read_timeout if read_timeout
-  end
-
-  def list
-    get("service/list")
-  end
-
-  def cluster(documents, language: nil, algorithm: nil, parameters: nil, template: nil)
-    # no defaults if template
-    unless template
-      language ||= "English"
-      algorithm ||= "Lingo"
-      parameters ||= {}
-    end
-
-    # data
-    data = {
-      documents: documents.map { |v| v.is_a?(String) ? {field: v} : v }
-    }
-    data[:language] = language if language
-    data[:algorithm] = algorithm if algorithm
-    data[:parameters] = parameters if parameters
-
-    # path
-    path = "service/cluster"
-    path = "#{path}?#{URI.encode_www_form(template: template)}" if template
-
-    post(path, data)
-  end
-
-  private
-
-  def get(path)
-    handle_response do
-      @http.get("#{@uri.request_uri.chomp("/")}/#{path}", HEADERS)
-    end
-  end
-
-  def post(path, data)
-    handle_response do
-      @http.post("#{@uri.request_uri.chomp("/")}/#{path}", data.to_json, HEADERS)
-    end
-  end
-
-  def handle_response
-    begin
-      response = yield
-    rescue Errno::ECONNREFUSED => e
-      raise Carrot2::Error, e.message
-    end
-
-    unless response.kind_of?(Net::HTTPSuccess)
-      body = JSON.parse(response.body) rescue {}
-      message = body["message"] || "Bad response: #{response.code}"
-      raise Carrot2::Error, message
-    end
-
-    JSON.parse(response.body)
+  def self.new(**options)
+    Client.new(**options)
   end
 end

metadata

@@ -1,59 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: carrot2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
-dependencies:
-- !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: 
-email: andrew@chartkick.com
+date: 2024-10-23 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -62,12 +20,13 @@ files:
 - LICENSE.txt
 - README.md
 - lib/carrot2.rb
+- lib/carrot2/client.rb
 - lib/carrot2/version.rb
-homepage: https://github.com/ankane/carrot2
+homepage: https://github.com/ankane/carrot2-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,15 +34,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: Ruby client for Carrot2
 test_files: []