sanitize_order 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d8d10579a9660656a1e3463922d33b6b6d8b84a
-  data.tar.gz: 62952f1f33683a08296a62e5d89c6ca6c6a489e7
+  metadata.gz: 963a9bce66ed836d5676f658ece93488cbf240dc
+  data.tar.gz: 791c2688fff60062777536141ac90877dc44792f
 SHA512:
-  metadata.gz: b526bef3e4defbf63bf79d36f0cd07aaf2d1a6c17cac9a6ea571c8828deaf775a3c82785d1190211d91b20f2e59294a98b65186c39389fe556ba1dad1bfc1a2a
-  data.tar.gz: 740b472be1f056de8742ef1b17d50c14d1ba8136a4926a61e8b3a5f3c8f67770463d04bec5620d52e85e48a28556e4aa5e489102022379a49dc7261509edf8d0
+  metadata.gz: 608e7f73b310c3235bce54706598c615946c07edcdbb8ff59d45fe2b2373bff5f993278a9d228ca92db7571c343f4450300637af0ff6ba3c079541ebcabb78c5
+  data.tar.gz: 1c149e2bb15f6973b6cfc1c5c1b215d31dfc0b2ff4862c0b4b72a7d506459b5b91e4be7c8283aafd21b9b608ed15836d7340123838d595a1f9f0eaffe554ac3d

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,16 @@
+### Expected/Desired Behavior:
+< Description of the expected or desired behavior including an example >
+
+### Current Behavior:
+< Description of the current behavior being encountered including an example >
+
+### Impact:
+- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
+- Was a regression introduced(if bug)?
+- Urgency(low, medium, high)?
+- Teams impacted?(web, ios, android, maps, etc)
+
+### Requirements:
+- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
+
+cc: @two_ @team_members

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,19 @@
+### Issue:
+[JIRA-0000](http://link_to_ticket.com)
+
+### Proposed Changes:
+< Description of the proposed change and its value. If possible also include a usage example and relative links to provide additional context for the reviewer>
+
+### Impact:
+- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
+- Any special deployment coordination needed(env changes, data/db migrations, etc.)?
+- Urgency(low, medium, high)?
+- Teams impacted(web, ios, android, maps, etc)?
+
+### Requirements:
+- Add Tests to cover changes
+- Update Swagger documentation if applicable
+- Update repo documentation if applicable(readme, wiki)
+- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
+
+cc: @two_ @team_members

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+db
+Gemfile.lock
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.2.2
+before_install: gem install bundler -v 1.11.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: CjKZEk2TI18/mrYBlMY2GSlLdI6oNUVDjlJkjwAWUeLUBK8k34BZLejoC8VsCle1PQzeXgialUJuzKhMEHRYrMWhh+jYPBcNfrI+rWF2vYRohWt77eKG6aEL/Gb3sc8V2xY7By5lPx7vNkqDpjbz+i0Hv0AXO5uApXGOzl74dII/L6GC1kykzr8Fjlqrs7UX63uY4q88N1YqhpLIzl/OmZpSogXEAIdcVmZy/kNAw8hstcVCjRoPGZjNd5eb+ojxMhcBAK+3xlh8tHOIRxygGDf810Flik/DhZjjRIb9KLraWS4Wy2qz93vWFfqdY0cO53y6BLdM1dZdzGqjI2ATJnruF4PbLTg+evys32LaLes+bKhn+3upjM/DzyfcNMpFd0+pOgweuC2pfhSACzDmxbZiUNcDE9ZUY0/vogm2/zI6eDi8uTMI1XIEPdl3lOmfmsEG8gR3DDCUQqpQNkZYRSW7L5svgwdx8z3cfaTiOVC3pQ5sDny0nenN91BsHB0pMuRKp637tDpQYPOMyDUHkBGPlNcWAm1fBFQZlqFanmoabu1iiRRL8kVWpkgajwt0aA/lIR3utQ/NIWDkhpPnJ3w5DhIC/vryKktzbo/YLO361ZFiRImzOhM8Pg5A/KKU5deJdnWRhknYQwJ1/1OaSl8jMO9tsBzxfGxjaKeAA8c=
+  gem: sanitize_order
+  on:
+    tags: true
+    repo: westfieldlabs/sanitize_order

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. 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.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor 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, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You 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 the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You 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 such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its 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. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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,65 @@
+# SanitizeOrder
+
+Sanitize an SQL order clause that might be tainted. Includes a whitelist option to
+limit the available columns to sort by and translate the given column names to
+actual table_name.column_name pairs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sanitize_order'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanitize_order
+
+## Usage
+
+In your model, add
+
+    include SanitizeOrder
+
+and in your controller safely set the order scope with
+
+    #sanitize_order(tainted_order)
+or
+
+    #sanitize_order(tainted_order, whitelist)
+
+where `tainted_order` is in the form of:
+
+    column_name direction, column_name direction, ...
+
+`direction` is optional and can be `ASC` or `DESC` and defaults to `ASC` if not
+given. Case is ignored.
+
+For example:
+
+    country asc, start_date
+
+A column name whitelist is used if given, otherwise columns are validated
+directly against the table column names. `column_name` may be in the form:
+
+    table_column_name
+
+  or
+
+    table_name.table_column_name
+
+The whitelist is a hash of allowed input table columns and the matching actual
+table and column names. For example:
+
+    {
+      'centre_id' => 'centre.id'
+      'enabled_at' => 'centre.enabled_date'
+      'disabled_at' => 'centre.disabled_date'
+      'features' => 'centre_features.name'
+    }
+
+The whitelist is assumed clean and correct so no checking is done on its
+contents.

data/Rakefile

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

data/app/models/concerns/sanitize_order.rb

@@ -0,0 +1,69 @@
+module SanitizeOrder
+  extend ActiveSupport::Concern
+
+  included do
+
+    scope :sanitize_order, -> (tainted_sql = nil, whitelist = nil) do
+      sql = sanitize_order_clause(tainted_sql, whitelist)
+      reorder(sql) unless sql.empty?
+    end
+
+    def self.sanitize_order_clause(tainted_sql = nil, whitelist = nil)
+      tainted_sql.to_s.strip.split(',').map do |e|
+        if whitelist
+          whitelist_order_element(e, whitelist)
+        else
+          sanitize_order_element(e)
+        end
+      end.reject(&:empty?).join(',')
+    end
+
+    def self.sanitize_order_element(element)
+      element.strip!
+      column_and_table_name, direction = element.split(' ')[0, 2]
+
+      # allow the table name to be passed in the format
+      # <table_name>.<column_name> in order to remove ambiguous query
+      # strings
+      if column_and_table_name.include?(".")
+        the_table_name, column = column_and_table_name.split('.')[0, 2]
+        the_table_name = sanitize_table_name(the_table_name)
+
+        # Do not allow invalid table names
+        return unless the_table_name.present?
+      else
+        column = column_and_table_name
+        the_table_name = table_name
+      end
+
+      column = sanitize_order_column(column)
+      direction = sanitize_order_direction(direction)
+
+      column ? "#{the_table_name}.#{column} #{direction}" : ''
+    end
+
+    def self.whitelist_order_element(element, whitelist)
+      element.strip!
+      column, direction = element.split(' ')[0, 2]
+
+      if column_and_table_name = whitelist[column]
+        direction = sanitize_order_direction(direction)
+        "#{column_and_table_name} #{direction}"
+      else
+        ""
+      end
+    end
+
+    def self.sanitize_order_column(column_name)
+      column_names.include?(column_name) ? column_name : nil
+    end
+
+    def self.sanitize_table_name(the_table_name)
+      (table_name == the_table_name) ? "#{the_table_name}" : nil
+    end
+
+    def self.sanitize_order_direction(dir = nil)
+      (dir.to_s.upcase == 'DESC' ? 'DESC' : 'ASC')
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_support"
+require "sanitize_order"
+
+# 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/contributing.md

@@ -0,0 +1,13 @@
+## Contributing
+
+0. Raise an issue in this project outlining the change you'd like to make. You'll need the `issue_number`
+1. Fork this project into your own Github account
+2. Create your feature branch (`git checkout -b {issue_number}_my-new-feature`)
+4. Push to the branch (`git push -u origin {issue_number}_my-new-feature`)
+5. Write RSpec tests to formalise the outcomes of your change
+6. Write the code to implement the changes, ensuring that the tests eventually pass
+7. Commit your changes (`git commit -am '{issue_number} Added some feature'`)
+8. Push to the branch (`git push -u origin my-new-feature`)
+9. Create a new Pull Request using Github's built-in mechanisms.
+10. Wait for a code review to come back, or an approval.
+11. Either go back and fix whatever the reviewers recommend, or watch and smile as your PR gets merged in and you become part of software development history.

data/lib/sanitize_order/version.rb

@@ -0,0 +1,3 @@
+module SanitizeOrder
+  VERSION = "1.1.2"
+end

data/lib/sanitize_order.rb

@@ -0,0 +1,5 @@
+require_relative '../app/models/concerns/sanitize_order'
+require "sanitize_order/version"
+
+module SanitizeOrder
+end

data/sanitize_order.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+require_relative 'lib/sanitize_order/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sanitize_order'
+  spec.version       = SanitizeOrder::VERSION
+  spec.authors       = ['Michael Mell', 'George Shaw']
+  spec.email         = ['mike.mell@nthwave.net', 'gshaw@westfield.com']
+
+  spec.summary       = %q{Sanitize an sql order clause from tainted params}
+  spec.description   = %q{Sanitize an sql order clause from tainted params}
+  spec.homepage      = 'https://github.com/westfieldlabs/sanitize_order'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib', 'app']
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_dependency 'activerecord', '~> 4.2.0'
+  spec.add_dependency 'activesupport', '~> 4.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sanitize_order
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Michael Mell
@@ -113,11 +113,29 @@ description: Sanitize an sql order clause from tainted params
 email:
 - mike.mell@nthwave.net
 - gshaw@westfield.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://github.com/westfield/sanitize_order
+files:
+- ".github/ISSUE_TEMPLATE"
+- ".github/PULL_REQUEST_TEMPLATE"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/models/concerns/sanitize_order.rb
+- bin/console
+- bin/setup
+- contributing.md
+- lib/sanitize_order.rb
+- lib/sanitize_order/version.rb
+- sanitize_order.gemspec
+homepage: https://github.com/westfieldlabs/sanitize_order
 licenses:
 - Apache-2.0
 metadata: {}