webscraping_ai 1.0.0 → 2.0.0

data/docs/HtmlApi.md

@@ -1,73 +0,0 @@
-# WebScrapingAI::HtmlApi
-
-All URIs are relative to *https://webscraping.ai/api*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_page**](HtmlApi.md#get_page) | **GET** / | Get page HTML by URL (renders JS in Chrome and uses rotating proxies)
-
-
-
-## get_page
-
-> ScrappedPage get_page(url, opts)
-
-Get page HTML by URL (renders JS in Chrome and uses rotating proxies)
-
-### Example
-
-```ruby
-# load the gem
-require 'webscraping_ai'
-# setup authorization
-WebScrapingAI.configure do |config|
-  # Configure API key authorization: api_key
-  config.api_key['api_key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['api_key'] = 'Bearer'
-end
-
-api_instance = WebScrapingAI::HtmlApi.new
-url = 'https://example.com' # String | URL of the page to get
-opts = {
-  selector: 'html', # String | CSS selector to get a part of the page (null by default, returns whole page HTML)
-  outer_html: false, # Boolean | Return outer HTML of the selected element (false by default, returns inner HTML)
-  proxy: 'US', # String | Proxy country code, for geotargeting (US by default)
-  disable_js: false, # Boolean | Disable JS execution (false by default)
-  inline_css: false # Boolean | Inline included CSS files to make page viewable on other domains (false by default)
-}
-
-begin
-  #Get page HTML by URL (renders JS in Chrome and uses rotating proxies)
-  result = api_instance.get_page(url, opts)
-  p result
-rescue WebScrapingAI::ApiError => e
-  puts "Exception when calling HtmlApi->get_page: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **url** | **String**| URL of the page to get | 
- **selector** | **String**| CSS selector to get a part of the page (null by default, returns whole page HTML) | [optional] 
- **outer_html** | **Boolean**| Return outer HTML of the selected element (false by default, returns inner HTML) | [optional] 
- **proxy** | **String**| Proxy country code, for geotargeting (US by default) | [optional] 
- **disable_js** | **Boolean**| Disable JS execution (false by default) | [optional] 
- **inline_css** | **Boolean**| Inline included CSS files to make page viewable on other domains (false by default) | [optional] 
-
-### Return type
-
-[**ScrappedPage**](ScrappedPage.md)
-
-### Authorization
-
-[api_key](../README.md#api_key)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/ScrappedPage.md

@@ -1,23 +0,0 @@
-# WebScrapingAI::ScrappedPage
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**size_bytes** | **Integer** | Page HTML content size in bytes | [optional] 
-**html** | **String** | HTML of the full page or a selected area | [optional] 
-**status** | **Integer** | Response HTTP status code (200, 404, 302, etc) | [optional] 
-**status_message** | **String** | Response HTTP status message | [optional] 
-
-## Code Sample
-
-```ruby
-require 'WebScrapingAI'
-
-instance = WebScrapingAI::ScrappedPage.new(size_bytes: null,
-                                 html: null,
-                                 status: null,
-                                 status_message: null)
-```
-
-

data/spec/models/scrapped_page_spec.rb

@@ -1,59 +0,0 @@
-=begin
-#WebScraping.AI
-
-#This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-
-The version of the OpenAPI document: 1.0.0
-
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
-
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for WebScrapingAI::ScrappedPage
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'ScrappedPage' do
-  before do
-    # run before each test
-    @instance = WebScrapingAI::ScrappedPage.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of ScrappedPage' do
-    it 'should create an instance of ScrappedPage' do
-      expect(@instance).to be_instance_of(WebScrapingAI::ScrappedPage)
-    end
-  end
-  describe 'test attribute "size_bytes"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "html"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "status"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "status_message"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-end