webcache 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe5883d3260aa52a00461c30acdeb2cabb0efb4bfb8bac8a522d5f887264603
-  data.tar.gz: 170c3bc9a8a737208d95e56e676323bb89544e96d86ba3d4bdf358e004a49c0a
+  metadata.gz: ba7f34df29a71904f0339c0495ec3e794fb27057203bbb9957cf52944f0d4394
+  data.tar.gz: b15806d79f3ba736aaeab5f335c23ae7f24efdea3902cd955362b9fcc6c0e46e
 SHA512:
-  metadata.gz: f03d4cdf614eca182e19571224faf62a7adc4a96b43c57c63ea3bdcadcc5cb7d47ed496488eeb7c2d6149984f30bb119adc9b1c817943128e659f1f003c7c31a
-  data.tar.gz: be5c985699f051544a8451c41abb8da3f5045d4fa953538098a8e8e1483ba5089158ad104362fa6fabe7097a7937a31a05be572d0bfd37b1cf15e112f6fb57eb
+  metadata.gz: 664369168097d544eb74acd295ca76cfc64c122b7d12b04e49f93632ca781210d258badcb4fcd05b79533d4b06dfc0d7143659d05e9e19c5f29886f8be4c4644
+  data.tar.gz: 2d957952ebd6771959432bca59880ed06ca50ee64d7b0f64e8446dbf6c7232e9a43dd55c723373181f8c0269548bff731d095efda8dd60fc41a5f281d2459ebe

data/README.md

@@ -147,19 +147,38 @@ cache = WebCache.new
 response = cache.get 'http://example.com', force: true
 ```
 
-Basic Authentication and Additional Options
+Authentication
 --------------------------------------------------
-WebCache uses Ruby's [Open URI][1] to download. If you wish to modify 
-the options it uses, simply update the `options` hash.
 
-For example, to use HTTP basic authentication, use something like this:
+To configure an authentication header, use the `auth` option. Similarly to
+the other options, this can be set directly on the static class, on instance
+initialization, or later on the instance:
 
 ```ruby
+cache = WebCache.new auth: '...'
+cache.get 'http://example.com'      # authenticated
+
 cache = WebCache.new
-cache.options[:http_basic_authentication] = ["user", "pass123!"]
-response = cache.get 'http://example.com'
+cache.auth = '...'
+cache.get 'http://example.com'      # authenticated
+
+WebCache.auth = '...'
+WebCache.get 'http://example.com'   # authenticated
+```
+
+For basic authentication, provide a hash:
+
+```ruby
+cache = WebCache.new auth: { user: 'user', pass: 's3cr3t' }
 ```
 
+For other authentication headers, simply provide the header string:
+
+```ruby
+cache = WebCache.new auth: "Bearer t0k3n"
+```
+
+
 
 Response Object
 --------------------------------------------------
@@ -177,6 +196,13 @@ the same content.
 
 In case of an error, this contains the error message, `nil` otherwise.
 
+### `response.code`
+
+Contains the HTTP code, or `nil` if there was a non-HTTP error.
+
+### `response.success?`
+
+A convenience method, returns true if `error` is empty.
 
 ### `response.base_uri`
 

data/lib/webcache.rb

@@ -4,3 +4,9 @@ require 'webcache/polyfills'
 require 'webcache/cache_operations'
 require 'webcache/response'
 require 'webcache/web_cache'
+
+if ENV['BYEBUG']
+  require 'byebug'
+  require 'lp'
+end
+

data/lib/webcache/cache_operations.rb

@@ -1,17 +1,17 @@
 require 'digest/md5'
 require 'fileutils'
-require 'open-uri'
-require 'open_uri_redirections'
+require 'http'
 
 class WebCache
   module CacheOperations
-    attr_reader :last_error
+    attr_reader :last_error, :user, :pass, :auth
     attr_writer :dir
 
-    def initialize(dir: 'cache', life: '1h')
+    def initialize(dir: 'cache', life: '1h', auth: nil)
       @dir = dir
       @life = life_to_seconds life
       @enabled = true
+      @auth = convert_auth auth
     end
 
     def get(url, force: false)
@@ -61,11 +61,11 @@ class WebCache
       FileUtils.rm_rf dir if Dir.exist? dir
     end
 
-    def options
-      @options ||= default_open_uri_options
+    def auth=(auth)
+      convert_auth auth
     end
 
-    private
+  private
 
     def get!(path, url)
       return load_file_content path if File.exist? path
@@ -90,12 +90,26 @@ class WebCache
     end
 
     def http_get(url)
-      Response.new open(url, options)
+      Response.new http_response(url)
     rescue => e
       url = URI.parse url
       Response.new error: e.message, base_uri: url, content: e.message
     end
 
+    def basic_auth?
+      !!(user and pass)
+    end
+
+    def http_response(url)
+      if basic_auth?
+        HTTP.basic_auth(user: user, pass: pass).follow.get url
+      elsif auth
+        HTTP.auth(auth).follow.get url
+      else
+        HTTP.follow.get url
+      end
+    end
+
     def stale?(path)
       life > 0 and File.exist?(path) and Time.new - File.mtime(path) >= life
     end
@@ -112,16 +126,16 @@ class WebCache
       end
     end
 
-    # Use a less strict URL retrieval:
-    # 1. Allow http to/from https redirects (through the use of the 
-    #    open_uri_redirections gem)
-    # 2. Disable SSL verification, otherwise, some https sites that show 
-    #    properly in the browser, will return an error.
-    def default_open_uri_options
-      {
-        allow_redirections: :all, 
-        ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE
-      }
+    def convert_auth(opts)
+      @user, @pass, @auth = nil, nil, nil
+
+      if opts.respond_to?(:has_key?) and opts.has_key?(:user) and opts.has_key?(:pass)
+        @user = opts[:user]
+        @pass = opts[:pass]
+      else
+        @auth = opts
+      end
     end
+
   end
 end

data/lib/webcache/response.rb

@@ -1,10 +1,10 @@
 class WebCache
   class Response
-    attr_accessor :error, :base_uri, :content
+    attr_accessor :error, :base_uri, :content, :code
 
     def initialize(opts={})
-      if opts.respond_to?(:read) && opts.respond_to?(:base_uri)
-        init_with_uri opts
+      if opts.is_a? HTTP::Response
+        init_with_http_response opts
       elsif opts.is_a? Hash
         init_with_hash opts
       end
@@ -14,18 +14,29 @@ class WebCache
       content
     end
 
-    private
+    def success?
+      !error
+    end
+
+  private
 
-    def init_with_uri(opts)
-      @content  = opts.read
-      @base_uri = opts.base_uri
-      @error    = nil
+    def init_with_http_response(response)
+      @base_uri = response.uri
+      @code = response.code
+      if response.status.success?
+        @content  = response.to_s
+        @error    = nil
+      else
+        @content  = response.status.to_s
+        @error    = response.status.to_s
+      end
     end
 
     def init_with_hash(opts)
       @error    = opts[:error]
       @base_uri = opts[:base_uri]
       @content  = opts[:content]
+      @code     = opts[:code]
     end
   end
 end

data/lib/webcache/version.rb

@@ -1,3 +1,3 @@
 class WebCache
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: webcache
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-28 00:00:00.000000000 Z
+date: 2019-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: open_uri_redirections
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '4.2'
 description: Easy to use file cache for web downloads
 email: db@dannyben.com
 executables: []