putsreq 0.0.1

data/app/interactors/notify_count.rb

@@ -0,0 +1,15 @@
+class NotifyCount
+  include Interactor
+
+  delegate :bucket, :built_request, to: :context
+
+  def call
+    return unless ENV['PUSHER_URL']
+
+    Pusher["channel_requests_#{bucket.token}"].trigger('new',
+                                                       count: bucket.requests_count,
+                                                       request: built_request)
+  rescue => e
+    Rails.logger.error(e)
+  end
+end

data/app/interactors/record_request.rb

@@ -0,0 +1,5 @@
+class RecordRequest
+  include Interactor::Organizer
+
+  organize CreateRequest, EvalResponseBuilder, ForwardRequest, CreateResponse, NotifyCount
+end

data/app/models/bucket.rb

@@ -0,0 +1,99 @@
+class Bucket
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  has_many :forks, class_name: 'Bucket'
+
+  belongs_to :fork, class_name: 'Bucket'
+  belongs_to :user
+
+  field :token
+  field :name
+  field :owner_token
+  field :response_builder, default: -> { default_response_builder }
+  field :history_start_at, type: Time
+
+  index token: 1
+  index owner_token: 1
+  index fork_id: 1
+
+  index({ updated_at: 1 }, { expire_after_seconds: 1.month })
+
+  before_create :generate_token
+
+  def requests
+    # I couldn't make has_many + conditions work with Mongoid
+    # requests must be filtered by created_at
+    # see clear_history
+
+    Request.where(bucket_id: id).gte(created_at: history_start_at || created_at).order(:created_at.desc)
+  end
+
+  def responses
+    # I couldn't make has_many + conditions work with Mongoid
+    # responses must be filtered by created_at
+    # see clear_history
+    Response.where(bucket_id: id).gte(created_at: history_start_at || created_at).order(:created_at.desc)
+  end
+
+  def clear_history
+    # requests and responses are capped collections in production, we cannot delete docs on a capped collection
+    # so we filter these objects by the history_start_at to "clear"
+    # db.runCommand({ "convertToCapped": "requests",  size: 25000000 });
+    # db.runCommand({ "convertToCapped": "responses", size: 25000000 });
+    update_attribute :history_start_at, Time.now
+  end
+
+  def name
+    if (name = read_attribute(:name)).blank?
+      token
+    else
+      name
+    end
+  end
+
+  def last_request
+    requests.order(:created_at.desc).first
+  end
+
+  def last_response
+    responses.order(:created_at.desc).first
+  end
+
+  def last_request_at
+    last_request.try(:created_at)
+  end
+
+  def first_request_at
+    requests.order(:created_at.asc).first.try(:created_at)
+  end
+
+  def requests_count
+    requests.count
+  end
+
+  private
+
+  def generate_token
+    self.token = loop do
+      random_token = SecureRandom.urlsafe_base64(15).tr('_-', '0a')
+      break random_token unless Bucket.where(token: random_token).exists?
+    end
+  end
+
+  def default_response_builder
+    <<-DEFAULT.strip_heredoc
+      // Build a response
+      var msg = 'Hello World';
+
+      if(request.params.name) {
+        msg = 'Hello ' + request.params.name;
+      }
+
+      response.body = msg;
+
+      // Forward a request
+      // request.forwardTo = 'http://example.com/api';
+    DEFAULT
+  end
+end

data/app/models/request.rb

@@ -0,0 +1,36 @@
+class Request
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  belongs_to :bucket, touch: true
+
+  has_one :response, dependent: :delete
+
+  field :body
+  field :headers, type: Hash
+  field :content_length
+  field :request_method
+  field :ip
+  field :url
+  field :params, type: Hash
+
+  index bucket_id: 1, created_at: -1
+
+  validates :bucket, presence: true
+
+  after_create :bump_requests_recorded
+
+  def body_as_string
+    body.is_a?(Hash) ? JSON.pretty_generate(body) : body.to_s
+  end
+
+  def headers_as_string
+    JSON.pretty_generate(headers.to_h)
+  end
+
+  private
+
+  def bump_requests_recorded
+    REDIS.incr 'requests_recorded'
+  end
+end

data/app/models/response.rb

@@ -0,0 +1,22 @@
+class Response
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  belongs_to :bucket
+  belongs_to :request
+
+  field :body, default: 'ok'
+  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/models/user.rb

@@ -0,0 +1,42 @@
+class User
+  include Mongoid::Document
+  # Include default devise modules. Others available are:
+  # :confirmable, :lockable, :timeoutable and :omniauthable
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :trackable, :validatable
+
+  ## Database authenticatable
+  field :email,              type: String, default: ""
+  field :encrypted_password, type: String, default: ""
+
+  ## Recoverable
+  field :reset_password_token,   type: String
+  field :reset_password_sent_at, type: Time
+
+  ## Rememberable
+  field :remember_created_at, type: Time
+
+  ## Trackable
+  field :sign_in_count,      type: Integer, default: 0
+  field :current_sign_in_at, type: Time
+  field :last_sign_in_at,    type: Time
+  field :current_sign_in_ip, type: String
+  field :last_sign_in_ip,    type: String
+
+  ## Confirmable
+  # field :confirmation_token,   type: String
+  # field :confirmed_at,         type: Time
+  # field :confirmation_sent_at, type: Time
+  # field :unconfirmed_email,    type: String # Only if using reconfirmable
+
+  ## Lockable
+  # field :failed_attempts, type: Integer, default: 0 # Only if lock strategy is :failed_attempts
+  # field :unlock_token,    type: String # Only if unlock strategy is :email or :both
+  # field :locked_at,       type: Time
+
+  has_many :users
+
+  field :name
+
+  validates :name, presence: true
+end

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

@@ -0,0 +1,4 @@
+<button class="btn btn-primary tm10">Update</button>
+<%= link_to 'Fork', bucket_fork_path(@bucket.token), class: 'btn btn-default tm10 lm5', method: :post %>
+<%= link_to 'Clear History', bucket_clear_path(@bucket.token), class: 'btn btn-default tm10 lm5', method: :delete, data: { confirm: 'Are you sure?' } %>
+<%= link_to 'Destroy', bucket_destroy_path(@bucket.token), class: 'btn btn-default tm10 lm5', method: :delete, data: { confirm: 'Are you sure?' } %>

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

@@ -0,0 +1,33 @@
+<%= form_for @bucket, url: update_bucket_path(@bucket.token), method: :put do |f| %>
+  <%= f.hidden_field :response_builder %>
+  <script id="response-builder-container"  type='application/vns.putsreq-response_builder'><%== @bucket.response_builder %></script>
+  <div class="row">
+    <div class="col-md-6">
+      <h4>Bucket name
+      <small><em>You can change it anytime.</em></small>
+      </h4>
+      <div class="input-group putsreq-name bm30">
+        <%= f.text_field :name %>
+        <% if @bucket.fork %>
+          <p><small>forked from <%= link_to @bucket.fork.name, bucket_path(@bucket.fork.token) %></small></p>
+        <% end %>
+      </div>
+    </div>
+    <div class="col-md-6">
+      <h4>Requests
+        <small><em>The number of requests made to this bucket.</em></small>
+      </h4>
+      <h3 id="bucket-request-count"><%= @bucket.requests_count %></h3>
+    </div>
+  </div>
+  <h4>Response Builder&nbsp;<a href="https://github.com/phstc/putsreq#response-builder" target="_blank"><span class="glyphicon glyphicon-info-sign"></span></a></h4>
+  <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) %>
+      <%= render 'buttons' %>
+    <% else %>
+      <%= render 'readonly_buttons' %>
+    <% end %>
+  </p>
+<% end %>

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

@@ -0,0 +1 @@
+<%= link_to 'Fork', bucket_fork_path(@bucket.token), class: 'btn btn-primary tm10', method: :post %>

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

@@ -0,0 +1,45 @@
+<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>
+    <div class="panel-heading" role="tab" id="headingOne">
+      <h4 class="panel-title">
+        <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
+          Headers
+        </a>
+      </h4>
+    </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>
+      </div>
+    </div>
+  </div>
+  <div class="panel panel-default">
+    <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
+        </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>
+      </div>
+    </div>
+  </div>
+  <div class="panel panel-default">
+    <div class="panel-heading" role="tab" id="headingThree">
+      <h4 class="panel-title">
+        <a role="button" data-toggle="collapse" data-parent="#accordion" href="#collapseThree" aria-expanded="true" aria-controls="collapseThree">
+          Response
+        </a>
+      </h4>
+    </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>
+      </div>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,58 @@
+<% content_for :title, @bucket.name %>
+
+<ul class="nav">
+  <li class="logo"><a href="/"><%= image_tag 'logo.png' %></a></li>
+  <li><a href="<%= "/#{@bucket.token}/inspect" %>">Inspect</a></li>
+  <li><a href="<%= "/#{@bucket.token}/last" %>" title="JSON-formatted">Last Request</a></li>
+  <li><a href="<%= "/#{@bucket.token}/last_response" %>" title="JSON-formatted">Last Response</a></li>
+  <% if user_signed_in? %>
+    <li><%= link_to 'Sign out', destroy_user_session_path, method: :delete %></li>
+  <% else %>
+    <li><%= link_to 'Sign in', new_user_session_path  %></li>
+    <li><%= link_to 'Sign up', new_user_registration_path %></li>
+  <% end %>
+</ul>
+
+<section class="putsreq-url-box">
+  <h3>Your PutsReq URL</h3>
+  <div class="input-group putsreq-url">
+    <input id="putsreq-url-input" data-bucket-token="<%= @bucket.token %>" type="text" value="<%= token_url(@bucket.token) %>" readonly="readonly"></input>
+    <span id="copy-button" class="input-group-addon hastip clipboard" data-clipboard-target="#putsreq-url-input">
+      <span class="glyphicon glyphicon-link hastip"></span>
+    </span>
+  </div>
+</section>
+
+<br/><br/>
+
+<section>
+  <h4>Sample Request using cURL</h4>
+  <code>curl -i -X POST -d 'name=Pablo' <%= token_url(@bucket.token) %></code>
+</section>
+
+<hr/>
+<%= render 'form' %>
+<hr/>
+
+<p id="new-requests-info"><!-- placeholder: New requests found. Load newer requests? --></p>
+
+<div class="row">
+  <div class="col-md-6">
+    <% if @bucket.first_request_at %>
+      <p>
+        <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 %>
+        <% end %>
+        </em>
+      </p>
+    <% end %>
+  </div>
+  <div class="col-md-6"></div>
+</div>
+<p><%= paginate @requests %></p>
+<%= render(partial: 'requests', collection: @requests, as: :recorded_request) || show_no_requests_found(@bucket) %>
+<p><%= paginate @requests %></p>
+
+<script src="//js.pusher.com/2.2/pusher.min.js" type="text/javascript"></script>

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

@@ -0,0 +1,45 @@
+<div class="row">
+  <div class="span10">
+    <div class="">
+      <header>
+        <%= image_tag 'logo.png' %>
+        <h3><em>PutsReq</em> lets you record HTTP requests and simulate responses like no other tool available. Try it now!</h3>
+        <%= form_for :bucket, url: buckets_path do |f| %>
+          <button class="btn btn-primary btn-large">Create a PutsReq</button>
+          <em>
+            <% if user_signed_in? %>
+              <%= link_to 'Sign out', destroy_user_session_path, method: :delete %>
+            <% else %>
+              <%= link_to 'Sign in', new_user_session_path  %> | <%= link_to 'Sign up', new_user_registration_path %>
+            <% end %>
+          </em>
+        <% end %>
+      </header>
+      <section class="start">
+        <% if @buckets.any?  %>
+          <div class="history">
+            <h4 class="bm0 tm0">History</h4>
+            <small>View and manage your buckets:</small>
+            <ul class="tm5">
+              <% @buckets.each do |bucket| %>
+                <li><%= link_to "#{bucket.name} (#{bucket.requests_count})", bucket_path(bucket.token) %></li>
+              <% end %>
+            </ul>
+          </div>
+        <% end %>
+        <h4>Record the requests sent or received</h4>
+        <p>Change your target URL to a PutsReq URL, then you will be able to inspect all headers and body being sent.
+        You can also debug callbacks from external services by configuring a PutsReq URL instead of your Webhook URL.</p>
+        <h4 class="tm20">Simulate responses</h4>
+        <p>PutsReq is the easiest way to simulate/stub HTTP responses. You can define the response status, headers and body with JavaScript using the <a href="https://github.com/phstc/putsreq#response-builder">Response Builder</a>.
+        If you don't want to test against the real API, but you know how to simulate (mock) the response, you can do that using a Response Builder.</p>
+        <p>Some use cases:</p>
+        <ul>
+          <li>Get the real response once then create a Response Builder simulating it and use PutsReq for the next calls.</li>
+          <li>Use PutsReq for your integration tests to verify if your application is making the HTTP requests as expected <a href="https://github.com/phstc/putsreq_integration_sample/blob/master/spec/acceptance/create_user_spec.rb">by checking the last recorded request</a>.</li>
+          <li>To benchmark by checking the First and Last request timestamps, or by checking the numbers of requests made within a period.</li>
+        </ul>
+      </section>
+    </div>
+  </div>
+</div>

data/app/views/layouts/_header.html.erb

@@ -0,0 +1,18 @@
+<title><%= content_for?(:title) ? yield(:title) : 'PutsReq' %></title>
+
+<link rel="apple-touch-icon-precomposed" href="/images/favicon152.png" />
+<link rel="icon" href="/images/favicon.png" />
+<meta name="msapplication-TileColor" content="#ffffff" />
+<meta name="msapplication-TileImage" content="/images/favicon144.png" />
+<%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+<%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+<%= csrf_meta_tags %>
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-50754009-1', 'auto');
+  ga('send', 'pageview');
+</script>