web_package-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62816866d03b077345bed1d89d669f936d6cb8ba
+  data.tar.gz: ea2217a4bad02a5026d22efb8374cacbb981d522
+SHA512:
+  metadata.gz: 6dc59287308fdd5aafdad31c5fed57e05b6eac6b9f082da2baaf6d773ae68b4c7c0d6e88cdff30d2df77988af9ff1c332005398a9147c2adf0311bbf91d12c70
+  data.tar.gz: 4f31cb9eeb9fb907878870c5b1397f644e7e0aee512e52220958bede2f50259bd4d9b19eb0ed0380260673e03e189dbc59457436f53427230bbc6af02ede01b9

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/LineLength:
+  Max: 100
+  IgnoreCopDirectives: true
+
+Naming/FileName:
+  Exclude:
+    - 'lib/web_package-rails.rb'
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - s
+
+Style/CharacterLiteral:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Oleg Afanasyev
+
+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,43 @@
+# Web packaging for Rails
+
+This gem is a glue to stick underlying [web_package](https://github.com/gafrom/web_package) mechanism into Rails 3+ apps. It provides a way to extend existing routes in Rails application with `.sxg` formats. That is, for each known path `/articles/foo` the library handles `/articles/foo.sxg` path out of the box.
+
+## Required environment variables
+
+For an http exchange to be signed a certificate with a special "CanSignHttpExchanges" extension must be provided. For testing purposes you may use just a self-signed one. Please refer to [web_package docs](https://github.com/gafrom/web_package#ever-thought-of-saving-the-internet-on-a-flash) to create such.
+
+Also, an endpoint must be set up serving the certificate in `application/cert-chain+cbor` format. You can use `gen-certurl` tool from [here](https://github.com/WICG/webpackage/tree/master/go/signedexchange#creating-our-first-signed-exchange) to convert PEM certificate into this format.
+
+Having done the above-said we are ready to assign env vars required to use the gem:
+```bash
+export SXG_CERT_URL='https://my.cdn.com/cert.cbor' \
+       SXG_CERT_PATH='/local/path/to/cert.pem' \
+       SXG_PRIV_PATH='/local/path/to/priv.key'
+```
+Please note, that the variables are fetched during class initialization. And <b>failing to provide valid paths will result in an exception.</b>
+
+## Install
+
+First, please ensure the above environment variables are set up all right.
+
+Next, add the gem into your `Gemfile`:
+```ruby
+gem 'web_package-rails'
+```
+And run `bundle install` command.
+
+That's it. Once added, the gem will hook into your Rails initialization process to prepend middleware stack with `WebPackage::Middleware`.
+
+## What is inside
+
+The gem is just a rack middleware comprising a lightweight scanner of request paths for the presence of `.sxg` extension. If found, the path is cleared of it, and modified request url is then passed further down the middleware stack to be handled as if no extension was ever given.
+
+In case `.sxg` extension is not detected - the requests are simply proxied intact.
+
+## Contributing
+
+Fork it, create your feature branch from develop, make changes and create new Pull Request. Please do not forget tests.
+
+## License
+
+Web package for Rails is released under the [MIT License](../master/LICENSE).

data/lib/web_package-rails.rb

@@ -0,0 +1,3 @@
+require 'web_package'
+require 'web_package/rails/version'
+require 'web_package/railtie'

data/lib/web_package/rails/version.rb

@@ -0,0 +1,5 @@
+module WebPackage
+  module Rails
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/web_package/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails/railtie'
+
+module WebPackage
+  # Integration into Rails middleware pipeline.
+  class Railtie < ::Rails::Railtie
+    initializer 'web_package.configure_rails_initialization' do |app|
+      app.middleware.insert 0, Middleware
+    end
+  end
+end

data/web_package-rails.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('lib/web_package/rails/version', __dir__)
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = 'web_package-rails'
+  s.version     = WebPackage::Rails::VERSION
+  s.date        = Date.today.to_s
+  s.summary     = 'Web packaging middleware for Rails.'
+  s.description = 'Provides integration of Signed HTTP Exchange format into Rails 3+, allowing a '\
+                  'browser to trust that a HTTP request-response pair was generated by the '\
+                  'origin it claims.'
+  s.authors     = ['Oleg Afanasyev', 'Alexey Martynyuk']
+  s.email       = ['gafrom@gmail.com']
+  s.homepage    = 'https://github.com/gafrom/web_package-rails'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2.0'
+
+  s.add_runtime_dependency 'railties',    '>= 3.1'
+  s.add_runtime_dependency 'web_package', '~> 0.1'
+
+  s.add_development_dependency 'rubocop', '~> 0.67'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: web_package-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleg Afanasyev
+- Alexey Martynyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: web_package
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.67'
+description: Provides integration of Signed HTTP Exchange format into Rails 3+, allowing
+  a browser to trust that a HTTP request-response pair was generated by the origin
+  it claims.
+email:
+- gafrom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- lib/web_package-rails.rb
+- lib/web_package/rails/version.rb
+- lib/web_package/railtie.rb
+- web_package-rails.gemspec
+homepage: https://github.com/gafrom/web_package-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Web packaging middleware for Rails.
+test_files: []