funneler 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 880aa82cecc26ab6df5c7a41625912a754581fe1
+  data.tar.gz: 163ec38d0b55d418d96a6b922706aaf1a109edc8
+SHA512:
+  metadata.gz: 4a92f2ffde57b6a756699bb8842e2fabd99083f5eb46c5c16341acf17ffad426c430d7642db85b4ee412e949f58d13611a9df0846c3633232543732d445fb104
+  data.tar.gz: cbd8d719e15c1db8d7b333e027e60c384f0cf527ce47acc8df7056d2917ece1582fbd99b90ba25fe57a90869e2060c6325e8a7925b7f81d72cf836c70e1b41ee

data/CHANGELOG

@@ -0,0 +1,2 @@
+v1.0
+  - Initial release of gem

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+We welcome contributions to this repository. Feel free to submit issues for bugs you encounter and pull requests for code and documentation contributions.
+
+In order to prevent licensing issues, we require all contributors to sign an individual contributor license agreement, which is reproduced below:
+
+## Individual Contributor License Agreement
+
+In order to clarify the intellectual property license granted with Contributions from any person or entity, Doximity, Inc. ("Doximity") must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of Doximity; it does not change your rights to use your own Contributions for any other purpose.
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Doximity. Except for the license granted herein to Doximity and recipients of software distributed by Doximity, You reserve all right, title, and interest in and to Your Contributions.
+
+### Definitions
+
+"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Doximity. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+1. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Doximity for inclusion in, or documentation of, any of the products owned or managed by Doximity (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Doximity or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Doximity for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Doximity and to recipients of software distributed by Doximity a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Doximity and to recipients of software distributed by Doximity a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Doximity, or that your employer has executed a separate Corporate CLA with Doximity.
+
+5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
+
+6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7. Should You wish to submit work that is not Your original creation, You may submit it to Doximity separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [[]named here]".
+
+8. You agree to notify Doximity of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    funneler (1.0.1)
+      jwt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (8.2.1)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    jwt (1.5.4)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.3.0)
+      byebug (~> 8.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    timecop (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  funneler!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop
+
+BUNDLED WITH
+   1.13.4

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Doximity, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,64 @@
+# Funneler
+
+A simple gem for helping coordinate moving a user through a set of
+routes.  The gem uses a token to keep track of the current place in the funnel.
+The simplest way to use that token is by including a module into the controller
+and passing the token in the route. However since the token is simply a string
+it can easily be kept in session or any other datastore if needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'funneler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install funneler
+
+## Usage
+
+1. Add the gem to your web application.  The gem is not dependent upon
+   any particular framework. It's only dependency is the [`jwt` gem](https://github.com/jwt/ruby-jwt]
+
+2. Generate a token for a given set of routes, and route your user to
+   the first page:
+```ruby
+funnel = Funneler.build(routes: ['/welcome', '/setup', '/complete'])
+redirect_to funnel.first_page
+```
+
+3. Modify those pages to include the `Funneler::ControllerMethods`
+   helper for reconstituting a funnel from the given token
+
+4. Use the helper to determine the next page like this:
+```erb
+<%= link_to funnel.next_page, "Next" %>
+```
+
+## Details
+
+The `Funneler::Funnel` is the core maintaining the state of the flow of
+pages and building the paths with valid tokens.
+
+
+## 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/doximity/funneler. 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 [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "funneler"
+
+require "pry"
+Pry.start

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/funneler.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'funneler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "funneler"
+  spec.version       = Funneler::VERSION
+  spec.authors       = ["Ryan Stawarz"]
+  spec.email         = ["ryan@stawarz.com"]
+
+  spec.summary       = %q{A light-weight approach for routing users through a pre-determined set of routes.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/doximity/funneler"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = Dir['.rspec', 'CHANGELOG', 'CONTRIBUTING.md', 'Gemfile', 'Gemfile.lock', 'LICENSE.txt', 'README.md', 'Rakefile', 'bin/*', 'funneler.gemspec', 'lib/**/*'].select { |f| File.file?(f) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'jwt'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/funneler/configuration.rb

@@ -0,0 +1,13 @@
+module Funneler
+  class Configuration
+    attr_accessor :jwt_key,
+      :jwt_algorithm,
+      :expires_in_days
+
+    def initialize(options = {})
+      @jwt_key = options[:jwt_key]
+      @jwt_algorithm = options[:jwt_algorithm]
+      @expires_in_days = options.fetch(:expires_in_days, 14)
+    end
+  end
+end

data/lib/funneler/controller_methods.rb

@@ -0,0 +1,7 @@
+module Funneler
+  module ControllerMethods
+    def funnel
+      @funnel ||= Funneler.from_token(token: params[:funnel_token])
+    end
+  end
+end

data/lib/funneler/funnel.rb

@@ -0,0 +1,79 @@
+module Funneler
+  class Funnel
+
+    attr_reader :data
+
+    def initialize(data = {})
+      @data = data
+      @url_cache = Hash.new {|h, key| h[key] = generate_page_for_index(key) }
+    end
+
+    def first_page(additional_params = {})
+      url = @url_cache[0]
+      return url if additional_params.empty?
+
+      add_params_to_url(url, additional_params)
+    end
+
+    def next_page
+      @url_cache[next_index]
+    end
+
+    def previous_page
+      @url_cache[previous_index]
+    end
+
+    def is_last_page?
+      routes.empty? || (current_page_index + 1) >= routes.length
+    end
+
+    def current_page
+      @url_cache[current_page_index]
+    end
+
+    def current_page_index
+      data.fetch('current_page_index', 0)
+    end
+
+    def token
+      TokenHandler.generate_token(data: data)
+    end
+
+    private
+
+    def generate_page_for_index(index)
+      return if bad_index?(index)
+
+      token = TokenHandler.generate_token(data: data.merge('current_page_index' => index))
+      add_params_to_url(routes[index], "funnel_token" => token)
+    end
+
+    def add_params_to_url(path, new_params)
+      uri = URI.parse(path)
+      params = URI.decode_www_form(uri.query || "").concat(new_params.to_a)
+      uri.query = URI.encode_www_form(params)
+
+      uri.to_s
+    end
+
+    def routes
+      data.fetch('routes', [])
+    end
+
+    def next_index
+      current_page_index + 1
+    end
+
+    def previous_index
+      index = current_page_index - 1
+      index < 0 ? 0 : index
+    end
+
+    def bad_index?(index)
+      index.nil? ||
+        index < 0 ||
+        index >= routes.length
+    end
+  end
+end
+

data/lib/funneler/funnel_factory.rb

@@ -0,0 +1,13 @@
+module Funneler
+  class FunnelFactory
+
+    class << self
+      def build(route_generator:, params: {}, expires_in_days: nil)
+        return nil unless route_generator.respond_to?(:call)
+
+        routes = route_generator.call(params)
+        Funnel.new('routes' => routes, 'expires_in_days' => expires_in_days)
+      end
+    end
+  end
+end

data/lib/funneler/token_handler.rb

@@ -0,0 +1,28 @@
+require 'jwt'
+
+module Funneler
+  class TokenHandler
+    class << self
+      def generate_token(data:, expires_in_days: nil)
+        key = Funneler.configuration.jwt_key
+        algorithm = Funneler.configuration.jwt_algorithm
+
+        expires_in_days ||= Funneler.configuration.expires_in_days
+        if expires_in_days
+          expiration = Time.now + (expires_in_days * 24 * 60 * 60)
+          data = { exp: expiration.to_i }.merge(data)
+        end
+
+        JWT.encode(data, key, algorithm)
+      end
+
+      def extract_data_from(token)
+        key = Funneler.configuration.jwt_key
+        algorithm = Funneler.configuration.jwt_algorithm
+        verify = (algorithm != nil || key != nil)
+        data, _ = JWT.decode(token, key, verify, algorithm: algorithm)
+        data
+      end
+    end
+  end
+end

data/lib/funneler/version.rb

@@ -0,0 +1,3 @@
+module Funneler
+  VERSION = "1.0.1"
+end

data/lib/funneler.rb

@@ -0,0 +1,51 @@
+require 'jwt'
+
+require "funneler/version"
+require "funneler/configuration"
+require "funneler/token_handler"
+require "funneler/funnel"
+require "funneler/funnel_factory"
+require "funneler/controller_methods"
+
+module Funneler
+  Error = Class.new(StandardError)
+  InvalidTokenError = Class.new(Error)
+  UnknownFunnelType = Class.new(Error)
+
+  class << self
+    attr_reader :configuration
+
+    def configuration
+      @configuration ||= Funneler::Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def from_token(token:)
+      data = Funneler::TokenHandler.extract_data_from(token)
+      Funneler::Funnel.new(data)
+    rescue JWT::DecodeError => e
+      raise InvalidTokenError, "Invalid token '#{token}': #{e.message}"
+    end
+
+    def build(route_generator:, params: {}, expires_in_days: nil)
+      Funneler::FunnelFactory.build(route_generator: route_generator,
+                                   params: params,
+                                   expires_in_days: expires_in_days)
+    end
+
+    def from_routes(routes: {})
+      Funnel.new('routes' => routes, 'current_page_index' => 0)
+    end
+
+    def from_url(url:)
+      uri = URI.parse(url)
+      params = Hash[URI.decode_www_form(uri.query || "")]
+      token = params['funnel_token']
+      from_token(token: token)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: funneler
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Ryan Stawarz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: pry-byebug
+  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: ''
+email:
+- ryan@stawarz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- funneler.gemspec
+- lib/funneler.rb
+- lib/funneler/configuration.rb
+- lib/funneler/controller_methods.rb
+- lib/funneler/funnel.rb
+- lib/funneler/funnel_factory.rb
+- lib/funneler/token_handler.rb
+- lib/funneler/version.rb
+homepage: https://github.com/doximity/funneler
+licenses:
+- Apache 2.0
+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: A light-weight approach for routing users through a pre-determined set of
+  routes.
+test_files: []