kill_switch 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 095f878161e04b7eba76f8e897ed241ac70e7e7c
+  data.tar.gz: 259d3da3659e3ac4a2d7927b1d564d9a48247dae
+SHA512:
+  metadata.gz: 4da461d8b7bd8caf84e5835942095a5701c781432b219ae9db27635c3675bdbbfee9b04f8d9097c47c2d12863e7a023f8d0934557b1f383f76ee5a1947ac5790
+  data.tar.gz: a1b90a8233d7c618942c488590fc2114c29fddaac5755af7cfc9960d3b3222c707df83f0061ea3c94ccb9903d83e422ae7ef4e398ff938a36b3cec1345d85e93

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+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,95 @@
+# KillSwitch
+
+Utility for managing blacklisted User Agent Strings.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kill_switch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kill_switch
+
+
+## Usage
+
+1. In config/initializers create a file and define some rules
+
+```ruby
+ClientBlacklist.configure do |config|
+  config.blacklist "1.03.00", "iOS", "iPhone OS 6.1", "iPhone4,1"
+end
+
+Format and optional params
+  config.blacklist app_version, device_platform, <optional> device_os_version, <optional> device_model
+Examples:
+  config.blacklist "1.03.00", "iOS", "iPhone OS 6.1", "iPhone4,1"
+  config.blacklist "1.03.00", "iOS", "iPhone OS 6.1"
+  config.blacklist "1.03.00", "iOS", "iPhone4,1"
+  config.blacklist "1.03.00", "iOS"
+```
+
+`device_os_version` and `device_model` are optional. If either are present, they will be matched
+
+This class matches on depth first, meaning if `device_os_version` or `device_model` are present
+in the rule definition, it will only match if the user agent also fully matches the criteria.
+
+When defining rules, note presedence.
+Given the user agent string 'BleachrClient/1.03.00 (iOS; iPhone OS 6.1; iPhone5,1)'
+and the following rules
+  config.blacklist "1.03.00", "iOS", "iPhone OS 6.1", "iPhone4,1"
+  config.blacklist "1.03.00", "iOS"
+
+The user agent **will not** be blacklisted because it does not match the first definition.
+The first full definition overrides the more generic definition.
+
+
+2. In the ApiController, add a hook to check for blacklisted user agents.
+
+`before_action ClientBlacklist::BlacklistFilter`
+
+
+3. Set-up for RSPEC tests
+
+Add a helper method and config setting to `rails_helper.rb`.
+
+```ruby
+RSpec.configure do |config|
+  
+  ...
+
+  config.before(:each, type: :controller) do
+    set_user_agent
+  end
+end
+
+def set_user_agent(user_agent = 'Client/0.00.01 (iOS; iPhone OS 6.1; iPhone4,1)')
+  request.env["HTTP_USER_AGENT"] = user_agent
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/livefront/kill_switch_gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))
+
+# require "pry"
+# Pry.start

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kill_switch"
+
+# 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/setup

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

data/kill_switch.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kill_switch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kill_switch"
+  spec.version       = KillSwitch::VERSION
+  spec.authors       = ["Rosie Hoyem"]
+  spec.email         = ["rosiehoyem@gmail.com"]
+
+  spec.summary       = %q{Utility for managing blacklisted User Agent Strings.}
+  spec.description   = %q{Utility for managing blacklisted User Agent Strings.}
+  spec.homepage      = "https://github.com/livefront/kill_switch_gem"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+end

data/lib/kill_switch.rb

@@ -0,0 +1,11 @@
+# External Dependencies
+require 'rubygems'
+require 'bundler/setup'
+
+# App Requires
+require "kill_switch/client_blacklist"
+require "kill_switch/user_agent"
+require "kill_switch/version"
+
+module KillSwitch
+end

data/lib/kill_switch/client_blacklist.rb

@@ -0,0 +1,109 @@
+require 'kill_switch/version'
+require 'singleton'
+
+class ClientBlacklist
+  include Singleton
+
+  def self.configure(&block)
+    raise ArgumentError, "Block not provided" unless block_given?
+    yield instance
+  end
+
+  def self.rules
+    instance.rules
+  end
+
+  def self.clear_rules
+    instance.instance_variable_set(:@rules, {})
+  end
+
+  def rules
+    @rules ||= {}
+  end
+
+  def self.user_agent_valid?(user_agent_string)
+    UserAgent.new(user_agent_string).valid?
+  end
+
+  def self.agent_blacklisted?(user_agent_string)
+    agent = UserAgent.new(user_agent_string)
+    raise RuntimeError, "User Agent Invalid" unless agent.valid?
+
+    base_rules = rules.fetch("blacklist", {}).fetch(agent.app_version, {}).fetch(agent.device_platform, nil)
+    # no rules found for version and device
+    return false if base_rules.nil?
+
+    if device_os_version_rules = base_rules[agent.device_os_version]
+      if device_os_version_rules.empty?
+        # No further criteria to match on. Found final match on device_os_version
+        return true
+      end
+      if device_os_version_rules[agent.device_model]
+        # Found a match on the nested device model
+        return true
+      end
+    end
+
+    if base_rules[agent.device_model]
+      # 3 rules, excluding devise_os_version
+      return true
+    end
+
+    if base_rules.any? # this means we have nested rules, not just the version and platform
+      return false # we have nested rules, nothing matched - good to go
+    end
+
+    return true # If we made it this far, we matched on the base_rules only
+  end
+
+  def blacklist(app_version, device_platform, device_os_version = nil, device_model = nil)
+    rules["blacklist"] ||= {}
+    rules["blacklist"][app_version] ||= {}
+    rules["blacklist"][app_version][device_platform] ||= {}
+
+    if device_os_version
+      rules["blacklist"][app_version][device_platform][device_os_version] ||= {}
+    end
+    if device_model
+      if device_os_version
+        # all 4 rules included - nest under device_os_version
+        rules["blacklist"][app_version][device_platform][device_os_version][device_model] ||= {}
+      else
+        # device_os_version excluded - rule is to exclude a particular device_platform
+        rules["blacklist"][app_version][device_platform][device_model] ||= {}
+      end
+    end
+  end
+
+  # Rails Before Filter Class Implementation
+  class BlacklistFilter
+    def self.before(controller)
+      user_agent = controller.request.user_agent
+      unless ClientBlacklist.user_agent_valid?(user_agent)
+        controller.render(
+          json: {
+            data: {
+              message: "User agent string is missing or invalid. Received [#{user_agent}]" },
+              metadata: nil,
+          },
+          status: 400,
+        )
+        return false
+      end
+
+      if ClientBlacklist.agent_blacklisted?(user_agent)
+        controller.render(
+          json: {
+            data: {
+                message: "This version [#{user_agent}] is no longer supported. Please visit the App Store to upgrade to the most recent version."
+            },
+            metadata: nil,
+          },
+          status: 403,
+        )
+        return false
+      end
+      return true # All checks passed
+    end
+  end
+end

data/lib/kill_switch/user_agent.rb

@@ -0,0 +1,35 @@
+class UserAgent
+  attr_reader :app_version
+  attr_reader :device_model
+  attr_reader :device_os_version
+  attr_reader :device_platform
+  attr_reader :string
+
+  def initialize(user_agent_string)
+    @string = user_agent_string
+    parse_string
+  end
+
+  def valid?
+    @parsed_successfully &&
+      !@app_version.to_s.empty? &&
+      !@device_model.to_s.empty? &&
+      !@device_os_version.to_s.empty? &&
+      !@device_platform.to_s.empty?
+  end
+
+  private
+
+  def parse_string
+    if match = @string.match(/\/([^ ]+) \(([^)]+)\)/)
+      @app_version, rest = match.captures
+      rest = rest.split(';')
+      @device_platform = rest[0].strip
+      @device_os_version = rest[1].strip
+      @device_model = rest[2].strip
+      @parsed_successfully = true
+    end
+  rescue Exception
+    @parsed_successfully = false
+  end
+end

data/lib/kill_switch/version.rb

@@ -0,0 +1,3 @@
+module KillSwitch
+  VERSION = "0.2.0"
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: kill_switch
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Rosie Hoyem
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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-nav
+  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: Utility for managing blacklisted User Agent Strings.
+email:
+- rosiehoyem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kill_switch.gemspec
+- lib/kill_switch.rb
+- lib/kill_switch/client_blacklist.rb
+- lib/kill_switch/user_agent.rb
+- lib/kill_switch/version.rb
+- tasks/rspec.rake
+homepage: https://github.com/livefront/kill_switch_gem
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Utility for managing blacklisted User Agent Strings.
+test_files: []