putsreq 0.0.3 → 0.0.4

data/Procfile

@@ -1 +1 @@
-web: bundle exec unicorn -p $PORT -c ./config/unicorn.rb
+web: bundle exec puma -C config/puma.rb

data/README.md

@@ -10,53 +10,27 @@ Check this post: [Play Rock-paper-scissors with Slack and PutsReq](http://www.pa
 
 ### Getting Started
 
-Steps to run PutsReq in development.
-
-#### Install MongoDB
-
-```bash
-brew install mongo
-
-mongod
-```
-
-#### Start PutsReq
-
-```
-cd ~/workspace
-
-git clone git@github.com:phstc/putsreq.git
-
-cd putsreq
-
-bundle install
-
-rails s
-
-open http://localhost:3000
-```
-
 ### Response Builder
 
 The Response Builder is the place where you can create your responses using JavaScript V8.
 
-Here is the list of request attributes you can access to create your responses:
+Check the list below with the request attributes you can access to create your own responses:
 
 #### request
 
 ```javascript
 // curl -X POST -H 'X-MyHeader: MyHeaderValue' -d 'name=Pablo' https://putsreq.com/<YOUR-TOKEN>
 
-request.request_method;
+request.request_method
 // => POST
 
-request.body;
+request.body
 // => name=Pablo
 
-request.params.name;
+request.params.name
 // => Pablo
 
-request.headers['HTTP_X_MYHEADER'];
+request.headers['HTTP_X_MYHEADER']
 // => MyHeaderValue
 ```
 
@@ -65,55 +39,55 @@ Parsing a JSON request:
 ```javascript
 // curl -i -X POST -H 'Content-Type: application/json' -d '{"message":"Hello World"}' https://putsreq.com/<YOUR-TOKEN>
 
-var parsedBody = JSON.parse(request.body);
+var parsedBody = JSON.parse(request.body)
 
-parsedBody.message;
+parsedBody.message
 // => Hello World
 ```
 
 #### response
 
 ```javascript
-response.status  = 200;  // default value
-response.headers = {};   // default value
-response.body    = 'ok'; // default value
+response.status = 200 // default value
+response.headers = {} // default value
+response.body = 'ok' // default value
 ```
 
 Returning a JSON response:
 
 ```javascript
-response.headers['Content-Type'] = 'application/json';
+response.headers['Content-Type'] = 'application/json'
 
-response.body = { 'message': 'Hello World' };
+response.body = { message: 'Hello World' }
 ```
 
 #### forwardTo
 
-If you only want to log your requests, you can use PutsReq as a proxy to forward them.
+If you only want to log your requests, you can use PutsReq just as a proxy for your requests.
 
 ```javascript
-request.forwardTo = 'http://example.com/api';
+request.forwardTo = 'http://example.com/api'
 ```
 
-You can also modify the requests before forwarding them.
+But you can always modify requests before forwarding them.
 
 ```javascript
 // add or change a header
 request.headers['X-MyNewHeader'] = 'MyHeaderValue'
 
-var parsedBody = JSON.parse(request.body);
+var parsedBody = JSON.parse(request.body)
 
 // add or change a value
-parsedBody['my_new_key'] = 'my new value';
+parsedBody['my_new_key'] = 'my new value'
 
-request.body = parsedBody;
+request.body = parsedBody
 
-request.forwardTo = 'http://example.com/api';
+request.forwardTo = 'http://example.com/api'
 ```
 
 ### CLI
 
-Want to test Webhook calls against your localhost? PutsReq makes it easy!
+Do want to test Webhook calls against your localhost? PutsReq makes it easy!
 
 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.
 
@@ -159,6 +133,37 @@ PutsReq supports [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_shar
 
 https://github.com/phstc/putsreq_integration_sample
 
+### Steps to run PutsReq in development
+
+For following the instructions below, you will need to install [Docker](https://www.docker.com/get-docker).
+
+```shell
+cd ~/workspace
+
+git clone git@github.com:phstc/putsreq.git
+
+docker-compose up -d
+
+open http://localhost:3000
+
+docker-compose logs --follow --tail=100 app
+```
+
+#### Running tests
+
+```shell
+docker-compose run app bundle exec rspec
+```
+
+### Production
+
+In production (Heroku), PutsReq runs on mLab sandbox, with a storage of 500 MB. For avoiding exceeding the capacity, the `requests` and `responses` collections must be converted into capped collections.
+
+```javascript
+db.runCommand({ convertToCapped: 'requests', size: 15000000 })
+db.runCommand({ convertToCapped: 'responses', size: 15000000 })
+```
+
 ### License
 
 Please see [LICENSE](https://github.com/phstc/putsreq/blob/master/LICENSE) for licensing details.

data/Rakefile

@@ -1,7 +1,7 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require File.expand_path('config/application', __dir__)
 
 PutsReq::Application.load_tasks
 

data/app/assets/javascripts/application.js

@@ -15,7 +15,7 @@
 //= require bootstrap
 //= require jquery.tipsy
 //= require clipboard
-//= require favico.js
+//= require favico.js.js
 //
 //= require ace/ace
 //= require ace/theme-chrome

data/app/assets/javascripts/buckets.js.coffee

@@ -2,7 +2,6 @@ App.buckets = {}
 
 App.buckets['share'] = App.buckets['show'] = ->
   App.buckets.initializeAce()
-  RequestCountPoller.start()
 
   tipsyConfig = title: 'Copy to Clipboard', copiedHint: 'Copied!'
 
@@ -14,7 +13,7 @@ App.buckets['share'] = App.buckets['show'] = ->
   clipboard.on 'success', ->
     $copyButton.prop('title', tipsyConfig.copiedHint).tipsy('show')
     $copyButton.attr('original-title', tipsyConfig.title)
-
+    
 App.buckets.initializeAce = ->
   autoResizeAce = ->
     # http://stackoverflow.com/questions/11584061/
@@ -47,22 +46,3 @@ App.buckets.initializeAce = ->
   # Whenever a change happens inside the ACE editor, update
   # the size again
   editor.getSession().on 'change', autoResizeAce
-
-RequestCountPoller =
-  start: ->
-    favicon = new Favico(bgColor: '#6C92C8', animation: 'none')
-    favicon.badge($('#bucket-request-count').text())
-
-    bucket = $('#putsreq-url-input').data('bucket-token')
-
-    pusher = new Pusher('3466d56fe2ef1fdd2943')
-    channel = pusher.subscribe("channel_requests_#{bucket}")
-    channel.bind 'new', (data) ->
-      try
-        $('#bucket-request-count').text(data.count)
-
-        favicon.badge(data.count)
-      catch error
-
-      $('#new-requests-info').hide().
-        html('<em><a id="new-requests-received" href="javascript:window.location.reload();">New requests found. Load newer requests?</a></em>').fadeIn('slow')

data/app/assets/stylesheets/{application.css → application.scss}

@@ -8,8 +8,9 @@
  * You're free to add application-wide styles to this file and they'll appear at the top of the
  * compiled file, but it's generally better to create a new file per style scope.
  *
- *= require bootstrap
  *= require tipsy
  *= require_self
  *= require_tree .
  */
+@import "bootstrap-sprockets";
+@import "bootstrap";

data/app/assets/stylesheets/buckets.css.scss

@@ -64,9 +64,7 @@
 }
 .requests-header tbody tr:hover td{background:#d0dafd;}
 .history {
-  float: right;
   background-color: #eee;
-  margin: 0 0 0 20px;
   padding: 10px;
   border-left: 3px solid #428bca;
 }

data/app/controllers/application_controller.rb

@@ -1,9 +1,7 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
 
-  helper_method :owner?, :body_as_string, :headers_as_string
+  helper_method :bucket, :owner?, :body_as_string, :headers_as_string
 
   before_action :configure_permitted_parameters, if: :devise_controller?
 
@@ -54,6 +52,8 @@ class ApplicationController < ActionController::Base
   end
 
   def owner?(bucket)
+    return true unless bucket.user
+
     owner_token == bucket.owner_token || (user_signed_in? && bucket.user == current_user)
   end
 
@@ -62,14 +62,16 @@ class ApplicationController < ActionController::Base
   end
 
   def bucket
-    @bucket ||= Bucket.find_by(token: params[:token])
+    @_bucket ||= CreateOrRetrieveBucket.call!(
+      token: params[:token],
+      owner_token: owner_token,
+      user_id: (current_user.id if user_signed_in?)
+    ).bucket
   end
 
   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) do  |u|
-      u.permit(:name, :email, :password, :password_confirmation, :current_password)
-    end
+    devise_parameter_sanitizer.permit(:sign_up, keys: %i[name email password password_confirmation remember_me])
+    devise_parameter_sanitizer.permit(:sign_in, keys: %i[name email password remember_me])
+    devise_parameter_sanitizer.permit(:account_update, keys: %i[name email password password_confirmation current_password])
   end
 end

data/app/controllers/buckets_controller.rb

@@ -1,24 +1,25 @@
 class BucketsController < ApplicationController
   skip_before_action :verify_authenticity_token, only: :record
 
-  before_filter :check_ownership!, only: %i(clear destroy update)
+  before_action :check_ownership!, only: %i[clear destroy update]
 
-  def create
-    new_bucket = { owner_token: owner_token }
-    new_bucket[:user_id] = current_user.id if user_signed_in?
-
-    bucket = Bucket.create(new_bucket)
+  def requests_count
+    render json: { requests_count: bucket.requests.count }
+  end
 
+  def create
     redirect_to bucket_path(bucket.token)
   end
 
   def fork
-    forked_bucket = Bucket.create(owner_token:       owner_token,
-                                  response_builder:  bucket.response_builder,
-                                  name:              "Copy of #{bucket.name}",
-                                  fork:              bucket)
-
-    redirect_to bucket_path(forked_bucket.token)
+    fork = Bucket.create(
+      owner_token: owner_token,
+      response_builder: bucket.response_builder,
+      name: "Copy of #{bucket.name}",
+      fork: bucket
+    )
+
+    redirect_to bucket_path(fork.token)
   end
 
   def clear
@@ -34,14 +35,19 @@ class BucketsController < ApplicationController
   end
 
   def show
-    @requests = bucket.requests.page(params[:page]).per 1
+    bucket.request = bucket.requests.page(params[:page]).per(1).first
+
+    respond_to do |format|
+      format.html { render }
+      format.json { render json: bucket, serializer: BucketSerializer }
+    end
   end
 
   def update
     update_bucket = bucket_params
     update_bucket[:user_id] = current_user.id if user_signed_in?
 
-    bucket.update_attributes update_bucket
+    bucket.update update_bucket
 
     redirect_to bucket_path(bucket.token)
   end
@@ -50,7 +56,7 @@ class BucketsController < ApplicationController
     return render_request_not_found unless last_request = bucket.last_request
 
     respond_to do |format|
-      format.html { render text: last_request.body }
+      format.html { render plain: last_request.body }
       format.json { render json: JSON.pretty_generate(last_request.attributes) }
     end
   end
@@ -59,7 +65,7 @@ class BucketsController < ApplicationController
     return render_request_not_found unless last_response = bucket.last_response
 
     respond_to do |format|
-      format.html { render text: last_response.body }
+      format.html { render plain: last_response.body }
       format.json { render json: JSON.pretty_generate(last_response.attributes) }
     end
   end
@@ -70,7 +76,7 @@ class BucketsController < ApplicationController
 
     response.headers.merge! recorded_response.headers.to_h
 
-    render text: body_as_string(recorded_response),
+    render plain: body_as_string(recorded_response),
            status: recorded_response.status
   end
 
@@ -79,7 +85,7 @@ class BucketsController < ApplicationController
   def render_request_not_found
     respond_to do |format|
       format.html { redirect_to bucket_path(bucket.token), alert: 'Please submit a request first' }
-      format.json { render nothing: true, status: 404 }
+      format.json { head :not_found }
     end
   end
 

data/app/controllers/home_controller.rb

@@ -1,10 +1,10 @@
 class HomeController < ApplicationController
   def index
-    if user_signed_in?
-      selector = Bucket.or([user: current_user], [owner_token: owner_token])
-    else
-      selector = Bucket.where(owner_token: owner_token)
-    end
+    selector = if user_signed_in?
+                 Bucket.or([user: current_user], [owner_token: owner_token])
+               else
+                 Bucket.where(owner_token: owner_token)
+               end
 
     @buckets = selector.order(:created_at.desc).limit(20)
 

data/app/controllers/requests_controller.rb

@@ -1,10 +1,21 @@
 class RequestsController < ApplicationController
+  def index
+    bucket = Bucket.find_by(token: params[:token])
+
+    requests = bucket.requests
+    requests = requests.gt(id: params[:last_request_id]) if params[:last_request_id].present?
+    requests = requests.limit(25).order(:id.asc)
+    requests = requests.map(&:attributes)
+
+    render json: JSON.generate(requests)
+  end
+
   def show
     request = Request.find(params[:id])
 
     respond_to do |format|
-      format.html { render text: request.body }
+      format.html { render plain: request.body }
       format.json { render json: JSON.pretty_generate(request.attributes) }
     end
   end
-end
+end

data/app/helpers/application_helper.rb

@@ -1,6 +1,6 @@
 module ApplicationHelper
   def dispatcher_route
-    controller_name = controller_path.gsub(/\//, "_")
+    controller_name = controller_path.gsub(/\//, '_')
     "#{controller_name}##{action_name}"
   end
 
@@ -8,7 +8,11 @@ module ApplicationHelper
     "#{request.protocol}#{request.host_with_port}/#{token}"
   end
 
-  def show_no_requests_found(bucket)
+  def show_no_requests_found(_bucket)
     content_tag(:p, 'No requests found.')
   end
+
+  def requests_recorded
+    number_with_delimiter(Rails.cache.fetch('requests_recorded', raw: true) { 0 })
+  end
 end