better_rest 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7075c76283c5d80eaf7a1b277a64378a6564b08
-  data.tar.gz: a2565755ea3043e17f2d703a910ce1cc132fc2a6
+  metadata.gz: e391c09a3930c6c9f2d5bdcc35aedf4296109aad
+  data.tar.gz: 944d0e611bc34c43717109678ec441b4e8ff2aab
 SHA512:
-  metadata.gz: fa1d80f4cee1b2043d862f06e279ac13bbb95bc946292f5312cc9ba317230836d0d5feacd1eb9ad7e7cb21adebe7aced9434fcfd26b9c7751fe91bb430664e43
-  data.tar.gz: c8e0e912bd2b05e9cc5c5ba86d6fb6b28042c25fa29923bbab877a7b8d01c4f0632e69a3c6c143f910ad2f1d5b2280a28dc6b6bb4b52f490d407f54ecd6d6c2e
+  metadata.gz: c38a7f7355728f3dec51213ac23dc4c29ad5cb8bdd478a9ccdf671a6eb5e715d15201f3fcb5466a4332471d2331877eb5ea48c9345441820d3fac6ac333e44e3
+  data.tar.gz: 2e51051265116b638ddd25bea50ad1fbb761b81d1555011e8146aa8e7cdbbb115c31d51780deac028d3b239df5336d221aa80b77534bae90bce687ca579ba29e

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+requests
+logs
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'typhoeus'
+gem 'vegas'
+gem 'json'
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ethon (0.7.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.3)
+    json (1.8.1)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rake (10.3.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+    typhoeus (0.6.9)
+      ethon (>= 0.7.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json
+  rake
+  sinatra
+  typhoeus
+  vegas

data/README.md

@@ -1,41 +1,34 @@
-# BetteR
+# BetteR [![Build Status](https://travis-ci.org/at1as/BetteR.svg?branch=master)](https://travis-ci.org/at1as/BetteR) [![Gem Version](https://badge.fury.io/rb/better_rest.svg)](http://badge.fury.io/rb/better_rest)
 
-BetteR is a a REST testing client written in Ruby and served by Sinatra.
+BetteR is a a REST test client written in Ruby and served by Sinatra.
 
 BetteR emphasises both a clean and easy to use interface, as well as allowing users to have a very granuler control over their requests (things like following redirects, verbosity of response and timeout intervals are all configurable). The current feature set is modest, but what it does, it aims to do well.
 
-## Screenshot
+### Screenshot
 
-![Screenshot](http://at1as.github.io/github_repo_assets/BetteR-reqeust.jpg)
+![Screenshot](http://at1as.github.io/github_repo_assets/better-rest-client.jpg)
 
-## Usage
+### Usage
 
-The easiest way to use BetteR is to install it using the gem:
+The easiest way to use BetteR is to install it using the [Ruby Gem](http://rubygems.org/gems/better_rest) (note that this usually lags a few commits behind):
 ```bash
 $ gem install better_rest
 ```
-Or download the repository here for the latest version and launch BetteR via:
+Or download the repository here for the latest version and launch via:
 ```bash
 $ ./bin/better_rest
 ```
-## Logs
+To try BetteR, without installing the Gem, it's also hosted on [Heroku](http://better-rest.herokuapp.com/). Note that when run on Heroku, some of functionality won't work due to lack of access to the filesystem (saving logs, etc.). Also note that this is likely to be from an older commit.
 
-Logs (if enabled from the Settings menu in the UI) will be stored in the following location
-```bash
-./logs/YYYY-MM-DD.log
-```
-## Dependencies
+### Dependencies
 
-Requires a ruby installation with the following gems installed (installation via the gem will eventually take care of these dependencies, but currently does not):
-- sinatra
-- typhoeus
-- vegas
-- json
+See Gemfile for dependencies
 
-## TODO
+### TODO
 
-* Add OAuth/OAuth2 support
+* POSTMAN import
+* OAuth/OAuth2 support
 * Update current deprecated Basic/Digest Auth method
-* Add ability to save requests
-* Add download to file
-* Add support for more than one variable
+* Download to file
+* Support more than one variable
+* Delete logs

data/Rakefile

@@ -0,0 +1,6 @@
+require './lib/better_rest.rb'
+task :default => [:test]
+
+task :test do
+    ruby "./bin/better_rest"
+end

data/better_rest.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name        = "better_rest"
-  s.version     = "0.1.1"
+  s.version     = "0.2.0"
   s.licenses	  = ['MIT']
-  s.summary     = "REST test Client"
-  s.date        = "2014-08-29"
-  s.description = "This is a REST API test client accessible via the browser."
+  s.summary     = "REST Test Client"
+  s.date        = "2014-12-13"
+  s.description = "A Configurable REST API test client accessible via your browser"
   s.authors     = ["Jason Willems"]
   s.email       = ["jason@willems.ca"]
   s.homepage    = "https://github.com/at1as/BetteR"
-  s.files       = `git ls-files`.split("\n") 
+  s.files       = `git ls-files`.split("\n")
   s.executables << 'better_rest'
 end

data/config.ru

@@ -0,0 +1,2 @@
+require './lib/better_rest.rb'
+run Sinatra::Application

data/lib/better_rest.rb

@@ -1,4 +1,8 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
 
 require 'sinatra'
 require 'typhoeus'
@@ -12,129 +16,223 @@ helpers do
   alias_method :h, :escape_html
 end
 
+configure do
+  dirs = ['logs', 'requests', 'tmp']
+  dirs.each do |folder|
+    Dir.mkdir(folder) unless File.directory? folder
+  end
+end
+
 BETTER_SIGNATURE = "BetteR - https://github.com/at1as/BetteR"
 
+
+# Return default values
 get '/?' do
   @requests = ["GET","POST","PUT","DELETE","HEAD","OPTIONS","PATCH"]
   @times = ["1", "2", "5", "10"]
-  @timeout = ["1","2","5","10","60"]
-  @validHeaderCount = 1
-  @headerHash = {"" => ""}
-  @follow, @verbose, @ssl, @loggingOn = true, true, false, false
-  @visible = ["displayed", "hidden", "displayed", "displayed", "displayed"]	#Ordered display toggle for frontend: REQUEST, AUTH, HEADERS, PAYLOAD, RESULTS
-  @payloadHeight = "100px"
+  @header_hash = {"" => ""}
+  @follow, @verbose, @ssl, @log_requests = true, true, false, false
+  @timeout_interval = 1
 
   erb :index
 end
 
-post '/' do
-  # Set Defaults
-  @headerHash = {}
-  @validHeaderCount = 1
-  @formResponse = true
-  @follow, @verbose, @ssl, @loggingOn = true, true, false, false
-  @requestBody = params[:payload]
-  @visible = [:servURLDiv, :servAuthDiv, :servHeaderDiv, :servePayloadDiv, :servResultsDiv].map{ |k| params[k] }
-  @var_key = params[:varKey]
-  @var_value = params[:varValue]
-  @ContentType = "text/plain"
-  @payloadHeight = params[:payloadHeight] ||= "100px"
-
-  puts "PH: #{@payloadHeight}"
-
-  # Loop through Header key/value pairs
-  # If a header is created and deleted in the UI before submit, headerCount will not renormalize (and will exceed the number headers sent)
-  # This will check that a particular header exists, before adding it to the Hash
-  params[:headerCount].to_i.times do |i|
-    @keyIncrement = "key#{i}"
-    @valueIncrement = "value#{i}"
-
-    if !(params.fetch(@keyIncrement, '').empty? || params.fetch(@valueIncrement, '').empty?)
-      @headerHash[params[@keyIncrement]] = params[@valueIncrement]
-      @validHeaderCount += 1
-    end
-  end
 
-  # Shameless branding. Only if User-Agent isn't user specified
-  @headerHash["User-Agent"] ||= BETTER_SIGNATURE
+# Send a request
+before '/request' do
+  request.body.rewind
+  @request_body = JSON.parse request.body.read
+end
+
+post '/request' do
+  puts @request_body
 
-  # Check which options the user set or default to the following
-  @follow = false if params[:followlocation] == ""
-  @verbose = false if params[:verbose] == ""
-  @ssl = true if params[:ssl_verifypeer] == "on"
-  @loggingOn = true if params[:enableLogging] == "on"
+  # Request Configuration
+  @follow = @request_body['redirect'] rescue false
+  @verbose = @request_body['verbose'] rescue false
+  @ssl = @request_body['ssl_ver'] rescue false
+  @log_requests = @request_body['logging'] rescue false
+  @timeout_interval = Integer(@request_body['timeout']) rescue 1
+  @request_body['headers']['User-Agent'] = BETTER_SIGNATURE unless @request_body['headers']['User-Agent']
 
-  # For parallel Requests
+  # Create the Request
   hydra = Typhoeus::Hydra.new
-
-  # Create the Request (swap variable keys for values, if they have been set)
   request = Typhoeus::Request.new(
-    params[:url].gsub("{{#{@var_key}}}", @var_value),
-    method: params[:requestType],
-    username: params[:usr].gsub("{{#{@var_key}}}", @var_value),
-    password: params[:pwd].gsub("{{#{@var_key}}}", @var_value),
-    auth_method: :auto,		#Should ideally not be auto, in order to test unideal APIs
-    headers: @headerHash,
-    body: params[:payload].gsub("{{#{@var_key}}}", @var_value),
+    @request_body["url"],
+    method: @request_body["request"],
+    username: @request_body["user"],
+    password: @request_body["password"],
+    auth_method: :auto,
+    headers: @request_body["headers"],
+    body: @request_body["payload"],
     followlocation: @follow,
     verbose: @verbose,
     ssl_verifypeer: @ssl,
-    timeout: Integer(params[:timeoutInterval])
+    timeout: @timeout_interval
   )
 
-  # Modify Request Payload to include datafile, if present
-  if params[:datafile]
-    @requestBody = { content: params[:payload], file: File.open(params[:datafile][:tempfile], 'r') }
-    request.options[:body] = @requestBody #{ content: params[:payload], file: File.open(params[:datafile][:tempfile], 'r') }
+  # Modify request object if necessary
+  unless @request_body['file'].empty?
+    request.options[:body] = { file: File.open('tmp/' + @request_body['file'], 'r') }
   end
 
-  # Substitute Header Values for defined variables
-  request.options[:headers].each do |key, val|
-    if val.to_s.include? "{{#{@var_key}}}"
-      request.options[:headers][key.to_s] = val.gsub("{{#{@var_key}}}", @var_value)
-    end
+  # Remove unused fields from request
+  request.options.delete(:body) if request.options[:body].empty?
+  if @request_body['user'].empty? || @request_body['password'].empty?
+    request.options.delete(:username)
+    request.options.delete(:password)
+    request.options.delete(:auth_method)
   end
 
-  # Remove unused fields from request (some APIs don't handle unexpected fields)
-  request.options.delete(:body) if request.options[:body] == ""
-  request.options.delete(:username) if params[:usr] == ""
-  request.options.delete(:password) if params[:pwd] == ""
-  request.options.delete(:auth_method) if params[:pwd] == "" && params[:usr] == ""
-
   # Send the request (specified number of times)
-  params[:times].to_i.times.map{ hydra.queue(request) }
+  @request_body['quantity'].to_i.times.map{ hydra.queue(request) }
   hydra.run
   response = request.response
 
-  # If user-agent wasn't set by user, don't bother showing the user this default
-  request.options[:headers].delete('User-Agent') && @headerHash.delete("User-Agent") if @headerHash["User-Agent"] == BETTER_SIGNATURE
-
-  # Log the request response
-  if @loggingOn
-    File.open('log/' + Time.now.strftime("%Y-%m-%d") + '.log', 'a') do |file|
-      file.write("-" * 10 + "\n" + Time.now.to_s + request.inspect + "\n\n" )
+  # Log the request
+  if @log_requests
+    File.open('logs/' + Time.now.strftime('%Y-%m-%d') + '.log', 'a') do |file|
+      file.write('-' * 10 + ?\n + Time.now.to_s + request.inspect + "\n\n")
     end
   end
 
-  # These values will be used by the ERB page
-  # Add the URL to the Request Options returned
+  # View response parameters
+  @response_body = {}
   request.options[:url] = request.url
-  @requestOptions = JSON.pretty_generate(request.options)
-  @returnBody = response.body
-  @returnCode = response.return_code
-  @returnTime = response.time
-  @statCodeReturn = response.response_headers
-  @requests = ["#{params[:requestType]}", "GET","POST","PUT","DELETE","HEAD","OPTIONS","PATCH"].uniq
-  @times = ["#{params[:times]}", "1", "2", "5", "10"].uniq
-  @timeout = ["1","2","5","10","60"]
+  @response_body['request_options'] = JSON.pretty_generate(request.options)
+  @response_body['return_msg'] = response.return_code.upcase
+  @response_body['return_code'] = response.code
+  @response_body['return_time'] = response.time
+  @response_body['return_body'] = response.body.force_encoding('UTF-8')
+  @response_body['return_headers'] = response.response_headers
+
+  @response_body.to_json
+end
 
-  erb :index
+
+# Save Request
+before '/save' do
+  request.body.rewind
+  @request_payload = JSON.parse request.body.read
 end
 
+post '/save' do
+  name = @request_payload['name']
+  collection = @request_payload['collection']
+
+  if File.exists? "requests/#{collection}.json"
+    stored_collection = JSON.parse File.read("requests/#{collection}.json")
+  else
+    stored_collection = {}
+  end
+  stored_collection[name] = @request_payload
+
+  File.open("requests/#{collection}.json", "w") do |f|
+    f.write(stored_collection.to_json)
+  end
+  200
+end
+
+
+# Load List of Requests
+get '/savedrequests' do
+  collection_map = {}
+  collections = Dir["requests/*.json"]
+
+  collections.each do |collection|
+    collection_contents = JSON.parse File.read(collection)
+    collection_names = collection_contents.keys
+
+    # Strip extension and directory from filename
+    collection = collection[9..-6]
+    collection_map[collection] = collection_names.sort
+  end
+
+  if collections.length > 0
+    return collection_map.to_json
+  else
+    return 404
+  end
+end
+
+
+# Load Request
+get '/savedrequests/:collection/:request' do
+  if File.exists? "requests/#{params[:collection]}.json"
+    collection = JSON.parse File.read("requests/#{params[:collection]}.json")
+    request = collection[params[:request]]
+    return request.to_json
+  else
+    return 404
+  end
+  200
+end
+
+
+# Delete Request Collection
+delete '/collections/:collection' do
+  if File.exists? "requests/#{params[:collection]}.json"
+    File.delete("requests/#{params[:collection]}.json")
+  else
+    return 404
+  end
+  200
+end
+
+
+# Delete Request from Collection
+delete '/collections/:collection/:request' do
+  if File.exists? "requests/#{params[:collection]}.json"
+    stored_collection = JSON.parse File.read("requests/#{params[:collection]}.json")
+    stored_collection.delete(params[:request])
+
+    File.open("requests/#{params[:collection]}.json", "w") do |f|
+      f.write(stored_collection.to_json)
+    end
+  else
+    return 404
+  end
+  200
+end
+
+
+# Retrieve list of saved logs
+get '/logs' do
+  entries = Dir["logs/*.log"]
+  entries = entries.map!{ |k| k[5..-5]}
+  return { :logs => entries }.to_json
+end
+
+
+# Download log
+get '/logs/:log' do
+  begin
+    send_file "logs/#{params[:log]}.log"
+  rescue
+    return 404
+  end
+end
+
+
+# Upload file
+# Clear directory writing file
+post '/upload' do
+  FileUtils.rm_rf(Dir.glob('tmp/*'))
+  unless request.body.nil?
+    File.open('tmp/' + params[:file][:filename], 'w') do |f|
+      f.write(params[:file][:tempfile].read)
+    end
+  end
+  200
+end
+
+
+# Defaults to main page
 not_found do
   redirect '/'
 end
 
+
 # Returns Ruby/Sinatra Environment details
 get '/env' do
   <<-ENDRESPONSE
@@ -144,8 +242,13 @@ get '/env' do
   ENDRESPONSE
 end
 
+
 # Kills process. Work around for Vegas Gem not catching SIGINT from Terminal
 get '/quit' do
-  puts "\nExiting..."
+  redirect to('/'), 200
+end
+
+after '/quit' do
+  puts  "\nExiting..."
   exit!
 end