soar_sc_routing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d26f7e7fdd02b09bad20b2d58479c51c0ca4289
+  data.tar.gz: 242a83d9dbc18128a59a85cb708fa4c99b8cced6
+SHA512:
+  metadata.gz: d0c9f3bbf5783e53cf09d75b239a2634891c94de0f4131369720df89b135b892aa33e2365040c1143dd003c2a274806c225b2566fe8c0ab2b0d3eca4a8e15136
+  data.tar.gz: cddba5d15e661327dcc2bf9f80522f92a09f5c28db3200dfc9d6aa5c348a333d9c021aea2cc68c7c02631fd558d9ca996aa1bf8e7ce0048575edb49bb1ce8374

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ernst Van Graan
+
+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,41 @@
+# SoarScRouting
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/soar_sc_routing`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_sc_routing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_sc_routing
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/soar_sc_routing.
+
+
+## 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,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 "soar_sc_routing"
+
+# 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,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/lib/soar_sc_routing/base_router.rb

@@ -0,0 +1,64 @@
+require 'soar_aspects'
+
+module SoarScRouting
+  class BaseRouter
+    attr_reader :route_meta
+
+    def initialize(route_meta)
+      @route_meta = route_meta
+    end
+
+    def route(request)
+      route_path(request)
+
+    rescue => ex
+      excepted(ex)
+    end
+
+    def redirect_to(url, http_code = 302)
+      [http_code, {'Location' => url, 'Content-Type' => 'text/html', 'Content-Length' => '0'}, []]
+    end
+
+    protected
+
+    def not_found
+      raise NotImplementedError.new "Implement not found renderer"
+    end
+
+    def excepted(ex)
+      raise NotImplementedError.new "Implement exception renderer: #{ex}"
+    end
+
+    private
+
+    def debug(message, flow_identifier)
+      auditing = SoarAspects::Aspects::auditing
+      if auditing
+        auditing.debug(message, flow_identifier)
+      else
+        $stderr.puts(message)
+      end
+    end
+
+    def route_matched_path(request, path)
+      debug("matched #{path}",request.params['flow_identifier'])
+      http_code, content_type, body = @route_meta.routing[path].call(request)
+      debug("controller returned #{http_code}, #{content_type}", request.params['flow_identifier'])
+      return [http_code, content_type, body]
+    end
+
+    def route_path(request)
+      # Only allow POST requests
+      #if not request.post?
+      #  return SoarSc::Web::Views::Default.render(405, "")
+      #end
+      @route_meta.routing.each do |path, block|
+        if matches = Regexp.new(path).match(request.path)
+          request.define_singleton_method(:regex_matches) { return matches.to_a }
+          return route_matched_path(request, path)
+        end
+      end
+      not_found
+    end    
+  end
+end

data/lib/soar_sc_routing/resource.rb

@@ -0,0 +1,28 @@
+module SoarScRouting
+  class Resource
+    attr_accessor :description
+    attr_accessor :method
+    attr_accessor :id
+    attr_accessor :params
+    attr_accessor :input
+    attr_accessor :output
+ 
+    def initialize(description, id, method = 'GET', params = nil, input = nil, output = nil)
+      @description = description
+      @id = id
+      @method = method
+      @params = params
+      @input = input
+      @output = output
+    end
+
+    def content
+      {
+        'doc' => @description,
+        'method' => @method,
+        'id' => @id,
+        'params' => @params
+      }
+    end
+  end
+end

data/lib/soar_sc_routing/router_meta.rb

@@ -0,0 +1,155 @@
+require 'json'
+require 'smaak'
+require 'jsender'
+require 'soar_authorization'
+require 'soar_aspects'
+
+module SoarScRouting
+  class RouterMeta
+    include Jsender
+    SIGNED = true unless defined? SIGNED; SIGNED.freeze
+    UNSIGNED = false unless defined? UNSIGNED; UNSIGNED.freeze
+    AUTHORIZED = true unless defined? AUTHORIZED; AUTHORIZED.freeze
+    UNAUTHORIZED = false unless defined? UNAUTHORIZED; UNAUTHORIZED.freeze
+
+    attr_accessor :configuration
+    attr_accessor :lexicon
+    attr_accessor :routing
+    attr_accessor :signed_routes
+    attr_accessor :service_names
+    attr_accessor :policy_am
+    attr_accessor :autenticate
+
+    def initialize(configuration)
+      @configuration = configuration
+      @lexicon = {}
+      @routing = {}
+      @signed_routes = {}
+      @service_names = {}
+      setup_routing_table
+    end
+
+    def access_manager
+      @policy_am
+    end
+
+    def register_route(detail, startup_flow_id = nil)
+      validate_detail(detail)
+      info("Registering service: #{detail}", startup_flow_id)
+      resource = SoarScRouting::Resource.new(detail['description'], "#{detail['service_name']}", detail['method'].upcase, detail['params'])
+      add_resource_route(detail['path'], resource, interpret_secured(detail), interpret_authorized(detail)) do |request|
+        if detail['controller']
+          return delegate_to_controller_and_renderer(detail, startup_flow_id)
+        elsif detail['action']
+          http_code, headers, body = detail['action'].call(request)
+          [http_code, headers, [body]]
+        end
+      end
+    end
+
+    def add_route(path, description, &block)
+      resource = SoarScRouting::Resource.new(description, generate_id(path))
+      add_resource_route(path, resource, UNSIGNED, AUTHORIZED, &block)
+    end
+
+    def add_unsigned_unauthorized_route(path, description, &block)
+      resource = SoarScRouting::Resource.new(description, generate_id(path))
+      add_resource_route(path, resource, UNSIGNED, UNAUTHORIZED, &block)
+    end
+
+    def add_signed_route(path, description, &block)
+      resource = SoarScRouting::Resource.new(description, generate_id(path))
+      add_resource_route(path, resource, SIGNED, AUTHORIZED, &block)
+    end
+
+    def add_signed_unauthorized_route(path, description, &block)
+      resource = SoarScRouting::Resource.new(description, generate_id(path))
+      add_resource_route(path, resource, SIGNED, UNAUTHORIZED, &block)
+    end
+
+    protected
+
+    # Inversion of control
+    def setup_routing_table
+    end
+
+    # IOC renderer for views
+    def render_view(detail, http_code, body)
+      raise NotImplementedError.new "No renderer"
+    end
+
+    private
+
+    def validate_detail(detail)
+      raise ArgumentError.new("detail must not be nil") if detail.nil?
+      raise ArgumentError.new("path must be provided") if detail['path'].nil?
+      raise ArgumentError.new("description must be provided") if detail['description'].nil?
+      raise ArgumentError.new("params must be provided") if detail['params'].nil?
+      raise ArgumentError.new("method must be provided") if detail['method'].nil?
+      raise ArgumentError.new("service_name must be provided") if detail['service_name'].nil?
+      raise ArgumentError.new("nfrs must be provided") if detail['nfrs'].nil?
+      raise ArgumentError.new("nfrs['secured'] must be provided") if detail['nfrs']['secured'].nil?
+      raise ArgumentError.new("nfrs['authorization'] must be provided") if detail['nfrs']['authorization'].nil?
+    end
+
+    def delegate_to_controller_and_renderer(detail, startup_flow_id)
+      controller = nil
+      begin
+        controller = Object::const_get("SoarSc::Web::Controllers::#{detail['controller']}").new(@configuration)
+      rescue NameError => ex
+        warn("Could not instantiate SoarSc::Web::Controllers::#{detail['controller']}. Trying class name as-is", startup_flow_id)
+        controller = Object::const_get(detail['controller']).new(@configuration)
+      end
+      http_code, body = controller.serve(request)
+      render_view(detail, http_code, body)      
+    end
+
+    def info(message, startup_flow_id)
+      auditing = SoarAspects::Aspects::auditing
+      if auditing
+        auditing.info(message, startup_flow_id)
+      else
+        $stderr.puts(message)
+      end
+    end
+
+    def warn(message, startup_flow_id)
+      auditing = SoarAspects::Aspects::auditing
+      if auditing
+        auditing.warn(message, startup_flow_id)
+      else
+        $stderr.puts(message)
+      end
+    end
+
+    def generate_id(path)
+      path.gsub("/","_")
+    end
+
+    def add_resource_route(path, resource, signed, authorization_required, &block)
+      @routing[path] = block
+      @service_names[path] = resource.id
+      @lexicon[path] = resource.content
+      @signed_routes[path] = signed
+      SoarAuthorization::Authorize::register_access_manager(path, resource.id, access_manager) if authorization_required
+    end
+
+    def interpret_secured(detail)
+      secured = 'SIGNED' # default to strong
+      if (not detail['nfrs']['secured'].nil?) and detail['nfrs']['secured'].is_a?(String)
+        secured = 'SIGNED' if detail['nfrs']['secured'].upcase.strip == 'SIGNED'
+        secured = nil if detail['nfrs']['secured'].upcase.strip == 'UNSIGNED'
+      end
+      secured == 'SIGNED'
+    end
+
+    def interpret_authorized(detail)
+      authorized = 'AUTHORIZED' # default to strong
+      if (not detail['nfrs'].nil?) and (not detail['nfrs']['authorization'].nil?) and (detail['nfrs']['authorization'].is_a?(String))
+        authorized = detail['nfrs']['authorization']
+        authorized = 'AUTHORIZED' if not ['AUTHORIZED', 'UNAUTHORIZED'].include?(detail['nfrs']['authorization'])
+      end
+      authorized == 'AUTHORIZED'
+    end    
+  end
+end

data/lib/soar_sc_routing/version.rb

@@ -0,0 +1,3 @@
+module SoarScRouting
+  VERSION = "0.1.0"
+end

data/lib/soar_sc_routing.rb

@@ -0,0 +1,7 @@
+require "soar_sc_routing/version"
+require "soar_sc_routing/resource"
+require "soar_sc_routing/router_meta"
+require "soar_sc_routing/base_router"
+
+module SoarScRouting
+end

data/soar_sc_routing.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_sc_routing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_sc_routing"
+  spec.version       = SoarScRouting::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{base router and router meta library for soar_sc}
+  spec.description   = %q{base router and router meta library for soar_sc}
+  spec.homepage      = "https://github.com/hetznerZA/soar_sc_routing"
+  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'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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_dependency 'jsender', "~> 0.2.0"
+  spec.add_dependency 'smaak', "~> 0.2.2"
+  spec.add_dependency "soar_authorization", "~> 0.1.4"
+  spec.add_dependency "soar_aspects", "~> 0.1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "soar_xt", "~> 0.0.3"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: soar_sc_routing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsender
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: smaak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: soar_authorization
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: soar_aspects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: soar_xt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: 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: base router and router meta library for soar_sc
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_sc_routing.rb
+- lib/soar_sc_routing/base_router.rb
+- lib/soar_sc_routing/resource.rb
+- lib/soar_sc_routing/router_meta.rb
+- lib/soar_sc_routing/version.rb
+- soar_sc_routing.gemspec
+homepage: https://github.com/hetznerZA/soar_sc_routing
+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.5.1
+signing_key: 
+specification_version: 4
+summary: base router and router meta library for soar_sc
+test_files: []