rack-unix_domain_socket_status 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 48e9c316275ff281bd9a9fe846e129bf1f4a0fa6
+  data.tar.gz: 7d3d49b04b3a87816421c50bbcc017820a96ead2
+SHA512:
+  metadata.gz: da8a8bb3170137de949a81d81312fc5c608d2ad85b32052380571c40094e57d5f410e0a3b1678e84d4fe1fda5df72fb573babefa90730e8ba8ea908852a41c86
+  data.tar.gz: b8142738ea553985b2ef21b3b1bff37b4c258a6171d8fcd28cc18535cb545fc6dd7a5f5ffb4189f922bcfa80100183cabb299c33fa7ba6da46cec6a26b7b9720

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-unix_domain_socket_status.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end
+group :test do
+  gem 'rack'
+  #gem 'coveralls', require: false
+  gem 'rspec'
+  gem 'simplecov', require: false
+  gem 'simplecov-rcov', require: false
+  gem 'timecop'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 SpringMT
+
+MIT License
+
+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,31 @@
+# Rack::UnixDomainSocketStatus
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-unix_domain_socket_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-unix_domain_socket_status
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rack-unix_domain_socket_status/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :test do
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+end

data/lib/rack/unix_domain_socket_status.rb

@@ -0,0 +1,52 @@
+require 'json'
+
+module Rack
+  class UnixDomainSocketStatus
+    def initialize(app, options={})
+      @app = app
+      raw_unix_domain_socket_path = options.delete(:unix_domain_socket_path) || raise('unix_domain_socket_path is required')
+      @unix_domain_socket_path    = Regexp.escape raw_unix_domain_socket_path.force_encoding(Encoding::BINARY)
+      @proc_net_unix_path         = options.delete(:proc_net_unix_path) || '/proc/net/unix'
+      @options = {
+        path:  '/unix_status',
+        status: 200,
+        headers: {'Content-Type' => 'application/json'},
+      }.merge(options)
+      @enable = ::File.exist? @proc_net_unix_path
+    end
+
+    def call(env)
+      if @enable && env['PATH_INFO'] == @options[:path]
+        status = @options[:status]
+        body = [calculate_unix_domain_socket_status]
+        headers = @options[:headers]
+        [status, headers, body]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+    # DO NOT ALLOW nil unix_domain_socket_path
+    # https://github.com/torvalds/linux/blob/master/include/uapi/linux/net.h#L47
+    #
+    def calculate_unix_domain_socket_status
+      # label in /proc/net/unix
+      #         Num: RefCount Protocol Flags Type St Inode Path
+      paths = /^\w+: \d+ 00000000 \d+ \d+ (\d+) \d+ #{@unix_domain_socket_path}$/n
+
+      queued = 0
+      active = 0
+      # no point in pread since we can't stat for size on this file
+      ::File.read(*[@proc_net_unix_path].push({encoding: 'binary'})).scan(paths) do |s|
+        case s[0].to_i
+        when 2 then queued += 1 # SS_CONNECTING
+        when 3 then active += 1 # SS_CONNECTED
+        end
+      end
+      {active: active, queued: queued, total: active + queued}.to_json
+    end
+
+  end
+end
+

data/rack-unix_domain_socket_status.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-unix_domain_socket_status"
+  spec.version       = "0.0.1"
+  spec.authors       = ["SpringMT"]
+  spec.email         = ["today.is.sky.blue.sky@gmail.com"]
+  spec.summary       = %q{Check for unix domain socket usage}
+  spec.description   = %q{Check for unix domain socket usage}
+  spec.homepage      = "https://github.com/SpringMT/rack-unix_domain_socket_status"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/rack-unix_domain_socket_status_spec.rb

@@ -0,0 +1,44 @@
+require 'json'
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Rack::UnixDomainSocketStatus do
+  app = lambda { |env|
+    [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]]
+  }
+
+  context 'confirm to Rack::Lint' do
+    subject do
+      Rack::Lint.new( Rack::UnixDomainSocketStatus.new(app, {unix_domain_socket_path: 'test.sock', proc_net_unix_path: 'tmp/dummy_unix'}) )
+    end
+    it do
+      response = Rack::MockRequest.new(subject).get('/')
+      expect(response.body).to eq 'Hello, World!'
+    end
+    it do
+      response = Rack::MockRequest.new(subject).get('/unix_status')
+      expect(response.body).to eq({active: 0, queued: 0, total: 0}.to_json)
+    end
+  end
+
+  context 'change path' do
+    subject do
+      Rack::Lint.new( Rack::UnixDomainSocketStatus.new(app, {unix_domain_socket_path: 'test.sock', proc_net_unix_path: 'tmp/dummy_unix', path: '/us'}) )
+    end
+    it do
+      response = Rack::MockRequest.new(subject).get('/us')
+      expect(response.body).to eq({active: 0, queued: 0, total: 0}.to_json)
+    end
+  end
+
+  context 'NOT exist proc_net_unix' do
+    subject do
+      Rack::Lint.new( Rack::UnixDomainSocketStatus.new(app, {unix_domain_socket_path: 'test.sock', proc_net_unix_path: 'tmp/hoge'}) )
+    end
+    it do
+      response = Rack::MockRequest.new(subject).get('/unix_status')
+      expect(response.body).to eq 'Hello, World!'
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'simplecov'
+require 'simplecov-rcov'
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib/rack/')
+require 'rack/unix_domain_socket_status'
+
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: rack-unix_domain_socket_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- SpringMT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Check for unix domain socket usage
+email:
+- today.is.sky.blue.sky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/unix_domain_socket_status.rb
+- rack-unix_domain_socket_status.gemspec
+- spec/rack-unix_domain_socket_status_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SpringMT/rack-unix_domain_socket_status
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Check for unix domain socket usage
+test_files:
+- spec/rack-unix_domain_socket_status_spec.rb
+- spec/spec_helper.rb