scrapebadger 0.1.0

data/lib/scrapebadger/models/webhook_test_response.rb

@@ -0,0 +1,259 @@
+=begin
+#ScrapeBadger API
+
+#Unified credit-based scraping API. https://docs.scrapebadger.com
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ScrapeBadger
+  # Test webhook delivery result.
+  class WebhookTestResponse
+    attr_accessor :success
+
+    attr_accessor :status_code
+
+    # Round-trip time in milliseconds
+    attr_accessor :response_time_ms
+
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'success' => :'success',
+        :'status_code' => :'status_code',
+        :'response_time_ms' => :'response_time_ms',
+        :'error' => :'error'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'success' => :'Boolean',
+        :'status_code' => :'Integer',
+        :'response_time_ms' => :'Float',
+        :'error' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'status_code',
+        :'error'
+      ])
+    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 `ScrapeBadger::WebhookTestResponse` 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 `ScrapeBadger::WebhookTestResponse`. 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?(:'success')
+        self.success = attributes[:'success']
+      else
+        self.success = nil
+      end
+
+      if attributes.key?(:'status_code')
+        self.status_code = attributes[:'status_code']
+      end
+
+      if attributes.key?(:'response_time_ms')
+        self.response_time_ms = attributes[:'response_time_ms']
+      else
+        self.response_time_ms = nil
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @success.nil?
+        invalid_properties.push('invalid value for "success", success cannot be nil.')
+      end
+
+      if @response_time_ms.nil?
+        invalid_properties.push('invalid value for "response_time_ms", response_time_ms cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @success.nil?
+      return false if @response_time_ms.nil?
+      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 &&
+          success == o.success &&
+          status_code == o.status_code &&
+          response_time_ms == o.response_time_ms &&
+          error == o.error
+    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
+      [success, status_code, response_time_ms, error].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = ScrapeBadger.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/scrapebadger/version.rb

@@ -0,0 +1,15 @@
+=begin
+#ScrapeBadger API
+
+#Unified credit-based scraping API. https://docs.scrapebadger.com
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+module ScrapeBadger
+  VERSION = '0.1.0'
+end

data/lib/scrapebadger.rb

@@ -0,0 +1,96 @@
+=begin
+#ScrapeBadger API
+
+#Unified credit-based scraping API. https://docs.scrapebadger.com
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+# Common files
+require 'scrapebadger/api_client'
+require 'scrapebadger/api_error'
+require 'scrapebadger/version'
+require 'scrapebadger/configuration'
+
+# Models
+require 'scrapebadger/models/account_info'
+require 'scrapebadger/models/billing_log_list_response'
+require 'scrapebadger/models/billing_log_response'
+require 'scrapebadger/models/filter_rule_create'
+require 'scrapebadger/models/filter_rule_delivery_log_list_response'
+require 'scrapebadger/models/filter_rule_delivery_log_response'
+require 'scrapebadger/models/filter_rule_list_response'
+require 'scrapebadger/models/filter_rule_response'
+require 'scrapebadger/models/filter_rule_update'
+require 'scrapebadger/models/filter_rule_validate_request'
+require 'scrapebadger/models/filter_rule_validate_response'
+require 'scrapebadger/models/http_validation_error'
+require 'scrapebadger/models/portal_api_routers_v1_twitter_filter_rules_filter_rule_pricing_response'
+require 'scrapebadger/models/stream_monitor_create'
+require 'scrapebadger/models/stream_monitor_list_response'
+require 'scrapebadger/models/stream_monitor_response'
+require 'scrapebadger/models/stream_monitor_update'
+require 'scrapebadger/models/subscription_info'
+require 'scrapebadger/models/tweet_delivery_log_list_response'
+require 'scrapebadger/models/tweet_delivery_log_response'
+require 'scrapebadger/models/validation_error'
+require 'scrapebadger/models/validation_error_loc_inner'
+require 'scrapebadger/models/webhook_create'
+require 'scrapebadger/models/webhook_list_item'
+require 'scrapebadger/models/webhook_list_response'
+require 'scrapebadger/models/webhook_response'
+require 'scrapebadger/models/webhook_test_request'
+require 'scrapebadger/models/webhook_test_response'
+
+# APIs
+require 'scrapebadger/api/account_api'
+require 'scrapebadger/api/amazon_api'
+require 'scrapebadger/api/apartments_api'
+require 'scrapebadger/api/baidu_api'
+require 'scrapebadger/api/bing_api'
+require 'scrapebadger/api/chat_gpt_api'
+require 'scrapebadger/api/depop_api'
+require 'scrapebadger/api/duck_duck_go_api'
+require 'scrapebadger/api/e_bay_api'
+require 'scrapebadger/api/facebook_api'
+require 'scrapebadger/api/google_api'
+require 'scrapebadger/api/idealista_api'
+require 'scrapebadger/api/immobiliare_api'
+require 'scrapebadger/api/instagram_api'
+require 'scrapebadger/api/leboncoin_api'
+require 'scrapebadger/api/linked_in_api'
+require 'scrapebadger/api/loop_net_api'
+require 'scrapebadger/api/realtor_api'
+require 'scrapebadger/api/reddit_api'
+require 'scrapebadger/api/redfin_api'
+require 'scrapebadger/api/tik_tok_api'
+require 'scrapebadger/api/twitter_api'
+require 'scrapebadger/api/vinted_api'
+require 'scrapebadger/api/walmart_api'
+require 'scrapebadger/api/web_api'
+require 'scrapebadger/api/yahoo_api'
+require 'scrapebadger/api/yandex_api'
+require 'scrapebadger/api/you_tube_api'
+require 'scrapebadger/api/zillow_api'
+
+module ScrapeBadger
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ScrapeBadger.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/scrapebadger.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#ScrapeBadger API
+
+#Unified credit-based scraping API. https://docs.scrapebadger.com
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "scrapebadger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scrapebadger"
+  s.version     = ScrapeBadger::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://github.com/scrape-badger/scrapebadger-ruby"
+  s.summary     = "ScrapeBadger API Ruby Gem"
+  s.description = "Unified credit-based scraping API. https://docs.scrapebadger.com"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/account_api_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#ScrapeBadger API
+
+#Unified credit-based scraping API. https://docs.scrapebadger.com
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ScrapeBadger::AccountApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AccountApi' do
+  before do
+    # run before each test
+    @api_instance = ScrapeBadger::AccountApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountApi' do
+    it 'should create an instance of AccountApi' do
+      expect(@api_instance).to be_instance_of(ScrapeBadger::AccountApi)
+    end
+  end
+
+  # unit tests for account_get_account_info
+  # Get account info
+  # Get account details for the authenticated API key.  Returns credit balances, tier, rate limit, and subscription details. No credits are deducted for this call.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountInfo]
+  describe 'account_get_account_info test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end