ethon-impersonate 0.17.9-arm64-darwin

data/lib/ethon_impersonate/easy/http.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'ethon_impersonate/easy/http/actionable'
+require 'ethon_impersonate/easy/http/post'
+require 'ethon_impersonate/easy/http/get'
+require 'ethon_impersonate/easy/http/head'
+require 'ethon_impersonate/easy/http/put'
+require 'ethon_impersonate/easy/http/delete'
+require 'ethon_impersonate/easy/http/patch'
+require 'ethon_impersonate/easy/http/options'
+require 'ethon_impersonate/easy/http/custom'
+
+module EthonImpersonate
+  class Easy
+
+    # This module contains logic about making valid HTTP requests.
+    module Http
+
+      # Set specified options in order to make a HTTP request.
+      # Look at {EthonImpersonate::Easy::Options Options} to see what you can
+      # provide in the options hash.
+      #
+      # @example Set options for HTTP request.
+      #   easy.http_request("www.google.com", :get, {})
+      #
+      # @param [ String ] url The url.
+      # @param [ String ] action_name The HTTP action name.
+      # @param [ Hash ] options The options hash.
+      #
+      # @option options :params [ Hash ] Params hash which
+      #   is attached to the url.
+      # @option options :body [ Hash ] Body hash which
+      #   becomes the request body. It is a PUT body for
+      #   PUT requests and a POST for everything else.
+      # @option options :headers [ Hash ] Request headers.
+      #
+      # @return [ void ]
+      #
+      # @see EthonImpersonate::Easy::Options
+      def http_request(url, action_name, options = {})
+        fabricate(url, action_name, options).setup(self)
+      end
+
+      private
+
+      # Return the corresponding action class.
+      #
+      # @example Return the action.
+      #   Action.fabricate(:get)
+      #   Action.fabricate(:smash)
+      #
+      # @param [ String ] url The url.
+      # @param [ String ] action_name The HTTP action name.
+      # @param [ Hash ] options The option hash.
+      #
+      # @return [ Easy::EthonImpersonate::Actionable ] The request instance.
+      def fabricate(url, action_name, options)
+        constant_name = action_name.to_s.capitalize
+
+        if EthonImpersonate::Easy::Http.const_defined?(constant_name)
+          EthonImpersonate::Easy::Http.const_get(constant_name).new(url, options)
+        else
+          EthonImpersonate::Easy::Http::Custom.new(constant_name.upcase, url, options)
+        end
+      end
+
+    end
+  end
+end

data/lib/ethon_impersonate/easy/informations.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy
+
+    # This module contains the methods to return informations
+    # from the easy handle. See http://curl.haxx.se/libcurl/c/curl_easy_getinfo.html
+    # for more information.
+    module Informations
+
+      # Holds available informations and their type, which is needed to
+      # request the informations from libcurl.
+      AVAILABLE_INFORMATIONS = {
+        # Return the available HTTP auth methods.
+        httpauth_avail: :long,
+
+        # Return the total time in seconds for the previous
+        # transfer, including name resolution, TCP connection, etc.
+        total_time: :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the first byte was received by libcurl. This
+        # includes pre-transfer time and also the time the
+        # server needs to calculate the result.
+        starttransfer_time: :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the SSL/SSH connect/handshake to the remote
+        # host was completed. This time is most often very near
+        # to the pre-transfer time, except for cases such as HTTP
+        # pipelining where the pre-transfer time can be delayed
+        # due to waits in line for the pipeline and more.
+        appconnect_time: :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the file transfer was just about to begin. This
+        # includes all pre-transfer commands and negotiations
+        # that are specific to the particular protocol(s) involved.
+        # It does not involve the sending of the protocol-
+        # specific request that triggers a transfer.
+        pretransfer_time: :double,
+
+        # Return the time, in seconds, it took from the start
+        # until the connect to the remote host (or proxy) was completed.
+        connect_time: :double,
+
+        # Return the time, in seconds, it took from the
+        # start until the name resolution was completed.
+        namelookup_time: :double,
+
+        # Return the time, in seconds, it took for all redirection steps
+        # include name lookup, connect, pretransfer and transfer before the
+        # final transaction was started. time_redirect shows the complete
+        # execution time for multiple redirections. (Added in 7.12.3)
+        redirect_time: :double,
+
+        # Return the last used effective url.
+        effective_url: :string,
+
+        # Return the string holding the IP address of the most recent
+        # connection done with this curl handle. This string
+        # may be IPv6 if that's enabled.
+        primary_ip: :string,
+
+        # Return the last received HTTP, FTP or SMTP response code.
+        # The value will be zero if no server response code has
+        # been received. Note that a proxy's CONNECT response should
+        # be read with http_connect_code and not this.
+        response_code: :long,
+
+        request_size: :long,
+
+        # Return the total number of redirections that were
+        # actually followed.
+        redirect_count: :long,
+
+        # URL a redirect would take you to, had you enabled redirects (Added in 7.18.2)
+        redirect_url: :string,
+
+        # Return the bytes, the total amount of bytes that were uploaded
+        size_upload: :double,
+
+        # Return the bytes, the total amount of bytes that were downloaded.
+        # The amount is only for the latest transfer and will be reset again
+        # for each new transfer. This counts actual payload data, what's
+        # also commonly called body. All meta and header data are excluded
+        # and will not be counted in this number.
+        size_download: :double,
+
+        # Return the bytes/second, the average upload speed that curl
+        # measured for the complete upload
+        speed_upload: :double,
+
+        # Return the bytes/second, the average download speed that curl
+        # measured for the complete download
+        speed_download: :double
+      }
+
+      AVAILABLE_INFORMATIONS.each do |name, type|
+        define_method(name) do
+          Curl.send("get_info_#{type}".to_sym, name.to_sym, handle)
+        end
+      end
+
+      # Returns true if this curl version supports zlib.
+      #
+      # @example Return wether zlib is supported.
+      #   easy.supports_zlib?
+      #
+      # @return [ Boolean ] True if supported, else false.
+      # @deprecated Please use the static version instead
+      def supports_zlib?
+        Kernel.warn("EthonImpersonate: Easy#supports_zlib? is deprecated and will be removed, please use Easy#.")
+        Easy.supports_zlib?
+      end
+
+    end
+  end
+end

data/lib/ethon_impersonate/easy/mirror.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy
+    class Mirror
+      attr_reader :options
+      alias_method :to_hash, :options
+
+      INFORMATIONS_TO_MIRROR = Informations::AVAILABLE_INFORMATIONS.keys +
+          [:return_code, :response_headers, :response_body, :debug_info]
+
+      INFORMATIONS_TO_LOG = [:effective_url, :response_code, :return_code, :total_time]
+
+      def self.from_easy(easy)
+        options = {}
+        INFORMATIONS_TO_MIRROR.each do |info|
+          options[info] = easy.send(info)
+        end
+        new(options)
+      end
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def log_informations
+        Hash[*INFORMATIONS_TO_LOG.map do |info|
+          [info, options[info]]
+        end.flatten]
+      end
+
+      INFORMATIONS_TO_MIRROR.each do |info|
+        define_method(info) do
+          options[info]
+        end
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/easy/operations.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy
+    # This module contains the logic to prepare and perform
+    # an easy.
+    module Operations
+      # Returns a pointer to the curl easy handle.
+      #
+      # @example Return the handle.
+      #   easy.handle
+      #
+      # @return [ FFI::Pointer ] A pointer to the curl easy handle.
+      def handle
+        @handle ||= FFI::AutoPointer.new(Curl.easy_init, Curl.method(:easy_cleanup))
+      end
+
+      # Sets a pointer to the curl easy handle.
+      # @param [ ::FFI::Pointer ] Easy handle that will be assigned.
+      def handle=(h)
+        @handle = h
+      end
+
+      # Perform the easy request.
+      #
+      # @example Perform the request.
+      #   easy.perform
+      #
+      # @return [ Integer ] The return code.
+      def perform
+        @return_code = Curl.easy_perform(handle)
+        if EthonImpersonate.logger.debug?
+          EthonImpersonate.logger.debug { "ETHON: performed #{log_inspect}" }
+        end
+        complete
+        @return_code
+      end
+
+      # Clean up the easy.
+      #
+      # @example Perform clean up.
+      #   easy.cleanup
+      #
+      # @return the result of the free which is nil
+      def cleanup
+        handle.free
+      end
+
+      # Prepare the easy. Options, headers and callbacks
+      # were set.
+      #
+      # @example Prepare easy.
+      #   easy.prepare
+      #
+      # @deprecated It is no longer necessary to call prepare.
+      def prepare
+        EthonImpersonate.logger.warn(
+          "ETHON: It is no longer necessary to call "+
+          "Easy#prepare. It's going to be removed "+
+          "in future versions."
+        )
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/easy/options.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy
+
+    # This module contains the logic and knowledge about the
+    # available options on easy.
+    module Options
+      attr_reader :url
+
+      def url=(value)
+        @url = value
+        Curl.set_option(:url, value, handle)
+      end
+
+      def escape=( b )
+        @escape = b
+      end
+
+      def escape?
+        return true if !defined?(@escape) || @escape.nil?
+        @escape
+      end
+
+      def multipart=(b)
+        @multipart = b
+      end
+
+      def multipart?
+        !!@multipart
+      end
+
+      Curl.easy_options(nil).each do |opt, props|
+        method_name = "#{opt}=".freeze
+        unless method_defined? method_name
+          define_method(method_name) do |value|
+            Curl.set_option(opt, value, handle)
+            value
+          end
+        end
+        next if props[:type] != :callback || method_defined?(opt)
+        define_method(opt) do |&block|
+          @procs ||= {}
+          @procs[opt.to_sym] = block
+          Curl.set_option(opt, block, handle)
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/easy/params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'ethon_impersonate/easy/util'
+require 'ethon_impersonate/easy/queryable'
+
+module EthonImpersonate
+  class Easy
+
+    # This class represents HTTP request parameters.
+    #
+    # @api private
+    class Params
+      include EthonImpersonate::Easy::Util
+      include EthonImpersonate::Easy::Queryable
+
+      # Create a new Params.
+      #
+      # @example Create a new Params.
+      #   Params.new({})
+      #
+      # @param [ Hash ] params The params to use.
+      #
+      # @return [ Params ] A new Params.
+      def initialize(easy, params)
+        @easy = easy
+        @params = params || {}
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/easy/queryable.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy
+
+    # This module contains logic about building
+    # query parameters for url or form.
+    module Queryable
+
+      # :nodoc:
+      def self.included(base)
+        base.send(:attr_accessor, :escape)
+        base.send(:attr_accessor, :params_encoding)
+      end
+
+      # Return wether there are elements in params or not.
+      #
+      # @example Return if params is empty.
+      #   form.empty?
+      #
+      # @return [ Boolean ] True if params is empty, else false.
+      def empty?
+        @params.empty?
+      end
+
+      # Return the string representation of params.
+      #
+      # @example Return string representation.
+      #   params.to_s
+      #
+      # @return [ String ] The string representation.
+      def to_s
+        @to_s ||= query_pairs.map{ |pair|
+          return pair if pair.is_a?(String)
+
+          if escape && @easy
+            pair.map{ |e| @easy.escape(e.to_s) }.join("=")
+          else
+            pair.join("=")
+          end
+        }.join('&')
+      end
+
+      # Return the query pairs.
+      #
+      # @example Return the query pairs.
+      #   params.query_pairs
+      #
+      # @return [ Array ] The query pairs.
+      def query_pairs
+        @query_pairs ||= build_query_pairs(@params)
+      end
+
+      # Return query pairs build from a hash.
+      #
+      # @example Build query pairs.
+      #   action.build_query_pairs({a: 1, b: 2})
+      #   #=> [[:a, 1], [:b, 2]]
+      #
+      # @param [ Hash ] hash The hash to go through.
+      #
+      # @return [ Array ] The array of query pairs.
+      def build_query_pairs(hash)
+        return [hash] if hash.is_a?(String)
+
+        pairs = []
+        recursively_generate_pairs(hash, nil, pairs)
+        pairs
+      end
+
+      # Return file info for a file.
+      #
+      # @example Return file info.
+      #   action.file_info(File.open('fubar', 'r'))
+      #
+      # @param [ File ] file The file to handle.
+      #
+      # @return [ Array ] Array of informations.
+      def file_info(file)
+        filename = File.basename(file.path)
+        [
+          filename,
+          mime_type(filename),
+          File.expand_path(file.path)
+        ]
+      end
+
+      private
+
+      def mime_type(filename)
+        if defined?(MIME) && t = MIME::Types.type_for(filename).first
+          t.to_s
+        else
+          'application/octet-stream'
+        end
+      end
+
+      def recursively_generate_pairs(h, prefix, pairs)
+        case h
+        when Hash
+          encode_hash_pairs(h, prefix, pairs)
+        when Array
+          if params_encoding == :rack
+            encode_rack_array_pairs(h, prefix, pairs)
+          elsif params_encoding == :multi
+            encode_multi_array_pairs(h, prefix, pairs)
+          elsif params_encoding == :none
+            pairs << [prefix, h]
+          else
+            encode_indexed_array_pairs(h, prefix, pairs)
+          end
+        end
+      end
+
+      def encode_hash_pairs(h, prefix, pairs)
+        h.each_pair do |k,v|
+          key = prefix.nil? ? k : "#{prefix}[#{k}]"
+          pairs_for(v, key, pairs)
+        end
+      end
+
+      def encode_indexed_array_pairs(h, prefix, pairs)
+        h.each_with_index do |v, i|
+          key = "#{prefix}[#{i}]"
+          pairs_for(v, key, pairs)
+        end
+      end
+
+      def encode_rack_array_pairs(h, prefix, pairs)
+        h.each do |v|
+          key = "#{prefix}[]"
+          pairs_for(v, key, pairs)
+        end
+      end
+
+    def encode_multi_array_pairs(h, prefix, pairs)
+      h.each_with_index do |v, i|
+        key = prefix
+        pairs_for(v, key, pairs)
+      end
+    end
+
+      def pairs_for(v, key, pairs)
+        case v
+        when Hash, Array
+          recursively_generate_pairs(v, key, pairs)
+        when File, Tempfile
+          pairs << [key, file_info(v)]
+        else
+          pairs << [key, v]
+        end
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/easy/response_callbacks.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy
+
+    # This module contains the logic for the response callbacks.
+    # The on_complete callback is the only one at the moment.
+    #
+    # You can set multiple callbacks, which are then executed
+    # in the same order.
+    #
+    #   easy.on_complete { p 1 }
+    #   easy.on_complete { p 2 }
+    #   easy.complete
+    #   #=> 1
+    #   #=> 2
+    #
+    # You can clear the callbacks:
+    #
+    #   easy.on_complete { p 1 }
+    #   easy.on_complete { p 2 }
+    #   easy.on_complete.clear
+    #   easy.on_complete
+    #   #=> []
+    module ResponseCallbacks
+
+      # Set on_headers callback.
+      #
+      # @example Set on_headers.
+      #   request.on_headers { p "yay" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_headers(&block)
+        @on_headers ||= []
+        @on_headers << block if block_given?
+        @on_headers
+      end
+
+      # Execute on_headers callbacks.
+      #
+      # @example Execute on_headers.
+      #   request.headers
+      def headers
+        return if @headers_called
+        @headers_called = true
+        if defined?(@on_headers) and not @on_headers.nil?
+          result = nil
+          @on_headers.each do |callback|
+            result = callback.call(self)
+            break if result == :abort
+          end
+          result
+        end
+      end
+
+      # Set on_complete callback.
+      #
+      # @example Set on_complete.
+      #   request.on_complete { p "yay" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_complete(&block)
+        @on_complete ||= []
+        @on_complete << block if block_given?
+        @on_complete
+      end
+
+      # Execute on_complete callbacks.
+      #
+      # @example Execute on_completes.
+      #   request.complete
+      def complete
+        headers unless @response_headers.empty?
+        if defined?(@on_complete) and not @on_complete.nil?
+          @on_complete.each{ |callback| callback.call(self) }
+        end
+      end
+
+      # Set on_progress callback.
+      #
+      # @example Set on_progress.
+      #   request.on_progress {|dltotal, dlnow, ultotal, ulnow| p "#{dltotal} #{dlnow} #{ultotal} #{ulnow}" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_progress(&block)
+        @on_progress ||= []
+        if block_given?
+          @on_progress << block
+          set_progress_callback
+          self.noprogress = 0
+        end
+        @on_progress
+      end
+
+      # Execute on_progress callbacks.
+      #
+      # @example Execute on_progress.
+      #   request.body(1, 1, 1, 1)
+      def progress(dltotal, dlnow, ultotal, ulnow)
+        if defined?(@on_progress) and not @on_progress.nil?
+          @on_progress.each{ |callback| callback.call(dltotal, dlnow, ultotal, ulnow) }
+        end
+      end
+
+      # Set on_body callback.
+      #
+      # @example Set on_body.
+      #   request.on_body { |chunk| p "yay" }
+      #
+      # @param [ Block ] block The block to execute.
+      def on_body(&block)
+        @on_body ||= []
+        @on_body << block if block_given?
+        @on_body
+      end
+
+      # Execute on_body callbacks.
+      #
+      # @example Execute on_body.
+      #   request.body("This data came from HTTP.")
+      #
+      # @return [ Object ] If there are no on_body callbacks, returns the symbol :unyielded.
+      def body(chunk)
+        if defined?(@on_body) and not @on_body.nil?
+          result = nil
+          @on_body.each do |callback|
+            result = callback.call(chunk, self)
+            break if result == :abort
+          end
+          result
+        else
+          :unyielded
+        end
+      end
+    end
+  end
+end

data/lib/ethon_impersonate/easy/util.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module EthonImpersonate
+  class Easy # :nodoc:
+
+    # This module contains small helpers.
+    #
+    # @api private
+    module Util
+
+      # Escapes zero bytes in strings.
+      #
+      # @example Escape zero bytes.
+      #   Util.escape_zero_byte("1\0")
+      #   #=> "1\\0"
+      #
+      # @param [ Object ] value The value to escape.
+      #
+      # @return [ String, Object ] Escaped String if
+      #   zero byte found, original object if not.
+      def escape_zero_byte(value)
+        return value unless value.to_s.include?(0.chr)
+        value.to_s.gsub(0.chr, '\\\0')
+      end
+
+      extend self
+    end
+  end
+end