union_station_hooks_core 1.0.0

data/lib/union_station_hooks_core/utils.rb

@@ -0,0 +1,161 @@
+#  Union Station - https://www.unionstationapp.com/
+#  Copyright (c) 2010-2015 Phusion Holding B.V.
+#
+#  "Union Station" and "Passenger" are trademarks of Phusion Holding B.V.
+#
+#  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.
+
+require 'base64'
+
+module UnionStationHooks
+  # Various utility methods.
+  #
+  # @private
+  module Utils
+    extend self # Make methods available as class methods.
+
+    def self.included(klass)
+      # When included into another class, make sure that Utils
+      # methods are made private.
+      public_instance_methods(false).each do |method_name|
+        klass.send(:private, method_name)
+      end
+    end
+
+    def require_key(options, key)
+      if !options.key?(key)
+        raise ArgumentError, "Option #{key.inspect} is required"
+      end
+    end
+
+    def require_non_empty_key(options, key)
+      value = options[key]
+      if value.nil? || value.empty?
+        raise ArgumentError, "Option #{key.inspect} is required " \
+          'and must be non-empty'
+      else
+        value
+      end
+    end
+
+    def get_socket_address_type(address)
+      if address =~ %r{^unix:.}
+        :unix
+      elsif address =~ %r{^tcp://.}
+        :tcp
+      else
+        :unknown
+      end
+    end
+
+    def connect_to_server(address)
+      case get_socket_address_type(address)
+      when :unix
+        UNIXSocket.new(address.sub(/^unix:/, ''))
+      when :tcp
+        host, port = address.sub(%r{^tcp://}, '').split(':', 2)
+        port = port.to_i
+        TCPSocket.new(host, port)
+      else
+        raise ArgumentError, "Unknown socket address type for '#{address}'."
+      end
+    end
+
+    def local_socket_address?(address)
+      case get_socket_address_type(address)
+      when :unix
+        return true
+      when :tcp
+        host, _port = address.sub(%r{^tcp://}, '').split(':', 2)
+        host == '127.0.0.1' || host == '::1' || host == 'localhost'
+      else
+        raise ArgumentError, "Unknown socket address type for '#{address}'."
+      end
+    end
+
+    def encoded_timestamp(time = Time.now)
+      timestamp = time.to_i * 1_000_000 + time.usec
+      timestamp.to_s(36)
+    end
+
+    if Base64.respond_to?(:strict_encode64)
+      def base64(data)
+        Base64.strict_encode64(data)
+      end
+    else
+      # Base64-encodes the given data. Newlines are removed.
+      # This is like `Base64.strict_encode64`, but also works
+      # on Ruby 1.8 which doesn't have that method.
+      def base64(data)
+        result = Base64.encode64(data)
+        result.delete!("\n")
+        result
+      end
+    end
+
+    def process_ust_router_reply(channel, error_description,
+                                 error_class = RuntimeError,
+                                 unexpected_error_class = RuntimeError)
+      result = channel.read
+      if result.nil?
+        raise unexpected_error_class,
+          "#{error_description}: UstRouter did not send a reply"
+      end
+      process_ust_router_reply_message(result, error_description,
+        error_class, unexpected_error_class)
+      result
+    end
+
+    def process_ust_router_reply_message(message, error_description,
+                                         error_class = RuntimeError,
+                                         unexpected_error_class = RuntimeError)
+      if message[0] != 'status'
+        raise unexpected_error_class,
+          "#{error_description}: expected UstRouter to respond with " \
+          "'status', but got #{message.inspect} instead"
+      end
+
+      if message[1] == 'error'
+        if message[2]
+          raise error_class, "#{error_description}: #{message[2]}"
+        else
+          raise error_class, "#{error_description} (no server message given)"
+        end
+      elsif message[1] != 'ok'
+        raise unexpected_error_class,
+          "#{error_description}: expected UstRouter to respond with " \
+          "'ok' or 'error', but got #{message.inspect} instead"
+      end
+    end
+
+    if defined?(PhusionPassenger::NativeSupport)
+      def process_times
+        PhusionPassenger::NativeSupport.process_times
+      end
+    else
+      ProcessTimes = Struct.new(:utime, :stime)
+
+      def process_times
+        times = Process.times
+        ProcessTimes.new((times.utime * 1_000_000).to_i,
+          (times.stime * 1_000_000).to_i)
+      end
+    end
+  end
+end

data/lib/union_station_hooks_core/version.rb

@@ -0,0 +1,32 @@
+#  Union Station - https://www.unionstationapp.com/
+#  Copyright (c) 2010-2015 Phusion Holding B.V.
+#
+#  "Union Station" and "Passenger" are trademarks of Phusion Holding B.V.
+#
+#  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.
+
+
+module UnionStationHooks
+  version_file   = File.expand_path('version_data.rb', File.dirname(__FILE__))
+  version_data   = eval(File.read(version_file))
+  MAJOR_VERSION  = version_data[:major]
+  MINOR_VERSION  = version_data[:minor]
+  TINY_VERSION   = version_data[:tiny]
+  VERSION_STRING = version_data[:string]
+end

data/lib/union_station_hooks_core/version_data.rb

@@ -0,0 +1,44 @@
+#  Union Station - https://www.unionstationapp.com/
+#  Copyright (c) 2010-2015 Phusion Holding B.V.
+#
+#  "Union Station" and "Passenger" are trademarks of Phusion Holding B.V.
+#
+#  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.
+
+# This file contains union_station_hook_core's version number. It is meant
+# to be read and evaluated by the gemspec. We do not define any functions or
+# modules here because we need to support the following situation:
+#
+# 1. Passenger loads its vendored union_station_hooks_* gems. This defines
+#    various modules.
+# 2. The app specified union_station_hooks_* gems in its Gemfile, which
+#    indicates that it wants to override Passenger's vendored
+#    union_station_hooks_* gems with its own versions. This will cause Bundler
+#    to load union_station_hooks_*.gemspec.
+#
+# To make the gemspecs load properly and without affecting the already-loaded
+# union_station_hooks_* gems code, we must not define any functions or modules
+# here.
+
+{
+  :major  => 1,
+  :minor  => 0,
+  :tiny   => 0,
+  :string => '1.0.0'
+}

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: union_station_hooks_core
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hongli Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-09 00:00:00.000000000 Z
+dependencies: []
+description: Union Station Ruby hooks core code.
+email: info@phusion.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/union_station_hooks_core.rb
+- lib/union_station_hooks_core/api.rb
+- lib/union_station_hooks_core/connection.rb
+- lib/union_station_hooks_core/context.rb
+- lib/union_station_hooks_core/lock.rb
+- lib/union_station_hooks_core/log.rb
+- lib/union_station_hooks_core/message_channel.rb
+- lib/union_station_hooks_core/request_reporter.rb
+- lib/union_station_hooks_core/request_reporter/basics.rb
+- lib/union_station_hooks_core/request_reporter/controllers.rb
+- lib/union_station_hooks_core/request_reporter/misc.rb
+- lib/union_station_hooks_core/request_reporter/view_rendering.rb
+- lib/union_station_hooks_core/spec_helper.rb
+- lib/union_station_hooks_core/time_point.rb
+- lib/union_station_hooks_core/transaction.rb
+- lib/union_station_hooks_core/utils.rb
+- lib/union_station_hooks_core/version.rb
+- lib/union_station_hooks_core/version_data.rb
+homepage: https://github.com/phusion/union_station_hooks_core
+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: Union Station Ruby hooks core code
+test_files: []
+has_rdoc: