basic_auth_mark 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2abf3c18b8f658f8a7f7cdece883a2dc7e8b3a9
+  data.tar.gz: 142fd71d74eae229c6026312d2f0fd6b91483266
+SHA512:
+  metadata.gz: 091f6db80e37bf312431c2313438f7aa3efb768dd1a52455214071340b29d7edf428c1a6eb124439ca12317cca86b917808c4c0a28af05441623c4a59ff120d5
+  data.tar.gz: e82ff03b4af82c064ae15d3609f755d89dad000f2f02f5cfc9b554ba99c7dfb221d69a0dcdf5fb5356235607fb79f027d796fae786cae039ed8fe976c18a6b45

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+*.gem

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ozawa@giftee.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 kazuki.ozawa
+
+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,43 @@
+# BasicAuthMark
+Show Github Ribbon when you use Basic Authenticaiton.
+
+## Installation
+
+### Rails App
+All you have to do is to include the Gem
+```ruby
+gem "basic_auth_mark"
+```
+
+## Configuring
+### Change Ribbon Position
+#### Rails App
+In `config/environments/#{environment}.rb`
+
+```ruby
+Rails.application.configure do
+  # ...
+  config.basic_auth_mark.position = 'left-bottom' # left-top/right-top/left-bottom/right-bottom
+end
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/g-ozawa/basic_auth_mark. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the BasicAuthMark project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/g-ozawa/basic_auth_mark/blob/master/CODE_OF_CONDUCT.md).
+
+## Acknowledgements
+- [rack-dev-mark](https://github.com/dtaniwaki/rack-dev-mark) got a lot of inspiration from this gem
+- [github-fork-ribbon-css](https://github.com/simonwhitaker/github-fork-ribbon-css) for github-ribbon-css
+
+## Copyright
+Copyright © 2019 Kazuki Ozawa.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/basic_auth_mark.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "basic_auth_mark/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "basic_auth_mark"
+  spec.version       = BasicAuthMark::VERSION
+  spec.authors       = ["kazuki ozawa"]
+  spec.email         = ["kazuki.ozawa@outlook.jp"]
+
+  spec.summary       = %q{Check Whether HTTP Basic Authentication is enabled or not.}
+  spec.description   = %q{Check Whether HTTP Basic Authentication is enabled or not.}
+  spec.homepage      = 'https://github.com/g-ozawa/basic_auth_mark'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rack'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/basic_auth_mark/mark.rb

@@ -0,0 +1,24 @@
+# Thanks to https://github.com/simonwhitaker/github-fork-ribbon-css
+
+module BasicAuthMark
+  class Mark
+    def initialize
+    end
+
+    def insert_into(html)
+      position = BasicAuthMark.position
+
+      style_tag_str = <<-EOS
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/github-fork-ribbon-css/0.2.2/gh-fork-ribbon.min.css" />
+      EOS
+
+      div_tag_str = <<-EOS
+<div class="github-fork-ribbon #{position}" onClick="this.style.display='none'" data-ribbon="BASIC AUTH"></div>
+      EOS
+
+      html
+        .sub(%r{(</head>)}i, "#{style_tag_str.strip}\\1")
+        .sub(%r{(<body[^>]*>)}i, "\\1#{div_tag_str.strip}")
+    end
+  end
+end

data/lib/basic_auth_mark/middleware.rb

@@ -0,0 +1,41 @@
+module BasicAuthMark
+  class Middleware
+    include Rack::Utils
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      return [status, headers, response] unless headers['Content-Type'].to_s =~ %r{\btext/html\b}i
+      return [status, headers, response] if status >= 300 && status < 400
+
+      request = Rack::Auth::Basic::Request.new(env)
+      if request.provided? && request.basic?
+        new_body = ''
+        response.each do |b|
+          begin
+            new_body << insert_basic_auth_marks(b)
+          rescue => exception
+            $stderr.write %Q|Failed to insert basic auth marks: #{exception.message}\n  #{exception.backtrace.join("  \n")}|
+          end
+        end
+        response.close if response.respond_to?(:close)
+        headers['Content-Length'] &&= new_body.bytesize.to_s
+        response = [new_body]
+      end
+
+      [status, headers, response]
+    end
+
+    private
+
+    def insert_basic_auth_marks(body)
+      mark = BasicAuthMark::Mark.new
+      body = mark.insert_into(body)
+      body
+    end
+  end
+end

data/lib/basic_auth_mark/railtie.rb

@@ -0,0 +1,16 @@
+require 'rails'
+
+module BasicAuthMark
+  class Railtie < Rails::Railtie
+    initializer "basic_auth_mark.insert_middleware" do |app|
+      app.config.middleware.use(BasicAuthMark::Middleware)
+    end
+
+    config.basic_auth_mark = ActiveSupport::OrderedOptions.new
+
+    config.after_initialize do
+      options = config.basic_auth_mark
+      BasicAuthMark.position = options.position if options.position
+    end
+  end
+end

data/lib/basic_auth_mark/version.rb

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

data/lib/basic_auth_mark.rb

@@ -0,0 +1,17 @@
+require 'rack'
+require 'basic_auth_mark/mark'
+require 'basic_auth_mark/middleware'
+require "basic_auth_mark/version"
+require 'basic_auth_mark/railtie' if defined?(Rails)
+
+module BasicAuthMark
+  class << self
+    def position
+      @position ||= 'right-top'
+    end
+
+    def position=(position)
+      @position = position
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: basic_auth_mark
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kazuki ozawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    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: 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: Check Whether HTTP Basic Authentication is enabled or not.
+email:
+- kazuki.ozawa@outlook.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- basic_auth_mark.gemspec
+- lib/basic_auth_mark.rb
+- lib/basic_auth_mark/mark.rb
+- lib/basic_auth_mark/middleware.rb
+- lib/basic_auth_mark/railtie.rb
+- lib/basic_auth_mark/version.rb
+homepage: https://github.com/g-ozawa/basic_auth_mark
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Check Whether HTTP Basic Authentication is enabled or not.
+test_files: []