ruby_inspector 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc62aa2145cbcc7a866417af8336e4938191bde
-  data.tar.gz: 9140911db39e45b9b73bbb59f8ae8fcf008590b2
+  metadata.gz: 670502b3bdc8ae5edb3e41ef19b8805968ff8d16
+  data.tar.gz: c48ecf4cc661be9eb3573281f8f8f49dd46f86df
 SHA512:
-  metadata.gz: 6c45ff6e7d390b47ada436aa0a21e6db621fee5efa6b221d264a7d9a7ade3e33cd7c09af0573967280e353b0bdd1bb7b5466eb2d4e1e8d86554b5576534ec774
-  data.tar.gz: fdf89ce39c7efa9c11ced6fabf6b8cc2a5a5e99855c07c092c4ab008d048122da39f4bd2a01c196032e08e87c7e031dd11efa9e957b9ac846ff30d387d6d9766
+  metadata.gz: 364f57553733876bf6c734561a35393aa0b333639987255115298b0c7da05dc958be6e9e1141874080716d115579f1293f0ca76db1c803760f65815f0d19dc41
+  data.tar.gz: 276838235ea7b152b870b2b94306487e42ed8421aeac07daebbc4a0f2a272b513351611670b2ada9fd69554a4261d060c8a78f4aa9590cf27e82242b8fd7e579

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
   - 2.0.0
+  - 2.1.5
+  - 2.2.0

data/Gemfile

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

data/History.md

@@ -0,0 +1,8 @@
+
+0.2.0 / 2015-02-28
+==================
+  * Improve code style consistency
+  * Handle socket not being able to connect initially
+  * Improve test coverage
+  * Add travis-ci integration (2.0.0, 2.1.5, 2.2.0)
+  * Tweak readme

data/README.md

@@ -1,15 +1,23 @@
-# Ruby Inspector
+# RubyInspector ![](https://travis-ci.org/gingermusketeer/ruby_inspector.svg?branch=master)
 
 Allows for ruby apps to be debugged using the standard chrome developer tools
 
+# Demo
+
+![RubyInspector demo gif](https://raw.githubusercontent.com/gingermusketeer/ruby_inspector/master/readme/demo.gif)
+
+See [RubyInspector demos](https://github.com/gingermusketeer/ruby_inspector_demos) for more examples
+
 # 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
+3. Add `gem 'ruby_inspector'` to your gem file
+4. Add `RubyInspector.enable("MyAppName", "Optional description")` to enable monitoring
+5. Add a breakpoint before the network requests are made
+6. Connect the devtools app to your app. apps -> Go
+7. Unleash the app from the breakpoint
+8. Monitor http traffic
 
 
 # Todo

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'ruby_inspector'
+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.
@@ -10,5 +10,5 @@ require 'ruby_inspector'
 # require 'pry'
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/lib/nsa/net_http_tracker.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require "net/http"
 
 module Nsa
   class NetHttpTracker
@@ -68,14 +68,14 @@ module Net
 
     def request(req, request_body = nil, &block)
       return orig_request(req, request_body, &block) unless started?
-      protocol = use_ssl? ? 'https' : 'http'
+      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 = ''
+      response_body = ""
       block_provided = block_given?
       response = orig_request(req, request_body) do |resp|
         resp.read_body { |str| response_body << str }

data/lib/ruby_inspector.rb

@@ -1,43 +1,66 @@
-require 'ruby_inspector/version'
-
-require 'json'
-require_relative './nsa/net_http_tracker'
-require_relative './ruby_inspector/dev_tools_request_tracker'
+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)
+    def enable(app_name, description)
+      @app_name = app_name
+      @description = description
+
+      begin
+        send_init_info
+      rescue Errno::ECONNREFUSED
+        puts "[RubyInspector] Unable to send initialization info during setup"
+      end
 
       ::Nsa::NetHttpTracker.on_request do |net_http_request_tracker|
         DevToolsRequestTracker.new(net_http_request_tracker)
       end
     end
 
+    def disable
+      @socket = nil
+      @initialized = nil
+    end
+
     def send_info(data)
-      socket.puts(
-        ::JSON.generate(data) + DELIMITER
-      )
+      send_init_info unless initialized?
+      send_socket_msg(data)
+    rescue Errno::ECONNREFUSED
+      puts "[RubyInspector] Unable to send data: #{data}"
     end
 
     private
 
-    attr_accessor :socket
-    def connect
-      @socket = TCPSocket.new('localhost', 8124)
+    attr_accessor :app_name, :description
+
+    def initialized?
+      @initialized
+    end
+
+    def socket
+      @socket ||= TCPSocket.new("localhost", 8124)
+    end
+
+    def send_socket_msg(data)
+      socket.puts(
+        ::JSON.generate(data) + DELIMITER
+      )
     end
 
-    def send_init_info(app_name, description)
-      send_info(
-        method: 'RubyInspector.initialize',
+    def send_init_info
+      send_socket_msg(
+        method: "RubyInspector.initialize",
         params: {
           name: app_name,
           type: :ruby,
           description: description
         }
       )
+      @initialized = true
     end
   end
 end

data/lib/ruby_inspector/dev_tools_request_tracker.rb

@@ -17,7 +17,7 @@ module RubyInspector
 
     def notify_request_started
       RubyInspector.send_info(
-        method: 'Network.requestWillBeSent',
+        method: "Network.requestWillBeSent",
         params: {
           requestId: request_id,
           request: {
@@ -27,24 +27,24 @@ module RubyInspector
             postData: request_tracker.request_body
           },
           timestamp: Time.now.to_f,
-          type: 'Other'
+          type: "Other"
         }
       )
     end
 
     def notify_response_received
       RubyInspector.send_info(
-        method: 'Network.responseReceived',
+        method: "Network.responseReceived",
         params: {
           requestId: request_id,
           timestamp: Time.now.to_f,
-          type: 'Document',
+          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',
+            mimeType: "text/html",
             requestHeaders: request_tracker.request_headers,
             remotePort: request_tracker.port
           }
@@ -54,7 +54,7 @@ module RubyInspector
 
     def notify_body_received
       RubyInspector.send_info(
-        method: 'RubyInspector.network.cacheBody',
+        method: "RubyInspector.network.cacheBody",
         params: { requestId: request_id },
         result: {
           body: request_tracker.response_body,
@@ -63,7 +63,7 @@ module RubyInspector
       )
 
       RubyInspector.send_info(
-        method: 'Network.loadingFinished',
+        method: "Network.loadingFinished",
         params: {
           requestId: request_id,
           timestamp: Time.now.to_f,

data/lib/ruby_inspector/version.rb

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

data/ruby_inspector.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   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 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rack', '~> 1.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_inspector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Brosnahan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-02-21 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
 - .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
+- History.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -101,6 +102,7 @@ files:
 - lib/ruby_inspector.rb
 - lib/ruby_inspector/dev_tools_request_tracker.rb
 - lib/ruby_inspector/version.rb
+- readme/demo.gif
 - ruby_inspector.gemspec
 homepage: https://github.com/gingermusketeer/ruby_inspector
 licenses: