gorse 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1508be3a15a7aefd31a677989145e16c1ecc19633abb8cc173f462a6ea924f
-  data.tar.gz: 3bac22cda6b6684942fa60591e3c52fffcd6774ee7e22624ad094c324d4dee5d
+  metadata.gz: 842507a7200f7259e97c07f2a6e9f530013a5711a9572e426c21552786f18603
+  data.tar.gz: 2b62c853f688dd49687b8dfcd1bdc56a5a33cb29dc978c3e405b6919a3ab3e83
 SHA512:
-  metadata.gz: 1369d41be05ce573fba6846d7c96b820c592fe41bc9ee3e0b4a557fbe1ddce6984eeeddb69fda494b9a6700e51afe64c861c73d41249db2c3e18e75cc0f5698c
-  data.tar.gz: aadef649c5fa603a2614f18a152ed923de9361d0e73fbc521365e840014883b8ab7a2160e9d1a1f1ca627b8cbdb5841ad4ff4594862b5d8c6db4b59cf6c6b47a
+  metadata.gz: b6885854bd2236f9f099a9edafb2e6171c96b8766ec9228743fb697ef05436807df0fd86e3386a9bf50e356d2fb51049f4283b7b7450bbd906f0f307110512e0
+  data.tar.gz: 49f611ef4d496254942bf4f90bb01cdfdf402435e3748df08232f9b276f6faef4d342e8ff68f48e1b8d247eb4f092b684868757a9fdef49f1c097daa8085e643

data/lib/gorse.rb

@@ -1,21 +1,26 @@
 require 'json'
 require 'net/http'
+require 'uri'
+require 'time'
 
 class Feedback
-  def initialize(feedback_type, user_id, item_id, timestamp)
+  def initialize(feedback_type, user_id, item_id, value, timestamp)
     @feedback_type = feedback_type
     @user_id = user_id
     @item_id = item_id
+    @value = value
     @timestamp = timestamp
   end
 
   def to_json(options = {})
-    {
+    data = {
       'FeedbackType' => @feedback_type,
       'UserId' => @user_id,
       'ItemId' => @item_id,
-      'Timestamp' => @timestamp
-    }.to_json(options)
+    }
+    data['Value'] = @value unless @value.nil?
+    data['Timestamp'] = @timestamp
+    JSON.generate(data)
   end
 end
 
@@ -32,6 +37,155 @@ class RowAffected
   attr_reader :row_affected
 end
 
+class Score
+  def initialize(id, score)
+    @id = id
+    @score = score
+  end
+
+  def self.from_json(string)
+    data = JSON.load string
+    data.map { |h| Score.new(h['Id'], h['Score']) }
+  end
+
+  attr_reader :id, :score
+end
+
+class User
+  def initialize(user_id:, labels: nil, comment: nil)
+    @user_id = user_id
+    @labels = labels
+    @comment = comment
+  end
+
+  def to_h
+    { 'UserId' => @user_id, 'Labels' => @labels, 'Comment' => @comment }
+  end
+
+  def to_json(*_args)
+    JSON.generate(to_h)
+  end
+
+  def self.from_json(string)
+    h = JSON.load string
+    User.new(user_id: h['UserId'], labels: h['Labels'], comment: h['Comment'])
+  end
+
+  attr_reader :user_id, :labels, :comment
+end
+
+class UserPatch
+  def initialize(labels: nil, comment: nil)
+    @labels = labels
+    @comment = comment
+  end
+
+  def to_json(*_args)
+    data = {}
+    data['Labels'] = @labels unless @labels.nil?
+    data['Comment'] = @comment unless @comment.nil?
+    JSON.generate(data)
+  end
+end
+
+class UserIterator
+  def initialize(cursor, users)
+    @cursor = cursor
+    @users = users
+  end
+
+  def self.from_json(string)
+    h = JSON.load string
+    users = (h['Users'] || []).map { |u| User.new(user_id: u['UserId'], labels: u['Labels'], comment: u['Comment']) }
+    UserIterator.new(h['Cursor'], users)
+  end
+
+  attr_reader :cursor, :users
+end
+
+class Item
+  def initialize(item_id:, is_hidden: nil, labels: nil, categories: nil, timestamp: nil, comment: nil)
+    @item_id = item_id
+    @is_hidden = is_hidden
+    @labels = labels
+    @categories = categories
+    @timestamp = timestamp
+    @comment = comment
+  end
+
+  def to_h
+    data = { 'ItemId' => @item_id }
+    data['IsHidden'] = @is_hidden unless @is_hidden.nil?
+    data['Labels'] = @labels unless @labels.nil?
+    data['Categories'] = @categories unless @categories.nil?
+    data['Timestamp'] = @timestamp unless @timestamp.nil?
+    data['Comment'] = @comment unless @comment.nil?
+    data
+  end
+
+  def to_json(*_args)
+    JSON.generate(to_h)
+  end
+
+  def self.from_json(string)
+    h = JSON.load string
+    Item.new(
+      item_id: h['ItemId'],
+      is_hidden: h['IsHidden'],
+      labels: h['Labels'],
+      categories: h['Categories'],
+      timestamp: h['Timestamp'],
+      comment: h['Comment']
+    )
+  end
+
+  attr_reader :item_id, :is_hidden, :labels, :categories, :timestamp, :comment
+end
+
+class ItemPatch
+  def initialize(is_hidden: nil, categories: nil, timestamp: nil, labels: nil, comment: nil)
+    @is_hidden = is_hidden
+    @categories = categories
+    @timestamp = timestamp
+    @labels = labels
+    @comment = comment
+  end
+
+  def to_json(*_args)
+    data = {}
+    data['IsHidden'] = @is_hidden unless @is_hidden.nil?
+    data['Categories'] = @categories unless @categories.nil?
+    data['Timestamp'] = @timestamp unless @timestamp.nil?
+    data['Labels'] = @labels unless @labels.nil?
+    data['Comment'] = @comment unless @comment.nil?
+    JSON.generate(data)
+  end
+end
+
+class ItemIterator
+  def initialize(cursor, items)
+    @cursor = cursor
+    @items = items
+  end
+
+  def self.from_json(string)
+    h = JSON.load string
+    items = (h['Items'] || []).map do |it|
+      Item.new(
+        item_id: it['ItemId'],
+        is_hidden: it['IsHidden'],
+        labels: it['Labels'],
+        categories: it['Categories'],
+        timestamp: it['Timestamp'],
+        comment: it['Comment']
+      )
+    end
+    ItemIterator.new(h['Cursor'], items)
+  end
+
+  attr_reader :cursor, :items
+end
+
 class Gorse
   def initialize(endpoint, api_key = "")
     @endpoint = endpoint
@@ -39,17 +193,143 @@ class Gorse
   end
 
   def insert_feedback(feedback)
-    uri = URI("#{@endpoint}/api/feedback")
-    response = Net::HTTP::post(uri, JSON.generate(feedback), {
-      'Content-Type' => 'application/json',
-      'Accept' => 'application/json'
-    })
-    RowAffected.from_json(response.body)
-  end
-
-  def get_recommend(user_id)
-    uri = URI("#{@endpoint}/api/recommend/#{user_id}")
-    response = Net::HTTP::get(uri)
-    JSON.parse(response)
+    response = request('POST', '/api/feedback', feedback)
+    RowAffected.from_json(response)
+  end
+
+  def list_feedbacks(feedback_type, user_id)
+    JSON.parse(request('GET', "/api/user/#{escape(user_id)}/feedback/#{escape(feedback_type)}"))
+  end
+
+  def delete_feedback(feedback_type, user_id, item_id)
+    RowAffected.from_json(request('DELETE', "/api/feedback/#{escape(feedback_type)}/#{escape(user_id)}/#{escape(item_id)}"))
+  end
+
+  def delete_feedbacks(user_id, item_id)
+    RowAffected.from_json(request('DELETE', "/api/feedback/#{escape(user_id)}/#{escape(item_id)}"))
+  end
+
+  def get_recommend(user_id, category: nil, n: nil, offset: nil)
+    if category.nil? && n.nil? && offset.nil?
+      return JSON.parse(request('GET', "/api/recommend/#{escape(user_id)}"))
+    end
+    cat_seg = (category || '').to_s
+    qs = []
+    qs << ["n", n] unless n.nil?
+    qs << ["offset", offset] unless offset.nil?
+    query = qs.map { |k, v| "#{k}=#{URI.encode_www_form_component(v.to_s)}" }.join('&')
+    path = "/api/recommend/#{escape(user_id)}/#{cat_seg}"
+    path += "?#{query}" unless query.empty?
+    JSON.parse(request('GET', path))
+  end
+
+  def get_latest_items(user_id: nil, category: nil, n:, offset: 0)
+    category_path = category && !category.empty? ? "/#{escape(category)}" : ''
+    qs = [["n", n], ["offset", offset]]
+    qs << ["user-id", user_id] unless user_id.nil? || user_id.empty?
+    query = qs.map { |k, v| "#{k}=#{URI.encode_www_form_component(v.to_s)}" }.join('&')
+    path = "/api/latest#{category_path}?#{query}"
+    JSON.parse(request('GET', path))
+  end
+
+  def session_recommend(feedbacks, n:)
+    path = "/api/session/recommend?n=#{n}"
+    JSON.parse(request('POST', path, feedbacks))
+  end
+
+  def get_neighbors(item_id, n:)
+    JSON.parse(request('GET', "/api/item/#{escape(item_id)}/neighbors?n=#{n}"))
+  end
+
+  def get_neighbors_category(item_id, category:, n:, offset: 0)
+    path = "/api/item/#{escape(item_id)}/neighbors/#{escape(category)}?n=#{n}&offset=#{offset}"
+    JSON.parse(request('GET', path))
+  end
+
+  def get_neighbors_users(user_id, n:, offset: 0)
+    path = "/api/user/#{escape(user_id)}/neighbors?n=#{n}&offset=#{offset}"
+    JSON.parse(request('GET', path))
+  end
+
+  # User APIs
+  def insert_user(user)
+    RowAffected.from_json(request('POST', '/api/user', user))
+  end
+
+  def insert_users(users)
+    RowAffected.from_json(request('POST', '/api/users', users))
+  end
+
+  def update_user(user_id, user_patch)
+    RowAffected.from_json(request('PATCH', "/api/user/#{escape(user_id)}", user_patch))
+  end
+
+  def get_user(user_id)
+    JSON.parse(request('GET', "/api/user/#{escape(user_id)}"))
+  end
+
+  def get_users(n:, cursor: '')
+    JSON.parse(request('GET', "/api/users?n=#{n}&cursor=#{URI.encode_www_form_component(cursor)}"))
+  end
+
+  def delete_user(user_id)
+    RowAffected.from_json(request('DELETE', "/api/user/#{escape(user_id)}"))
+  end
+
+  # Item APIs
+  def insert_item(item)
+    RowAffected.from_json(request('POST', '/api/item', item))
+  end
+
+  def insert_items(items)
+    RowAffected.from_json(request('POST', '/api/items', items))
+  end
+
+  def update_item(item_id, item_patch)
+    RowAffected.from_json(request('PATCH', "/api/item/#{escape(item_id)}", item_patch))
+  end
+
+  def get_item(item_id)
+    JSON.parse(request('GET', "/api/item/#{escape(item_id)}"))
+  end
+
+  def get_items(n:, cursor: '')
+    JSON.parse(request('GET', "/api/items?n=#{n}&cursor=#{URI.encode_www_form_component(cursor)}"))
+  end
+
+  def delete_item(item_id)
+    RowAffected.from_json(request('DELETE', "/api/item/#{escape(item_id)}"))
+  end
+
+  private
+
+  def escape(s)
+    URI.encode_www_form_component(s.to_s)
+  end
+
+  def request(method, path, body = nil)
+    base = @endpoint.end_with?('/') ? @endpoint : @endpoint + '/'
+    uri = URI.join(base, path.sub(/^\//, ''))
+    headers = { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+    headers['X-API-Key'] = @api_key if @api_key && !@api_key.empty?
+
+    req = case method.upcase
+          when 'GET' then Net::HTTP::Get.new(uri, headers)
+          when 'POST' then Net::HTTP::Post.new(uri, headers)
+          when 'PATCH' then Net::HTTP::Patch.new(uri, headers)
+          when 'DELETE' then Net::HTTP::Delete.new(uri, headers)
+          else raise "Unsupported method #{method}"
+          end
+    if body && %w[POST PATCH].include?(method.upcase)
+      payload = body.is_a?(String) ? body : JSON.generate(body)
+      req.body = payload
+    end
+    response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |h|
+      h.request(req)
+    end
+    unless response.is_a?(Net::HTTPSuccess)
+      raise "HTTP #{response.code}: #{response.body}"
+    end
+    response.body
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gorse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Zhenghao Zhang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2025-11-27 00:00:00.000000000 Z
 dependencies: []
 description: Ruby SDK for Gorse recommender system
 email: zhangzhenghao@hotmail.com
@@ -21,7 +21,7 @@ homepage: https://gorse.io/
 licenses:
 - Apache 2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -36,8 +36,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Ruby SDK for Gorse recommender system
 test_files: []