webscraping_ai 1.0.0 → 2.0.0

data/lib/webscraping_ai/api_client.rb

@@ -1,12 +1,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
 
@@ -269,11 +269,13 @@ module WebScrapingAI
         tempfile.write(chunk)
       end
       request.on_complete do |response|
-        tempfile.close if tempfile
-        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                            "explicitly with `tempfile.delete`"
+        if tempfile
+          tempfile.close
+          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                              "explicitly with `tempfile.delete`"
+        end
       end
     end
 

data/lib/webscraping_ai/api_error.rb

@@ -1,12 +1,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
 

data/lib/webscraping_ai/configuration.rb

@@ -1,12 +1,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
 
@@ -127,8 +127,8 @@ module WebScrapingAI
 
     def initialize
       @scheme = 'https'
-      @host = 'webscraping.ai'
-      @base_path = '/api'
+      @host = 'api.webscraping.ai'
+      @base_path = ''
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -207,7 +207,7 @@ module WebScrapingAI
     def server_settings
       [
         {
-          url: "https://webscraping.ai/api/",
+          url: "https://api.webscraping.ai",
           description: "No description provided",
         }
       ]

data/lib/webscraping_ai/models/error.rb

@@ -0,0 +1,207 @@
+=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 'date'
+
+module WebScrapingAI
+  class Error
+    # Error description
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'message' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WebScrapingAI::Error` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WebScrapingAI::Error`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          message == o.message
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [message].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        WebScrapingAI.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/webscraping_ai/models/{scrapped_page.rb → page_error.rb}

@@ -1,27 +1,21 @@
 =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
 
 require 'date'
 
 module WebScrapingAI
-  class ScrappedPage
-    # Page HTML content size in bytes
-    attr_accessor :size_bytes
-
-    # HTML of the full page or a selected area
-    attr_accessor :html
-
-    # Response HTTP status code (200, 404, 302, etc)
-    attr_accessor :status
+  class PageError
+    # Response HTTP status code (403, 500, etc)
+    attr_accessor :status_code
 
     # Response HTTP status message
     attr_accessor :status_message
@@ -29,19 +23,15 @@ module WebScrapingAI
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'size_bytes' => :'size_bytes',
-        :'html' => :'html',
-        :'status' => :'status',
-        :'status_message' => :'statusMessage'
+        :'status_code' => :'status_code',
+        :'status_message' => :'status_message'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'size_bytes' => :'Integer',
-        :'html' => :'String',
-        :'status' => :'Integer',
+        :'status_code' => :'Integer',
         :'status_message' => :'String'
       }
     end
@@ -56,27 +46,19 @@ module WebScrapingAI
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `WebScrapingAI::ScrappedPage` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WebScrapingAI::PageError` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `WebScrapingAI::ScrappedPage`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WebScrapingAI::PageError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'size_bytes')
-        self.size_bytes = attributes[:'size_bytes']
-      end
-
-      if attributes.key?(:'html')
-        self.html = attributes[:'html']
-      end
-
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
+      if attributes.key?(:'status_code')
+        self.status_code = attributes[:'status_code']
       end
 
       if attributes.key?(:'status_message')
@@ -102,9 +84,7 @@ module WebScrapingAI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          size_bytes == o.size_bytes &&
-          html == o.html &&
-          status == o.status &&
+          status_code == o.status_code &&
           status_message == o.status_message
     end
 
@@ -117,7 +97,7 @@ module WebScrapingAI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [size_bytes, html, status, status_message].hash
+      [status_code, status_message].hash
     end
 
     # Builds the object from hash

data/lib/webscraping_ai/version.rb

@@ -1,15 +1,15 @@
 =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
 
 module WebScrapingAI
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/spec/api/html_api_spec.rb

@@ -1,43 +1,64 @@
 =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
 
 require 'spec_helper'
 require 'json'
 
-# Unit tests for WebScrapingAI::HtmlApi
+# Unit tests for WebScrapingAI::HTMLApi
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'HtmlApi' do
+describe 'HTMLApi' do
   before do
     # run before each test
-    @api_instance = WebScrapingAI::HtmlApi.new
+    @api_instance = WebScrapingAI::HTMLApi.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of HtmlApi' do
-    it 'should create an instance of HtmlApi' do
-      expect(@api_instance).to be_instance_of(WebScrapingAI::HtmlApi)
+  describe 'test an instance of HTMLApi' do
+    it 'should create an instance of HTMLApi' do
+      expect(@api_instance).to be_instance_of(WebScrapingAI::HTMLApi)
+    end
+  end
+
+  # unit tests for get_html
+  # Page HTML by URL
+  # Returns just HTML on success, JSON on error
+  # @param url URL of the target page
+  # @param [Hash] opts the optional parameters
+  # @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_html 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_page
-  # Get page HTML by URL
-  # @param url URL of the page to get
+  # unit tests for post_html
+  # Page HTML by URL 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
-  # @return [ScrappedPage]
-  describe 'get_page test' do
+  # @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_html test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end