outscraper 0.3.4 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e490638335315130985cc5b8f5c2c268b72a56142fb4c06383dabff1ecfd3ece
-  data.tar.gz: 2ef885848538c535630b6ded859f0fa8657fd36455e45fe07a7da93bc5180ad9
+  metadata.gz: 36bc03b48faddd06287b3c11a0c457a80412221cc752e19834419b66791eb83b
+  data.tar.gz: 2d46d01a94f94ffd1cbd39d8718ecf6c31172ae9a274f9380f365295a5115454
 SHA512:
-  metadata.gz: 732b1c087ccf83a52193fe54afaf03a0fa31d642dfab11c03c587a04b427df9df2962e0b259690e7e49c3a2de77d36901fc89f9e60953d17aadd836300609780
-  data.tar.gz: 8a8c95af2d738edc5aba671ee0f1005302c6674a81ca5c7c9830c4f8f6b0b4cc53823da594af1df51e6da175b3d81d798ab779c4dc1aa6cb65ea382910e0b779
+  metadata.gz: c359daeb150ec3e8c527b3d1e25cde39decf289215f17d47707089ca0d4e61de61a2ae8e837686bd3521e22f44c9746b5d0a73454dc3bf5ee4b6ddc06fa076e4
+  data.tar.gz: 715e674806c05bf2daf94f153b5c30c04639b4a6452178b82adb361cddca5c8e97d32783b5dc72f78569f541149f8ed2099fca624f75381346736c9363c433fb

data/README.md

@@ -22,7 +22,7 @@ require 'Outscraper'
 
 client = Outscraper::Client.new('SECRET_API_KEY')
 ```
-[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+[Link to the account page to create the API key](https://app.outscraper.com/account/api)
 
 ## Usage
 

data/examples/Businesses.md

@@ -0,0 +1,123 @@
+# Businesses Search With Ruby
+
+The library provides real-time access to business records via the [Outscraper API](https://app.outscraper.com/api-docs).
+It supports classic structured filters and AI-powered plain-text queries for flexible search.
+
+- Structured search using `filters`, `fields`, `limit`, and other parameters
+- AI-powered search using the `query` parameter
+- Combined mode where structured params and `query` are merged by the server
+
+---
+
+## Installation
+
+Install the gem and add it to the application's Gemfile by executing:
+
+```bash
+bundle add outscraper
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install outscraper
+```
+
+[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
+
+---
+
+## Initialization
+
+```ruby
+require "outscraper"
+
+client = Outscraper::Client.new("SECRET_API_KEY")
+```
+
+[Link to the profile page to create the API key](https://app.outscraper.com/profile)
+
+---
+
+## Usage
+
+### Search businesses with structured filters
+
+```ruby
+results = client.businessesSearch(
+  filters: {
+    country_code: "US",
+    states: ["NY"],
+    cities: ["New York", "Buffalo"],
+    types: ["restaurant", "cafe"],
+    has_website: true,
+    has_phone: true,
+    business_statuses: ["operational"]
+  },
+  limit: 50,
+  include_total: false,
+  fields: ["name", "phone", "website", "address", "rating", "reviews"]
+)
+
+puts results
+```
+
+### Search businesses with AI plain-text query
+
+```ruby
+results = client.businessesSearch(
+  query: "Find cafes in New York, NY. Limit 25. Return name, address, phone, website, rating and reviews."
+)
+
+puts results
+```
+
+### Combine structured params and plain-text query
+
+```ruby
+results = client.businessesSearch(
+  filters: {
+    country_code: "US",
+    states: ["CA"],
+    types: ["restaurant"]
+  },
+  fields: ["name", "phone"],
+  limit: 15,
+  query: "Add cafes too. Return address and reviews. Limit 20. Include total."
+)
+
+puts results
+```
+
+When both structured params and `query` are provided:
+
+- `filters` and `fields` are merged
+- for `limit`, `cursor`, and `include_total`, plain-text values take priority when present
+- if a value is not specified, API defaults are used
+
+### Iterate through all results (auto-pagination)
+
+```ruby
+items = client.businessesIterSearch(
+  filters: {
+    country_code: "US",
+    states: ["NY"],
+    business_statuses: ["operational"]
+  },
+  limit: 100,
+  fields: ["name", "phone", "address", "rating", "reviews"]
+)
+
+puts items.length
+```
+
+### Get business details by ID
+
+```ruby
+business = client.businessesGet(
+  "YOUR_BUSINESS_ID",
+  fields: ["name", "phone", "website", "address", "rating", "reviews"]
+)
+
+puts business
+```

data/lib/outscraper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Outscraper
-  VERSION = "0.3.4"
+  VERSION = "0.3.6"
 end

data/lib/outscraper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "httparty"
+require "cgi"
+require "json"
 
 require_relative "outscraper/version"
 
@@ -391,5 +393,91 @@ module Outscraper
         webhook: webhook
       }).parsed_response['data']
     end
+
+    def postAPIRequest(path, parameters = {})
+      payload = parameters || {}
+
+      response = self.class.post(
+        path,
+        headers: { 'Content-Type' => 'application/json' },
+        body: payload.to_json
+      ).parsed_response
+
+      response.is_a?(Hash) && response.key?('data') ? response['data'] : response
+    end
+
+    def businessesSearch(
+      filters: {},
+      limit: 10,
+      include_total: false,
+      cursor: nil,
+      fields: nil,
+      async_request: false,
+      ui: false,
+      webhook: nil,
+      query: nil
+    )
+      payload = {
+        filters: (filters || {}),
+        limit: limit,
+        include_total: include_total,
+        cursor: cursor,
+        fields: fields ? Array(fields) : nil,
+        query: query,
+        async: async_request,
+        ui: ui,
+        webhook: webhook
+      }.compact
+
+      postAPIRequest('/businesses', payload)
+    end
+
+    def businessesIterSearch(filters: {}, limit: 10, fields: nil, include_total: false)
+      cursor = nil
+      all_items = []
+
+      loop do
+        page = businessesSearch(
+          filters: filters,
+          limit: limit,
+          include_total: include_total,
+          cursor: cursor,
+          fields: fields,
+          async_request: false
+        )
+
+        items = page.is_a?(Hash) ? (page['items'] || []) : []
+        break if !items.is_a?(Array) || items.empty?
+
+        all_items.concat(items)
+
+        has_more = !!(page['has_more'])
+        next_cursor = page['next_cursor']
+        break if !has_more || next_cursor.nil? || next_cursor.to_s.strip.empty?
+
+        cursor = next_cursor.to_s
+      end
+
+      all_items
+    end
+
+    def businessesGet(business_id, fields: nil, async_request: false, ui: false, webhook: nil)
+      raise ArgumentError, 'business_id is required' if business_id.nil? || business_id.to_s.strip.empty?
+
+      fields_param =
+        if fields.is_a?(Array)
+          fields.map(&:to_s).join(',')
+        else
+          fields
+        end
+
+      response = self.class.get("/businesses/#{CGI.escape(business_id.to_s)}", query: {
+        fields: fields_param,
+        async: async_request,
+        ui: ui,
+        webhook: webhook
+      }.compact).parsed_response
+      response.is_a?(Hash) && response.key?('data') ? response['data'] : response
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outscraper
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.6
 platform: ruby
 authors:
 - Outscraper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-08 00:00:00.000000000 Z
+date: 2026-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,6 +39,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/Businesses.md
 - examples/Company Insights.md
 - examples/Company Website Finder.md
 - examples/Contacts And Leads.md