open_uri_w_redirect_to_https 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9deff2ecc9ce387ffff9e58e0363488e73a4a56
+  data.tar.gz: 762930ae967325ada38469f82b6860b0522ad5e8
+SHA512:
+  metadata.gz: 67810beb05e32c9b442846230827695ce16d80c5a241736c241c42d5d8bae5af7fecb21f70e8b91d408e06f73dda5a31e826af8f60a1bd9cf560c9f733c07cdd
+  data.tar.gz: ac6489110783d2bb0ec7f11c27dde135da3928890000eac965cc0dedd1cac98f3058d2d4c5de9317c911e7dea241256350cce011dc52f8dc33a37ecc9bf4df00

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Felix C. Stegerman
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2014-11-22
+
+    Copyright   : Copyright (C) 2014  Felix C. Stegerman
+    Version     : v0.1.0
+
+[]: }}}1
+
+[![Gem Version](https://badge.fury.io/rb/open_uri_w_redirect_to_https.png)](https://rubygems.org/gems/open_uri_w_redirect_to_https)
+
+## Description
+
+  open_uri_w_redirect_to_https - open-uri HTTP to HTTPS redirect support patch
+
+  Unfortunately, `open-uri` [does not accept HTTP to HTTPS
+  redirects](https://bugs.ruby-lang.org/issues/3719).  This gem
+  patches `open` to allow HTTP to HTTPS redirects when requested.
+
+  So instead of:
+
+```bash
+$ pry
+> require 'open-uri'
+> open 'http://github.com'
+RuntimeError: redirection forbidden: http://github.com -> https://github.com/
+```
+
+  you get:
+
+```bash
+$ pry
+> require 'open_uri_w_redirect_to_https'
+> open 'http://github.com', redirect_to_https: true
+=> #<File:/tmp/open-uri...>
+```
+
+  or:
+
+```bash
+$ pry
+> require 'open_uri_w_redirect_to_https'
+> OpenURI.redirect_to_https = true   # set default
+> open 'http://github.com'
+=> #<File:/tmp/open-uri...>
+```
+
+## Installation
+
+With bundler:
+
+```ruby
+# Gemfile
+gem 'open_uri_w_redirect_to_https'
+```
+
+Otherwise:
+
+```bash
+gem install open_uri_w_redirect_to_https
+```
+
+## Caveats
+
+  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)?
+  <br/>
+  A: because this one is thread-safe.
+
+## Specs & Docs
+
+```bash
+rake spec
+rake coverage
+rake docs
+```
+
+## License
+
+  MIT [1].
+
+## References
+
+  [1] MIT License
+  --- http://opensource.org/licenses/MIT
+
+[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -0,0 +1,64 @@
+desc 'Run specs'
+task :spec do
+  sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
+  sh 'rspec -cfd'
+end
+
+desc 'Run specs verbosely, view w/ less'
+task 'spec:less' do
+  sh 'rspec -cfd --tty | less -R'
+end
+
+desc 'Run specs w/ coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'yes'; Rake::Task['spec'].execute
+end
+
+desc 'Check for warnings'
+task :warn do
+  reqs = %w{ config }.map { |x| "-r open_uri_w_redirect_to_https/#{x}" } * ' '
+  sh "ruby -w -I lib #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs'
+task 'warn:spec' do
+  reqs = Dir['spec/**/*.rb'].sort.map { |x| "-r ./#{x}" } * ' '
+  sh "ruby -w -I lib -r rspec #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs (but not void context)'
+task 'warn:spec:novoid' do
+  sh 'rake warn:spec 2>&1 | grep -v "void context"'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task 'docs:undoc' do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ coverage/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/open_uri_w_redirect_to_https/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build open_uri_w_redirect_to_https.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot:undo' do
+  sh 'git checkout -- lib/open_uri_w_redirect_to_https/version.rb'
+end

data/lib/open_uri_w_redirect_to_https.rb

@@ -0,0 +1,82 @@
+# --                                                            ; {{{1
+#
+# File        : open_uri_w_redirect_to_https.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2014-11-22
+#
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : MIT
+#
+# --                                                            ; }}}1
+
+require 'open-uri'
+require 'thread'
+
+module OpenURI
+
+  RedirectHTTPToHTTPS = { mutex: Mutex.new, default: false }
+
+  class << self
+    alias_method :open_uri_orig     , :open_uri
+    alias_method :redirectable_orig?, :redirectable?
+
+    # set the `open_uri` `:redirect_to_https` default; thread safe!
+    def redirect_to_https=(val)
+      RedirectHTTPToHTTPS[:mutex].synchronize {
+        RedirectHTTPToHTTPS[:default] = val
+      }
+    end
+
+    # `redirectable?` patch that uses `caller` to determine whether
+    # HTTP to HTTPS redirection should be allowed (as well)
+    def redirectable?(uri1, uri2)
+      if caller.find { |x| x =~ /redirect_to_https/ } =~ /__WITH__/
+        redirectable_w_redirect_to_https? uri1, uri2
+      else
+        redirectable_orig? uri1, uri2
+      end
+    end
+
+    # `open_uri` patch that also accepts the `:redirect_to_https`
+    # option; when set to `true`, redirections from HTTP to HTTPS are
+    # allowed; for example:
+    #
+    # ```
+    # open('http://github.com', redirect_to_https: true)  # works!
+    # ```
+    #
+    # you can set the default using `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
+    end
+
+  private
+
+    # allow everything the `redirectable?` method does as well as HTTP
+    # to HTTPS
+    def redirectable_w_redirect_to_https?(uri1, uri2)
+      redirectable_orig?(uri1, uri2) || \
+        (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
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/open_uri_w_redirect_to_https/version.rb

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

data/open_uri_w_redirect_to_https.gemspec

@@ -0,0 +1,31 @@
+require File.expand_path('../lib/open_uri_w_redirect_to_https/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'open_uri_w_redirect_to_https'
+  s.homepage    = 'https://github.com/obfusk/open_uri_w_redirect_to_https'
+  s.summary     = 'open-uri HTTP to HTTPS redirect support patch'
+
+  s.description = <<-END.gsub(/^ {4}/, '')
+    open-uri HTTP to HTTPS redirect support patch
+  END
+
+  s.version     = OpenURIWithRedirectToHttps::VERSION
+  s.date        = OpenURIWithRedirectToHttps::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ MIT }
+
+  s.files       = %w{ .yardopts LICENSE README.md Rakefile } \
+                + %w{ open_uri_w_redirect_to_https.gemspec } \
+                + Dir['lib/**/*.rb']
+
+  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov', '~> 0.9.0'  # TODO
+  s.add_development_dependency 'yard'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: open_uri_w_redirect_to_https
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  open-uri HTTP to HTTPS redirect support patch
+email:
+- flx@obfusk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE
+- README.md
+- Rakefile
+- lib/open_uri_w_redirect_to_https.rb
+- lib/open_uri_w_redirect_to_https/version.rb
+- open_uri_w_redirect_to_https.gemspec
+homepage: https://github.com/obfusk/open_uri_w_redirect_to_https
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: open-uri HTTP to HTTPS redirect support patch
+test_files: []
+has_rdoc: