webcache 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba7f34df29a71904f0339c0495ec3e794fb27057203bbb9957cf52944f0d4394
-  data.tar.gz: b15806d79f3ba736aaeab5f335c23ae7f24efdea3902cd955362b9fcc6c0e46e
+  metadata.gz: 25153a99b8c66cf0ced7058588431c1609861557c8b6078b35c95aa2ee3910bd
+  data.tar.gz: ad2729b1be7a35c41cbe4e5353587b8bf6633b557694b36ac32da2d1de1e481b
 SHA512:
-  metadata.gz: 664369168097d544eb74acd295ca76cfc64c122b7d12b04e49f93632ca781210d258badcb4fcd05b79533d4b06dfc0d7143659d05e9e19c5f29886f8be4c4644
-  data.tar.gz: 2d957952ebd6771959432bca59880ed06ca50ee64d7b0f64e8446dbf6c7232e9a43dd55c723373181f8c0269548bff731d095efda8dd60fc41a5f281d2459ebe
+  metadata.gz: 170441dab3662f413d130de99f79d9a778a1feaf85913aaccb0f117275b65540dfaee631c643f11846bae8d776ce8ecf1419863555c9da93075b56aa4224f93b
+  data.tar.gz: a1b2f766439bbf2a2afe5d6818f5a174c7172fa912cba66d4e3114d2f9f0cf6f6782ea95f624343f64274698478366e67d97c05ef9e5b9956cb1c6df50fb4723

data/README.md

@@ -1,8 +1,7 @@
-WebCache
-==================================================
+# WebCache
 
 [![Gem Version](https://badge.fury.io/rb/webcache.svg)](https://badge.fury.io/rb/webcache)
-[![Build Status](https://travis-ci.com/DannyBen/webcache.svg?branch=master)](https://travis-ci.com/DannyBen/webcache)
+[![Build Status](https://github.com/DannyBen/webcache/workflows/Test/badge.svg)](https://github.com/DannyBen/webcache/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/022f555211d47d655988/maintainability)](https://codeclimate.com/github/DannyBen/webcache/maintainability)
 
 ---
@@ -11,8 +10,7 @@ Hassle-free caching for HTTP download.
 
 ---
 
-Install
---------------------------------------------------
+## Install
 
 ```
 $ gem install webcache
@@ -24,8 +22,7 @@ Or with bundler:
 gem 'webcache'
 ```
 
-Usage
---------------------------------------------------
+## Usage
 
 WebCache can be used both as an instance, and as a static class.
 
@@ -62,12 +59,13 @@ puts response.base_uri    # => "http://example.com/"
 ```
 
 By default, the cached objects are stored in the `./cache` directory, and
-expire after 60 minutes. The cache directory will be created as needed.
+expire after 60 minutes. The cache directory will be created as needed, and
+the permissions of the cached files can be specified if needed.
 
 You can change these settings on initialization:
 
 ```ruby
-cache = WebCache.new dir: 'tmp/my_cache', life: '3d'
+cache = WebCache.new dir: 'tmp/my_cache', life: '3d', permissions: 0o640
 response = cache.get 'http://example.com'
 ```
 
@@ -77,6 +75,7 @@ Or later:
 cache = WebCache.new
 cache.dir = 'tmp/my_cache'
 cache.life = '4h'
+cache.permissions = 0o640
 response = cache.get 'http://example.com'
 ```
 
@@ -147,8 +146,7 @@ cache = WebCache.new
 response = cache.get 'http://example.com', force: true
 ```
 
-Authentication
---------------------------------------------------
+## Authentication
 
 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
@@ -178,10 +176,7 @@ For other authentication headers, simply provide the header string:
 cache = WebCache.new auth: "Bearer t0k3n"
 ```
 
-
-
-Response Object
---------------------------------------------------
+## Response Object
 
 The response object holds these properties:
 
@@ -191,7 +186,6 @@ Contains the HTML content. In case of an error, this will include the
 error message. The `#to_s` method of the response object also returns
 the same content.
 
-
 ### `response.error`
 
 In case of an error, this contains the error message, `nil` otherwise.
@@ -210,12 +204,17 @@ Contains the actual address of the page. This is useful when the request
 is redirected. For example, `http://example.com` will set the 
 `base_uri` to `http://example.com/` (note the trailing slash).
 
-
----
+## Related Projects
 
 For a similar gem that provides general purpose caching, see the 
-[Lightly gem][2]
+[Lightly gem][lightly].
+
+## Contributing / Support
 
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
 
-[1]: http://ruby-doc.org/stdlib-2.0.0/libdoc/open-uri/rdoc/OpenURI/OpenRead.html#method-i-open
-[2]: https://github.com/DannyBen/lightly
+[lightly]: https://github.com/DannyBen/lightly
+[issues]: https://github.com/DannyBen/webcache/issues

data/lib/webcache/cache_operations.rb

@@ -4,21 +4,23 @@ require 'http'
 
 class WebCache
   module CacheOperations
+    attr_accessor :permissions
     attr_reader :last_error, :user, :pass, :auth
     attr_writer :dir
 
-    def initialize(dir: 'cache', life: '1h', auth: nil)
+    def initialize(dir: 'cache', life: '1h', auth: nil, permissions: nil)
       @dir = dir
       @life = life_to_seconds life
       @enabled = true
       @auth = convert_auth auth
+      @permissions = permissions
     end
 
     def get(url, force: false)
       return http_get url unless enabled?
 
       path = get_path url
-      clear url if force or stale? path
+      clear url if force || stale?(path)
 
       get! path, url
     end
@@ -69,6 +71,7 @@ class WebCache
 
     def get!(path, url)
       return load_file_content path if File.exist? path
+
       response = http_get url
       save_file_content path, response unless !response || response.error
       response
@@ -84,8 +87,8 @@ class WebCache
 
     def save_file_content(path, response)
       FileUtils.mkdir_p dir
-      File.open path, 'wb' do |f| 
-        f.write Marshal.dump response
+      File.open path, 'wb', permissions do |file|
+        file.write Marshal.dump(response)
       end
     end
 
@@ -111,31 +114,32 @@ class WebCache
     end
 
     def stale?(path)
-      life > 0 and File.exist?(path) and Time.new - File.mtime(path) >= life
+      life.positive? and File.exist?(path) and Time.new - File.mtime(path) >= life
     end
 
     def life_to_seconds(arg)
       arg = arg.to_s
 
       case arg[-1]
-      when 's'; arg[0..-1].to_i
-      when 'm'; arg[0..-1].to_i * 60
-      when 'h'; arg[0..-1].to_i * 60 * 60
-      when 'd'; arg[0..-1].to_i * 60 * 60 * 24
-      else;     arg.to_i
+      when 's' then arg[0..].to_i
+      when 'm' then arg[0..].to_i * 60
+      when 'h' then arg[0..].to_i * 60 * 60
+      when 'd' then arg[0..].to_i * 60 * 60 * 24
+      else; arg.to_i
       end
     end
 
     def convert_auth(opts)
-      @user, @pass, @auth = nil, nil, nil
+      @user = nil
+      @pass = nil
+      @auth = nil
 
-      if opts.respond_to?(:has_key?) and opts.has_key?(:user) and opts.has_key?(:pass)
+      if opts.respond_to?(:has_key?) && opts.has_key?(:user) && opts.has_key?(:pass)
         @user = opts[:user]
         @pass = opts[:pass]
       else
         @auth = opts
       end
     end
-
   end
 end

data/lib/webcache/response.rb

@@ -2,11 +2,10 @@ class WebCache
   class Response
     attr_accessor :error, :base_uri, :content, :code
 
-    def initialize(opts={})
-      if opts.is_a? HTTP::Response
-        init_with_http_response opts
-      elsif opts.is_a? Hash
-        init_with_hash opts
+    def initialize(opts = {})
+      case opts
+      when HTTP::Response then init_with_http_response opts
+      when Hash           then init_with_hash opts
       end
     end
 

data/lib/webcache/version.rb

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

data/lib/webcache.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webcache
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-29 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.0'
 description: Easy to use file cache for web downloads
 email: db@dannyben.com
 executables: []
@@ -33,14 +33,14 @@ files:
 - README.md
 - lib/webcache.rb
 - lib/webcache/cache_operations.rb
-- lib/webcache/polyfills.rb
 - lib/webcache/response.rb
 - lib/webcache/version.rb
 - lib/webcache/web_cache.rb
 homepage: https://github.com/DannyBen/webcache
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -49,14 +49,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Hassle-free caching for HTTP download

data/lib/webcache/polyfills.rb

@@ -1,10 +0,0 @@
-# :nocov:
-
-# Required for Ruby < 2.4
-if !Dir.respond_to? :empty?
-  class Dir
-    def self.empty?(path_name)
-      exist?(path_name) && (entries(path_name) - ['.', '..']).empty?
-    end
-  end
-end