richurls 0.5.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4030ed06bc0c13f5707d3a061e6561eb8229fa48b6d3499fbe7d434c7fa0d433
-  data.tar.gz: 8e324278bcc431ddd8cffe70ce17cf0d81dc8e3e9dbe13d93508f38e6a4efef5
+  metadata.gz: 145d6a2838880f17633feaaf112591a56742fc575994381b9ff6f643cc57cfeb
+  data.tar.gz: 0cc73d7141e804757dc96be1fad2f16e0efdb89632f7d7fb2ed8b40d26a82282
 SHA512:
-  metadata.gz: 2ed70d90e7231dc89c0d7c152ffbdf085339c65ddf8737a9d997874dc67a34900b5768b5529f8e76bb6a2f557458f51411fd3923bd9416ae09815b4afb5996c9
-  data.tar.gz: 319f776fd40d680038bd134b620c779a49d263a858afc703f44b1eedf22bb6e58ee5016011ccbc8a075b917a32b83d0c42c54f2ff5c18b26657566a303513e9d
+  metadata.gz: c914e3714a4fa9d46cfe1d64ec84291c2161ab430e91519f636170a848c0f6dfcb57c5c54ec511382386e1dbab9bb0d83de76474f0b531277e23f7f1c4374d70
+  data.tar.gz: aec44007b71df681a63452331fbe4a3fa2c38d3e7203308f5a6e0e5c664d9c146dbff12fd00dd78da48f8e8f46846ec6eaec9648ee51254f2d82eee2b6454ac2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    richurls (0.5.8)
+    richurls (0.6.0)
       addressable (~> 2)
       oj (~> 3)
       ox (~> 2)
@@ -14,7 +14,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     diff-lcs (1.3)
-    oj (3.10.6)
+    oj (3.10.8)
     ox (2.13.2)
     parallel (1.19.1)
     parser (2.7.1.2)

data/README.md

@@ -1,4 +1,4 @@
-# richurls [![Build Status](https://travis-ci.com/WeTransfer/richurls.svg?branch=master)](https://travis-ci.com/WeTransfer/richurls)
+# richurls [![Build Status](https://travis-ci.com/WeTransfer/richurls.svg?branch=main)](https://travis-ci.com/WeTransfer/richurls)
 A gem which can enrich urls with speed.
 
 **Installation**
@@ -85,3 +85,20 @@ RichUrls.enrich('https://wetransfer.com', cache_time: 3600)
 This `cache_time` will be accessible through the `time` parameters in the `set`
 and `extend` methods on the `Cache::Wrapper`-instance and can be used as you
 please.
+
+**Swapping browsers**
+
+The default browser is `curl` in the form of `Patron`. However if you feel
+like swapping to a different 'browser' like `HTTParty`, `RestClient` or something
+like `Ferrum` feel free to do so. You can swap it by doing:
+
+```ruby
+class CustomBrowser < RichUrls::Browser
+  def remote_call(url)
+    # Please make sure to return the variables in the function as such:
+    [status, redirected_url, body]
+  end
+end
+
+RichUrls.browser = CustomBrowser.new
+```

data/lib/patron_browser.rb

@@ -0,0 +1,25 @@
+require 'patron'
+
+module RichUrls
+  DEFAULT_TIMEOUT = 10 # seconds
+
+  class Browser
+    def remote_call(_url)
+      raise NotImplementedError,
+            'subclasses of Browser need a remote_call method'
+    end
+  end
+
+  class PatronBrowser < Browser
+    def remote_call(url)
+      session = Patron::Session.new(
+        timeout: DEFAULT_TIMEOUT,
+        headers: RichUrls.headers
+      )
+
+      response = session.get(url)
+
+      [response.status, response.url, response.body]
+    end
+  end
+end

data/lib/richurls.rb

@@ -5,6 +5,7 @@ require 'digest'
 require_relative 'cache'
 require_relative 'url_fetcher'
 require_relative 'body_decorator'
+require_relative 'patron_browser'
 
 module RichUrls
   class MalformedURLError < StandardError; end
@@ -13,6 +14,19 @@ module RichUrls
     @cache || Cache::None.new
   end
 
+  def self.browser=(browser)
+    unless browser.is_a? Browser
+      raise ArgumentError,
+            'browser needs to be of a RichUrls::Browser type'
+    end
+
+    @browser ||= browser
+  end
+
+  def self.browser
+    @browser || PatronBrowser.new
+  end
+
   def self.cache=(wrapper)
     unless wrapper.is_a? Cache::Wrapper
       raise ArgumentError,
@@ -35,6 +49,6 @@ module RichUrls
       raise MalformedURLError, "this url is malformed: #{url}"
     end
 
-    UrlFetcher.fetch(url, filter, cache_time)
+    UrlFetcher.fetch(url, filter, browser: browser, cache_time: cache_time)
   end
 end

data/lib/url_fetcher.rb

@@ -6,15 +6,21 @@ module RichUrls
 
     class UrlFetcherError < StandardError; end
 
-    def self.fetch(url, attributes = [], cache_time = nil)
-      new(url, attributes, cache_time).fetch
+    def self.fetch(
+      url,
+      attributes = [],
+      browser: PatronBrowser.new,
+      cache_time: nil
+    )
+      new(url, attributes, browser, cache_time).fetch
     end
 
     private_class_method :new
 
-    def initialize(url, attributes, cache_time)
+    def initialize(url, attributes, browser, cache_time)
       @url = url
       @attributes = attributes
+      @browser = browser
       @cache_time = cache_time
     end
 
@@ -36,17 +42,10 @@ module RichUrls
     end
 
     def patron_call
-      session = Patron::Session.new(
-        timeout: DEFAULT_TIMEOUT,
-        headers: RichUrls.headers
-      )
+      status, return_url, body = @browser.remote_call(@url)
 
-      response = session.get(@url)
-
-      if response.status < 400
-        decorated = BodyDecorator.decorate(
-          response.url, response.body, @attributes
-        )
+      if status < 400
+        decorated = BodyDecorator.decorate(return_url, body, @attributes)
         RichUrls.cache.set(digest, Oj.dump(decorated), @cache_time)
         decorated
       else

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.5.8'
+  spec.version = '0.6.0'
   spec.authors = ['grdw']
   spec.email = ['gerard@wetransfer.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: richurls
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.6.0
 platform: ruby
 authors:
 - grdw
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -153,6 +153,7 @@ files:
 - lib/parsers/property.rb
 - lib/parsers/provider_display_parser.rb
 - lib/parsers/url.rb
+- lib/patron_browser.rb
 - lib/richurls.rb
 - lib/url_fetcher.rb
 - lib/url_helper.rb