tiny_grabber 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6854187622de409b8cbbdcb66359518a44562040
-  data.tar.gz: 23c45d3540c56c6ce59f9a5c12933814bb3442be
+  metadata.gz: 8385d450b76a0d89ffa5586ee9f9a684f56bce00
+  data.tar.gz: a6691e3ad022cf3ad32d1924ce947b28786d8bda
 SHA512:
-  metadata.gz: b838e5fb70eb94dd2eadb48cf562124d3369c748e9525fa639d0123df17b6b3f58e4862b0f6be6ec64cbdb51ef2e091d8c34c20f76c1ceeb73fdbc4f703f7845
-  data.tar.gz: a395c1fe156fbbcc32724c77da62abf1ac54766c6376b93ba15271592d53a3726bb694ba2f5fb9e01d86e5d06236e6be4eca7090a681e29589c82bfb19e83245
+  metadata.gz: 72639e18d054c04ac01549d4cc044395b44dff3267ea51408d77488ec56b9130ea104d796b07c73252ed2b40bbbfa1222ac6fe64a8e90e3f728f6f65ee33fef6
+  data.tar.gz: 967877a786a60e4204cdf8066e7ab27a997449f7ac8a9fa73e74ce2ca50cecc820df586e70205e548747305d7f05476936d6149466544b28165660591270f969

data/README.md

@@ -32,31 +32,39 @@ require 'tiny_grabber'
 
 # Set request timelive
 read_timeout = 300
+
 # You can set own UserAgent, but by default each request get random UserAgent from list of most popular
 user_agent = 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.0 Safari/537.36'
+
 # Set proxy for concealment your real IP
-proxy = { ip: 'xx.xx.xx.xx', port: 'xxxx' }
+# ip(required argument) - String format [0-9]+\.[0-9]+\.[0-9]+\.
+# port(required argument) - Integer
+# type - Connect type `http` or `socks`
+proxy = { ip: 'xx.xx.xx.xx', port: 'xxxx', type: '...' }
+
 # Set Net::HTTP headers
 headers = { 'Content-Type' => 'text/html; charset=utf-8' }
-# You can set own cookies like String
+
+# You can set own cookies like String or Hash
 cookies = 'username=username&password=password'
-# or Hash
 cookies = { username: 'username', password: 'password' }
+
 # For POST request you can set DATAS
 params = { key: 'value' }
 
 # Initialize TinyGrabber object
 tg = TinyGrabber.new
 
-# Set debug flag for view log information
-tg.debug = true
 
-# Or set debug configuration
-# active - flag to save log information
-# destination - save log to file or print: [:file, :print]
-# save_html - flag to save response html to file
+# Set debug configuration
+# active - Flag to save log information
+# destination - Save log to file or print: [:file, :print]
+# save_html - Flag to save response html to file
 tg.debug = { active: true, destination: :file, save_html: true }
 
+# Set debug flag for activate debug with default configuration { active: true, destination: :print, save_html: false }
+tg.debug = true
+
 # Set max time to execute request
 tg.read_timeout = read_timeout
 
@@ -114,8 +122,11 @@ response.body
 
 ## Changelog
 
+* *v 0.2.5*
+    * Added auto convert params to symbol
+    Now you can set cookies with hash `cookies = { "username" => 'username', "password" => 'password' }`
 * *v 0.2.4*
-    * Add debug file
+    * Added debug file
 * *v 0.2.3*
     * The feature to set cookies in the form of a Hash is added
 * *v 0.2.2*

data/lib/tiny_grabber/agent.rb

@@ -3,12 +3,8 @@
 # Setting connect attributes
 #
 class TinyGrabber::Agent
-  # Debug flag for detilazition log and save result HTML to /log/*.html file
+  # Debug configuration
   attr_accessor :debug
-  # Debug destination type
-  attr_accessor :debug_destination
-  # Debug flag for save html in file
-  attr_accessor :debug_save_html
   # Max time to execute request
   attr_accessor :read_timeout
   # Web browser name
@@ -49,9 +45,7 @@ class TinyGrabber::Agent
   # Initialization object
   #
   def initialize
-    @debug = false
-    @debug_destination = :file
-    @debug_save_html = false
+    @debug = Debug.new
 
     # Initialize variables agent attributes
     @user_agent = AGENT_ALIASES[rand(AGENT_ALIASES.count) - 1]
@@ -69,6 +63,22 @@ class TinyGrabber::Agent
   end
 
 
+  # Set debug configuration
+  #
+  # @param debug
+  #
+  def debug= debug
+    debug = var_to_sym(debug, true)
+    if debug.is_a?(Hash)
+      @debug.active = debug[:active]
+      @debug.destination = debug[:destination]
+      @debug.save_html = debug[:save_html]
+    elsif debug.is_a?(TrueClass)
+      @debug.active = true
+    end
+  end
+
+
   # Set READ_TIMEOUT agent attribute
   #
   # @param read_timeout Waiting time to reading
@@ -96,16 +106,18 @@ class TinyGrabber::Agent
   #
   def proxy= proxy
     if proxy.is_a?(String)
-      ip, port = proxy.split(':')
+      ip, port, type = proxy.split(':')
       fail 'attribute proxy must be in format ip:port' unless ip and port
-      proxy = { ip: ip, port: port }
+      type ||= :http
+      proxy = { ip: ip, port: port, type: type }
     end
+    proxy = var_to_sym(proxy)
     fail 'attribute proxy must be Hash' unless proxy.is_a?(Hash)
     fail 'attribute proxy must contain :ip and :port keys' unless proxy[:ip] and proxy[:port]
 
     @proxy = proxy
-    if ['socks', :socks].include?(proxy[:type])
-      @http = Net::HTTP.SOCKSProxy(proxy[:ip], proxy[:port])
+    if [:socks, 'socks'].include? proxy[:type]
+      @http = Net::HTTP.SOCKSProxy(proxy[:ip].to_s, proxy[:port].to_s)
     else
       @http = Net::HTTP::Proxy(proxy[:ip], proxy[:port])
     end
@@ -117,6 +129,7 @@ class TinyGrabber::Agent
   # @param basic_auth Authentification configuration
   #
   def basic_auth= basic_auth
+    basic_auth = var_to_sym(basic_auth)
     fail 'attribute basic_auth must be Hash' unless basic_auth.is_a?(Hash)
     fail 'attribute basic_auth must contain :username and :password keys' unless basic_auth[:username] and basic_auth[:password]
     @basic_auth = basic_auth
@@ -138,6 +151,7 @@ class TinyGrabber::Agent
   # @param cookies Request cookies
   #
   def cookies= cookies
+    cookies = var_to_sym(cookies)
     cookies = cookies.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&') if cookies.is_a?(Hash)
     fail 'attribute cookies must be String' unless cookies.is_a?(String)
     @cookies = cookies
@@ -154,11 +168,12 @@ class TinyGrabber::Agent
   # @param params Request additional params
   #
   def fetch url, method = :get, headers = {}, params = {}
-    if @debug
-      Debug::save @debug_destination, '=============================='
-      Debug::save @debug_destination, "#{method.upcase} #{url}"
-      Debug::save @debug_destination, "-> [params] = #{params}"
-      Debug::save @debug_destination, '------------------------------'
+    if @debug.active
+      @debug.save '=============================='
+      @debug.save "#{method.upcase} #{url}"
+      @debug.save "-> [proxy] = #{@proxy}" if @proxy
+      @debug.save "-> [params] = #{params}"
+      @debug.save '------------------------------'
     end
     set_uri url
     case method
@@ -177,23 +192,23 @@ class TinyGrabber::Agent
     case @response
       # HTTP response code 1xx
       when Net::HTTPInformation
-        Debug::save @debug_destination, "<- [response] = Net::HTTPInformation" if @debug
+        @debug.save "<- [response] = Net::HTTPInformation" if @debug.active
       # HTTP response code 2xx
       when Net::HTTPSuccess
         save_headers if @response.header
         save_cookies if @response.cookies
-        Debug::save @debug_destination, "<- [response] = #{@response.code} Net::HTTPSuccess" if @debug
+        @debug.save "<- [response] = #{@response.code} Net::HTTPSuccess" if @debug.active
       # HTTP response code 3xx
       when Net::HTTPRedirection
-        Debug::save @debug_destination, "<- [response] = #{@response.code} Net::HTTPRedirection" if @debug
+        @debug.save "<- [response] = #{@response.code} Net::HTTPRedirection" if @debug.active
       # HTTP response code 4xx
       when Net::HTTPClientError
-        Debug::save @debug_destination, "<- [response] = #{@response.code} Net::HTTPClientError" if @debug
+        @debug.save "<- [response] = #{@response.code} Net::HTTPClientError" if @debug.active
       # HTTP response code 5xx
       when Net::HTTPServerError
-        Debug::save @debug_destination, "<- [response] = #{@response.code} Net::HTTPServerError" if @debug
+        @debug.save "<- [response] = #{@response.code} Net::HTTPServerError" if @debug.active
     end
-    Debug::save_to_file @response.body  if @debug_save_html
+    @debug.save_to_file @response.body  if @debug.save_html
     @response
   end
 
@@ -205,7 +220,7 @@ class TinyGrabber::Agent
   def set_uri url
     # It's magic work with escaped url
     @uri = URI(URI.escape(URI.unescape(url)))
-    Debug::save @debug_destination, "-> [uri] = #{@uri}" if @debug
+    @debug.save "-> [uri] = #{@uri}" if @debug.active
   end
 
 
@@ -213,7 +228,7 @@ class TinyGrabber::Agent
   #
   def set_user_agent
     @headers['User-Agent'] = @user_agent
-    Debug::save @debug_destination, "-> [user_agent] = #{@user_agent}" if @debug
+    @debug.save "-> [user_agent] = #{@user_agent}" if @debug.active
   end
 
 
@@ -221,7 +236,7 @@ class TinyGrabber::Agent
   #
   def set_basic_auth
     @request.basic_auth @basic_auth[:username], @basic_auth[:password]
-    Debug::save @debug_destination, "-> [basic_auth] = #{@basic_auth}" if @debug
+    @debug.save "-> [basic_auth] = #{@basic_auth}" if @debug.active
   end
 
 
@@ -229,7 +244,7 @@ class TinyGrabber::Agent
   #
   def set_headers
     @headers.each { |k, v| @request.add_field(String(k), v) }
-    Debug::save @debug_destination, "-> [headers] = #{@headers}" if @debug
+    @debug.save "-> [headers] = #{@headers}" if @debug.active
   end
 
 
@@ -237,7 +252,7 @@ class TinyGrabber::Agent
   #
   def set_cookies
     @request['Cookie'] = @cookies
-    Debug::save @debug_destination, "-> [cookies] = #{@cookies}" if @debug
+    @debug.save "-> [cookies] = #{@cookies}" if @debug.active
   end
 
 
@@ -247,7 +262,7 @@ class TinyGrabber::Agent
   def send_request
     @http.start(@uri.host, @uri.port, use_ssl: @uri.scheme == 'https') do |http|
       http.read_timeout = @read_timeout
-      Debug::save @debug_destination, "-> [read_timeout] = #{@read_timeout}" if @debug
+      @debug.save "-> [read_timeout] = #{@read_timeout}" if @debug.active
       http.request(@request)
     end
   end
@@ -259,7 +274,7 @@ class TinyGrabber::Agent
     @headers = @response.headers
     # Delete header TRANSFER_ENCODING for chain of requests
     @headers.delete('transfer-encoding')
-    Debug::save @debug_destination, "<- [headers] = #{@headers}" if @debug
+    @debug.save "<- [headers] = #{@headers}" if @debug.active
   end
 
 
@@ -267,7 +282,7 @@ class TinyGrabber::Agent
   #
   def save_cookies
     @cookies = @response.cookies
-    Debug::save @debug_destination, "<- [cookies] = #{@cookies}" if @debug
+    @debug.save "<- [cookies] = #{@cookies}" if @debug.active
   end
 
 
@@ -277,4 +292,27 @@ class TinyGrabber::Agent
     @headers = {}
     @cookies = nil
   end
+
+  # Convert variables and contains to symbol
+  #
+  # @param var Variable need to convert
+  #
+  def var_to_sym var, str_to_sym = false
+    if var.is_a?(Hash)
+      result = {}
+      var.each do |k, v|
+        result[k.to_sym] = var_to_sym(v, str_to_sym)
+      end
+    elsif var.is_a?(Array)
+      result = []
+      var.each do |v|
+        result << var_to_sym(v, str_to_sym)
+      end
+    elsif var.is_a?(String)
+      result = str_to_sym ? var.to_sym : var
+    else
+      result = var
+    end
+    result
+  end
 end

data/lib/tiny_grabber/debug.rb

@@ -1,14 +1,74 @@
 # Save debug log information
 class Debug
+  # Flag to active debug save log
+  attr_accessor :active
+  # Print log or save to file
+  attr_accessor :destination
+  # Flag to save response HTML to file
+  attr_accessor :save_html
 
-  # Save log information
+  # Initialize a debug object
+  #
+  def initialize
+    @active = false
+    @destination = :print
+    @save_html = false
+  end
+
+
+  # Set debug active flag
+  #
+  # @param active Flag
+  #
+  def active= active
+    @active = active
+  end
+
+
+  # Get debug active flag
+  def active
+    @active
+  end
+
+
+  # Set debug destination
   #
   # @param destination Save log to file or print
+  #
+  def destination= destination
+    @destination = destination
+  end
+
+
+  # Get debug destination
+  #
+  def destination
+    @destination
+  end
+
+
+  # Set debug flag to save response HTML to file
+  #
+  # @param save_html Flag
+  def save_html= save_html
+    @save_html = save_html
+  end
+
+
+  # Get debug flag to save response HTML to file
+  #
+  def save_html
+    @save_html
+  end
+
+
+  # Save log information
+  #
   # @param message Message body
   #
-  def self.save destination = :print, message
+  def save message
     message = "TG | #{Time.now.strftime('%Y%m%d-%H%M%S')} | #{message}"
-    case destination
+    case @destination
       when :file
         save_to_file message
       when :print
@@ -21,7 +81,7 @@ class Debug
   #
   # @param message Message body
   #
-  def self.save_to_file message
+  def save_to_file message
     debug_path = "#{Dir.pwd}/log"
     Dir.mkdir(debug_path, 0775) unless File.exists? debug_path
     filename = "#{Time.now.strftime('%Y%m%d')}.log"

data/lib/tiny_grabber/version.rb

@@ -1,4 +1,4 @@
 class TinyGrabber
   # Version number
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

data/lib/tiny_grabber.rb

@@ -80,15 +80,7 @@ class TinyGrabber
   # @param debug Flag to start debug
   #
   def debug= debug
-    if debug.is_a?(TrueClass) || debug.is_a?(FalseClass)
-      @agent.debug = debug
-      @agent.debug_destination = :print
-      @agent.debug_save_html = false
-    elsif debug.is_a? Hash
-      @agent.debug = debug[:active]
-      @agent.debug_destination = debug[:destination]
-      @agent.debug_save_html = debug[:save_html]
-    end
+    @agent.debug = debug
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_grabber
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Aleksandr Chernyshev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: socksify