lhc-core-interceptors 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 846a8d5619ee3ea84c7adfe04e967f37cb34f49a
-  data.tar.gz: 5e08294e64256b9adeb5040f369c2ae36bbc6f06
+  metadata.gz: 199dcad392ac88c77807b144fa9ff615514ba3d9
+  data.tar.gz: 62ee867af574146bc8d9033e6d82a2dbce4d1e3b
 SHA512:
-  metadata.gz: c182e664a63da4afcff74156c847dcd74303f6b32a2e893d91b17b3b9532cfa0e6b99cb649d379216c3512b3d9d0c58bb2eca10725671c7354dde993237bc546
-  data.tar.gz: 9d8f7cfba22dd40c1f78cb237677ef7ebf359fd401a8b7c40d5632b586271aaecaf846c9c5ff7de5fb2f628dc917a5df5b2807eab378fc20307198b86b54f45b
+  metadata.gz: d4817c6e276fc7867f801f6795054e0c1dbf56ad99f00ca4fbb9ec2ac68a9a3b3709ab11762af1a71e29c4b7d1dd0f4977953a80e252b3bc10dd3a78f0ae027f
+  data.tar.gz: bce436de74efa7be5a67bb96457aa99402b035294aa88f2f97b45645b4d2b4ed26f616ec63fee1fedc00b75f6c7622c3669215541b7576df865075eea6314baf

data/.rubocop.localch.yml

@@ -0,0 +1,190 @@
+# This is master rubocop configuration.
+# DO NOT EDIT THIS FILE - it WILL be overwriten on every config update
+AllCops:
+  TargetRubyVersion: 2.1
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+    - '**/Capfile'
+  Exclude:
+    - 'db/**/*'
+    - 'script/**/*'
+    - 'vendor/bundle/**/*'
+    - 'bin/**/*'
+    - 'config/unicorn.rb'
+    - 'config/compass.rb'
+    - 'Rakefile'
+
+Rails:
+  Enabled: true
+
+require:
+  - rubocop-rspec
+
+Lint/HandleExceptions:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Performance/StringReplacement:
+  Enabled: false
+
+Performance/TimesMap:
+  Enabled: false
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Performance/RedundantMatch:
+  Enabled: false
+
+Performance/RedundantMerge:
+  Enabled: false
+
+Performance/Casecmp:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Exclude:
+    - spec/**/*
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/UnneededCapitalW:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - spec/**/*
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Exclude:
+    - spec/support/pages/**/*
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/views/**/*
+    - spec/routing/**/*
+    - spec/requests/**/*
+    - spec/features/**/*
+
+RSpec/FilePath:
+  Enabled: false
+
+Rails/Output:
+  Exclude:
+    - 'config/application.rb'
+    - 'config/initializers/asset_manifest_warning.rb'

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# This is project specific rubocop configuration file.
+# You can tweak project settings here
+inherit_from:
+  - ./.rubocop.localch.yml
+
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - lib/lhc-core-interceptors.rb
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+  

data/README.md

@@ -96,6 +96,8 @@ Add the auth interceptor to your basic set of LHC interceptors.
   LHC.config.interceptors = [LHC::Auth]
 ```
 
+#### Bearer Authentication
+
 ```ruby
   LHC.get('http://local.ch', auth: { bearer: -> { access_token } })
 ```
@@ -106,3 +108,16 @@ Adds the following header to the request:
 ```
 
 Assuming the method `access_token` responds on runtime of the request with `123456`.
+
+#### Basic Authentication
+
+```ruby
+  LHC.get('http://local.ch', auth: { basic: -> { username: 'steve', password: 'can' } })
+```
+
+Adds the following header to the request:
+```
+  'Authorization': 'Basic c3RldmU6Y2Fu'
+```
+
+Which is the base64 encoded credentials "username:password".

data/cider-ci/jobs/rspec.yml

@@ -0,0 +1,48 @@
+rspec:
+  name: 'RSPec tests'
+
+  run-on:
+    - type: branch
+      include-match: ^.*$
+
+  context:
+    task-defaults:
+      ports:
+        CAPYBARA_PORT:
+          inet_address: "localhost"
+          min: 8000
+          max: 8999
+        PHANTOMJS_PORT:
+          inet_address: "localhost"
+          min: 44600
+          max: 44999
+
+      scripts:
+        rspec:
+          start-when:
+            - script: bundle
+            - script: ruby-version
+            - script: tmp-cache
+
+
+        _cider-ci_include:
+          - cider-ci/scripts/bundle.yml
+          - cider-ci/scripts/tmp-cache.yml
+          - cider-ci/scripts/ruby-version.yml
+          - cider-ci/scripts/rspec.yml
+
+
+      trial-attachments:
+        logs:
+          include-match: log\/.*\.log$
+          content-type: text/plain
+        image-screenshots:
+          include-match: tmp\/capybara\/.*\.png$
+          content-type: image/png
+        html-screenshots:
+          include-match: tmp\/capybara\/.*\.html$
+          content-type: text/html
+
+    _cider-ci_generate-tasks:
+      include-match: spec/.*_spec.rb
+      exclude-match: spec/support/shared/*

data/cider-ci/jobs/rubocop.yml

@@ -0,0 +1,55 @@
+rubocop:
+  name: 'Rubocop analysis'
+
+  run-on:
+    - type: branch
+      include-match: ^.*$
+
+  context:
+    task-defaults:
+      environment-variables:
+        GIT_REPOSITORY: local-ch/location-app
+        RESULT_PATH: 'tmp/checkstyle.json'
+
+      scripts:
+        rubocop:
+          start-when:
+            - script: bundle
+            - script: ruby-version
+            - script: tmp-cache
+
+        
+        github_comment:
+          start-when:
+            - script: rubocop
+              states: [failed]
+        
+
+        _cider-ci_include:
+          - cider-ci/scripts/bundle.yml
+          - cider-ci/scripts/tmp-cache.yml
+          - cider-ci/scripts/ruby-version.yml
+          - cider-ci/scripts/rubocop.yml
+          
+          - cider-ci/scripts/github_comment.yml
+          
+
+      max-auto-trials: 1
+
+      trial-attachments:
+        logs:
+          include-match: tmp\/checkstyle.json$
+          content-type: application/json
+
+      tree-attachments:
+        logs:
+          include-match: tmp\/checkstyle.json$
+          content-type: application/json
+
+    tasks:
+      rubocop:
+        scripts:
+          rubocop: {}
+          
+          github_comment: {}
+          

data/cider-ci/scripts/bundle.yml

@@ -0,0 +1,3 @@
+bundle:
+  exclusive-executor-resource: bundler
+  body: sed 's/^source.*/source "http\:\/\/52.29.7.59:9292"/g' Gemfile > Gemfile.tmp ; mv Gemfile.tmp Gemfile && bundle install

data/cider-ci/scripts/github_comment.yml

@@ -0,0 +1,6 @@
+github_comment:
+  ignore-state: true
+  body: |
+    #!/usr/bin/env bash
+
+    bundle exec rake checkstyle

data/cider-ci/scripts/rspec.yml

@@ -0,0 +1,4 @@
+rspec:
+  body: |
+    #!/usr/bin/env bash
+    bundle exec rspec $CIDER_CI_TASK_FILE

data/cider-ci/scripts/rubocop.yml

@@ -0,0 +1,5 @@
+rubocop:
+  body: |
+    #!/usr/bin/env bash
+
+    bundle exec rubocop  --config .rubocop.yml --format json --out $RESULT_PATH --format progress

data/cider-ci/scripts/ruby-version.yml

@@ -0,0 +1,2 @@
+ruby-version:
+  body: ruby --version

data/cider-ci/scripts/tmp-cache.yml

@@ -0,0 +1,2 @@
+tmp-cache:
+  body: mkdir -p tmp/cache

data/cider-ci.yml

@@ -1,3 +1,4 @@
 jobs:
   _cider-ci_include:
-    - cider-ci/jobs/tests.yml
+    - cider-ci/jobs/rubocop.yml
+    - cider-ci/jobs/rspec.yml

data/lhc-core-interceptors.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'webmock'
   s.add_development_dependency 'geminabox'
   s.add_development_dependency 'pry'
+  s.add_development_dependency 'ciderizer'
 end

data/lib/lhc-core-interceptors/auth.rb

@@ -2,10 +2,32 @@ class LHC::Auth < LHC::Interceptor
 
   def before_request(request)
     options = request.options[:auth] || {}
-    if token = options[:bearer]
-      token = token.call if token.is_a?(Proc)
-      request.headers['Authorization'] = "Bearer #{token}"
+    authenticate!(request, options)
+  end
+
+  private
+
+  def authenticate!(request, options)
+    if options[:bearer]
+      bearer_authentication!(request, options)
+    elsif options[:basic]
+      basic_authentication!(request, options)
     end
   end
 
+  def basic_authentication!(request, options)
+    auth = options[:basic]
+    credentials = "#{auth[:username]}:#{auth[:password]}"
+    set_authorization_header request, "Basic #{Base64.encode64(credentials).chomp}"
+  end
+
+  def bearer_authentication!(request, options)
+    token = options[:bearer]
+    token = token.call if token.is_a?(Proc)
+    set_authorization_header request, "Bearer #{token}"
+  end
+
+  def set_authorization_header(request, value)
+    request.headers['Authorization'] = value
+  end
 end

data/lib/lhc-core-interceptors/monitoring.rb

@@ -2,7 +2,7 @@ class LHC::Monitoring < LHC::Interceptor
 
   # Options forwarded to the monitoring
   FORWARDED_OPTIONS = {
-    monitoring_key: :key,
+    monitoring_key: :key
   }
 
   include ActiveSupport::Configurable

data/lib/lhc-core-interceptors/version.rb

@@ -1,3 +1,3 @@
 module LHCCoreInterceptors
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/spec/auth/basic_auth_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+
+describe LHC::Auth do
+  before(:each) do
+    LHC.config.interceptors = [LHC::Auth]
+  end
+
+  it 'adds basic auth to every request' do
+    options = { basic: { username: 'steve', password: 'can' } }
+    LHC.config.endpoint(:local, 'http://local.ch', auth: options)
+    stub_request(:get, 'http://local.ch')
+      .with(headers: { 'Authorization' => 'Basic c3RldmU6Y2Fu' })
+    LHC.get(:local)
+  end
+end

data/spec/auth/bearer_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 describe LHC::Auth do
-
   before(:each) do
     LHC.config.interceptors = [LHC::Auth]
   end
@@ -10,10 +9,9 @@ describe LHC::Auth do
     def bearer_token
       '123456'
     end
-    options = { bearer: ->{ bearer_token } }
+    options = { bearer: -> { bearer_token } }
     LHC.config.endpoint(:local, 'http://local.ch', auth: options)
-    stub_request(:get, 'http://local.ch').with(headers: { 'Authorization' => 'Bearer 123456'})
+    stub_request(:get, 'http://local.ch').with(headers: { 'Authorization' => 'Bearer 123456' })
     LHC.get(:local)
   end
-
 end

data/spec/caching/main_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 describe LHC::Caching do
-
   before(:each) do
     LHC.config.interceptors = [LHC::Caching]
     Rails.cache.clear
@@ -14,13 +13,13 @@ describe LHC::Caching do
     LHC.config.endpoint(:local, 'http://local.ch', cache: true, cache_expires_in: 5.minutes)
     expect(Rails.cache).to receive(:write)
       .with(
-        "LHC_CACHE(v#{LHC::Caching::CACHE_VERSION}): GET http://local.ch", 
+        "LHC_CACHE(v#{LHC::Caching::CACHE_VERSION}): GET http://local.ch",
         {
           body: 'The Website',
           code: 200,
           headers: nil,
           return_code: nil
-        }, expires_in: 5.minutes
+        }, { expires_in: 5.minutes }
       )
       .and_call_original
     original_response = LHC.get(:local)
@@ -52,10 +51,9 @@ describe LHC::Caching do
   it 'does not store server errors in cache' do
     LHC.config.endpoint(:local, 'http://local.ch', cache: true)
     stub_request(:get, 'http://local.ch').to_return(status: 500, body: 'ERROR')
-    expect{ LHC.get(:local) }.to raise_error LHC::ServerError
+    expect { LHC.get(:local) }.to raise_error LHC::ServerError
     stub
     expect(Rails.cache).to receive(:write).once
     LHC.get(:local)
   end
-
 end

data/spec/caching/parameters_spec.rb

@@ -1,9 +1,7 @@
 require 'rails_helper'
 
 describe LHC::Caching do
-
   context 'parameters' do
-
     before(:each) do
       LHC.config.interceptors = [LHC::Caching]
       Rails.cache.clear
@@ -21,4 +19,4 @@ describe LHC::Caching do
       ).to eq 'The Website for Zuerich'
     end
   end
-end
+end

data/spec/caching/response_status_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 describe LHC::Caching do
-
   before(:each) do
     LHC.config.interceptors = [LHC::Caching]
     LHC.config.endpoint(:local, 'http://local.ch', cache: true, cache_expires_in: 5.minutes)

data/spec/caching/to_cache_spec.rb

@@ -1,17 +1,14 @@
 require 'rails_helper'
 
 describe LHC::Caching do
-
   context 'to_cache' do
-
     it 'returns a marshalable object to store in the cache' do
       expect do
+        response = Typhoeus::Response.new(headers: { 'Accept' => 'application/json' })
         Marshal.dump(
-          LHC::Caching.new.send(:to_cache,
-            Typhoeus::Response.new(headers: { 'Accept' => 'application/json' })
-          )
+          LHC::Caching.new.send(:to_cache, response)
         )
-      end.to_not raise_error
+      end.not_to raise_error
     end
   end
-end
+end

data/spec/dummy/bin/rails

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
+APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/spec/dummy/config/initializers/cookies_serializer.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.action_dispatch.cookies_serializer = :json
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/dummy/config.ru

@@ -1,4 +1,4 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path('../config/environment', __FILE__)
 run Rails.application

data/spec/monitoring/main_spec.rb

@@ -1,14 +1,14 @@
 require 'rails_helper'
 
 describe LHC::Monitoring do
-
   let(:stub) { stub_request(:get, 'http://local.ch').to_return(status: 200, body: 'The Website') }
   let(:endpoint_configuration) { LHC.config.endpoint(:local, 'http://local.ch') }
 
   module Statsd
-    def self.count(path, value)
+    def self.count(_path, _value)
     end
-    def self.timing(path, value)
+
+    def self.timing(_path, _value)
     end
   end
 
@@ -25,7 +25,6 @@ describe LHC::Monitoring do
   end
 
   context 'statsd configured' do
-
     it 'reports trial, response and timing by default ' do
       stub
       expect(Statsd).to receive(:count).with('lhc.dummy.test.local_ch.get.count', 1)
@@ -39,7 +38,7 @@ describe LHC::Monitoring do
       expect(Statsd).to receive(:count).with('lhc.dummy.test.local_ch.get.count', 1)
       expect(Statsd).to receive(:count).with('lhc.dummy.test.local_ch.get.500', 1)
       expect(Statsd).not_to receive(:timing)
-      expect{ LHC.get(:local) }.to raise_error LHC::ServerError
+      expect { LHC.get(:local) }.to raise_error LHC::ServerError
     end
 
     it 'reports timeout instead of status code if response timed out' do
@@ -47,7 +46,7 @@ describe LHC::Monitoring do
       expect(Statsd).to receive(:count).with('lhc.dummy.test.local_ch.get.count', 1)
       expect(Statsd).to receive(:count).with('lhc.dummy.test.local_ch.get.timeout', 1)
       expect(Statsd).not_to receive(:timing)
-      expect{ LHC.get(:local) }.to raise_error LHC::Timeout
+      expect { LHC.get(:local) }.to raise_error LHC::Timeout
     end
 
     it 'allows to set the stats key for request' do
@@ -60,7 +59,6 @@ describe LHC::Monitoring do
   end
 
   context 'without protocol' do
-
     let(:endpoint_configuration) { LHC.config.endpoint(:local, 'local.ch') }
 
     it 'reports trial, response and timing by default ' do

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'pry'
 require 'webmock/rspec'
 
-Dir[File.join(__dir__, "support/**/*.rb")].each {|f| require f}
+Dir[File.join(__dir__, "support/**/*.rb")].each { |f| require f }

data/spec/support/cleanup_configuration.rb

@@ -10,9 +10,7 @@ class LHC::Config
 end
 
 RSpec.configure do |config|
-
   config.before(:each) do
     LHC::Config.instance._cleanup
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhc-core-interceptors
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - local.ch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ciderizer
+  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: A set of useful interceptors to use with LHC (like caching, monitoring
   etc.)
 email:
@@ -117,18 +131,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.localch.yml"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile
 - cider-ci.yml
-- cider-ci/contexts/rspec.yml
-- cider-ci/jobs/tests.yml
+- cider-ci/jobs/rspec.yml
+- cider-ci/jobs/rubocop.yml
+- cider-ci/scripts/bundle.yml
+- cider-ci/scripts/github_comment.yml
+- cider-ci/scripts/rspec.yml
+- cider-ci/scripts/rubocop.yml
+- cider-ci/scripts/ruby-version.yml
+- cider-ci/scripts/tmp-cache.yml
 - lhc-core-interceptors.gemspec
 - lib/lhc-core-interceptors.rb
 - lib/lhc-core-interceptors/auth.rb
 - lib/lhc-core-interceptors/caching.rb
 - lib/lhc-core-interceptors/monitoring.rb
 - lib/lhc-core-interceptors/version.rb
+- spec/auth/basic_auth_spec.rb
 - spec/auth/bearer_spec.rb
 - spec/caching/main_spec.rb
 - spec/caching/parameters_spec.rb
@@ -203,6 +226,7 @@ signing_key:
 specification_version: 4
 summary: A set of interceptors
 test_files:
+- spec/auth/basic_auth_spec.rb
 - spec/auth/bearer_spec.rb
 - spec/caching/main_spec.rb
 - spec/caching/parameters_spec.rb

data/cider-ci/contexts/rspec.yml

@@ -1,16 +0,0 @@
-subcontexts:
-
-  - name: 'All rspec tests'
-
-    task-defaults:
-
-      scripts:
-
-        test:
-
-          body: |
-            #!/usr/bin/env bash
-            bundle exec rspec $CIDER_CI_TASK_FILE
-
-    _cider-ci_generate-tasks:
-      include-match: spec/.*_spec.rb

data/cider-ci/jobs/tests.yml

@@ -1,27 +0,0 @@
-tests:
-
-  name: 'Tests'
-
-  run-on:
-    - type: branch
-      include-match: ^.*$
-  
-  context:
-    
-    _cider-ci_include:
-      - cider-ci/contexts/rspec.yml
-
-    task-defaults:
-
-      scripts:
-
-        bundle:
-          body: sed 's/^source.*/source "http\:\/\/52.29.7.59:9292"/g' Gemfile > Gemfile.tmp ; mv Gemfile.tmp Gemfile && bundle install
-
-        ruby-version:
-          body: ruby --version
-
-        test:
-          start-when:
-            - script: bundle
-            - script: ruby-version