open_uri_w_redirect_to_https 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9deff2ecc9ce387ffff9e58e0363488e73a4a56
-  data.tar.gz: 762930ae967325ada38469f82b6860b0522ad5e8
+  metadata.gz: 3e440a3dccb0a62785e545546b560476f37ccd57
+  data.tar.gz: 38c85885bc54e08028e1cebdd0d9212fad57cec8
 SHA512:
-  metadata.gz: 67810beb05e32c9b442846230827695ce16d80c5a241736c241c42d5d8bae5af7fecb21f70e8b91d408e06f73dda5a31e826af8f60a1bd9cf560c9f733c07cdd
-  data.tar.gz: ac6489110783d2bb0ec7f11c27dde135da3928890000eac965cc0dedd1cac98f3058d2d4c5de9317c911e7dea241256350cce011dc52f8dc33a37ecc9bf4df00
+  metadata.gz: b390de4b5d5a12d7d15fa0aaa049d859c07291077ff37f09d0dd8ba89da3daf770ee4128393c2da0d91c94d2f591c44190a3ab9786faec75e1587d5ba7c53aba
+  data.tar.gz: cccf201bec13a2d174429fe4706845c05576985b46985e98895f074badb35d81d03c9d0397c32bcdc504d9f3603a5e5b235399f7607594603190a8568ee4a309

data/README.md

@@ -2,10 +2,10 @@
 
     File        : README.md
     Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-    Date        : 2014-11-22
+    Date        : 2014-11-23
 
     Copyright   : Copyright (C) 2014  Felix C. Stegerman
-    Version     : v0.1.0
+    Version     : v0.1.1
 
 []: }}}1
 
@@ -42,7 +42,17 @@ $ pry
 ```bash
 $ pry
 > require 'open_uri_w_redirect_to_https'
-> OpenURI.redirect_to_https = true   # set default
+> OpenURI.w_redirect_to_https { open 'http://github.com' }
+  # dynamically scoped in current thread
+=> #<File:/tmp/open-uri...>
+```
+
+  or:
+
+```bash
+$ pry
+> require 'open_uri_w_redirect_to_https'
+> OpenURI.redirect_to_https = true   # set global default
 > open 'http://github.com'
 => #<File:/tmp/open-uri...>
 ```
@@ -67,10 +77,14 @@ gem install open_uri_w_redirect_to_https
   Monkey-patching is not a very robust way to fix bugs.  Use at your
   own risk.
 
-  Q: why should I prefer this gem to
-  [open_uri_redirections](https://github.com/jaimeiniesta/open_uri_redirections)?
+  Q: why should I prefer this gem to [open_uri_redirections]
+  (https://github.com/jaimeiniesta/open_uri_redirections)?
   <br/>
-  A: because this one is thread-safe.
+  A: because this one is thread-safe (I hope); other than that, feel
+  free to choose either
+
+  NB: this gem internally uses thread-local variables like
+  `Thread.current[:__open_uri_w_redirect_to_https__]`.
 
 ## Specs & Docs
 
@@ -80,6 +94,10 @@ rake coverage
 rake docs
 ```
 
+## TODO
+
+* specs: (can we) test `redirect_to_https=true` w/ threads?
+
 ## License
 
   MIT [1].

data/lib/open_uri_w_redirect_to_https.rb

@@ -2,7 +2,7 @@
 #
 # File        : open_uri_w_redirect_to_https.rb
 # Maintainer  : Felix C. Stegerman <flx@obfusk.net>
-# Date        : 2014-11-22
+# Date        : 2014-11-23
 #
 # Copyright   : Copyright (C) 2014  Felix C. Stegerman
 # Licence     : MIT
@@ -20,17 +20,48 @@ module OpenURI
     alias_method :open_uri_orig     , :open_uri
     alias_method :redirectable_orig?, :redirectable?
 
-    # set the `open_uri` `:redirect_to_https` default; thread safe!
+    # set the `open_uri` `:redirect_to_https` global default
     def redirect_to_https=(val)
-      RedirectHTTPToHTTPS[:mutex].synchronize {
-        RedirectHTTPToHTTPS[:default] = val
-      }
+      (x = RedirectHTTPToHTTPS)[:mutex].synchronize { x[:default] = val }
     end
 
-    # `redirectable?` patch that uses `caller` to determine whether
-    # HTTP to HTTPS redirection should be allowed (as well)
+    # get the `open_uri` `:redirect_to_https` dynamic or global
+    # default
+    def redirect_to_https?
+      (x = RedirectHTTPToHTTPS)[:mutex].synchronize do
+        t = Thread.current[:__open_uri_w_redirect_to_https_default__]
+        t.nil? ? x[:default] : t
+      end
+    end
+
+    # dynamically thread-scoped `open_uri` `:redirect_to_https`
+    # default; for example:
+    #
+    # ```
+    # w_redirect_to_https { open('http://github.com' }
+    # ```
+    def w_redirect_to_https(val = true, &b)
+      old = Thread.current[:__open_uri_w_redirect_to_https_default__]
+      Thread.current[:__open_uri_w_redirect_to_https_default__] = val
+      begin
+        b[]
+      ensure
+        Thread.current[:__open_uri_w_redirect_to_https_default__] = old
+      end
+    end
+
+    # `redirectable?` patch that uses a thread-local variable to
+    # determine whether HTTP to HTTPS redirection should be allowed
+    # (as well)
+    #
+    # unless the dynamic or global `:redirect_to_https` setting is set
+    # to `:always`, only the behaviour of calls through `open_uri`
+    # will be changed (as per argument or dynamic or global setting)
     def redirectable?(uri1, uri2)
-      if caller.find { |x| x =~ /redirect_to_https/ } =~ /__WITH__/
+      if  redirect_to_https? == :always ||
+          Thread.current[:__open_uri_w_redirect_to_https__]
+        # clear to prevent leaking (e.g. to block)
+        Thread.current[:__open_uri_w_redirect_to_https__] = nil
         redirectable_w_redirect_to_https? uri1, uri2
       else
         redirectable_orig? uri1, uri2
@@ -42,20 +73,16 @@ module OpenURI
     # allowed; for example:
     #
     # ```
-    # open('http://github.com', redirect_to_https: true)  # works!
+    # open('http://github.com', redirect_to_https: true)
     # ```
     #
-    # you can set the default using `redirect_to_https=`
+    # you can set the dynamic or global default using
+    # `redirect_to_https=` or `w_redirect_to_https`
     def open_uri(name, *rest, &b)
       r = (o = rest.find { |x| Hash === x }) && o.delete(:redirect_to_https)
-      d = RedirectHTTPToHTTPS[:mutex].synchronize {
-        RedirectHTTPToHTTPS[:default]
-      }
-      if (r.nil? ? d : r)
-        open_uri__WITH__redirect_to_https name, *rest, &b
-      else
-        open_uri__WITHOUT__redirect_to_https name, *rest, &b
-      end
+      Thread.current[:__open_uri_w_redirect_to_https__] = \
+        r.nil? ? redirect_to_https? : r
+      open_uri_orig name, *rest, &b
     end
 
   private
@@ -67,15 +94,6 @@ module OpenURI
         (uri1.scheme.downcase == 'http' && uri2.scheme.downcase == 'https')
     end
 
-    # just calls open_uri_orig; redirectable? matches __WITH__
-    def open_uri__WITH__redirect_to_https(name, *rest, &b)
-      open_uri_orig name, *rest, &b
-    end
-
-    # just calls open_uri_orig; redirectable? does't match __WITH__
-    def open_uri__WITHOUT__redirect_to_https(name, *rest, &b)
-      open_uri_orig name, *rest, &b
-    end
   end
 end
 

data/lib/open_uri_w_redirect_to_https/version.rb

@@ -1,4 +1,4 @@
 module OpenURIWithRedirectToHttps
-  VERSION = '0.1.0'
-  DATE    = '2014-11-22'
+  VERSION = '0.1.1'
+  DATE    = '2014-11-23'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_uri_w_redirect_to_https
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Felix C. Stegerman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-22 00:00:00.000000000 Z
+date: 2014-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakeweb