crawlora-xiaohongshu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 969a1e6e728986d3d475440752d9d49d3871d35ecc5323870b9b19e241911281
+  data.tar.gz: c698b28bbf1b42c09680b3bae1ae9b612769edcdc869988af6e2a9ce5aef667c
+SHA512:
+  metadata.gz: 169d0668dd48ee23c971507007d9ae27c15b84d0f24d6d0235c6704d82ce46af4d3802c936f9665f38eacbae57c21313445582cc0986c5f06709c09c2b7783a8
+  data.tar.gz: 9378eb562be9adaa6d8f205ace40da0f44da7adee9ebaefcf74e92744bc235015c8105a7dc7ea90c74e8149ac484d399952328a4b1b87102a466c5c3664a14a5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Initial focused Xiaohongshu Ruby client for Crawlora's hosted API.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Crawlora
+
+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,44 @@
+# Crawlora Xiaohongshu API client for Ruby (`crawlora-xiaohongshu`)
+
+This Ruby gem calls Crawlora's hosted Xiaohongshu API at `https://api.crawlora.net/api/v1`. It exposes 4 endpoints covering public explore feeds, note details, comments, and search suggestions; it does not call or scrape Xiaohongshu directly. Requests require your Crawlora API key and use your account's service plan.
+
+## Install
+
+```ruby
+gem "crawlora-xiaohongshu"
+```
+
+Create an account at [crawlora.net](https://crawlora.net/signup?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=xiaohongshu-ruby-signup), open the [Crawlora console](https://crawlora.net/app?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=xiaohongshu-ruby-console) to get an API key, and set `CRAWLORA_API_KEY` before running the client:
+
+```ruby
+require "json"
+require "crawlora/xiaohongshu"
+
+client = Crawlora::Xiaohongshu::Client.new
+result = client.request("xiaohongshu-explore", JSON.parse("{}"))
+puts result
+client.close
+```
+
+Use an operation-specific method for normal calls. `request(operation_id, params = {}, response_type: :auto)` is available for every operation. `response_type: :text` returns raw response text. This gem includes 4 API operations.
+
+```ruby
+client = Crawlora::Xiaohongshu::Client.new(api_key: ENV.fetch("CRAWLORA_API_KEY"), timeout: 30)
+# client.<operation_method>(<endpoint parameters>)
+client.close
+```
+
+Client options include `api_key`, `base_url`, and `timeout`. Ruby stdlib provides the HTTP and JSON support.
+
+## Supported Xiaohongshu API endpoints
+
+Browse every route included in this gem. The [endpoint reference](https://github.com/Crawlora-org/crawlora-xiaohongshu/blob/main/docs/usage.md) includes parameter and response details.
+
+| Method | Endpoint | API operation | Description |
+| --- | --- | --- | --- |
+| `GET` | `/xiaohongshu/explore` | `xiaohongshu-explore` | Anonymous Xiaohongshu explore/channel feed |
+| `GET` | `/xiaohongshu/note` | `xiaohongshu-note` | Anonymous Xiaohongshu note detail |
+| `GET` | `/xiaohongshu/note-comments` | `xiaohongshu-note-comments` | Anonymous Xiaohongshu note comments |
+| `GET` | `/xiaohongshu/search-suggest` | `xiaohongshu-search-suggest` | Anonymous Xiaohongshu search suggestions |
+
+See [Crawlora](https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=xiaohongshu-ruby-homepage), the [API documentation](https://crawlora.net/docs?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=xiaohongshu-ruby-api-docs), and [the package repository](https://github.com/Crawlora-org/crawlora-xiaohongshu) for account setup, the API operation reference, and release history.

data/lib/crawlora/xiaohongshu/client.rb

@@ -0,0 +1,212 @@
+require "json"
+require "net/http"
+require "uri"
+
+module Crawlora
+  module Xiaohongshu
+    module Errors
+      class Error < StandardError
+        attr_reader :status, :operation_id, :body
+
+        def initialize(message, status: nil, operation_id: nil, body: nil)
+          super(message)
+          @status, @operation_id, @body = status, operation_id, body
+        end
+      end
+      class ClientError < Error; end
+      class ServerError < Error; end
+      class NetworkError < Error; end
+    end
+
+    OPERATIONS = JSON.parse(<<~'JSON').freeze
+      {"xiaohongshu-explore": {"bodyParam": null, "bodyRequired": false, "id": "xiaohongshu-explore", "method": "GET", "params": [{"description": "Optional explore channel id from the channels list in a previous response. Unknown values are rejected; omit for the default feed.", "in": "query", "name": "channel_id", "type": "string", "x-example": "homefeed.food_v3"}], "path": "/xiaohongshu/explore", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "channel_id", "type": "string"}], "security": ["ApiKeyAuth"]}, "xiaohongshu-note": {"bodyParam": null, "bodyRequired": false, "id": "xiaohongshu-note", "method": "GET", "params": [{"description": "Note URL carrying xsec_token, normally the note_url returned by /xiaohongshu/explore. Pass url, or both note_id and xsec_token.", "in": "query", "name": "url", "type": "string", "x-example": "https://www.xiaohongshu.com/explore/0123456789abcdef01234567?xsec_token=SYNTHETIC-EXAMPLE-TOKEN-0001&xsec_source=pc_feed"}, {"description": "24-character hex note id from an explore card (requires xsec_token)", "in": "query", "name": "note_id", "type": "string", "x-example": "0123456789abcdef01234567"}, {"description": "Short-lived feed-issued token that accompanies note_id", "in": "query", "name": "xsec_token", "type": "string", "x-example": "SYNTHETIC-EXAMPLE-TOKEN-0001"}], "path": "/xiaohongshu/note", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "url", "type": "string"}, {"in": "query", "name": "note_id", "type": "string"}, {"in": "query", "name": "xsec_token", "type": "string"}], "security": ["ApiKeyAuth"]}, "xiaohongshu-note-comments": {"bodyParam": null, "bodyRequired": false, "id": "xiaohongshu-note-comments", "method": "GET", "params": [{"description": "Note URL carrying xsec_token, normally the note_url returned by /xiaohongshu/explore. Pass url, or both note_id and xsec_token.", "in": "query", "name": "url", "type": "string", "x-example": "https://www.xiaohongshu.com/explore/0123456789abcdef01234567?xsec_token=SYNTHETIC-EXAMPLE-TOKEN-0001&xsec_source=pc_feed"}, {"description": "24-character hex note id from an explore card (requires xsec_token)", "in": "query", "name": "note_id", "type": "string", "x-example": "0123456789abcdef01234567"}, {"description": "Short-lived feed-issued token that accompanies note_id", "in": "query", "name": "xsec_token", "type": "string", "x-example": "SYNTHETIC-EXAMPLE-TOKEN-0001"}, {"description": "Pagination cursor from a previous response", "in": "query", "name": "cursor", "type": "string", "x-example": "cursor-1"}], "path": "/xiaohongshu/note-comments", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "url", "type": "string"}, {"in": "query", "name": "note_id", "type": "string"}, {"in": "query", "name": "xsec_token", "type": "string"}, {"in": "query", "name": "cursor", "type": "string"}], "security": ["ApiKeyAuth"]}, "xiaohongshu-search-suggest": {"bodyParam": null, "bodyRequired": false, "id": "xiaohongshu-search-suggest", "method": "GET", "params": [{"description": "Partially typed search keyword", "in": "query", "name": "keyword", "required": true, "type": "string", "x-example": "coffee"}], "path": "/xiaohongshu/search-suggest", "pathParams": [], "produces": ["application/json"], "queryParams": [{"in": "query", "name": "keyword", "required": true, "type": "string"}], "security": ["ApiKeyAuth"]}}
+    JSON
+    OPERATION_IDS = JSON.parse(<<~'JSON').freeze
+      ["xiaohongshu-explore", "xiaohongshu-note", "xiaohongshu-note-comments", "xiaohongshu-search-suggest"]
+    JSON
+    OPERATION_COUNT = OPERATION_IDS.length
+
+    class Client
+      attr_reader :base_url
+
+      def initialize(api_key: ENV["CRAWLORA_API_KEY"], base_url: "https://api.crawlora.net/api/v1", timeout: 30, user_agent: "crawlora-xiaohongshu-ruby/0.1.0", transport: nil)
+        @api_key = api_key
+        @base_url = base_url.to_s.sub(%r{/+$}, "")
+        @timeout = Float(timeout)
+        @user_agent = user_agent
+        @transport = transport
+        @closed = false
+      end
+
+      def request(operation_id, params = {}, response_type: :auto)
+        raise Errors::ClientError, "client is closed" if @closed
+        operation_id = operation_id.to_s
+        operation = OPERATIONS[operation_id]
+        raise Errors::ClientError.new("unknown operation: #{operation_id}", operation_id: operation_id) unless operation
+        raise Errors::ClientError.new("Crawlora API key is required", operation_id: operation_id) if @api_key.nil? || @api_key.to_s.empty?
+        normalized = params.each_with_object({}) { |(key, value), out| out[key.to_s] = value }
+        payload = request_body(operation, normalized)
+        url = build_url(operation, normalized)
+        uri = URI.parse(url)
+        request = operation["method"] == "POST" ? Net::HTTP::Post.new(uri) : Net::HTTP::Get.new(uri)
+        unless payload.nil?
+          request.body = payload
+          request["Content-Type"] = "application/json"
+        end
+        request["x-api-key"] = @api_key
+        request["User-Agent"] = @user_agent
+        request["Accept"] = operation["produces"].include?("text/plain") ? "application/json, text/plain" : "application/json"
+        begin
+          if @transport
+            response = if operation["method"] == "POST"
+              @transport.call(url, request.to_hash, @timeout, "POST", payload)
+            else
+              @transport.call(url, request.to_hash, @timeout)
+            end
+            status = Integer(response.fetch(:status) { response.fetch("status") })
+            body = response.fetch(:body) { response.fetch("body", "") }
+            headers = response.fetch(:headers) { response.fetch("headers", {}) }
+            content_type = headers["content-type"] || headers["Content-Type"]
+          else
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = uri.scheme == "https"
+            http.open_timeout = @timeout
+            http.read_timeout = @timeout
+            response = http.start { |connection| connection.request(request) }
+            status = response.code.to_i
+            body = response.body
+            content_type = response["content-type"]
+          end
+        rescue Timeout::Error, SocketError, SystemCallError, IOError, EOFError, Net::HTTPBadResponse, Net::ProtocolError, OpenSSL::SSL::SSLError => error
+          raise Errors::NetworkError.new("Crawlora request failed: #{error.message}", operation_id: operation_id)
+        end
+        unless status >= 200 && status < 300
+          klass = status >= 500 ? Errors::ServerError : Errors::ClientError
+          raise klass.new("Crawlora returned HTTP #{status}", status: status, operation_id: operation_id, body: body)
+        end
+        parse_response(body, content_type, operation, normalized, response_type)
+      end
+
+      def close
+        @closed = true
+      end
+
+      def closed?
+        @closed
+      end
+
+      def with
+        return self unless block_given?
+        yield self
+      ensure
+        close if block_given?
+      end
+
+      def self.operation_count
+        OPERATION_COUNT
+      end
+
+      def self.operation_ids
+        OPERATION_IDS
+      end
+
+      def self.operations
+        OPERATIONS
+      end
+
+            define_method('explore') do |**params|
+        response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
+        request('xiaohongshu-explore', params, response_type: response_type)
+      end
+      define_method('note') do |**params|
+        response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
+        request('xiaohongshu-note', params, response_type: response_type)
+      end
+      define_method('note_comments') do |**params|
+        response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
+        request('xiaohongshu-note-comments', params, response_type: response_type)
+      end
+      define_method('search_suggest') do |**params|
+        response_type = params.delete(:response_type) || params.delete(:_response_type) || :auto
+        request('xiaohongshu-search-suggest', params, response_type: response_type)
+      end
+
+      private
+
+      # POST operations take their JSON body under the body parameter name or "body".
+      def request_body(operation, params)
+        name = operation["bodyParam"]
+        return nil if name.nil?
+        value = params.key?(name) ? params[name] : params["body"]
+        if value.nil?
+          raise Errors::ClientError.new("missing request body: #{name}", operation_id: operation["id"]) if operation["bodyRequired"]
+          return nil
+        end
+        value.is_a?(String) ? value : JSON.generate(value)
+      end
+
+      def build_url(operation, params)
+        known = operation["params"].map { |param| param["name"] }
+        known << "body" if operation["bodyParam"]
+        unknown = params.keys - known
+        raise Errors::ClientError.new("unknown parameters: #{unknown.join(', ')}", operation_id: operation["id"]) unless unknown.empty?
+        path = operation["path"].dup
+        operation["params"].select { |param| param["in"] == "path" }.each do |param|
+          value = params[param["name"]]
+          raise Errors::ClientError.new("missing path parameter: #{param['name']}", operation_id: operation["id"]) if value.nil?
+          path.sub!("{" + param["name"] + "}", percent_encode(value.to_s))
+        end
+        pairs = []
+        operation["queryParams"].each do |param|
+          name = param["name"]
+          value = params.key?(name) ? params[name] : param["default"]
+          if value.nil?
+            raise Errors::ClientError.new("missing query parameter: #{name}", operation_id: operation["id"]) if param["required"]
+            next
+          end
+          enum_values = param["enum"] || (param["items"] && param["items"]["enum"])
+          if enum_values && !(value.is_a?(Array) ? value : [value]).all? { |item| enum_values.map(&:to_s).include?(item.to_s) }
+            raise Errors::ClientError.new("invalid value for #{name}", operation_id: operation["id"])
+          end
+          if value.is_a?(Array)
+            format = param["collectionFormat"] || "csv"
+            if format == "multi"
+              value.each { |item| pairs << [name, scalar(item)] }
+            else
+              separator = {"csv" => ",", "ssv" => " ", "tsv" => "\t", "pipes" => "|"}[format] || ","
+              pairs << [name, value.map { |item| scalar(item) }.join(separator)]
+            end
+          else
+            pairs << [name, scalar(value)]
+          end
+        end
+        query = pairs.map { |name, value| "#{percent_encode(name)}=#{percent_encode(value)}" }.join("&")
+        @base_url + path + (query.empty? ? "" : "?" + query)
+      end
+
+      def scalar(value)
+        value == true ? "true" : (value == false ? "false" : value.to_s)
+      end
+
+      def percent_encode(value)
+        URI::DEFAULT_PARSER.escape(value.to_s, /[^A-Za-z0-9\-._~]/)
+      end
+
+      def parse_response(body, content_type, operation, params, response_type)
+        type = response_type.to_s
+        raise Errors::ClientError.new("response_type must be auto, json, or text", operation_id: operation["id"]) unless %w[auto json text].include?(type)
+        format = operation["params"].find { |param| param["name"] == "format" }
+        text_formats = format && format["enum"] ? format["enum"].reject { |value| %w[json application/json].include?(value.to_s.downcase) } : []
+        raw_format = params["format"] && text_formats.include?(params["format"].to_s)
+        json_format = format && format["enum"] && format["enum"].any? { |value| %w[json application/json].include?(value.to_s.downcase) } && %w[json application/json].include?(params["format"].to_s.downcase)
+        is_json = json_format || content_type.to_s.downcase.include?("json") || operation["produces"] == ["application/json"]
+        return body if type == "text" || raw_format || (type == "auto" && !is_json)
+        JSON.parse(body)
+      rescue JSON::ParserError => error
+        raise Errors::Error.new("invalid JSON response from Crawlora: #{error.message}", operation_id: operation["id"], body: body)
+      end
+
+      public
+    end
+  end
+end

data/lib/crawlora/xiaohongshu/version.rb

@@ -0,0 +1,5 @@
+module Crawlora
+  module Xiaohongshu
+    VERSION = "0.1.0"
+  end
+end

data/lib/crawlora/xiaohongshu.rb

@@ -0,0 +1,2 @@
+require_relative "xiaohongshu/version"
+require_relative "xiaohongshu/client"

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: crawlora-xiaohongshu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Crawlora
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-29 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client for Crawlora's hosted Xiaohongshu API. Covers public explore
+  feeds, note details, comments, and search suggestions across 4 endpoints.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/crawlora/xiaohongshu.rb
+- lib/crawlora/xiaohongshu/client.rb
+- lib/crawlora/xiaohongshu/version.rb
+homepage: https://crawlora.net/?utm_source=rubygems&utm_medium=referral&utm_campaign=platform-clients&utm_content=xiaohongshu-ruby-homepage
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Crawlora-org/crawlora-xiaohongshu
+  documentation_uri: https://github.com/Crawlora-org/crawlora-xiaohongshu/blob/main/ruby/README.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Xiaohongshu API client for Crawlora (4 endpoints)
+test_files: []