richurls 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4486b68e5e043f9ea570be7f89d147a2c443130740819d850c0c5664831b1662
-  data.tar.gz: 6eb6146c94e4ac4f2efd55ece0c2bcc9792a4e2deb80750e0d2817f37f5f1e44
+  metadata.gz: c099711668f878f6935edf351d0c76735e30653f806a06f161c54f56d38e7191
+  data.tar.gz: 4559b4fe4fad8f175384a127a5ffb93f71e3ed92b2c2d54aa0c8e8fecf5f4828
 SHA512:
-  metadata.gz: b7c6512cecef58f082a2dcfb9e53390966eb553df0c7d7e907461518a182d792bf75a9922a78dd9892d6fb476fa14aedb9b2de6d798915e238de8d217dbd4898
-  data.tar.gz: 376d658ae758094622037321413a59e951ac09d087b04b8e2a60d2826a0453cf3f7b0e437ef06e15b9d6eab5526637ec3ea130c723c5deec348bbbcb25bc2fe3
+  metadata.gz: d8634f5865f47911969e0b7f3c99bfc8d63ab972a1858ea83b817db4cdf32f2d9958eb58b16a162bc81ff2948508163be2cdb46d5d223b69605d983ed13d1c08
+  data.tar.gz: c8a0b54e6adb5bd6e0a87c75745a38849c1c226a562ef3728df48e8f51d3a6fab30aa7930b57eb7fac9d6d445ce0630e4f2953917d36ac19a16eb9dcbc41882d

data/.rubocop.yml

@@ -3,29 +3,31 @@ AllCops:
 
 Lint/SuppressedException:
   Enabled: false
-
 Lint/AssignmentInCondition:
   Exclude:
     - 'spec/**/*.rb'
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
     - '*.gemspec'
-Style/FormatString:
+Metrics/MethodLength:
   Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
 Style/Documentation:
   Enabled: false
-# This is causing breaking changes:
 Style/ExpandPathArguments:
   Enabled: false
+Style/FormatString:
+  Enabled: false
 Style/FrozenStringLiteralComment:
   Enabled: false
 Style/GuardClause:
   Enabled: false
-Style/RegexpLiteral:
+Naming/MemoizedInstanceVariableName:
   Enabled: false
-Style/BlockDelimiters:
-  Exclude:
-    - 'spec/**/*.rb'
-Metrics/MethodLength:
+Style/RegexpLiteral:
   Enabled: false

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    richurls (0.1.9)
+    richurls (0.2.0)
       oj (~> 3)
       ox (~> 2)
       patron (~> 0.13)
-      redis (~> 4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -13,8 +12,8 @@ GEM
     ast (2.4.0)
     diff-lcs (1.3)
     jaro_winkler (1.5.4)
-    oj (3.10.1)
-    ox (2.12.1)
+    oj (3.10.2)
+    ox (2.13.2)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
@@ -49,6 +48,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.1)
+  redis (~> 4.1)
   richurls!
   rspec (~> 3.9)
   rubocop (~> 0.79)

data/README.md

@@ -25,3 +25,22 @@ RichUrls.enrich('https://wetransfer.com')
 # }
 ```
 
+**Caching:**
+
+By default caching is turned off. Caching can be enabled by writing a cache wrapper as such:
+
+```ruby
+class CustomCache < Cache::Wrapper
+  def get(key)
+    # Callback for fetching a cache entry
+  end
+
+  def set(key, value, time)
+    # Callback for setting a value in a cache to a certain key for a certain time
+  end
+
+  def extend(key, time)
+    # Callback for extending a cached value by key by a certain time
+  end
+end
+```

data/lib/cache.rb

@@ -0,0 +1,23 @@
+module Cache
+  class Wrapper
+    def get(_key)
+      raise NotImplementedError, 'wrapper needs `get` method'
+    end
+
+    def set(_key, _value, _time)
+      raise NotImplementedError, 'wrapper needs `set` method'
+    end
+
+    def extend(_key, _time)
+      raise NotImplementedError, 'wrapper needs `extend` method'
+    end
+  end
+
+  class None < Wrapper
+    def get(_); end
+
+    def set(_, _, _); end
+
+    def extend(_); end
+  end
+end

data/lib/parsers/favicon_parser.rb

@@ -1,9 +1,18 @@
 module Parsers
-  FaviconParser = lambda do |document, url|
-    favicon_el = document.find(:link, rel: %w[shortcut icon])
-    icon_el = document.find(:link, rel: %w[icon])
+  module FaviconParser
+    KEYWORDS = ['shortcut icon', 'icon shortcut', 'icon'].freeze
 
-    (favicon_el && UrlHelper.url_for(url, favicon_el.attributes[:href])) ||
-      (icon_el && UrlHelper.url_for(url, icon_el.attributes[:href]))
+    def self.call(document, url)
+      KEYWORDS.each do |rel|
+        found_document = document.find(:link, rel: rel)
+
+        if found_document
+          @el = found_document
+          break
+        end
+      end
+
+      @el && UrlHelper.url_for(url, @el.attributes[:href])
+    end
   end
 end

data/lib/richurls.rb

@@ -3,12 +3,26 @@ require 'redis'
 require 'uri'
 require 'digest'
 
+require_relative 'cache'
 require_relative 'url_fetcher'
 require_relative 'body_decorator'
 
 module RichUrls
   class MalformedURLError < StandardError; end
 
+  def self.cache
+    @cache || Cache::None.new
+  end
+
+  def self.cache=(wrapper)
+    unless wrapper < Cache::Wrapper
+      raise ArgumentError,
+            'caching wrapper needs to be of type Cache::Wrapper'
+    end
+
+    @cache ||= wrapper.new
+  end
+
   def self.enrich(url)
     unless URI::DEFAULT_PARSER.make_regexp.match?(url)
       raise MalformedURLError, "this url is malformed: #{url}"

data/lib/url_fetcher.rb

@@ -18,10 +18,10 @@ module RichUrls
     end
 
     def fetch
-      cached = redis.get(digest)
+      cached = RichUrls.cache.get(digest)
 
       if cached
-        redis.expire(digest, CACHE_TIME)
+        RichUrls.cache.extend(digest, CACHE_TIME)
         Oj.load(cached)
       else
         patron_call
@@ -30,10 +30,6 @@ module RichUrls
 
     private
 
-    def redis
-      @redis ||= Redis.new
-    end
-
     def digest
       @digest ||= Digest::MD5.hexdigest(@url)
     end
@@ -44,7 +40,7 @@ module RichUrls
 
       if response.status < 400
         decorated = BodyDecorator.new(response.url, response.body).decorate
-        redis.set(digest, Oj.dump(decorated), ex: CACHE_TIME)
+        RichUrls.cache.set(digest, Oj.dump(decorated), CACHE_TIME)
         decorated
       else
         raise UrlFetcherError, 'url cannot be found'

data/lib/xml_handler.rb

@@ -26,17 +26,9 @@ module RichUrls
       @elements = []
     end
 
-    def find(name, attributes = {})
+    def find(name, attrs = {})
       @elements.detect do |el|
-        matching_attributes = attributes.all? do |key, val|
-          if val.is_a?(Array)
-            result = el.attributes.fetch(key, '').split(' ')
-
-            val.all? { |sub_val| result.include?(sub_val) }
-          else
-            el.attributes[key] == val
-          end
-        end
+        matching_attributes = attrs.all? { |k, v| el.attributes[k] == v }
 
         el.name == name && matching_attributes
       end

data/richurls.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'richurls'
-  spec.version = '0.1.9'
+  spec.version = '0.2.0'
   spec.authors = ['grdw']
   spec.email = ['gerard@wetransfer.com']
 
@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'oj', '~> 3'
   spec.add_dependency 'ox', '~> 2'
   spec.add_dependency 'patron', '~> 0.13'
-  spec.add_dependency 'redis', '~> 4.1'
   spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'redis', '~> 4.1'
   spec.add_development_dependency 'rspec', '~> 3.9'
   spec.add_development_dependency 'rubocop', '~> 0.79'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richurls
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - grdw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :runtime
+        version: '2.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ files:
 - LICENSE
 - README.md
 - lib/body_decorator.rb
+- lib/cache.rb
 - lib/parsers/description_parser.rb
 - lib/parsers/embed_parser.rb
 - lib/parsers/embed_parsers/base.rb