f4w-rack 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ad35b1fc323072c8c9bf4c6d239ede885a90d59
-  data.tar.gz: 177811be343d378b03bf1922e61f69888127143a
+  metadata.gz: 2e26ce490c8f1a9a9b3a9445998b5e0d78dcb96c
+  data.tar.gz: 24b76f9dfb3c2881ccdb16a74fef83a9bf248032
 SHA512:
-  metadata.gz: 768f3cea3eff162ca162295e2e52d799c1e7d87789b84cef0fd4297f50ce8d973db3ed4ea744522fb3a65f300679fff3bc151fd3be3e0c1607e6d5a016a85b52
-  data.tar.gz: e83f6f3501d3ee52cbcab1b92c2125c89ed36a792a1f45e0835e1155132161dd667edf6c5710a0cd00c38e2879b3cfa631234325cac577530b64c50173b2ae49
+  metadata.gz: d38398bdee034c8354f3adc468150d4e442a21b3d919017e4c1917d2f40bb43edbc0f7bad702157174a8a0788dee47c97e5e9461e85ccb629200d7bd198e2f89
+  data.tar.gz: 77c05003f2933bea65ff5c0bd69ad8c6fec5d40eee8ff2cdb25428702c6bc0f2b59ee84454ff389c173cd9484daf2efde5080afa267bfdd9b11f491921e5a94e

data/.gitlab-ci.yml

@@ -0,0 +1,28 @@
+services: []
+
+test_ruby_2.2:
+  stage: test
+  variables:
+    LC_ALL: C.UTF-8
+  image: ruby:2.2
+  script:
+    - bundle install
+    - bundle exec rake test
+
+test_ruby_2.3:
+  stage: test
+  variables:
+    LC_ALL: C.UTF-8
+  image: ruby:2.3
+  script:
+    - bundle install
+    - bundle exec rake test
+
+rubocop:
+  stage: test
+  variables:
+    LC_ALL: C.UTF-8
+  image: ruby:2.2
+  script:
+    - bundle install
+    - bundle exec rubocop -f s

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayStyleGuide: true
+  DisplayCopNames: true
+  DefaultFormatter: fuubar
+
+Metrics/BlockLength:
+  Exclude:
+    - 'test/**/*'
+
+# Metrics/MethodLength:
+#   Max: 20
+
+# Documentation:
+#   Enabled: false
+#   # Exclude:
+#   #   - 'app/controllers/**/*'
+
+# BlockLength:
+#   Exclude:
+#     - 'app/**/concerns/**/*'
+#     - 'app/controllers/apidocs_controller.rb'
+#     - 'app/models/docs/**/*'
+

data/.rubocop_todo.yml

@@ -0,0 +1,58 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-12-15 15:56:28 +0100 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/IneffectiveAccessModifier:
+  Exclude:
+    - 'lib/f4w/logging/entry.rb'
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'lib/f4w/rack/logger.rb'
+
+# Offense count: 1
+# Configuration parameters: ContextCreatingMethods.
+Lint/UselessAccessModifier:
+  Exclude:
+    - 'lib/f4w/logging/entry.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 5
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 132
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/f4w/logging/app_data.rb'
+    - 'lib/f4w/logging/entry.rb'
+    - 'lib/f4w/rack.rb'
+    - 'lib/f4w/rack/logger.rb'
+
+# Offense count: 1
+Style/StructInheritance:
+  Exclude:
+    - 'lib/f4w/logging/error_data.rb'

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# F4W Rack middlewares #
+
+## [Unreleased] ##
+
+## [0.2.0] - 2016-12-30 ##
+Added
+- testing & linting
+- dry-initiliazer
+- OAuth2 mock middleware for testing purpose
+
+## 0.1.0 - 2016-11-15 ##
+
+### Added ###
+- OAuth2 checking middleware
+- Logging middleware
+
+
+[Unreleased]: https://gitlab.com/unifi-f4w/f4w-rack/compare/0.1.0...develop
+[0.2.0]: https://gitlab.com/unifi-f4w/f4w-rack/compare/0.2.0...0.1.0

data/Rakefile

@@ -1,6 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.options = '-v'
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb'] + FileList['test/**/spec_*.rb']
+end
 
-task :default => :spec
+task default: :test

data/bin/console

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "f4w/rack"
+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.
+require 'f4w/rack/oauth2'
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start
+require 'pry'
+Pry.start

data/f4w-rack.gemspec

@@ -4,26 +4,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'f4w/rack/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "f4w-rack"
+  spec.name          = 'f4w-rack'
   spec.version       = F4w::Rack::VERSION
-  spec.authors       = ["Alessio Caiazza"]
-  spec.email         = ["nolith@abisso.org"]
+  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.summary       = 'A collection of rack middleware'
+  spec.description   = '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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rack", ">= 1.6.4"
-  spec.add_dependency "oauth2-checker", "~> 0.2.0"
+  spec.add_dependency 'rack', '>= 1.6.4'
+  spec.add_dependency 'oauth2-checker', '~> 0.2.0'
+  spec.add_dependency 'dry-initializer', '~> 0.10.0'
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-rg', '~> 5.2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.46.0'
 end

data/lib/f4w/logging/app_data.rb

@@ -3,13 +3,13 @@ module F4w
     class AppData
       attr_accessor :data
 
-      def initialize(data={})
+      def initialize(data = {})
         @data = data
       end
 
-      def as_json(options = nil)
+      def as_json(_options = nil)
         { 'appData' => @data.to_json }
       end
     end
   end
-end
+end

data/lib/f4w/logging/entry.rb

@@ -24,11 +24,11 @@ module F4w
         @invocation_zoned_date_time = DateTime.now.iso8601(3)
       end
 
-      def as_json(options=nil)
+      def as_json(options = nil)
         json = {
-            'invocationZonedDateTime' => @invocation_zoned_date_time,
-            'serviceURI' => @service_uri,
-            'tyepeOfCall' => @type_of_call
+          '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?
@@ -56,12 +56,10 @@ module F4w
 
       private
 
-      def self.log_request(uri, type, user_id, data = nil, error_context=nil, error_message=nil)
+      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
+                  ErrorData.new(error_context, error_message)
+                end
         new(uri, type, user_id, data.nil? ? nil : AppData.new(data), error)
       end
     end

data/lib/f4w/logging/error_data.rb

@@ -3,4 +3,4 @@ module F4w
     class ErrorData < Struct.new(:context, :message)
     end
   end
-end
+end

data/lib/f4w/rack.rb

@@ -1,4 +1,4 @@
-require "f4w/rack/version"
+require 'f4w/rack/version'
 
 module F4w
   module Rack

data/lib/f4w/rack/all.rb

@@ -0,0 +1,6 @@
+require 'f4w/rack'
+require 'f4w/rack/logger'
+require 'f4w/rack/oauth2'
+require 'f4w/logging/app_data'
+require 'f4w/logging/entry'
+require 'f4w/logging/error_data'

data/lib/f4w/rack/logger.rb

@@ -10,7 +10,7 @@ module F4w
 
       def call(env)
         req = ::Rack::Request.new(env)
-        requested_uri = req.url()
+        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)
@@ -29,9 +29,8 @@ module F4w
       private
 
       def app_data(env)
-        env.dup.delete_if { |key,_| !(key =~/^HTTP_/) || key == 'HTTP_COOKIE' }
+        env.dup.delete_if { |key, _| !(key =~ /^HTTP_/) || key == 'HTTP_COOKIE' }
       end
-
     end
   end
 end

data/lib/f4w/rack/mock_oauth2.rb

@@ -0,0 +1,35 @@
+require 'dry-initializer'
+require 'rack/request'
+
+module F4w
+  module Rack
+    # A Mock that behaves like <tt>F4w::Rack::Oauth2</tt>
+    class MockOauth2
+      include Dry::Initializer.define -> do # rubocop:disable Style/Lambda
+        param :app
+        param :token_validator,
+              default: proc { ->(_token) { [true, 'mock_owner'] } }
+      end
+
+      def call(env)
+        req = ::Rack::Request.new(env)
+        if req.params['access_token']
+          validate_token(req, env)
+        else
+          env['rack.oauth2.valid_token'] = false
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def validate_token(request, env)
+        valid, resource_owner = @token_validator
+                                .call(request.params['access_token'])
+        env['rack.oauth2.valid_token'] = valid
+        env['rack.oauth2.resource_owner'] = resource_owner
+      end
+    end
+  end
+end

data/lib/f4w/rack/oauth2.rb

@@ -1,24 +1,22 @@
+require 'dry-initializer'
 require 'rack/request'
 require 'oauth2/checker'
 
 module F4w
   module Rack
+    # Validates oauth token
     class Oauth2
-      def initialize(app, client_id, client_secret, options={})
-        @app = app
-        @client_id = client_id
-        @client_secret = client_secret
-        @options = options
+      include Dry::Initializer.define -> do # rubocop:disable Style/Lambda
+        param :app
+        param :client_id
+        param :client_secret
+        param :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?
+          validate_token(req, env)
         else
           env['rack.oauth2.valid_token'] = false
         end
@@ -29,9 +27,19 @@ module F4w
       private
 
       def oauth2_checker
-        ::OAuth2::Checker.new(@client_id,@client_secret,@options)
+        ::OAuth2::Checker.new(@client_id, @client_secret, @options)
       end
 
+      def validate_token(request, env)
+        logger = request.logger || ::Logger.new($stdout)
+
+        logger.debug('getting Oauth2 resource_owner')
+        valid, resource_owner = oauth2_checker
+                                .validate(request.params['access_token'])
+        env['rack.oauth2.valid_token'] = valid
+        env['rack.oauth2.resource_owner'] = resource_owner
+        logger.debug("resource_owner: #{resource_owner}")
+      end
     end
   end
 end

data/lib/f4w/rack/version.rb

@@ -1,5 +1,5 @@
 module F4w
   module Rack
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: f4w-rack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alessio Caiazza
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2016-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +95,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-rg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.46.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.46.0
 description: A collection of rack middleware related to FACTS4WORKERS EU project
 email:
 - nolith@abisso.org
@@ -88,8 +158,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -100,7 +174,9 @@ files:
 - lib/f4w/logging/entry.rb
 - lib/f4w/logging/error_data.rb
 - lib/f4w/rack.rb
+- lib/f4w/rack/all.rb
 - lib/f4w/rack/logger.rb
+- lib/f4w/rack/mock_oauth2.rb
 - lib/f4w/rack/oauth2.rb
 - lib/f4w/rack/version.rb
 homepage: https://gitlab.com/unifi-f4w/f4w-rack