soar_sc_mvc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca5bb8883f081b830af06796d35b361ec50583e0
+  data.tar.gz: e04d6643b5f8f5bfa801880f0f682373ceb01729
+SHA512:
+  metadata.gz: 2b71e8343a04783d009047a7f42d78a3f07583561f9fbf17784f7bce799fe07b0c8c5e582e455d735f1af4ad13f6be0554e1c52dce7fbb4f5bf4381f9af77481
+  data.tar.gz: bd0caee06c4bc214e0ab0570411119fce5b6d9027e793a266f6d4628bb8716ebf2e9863620716a48b39a415fda06731e37204ae324157c49954e620d75d9c23a

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_mvc.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,83 @@
+# SoarScMvc
+
+This library includes a configured controller, configured model and model factory supporting the SOAR reference implementation service component MVC. ConfiguredController provides access to soar_sc dependencies as and requesty body, as well as a configured and ready-to-use SMAAK client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_sc_mvc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_sc_mvc
+
+## Usage
+
+### SoarSc::Web::Models::ModelFactory
+
+Given a configuration with a provider adhering to SoarSc::Web::Models::ConfiguredModel, configured as follows:
+
+```ruby
+{ 'providers' => 
+  { 'my_provider' => 
+    { 'adaptor' => 'MyAdaptorClass',
+      'some' => 'value' }
+  }
+}
+```
+
+an instance of the model (MyAdaptorClass), readily configured with the configuration hierarchy
+
+```ruby
+{ 'some' => 'value' }
+```
+
+can be obtained so:
+
+```ruby
+model_factory = SoarSc::Web::Models::ModelFactory.new(configuration)
+model = model_factory.create('my_provider')
+```
+
+### ConfiguredModel
+
+```ruby
+class MyModel < SoarSc::Web::Models::ConfiguredModel
+end
+
+model = MyModel.new(configuration)
+puts model.configuration
+```
+
+### ConfiguredController
+
+class MyController < SoarSc::Web::Controllers::ConfiguredController
+  def serve(request)
+    puts "Dependencies are: #{dependencies}"
+    puts "body is #{body(requests)}"
+    puts "I can use smaak client #{smaak_client}"
+    [200, "100"]
+  end
+end
+
+controller = MyController.new(configuration)
+
+## Contributing
+
+Please send feedback and comments to the author at:
+
+Ernst van Graan <ernst.van.graan@hetzner.co.za>
+
+This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za
+
+## 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_mvc"
+
+# 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_mvc/configured_controller.rb

@@ -0,0 +1,65 @@
+require 'smaak'
+require 'smaak/client'
+require 'net/http'
+require 'uri'
+
+module SoarSc
+  module Web
+    module Controllers
+      class ConfiguredController
+        attr_accessor :configuration
+        attr_accessor :policies
+        attr_accessor :dependencies
+        attr_accessor :smaak_client
+
+        def initialize(configuration, policies = nil)
+          @configuration = configuration
+          @policies = policies
+          @dependencies = SoarSc::dependencies
+          configure_smaak_client if smaak_enabled?
+        end
+
+        def body(request)
+          return nil if request.body.nil?
+          return request.body.gets if request.body.is_a? Rack::Lint::InputWrapper
+          return request.body.string if request.body.is_a? StringIO
+          request.body
+        end
+
+        def serve(request)
+          [ 501, "Not implemented" ]
+        end
+
+        def smaak_client
+          SoarSc::auditing.warn("SMAAK not enabled, and so I don't have a SMAAK client",SoarSc::startup_flow_id) if not smaak_enabled?
+          @smaak_client
+        end
+
+        protected
+
+        def smaak_enabled?
+          (@configuration['private_key'] and @configuration['associations']) or
+          (@configuration['smaak'] == 'dynamic')
+        end
+
+        def configure_smaak_client
+          @smaak_client = ::Smaak::Client.new
+          secure_service = SoarSmaak::SecureService.get_instance(@configuration)
+          if secure_service.dynamic
+            secure_service.trust_store.associations.each do |identifier, association|
+              @smaak_client.add_association(identifier, association['public_key'], association['psk'], association['encrypt'])
+            end
+            @smaak_client.set_identifier(secure_service.dynamic)
+            @smaak_client.set_private_key(secure_service.trust_store.associations[secure_service.dynamic]['private_key'])
+          else
+            @smaak_client.set_identifier(SoarSc::environment['IDENTIFIER'])
+            @smaak_client.set_private_key(@configuration['private_key'])
+            @configuration['associations'].each do |identifier, association|
+              @smaak_client.add_association(identifier, association['public_key'], association['psk'], association['encrypt'])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soar_sc_mvc/configured_model.rb

@@ -0,0 +1,15 @@
+module SoarSc
+  module Web
+    module Models
+      class ConfiguredModel
+        attr_accessor :configuration
+        attr_accessor :dependencies
+
+        def initialize(configuration)
+          @configuration = configuration
+          @dependencies = SoarSc::dependencies
+        end
+      end
+    end
+  end
+end

data/lib/soar_sc_mvc/model_factory.rb

@@ -0,0 +1,14 @@
+require 'soar_configured_factory'
+
+module SoarSc
+  module Web
+    module Models
+      class ModelFactory < SoarConfiguredFactory::ConfiguredFactory
+        def initialize(configuration)
+          super(configuration)
+          @path = ['providers']
+        end
+      end
+    end
+  end
+end

data/lib/soar_sc_mvc/parser.rb

@@ -0,0 +1,49 @@
+module SoarSc
+  module Web
+    class Parser
+      def self.parseIntoParams(request)
+        rx = extract_request_parameters(request)
+        return {} if not rx
+        enumerate_parameters(rx)
+      end
+
+      def self.ensure_quoted(value)
+        is_quoted?(value) ? value : "\"#{value}\""
+      end
+        
+      def self.ensure_not_quoted(value)
+        is_quoted?(value) ? value[1..-2] : value
+      end
+
+      private
+
+      def self.is_quoted?(param)
+        double = (param[0] == '"') and (param[param.size-1] == '"')
+        single = (param[0] == "'") and (param[param.size-1] == "'")
+        single or double
+      end
+
+      def self.extract_request_parameters(request)
+        rx = request.env['rack.request.form_vars'] || ""
+        rx = ((request.body.is_a? Rack::Lint::InputWrapper) ? request.body.gets : request.body) if rx == ""
+        rx = request.url.split('?')[1] if (request.url) and (not request.url.split('?').nil?) and (rx == "")
+        rx
+      end
+
+      def self.enumerate_parameters(rx)
+        params = {}
+        rx.split('&').each do |keyvalue|
+          params = append_parameter(params, keyvalue)
+        end
+        params
+      end
+
+      def self.append_parameter(params, keyvalue)
+        key = keyvalue.split('=')[0]
+        value = keyvalue.split('=')[1]
+        params[key] = value.nil? ? nil : CGI::unescape(value)
+        params
+      end
+    end
+  end
+end

data/lib/soar_sc_mvc/version.rb

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

data/lib/soar_sc_mvc.rb

@@ -0,0 +1,11 @@
+require "soar_sc_mvc/version"
+require 'rack'
+require 'smaak'
+require 'soar_smaak'
+require "soar_sc_mvc/parser"
+require "soar_sc_mvc/configured_controller"
+require "soar_sc_mvc/configured_model"
+require "soar_sc_mvc/model_factory"
+
+module SoarScMvc
+end

data/soar_sc_mvc.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_sc_mvc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_sc_mvc"
+  spec.version       = SoarScMvc::VERSION
+  spec.authors       = ["Ernst Van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+
+  spec.summary       = %q{MVC library for SOAR reference implementation service component}
+  spec.description   = %q{MVC library for SOAR reference implementation service component}
+  spec.homepage      = "https://github.com/hetznerZA/soar_sc_mvc"
+  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 "soar_configured_factory", '~> 0.1.0'
+  spec.add_dependency 'smaak', "~> 0.2.2"
+  spec.add_dependency 'soar_smaak', "~> 0.1.16"
+  spec.add_dependency "rack", "~> 1.6.4"
+
+  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 "byebug"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: soar_sc_mvc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst Van Graan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: soar_configured_factory
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.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_smaak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.16
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !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: 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: MVC library for SOAR reference implementation service component
+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_mvc.rb
+- lib/soar_sc_mvc/configured_controller.rb
+- lib/soar_sc_mvc/configured_model.rb
+- lib/soar_sc_mvc/model_factory.rb
+- lib/soar_sc_mvc/parser.rb
+- lib/soar_sc_mvc/version.rb
+- soar_sc_mvc.gemspec
+homepage: https://github.com/hetznerZA/soar_sc_mvc
+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: MVC library for SOAR reference implementation service component
+test_files: []