scim-kit 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd17a93f0e199bc2b7312d8643714ed2735724f911da7af62366e7b02f42fc5e
-  data.tar.gz: 8bc20d24ddc2593667785155056b278a06c10f73a83c5d76d0c9b661c9acf73e
+  metadata.gz: a34f8dee8da1be1e6851d91b193a1d5ea0f2b14bddab9b36ee8141ea219abeaf
+  data.tar.gz: 3fe74aa226fc42b5188e5c5dc2699aeb3c8fb8d405829fd7eade63a92ca02953
 SHA512:
-  metadata.gz: 6ecf2c8514298d164cfa844c52d3e706848e89d46b79b91e989476cedbd834097ed472e05b4f1c8bfa519acc8d46a416397bf414159d6ef97c73c7c26a0bb843
-  data.tar.gz: f7bead86283182163aa08103d32f869c03e148f3186970a74d32d47aaf9780561b04a1bbd68e3a1b6743660dbcdd6d0d383ec3bd07f10b590c70680a4453f222
+  metadata.gz: a35746b0546fe4661e46fbb07958ee33a753744bc4041c74d4435c1df4c6778fac266266a0e727f8c5e40cacc5c3f5f783f875b22b5dd83966081557b34b1d2c
+  data.tar.gz: 0d4ccca792c5fcebab61eefda0a38e2ed2d47d6a43d9eb39b219f864a3f096de575670628ef0a15744357d22a7eb84f3b82518409933413f936002f7e2519d80

data/.gitignore

@@ -9,5 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
-Gemfile.lock
 .byebug_history

data/.rubocop.yml

@@ -9,7 +9,7 @@ AllCops:
     - 'vendor/**/*'
   TargetRubyVersion: 2.5
 
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
 Metrics/BlockLength:
@@ -27,6 +27,9 @@ Naming/FileName:
   Exclude:
     - 'lib/scim-kit.rb'
 
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
 RSpec/NamedSubject:
   Enabled: false
 

data/.travis.yml

@@ -3,6 +3,6 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.3
-  - 2.6.1
+  - 2.5.5
+  - 2.6.3
 before_install: gem install bundler -v 1.17.1

data/CHANGELOG.md

@@ -1,4 +1,5 @@
-Version 0.3.2
+Version 0.4.0
+
 # Changelog
 All notable changes to this project will be documented in this file.
 
@@ -6,7 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- NA
+- nil
+
+## [0.4.0] - 2019-06-15
+- add implementation of SCIM 2.0 filter parser. [RFC-7644](https://tools.ietf.org/html/rfc7644#section-3.4.2.2)
 
 ## [0.3.2] - 2019-02-23
 ### Changed
@@ -35,7 +39,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - \_assign does not coerce values by default.
 - errors are merged together instead of overwritten during attribute validation.
 
-[Unreleased]: https://github.com/mokhan/scim-kit/compare/v0.3.2...HEAD
+[Unreleased]: https://github.com/mokhan/scim-kit/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/mokhan/scim-kit/compare/v0.3.2...v0.4.0
 [0.3.2]: https://github.com/mokhan/scim-kit/compare/v0.3.1...v0.3.2
 [0.3.1]: https://github.com/mokhan/scim-kit/compare/v0.3.0...v0.3.1
 [0.3.0]: https://github.com/mokhan/scim-kit/compare/v0.2.16...v0.3.0

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    scim-kit (0.4.0)
+      activemodel (>= 5.2.0)
+      net-hippie (~> 0.2)
+      parslet (~> 1.8)
+      tilt (~> 2.0)
+      tilt-jbuilder (~> 0.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    bundler-audit (0.6.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 0.18)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ffaker (2.11.0)
+    hashdiff (0.4.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    jbuilder (2.9.1)
+      activesupport (>= 4.2.0)
+    minitest (5.11.3)
+    net-hippie (0.2.6)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    parslet (1.8.2)
+    public_suffix (3.1.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.71.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.9)
+    tilt-jbuilder (0.7.1)
+      jbuilder
+      tilt (>= 1.3.0, < 3)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    webmock (3.6.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  bundler-audit (~> 0.6)
+  byebug
+  ffaker (~> 2.7)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.52)
+  rubocop-rspec (~> 1.22)
+  scim-kit!
+  webmock (~> 3.5)
+
+BUNDLED WITH
+   1.17.3

data/lib/scim/kit/v2.rb

@@ -11,6 +11,7 @@ require 'scim/kit/v2/meta'
 require 'scim/kit/v2/mutability'
 require 'scim/kit/v2/resource'
 require 'scim/kit/v2/error'
+require 'scim/kit/v2/filter'
 require 'scim/kit/v2/resource_type'
 require 'scim/kit/v2/returned'
 require 'scim/kit/v2/schema'

data/lib/scim/kit/v2/filter.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'parslet'
+
+module Scim
+  module Kit
+    module V2
+      # Parses SCIM filter queries
+      class Filter < Parslet::Parser
+        root :filter
+
+        # FILTER = attrExp / logExp / valuePath / assignVariable / *1"not" "(" FILTER ")"
+        rule(:filter) do
+          logical_expression | filter_atom
+        end
+
+        rule(:filter_atom) do
+          (not_op? >> lparen >> filter >> rparen) | attribute_expression | value_path
+        end
+
+        # valuePath = attrPath "[" valFilter "]" ; FILTER uses sub-attributes of a parent attrPath
+        rule(:value_path) do
+          attribute_path >> lbracket >> value_filter >> rbracket
+        end
+
+        # valFilter = attrExp / logExp / *1"not" "(" valFilter ")"
+        rule(:value_filter) do
+          attribute_expression | logical_expression | not_op? >> lparen >> value_filter >> rparen
+        end
+
+        # attrExp = (attrPath SP "pr") / (attrPath SP compareOp SP compValue)
+        rule(:attribute_expression) do
+          (attribute_path >> space >> presence.as(:operator)) | (attribute_path >> space >> comparison_operator.as(:operator) >> space >> comparison_value.as(:value))
+        end
+
+        # logExp = FILTER SP ("and" / "or") SP FILTER
+        rule(:logical_expression) do
+          filter_atom.as(:left) >> space >> (and_op | or_op).as(:operator) >> space >> filter.as(:right)
+        end
+
+        # compValue = false / null / true / number / string ; rules from JSON (RFC 7159)
+        rule(:comparison_value) do
+          falsey | null | truthy | number | string
+        end
+
+        # compareOp = "eq" / "ne" / "co" / "sw" / "ew" / "gt" / "lt" / "ge" / "le"
+        rule(:comparison_operator) do
+          equal | not_equal | contains | starts_with | ends_with |
+            greater_than | less_than | less_than_equals | greater_than_equals
+        end
+
+        # attrPath = [URI ":"] ATTRNAME *1subAttr ; SCIM attribute name ; URI is SCIM "schema" URI
+        rule(:attribute_path) do
+          ((uri >> colon).repeat(0, 1) >> attribute_name >> sub_attribute.repeat(0, 1)).as(:attribute)
+        end
+
+        # ATTRNAME  = ALPHA *(nameChar)
+        rule(:attribute_name) do
+          alpha >> name_character.repeat(0, nil)
+        end
+
+        # nameChar = "-" / "_" / DIGIT / ALPHA
+        rule(:name_character) { hyphen | underscore | digit | alpha }
+
+        # subAttr = "." ATTRNAME ; a sub-attribute of a complex attribute
+        rule(:sub_attribute) { dot >> attribute_name }
+
+        # uri = 1*ALPHA 1*(":" 1*ALPHA)
+        rule(:uri) do
+          # alpha.repeat(1, nil) >> (colon >> (alpha.repeat(1, nil) | version)).repeat(1, nil)
+          str('urn:ietf:params:scim:schemas:') >> (
+            str('core:2.0:User') |
+            str('core:2.0:Group') | (
+              str('extension') >>
+              colon >>
+              alpha.repeat(1) >>
+              colon >>
+              version >>
+              colon >>
+              alpha.repeat(1)
+            )
+          )
+        end
+
+        rule(:presence) { str('pr') }
+        rule(:and_op) { str('and') }
+        rule(:or_op) { str('or') }
+        rule(:not_op?) { (str('not') >> space).repeat(0, 1).as(:not) }
+        rule(:falsey) { str('false') }
+        rule(:truthy) { str('true') }
+        rule(:null) { str('null') }
+        rule(:number) do
+          str('-').maybe >> (
+            str('0') | (match('[1-9]') >> digit.repeat)
+          ) >> (
+            str('.') >> digit.repeat(1)
+          ).maybe >> (
+            match('[eE]') >> (str('+') | str('-')).maybe >> digit.repeat(1)
+          ).maybe
+        end
+        rule(:equal) { str('eq') }
+        rule(:not_equal) { str('ne') }
+        rule(:contains) { str('co') }
+        rule(:starts_with) { str('sw') }
+        rule(:ends_with) { str('ew') }
+        rule(:greater_than) { str('gt') }
+        rule(:less_than) { str('lt') }
+        rule(:greater_than_equals) { str('ge') }
+        rule(:less_than_equals) { str('le') }
+        rule(:string) do
+          quote >> (str('\\') >> any | str('"').absent? >> any).repeat >> quote
+        end
+        rule(:lparen) { str('(') }
+        rule(:rparen) { str(')') }
+        rule(:lbracket) { str('[') }
+        rule(:rbracket) { str(']') }
+        rule(:digit) { match('\d') }
+        rule(:quote) { str('"') }
+        rule(:single_quote) { str("'") }
+        rule(:space) { match('\s') }
+        rule(:alpha) { match['a-zA-Z'] }
+        rule(:dot) { str('.') }
+        rule(:colon) { str(':') }
+        rule(:hyphen) { str('-') }
+        rule(:underscore) { str('_') }
+        rule(:version) { digit >> dot >> digit }
+        rule(:assign) { str('=') }
+      end
+    end
+  end
+end

data/lib/scim/kit/version.rb

@@ -2,6 +2,6 @@
 
 module Scim
   module Kit
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

data/scim-kit.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['mo']
   spec.email         = ['mo@mokhan.ca']
 
-  spec.summary       = 'A SCIM library.'
-  spec.description   = 'A SCIM library.'
+  spec.summary       = 'A simple toolkit for working with SCIM 2.0'
+  spec.description   = 'A simple toolkit for working with SCIM 2.0'
   spec.homepage      = 'https://www.github.com/mokhan/scim-kit'
   spec.license       = 'MIT'
 
@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activemodel', '>= 5.2.0'
   spec.add_dependency 'net-hippie', '~> 0.2'
+  spec.add_dependency 'parslet', '~> 1.8'
   spec.add_dependency 'tilt', '~> 2.0'
   spec.add_dependency 'tilt-jbuilder', '~> 0.7'
   spec.add_development_dependency 'bundler', '~> 1.17'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scim-kit
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - mo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-23 00:00:00.000000000 Z
+date: 2019-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -192,7 +206,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
-description: A SCIM library.
+description: A simple toolkit for working with SCIM 2.0
 email:
 - mo@mokhan.ca
 executables:
@@ -207,6 +221,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -229,6 +244,7 @@ files:
 - lib/scim/kit/v2/complex_attribute_validator.rb
 - lib/scim/kit/v2/configuration.rb
 - lib/scim/kit/v2/error.rb
+- lib/scim/kit/v2/filter.rb
 - lib/scim/kit/v2/messages.rb
 - lib/scim/kit/v2/meta.rb
 - lib/scim/kit/v2/mutability.rb
@@ -273,8 +289,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: A SCIM library.
+summary: A simple toolkit for working with SCIM 2.0
 test_files: []