passenger_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c96538b9f4c72d79d7c4951a498b812d4cf9efc0
+  data.tar.gz: c1af38bf1c52e7f04107f42a246202720fcb4539
+SHA512:
+  metadata.gz: 9b4f4fa6a7a82860e5b1a2a9a0606e9c227aee498bd29cd126d34856857ffaa04cac99bb3fd6957c06eb833c618493a80c3b77928619d19588e1c519e0c722f2
+  data.tar.gz: f87b4528041e5440bccc496cb32be3a24b326d430d12cec725b5847a73170c8150dae5908d23cd51e58a01beddcc96ef4d8e7bc62af8efb3d9bc0da0528a5edf

data/.dockerignore

@@ -0,0 +1,6 @@
+.bundle
+.git
+Gemfile.lock
+coverage
+gemfiles
+vendor

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/gemfiles/
+/vendor/

data/.rubocop.yml

@@ -0,0 +1,63 @@
+AllCops:
+  EnabledByDefault: true
+  TargetRubyVersion: 2.4
+
+### customize
+
+Layout/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+
+Metrics/LineLength:
+  IgnoredPatterns:
+    - '^ +spec\.(summary|description) +='
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/LambdaCall:
+  EnforcedStyle: braces
+
+Style/HashSyntax:
+  Exclude:
+    - "**/Rakefile"
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+### disabled
+
+Lint/UnneededSplatExpansion:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: false
+
+Style/MissingElse:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/VariableInterpolation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,30 @@
+dist: trusty
+sudo: false
+language: ruby
+
+rvm:
+  - 2
+  - 1.8
+
+install:
+  - bundle install --jobs=3 --retry=3
+  - appraisal install
+
+before_script:
+  - |
+    if [ "$TRAVIS_PULL_REQUEST" = false -a "$TRAVIS_RUBY_VERSION" = 2 ]; then
+      curl -fL -o cc-test-reporter \
+        https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+      chmod +x cc-test-reporter
+    fi
+
+script:
+  - if [ -e cc-test-reporter ]; then export COVERAGE=true; fi
+  - appraisal rake
+  - if [ "$TRAVIS_RUBY_VERSION" = 2 ]; then rubocop -DES; fi
+
+after_script:
+  - |
+    if [ -e cc-test-reporter ]; then
+      ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+    fi

data/Appraisals

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+appraise 'passenger-5.0.10' do
+  gem 'passenger', '5.0.10'
+end
+
+appraise 'passenger-5.0' do
+  gem 'passenger', '~> 5.0.10'
+end
+
+appraise 'passenger-5.1.0' do
+  gem 'passenger', '5.1.0'
+end
+
+appraise 'passenger-5.1' do
+  gem 'passenger', '~> 5.1.0'
+end

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 m.ishihara@gmail.com. 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,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in passenger_api.gemspec
+gemspec
+
+if RUBY_VERSION > '2.0'
+  gem 'rubocop', '0.49.1'
+end
+
+if RUBY_VERSION < '2.3'
+  gem 'rack', '< 2'
+end
+
+if RUBY_VERSION < '1.9'
+  gem 'json'
+  gem 'rack-test', '< 0.7'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Masaki Takeuchi
+
+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,62 @@
+# PassengerAPI
+
+PassengerAPI is a Rack application to access Passenger internal APIs.
+
+[![Build Status](https://travis-ci.org/m4i/passenger_api.svg?branch=master)](https://travis-ci.org/m4i/passenger_api)
+[![Test Coverage](https://codeclimate.com/github/m4i/passenger_api/badges/coverage.svg)](https://codeclimate.com/github/m4i/passenger_api/coverage)
+[![Code Climate](https://codeclimate.com/github/m4i/passenger_api/badges/gpa.svg)](https://codeclimate.com/github/m4i/passenger_api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'passenger_api'
+```
+
+## Usage
+
+Add this line to your application's config.ru:
+
+```ruby
+map('/passenger') { run PassengerAPI.new }
+```
+
+Then, access API.
+
+```
+$ passenger start -d
+$ curl localhost:3000/passenger/pool.txt
+----------- General information -----------
+Max pool size : 6
+App groups    : 1
+Processes     : 1
+Requests in top-level queue : 0
+
+----------- Application groups -----------
+/app/public (development):
+  App root: /app
+  Requests in queue: 0
+  * PID: 25915   Sessions: 1       Processed: 3       Uptime: 30s
+    CPU: 0%      Memory  : 7M      Last used: 0s ago
+```
+
+Passenger internal APIs are undocumented. If you want to know about them, please see https://github.com/phusion/passenger/issues/1407.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 GitHub at https://github.com/m4i/passenger_api. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PassengerAPI project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/m4i/passenger_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'passenger_api'
+
+# 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/lib/passenger_api.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'passenger_api/request'
+require 'passenger_api/version'
+
+class PassengerAPI
+  def initialize
+    require 'passenger_api/ext'
+  end
+
+  def call(env)
+    to_rack_response(call_api(build_argv(Request.new(env))))
+  end
+
+  private
+
+  def build_argv(req)
+    argv = [req.method, req.path]
+    argv << '--data' << req.body unless req.body.empty?
+    argv
+  end
+
+  def call_api(argv)
+    argv += ['--show-headers']
+    catch :response do
+      PhusionPassenger::Config::ApiCallCommand.new(argv).run
+    end
+  end
+
+  def to_rack_response(res)
+    # for Ruby 1.8.7
+    # headers = res.each_capitalized.to_h
+    headers = {}
+    res.each_capitalized { |n, v| headers[n] = v }
+
+    [res.code, headers, [res.body]]
+  end
+end

data/lib/passenger_api/ext.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+unless defined?(PhusionPassenger)
+  require 'phusion_passenger'
+  PhusionPassenger.locate_directories
+end
+PhusionPassenger.require_passenger_lib 'config/api_call_command'
+
+module PhusionPassenger
+  module Config
+    class ApiCallCommand
+      private
+
+      def print_headers(response)
+        throw :response, response
+      end
+    end
+  end
+end

data/lib/passenger_api/request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class PassengerAPI
+  class Request
+    def initialize(env)
+      @env = env
+    end
+
+    def method
+      @env['REQUEST_METHOD']
+    end
+
+    def path
+      path = @env['PATH_INFO']
+      path = '/' if path.empty?
+      path += "?#{@env['QUERY_STRING']}" unless @env['QUERY_STRING'].empty?
+      path
+    end
+
+    def body
+      @_body ||= @env['rack.input'].read
+    end
+  end
+end

data/lib/passenger_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class PassengerAPI
+  VERSION = '0.1.0'
+end

data/passenger_api.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'passenger_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'passenger_api'
+  spec.version       = PassengerAPI::VERSION
+  spec.authors       = ['Masaki Takeuchi']
+  spec.email         = ['m.ishihara@gmail.com']
+
+  spec.summary       = 'A Rack application to access Passenger internal APIs'
+  spec.description   = 'PassengerAPI is a Rack application to access Passenger internal APIs.'
+  spec.homepage      = 'https://github.com/m4i/passenger_api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.8.7'
+
+  spec.add_dependency 'passenger', '>= 5.0.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: passenger_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masaki Takeuchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: passenger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: 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: appraisal
+  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: rack-test
+  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: simplecov
+  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: PassengerAPI is a Rack application to access Passenger internal APIs.
+email:
+- m.ishihara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/passenger_api.rb
+- lib/passenger_api/ext.rb
+- lib/passenger_api/request.rb
+- lib/passenger_api/version.rb
+- passenger_api.gemspec
+homepage: https://github.com/m4i/passenger_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Rack application to access Passenger internal APIs
+test_files: []