f4w-rack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ad35b1fc323072c8c9bf4c6d239ede885a90d59
+  data.tar.gz: 177811be343d378b03bf1922e61f69888127143a
+SHA512:
+  metadata.gz: 768f3cea3eff162ca162295e2e52d799c1e7d87789b84cef0fd4297f50ce8d973db3ed4ea744522fb3a65f300679fff3bc151fd3be3e0c1607e6d5a016a85b52
+  data.tar.gz: e83f6f3501d3ee52cbcab1b92c2125c89ed36a792a1f45e0835e1155132161dd667edf6c5710a0cd00c38e2879b3cfa631234325cac577530b64c50173b2ae49

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,20 @@
+# F4w::Rack
+
+This gems offers some rack middlewares specifically developed for FACTS4WORKERS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'f4w-rack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install f4w-rack
+

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 "f4w/rack"
+
+# 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/f4w-rack.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'f4w/rack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "f4w-rack"
+  spec.version       = F4w::Rack::VERSION
+  spec.authors       = ["Alessio Caiazza"]
+  spec.email         = ["nolith@abisso.org"]
+
+  spec.summary       = %q{A collection of rack middleware}
+  spec.description   = %q{A collection of rack middleware related to FACTS4WORKERS EU project}
+  spec.homepage      = "https://gitlab.com/unifi-f4w/f4w-rack"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "rack", ">= 1.6.4"
+  spec.add_dependency "oauth2-checker", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/f4w/logging/app_data.rb

@@ -0,0 +1,15 @@
+module F4w
+  module Logging
+    class AppData
+      attr_accessor :data
+
+      def initialize(data={})
+        @data = data
+      end
+
+      def as_json(options = nil)
+        { 'appData' => @data.to_json }
+      end
+    end
+  end
+end

data/lib/f4w/logging/entry.rb

@@ -0,0 +1,69 @@
+require 'date'
+require 'f4w/logging/app_data'
+require 'f4w/logging/error_data'
+
+module F4w
+  module Logging
+    class Entry
+      VERSION = 1
+
+      attr_accessor :app_data_log_record
+      attr_accessor :error_log_record
+      attr_accessor :invocation_zoned_date_time
+      attr_accessor :service_uri
+      attr_accessor :type_of_call
+      attr_accessor :user_id
+
+      def initialize(uri, type_of_call, user_id, app_data, error_data)
+        @service_uri = uri
+        @type_of_call = type_of_call
+        @app_data_log_record = app_data
+        @error_log_record = error_data
+        @user_id = user_id
+
+        @invocation_zoned_date_time = DateTime.now.iso8601(3)
+      end
+
+      def as_json(options=nil)
+        json = {
+            'invocationZonedDateTime' => @invocation_zoned_date_time,
+            'serviceURI' => @service_uri,
+            'tyepeOfCall' => @type_of_call
+        }
+
+        json['appDataLogRecord'] = @app_data_log_record.as_json(options) unless @app_data_log_record.nil?
+        json['errorLogRecord'] = @error_log_record.as_json(options) unless @error_log_record.nil?
+        json['userID'] = @user_id unless @user_id.nil?
+
+        json
+      end
+
+      def self.request_start(uri, user_id, data = nil)
+        log_request(uri, '1', user_id, data)
+      end
+
+      def self.request_end(uri, user_id, data = nil)
+        log_request(uri, '2', user_id, data)
+      end
+
+      def self.error(uri, user_id, error_context, error_message, data = nil)
+        log_request(uri, '-1', user_id, data, error_context, error_message)
+      end
+
+      def to_s
+        "ver=#{VERSION} log=#{to_json}"
+      end
+
+      private
+
+      def self.log_request(uri, type, user_id, data = nil, error_context=nil, error_message=nil)
+        error = if !error_context.nil? && !error_message.nil?
+          ErrorData.new(error_context, error_message)
+        else
+          nil
+        end
+        new(uri, type, user_id, data.nil? ? nil : AppData.new(data), error)
+      end
+    end
+  end
+end

data/lib/f4w/logging/error_data.rb

@@ -0,0 +1,6 @@
+module F4w
+  module Logging
+    class ErrorData < Struct.new(:context, :message)
+    end
+  end
+end

data/lib/f4w/rack/logger.rb

@@ -0,0 +1,37 @@
+require 'rack/request'
+require 'f4w/logging/entry'
+
+module F4w
+  module Rack
+    class Logger
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        req = ::Rack::Request.new(env)
+        requested_uri = req.url()
+        user_id = env['rack.oauth2.resource_owner']
+        data = app_data(env)
+        puts F4w::Logging::Entry.request_start(requested_uri, user_id, data)
+        begin
+          status, headers, body = @app.call(env)
+
+          [status, headers, body]
+        rescue Exception => e
+          puts F4w::Logging::Entry.error(requested_uri, user_id, 'uncatched_exception', e.message, data.merge(error_class: e.class))
+          throw e
+        ensure
+          puts F4w::Logging::Entry.request_end(requested_uri, user_id, data)
+        end
+      end
+
+      private
+
+      def app_data(env)
+        env.dup.delete_if { |key,_| !(key =~/^HTTP_/) || key == 'HTTP_COOKIE' }
+      end
+
+    end
+  end
+end

data/lib/f4w/rack/oauth2.rb

@@ -0,0 +1,37 @@
+require 'rack/request'
+require 'oauth2/checker'
+
+module F4w
+  module Rack
+    class Oauth2
+      def initialize(app, client_id, client_secret, options={})
+        @app = app
+        @client_id = client_id
+        @client_secret = client_secret
+        @options = options
+      end
+
+      def call(env)
+        req = ::Rack::Request.new(env)
+        if req.params['access_token']
+          req.logger.debug('getting Oauth2 resource_owner') unless req.logger.nil?
+          valid, resource_owner = oauth2_checker.validate(req.params['access_token'])
+          env['rack.oauth2.valid_token'] = valid
+          env['rack.oauth2.resource_owner'] = resource_owner
+          req.logger.debug("resource_owner: #{resource_owner}") unless req.logger.nil?
+        else
+          env['rack.oauth2.valid_token'] = false
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def oauth2_checker
+        ::OAuth2::Checker.new(@client_id,@client_secret,@options)
+      end
+
+    end
+  end
+end

data/lib/f4w/rack/version.rb

@@ -0,0 +1,5 @@
+module F4w
+  module Rack
+    VERSION = "0.1.0"
+  end
+end

data/lib/f4w/rack.rb

@@ -0,0 +1,7 @@
+require "f4w/rack/version"
+
+module F4w
+  module Rack
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: f4w-rack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessio Caiazza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-15 00:00:00.000000000 Z
+dependencies:
+- !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: oauth2-checker
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: A collection of rack middleware related to FACTS4WORKERS EU project
+email:
+- nolith@abisso.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- f4w-rack.gemspec
+- lib/f4w/logging/app_data.rb
+- lib/f4w/logging/entry.rb
+- lib/f4w/logging/error_data.rb
+- lib/f4w/rack.rb
+- lib/f4w/rack/logger.rb
+- lib/f4w/rack/oauth2.rb
+- lib/f4w/rack/version.rb
+homepage: https://gitlab.com/unifi-f4w/f4w-rack
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A collection of rack middleware
+test_files: []