rhack 1.3.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 255f778be8172b77886bc90969871994f99e05b3
-  data.tar.gz: 99653ac463971ce0f8ceec23a6c829f4c70140a8
+  metadata.gz: 3a6f9fd958d14ef221d1f20ebb4217decff1a257
+  data.tar.gz: 9b0d6cdf7cbe66b9d0f7ee3fa155761af34584c1
 SHA512:
-  metadata.gz: 91eb7a4e415c6766830a0e4967f675b0ad472845bf03321717a30b7504b8b3034a110ec7de3301a57e589ca6d59c8c60ed09b1ca4f09e66fbc108d6b96935893
-  data.tar.gz: 88ae5008a606ab82504206dc69b3caa7e72d4eb70108048e93634e3b9412ca8e576ad7f91c9ae3d8042b54df284bfe820eedc024f4ca122694f3abdcd6a684ff
+  metadata.gz: d7905168e4924ff769eb900fe57105edefa41ed98605b9421b4e9a4c1185e5ad3ce50c94034652cae9a94418f1b6fbc0da4058b153903bc91805224ba134e9ef
+  data.tar.gz: 2574c36ae2d5eabd0721d9134d38645963fcec1f49495642084bf63a24d1bc116cfc508564bc3c11b8e78ef212a0bc9870d9e5de30e7b7962e487136358c9339

data/lib/rhack.rb

@@ -50,7 +50,7 @@ module RHACK
   if uas = uas.desktop.to_s and File.file? uas
     @@useragents = IO.read(uas)/"\n"
   else
-    @@useragents = ['Mozilla/5.0 (Windows NT 6.1; WOW64; rv:14.0) Gecko/20100101 Firefox/14.0.1']
+    @@useragents = ['Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.89 Safari/537.36']
   end
   
   class Scout
@@ -58,9 +58,9 @@ module RHACK
     mattr_accessor :retry, :timeout
     
     scout = RHACK.config.scout || {}
-    @@retry     = scout.retry.b || {}
-    @@timeout = scout.timeout.b || 60
-    @@cacert  = scout.cacert.b ? File.expand_path(scout.cacert) : File.expand_path('../../config/cacert.pem', __FILE__)
+    @@retry     = scout.retry.presence || {}
+    @@timeout = scout.timeout.presence || 60
+    @@cacert  = scout.cacert.presence ? File.expand_path(scout.cacert) : File.expand_path('../../config/cacert.pem', __FILE__)
   end
   
 end
@@ -89,5 +89,13 @@ require "rhack/scout_squad"
 require "rhack/frame"
 require "rhack/page"
 if defined? Redis::Objects
+  # redis storage for namespaced cache, oauth data etc
   require "rhack/storage"
 end
+
+module RHACK
+  # key feature
+  autoload :Client, 'rhack/clients'
+  # basic client for oauth
+  autoload :OAuthClient, 'rhack/clients/oauth'
+end

data/lib/rhack/clients.rb

@@ -1,10 +1,4 @@
 require 'rhack'
 require 'rhack/clients/base'
 require 'rhack/clients/storage'
-require 'rhack/clients/oauth'
-
-module RHACK
-  for name in [:Service, :ServiceError]
-    autoload name, 'rhack/clients/compatibility'
-  end
-end
+require 'rhack/clients/errors'

data/lib/rhack/clients/base.rb

@@ -1,29 +1,42 @@
 # encoding: utf-8
-
-# TODO 1.0+: опция для клиента, чтобы это описание имело смысл, т.к. сейчас это ложь:
-#   Вызовам клиентов всегда следует ждут и возвращают обработанный ответ, если вызвваны без блока. 
-#   В противном случае используется событийная модель и обработанный ответ передаётся в блок.
 module RHACK
 
   class Client
     attr_reader :service
     attr_accessor :f
     class_attribute :frame_defaults, :instance_writer => false
+    class_attribute :scouts_initializers, :instance_writer => false
     class_attribute :accounts, :instance_writer => false
     class_attribute :routes, :instance_writer => false
     class_attribute :rootpath, :instance_writer => false
     
     self.frame_defaults = {}
+    self.scouts_initializers = []
     self.accounts = {}
     self.routes = {}
     
     class << self
     
       def inherited(child)
-        child.class_eval {
+        child.class_eval do
           include RHACK
           __init__
-        }
+          
+          # Proxying Rails router methods digging into the client namespace
+          if defined? ::Rails.application.routes.url_helpers
+            url_helpers = ::Rails.application.routes.url_helpers
+            routes_namespace = name.gsub(/::/, '').underscore.sub(/_client$/, '')
+            route_pattern = /^(.+_)?#{routes_namespace}_(.+)/
+            url_helpers.my_methods.each {|name|
+              if name.to_s[route_pattern]
+                full_route_name = $&
+                define_method "#$1#$2" do |*options|
+                  url_helpers.send full_route_name, *options
+                end
+              end
+            }
+          end
+        end
       end
       
       def method_missing(method, *args, &block)
@@ -55,8 +68,11 @@ module RHACK
       end
       
       # Set default Frame options
-      def frame(dict)
+      def frame(dict, &scout_initializer)
         self.frame_defaults += dict
+        if scout_initializer
+          self.scouts_initializers << scout_initializer
+        end
       end
       
       # Set usable accounts
@@ -78,6 +94,13 @@ module RHACK
         if self.class.const_defined? :Result
           opts[:result] = self.class::Result
         end
+        if scouts_initializers = self.scouts_initializers.presence
+          opts[:on_scout_initialize] ||= lambda {|scout|
+            scouts_initializers.each {|initializer|
+              initializer.call scout
+            }
+          }
+        end
         @f = Frame(rootpath || route(service) || route(:login), opts)
       end
     end
@@ -120,7 +143,7 @@ module RHACK
     def route(name, interpolation=nil)
       if url = routes[name]
         if interpolation
-          url %= interpolation
+          url %= interpolation.symbolize_keys
         end
         if url !~ /^\w+:/
           url = File.join rootpath, url
@@ -129,8 +152,6 @@ module RHACK
       end
     end
     alias :url :route
-    # URI is deprecated # backward compatibility
-    alias :URI :route
     
     def account(name)
       accounts[name]
@@ -138,5 +159,4 @@ module RHACK
     
   end
   
-  class ClientError < Exception; end
 end

data/lib/rhack/clients/errors.rb

@@ -0,0 +1,41 @@
+module RHACK
+    
+  # Abstraction, don't use it.
+  class BasicError < StandardError
+    # keep here debugful data
+    attr_accessor :details
+    
+    # # Usage ...
+    # # ... without :details keyword, as usual:
+    # raise ServerError, 'an error has occured'
+    # # ... with :details keyword
+    # raise ServerError.new 'an error has occured', details: @curl_res
+    # # ... if you also want to set custom backtrace
+    # raise ServerError.new('an error has occured', details: @curl_res), backtrace_array
+    def initialize(message, *opts) # details: nil
+      @details = opts.extract_options![:details]
+      super
+    end
+    
+  end
+  
+  # The client couldn't connect and yet we don't know whose this fault is,
+  # e.g. domain lookup error or timeout.
+  class ConnectionError < BasicError; end
+  
+  # The client successfully connected to the server
+  # but it returned an improper, non-descriptive response,
+  # e.g. 500 status, empty body, etc.
+  class ServerError < BasicError; end
+  
+  # The client successfully connected to the server
+  # but server didn't accept a request and returned a descriptive exception,
+  # e.g. 406 status, body with only "error" key, etc.
+  class RequestError < BasicError; end
+  
+  # The client successfully connected to the server,
+  # the server accept a request but we failed to process a response,
+  # e.g. because of an unexpected response structure
+  class ClientError < BasicError; end
+    
+end

data/lib/rhack/dl.rb

@@ -208,7 +208,7 @@ module RHACK
       df += '.map'
       text = read df
       $log << "mapfile read: #{text}"
-      if text.b
+      if text.present?
         text[/^(\d+)\0+(\d+)\0*\n/]
         map = {}
         $log << [$1,$2]

data/lib/rhack/frame.rb

@@ -25,6 +25,8 @@ module RHACK
     alias options opts
     @@cache = {}
     
+    # Opts passed to Scout:
+    #   :ck / :cp, :raise, :timeout, :retry, :redir
     def initialize *args
       #args << 10 unless args[-1].is Fixnum
       #args.insert -2, {} unless args[-2].is Hash
@@ -44,6 +46,10 @@ module RHACK
         @static = false
       end
       @ss  = ScoutSquad @loc.href, @opts, scouts_count
+      # for low-level settings that are not implemented explicitly
+      if @opts[:on_scout_initialize].present?
+        each &@opts[:on_scout_initialize]
+      end
     end
     
     def update_loc url
@@ -256,7 +262,7 @@ module RHACK
           order = [del ? :loadDelete : :loadGet, url]
         end
       end
-      if !order.b and !orders.b
+      if order.blank? and orders.blank?
         raise ArgumentError, "failed to run blank request#{'s' if many}, params was
      (#{args.inspect[1..-2]})"
       end

data/lib/rhack/js/johnson.rb

@@ -20,7 +20,7 @@ module Johnson
     class << self
       
       def runtime_set?(opts)
-        !opts[:eval].b or (@@browser and @@browser.thread_id == Curl.carier_thread.object_id)
+        opts[:eval].blank? or (@@browser and @@browser.thread_id == Curl.carier_thread.object_id)
       end
     
       # CarierThread breaks if Multi has no work && CarierThread
@@ -36,9 +36,9 @@ module Johnson
         unless runtime_set? opts
           if Curl.status
             Curl.recall
-            Curl.debug 'recalled'
+            L.debug 'recalled'
           end
-          if opts[:thread_safe].b
+          if opts[:thread_safe].present?
             @@browser = new_browser(opts[:jq])
             L.debug "#@@browser initialized in #{Thread.current}\nmain: #{Thread.main}; carier: #{Curl.carier_thread}"
           else

data/lib/rhack/page.rb

@@ -49,7 +49,7 @@ module RHACK
       if obj.is Curl::Easy or obj.kinda Scout
         c = obj.kinda(Scout) ? obj.http : obj
         # just (c, loc) would pass to #process opts variable that returns '' on any key
-        process(c, loc.b || {})
+        process(c, loc.presence || {})
       else
         @body = obj
         @loc = loc
@@ -57,7 +57,7 @@ module RHACK
     end
     
     def empty?
-      !@data && !@body.b
+      !@data && @body.blank?
     end
     
     def size
@@ -215,10 +215,10 @@ module RHACK
       document.domain = location.host;"
       find("script").each {|n|
         L.debug n.text.strip
-        if text = n.text.strip.b
+        if text = n.text.strip.presence
           js[:write_output] = ''
           eval_string text
-          if res = js[:write_output].b then n.after res end
+          if res = js[:write_output].presence then n.after res end
           n.remove!
         elsif frame and n.src
           eval_string frame.get_cached expand_link n.src
@@ -251,10 +251,10 @@ module RHACK
     end
     
     def title(full=true)
-      if @data.nil? and !@failed and @body.b
+      if @data.nil? and !@failed and @body.present?
         if full
           to_html unless defined? @doc
-          if @doc.title.b
+          if @doc.title.present?
             @title = @doc.title
           else
             @title = @loc.href
@@ -454,7 +454,7 @@ module RHACK
       if form_node['method'].downcase == 'post'
         [hash, form_node.enctype =~ /multipart/, action, opts]
       else
-        action = "#{action}#{action['?'] ? '&' : '?'}#{hash.urlencode}" if hash.b
+        action = "#{action}#{action['?'] ? '&' : '?'}#{hash.urlencode}" if hash.present?
         [action, opts]
       end
     end
@@ -496,7 +496,7 @@ module RHACK
     
     def get_links(links='a')
       begin
-        links = find(links).map {|e| e.href}.b || find(links+'//a').map {|e| e.href} if links.is String
+        links = find(links).map {|e| e.href}.presence || find(links+'//a').map {|e| e.href} if links.is String
       rescue LibXML::XML::Error
         links = [links]
       end

data/lib/rhack/scout.rb

@@ -193,7 +193,7 @@ module RHACK
         when Curl::Response
           ck = res['cookies']
       end
-      return if !ck.b
+      return if ck.blank?
       ck.each {|c| Cookie(c, self)}
     end
 
@@ -253,12 +253,15 @@ module RHACK
         retry!
       else
         L.debug "#{curl_err} -> not reloading scout"
-        raise @error if @raise_err
-        #raise *@error if @raise_err # old
-        yield if block_given?
-        # Now, we assume that data of this @http have been copied or will not be used anymore,
-        # thus the scout can be reused.
-        @busy = false
+        begin
+          raise @error if @raise_err
+          #raise *@error if @raise_err # old
+          yield if block_given?
+        ensure
+          # Now, we assume that data of this @http have been copied or will not be used anymore,
+          # thus the scout can be reused.
+          @busy = false
+        end
       end
     end
     
@@ -302,14 +305,17 @@ module RHACK
         process_cookies res if @cookies_enabled
         # We cannot just cancel on_complete in on_redirect block,
         # because loadGet should (and will) immediately reset on_complete back.
-        if res.code.in(300..399) and !not_redir.b and (relvl -= 1) > -1 and loc = res.hash.location
+        if res.code.in(300..399) and not_redir.blank? and (relvl -= 1) > -1 and loc = res.hash.location
           loadGet(loc, headers: headers, relvl: relvl, redir: true, &callback)
         else
-          yield @http if block_given?
-          # Now, we assume that data of this @http have been copied or will not be used anymore,
-          # thus the scout can be reused.
-          @busy = false
-          @http.on_failure &Proc::NULL
+          begin
+            yield @http if block_given?
+          ensure
+            # Now, we assume that data of this @http have been copied or will not be used anymore,
+            # thus the scout can be reused.
+            @busy = false
+            @http.on_failure &Proc::NULL
+          end
         end
       }
       # Curl::Err::* (TCP/IP level) exception callback.
@@ -353,7 +359,7 @@ module RHACK
       unless hash.is Hash # not parameterized
         opts[:headers] = opts[:headers].reverse_merge 'Content-Type' => 'application/octet-stream'
       end
-      mkBody hash, multipart.b
+      mkBody hash, multipart.present?
       @last_method	= :post
       if block_given?
         @post_proc	= callback

data/lib/rhack/scout_squad.rb

@@ -62,7 +62,7 @@ module RHACK
     end
       
     def rand
-      raise PickError if !b
+      raise PickError if empty?
       # to_a because Array#reject returns object of this class
       if scout = to_a.rand_by_available?
         L.debug {"randomly picked an available scout##{scout.object_id}"}
@@ -74,7 +74,7 @@ module RHACK
     end
       
     def next
-      raise PickError if !b
+      raise PickError if empty?
       if scout = to_a.find_available?
         L.debug {"picked the next available scout##{scout.object_id}"}
         scout
@@ -86,7 +86,7 @@ module RHACK
     
     def to_s
       str = '<#ScoutSquad @ '
-      if b
+      if any?
         if first.webproxy
           str << "#{first.proxy} ~ "
         elsif first.proxy

data/lib/rhack/version.rb

@@ -1,3 +1,3 @@
 module RHACK
-  VERSION = '1.3.8'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: rhack
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Sergey Baev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmtools
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
 description: 'RHACK is Ruby Http ACcess Kit: curl-based web-client framework created
@@ -49,7 +49,7 @@ extensions:
 - ext/curb/extconf.rb
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CURB-LICENSE
 - Gemfile
 - LICENSE
@@ -91,6 +91,7 @@ files:
 - lib/rhack/clients.rb
 - lib/rhack/clients/base.rb
 - lib/rhack/clients/compatibility.rb
+- lib/rhack/clients/errors.rb
 - lib/rhack/clients/examples.rb
 - lib/rhack/clients/oauth.rb
 - lib/rhack/clients/storage.rb
@@ -116,7 +117,6 @@ files:
 - lib/rhack/proxy/list.rb
 - lib/rhack/scout.rb
 - lib/rhack/scout_squad.rb
-- lib/rhack/services.rb
 - lib/rhack/storage.rb
 - lib/rhack/version.rb
 - lib/rhack_in.rb
@@ -134,19 +134,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Curl-based web-client framework created for developing web-scrapers/bots
 test_files: []
-has_rdoc: 

data/lib/rhack/services.rb

@@ -1 +0,0 @@
-require 'rhack/clients'