serviceworker-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5204e0b97606d5376b6f64929819f4a028112204
+  data.tar.gz: 3c670957542a61203341a539becb33998e22f449
+SHA512:
+  metadata.gz: bc077d6c2e08e5f50d0f6c51abcba3c717c0ea78799cbbfdebb14c56175b1842e832b503d6a6737a0d598b2a94040ab7665d7496fd3b9156887114e6245cf01d
+  data.tar.gz: 8e830544524431c811c9505e3aefc98466fa6ec7afaa628fa44243559d2f0046d7963340888f69961ce75ebf0c4b69a4e6c1a061d091a5b21e916d11e7efa5bc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rosskaff@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serviceworker-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ross Kaffenberger
+
+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,44 @@
+# ServiceWorker::Rails
+
+Integrates ServiceWorker scripts with the Rails asset pipeline.
+
+## Features
+
+* Leverages Rails asset pipeline to compile service worker scripts
+* Adds appropriate response headers to service worker scripts
+* Renders compiled source in production and development
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serviceworker-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serviceworker-rails
+
+## Usage
+
+Currently, `serviceworker-rails` assumes your script resolves to `serviceworker.js`
+
+## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/serviceworker-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "serviceworker/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/serviceworker-rails.rb

@@ -0,0 +1,2 @@
+require "serviceworker"
+require "serviceworker/rails"

data/lib/serviceworker.rb

@@ -0,0 +1,19 @@
+module ServiceWorker
+  class << self
+    # The path to the root of the application. ServiceWorker.rb uses this property
+    # to . If you are using ServiceWorker.rb with Rails, you do not need to set
+    # this attribute manually.
+    #
+    # @return [String]
+    attr_accessor :root
+
+    # The logger to use when logging exception details and backtraces. If you
+    # are using Better Errors with Rails, you do not need to set this attribute
+    # manually. If this attribute is `nil`, nothing will be logged.
+    #
+    # @return [Logger, nil]
+    attr_accessor :logger
+  end
+end
+
+require "serviceworker/middleware"

data/lib/serviceworker/middleware.rb

@@ -0,0 +1,66 @@
+module ServiceWorker
+  class Middleware
+    def initialize(app, opts = {})
+      @app = app
+      @opts = opts
+
+      @logger = opts.fetch(:logger, ServiceWorker.logger)
+    end
+
+    def call(env)
+      case env['REQUEST_METHOD']
+      when 'GET', 'HEAD'
+        path = env['PATH_INFO'].chomp('/')
+        info("responding to #{path}")
+        return respond_to(path, env) if match?(path)
+      end
+
+      @app.call(env)
+    end
+
+    def match?(path)
+      path == '/serviceworker.js'
+    end
+
+    private
+
+    def respond_to(path_info, env)
+      status, headers, body = handle_request(path_info, env)
+
+      headers['Cache-Control'] = 'private, max-age=0, no-cache'
+
+      [status, headers, body]
+    end
+
+    def handle_request(path_info, env)
+      if config.compile
+        info "compiling #{path_info} from Sprockets"
+        sprockets_server.call(env)
+      else
+        file_path = asset_path(path_info)
+        info "Proxing #{path_info} from #{file_path}"
+        file_server.call(env.merge('PATH_INFO' => file_path))
+      end
+    end
+
+    def info(msg)
+      @logger.info "[#{self.class}] - #{msg}"
+    end
+
+    def sprockets_server
+      ::Rails.application.assets
+    end
+
+    def file_server
+      @file_server ||= ::Rack::File.new(::Rails.root.join("public"))
+    end
+
+    def config
+      ::Rails.application.config.assets
+    end
+
+    def asset_path(path)
+      ::ActionController::Base.helpers.asset_path(path.gsub(/^\//, ''))
+    end
+  end
+end

data/lib/serviceworker/rails.rb

@@ -0,0 +1,8 @@
+require "serviceworker/rails/version"
+require "serviceworker/railtie"
+
+module ServiceWorker
+  module Rails
+
+  end
+end

data/lib/serviceworker/rails/version.rb

@@ -0,0 +1,5 @@
+module ServiceWorker
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/serviceworker/railtie.rb

@@ -0,0 +1,24 @@
+require "rails"
+require "rails/railtie"
+
+module ServiceWorker
+  class Railtie < ::Rails::Railtie
+    initializer "serviceworker-rails.configure_rails_initialization" do
+      insert_middleware
+      ServiceWorker.logger = ::Rails.logger
+      ServiceWorker.root = ::Rails.root.to_s
+    end
+
+    def insert_middleware
+      if defined? ::Rack::SendFile
+        app.middleware.insert_after ::Rack::Sendfile, ServiceWorker::Middleware
+      else
+        app.middleware.use ServiceWorker::Middleware
+      end
+    end
+
+    def app
+      ::Rails.application
+    end
+  end
+end

data/serviceworker-rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serviceworker/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serviceworker-rails"
+  spec.version       = ServiceWorker::Rails::VERSION
+  spec.authors       = ["Ross Kaffenberger"]
+  spec.email         = ["rosskaff@gmail.com"]
+
+  spec.summary       = %q{ServiceWorker for Rails 3+}
+  spec.description   = %q{Integrates ServiceWorker JavaScript support into the Rails asset pipeline.}
+  spec.homepage      = "https://github.com/rossta/serviceworker-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", [">= 3.1"]
+
+  spec.add_development_dependency "sprockets-rails"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rack-test"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: serviceworker-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ross Kaffenberger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-23 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: sprockets-rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: Integrates ServiceWorker JavaScript support into the Rails asset pipeline.
+email:
+- rosskaff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/serviceworker-rails.rb
+- lib/serviceworker.rb
+- lib/serviceworker/middleware.rb
+- lib/serviceworker/rails.rb
+- lib/serviceworker/rails/version.rb
+- lib/serviceworker/railtie.rb
+- serviceworker-rails.gemspec
+homepage: https://github.com/rossta/serviceworker-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ServiceWorker for Rails 3+
+test_files: []