RubyGems - zenrows - Versions diffs - 0.1.0 → 0.2.1 - Mend

zenrows 0.1.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

checksums.yaml +4 -4
data/.mcp.json +10 -0
data/.tool-versions +1 -0
data/CHANGELOG.md +28 -0
data/CLAUDE.md +1 -1
data/Makefile +19 -0
data/README.md +100 -19
data/lib/zenrows/api_client.rb +180 -0
data/lib/zenrows/api_response.rb +185 -0
data/lib/zenrows/backends/http_rb.rb +10 -11
data/lib/zenrows/backends/net_http.rb +141 -0
data/lib/zenrows/client.rb +35 -9
data/lib/zenrows/configuration.rb +6 -0
data/lib/zenrows/css_extractor.rb +111 -0
data/lib/zenrows/proxy.rb +19 -0
data/lib/zenrows/version.rb +1 -1
data/lib/zenrows.rb +10 -2
data/sig/manifest.yaml +5 -0
data/sig/zenrows/api_client.rbs +15 -0
data/sig/zenrows/api_response.rbs +28 -0
data/sig/zenrows/backends/base.rbs +9 -0
data/sig/zenrows/backends/http_rb.rbs +3 -0
data/sig/zenrows/backends/net_http.rbs +28 -0
data/sig/zenrows/backends.rbs +2 -0
data/sig/zenrows/client.rbs +11 -0
data/sig/zenrows/configuration.rbs +20 -0
data/sig/zenrows/css_extractor.rbs +14 -0
data/sig/zenrows/errors.rbs +27 -0
data/sig/zenrows/js_instructions.rbs +28 -0
data/sig/zenrows/proxy.rbs +14 -0
data/sig/zenrows.rbs +4 -1
data/test/zenrows/api_client_test.rb +161 -0
data/test/zenrows/api_response_test.rb +142 -0
data/test/zenrows/css_extractor_test.rb +84 -0
data/test/zenrows/js_instructions_test.rb +2 -1
data/test/zenrows/proxy_test.rb +39 -0
metadata +25 -2

data/test/zenrows/api_client_test.rb ADDED Viewed

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+require "test_helper"
+require "webmock/minitest"
+class ApiClientTest < Minitest::Test
+  def setup
+    Zenrows.configure do |config|
+      config.api_key = "test_api_key"
+    end
+    @client = Zenrows::ApiClient.new
+  end
+  def teardown
+    Zenrows.reset_configuration!
+    WebMock.reset!
+  end
+  def test_initialization_with_global_config
+    assert_equal "test_api_key", @client.api_key
+  end
+  def test_initialization_with_custom_api_key
+    client = Zenrows::ApiClient.new(api_key: "custom_key")
+    assert_equal "custom_key", client.api_key
+  end
+  def test_get_basic_request
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(apikey: "test_api_key", url: "https://example.com"))
+      .to_return(status: 200, body: "<html>Test</html>")
+    response = @client.get("https://example.com")
+    assert_equal 200, response.status
+    assert_equal "<html>Test</html>", response.html
+  end
+  def test_get_with_autoparse
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(autoparse: "true"))
+      .to_return(status: 200, body: '{"title":"Product"}')
+    response = @client.get("https://amazon.com/dp/123", autoparse: true)
+    assert_equal "Product", response.parsed["title"]
+  end
+  def test_get_with_css_extractor_hash
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(css_extractor: '{"title":"h1"}'))
+      .to_return(status: 200, body: '{"title":"Page Title"}')
+    response = @client.get("https://example.com", css_extractor: {title: "h1"})
+    assert_equal "Page Title", response.extracted["title"]
+  end
+  def test_get_with_css_extractor_dsl
+    extractor = Zenrows::CssExtractor.build do
+      extract :title, "h1"
+      links :urls, "a"
+    end
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(css_extractor: '{"title":"h1","urls":"a @href"}'))
+      .to_return(status: 200, body: '{"title":"Test","urls":["link1"]}')
+    response = @client.get("https://example.com", css_extractor: extractor)
+    assert_equal "Test", response.extracted["title"]
+  end
+  def test_get_with_markdown_response
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(response_type: "markdown"))
+      .to_return(status: 200, body: "# Title\n\nText")
+    response = @client.get("https://example.com", response_type: "markdown")
+    assert_equal "# Title\n\nText", response.markdown
+  end
+  def test_get_with_js_render
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(js_render: "true"))
+      .to_return(status: 200, body: "<html>Rendered</html>")
+    response = @client.get("https://example.com", js_render: true)
+    assert_equal "<html>Rendered</html>", response.html
+  end
+  def test_get_with_premium_proxy
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(premium_proxy: "true", proxy_country: "us"))
+      .to_return(status: 200, body: "OK")
+    response = @client.get("https://example.com", premium_proxy: true, proxy_country: "us")
+    assert_predicate response, :success?
+  end
+  def test_get_with_antibot
+    stub_request(:get, "https://api.zenrows.com/v1/")
+      .with(query: hash_including(antibot: "true"))
+      .to_return(status: 200, body: "OK")
+    response = @client.get("https://example.com", antibot: true)
+    assert_predicate response, :success?
+  end
+  def test_authentication_error
+    stub_request(:get, /api\.zenrows\.com/)
+      .with(query: hash_including(apikey: "test_api_key"))
+      .to_return(status: 401, body: "Unauthorized")
+    assert_raises Zenrows::AuthenticationError do
+      @client.get("https://example.com")
+    end
+  end
+  def test_rate_limit_error
+    stub_request(:get, /api\.zenrows\.com/)
+      .with(query: hash_including(apikey: "test_api_key"))
+      .to_return(status: 429, body: "Too Many Requests", headers: {"Retry-After" => "60"})
+    error = assert_raises Zenrows::RateLimitError do
+      @client.get("https://example.com")
+    end
+    assert_equal 60, error.retry_after
+  end
+  def test_bot_detected_error
+    stub_request(:get, /api\.zenrows\.com/)
+      .with(query: hash_including(apikey: "test_api_key"))
+      .to_return(status: 403, body: "Bot detected")
+    error = assert_raises Zenrows::BotDetectedError do
+      @client.get("https://example.com")
+    end
+    assert_includes error.suggestion, "premium_proxy"
+  end
+  def test_post_request
+    stub_request(:post, "https://api.zenrows.com/v1/")
+      .with(
+        query: hash_including(apikey: "test_api_key", url: "https://example.com"),
+        body: "form_data=value"
+      )
+      .to_return(status: 200, body: "Posted")
+    response = @client.post("https://example.com", body: "form_data=value")
+    assert_predicate response, :success?
+  end
+end

data/test/zenrows/api_response_test.rb ADDED Viewed

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+require "test_helper"
+class ApiResponseTest < Minitest::Test
+  def test_html_response
+    http_response = mock_response("<html><body>Test</body></html>", 200)
+    response = Zenrows::ApiResponse.new(http_response)
+    assert_equal "<html><body>Test</body></html>", response.html
+    assert_equal "<html><body>Test</body></html>", response.body
+    assert_equal 200, response.status
+    assert_predicate response, :success?
+  end
+  def test_json_response_with_html
+    body = '{"html":"<html>Test</html>","xhr":[]}'
+    http_response = mock_response(body, 200)
+    response = Zenrows::ApiResponse.new(http_response, json_response: true)
+    assert_equal "<html>Test</html>", response.html
+    assert_empty response.xhr
+  end
+  def test_markdown_response
+    body = "# Title\n\nParagraph text"
+    http_response = mock_response(body, 200)
+    response = Zenrows::ApiResponse.new(http_response, response_type: "markdown")
+    assert_equal "# Title\n\nParagraph text", response.markdown
+  end
+  def test_autoparse_response
+    body = '{"title":"Product Name","price":"$29.99"}'
+    http_response = mock_response(body, 200)
+    response = Zenrows::ApiResponse.new(http_response, autoparse: true)
+    assert_equal "Product Name", response.parsed["title"]
+    assert_equal "$29.99", response.parsed["price"]
+  end
+  def test_css_extractor_response
+    body = '{"title":"Page Title","links":["link1","link2"]}'
+    http_response = mock_response(body, 200)
+    response = Zenrows::ApiResponse.new(http_response, css_extractor: {title: "h1"})
+    assert_equal "Page Title", response.extracted["title"]
+    assert_equal ["link1", "link2"], response.extracted["links"]
+  end
+  def test_js_instructions_report
+    body = '{"html":"...","js_instructions_report":{"instructions_executed":2}}'
+    http_response = mock_response(body, 200)
+    response = Zenrows::ApiResponse.new(http_response, json_response: true)
+    assert_equal({"instructions_executed" => 2}, response.js_instructions_report)
+  end
+  def test_headers_accessors
+    headers = {
+      "Concurrency-Limit" => "200",
+      "Concurrency-Remaining" => "199",
+      "X-Request-Cost" => "0.001",
+      "Zr-Final-Url" => "https://example.com/final"
+    }
+    http_response = mock_response("", 200, headers)
+    response = Zenrows::ApiResponse.new(http_response)
+    assert_equal 200, response.concurrency_limit
+    assert_equal 199, response.concurrency_remaining
+    assert_in_delta 0.001, response.request_cost
+    assert_equal "https://example.com/final", response.final_url
+  end
+  def test_success_status_codes
+    [200, 201, 204, 299].each do |code|
+      http_response = mock_response("", code)
+      response = Zenrows::ApiResponse.new(http_response)
+      assert_predicate response, :success?, "Expected #{code} to be success"
+    end
+  end
+  def test_non_success_status_codes
+    [400, 401, 403, 404, 500].each do |code|
+      http_response = mock_response("", code)
+      response = Zenrows::ApiResponse.new(http_response)
+      refute_predicate response, :success?, "Expected #{code} to not be success"
+    end
+  end
+  private
+  def mock_response(body, status, headers = {})
+    MockHttpResponse.new(body, status, headers)
+  end
+  class MockHttpResponse
+    attr_reader :body, :headers
+    def initialize(body, status, headers = {})
+      @body = MockBody.new(body)
+      @status = MockStatus.new(status)
+      @headers = MockHeaders.new(headers)
+    end
+    attr_reader :status
+    class MockBody
+      def initialize(content)
+        @content = content
+      end
+      def to_s
+        @content
+      end
+    end
+    class MockStatus
+      def initialize(code)
+        @code = code
+      end
+      attr_reader :code
+    end
+    class MockHeaders
+      def initialize(headers)
+        @headers = headers
+      end
+      def [](key)
+        @headers[key]
+      end
+      def to_h
+        @headers
+      end
+    end
+  end
+end

data/test/zenrows/css_extractor_test.rb ADDED Viewed

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+require "test_helper"
+class CssExtractorTest < Minitest::Test
+  def test_build_with_block
+    extractor = Zenrows::CssExtractor.build do
+      extract :title, "h1"
+      extract :price, ".price"
+    end
+    assert_equal({title: "h1", price: ".price"}, extractor.to_h)
+  end
+  def test_extract_with_attribute
+    extractor = Zenrows::CssExtractor.new
+    extractor.extract(:link, "a.main", attribute: "href")
+    assert_equal({link: "a.main @href"}, extractor.to_h)
+  end
+  def test_links_helper
+    extractor = Zenrows::CssExtractor.new
+    extractor.links(:nav_links, "nav a")
+    assert_equal({nav_links: "nav a @href"}, extractor.to_h)
+  end
+  def test_images_helper
+    extractor = Zenrows::CssExtractor.new
+    extractor.images(:product_images, "img.product")
+    assert_equal({product_images: "img.product @src"}, extractor.to_h)
+  end
+  def test_chaining
+    extractor = Zenrows::CssExtractor.new
+      .extract(:title, "h1")
+      .extract(:price, ".price")
+      .links(:links, "a")
+    assert_equal 3, extractor.size
+  end
+  def test_to_json
+    extractor = Zenrows::CssExtractor.build do
+      extract :title, "h1"
+      extract :link, "a", attribute: "href"
+    end
+    json = extractor.to_json
+    parsed = JSON.parse(json)
+    assert_equal "h1", parsed["title"]
+    assert_equal "a @href", parsed["link"]
+  end
+  def test_empty
+    extractor = Zenrows::CssExtractor.new
+    assert_empty extractor
+    extractor.extract(:title, "h1")
+    refute_empty extractor
+  end
+  def test_size
+    extractor = Zenrows::CssExtractor.build do
+      extract :one, ".one"
+      extract :two, ".two"
+      extract :three, ".three"
+    end
+    assert_equal 3, extractor.size
+  end
+  def test_string_name_converted_to_symbol
+    extractor = Zenrows::CssExtractor.new
+    extractor.extract("title", "h1")
+    assert_equal({title: "h1"}, extractor.to_h)
+  end
+end

data/test/zenrows/js_instructions_test.rb CHANGED Viewed

@@ -10,7 +10,7 @@ class JsInstructionsTest < Minitest::Test
     end
     assert_equal 2, instructions.size
-    refute instructions.empty?
+    refute_empty instructions
   end
   def test_click
@@ -113,6 +113,7 @@ class JsInstructionsTest < Minitest::Test
     end
     json = instructions.to_json
     assert_equal '[{"click":".btn"},{"wait":500}]', json
   end

data/test/zenrows/proxy_test.rb CHANGED Viewed

@@ -111,4 +111,43 @@ class ProxyTest < Minitest::Test
       @proxy.build(wait: 200_000)
     end
   end
+  def test_build_with_device_mobile
+    config = @proxy.build(device: "mobile")
+    assert_includes config[:password], "device=mobile"
+  end
+  def test_build_with_device_desktop
+    config = @proxy.build(device: :desktop)
+    assert_includes config[:password], "device=desktop"
+  end
+  def test_build_with_antibot
+    config = @proxy.build(antibot: true)
+    assert_includes config[:password], "antibot=true"
+  end
+  def test_build_with_session_ttl
+    config = @proxy.build(session_id: true, session_ttl: "30m")
+    assert_includes config[:password], "session_ttl=30m"
+    assert_match(/session_id=\d+/, config[:password])
+  end
+  def test_build_with_all_valid_session_ttl_values
+    %w[30s 5m 30m 1h 1d].each do |ttl|
+      config = @proxy.build(session_ttl: ttl)
+      assert_includes config[:password], "session_ttl=#{ttl}"
+    end
+  end
+  def test_raises_on_invalid_session_ttl
+    assert_raises ArgumentError do
+      @proxy.build(session_ttl: "invalid")
+    end
+  end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zenrows
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ernest Bursa
@@ -46,27 +46,50 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".mcp.json"
 - ".standard.yml"
+- ".tool-versions"
 - ".yardopts"
 - CHANGELOG.md
 - CLAUDE.md
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - lib/zenrows.rb
+- lib/zenrows/api_client.rb
+- lib/zenrows/api_response.rb
 - lib/zenrows/backends/base.rb
 - lib/zenrows/backends/http_rb.rb
+- lib/zenrows/backends/net_http.rb
 - lib/zenrows/client.rb
 - lib/zenrows/configuration.rb
+- lib/zenrows/css_extractor.rb
 - lib/zenrows/errors.rb
 - lib/zenrows/js_instructions.rb
 - lib/zenrows/proxy.rb
 - lib/zenrows/railtie.rb
 - lib/zenrows/version.rb
 - plan.md
+- sig/manifest.yaml
 - sig/zenrows.rbs
+- sig/zenrows/api_client.rbs
+- sig/zenrows/api_response.rbs
+- sig/zenrows/backends.rbs
+- sig/zenrows/backends/base.rbs
+- sig/zenrows/backends/http_rb.rbs
+- sig/zenrows/backends/net_http.rbs
+- sig/zenrows/client.rbs
+- sig/zenrows/configuration.rbs
+- sig/zenrows/css_extractor.rbs
+- sig/zenrows/errors.rbs
+- sig/zenrows/js_instructions.rbs
+- sig/zenrows/proxy.rbs
 - test/test_helper.rb
+- test/zenrows/api_client_test.rb
+- test/zenrows/api_response_test.rb
 - test/zenrows/client_test.rb
+- test/zenrows/css_extractor_test.rb
 - test/zenrows/js_instructions_test.rb
 - test/zenrows/proxy_test.rb
 - test/zenrows_test.rb
@@ -86,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="