ruby_inspector 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cc62aa2145cbcc7a866417af8336e4938191bde
+  data.tar.gz: 9140911db39e45b9b73bbb59f8ae8fcf008590b2
+SHA512:
+  metadata.gz: 6c45ff6e7d390b47ada436aa0a21e6db621fee5efa6b221d264a7d9a7ade3e33cd7c09af0573967280e353b0bdd1bb7b5466eb2d4e1e8d86554b5576534ec774
+  data.tar.gz: fdf89ce39c7efa9c11ced6fabf6b8cc2a5a5e99855c07c092c4ab008d048122da39f4bd2a01c196032e08e87c7e031dd11efa9e957b9ac846ff30d387d6d9766

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_inspector.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Max Brosnahan
+
+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,18 @@
+# Ruby Inspector
+
+Allows for ruby apps to be debugged using the standard chrome developer tools
+
+# Getting started
+
+1. Get a copy of [chrome devtools app](https://github.com/auchenberg/chrome-devtools-app)
+2. Setup and start [ruby_inspector_server](https://github.com/gingermusketeer/ruby_inspector_server)
+3. Run `ruby demo.rb`
+4. Connect the devtools app to your app. apps -> Go
+5. Unleash the app from the breakpoint
+6. Monitor http traffic
+
+
+# Todo
+- Start the server automatically in the background unless it is started (server.pid?)
+- Pull the tcp socket port from the node app (socket.port?)
+- Add ruby script debugging via byebug

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ruby_inspector'
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nsa/net_http_tracker.rb

@@ -0,0 +1,97 @@
+require 'net/http'
+
+module Nsa
+  class NetHttpTracker
+    class<<self
+      def on_request(&block)
+        if block_given?
+          @on_request = block
+        else
+          @on_request
+        end
+      end
+    end
+
+    attr_reader :protocol, :address, :port, :path, :method, :request_headers,
+      :request_body, :status_code, :status_message, :response_headers,
+      :response_body
+
+    def initialize(protocol, address, port, path, method, headers, body)
+      @protocol = protocol
+      @address = address
+      @port = port
+      @path = path
+      @method = method
+      @request_headers = headers
+      @request_body = body
+      self.class.on_request.call(self)
+    end
+
+    def url
+      "#{protocol}://#{address}#{path}"
+    end
+
+    def on_response(&block)
+      if block_given?
+        @on_response = block
+      else
+        @on_response
+      end
+    end
+
+    def on_body(&block)
+      if block_given?
+        @on_body = block
+      else
+        @on_body
+      end
+    end
+
+    def set_response_info(status_code, status_message, headers)
+      @status_code = status_code
+      @status_message = status_message
+      @response_headers = headers
+      on_response.call
+    end
+
+    def response_body=(body)
+      @response_body = body
+      on_body.call
+    end
+  end
+end
+
+module Net
+  class HTTP
+    alias_method(:orig_request, :request) unless method_defined?(:orig_request)
+    alias_method(:orig_connect, :connect) unless method_defined?(:orig_connect)
+
+    def request(req, request_body = nil, &block)
+      return orig_request(req, request_body, &block) unless started?
+      protocol = use_ssl? ? 'https' : 'http'
+      request_headers = Hash[req.each_header.to_a]
+      request_tracker = ::Nsa::NetHttpTracker.new(
+        protocol, @address, @port, req.path, req.method, request_headers,
+        request_body || req.body
+      )
+
+      response_body = ''
+      block_provided = block_given?
+      response = orig_request(req, request_body) do |resp|
+        resp.read_body { |str| response_body << str }
+        resp.define_singleton_method(:read_body) do |dest = nil, &block|
+          dest << response_body unless dest.nil?
+          block.call(response_body) unless block.nil?
+          response_body
+        end
+        block.call(resp) if block_provided
+      end
+
+      request_tracker.set_response_info(
+        response.code, response.message, Hash[response.each_header.to_a]
+      )
+      request_tracker.response_body = response_body
+      response
+    end
+  end
+end

data/lib/ruby_inspector.rb

@@ -0,0 +1,43 @@
+require 'ruby_inspector/version'
+
+require 'json'
+require_relative './nsa/net_http_tracker'
+require_relative './ruby_inspector/dev_tools_request_tracker'
+
+module RubyInspector
+  DELIMITER = "\0"
+  class << self
+    def enable(app_name, description = '')
+      connect
+      send_init_info(app_name, description)
+
+      ::Nsa::NetHttpTracker.on_request do |net_http_request_tracker|
+        DevToolsRequestTracker.new(net_http_request_tracker)
+      end
+    end
+
+    def send_info(data)
+      socket.puts(
+        ::JSON.generate(data) + DELIMITER
+      )
+    end
+
+    private
+
+    attr_accessor :socket
+    def connect
+      @socket = TCPSocket.new('localhost', 8124)
+    end
+
+    def send_init_info(app_name, description)
+      send_info(
+        method: 'RubyInspector.initialize',
+        params: {
+          name: app_name,
+          type: :ruby,
+          description: description
+        }
+      )
+    end
+  end
+end

data/lib/ruby_inspector/dev_tools_request_tracker.rb

@@ -0,0 +1,75 @@
+module RubyInspector
+  class DevToolsRequestTracker
+    def self.next_request_id
+      @current_request_id ||= 0
+      @current_request_id += 1
+    end
+
+    attr_reader :request_id, :request_tracker
+
+    def initialize(request_tracker)
+      @request_tracker = request_tracker
+      @request_id = self.class.next_request_id.to_s
+      notify_request_started
+      request_tracker.on_response { notify_response_received }
+      request_tracker.on_body { notify_body_received }
+    end
+
+    def notify_request_started
+      RubyInspector.send_info(
+        method: 'Network.requestWillBeSent',
+        params: {
+          requestId: request_id,
+          request: {
+            url: request_tracker.url,
+            method: request_tracker.method,
+            headers: request_tracker.request_headers,
+            postData: request_tracker.request_body
+          },
+          timestamp: Time.now.to_f,
+          type: 'Other'
+        }
+      )
+    end
+
+    def notify_response_received
+      RubyInspector.send_info(
+        method: 'Network.responseReceived',
+        params: {
+          requestId: request_id,
+          timestamp: Time.now.to_f,
+          type: 'Document',
+          response: {
+            url: request_tracker.url,
+            status: request_tracker.status_code,
+            statusText: request_tracker.status_message,
+            headers: request_tracker.response_headers,
+            mimeType: 'text/html',
+            requestHeaders: request_tracker.request_headers,
+            remotePort: request_tracker.port
+          }
+        }
+      )
+    end
+
+    def notify_body_received
+      RubyInspector.send_info(
+        method: 'RubyInspector.network.cacheBody',
+        params: { requestId: request_id },
+        result: {
+          body: request_tracker.response_body,
+          base64Encoded: false
+        }
+      )
+
+      RubyInspector.send_info(
+        method: 'Network.loadingFinished',
+        params: {
+          requestId: request_id,
+          timestamp: Time.now.to_f,
+          encodedDataLength: request_tracker.response_body.length
+        }
+      )
+    end
+  end
+end

data/lib/ruby_inspector/version.rb

@@ -0,0 +1,3 @@
+module RubyInspector
+  VERSION = '0.1.0'
+end

data/ruby_inspector.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_inspector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby_inspector'
+  spec.version       = RubyInspector::VERSION
+  spec.authors       = ['Max Brosnahan']
+  spec.email         = ['maximilianbrosnahan@gmail.com']
+
+  spec.summary       = 'Debugging ruby with chrome devtools'
+  spec.homepage      = 'https://github.com/gingermusketeer/ruby_inspector'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rack', '~> 1.6'
+  spec.add_development_dependency 'thin', '~> 1.6'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: ruby_inspector
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Brosnahan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- maximilianbrosnahan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nsa/net_http_tracker.rb
+- lib/ruby_inspector.rb
+- lib/ruby_inspector/dev_tools_request_tracker.rb
+- lib/ruby_inspector/version.rb
+- ruby_inspector.gemspec
+homepage: https://github.com/gingermusketeer/ruby_inspector
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Debugging ruby with chrome devtools
+test_files: []
+has_rdoc: