rack-content_disposition_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65bb8f8c0b81289e8992dddcdc32ddf7be95aebbadf8c981a4c11a193670f6f1
+  data.tar.gz: 07f5d4a25e13bd83dc705513720c7b0835f7d29b0b794aab7a840b497232e672
+SHA512:
+  metadata.gz: 9a3884c9d2a6f6e757596cdf6354e02cf1fb7bf21454b8dfb0a27112f713ecb3998df85d90eb9114daa74215a0df6712f0d2344f5194234c7b2972a738b0d21e
+  data.tar.gz: 5e78b8f97f0b1939177f7229524cae99f566034431454f3776aaeabb38aa29c4dcc293346a4ae12ea45f1287156f38d51ee4b0c514d87c7f2e6a9f58894600dc

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022/03/24
+
+- Initial release.

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 hana-da
+
+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,70 @@
+# Rack::ContentDispositionHelper
+
+Rack::ContentDispositionHelper is Rack middleware that rewrites the decoded `filename*` directive in the Content-Disposition response header as the value of the `filename` directive.
+
+Safari does not use `filename*` if the size of the Content-Disposition response header exceeds 254Bytes, but this middleware is helpful in such cases.
+
+This middleware checks that the User-Agent value in the request header is Safari-like.
+If the User-Agent is not Safari-like, no processing is performed.
+
+## Usage example
+
+### Rails app
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem 'rack-content_disposition_helper'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+This will load rack-content_disposition_helper and set it up as a Rails middleware. The middleware is inserted for all of environment.
+
+You don't need to add middleware to rails middleware stack. 
+
+### Sinatra and other Rack apps
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+gem 'rack-content_disposition_helper'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+For Sinatra and other Rack apps, add this to config.ru:
+
+```ruby
+# config.ru
+use Rack::ContentDispositionHelper
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hana-da/rack-content_disposition_helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hana-da/rack-content_disposition_helper/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rack::ContentDispositionHelper project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hana-da/rack-content_disposition_helper/blob/master/CODE_OF_CONDUCT.md).

data/lib/rack/content_disposition_helper/content_disposition.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Rack
+  class ContentDispositionHelper
+    class ContentDisposition
+      LIMIT = 254
+      FILENAME_ASTERISK_PREFIX = "filename*=UTF-8''"
+
+      attr_reader :value, :parts
+
+      def initialize(original_value)
+        @value = original_value
+        @parts = value&.split
+      end
+
+      def long?
+        return nil unless value
+
+        value.length > LIMIT
+      end
+
+      def disposition
+        parts&.first
+      end
+
+      def raw_filename_value
+        return unless disposition
+
+        "#{disposition} filename=\"#{raw_filename}\""
+      end
+
+      def raw_filename
+        filename_asterisk&.then { |v| CGI.unescape(v).delete_prefix!(FILENAME_ASTERISK_PREFIX) }
+      end
+
+      def filename_asterisk
+        parts&.find { |d| d.start_with?(FILENAME_ASTERISK_PREFIX) }
+      end
+    end
+  end
+end

data/lib/rack/content_disposition_helper/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rack
+  class ContentDispositionHelper
+    class Railtie < ::Rails::Railtie
+      initializer 'rack-content_disposition_helper.middleware_use' do |app|
+        app.middleware.use Rack::ContentDispositionHelper
+      end
+    end
+  end
+end

data/lib/rack/content_disposition_helper/user_agent.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rack
+  class ContentDispositionHelper
+    class UserAgent
+      SAFARI_PATTERN = %r{ (:?Version|Mobile)/[0-9A-Z.]+ Safari/[0-9.]+\z}.freeze
+
+      def initialize(env)
+        @user_agent = env['HTTP_USER_AGENT']
+      end
+
+      def safari?
+        @user_agent&.match?(SAFARI_PATTERN)
+      end
+    end
+  end
+end

data/lib/rack/content_disposition_helper/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  class ContentDispositionHelper
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/content_disposition_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rack/content_disposition_helper/version'
+
+require 'rack/content_disposition_helper/user_agent'
+require 'rack/content_disposition_helper/content_disposition'
+
+require 'rack/content_disposition_helper/railtie' if defined?(::Rails::Railtie)
+
+module Rack
+  class ContentDispositionHelper
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status_code, headers, body = @app.call(env)
+
+      user_agent = UserAgent.new(env)
+      content_disposition = ContentDisposition.new(headers['Content-Disposition'])
+
+      if content_disposition.long? && user_agent.safari?
+        headers = headers.merge('Content-Disposition' => content_disposition.raw_filename_value)
+      end
+
+      [status_code, headers, body]
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: rack-content_disposition_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hana-da
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Rack::ContentDispositionHelper is Rack middleware that rewrites the decoded
+  filename* directive in the Content-Disposition response header as the value of the
+  filename directive.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- lib/rack/content_disposition_helper.rb
+- lib/rack/content_disposition_helper/content_disposition.rb
+- lib/rack/content_disposition_helper/railtie.rb
+- lib/rack/content_disposition_helper/user_agent.rb
+- lib/rack/content_disposition_helper/version.rb
+homepage: https://github.com/hana-da/rack-content_disposition_helper
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/hana-da/rack-content_disposition_helper
+  source_code_uri: https://github.com/hana-da/rack-content_disposition_helper
+  bug_tracker_uri: https://github.com/hana-da/rack-content_disposition_helper/issues
+  changelog_uri: https://github.com/hana-da/rack-content_disposition_helper/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.9
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware that modifies Content-Disposition response header.
+test_files: []