twingly-url_cache 1.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9ed893f285e11aefe16536d0dbff6dd75d2e1e9
-  data.tar.gz: 92fa6a2cfc57232d56e0b89542556a9ce8f484ae
+SHA256:
+  metadata.gz: 1ed2d18cc27d219c6d13d00683ba7b3452e3f4e1820706d538c86f7ea102515c
+  data.tar.gz: de311bd4e8dddc0c8d0d28aaf48c56bd49940920d12a0c233261eee0e1b24536
 SHA512:
-  metadata.gz: 938656877cb25f56db3ccb9b88c8196329fd1b8982bc613c53b1b51be5a08a7f4c55ba52eb2953fe886d8daea8fc85266d7d33f820a677d4bf0d7a2048a720d7
-  data.tar.gz: 21a983f60abfc1a58a3ff76a42ab9f01e53057d734e7ba3d90263a63a2e9156d423f7ffeae5a8246df195ba32a6f0c2747d77efd5d45ce1fd8fbc44bdc4cde88
+  metadata.gz: 8f50e165dbb8716c6fbbb3ada282e1d2e41a03579a7d9905853dcbcfe92c3c16014979e074d165f3889db0edcffac7b622e215222df6c99533fc914db4e17c90
+  data.tar.gz: 38c9491b219f5e951e0a8a438402674e941c7c639e6c33486cd7f8b063e2595afbce60d69e4789df4f72cf81c4571ee888d44a4e5958a05029da0e83859c05db

data/README.md

@@ -1,5 +1,7 @@
 # Twingly::UrlCache
 
+[![GitHub Build Status](https://github.com/twingly/twingly-url_cache/workflows/CI/badge.svg?branch=master)](https://github.com/twingly/twingly-url_cache/actions)
+
 URL cache, remember if an URL been seen before. Uses [Memcached] to cache data, prefers [MemCachier].
 
 [Memcached]: http://memcached.org/
@@ -36,10 +38,10 @@ Initialize an instance, cache an URL with `#cache!` and look if it's cached with
 => false
 ```
 
-Required environment variables:
+Optional environment variables:
 
 ```Shell
-MEMCACHIER_SERVERS
+MEMCACHIER_SERVERS # Defaults to localhost
 MEMCACHIER_PASSWORD
 MEMCACHIER_USERNAME
 ```
@@ -48,9 +50,26 @@ MEMCACHIER_USERNAME
 
 After checking out the repo, run `bin/setup` to install dependencies. Start memcached. Then, run `bundle exec rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release workflow
+
+* Update the examples in this README if needed.
+
+* Bump the version in `lib/twingly/url_cache/version.rb` in a commit, no need to push (the release task does that).
+
+* Ensure you are signed in to RubyGems.org as [twingly][twingly-rubygems] with `gem signin`.
+
+* Build and [publish](http://guides.rubygems.org/publishing/) the gem. This will create the proper tag in git, push the commit and tag and upload to RubyGems.
+
+        bundle exec rake release
+
+* Update the changelog with [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/) (`gem install github_changelog_generator` if you don't have it, set `CHANGELOG_GITHUB_TOKEN` to a personal access token to avoid rate limiting by GitHub). This command will update `CHANGELOG.md`. You need to commit and push manually.
+
+        github_changelog_generator -u twingly -p twingly-url_cache
+
+[twingly-rubygems]: https://rubygems.org/profiles/twingly
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/twingly/twingly-url_cache.
-

data/lib/twingly/url_cache/version.rb

@@ -1,5 +1,5 @@
 module Twingly
   class UrlCache
-    VERSION = "1.0.1"
+    VERSION = "3.0.0"
   end
 end

data/lib/twingly/url_cache.rb

@@ -5,26 +5,35 @@ require "retryable"
 
 module Twingly
   class UrlCache
+    class Error < StandardError; end
+    class ServerError < Error; end
+
     attr_reader :ttl
 
     CACHE_VALUE = ""
 
-    def initialize(ttl: 0)
-      @cache = Dalli::Client.new(servers, options)
-      @ttl = ttl
+    def initialize(ttl: 0, cache: default_cache)
+      @ttl   = ttl
+      @cache = cache
     end
 
     def cache!(url)
       key = key_for(url)
-      Retryable.retryable(tries: 3, on: Dalli::RingError) do
-        !!@cache.set(key, CACHE_VALUE, ttl, raw: true)
+
+      retry_transient_exceptions do
+        with_exception_class_conversion do
+          !!@cache.set(key, CACHE_VALUE, ttl, raw: true)
+        end
       end
     end
 
     def cached?(url)
       key = key_for(url)
-      Retryable.retryable(tries: 3, on: Dalli::RingError) do
-        @cache.get(key, raw: true) == CACHE_VALUE
+
+      retry_transient_exceptions do
+        with_exception_class_conversion do
+          @cache.get(key, raw: true) == CACHE_VALUE
+        end
       end
     end
 
@@ -34,6 +43,14 @@ module Twingly
       Digest::MD5.digest(url)
     end
 
+    def default_cache
+      retry_transient_exceptions do
+        with_exception_class_conversion do
+          Dalli::Client.new(servers, options)
+        end
+      end
+    end
+
     def options
       {
         username: ENV.fetch("MEMCACHIER_USERNAME") { },
@@ -45,8 +62,19 @@ module Twingly
     end
 
     def servers
-      ENV.fetch("MEMCACHIER_SERVERS").split(",")
+      ENV.fetch("MEMCACHIER_SERVERS") { "localhost" }.split(",")
+    end
+
+    def with_exception_class_conversion
+      yield
+    rescue Dalli::RingError => error
+      raise ServerError, error.message
+    rescue Dalli::DalliError => error
+      raise Error, error.message
+    end
+
+    def retry_transient_exceptions(&block)
+      Retryable.retryable(tries: 3, on: ServerError, &block)
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twingly-url_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Twingly AB
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 3.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 3.2.3
 - !ruby/object:Gem::Dependency
   name: retryable
   requirement: !ruby/object:Gem::Requirement
@@ -38,34 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,7 +93,7 @@ files:
 homepage: https://github.com/twingly/twingly-url_cache
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: URL cache, remember if an URL been seen before
 test_files: []