Frozen string literal, docs

* Add `frozen_string_literal: true`

* Add some YARD docs

* Update CHANGELOG

CHANGELOG.md

@@ -2,10 +2,14 @@
 
 Reverse Chronological Order:
 
+## `0.6.2` (2017-12-27)
+
+* Fix ProxyDocker provider.
+
 ## `0.6.1` (2017-12-11)
 
 * Fix gem executable to check dependencies for adapters
-* Code clean
+* Code cleanup
 * Some new specs
 
 ## `0.6.0` (2017-12-08)

lib/proxy_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'net/https'
 

lib/proxy_fetcher/client/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # ProxyFetcher HTTP client that encapsulates all the logic for sending
   # HTTP(S) requests using proxies, automatically fetched and validated by the gem.
@@ -122,6 +124,8 @@ def patch(url, payload, headers: {}, options: {})
 
       private
 
+      # Executes HTTP request with user payload.
+      #
       def request_with_payload(method, url, payload, headers, options)
         safe_request_to(url, options.fetch(:max_retries, 1000)) do |proxy|
           opts = options.merge(url: url, payload: payload, proxy: proxy, headers: default_headers.merge(headers))
@@ -130,6 +134,8 @@ def request_with_payload(method, url, payload, headers, options)
         end
       end
 
+      # Executes HTTP request without user payload.
+      #
       def request_without_payload(method, url, headers, options)
         safe_request_to(url, options.fetch(:max_retries, 1000)) do |proxy|
           opts = options.merge(url: url, proxy: proxy, headers: default_headers.merge(headers))
@@ -138,6 +144,12 @@ def request_without_payload(method, url, headers, options)
         end
       end
 
+      # Default ProxyFetcher::Client http headers. Uses some options
+      # from the configuration object, such as User-Agent string.
+      #
+      # @return [Hash]
+      #   headers
+      #
       def default_headers
         {
           'User-Agent' => ProxyFetcher.config.user_agent

lib/proxy_fetcher/client/proxies_registry.rb

@@ -1,12 +1,30 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Client
     class ProxiesRegistry
       class << self
+        # Removes proxy from the list of the current proxy manager
+        # instance. If no more proxy available, refreshes the list.
+        #
+        # @param proxy [ProxyFetcher::Proxy]
+        #   proxy object to remove
+        #
         def invalidate_proxy!(proxy)
           manager.proxies.delete(proxy)
           manager.refresh_list! if manager.proxies.empty?
         end
 
+        # Searches for valid proxy or required type (HTTP or secure)
+        # for requested URL. If no proxy found, than it refreshes proxy list
+        # and tries again.
+        #
+        # @param url [String]
+        #   URL to process with proxy
+        #
+        # @return [ProxyFetcher::Proxy]
+        #   gems proxy object
+        #
         def find_proxy_for(url)
           proxy = if URI.parse(url).is_a?(URI::HTTPS)
                     manager.proxies.detect(&:ssl?)
@@ -20,6 +38,12 @@ def find_proxy_for(url)
           find_proxy_for(url)
         end
 
+        # Instantiate or returns <code>ProxyFetcher::Manager</code> instance
+        # for current <code>Thread</code>.
+        #
+        # @return [ProxyFetcher::Manager]
+        #   ProxyFetcher manager class
+        #
         def manager
           manager = Thread.current[:proxy_fetcher_manager]
           return manager unless manager.nil?

lib/proxy_fetcher/client/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Client
     # ProxyFetcher::Client HTTP request abstraction.
@@ -37,6 +39,8 @@ def initialize(args)
         build_http_client
       end
 
+      # Executes HTTP request with defined options.
+      #
       def execute
         request = request_class_for(method).new(uri, headers)
 
@@ -47,6 +51,9 @@ def execute
 
       private
 
+      # Converts payload to the required format, so <code>Hash</code>
+      # must be a WWW-Form encoded for example.
+      #
       def preprocess_payload(payload)
         return if payload.nil?
 
@@ -58,6 +65,8 @@ def preprocess_payload(payload)
         end
       end
 
+      # Builds HTTP client based on stdlib Net::HTTP.
+      #
       def build_http_client
         @http = Net::HTTP.new(uri.host, uri.port, proxy.addr, proxy.port)
 
@@ -76,6 +85,8 @@ def process_response!(http_response)
         end
       end
 
+      # Follows redirection for response.
+      #
       def follow_redirection(http_response)
         raise ProxyFetcher::Exceptions::MaximumRedirectsReached if max_redirects <= 0
 
@@ -85,6 +96,9 @@ def follow_redirection(http_response)
         Request.execute(method: :get, url: url, proxy: proxy, headers: headers, timeout: timeout, max_redirects: max_redirects - 1)
       end
 
+      # Returns particular Net::HTTP method object
+      # for processing required request.
+      #
       def request_class_for(method)
         Net::HTTP.const_get(method, false)
       end

lib/proxy_fetcher/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # ProxyFetcher configuration. Stores all the options for dealing
   # with HTTP requests, adapters, custom classes.
@@ -21,6 +23,11 @@ class Configuration
     DEFAULT_ADAPTER = :nokogiri
 
     class << self
+      # Registry for handling proxy providers.
+      #
+      # @return [ProxyFetcher::ProvidersRegistry]
+      #   providers registry
+      #
       def providers_registry
         @registry ||= ProvidersRegistry.new
       end
@@ -38,11 +45,21 @@ def register_provider(name, klass)
         providers_registry.register(name, klass)
       end
 
+      # Returns registered providers names.
+      #
+      # @return [Array<String>, Array<Symbol>]
+      #   registered providers names
+      #
       def registered_providers
         providers_registry.providers.keys
       end
     end
 
+    # Initialize ProxyFetcher configuration with default options.
+    #
+    # @return [ProxyFetcher::Configuration]
+    #   ProxyFetcher gem configuration object
+    #
     def initialize
       reset!
     end

lib/proxy_fetcher/configuration/providers_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # ProxyFetcher providers registry that stores all registered proxy providers.
   class ProvidersRegistry

lib/proxy_fetcher/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # HTML document abstraction class. Used to work with different HTML parser adapters
   # such as Nokogiri, Oga or a custom one. Stores <i>backend</i< that will handle all

lib/proxy_fetcher/document/adapters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   class Document
     # ProxyFetcher HTML parser adapters.

lib/proxy_fetcher/document/adapters/abstract_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   class Document
     # Abstract HTML parser adapter class.

lib/proxy_fetcher/document/adapters/nokogiri_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   class Document
     # HTML parser adapter that uses Nokogiri as a backend.

lib/proxy_fetcher/document/adapters/oga_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   class Document
     # HTML parser adapter that uses Oga as a backend.

lib/proxy_fetcher/document/node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   class Document
     # Abstract class for storing HTML elements that was parsed by

lib/proxy_fetcher/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # Base exception class for all the ProxyFetcher exceptions.
   Error = Class.new(StandardError)

lib/proxy_fetcher/manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # ProxyFetcher Manager class for interacting with proxy lists from various providers.
   class Manager

lib/proxy_fetcher/providers/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Providers
     # Base class for all the ProxyFetcher providers.

lib/proxy_fetcher/providers/free_proxy_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Providers
     # FreeProxyList provider class.

lib/proxy_fetcher/providers/free_proxy_list_ssl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Providers
     # FreeProxyListSSL provider class.

lib/proxy_fetcher/providers/gather_proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module ProxyFetcher

lib/proxy_fetcher/providers/http_tunnel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Providers
     # HTTPTunnel provider class.

lib/proxy_fetcher/providers/proxy_docker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Providers
     # ProxyDocker provider class.

lib/proxy_fetcher/providers/proxy_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 module ProxyFetcher

lib/proxy_fetcher/providers/xroxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   module Providers
     # XRoxy provider class.

lib/proxy_fetcher/proxy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # Proxy object
   class Proxy

lib/proxy_fetcher/utils/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # Default ProxyFetcher HTTP client used to fetch proxy lists from
   # the different providers. Uses ProxyFetcher configuration options

lib/proxy_fetcher/utils/proxy_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   # Default ProxyFetcher proxy validator that checks either proxy
   # connectable or not. It tries to send HEAD request to default

lib/proxy_fetcher/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ProxyFetcher
   ##
   # ProxyFetcher gem version.

spec/proxy_fetcher/client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'json'
 

spec/proxy_fetcher/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Configuration do

spec/proxy_fetcher/document/adapters_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Document::Adapters do

spec/proxy_fetcher/document/node_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Document::Node do

spec/proxy_fetcher/providers/base_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::Base do

spec/proxy_fetcher/providers/free_proxy_list_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::FreeProxyList do

spec/proxy_fetcher/providers/free_proxy_list_ssl_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::FreeProxyListSSL do

spec/proxy_fetcher/providers/gather_proxy_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::GatherProxy do

spec/proxy_fetcher/providers/http_tunnel_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::HTTPTunnel do

spec/proxy_fetcher/providers/multiple_providers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Multiple proxy providers' do

spec/proxy_fetcher/providers/proxy_docker_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::ProxyDocker do

spec/proxy_fetcher/providers/proxy_list_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::ProxyList do

spec/proxy_fetcher/providers/xroxy_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe ProxyFetcher::Providers::XRoxy do