passenger_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c96538b9f4c72d79d7c4951a498b812d4cf9efc0
-  data.tar.gz: c1af38bf1c52e7f04107f42a246202720fcb4539
+SHA256:
+  metadata.gz: d3981d1dcd88cc9810839a91a11c255c7746e25e646123102d376f9dbd5d6423
+  data.tar.gz: 18398b956c362efd2acf4bef2e3bc612f68b6c4cea81a82ece4675e420c305a0
 SHA512:
-  metadata.gz: 9b4f4fa6a7a82860e5b1a2a9a0606e9c227aee498bd29cd126d34856857ffaa04cac99bb3fd6957c06eb833c618493a80c3b77928619d19588e1c519e0c722f2
-  data.tar.gz: f87b4528041e5440bccc496cb32be3a24b326d430d12cec725b5847a73170c8150dae5908d23cd51e58a01beddcc96ef4d8e7bc62af8efb3d9bc0da0528a5edf
+  metadata.gz: 3f56efa6ddd0a5d968b634d28ef96bf280ce5b1763f8aa9cd02d898ff907328245d0be89c0157d05847506cee5e5b0245ee612c274499ea01978defed26ea4b5
+  data.tar.gz: e16c1c5d88c21380b20eb67dc12552345a40e6984289d5dd3ff8d8481ec698cc7c1611033448f44737c3653f96743a572e3bd5e1613bad238530e015372d9641

data/.dockerignore

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

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.travis.yml

@@ -4,7 +4,7 @@ language: ruby
 
 rvm:
   - 2
-  - 1.8
+  - 2.2
 
 install:
   - bundle install --jobs=3 --retry=3

data/Appraisals

@@ -1,17 +1,21 @@
 # frozen_string_literal: true
 
-appraise 'passenger-5.0.10' do
-  gem 'passenger', '5.0.10'
+appraise 'passenger-5.0.22' do
+  gem 'passenger', '5.0.22'
 end
 
 appraise 'passenger-5.0' do
-  gem 'passenger', '~> 5.0.10'
+  gem 'passenger', '~> 5.0.23'
 end
 
-appraise 'passenger-5.1.0' do
-  gem 'passenger', '5.1.0'
+appraise 'passenger-5.1' do
+  gem 'passenger', '~> 5.1'
 end
 
-appraise 'passenger-5.1' do
-  gem 'passenger', '~> 5.1.0'
+appraise 'passenger-5.2' do
+  gem 'passenger', '~> 5.2'
+end
+
+appraise 'passenger-5.3' do
+  gem 'passenger', '~> 5.3'
 end

data/Dockerfile

@@ -0,0 +1,32 @@
+FROM ruby
+
+WORKDIR /app
+
+COPY pkg/passenger_api-*.gem ./
+RUN set -eux; \
+	gem install passenger_api-*.gem; \
+	passenger-config install-standalone-runtime; \
+	passenger-config build-native-support
+
+#RUN set -eux; \
+#	gem install passenger_api; \
+#	passenger-config install-standalone-runtime; \
+#	passenger-config build-native-support
+
+
+
+
+FROM ruby:slim
+
+CMD ["passenger_api"]
+EXPOSE 3000
+WORKDIR /app
+
+ENV \
+	PASSENGER_APP_ENV=production \
+	PASSENGER_MAX_POOL_SIZE=2 \
+	PASSENGER_MIN_INSTANCES=2 \
+	PASSENGER_DISABLE_SECURITY_UPDATE_CHECK=true \
+	PASSENGER_LOG_FILE=/dev/stdout
+
+COPY --from=0 /usr/local/bundle /usr/local/bundle

data/Gemfile

@@ -7,15 +7,4 @@ 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
+gem 'rubocop', '0.49.1'

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    passenger_api (0.2.0)
+      passenger (>= 5.0.22)
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    docile (1.3.1)
+    json (2.1.0)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    passenger (5.3.1)
+      rack
+      rake (>= 0.8.1)
+    powerpack (0.1.1)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    unicode-display_width (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  passenger_api!
+  rack-test
+  rake (~> 10.0)
+  rubocop (= 0.49.1)
+  simplecov
+
+BUNDLED WITH
+   1.16.2

data/README.md

@@ -2,31 +2,69 @@
 
 PassengerAPI is a Rack application to access Passenger internal APIs.
 
+[![Gem Version](https://badge.fury.io/rb/passenger_api.svg)](https://badge.fury.io/rb/passenger_api)
 [![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
+## Usage
 
-Add this line to your application's Gemfile:
+Run PassengerAPI:
 
-```ruby
-gem 'passenger_api'
+```
+gem install passenger_api
+passenger_api
 ```
 
-## Usage
+or
+
+```
+docker run --rm -v /tmp:/tmp -p 3000:3000 m4i0/passenger_api
+```
 
-Add this line to your application's config.ru:
+Run your application:
 
-```ruby
-map('/passenger') { run PassengerAPI.new }
+```
+passenger start -p 3001
 ```
 
 Then, access API.
 
 ```
-$ passenger start -d
-$ curl localhost:3000/passenger/pool.txt
+$ curl -s localhost:3000/ping.json | jq .
+[
+  {
+    "instance": {
+      "instance_dir": {
+        "created_at": 1527877456,
+        "created_at_monotonic_usec": 8184689115911,
+        "major_version": 4,
+        "minor_version": 0,
+        "path": "/tmp/passenger.VWzMe1k"
+      },
+      "instance_id": "p9npsg-ojQFlj-pTG7Y9",
+      "integration_mode": "standalone",
+      "name": "XELqenPb",
+      "passenger_version": "5.3.1",
+      "server_software": "nginx/1.14.0 Phusion_Passenger/5.3.1",
+      "standalone_engine": "nginx",
+      "watchdog_pid": 186,
+      "core_pid": 189,
+      "state": "good"
+    },
+    "status": 200,
+    "header": {
+      "Status": "200 OK",
+      "Content-Type": "application/json",
+      "Date": "Fri, 01 Jun 2018 18:29:08 +0000",
+      "Connection": "keep-alive",
+      "Content-Length": "18"
+    },
+    "body": "{ \"status\": \"ok\" }"
+  }
+]
+
+$ curl -s localhost:3000/pool.txt | jq '.[].body' -r
 ----------- General information -----------
 Max pool size : 6
 App groups    : 1
@@ -39,6 +77,46 @@ Requests in top-level queue : 0
   Requests in queue: 0
   * PID: 25915   Sessions: 1       Processed: 3       Uptime: 30s
     CPU: 0%      Memory  : 7M      Last used: 0s ago
+
+$ curl -s localhost:3000/pool.xml | jq '.[].body' -r | xmllint --format -
+<?xml version="1.0" encoding="iso8859-1"?>
+<info version="3">
+  <passenger_version>5.3.1</passenger_version>
+  <group_count>1</group_count>
+  <process_count>1</process_count>
+  <max>6</max>
+  <capacity_used>1</capacity_used>
+  <get_wait_list_size>0</get_wait_list_size>
+  <supergroups>
+(snip)
+  </supergroups>
+</info>
+```
+
+Multiple instances:
+
+```
+$ docker run -d --rm -v /tmp/a:/tmp/a phusion/passenger-ruby25 passenger start --instance-registry-dir /tmp/a
+$ docker run -d --rm -v /tmp/b:/tmp/b phusion/passenger-ruby25 passenger start --instance-registry-dir /tmp/b
+$ docker run -d --rm -v /tmp/c:/tmp/c phusion/passenger-ruby25 passenger start --instance-registry-dir /tmp/c
+$ curl -sH 'X-Passenger-Instance-Registry-Dir: /tmp/*' localhost:3000/ping.json | jq .
+[
+  {
+(snip)
+        "path": "/tmp/b/passenger.1kGFpF5"
+(snip)
+  },
+  {
+(snip)
+        "path": "/tmp/a/passenger.P5HNi8e"
+(snip)
+  },
+  {
+(snip)
+        "path": "/tmp/c/passenger.6oU9Cgi"
+(snip)
+  }
+]
 ```
 
 Passenger internal APIs are undocumented. If you want to know about them, please see https://github.com/phusion/passenger/issues/1407.
@@ -55,7 +133,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/m4i/pa
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 

data/config.ru

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'passenger_api'
+
+run PassengerAPI.new

data/exe/passenger_api

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+rackup = File.expand_path('../config.ru', __dir__)
+ARGV.unshift(*%W[start --instance-registry-dir /var/run --rackup #{rackup}])
+load Gem.bin_path('passenger', 'passenger')

data/lib/passenger_api.rb

@@ -1,38 +1,66 @@
 # frozen_string_literal: true
 
-require 'passenger_api/request'
 require 'passenger_api/version'
 
-class PassengerAPI
-  def initialize
-    require 'passenger_api/ext'
-  end
+require 'json'
+require 'net/http'
 
+require 'rack/request'
+
+unless defined?(PhusionPassenger)
+  require 'phusion_passenger'
+  PhusionPassenger.locate_directories
+end
+PhusionPassenger.require_passenger_lib('admin_tools/instance_registry')
+
+class PassengerAPI
   def call(env)
-    to_rack_response(call_api(build_argv(Request.new(env))))
+    rack_request = Rack::Request.new(env)
+    case rack_request.path
+    when '/health'
+      [200, { 'Content-Type' => 'text/plain' }, ["OK\n"]]
+    else
+      proxy_api(rack_request)
+    end
   end
 
   private
 
-  def build_argv(req)
-    argv = [req.method, req.path]
-    argv << '--data' << req.body unless req.body.empty?
-    argv
-  end
+  def proxy_api(rack_request)
+    dir = rack_request.get_header('HTTP_X_PASSENGER_INSTANCE_REGISTRY_DIR')
+    instances = PhusionPassenger::AdminTools::InstanceRegistry.new(dir).list
+    net_http_request = convert_rack_request_to_net_http_request(rack_request)
 
-  def call_api(argv)
-    argv += ['--show-headers']
-    catch :response do
-      PhusionPassenger::Config::ApiCallCommand.new(argv).run
+    responses = instances.map do |instance|
+      build_response(instance, call_api(instance, net_http_request))
     end
+
+    [200, { 'Content-Type' => 'application/json' }, [responses.to_json]]
+  end
+
+  def build_response(instance, net_http_response)
+    {
+      instance: instance.as_json.merge(state: instance.state),
+      status:   net_http_response.code.to_i,
+      header:   net_http_response.each_capitalized.to_h,
+      body:     net_http_response.body,
+    }
   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 }
+  def call_api(instance, net_http_request)
+    net_http_request.basic_auth('admin', instance.full_admin_password)
+    instance.http_request('agents.s/core_api', net_http_request)
+  end
 
-    [res.code, headers, [res.body]]
+  def convert_rack_request_to_net_http_request(rack_request)
+    klass = Net::HTTP.const_get(rack_request.request_method.capitalize)
+    header = {}
+    if rack_request.content_type
+      header['Content-Type'] = rack_request.content_type
+    end
+    net_http_request = klass.new(rack_request.fullpath, header)
+    body = rack_request.body.read
+    net_http_request.body = body unless body.empty?
+    net_http_request
   end
 end

data/lib/passenger_api/version.rb

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

data/passenger_api.gemspec

@@ -15,18 +15,21 @@ Gem::Specification.new do |spec|
   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)/})
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.required_ruby_version = '>= 2.2.2'
 
-  spec.add_dependency 'passenger', '>= 5.0.10'
+  spec.add_dependency 'passenger', '>= 5.0.22'
+  spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'appraisal'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passenger_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masaki Takeuchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2018-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: passenger
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.10
+        version: 5.0.22
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.10
+        version: 5.0.22
+- !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.15'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +125,8 @@ dependencies:
 description: PassengerAPI is a Rack application to access Passenger internal APIs.
 email:
 - m.ishihara@gmail.com
-executables: []
+executables:
+- passenger_api
 extensions: []
 extra_rdoc_files: []
 files:
@@ -121,15 +136,17 @@ files:
 - ".travis.yml"
 - Appraisals
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- config.ru
+- exe/passenger_api
 - 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
@@ -144,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -152,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A Rack application to access Passenger internal APIs

data/lib/passenger_api/ext.rb

@@ -1,19 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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