funcify 0.4.25

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0420107038bad57cdfd421e108fe0ac3f1f0c9ecddceb3c676dc717ac11e44f3'
+  data.tar.gz: cd7ab73950ec24788764d1df712404a6a3427e835118ca8c4b3e8a2f6760f046
+SHA512:
+  metadata.gz: bde0dcf1bb42b99556dc906bb52a39a0de80eec7022c603a5cf0a5e145244992f01b5e6dcbb3cb4a49ff3111ac95b467faed0d8d840ec01877df815043212d29
+  data.tar.gz: 3e909ed15b8ee35ad3eb55e7486c6f3643cb890bb90aa62f9255a853e0504c9c9b9f2da0f096b1eea0c7f2b3a6e7c98b8c63b7312cfdacd89f57768dc43cfc62

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.ds_store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at wild.fauve@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in funcify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    funcify (0.4.24)
+      dry-monads (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-monads (1.3.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (13.0.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  funcify!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Col Perks
+
+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,83 @@
+# Funcify
+
+Fn is a collection of Higher Level functions implemented with simple lambdas and currying.  And why not.  Its not meant to be complete, not very sophisticated.  Rather is a "play with functions" project.  Its split into 2 parts:
+
++ Common higher-level functions, such as `compose` or `flat_map`
++ More specialised authorisation testing functions, designed for adding authorisation tests to your code.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'funcify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install funcify
+
+## Usage
+
+### General Higher Level Functions
+
+### Authorisation Functions
+
+The `#authorise` function takes the following arguments:
++ enforcer.  A function that will be given the result (wrapped in a Monad) of the authorisation policies and can decide what to do with it.  There are 2 defined;
+  - `nil_enforcer`, which is an identity function and return the input value
+  - `auth_error_raise_enforcer`, which takes 2 curried arguments; an exception to raise and the value
++ policies.  Each policy is a function that takes the context and returns either a Success Monad or a Failure Monad wrapping the context.  Thats it.
++ data context.  The data context is the input into the authorisation policies.  Its provided as the last argument so that the remainder (basically the configuration) can be partially applied, and then the partially applied function can be passed around and given state when you want.
+
+The simplist policy (and perhaps the most useless) would look like this:
+
+```ruby
+-> ctx { M.Success(ctx) }
+```
+
+Takes in the context and returns it wrapped in a success.  Nice!
+
+Lets have a look at the supplied Slack Token policy.  The policy looks like this;
+
+```ruby
+-> expected_token, ctx { Fn.either.(Fn.tests.(Fn.all?, slack_token_tests(expected_token)), Fn.success, Fn.failure ).(ctx) }.curry
+```
+What this is doing is, taking the expected Slack token, a context that (somewhere) will contain a provided Slack token, running all the tests defined by `slack_token_tests`, and if that all pass, return the context wrapped in a Success Monad.  The significant test is
+
+```ruby
+-> t, ctx { ctx[:token] == t }.curry
+```
+
+where `t` is the expected token, and the context (`ctx`) is a hash containing a key `token` which must equal the expected token.
+
+So, to set this up, to be partially applied, we can start by defining the policy execution functions.
+
+```ruby
+policy_fn = Afn.authorise.(Afn.auth_error_raise_enforcer.(StandardError)).([Fn::Afn.slack_token_policy.("slack_token")])
+
+# then at sometime later, perhaps when we have the token, we can then check it by applying the last argument, the ctx
+result = policy_fn.({token: "slack_token"})  # => Success({token: "slack_token"})
+```
+
+## 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]/fn. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fn/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "funcify"
+
+# 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 "pry"
+Pry.start(__FILE__)

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

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "funcify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "funcify"
+  spec.version       = Funcify::VERSION
+  spec.authors       = ["Col Perks"]
+  spec.email         = ["wild.fauve@gmail.com"]
+
+  spec.summary       = %q{Useful Higher Order Ruby Functions.}
+  spec.homepage      = "https://github.com/wildfauve/funcify"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    #
+    # spec.metadata["homepage_uri"] = spec.homepage
+    # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'dry-monads', '~>1.0'
+
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/funcify.rb

@@ -0,0 +1,15 @@
+require "funcify/version"
+require 'dry/monads/result'
+require 'dry/monads/try'
+
+
+module Funcify
+  autoload :Fn,     'funcify/fn'
+  autoload :Afn,    'funcify/afn'
+  autoload :Map,    'funcify/map'
+  autoload :Record, 'funcify/record'
+  autoload :Monad,  'funcify/monad'
+  autoload :Cond,   'funcify/cond'
+  autoload :Str,    'funcify/str'
+  autoload :FSet,   'funcify/fset'
+end

data/lib/funcify/afn.rb

@@ -0,0 +1,274 @@
+module Funcify
+
+  class Afn
+
+    extend Dry::Monads::Result::Mixin
+
+    PRIVILEGE = :privilege
+    RESOURCE  = :resource
+
+    class << self
+
+      #
+      # Authorise Fns
+      #
+      # @param enforcer  A fn that responds to #call and is invoked when the authorisations fail
+      # @param policy_predicates  An array of Policy Predicates.  The policy takes optional state and ctx and returns a Maybe. Available checkers are:
+      #                  + Afn.activity_policy
+      #                  + Afn.privilege_policy
+      #                  + Afn.slack_token_policy
+      # @param ctx       A data structure of the user's authz context understood by the policy checker; e.g. the activity being performed
+      # Example
+      # > Afn.authorise.(Afn.auth_error_raise_enforcer.(PolicyEnforcement::AuthorisationFailed))
+      #                .([Afn.activity_policy.(system_policy)])
+      #                .(activity_ctx(:create))
+      # => Success(nil) | raises a PolicyEnforcement::AuthorisationFailed
+      # Use partial evaluation by establishing the enforcer and policies (which returns a partially applied authorise fn)
+      # passing this to the services to be protected, which that evaluate the fn by providing the ctx.
+      def authorise
+        -> enforcer, policies, ctx {
+          Fn.compose.(  finally_fn.(enforcer),
+                        Fn.fmap_compose.(policies)
+            ).(Success(ctx))
+        }.curry
+      end
+
+      # alias of #authorise, which works with fmapping; hence all policy checks MUST be Success
+      def all_authorisor
+        -> enforcer, policies, ctx {
+          Fn.compose.(  finally_fn.(enforcer),
+                        Fn.fmap_compose.(policies)
+            ).(Success(ctx))
+        }.curry
+      end
+
+      # Similar to all_authorisor, except at least one of the policies MUST be success
+      def or_authorisor
+        -> enforcer, policies, ctx {
+          Fn.compose.(  any_finally_fn.(enforcer),
+                        Fn.map.(-> policy { policy.(ctx) } )
+            ).(policies)
+        }.curry
+      end
+
+      def finally_fn
+        -> enforcer, v { Fn.either.(Fn.maybe_value_ok?).(Fn.identity).(-> x { enforcer.(x) } ).(v) }.curry
+      end
+
+      # any results Success(), then Success, otherwise call enforcer
+      def any_finally_fn
+        -> enforcer, results {
+          Fn.either.(Fn.any?.(Fn.maybe_value_ok?), Fn.success).(-> x { enforcer.(x) }).(results)
+       }.curry
+      end
+
+      #
+      # Enforcement Fns
+      def nil_enforcer
+        Fn.identity
+      end
+
+      def error_raiser
+        -> exception, ctx { raise exception unless ctx.success? }.curry
+      end
+
+      #
+      # Policy Predicate Fns
+      # ====================
+      #
+      # A Policy Predicate takes a context (any data structure it might or might not undestand), performs predicate
+      # tests using the context and the state, and returns an Either (Success or Failure)
+      # The ctx is specific to the test
+      #
+
+      #
+      # Valid JWT test
+      # --------------
+      #
+      # Takes any data structure and a function which validates it.
+      def validity_policy
+        -> policy_predicates, ctx {
+          Fn.either.(Fn.tests.(Fn.all?, policy_predicates), Fn.success, Fn.failure ).(ctx)
+        }.curry
+      end
+
+      # Slack Policy
+      # ------------
+      # Slack Policy looks for :token in the ctx, and ensures that token is configured in Account.
+      # @param ctx {} expects a :token key/value provided by Slack.
+      def slack_token_policy
+        -> expected_token, ctx { Fn.either.(Fn.tests.(Fn.all?, slack_token_tests(expected_token)), Fn.success, Fn.failure ).(ctx) }.curry
+      end
+
+      def slack_token_tests(token)
+        [
+          key_present_test.(:token),
+          valid_slack_token.(token)
+        ]
+      end
+
+      # The Activity-based access control policy
+      # ----------------------------------------
+      # @param activities [String] A collection of activity strings assigned to the user obtained from Identity.  For example:
+      #                            => ["lic:account:resource:billing_entity:*","lic:account:resource:payment_method:*"]
+      # @param filter_fn  A fn used to filter the activities.  Afn provides a #for_system fn which removes
+      #                   any activities not associated with the system under test.  Fn.identity could be used to retain
+      #                   all activities, or you can use any other fn that takes the activities as the last param
+      # @param ctx {}  service/resource/action being tested; e.g. {:resource=>:invoice, :action=>:create}
+      # Policy runs 4 tests:
+      # + the ctx includes a :resource key
+      # + the ctx includes an :action key
+      # + the ctx includes an :activities
+      # + and finally, the significant test, the service/resource/action match an activity
+      def activity_policy
+        -> activities, filter_fn, ctx {
+          Fn.either.( Fn.tests.(Fn.all?, activity_tests), Fn.success, Fn.failure ).(ctx.merge(activities: filter_fn.(activities)))
+        }.curry
+      end
+
+      def activity_tests
+        [
+          key_present_test.(:resource),
+          key_present_test.(:action),
+          key_present_test.(:activities),
+          has_activity.(resource_activity_policy_tests)
+        ]
+      end
+
+      # The Privelged access control policy
+      # ----------------------------------------
+      # @param activities [String] A collection of activity strings assigned to the user obtained from Identity.  For example:
+      #                            => ["lic:account:privilege:billing_entity:*","lic:account:privilege:payment_method:*"]
+      # @param filter_fn  A fn used to filter the activities.  Afn provides a #for_system fn which removes
+      #                   any activities not associated with the system under test.  Fn.identity could be used to retain
+      #                   all activities, or you can use any other fn that takes the activities as the last param
+      # @param ctx {}  service/resource/action being tested for privileged access; e.g. {:resource=>:invoice, :action=>:create}
+      # Policy runs 4 tests:
+      # + the ctx includes a :privilege key
+      # + the ctx includes an :action key
+      # + the ctx includes an :activities
+      # + and finally, the significant test, the service/resource/action match an activity
+      def privilege_policy
+        -> activities, filter_fn, ctx {
+          Fn.either.(Fn.tests.(Fn.all?, privilege_tests), Fn.success, Fn.failure ).(ctx.merge(activities: filter_fn.(activities)))
+        }.curry
+      end
+
+      def privilege_tests
+        [
+          key_present_test.(:privilege),
+          key_present_test.(:action),
+          key_present_test.(:activities),
+          has_privileged_access.(privilege_activity_policy_tests)
+        ]
+      end
+
+
+      #
+      # Helper Fns
+      #
+
+      def for_system
+        -> system, activities {
+          Fn.remove.(-> a { !a.include?(system.to_s)}).(activities)
+        }.curry
+      end
+
+      def key_present_test
+        -> k, ctx { ctx.has_key? k }.curry
+      end
+
+      def valid_slack_token
+        -> t, ctx { ctx[:token] == t }.curry
+      end
+
+      # s: system
+      # r: r
+      # a: action
+      # activitys: user's activity enum
+      def has_activity
+        -> tests, ctx  {
+          activity_match.(tests, ctx[:resource], ctx[:action]).(ctx[:activities])
+        }.curry
+      end
+
+      def has_privileged_access
+        -> tests, ctx  {
+          activity_match.(tests, ctx[:privilege], ctx[:action]).(ctx[:activities])
+        }.curry
+      end
+
+
+      def activity_match
+        -> tests, r, a, activities {
+          Fn.find.(policy_match.(tests, r, a)).(activities)
+        }.curry
+      end
+
+      def policy_match
+        -> tests, r, a, activity {
+          Fn.compose.(  activity_token_matcher.(tests, r,a),
+                        Fn.coherse.(:to_sym),
+                        Fn.split.(":")
+            ).(activity)
+        }.curry
+      end
+
+      def activity_token_matcher
+        -> tests, r, a, tokens {
+          Fn.tests.(Fn.all?, tests.(r, a)).(tokens)
+        }.curry
+      end
+
+      def privilege_activity_policy_tests
+        -> r, a {
+          [
+            has_priviled.(r),
+            resource_test.(r),
+            action_test.(a)
+          ]
+        }
+      end
+
+      def resource_activity_policy_tests
+        -> r, a {
+          [
+            has_resource.(r),
+            resource_test.(r),
+            action_test.(a)
+          ]
+        }
+      end
+
+      def system_test
+        -> req, token { token_match.(req).(Fn.at.(1).(token)) }.curry
+      end
+
+      def has_resource
+        -> req, token { Fn.at.(2,token) == RESOURCE }.curry
+      end
+
+      def has_priviled
+        -> req, token { Fn.at.(2,token) == PRIVILEGE }.curry
+      end
+
+      def resource_test
+        -> req, token { token_match.(req).(Fn.at.(3).(token)) }.curry
+      end
+
+      def action_test
+        -> req, token { token_match.(req).(Fn.at.(4).(token)) }.curry
+      end
+
+      def token_match
+        -> req, token {
+          # req.nil? || req.size == 0 || token == :* || token == req
+          token == :* || token == req
+        }.curry
+      end
+
+    end
+
+  end
+
+end