putsreq 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d06503d7f311af6ea6889c942724186869f9f40
-  data.tar.gz: 35f4b09443af29f865ab6b27492aa3f98d6a5b07
+  metadata.gz: d16ff759b8282f7cb2d4488a019d6631dac732a3
+  data.tar.gz: e7b1e5d40ac369a8a3060701343d772c092db96d
 SHA512:
-  metadata.gz: 32c23e0ad1396408aa4353a32b402a1dabd145e2069354a51fc91742aef9f9257f4fb79042f6a57e274136fbfdea64776f2cc68acce25c7f8a8955451437b4f7
-  data.tar.gz: 43c51f6fc3337fa44e126c265564d9af1d208489aeb6cbe83ad2b7ce937ee27158d36bc45d7917abc2136f3277ae33747d07a570863999df261e7f50eefbc0ea
+  metadata.gz: 0ac7b3f2361a504d38e929713f4a438e4fcbee4aacd15016bac9c296733e8647fadf56d438b781c0799d086d4a20ae3626317de520dfbebcc3785e1a0b04764e
+  data.tar.gz: 094d545c5baca272fbd54c40d1fd13d53ebb0c06c11ebcc328b260d3ad83d99f8e7552bcd4d211e4d86deae8f12e525240852d337ef77771f6307f12a7fdff9a

data/README.md

@@ -113,12 +113,15 @@ request.forwardTo = 'http://example.com/api';
 
 ### CLI
 
-Want to test a Webhook calls against your localhost? PutsReq makes it easy!
+Want to test Webhook calls against your localhost? PutsReq makes it easy!
 
-```shell
+You can think of it, as a kind of [ngrok](http://ngrok.io), but instead of creating a tunnel to your localhost, PutsReq polls requests from `YOUR-PUTSREQ-TOKEN` and forwards to your localhost.
+
+```bash
 gem install putsreq
 
 putsreq forward --to http://localhost:3000 --token YOUR-TOKEN
+
 Listening requests from YOUR-TOKEN
 Forwarding to http://localhost:3000
 Press CTRL+c to terminate

data/app/controllers/application_controller.rb

@@ -3,19 +3,57 @@ class ApplicationController < ActionController::Base
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
 
-  helper_method :is_owner?
+  helper_method :owner?, :body_as_string, :headers_as_string
 
   before_action :configure_permitted_parameters, if: :devise_controller?
 
   protected
 
-  def check_ownership!
-    unless is_owner?(bucket)
-      redirect_to bucket_path(bucket.token), alert: 'Only the bucket owner can perform this operation'
+  def body_as_string(req_or_res)
+    body = req_or_res.body
+
+    if body_json?(req_or_res) && body.is_a?(String)
+      # See https://github.com/phstc/putsreq/issues/31#issuecomment-271681249
+      return JSON.pretty_generate(JSON.parse(body))
+    end
+
+    if body.is_a?(Hash)
+      # For responses body can be a hash
+      # body.to_h because body can be a BSON::Document
+      # which for some reason does format well with
+      # pretty_generate
+      return JSON.pretty_generate(body.to_h)
+    end
+
+    if body.is_a?(Array)
+      # see https://github.com/phstc/putsreq/issues/33
+      return JSON.pretty_generate(body.to_a)
+    end
+
+    body.to_s
+  rescue
+    body.to_s
+  end
+
+  def headers_as_string(req_or_res)
+    JSON.pretty_generate(req_or_res.headers.to_h)
+  end
+
+  def body_json?(req_or_res)
+    req_or_res.headers.to_h.each do |key, value|
+      return !!(value =~ /application\/json/i) if key =~ /^content-type$/i
     end
+
+    false
   end
 
-  def is_owner?(bucket)
+  def check_ownership!
+    return if owner?(bucket)
+
+    redirect_to bucket_path(bucket.token), alert: 'Only the bucket owner can perform this operation'
+  end
+
+  def owner?(bucket)
     owner_token == bucket.owner_token || (user_signed_in? && bucket.user == current_user)
   end
 
@@ -30,6 +68,8 @@ class ApplicationController < ActionController::Base
   def configure_permitted_parameters
     devise_parameter_sanitizer.for(:sign_up) { |u| u.permit(:name, :email, :password, :password_confirmation, :remember_me) }
     devise_parameter_sanitizer.for(:sign_in) { |u| u.permit(:name, :email, :password, :remember_me) }
-    devise_parameter_sanitizer.for(:account_update) { |u| u.permit(:name, :email, :password, :password_confirmation, :current_password) }
+    devise_parameter_sanitizer.for(:account_update) do  |u|
+      u.permit(:name, :email, :password, :password_confirmation, :current_password)
+    end
   end
 end

data/app/controllers/buckets_controller.rb

@@ -1,7 +1,7 @@
 class BucketsController < ApplicationController
   skip_before_action :verify_authenticity_token, only: :record
 
-  before_filter :check_ownership!, only: %i[clear destroy update]
+  before_filter :check_ownership!, only: %i(clear destroy update)
 
   def create
     new_bucket = { owner_token: owner_token }
@@ -70,7 +70,8 @@ class BucketsController < ApplicationController
 
     response.headers.merge! recorded_response.headers.to_h
 
-    render text: recorded_response.body_as_string, status: recorded_response.status
+    render text: body_as_string(recorded_response),
+           status: recorded_response.status
   end
 
   private

data/app/controllers/requests_controller.rb

@@ -0,0 +1,10 @@
+class RequestsController < ApplicationController
+  def show
+    request = Request.find(params[:id])
+
+    respond_to do |format|
+      format.html { render text: request.body }
+      format.json { render json: JSON.pretty_generate(request.attributes) }
+    end
+  end
+end

data/app/interactors/forward_request.rb

@@ -17,7 +17,6 @@ class ForwardRequest
   private
 
   def forward_to(built_request, forward_url)
-
     options = { timeout: 5,
                 headers: built_request['headers'],
                 body: body }

data/app/models/bucket.rb

@@ -17,7 +17,7 @@ class Bucket
   index owner_token: 1
   index fork_id: 1
 
-  index({ updated_at: 1 }, { expire_after_seconds: 1.month })
+  index({ updated_at: 1 }, expire_after_seconds: 1.month)
 
   before_create :generate_token
 

data/app/models/request.rb

@@ -20,12 +20,12 @@ class Request
 
   after_create :bump_requests_recorded
 
-  def body_as_string
-    body.is_a?(Hash) ? JSON.pretty_generate(body) : body.to_s
-  end
+  def path
+    return unless url
+
+    u = URI(url)
 
-  def headers_as_string
-    JSON.pretty_generate(headers.to_h)
+    url.gsub(/.*#{Regexp.escape(u.host)}(\:#{Regexp.escape(u.port.to_s)})?/, '')
   end
 
   private

data/app/models/response.rb

@@ -9,14 +9,9 @@ class Response
   field :headers, type: Hash, default: { 'Content-Type' => 'text/plain' }
   field :status, type: Integer, default: 200
 
-  # index created_at: 1, options { expireAfterSeconds: 604800 }
   index bucket_id: 1, created_at: -1
   index request_id: 1
 
   validates :bucket, presence: true
   validates :request,  presence: true
-
-  def body_as_string
-    body.is_a?(Hash) ? JSON.pretty_generate(body) : body.to_s
-  end
 end

data/app/views/buckets/_form.html.erb

@@ -24,10 +24,10 @@
   <div id="editor" name="editor" style="width: 100%; height: 150px"></div>
   <textarea id="response_builder" name="response_builder" style="display:none;"></textarea>
   <p>
-    <% if is_owner?(@bucket) %>
+    <% if owner?(@bucket) %>
       <%= render 'buttons' %>
     <% else %>
       <%= render 'readonly_buttons' %>
     <% end %>
   </p>
-<% end %>
+<% end %>

data/app/views/buckets/_requests.html.erb

@@ -1,3 +1,4 @@
+<!-- request id: <%= recorded_request.id %> -->
 <div class="panel-group request-show" id="accordion" role="tablist" aria-multiselectable="true">
   <div class="panel panel-default">
     <span class="pull-right label label-info"  title="<%= recorded_request.created_at.utc %>"><%= time_ago_in_words recorded_request.created_at %> ago</span>
@@ -10,7 +11,7 @@
     </div>
     <div id="collapseOne" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingOne">
       <div class="panel-body">
-        <pre><%= simple_format recorded_request.headers_as_string %></pre>
+        <pre><%= headers_as_string(recorded_request) %></pre>
       </div>
     </div>
   </div>
@@ -18,13 +19,13 @@
     <div class="panel-heading" role="tab" id="headingTwo">
       <h4 class="panel-title">
         <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseTwo" aria-expanded="true" aria-controls="collapseTwo">
-          Request
+          <%= recorded_request.request_method.upcase %> <%= recorded_request.path %>
         </a>
       </h4>
     </div>
     <div id="collapseTwo" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingTwo">
       <div class="panel-body">
-        <pre><%= h recorded_request.body_as_string %></pre>
+        <pre><%= body_as_string(recorded_request) %></pre>
       </div>
     </div>
   </div>
@@ -38,7 +39,7 @@
     </div>
     <div id="collapseThree" class="panel-collapse collapse in" role="tabpanel" aria-labelledby="headingThree">
       <div class="panel-body">
-        <pre><%= h recorded_request.response.body_as_string %></pre>
+        <pre><%= body_as_string(recorded_request.response) %></pre>
       </div>
     </div>
   </div>

data/app/views/buckets/show.html.erb

@@ -43,8 +43,9 @@
         <em>First request at: <%= @bucket.first_request_at %></br>
         Last request at: <%= @bucket.last_request_at %></br>
         <% if @bucket.last_request_at - @bucket.first_request_at > 0 %>
-          From first to last: <%= distance_of_time_in_words @bucket.first_request_at, @bucket.last_request_at, include_seconds: true %>
+          From first to last: <%= distance_of_time_in_words @bucket.first_request_at, @bucket.last_request_at, include_seconds: true %></br>
         <% end %>
+        Request ID: <%= link_to @requests.first.id, request_path(id: @requests.first.id, format: :json) %>
         </em>
       </p>
     <% end %>

data/app/views/home/index.html.erb

@@ -32,7 +32,7 @@
         <h4 class="tm20">Fake responses</h4>
         <p>PutsReq is the easiest way to fake HTTP responses. You can define the response status, headers and body you want using <a href="https://github.com/phstc/putsreq#response-builder">JavaScript</a>.
         <h4 class="tm20">Forward requests</h4>
-        <p>You can easily <a href="https://github.com/phstc/putsreq#forwardto">forward requests to another URL</a>, including <a href="https://github.com/phstc/putsreq#CLI">localhost</a>.
+        <p>You can easily <a href="https://github.com/phstc/putsreq#forwardto">forward requests to another URL</a>, including <a href="https://github.com/phstc/putsreq#cli">localhost</a>.
       </section>
     </div>
   </div>

data/bin/putsreq

@@ -22,33 +22,42 @@ class PutsReqCLI < Thor
 
       p
     end
-  end
 
-  desc 'forward', 'Forward requests from PutsReq to a given URL'
-  method_option :token, desc: 'PutsReq token',   required: true
-  method_option :to,    desc: 'destination URL', required: true
-  def forward
-    trap('SIGINT', 'EXIT')
+    def subscribe_and_forward(token, to)
+      puts "Listening requests from #{token}"
+      puts "Forwarding to #{to}"
+      puts 'Press CTRL+c to terminate'
 
-    token = parse_bucket_token(options[:token])
-    to    = options[:to]
+      PusherClient.logger.level = Logger::ERROR
+
+      options = { secure: true }
+
+      socket = PusherClient::Socket.new('3466d56fe2ef1fdd2943', options)
 
-    puts "Listening requests from #{token}"
-    puts "Forwarding to #{to}"
-    puts "Press CTRL+c to terminate"
+      channel = "channel_requests_#{token}"
 
-    PusherClient.logger.level = Logger::ERROR
+      socket.subscribe(channel)
 
-    options = { secure: true }
+      socket[channel].bind('new') do |data|
+        last_request = JSON.parse(data)['request']
 
-    socket = PusherClient::Socket.new('3466d56fe2ef1fdd2943', options)
+        options = { headers:  last_request['headers'] }
 
-    channel = "channel_requests_#{token}"
+        options[:body] = last_request['body'] unless last_request['body'].to_s.empty?
 
-    socket.subscribe(channel)
+        forward_request = HTTParty.send(last_request['request_method'].downcase.to_sym,
+                                        to,
+                                        options)
 
-    socket[channel].bind('new') do |data|
-      last_request = JSON.parse(data)['request']
+        puts "#{Time.now}\t#{last_request['request_method']}\t#{forward_request.code}"
+      end
+
+      socket.connect
+    end
+
+    def forward_request(token, to, id)
+      url = "http://putsreq.com/#{token}/requests/#{id}.json"
+      last_request = HTTParty.get(url)
 
       options = { headers:  last_request['headers'] }
 
@@ -60,8 +69,23 @@ class PutsReqCLI < Thor
 
       puts "#{Time.now}\t#{last_request['request_method']}\t#{forward_request.code}"
     end
+  end
+
+  desc 'forward', 'Forward requests from PutsReq to a given URL'
+  method_option :token, desc: 'PutsReq token',   required: true
+  method_option :to,    desc: 'destination URL', required: true
+  method_option :id,    desc: 'ID to forward a single request', required: false
+  def forward
+    trap('SIGINT', 'EXIT')
+
+    token = parse_bucket_token(options[:token])
+    to    = options[:to]
 
-    socket.connect
+    if id = options[:id]
+      forward_request(token, to, id)
+    else
+      subscribe_and_forward(token, to)
+    end
   end
 
   desc 'version', 'Show version'

data/config/routes.rb

@@ -6,6 +6,7 @@ PutsReq::Application.routes.draw do
   post 'buckets' => 'buckets#create', as: :buckets
   get ':token/inspect' => 'buckets#show', as: :bucket
   get ':token/last' => 'buckets#last', as: :bucket_last
+  get ':token/requests/:id' => 'requests#show', as: :request
   get ':token/last_response' => 'buckets#last_response', as: :bucket_last_response
   put ':token/buckets' => 'buckets#update', as: :update_bucket
   match ':token' => 'buckets#record', via: :all, as: :bucket_record

data/lib/putsreq/version.rb

@@ -1,3 +1,3 @@
 module PutsReq
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/spec/models/request_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Request do
+  describe '#path' do
+    let(:path) { '/12345?name=test' }
+
+    it 'returns path' do
+      subject.url = "https://putsreq.com#{path}"
+
+      expect(subject.path).to eq path
+    end
+
+    context 'when domain with port' do
+      it 'returns path' do
+        subject.url = "http://localhost:3000#{path}"
+
+        expect(subject.path).to eq path
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: putsreq
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -72,6 +72,7 @@ files:
 - app/controllers/buckets_controller.rb
 - app/controllers/concerns/.keep
 - app/controllers/home_controller.rb
+- app/controllers/requests_controller.rb
 - app/helpers/application_helper.rb
 - app/interactors/create_request.rb
 - app/interactors/create_response.rb
@@ -161,6 +162,7 @@ files:
 - spec/interactors/eval_response_builder_spec.rb
 - spec/interactors/forward_request_spec.rb
 - spec/models/bucket_spec.rb
+- spec/models/request_spec.rb
 - spec/models/user_spec.rb
 - spec/spec_helper.rb
 - vendor/assets/javascripts/.keep
@@ -307,5 +309,6 @@ test_files:
 - spec/interactors/eval_response_builder_spec.rb
 - spec/interactors/forward_request_spec.rb
 - spec/models/bucket_spec.rb
+- spec/models/request_spec.rb
 - spec/models/user_spec.rb
 - spec/spec_helper.rb