wso2_toolbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4dd0daaf7f02586cdee53321e305ee6cb3ebf4de
+  data.tar.gz: fa5605e1bb1ef9466112214ba02bc83005062069
+SHA512:
+  metadata.gz: a6031fedca55bff5995e5f912d71fda9259f91b1826cd5a176c5fefb02f330aeb0aae1c32411fa76b708f194d2fc4bf66fa36282123c172bcfa033bcbda46c95
+  data.tar.gz: 3f2bbed00235ef592c8445b4e3f4d3d7b1c0c6b48499b3e788972778f4c71ebee902f0987637ea5b2c81017bac4921eb30c6ea77ce5be31cf2977df4a72f910a

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+wso2_toolbox

data/.travis.yml

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

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 wso2_toolbox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    wso2_toolbox (0.1.0)
+      actionpack (>= 5.0)
+      activesupport (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.3)
+    rack-test (0.8.2)
+      rack (>= 1.0, < 3)
+    rails-controller-testing (1.0.2)
+      actionpack (~> 5.x, >= 5.0.1)
+      actionview (~> 5.x, >= 5.0.1)
+      activesupport (~> 5.x)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    shoulda-matchers (3.1.2)
+      activesupport (>= 4.0.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rails-controller-testing (~> 1.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shoulda-matchers (~> 3.1)
+  wso2_toolbox!
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,53 @@
+# Wso2Toolbox
+
+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/wso2_toolbox`. 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 'wso2_toolbox'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wso2_toolbox
+
+## Usage
+
+### Example controller
+
+```
+class MyController
+  include Wso2Toolbox::IdentityHeaders
+end
+```
+
+### Example test
+
+In `spec_helper.rb` require 'paper_trail/frameworks/rspec'.
+
+```
+require 'rails_helper'
+
+RSpec.describe MyController do
+  it_behaves_like 'audit user', ApplicationController
+end
+```
+
+## 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 Bitbucker at https://bitbucket.org/guideinvestimentos/wso2_toolboxÎ.

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 "wso2_toolbox"
+
+# 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(__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/bitbucket-pipelines.yml

@@ -0,0 +1,19 @@
+image: ruby:2.4.1
+
+pipelines:
+  default:
+    - step:
+        script:
+          - git archive --remote=git@bitbucket.org:guideinvestimentos/rails_defaults.git HEAD .rubocop.yml | tar -x
+          - bundle install
+          - gem install rubocop
+          - rspec -fdoc
+          - rubocop .
+  branches:
+    master:
+      - step:
+          script:
+            - gem build wso2_toolbox.gemspec
+            - curl -u $RUBYGEMS_USERNAME:$RUBYGEMS_PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials
+            - chmod 0600 ~/.gem/credentials
+            - gem push $(ls *.gem)

data/lib/wso2_toolbox/identity_headers.rb

@@ -0,0 +1,20 @@
+require 'active_support'
+
+module Wso2Toolbox
+  module IdentityHeaders
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_paper_trail_whodunnit
+    end
+
+    def user_identifier
+      user_header = request.headers[:HTTP_USER_IDENTIFIER]
+      user_header ? Base64.decode64(user_header) : nil
+    end
+
+    def user_for_paper_trail
+      user_identifier
+    end
+  end
+end

data/lib/wso2_toolbox/rspec_utils/shared_examples/identity_headers.rb

@@ -0,0 +1,81 @@
+module Wso2Toolbox
+  module RspecUtils
+    module SharedExamples
+      module IdentityHeaders
+        RSpec.shared_context 'stub identity headers' do |controller_class|
+          let(:user_hash) do
+            {
+              'id' => 1,
+              'user_name' => 'app-user',
+              'email' => 'noreplay@guideinvestimentos.com.br',
+              'remote_ip' => '127.0.0.1'
+            }
+          end
+          let(:base64_header) { Base64.strict_encode64(user_hash.to_s) }
+          let(:headers_hash) { { 'HTTP_USER_IDENTIFIER' => base64_header } }
+          let(:request_obj) do
+            instance_double('ActionDispatch::Request', headers: headers)
+          end
+
+          before(:each) do
+            allow_any_instance_of(controller_class).
+              to receive(:request) { request_obj }
+          end
+        end
+
+        RSpec.shared_examples 'set_paper_trail_whodunnit' do
+          describe 'before_action' do
+            it { is_expected.to use_before_action(:set_paper_trail_whodunnit) }
+          end
+        end
+
+        RSpec.shared_examples 'get user identifier' do |controller_class|
+          include_context 'stub identity headers', controller_class
+
+          describe '#user_identifier' do
+            context 'receive user identifier header' do
+              let(:headers) do
+                ActionDispatch::Http::Headers.from_hash(headers_hash)
+              end
+              it { expect(subject.user_identifier).to eq user_hash.to_s }
+            end
+
+            context 'not receive user identifier header' do
+              let(:headers) { ActionDispatch::Http::Headers.from_hash({}) }
+              it { expect(subject.user_identifier).to be_nil }
+            end
+          end
+        end
+
+        RSpec.shared_examples 'get user for paper_trail' do |controller_class|
+          include_context 'stub identity headers', controller_class
+
+          describe '#user_for_paper_trail' do
+            context 'receive user identifier header' do
+              before(:each) do
+                allow_any_instance_of(controller_class).
+                  to receive(:user_identifier) { user_hash.to_s }
+              end
+
+              it { expect(subject.user_for_paper_trail).to eq user_hash.to_s }
+            end
+            context 'receive user identifier header' do
+              before(:each) do
+                allow_any_instance_of(controller_class).
+                  to receive(:user_identifier) { nil }
+              end
+
+              it { expect(subject.user_for_paper_trail).to be_nil }
+            end
+          end
+        end
+
+        RSpec.shared_examples 'audit user' do |controller_class|
+          it_behaves_like 'set_paper_trail_whodunnit'
+          it_behaves_like 'get user identifier', controller_class
+          it_behaves_like 'get user for paper_trail', controller_class
+        end
+      end
+    end
+  end
+end

data/lib/wso2_toolbox/rspec_utils/shared_examples.rb

@@ -0,0 +1,6 @@
+module Wso2Toolbox
+  module RspecUtils
+    module SharedExamples
+    end
+  end
+end

data/lib/wso2_toolbox/rspec_utils.rb

@@ -0,0 +1,7 @@
+require 'wso2_toolbox/rspec_utils/shared_examples'
+require 'wso2_toolbox/rspec_utils/shared_examples/identity_headers'
+
+module Wso2Toolbox
+  module RspecUtils
+  end
+end

data/lib/wso2_toolbox/version.rb

@@ -0,0 +1,3 @@
+module Wso2Toolbox
+  VERSION = '0.1.0'.freeze
+end

data/lib/wso2_toolbox.rb

@@ -0,0 +1,5 @@
+require 'wso2_toolbox/version'
+require 'wso2_toolbox/identity_headers'
+
+module Wso2Toolbox
+end

data/wso2_toolbox.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wso2_toolbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wso2_toolbox'
+  spec.version       = Wso2Toolbox::VERSION
+  spec.authors       = ['Abner Carleto']
+  spec.email         = ['abner.carleto@cedrotech.com']
+
+  spec.summary       = 'WSO2 useful tools'
+  spec.homepage      = 'https://bitbucket.org/guideinvestimentos/wso2_toolbox'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionpack', '>= 5.0'
+  spec.add_dependency 'activesupport', '>= 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rails-controller-testing', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: wso2_toolbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abner Carleto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- abner.carleto@cedrotech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bitbucket-pipelines.yml
+- lib/wso2_toolbox.rb
+- lib/wso2_toolbox/identity_headers.rb
+- lib/wso2_toolbox/rspec_utils.rb
+- lib/wso2_toolbox/rspec_utils/shared_examples.rb
+- lib/wso2_toolbox/rspec_utils/shared_examples/identity_headers.rb
+- lib/wso2_toolbox/version.rb
+- wso2_toolbox.gemspec
+homepage: https://bitbucket.org/guideinvestimentos/wso2_toolbox
+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.6.10
+signing_key: 
+specification_version: 4
+summary: WSO2 useful tools
+test_files: []