webscraping_ai 1.0.0 → 2.0.0

data/spec/api/selected_html_api_spec.rb

@@ -0,0 +1,103 @@
+=begin
+#WebScraping.AI
+
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for WebScrapingAI::SelectedHTMLApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SelectedHTMLApi' do
+  before do
+    # run before each test
+    @api_instance = WebScrapingAI::SelectedHTMLApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SelectedHTMLApi' do
+    it 'should create an instance of SelectedHTMLApi' do
+      expect(@api_instance).to be_instance_of(WebScrapingAI::SelectedHTMLApi)
+    end
+  end
+
+  # unit tests for get_selected
+  # HTML of a selected page area by URL and CSS selector
+  # Returns just HTML on success, JSON on error
+  # @param url URL of the target page
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :selector CSS selector (null by default, returns whole page HTML)
+  # @option opts [Hash<String, String>] :headers HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;})
+  # @option opts [Integer] :timeout Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
+  # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
+  # @option opts [String] :proxy Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
+  # @return [nil]
+  describe 'get_selected test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_selected_multiple
+  # HTML of multiple page areas by URL and CSS selectors
+  # Always returns JSON
+  # @param url URL of the target page
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :selectors Multiple CSS selectors (null by default, returns whole page HTML)
+  # @option opts [Hash<String, String>] :headers HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;})
+  # @option opts [Integer] :timeout Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
+  # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
+  # @option opts [String] :proxy Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
+  # @return [Array<String>]
+  describe 'get_selected_multiple test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_selected
+  # HTML of a selected page areas by URL and CSS selector, with POST request to the target page
+  # Returns just HTML on success, JSON on error. Request body will be passed to the target page.
+  # @param url URL of the target page
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :selector CSS selector (null by default, returns whole page HTML)
+  # @option opts [Hash<String, String>] :headers HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;})
+  # @option opts [Integer] :timeout Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
+  # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
+  # @option opts [String] :proxy Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
+  # @return [nil]
+  describe 'post_selected test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_selected_multiple
+  # HTML of multiple page areas by URL and CSS selectors, with POST request to the target page
+  # Always returns JSON. Request body will be passed to the target page.
+  # @param url URL of the target page
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :selectors Multiple CSS selectors (null by default, returns whole page HTML)
+  # @option opts [Hash<String, String>] :headers HTTP headers to pass to the target page. Can be specified either via a nested query parameter (...&amp;headers[One]&#x3D;value1&amp;headers&#x3D;[Another]&#x3D;value2) or as a JSON encoded object (...&amp;headers&#x3D;{\&quot;One\&quot;: \&quot;value1\&quot;, \&quot;Another\&quot;: \&quot;value2\&quot;})
+  # @option opts [Integer] :timeout Maximum processing time in ms. Increase it in case of timeout errors (5000 by default, maximum is 30000)
+  # @option opts [Boolean] :js Execute on-page JavaScript using a headless browser (true by default), costs 2 requests
+  # @option opts [String] :proxy Type of proxy, use residential proxies if your site restricts traffic from datacenters (datacenter by default)
+  # @return [Array<String>]
+  describe 'post_selected_multiple test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -1,12 +1,12 @@
 =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
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
 
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -156,7 +156,7 @@ describe WebScrapingAI::ApiClient do
     end
 
     it 'fails for invalid collection format' do
-      expect{api_client.build_collection_param(param, :INVALID)}.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
     end
   end
 

data/spec/configuration_spec.rb

@@ -1,12 +1,12 @@
 =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
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
 
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -18,7 +18,7 @@ describe WebScrapingAI::Configuration do
   before(:each) do
     # uncomment below to setup host and base_path
     # require 'URI'
-    # uri = URI.parse("https://webscraping.ai/api")
+    # uri = URI.parse("https://api.webscraping.ai")
     # WebScrapingAI.configure do |c|
     #   c.host = uri.host
     #   c.base_path = uri.path
@@ -28,14 +28,14 @@ describe WebScrapingAI::Configuration do
   describe '#base_url' do
     it 'should have the default value' do
       # uncomment below to test default value of the base path
-      # expect(config.base_url).to eq("https://webscraping.ai/api")
+      # expect(config.base_url).to eq("https://api.webscraping.ai")
     end
 
     it 'should remove trailing slashes' do
       [nil, '', '/', '//'].each do |base_path|
         config.base_path = base_path
         # uncomment below to test trailing slashes
-        # expect(config.base_url).to eq("https://webscraping.ai/api")
+        # expect(config.base_url).to eq("https://api.webscraping.ai")
       end
     end
   end

data/spec/models/error_spec.rb

@@ -0,0 +1,41 @@
+=begin
+#WebScraping.AI
+
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for WebScrapingAI::Error
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Error' do
+  before do
+    # run before each test
+    @instance = WebScrapingAI::Error.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Error' do
+    it 'should create an instance of Error' do
+      expect(@instance).to be_instance_of(WebScrapingAI::Error)
+    end
+  end
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/page_error_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#WebScraping.AI
+
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for WebScrapingAI::PageError
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PageError' do
+  before do
+    # run before each test
+    @instance = WebScrapingAI::PageError.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PageError' do
+    it 'should create an instance of PageError' do
+      expect(@instance).to be_instance_of(WebScrapingAI::PageError)
+    end
+  end
+  describe 'test attribute "status_code"' 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

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
 =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
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
 
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 

data/webscraping_ai.gemspec

@@ -3,12 +3,12 @@
 =begin
 #WebScraping.AI
 
-#A client for https://webscraping.ai API. It provides Chrome JS rendering, rotating proxies and HTML parsing for web scraping.
-
-The version of the OpenAPI document: 1.0.0
+#A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
 
+The version of the OpenAPI document: 2.0.0
+Contact: support@webscraping.ai
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.3
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["hello@webscraping.ai"]
   s.homepage    = "https://webscraping.ai"
   s.summary     = "WebScraping.AI Ruby Gem"
-  s.description = "A client for https://webscraping.ai API. It provides Chrome JS rendering, rotating proxies and HTML parsing for web scraping."
+  s.description = "A client for https://webscraping.ai API. It provides a web scaping automation API with Chrome JS rendering, rotating proxies and builtin HTML parsing."
   s.license     = 'MIT'
   s.required_ruby_version = ">= 1.9"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webscraping_ai
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - WebScraping.AI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -34,44 +34,44 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.6.0
-description: A client for https://webscraping.ai API. It provides Chrome JS rendering,
-  rotating proxies and HTML parsing for web scraping.
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: A client for https://webscraping.ai API. It provides a web scaping automation
+  API with Chrome JS rendering, rotating proxies and builtin HTML parsing.
 email:
 - hello@webscraping.ai
 executables: []
@@ -79,23 +79,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
-- docs/HtmlApi.md
-- docs/ScrappedPage.md
+- docs/Error.md
+- docs/HTMLApi.md
+- docs/PageError.md
+- docs/SelectedHTMLApi.md
 - git_push.sh
 - lib/webscraping_ai.rb
 - lib/webscraping_ai/api/html_api.rb
+- lib/webscraping_ai/api/selected_html_api.rb
 - lib/webscraping_ai/api_client.rb
 - lib/webscraping_ai/api_error.rb
 - lib/webscraping_ai/configuration.rb
-- lib/webscraping_ai/models/scrapped_page.rb
+- lib/webscraping_ai/models/error.rb
+- lib/webscraping_ai/models/page_error.rb
 - lib/webscraping_ai/version.rb
 - spec/api/html_api_spec.rb
+- spec/api/selected_html_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/scrapped_page_spec.rb
+- spec/models/error_spec.rb
+- spec/models/page_error_spec.rb
 - spec/spec_helper.rb
 - webscraping_ai.gemspec
 homepage: https://webscraping.ai
@@ -117,13 +122,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: WebScraping.AI Ruby Gem
 test_files:
 - spec/api/html_api_spec.rb
+- spec/api/selected_html_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/scrapped_page_spec.rb
+- spec/models/error_spec.rb
+- spec/models/page_error_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,70 +0,0 @@
-PATH
-  remote: .
-  specs:
-    webscraping_ai (1.0.0)
-      json (~> 2.1, >= 2.1.0)
-      typhoeus (~> 1.0, >= 1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    byebug (11.1.1)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.12.2)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
-    method_source (1.0.0)
-    parallel (1.19.1)
-    parser (2.7.0.5)
-      ast (~> 2.4.0)
-    pry (0.13.0)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    psych (3.1.0)
-    rainbow (3.0.0)
-    rake (12.0.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.66.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.1)
-    typhoeus (1.3.1)
-      ethon (>= 0.9.0)
-    unicode-display_width (1.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry-byebug
-  rake (~> 12.0.0)
-  rspec (~> 3.6, >= 3.6.0)
-  rubocop (~> 0.66.0)
-  webscraping_ai!
-
-BUNDLED WITH
-   2.1.2