agile-proxy 0.1.0

data/db/migrations/20141106083100_add_username_and_password_to_applications.rb

@@ -0,0 +1,8 @@
+class AddUsernameAndPasswordToApplications < ActiveRecord::Migration
+  def change
+    change_table(:applications) do |t|
+      t.string :username, default: 'anonymous'
+      t.string :password, default: 'password'
+    end
+  end
+end

data/db/migrations/20141119143800_add_record_to_applications.rb

@@ -0,0 +1,7 @@
+class AddRecordToApplications < ActiveRecord::Migration
+  def change
+    change_table(:applications) do |t|
+      t.boolean :record_requests, default: false
+    end
+  end
+end

data/db/migrations/20141119174300_create_recordings.rb

@@ -0,0 +1,18 @@
+class CreateRecordings < ActiveRecord::Migration
+  def change
+    create_table :recordings do |t|
+      t.integer :application_id
+      t.text :request_headers
+      t.text :request_body
+      t.string :request_url
+      t.string :request_method
+      t.text :response_headers
+      t.text :response_body
+      t.text :response_status
+      t.integer :request_spec_id
+      t.timestamps
+    end
+    add_index :recordings, :application_id, :unique => false
+    add_index :recordings, :request_spec_id, :unique => false
+  end
+end

data/db/schema.rb

@@ -0,0 +1,78 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20141119174300) do
+
+  create_table "applications", force: true do |t|
+    t.integer  "user_id"
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.string   "username",        default: "anonymous"
+    t.string   "password",        default: "password"
+    t.boolean  "record_requests", default: false
+  end
+
+  add_index "applications", ["user_id"], name: "index_applications_on_user_id"
+
+  create_table "recordings", force: true do |t|
+    t.integer  "application_id"
+    t.text     "request_headers"
+    t.text     "request_body"
+    t.string   "request_url"
+    t.string   "request_method"
+    t.text     "response_headers"
+    t.text     "response_body"
+    t.text     "response_status"
+    t.integer  "request_spec_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "recordings", ["application_id"], name: "index_recordings_on_application_id"
+  add_index "recordings", ["request_spec_id"], name: "index_recordings_on_request_spec_id"
+
+  create_table "request_specs", force: true do |t|
+    t.integer "user_id"
+    t.integer "application_id"
+    t.string  "url"
+    t.text    "note"
+    t.integer "response_id"
+    t.string  "http_method",    default: "GET"
+    t.string  "url_type",       default: "url"
+    t.text    "conditions",     default: "{}"
+  end
+
+  add_index "request_specs", ["application_id"], name: "index_request_specs_on_application_id"
+  add_index "request_specs", ["user_id"], name: "index_request_specs_on_user_id"
+
+  create_table "responses", force: true do |t|
+    t.string   "name"
+    t.text     "content"
+    t.string   "content_type"
+    t.integer  "status_code",  default: 200
+    t.text     "headers",      default: "{}"
+    t.boolean  "is_template"
+    t.float    "delay",        default: 0.0
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", force: true do |t|
+    t.string   "name"
+    t.string   "email"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/examples/README.md

@@ -0,0 +1 @@
+See example specs in `spec/requests/examples`.

data/examples/facebook_api.html

@@ -0,0 +1,59 @@
+<div id="fb-root"></div>
+<script>
+  // Load the SDK Asynchronously
+  (function(d){
+     var js, id = 'facebook-jssdk', ref = d.getElementsByTagName('script')[0];
+     if (d.getElementById(id)) {return;}
+     js = d.createElement('script'); js.id = id; js.async = true;
+     js.src = "//connect.facebook.net/en_US/all.js";
+     ref.parentNode.insertBefore(js, ref);
+   }(document));
+
+  // Init the SDK upon load
+  window.fbAsyncInit = function() {
+    FB.init({
+      appId      : '408416075843608', // App ID
+      //channelUrl : '//'+window.location.hostname+'/channel', // Path to your Channel File
+      status     : true, // check login status
+      cookie     : true, // enable cookies to allow the server to access the session
+      xfbml      : true  // parse XFBML
+    });
+
+    // listen for and handle auth.statusChange events
+    FB.Event.subscribe('auth.statusChange', function(response) {
+      if (response.authResponse) {
+        // user has auth'd your app and is logged into Facebook
+        FB.api('/me', function(me){
+          if (me.name) {
+            document.getElementById('auth-displayname').innerHTML = me.name;
+          }
+        });
+        document.getElementById('auth-loggedout').style.display = 'none';
+        document.getElementById('auth-loggedin').style.display = 'block';
+      } else {
+        // user has not auth'd your app, or is not logged into Facebook
+        document.getElementById('auth-loggedout').style.display = 'block';
+        document.getElementById('auth-loggedin').style.display = 'none';
+      }
+    });
+
+    // respond to clicks on the login and logout links
+    document.getElementById('auth-loginlink').addEventListener('click', function(){
+      FB.login();
+    });
+    document.getElementById('auth-logoutlink').addEventListener('click', function(){
+      FB.logout();
+    });
+  }
+</script>
+
+<h1>Facebook Client-side Authentication Example</h1>
+  <div id="auth-status">
+    <div id="auth-loggedout">
+      <a href="#" id="auth-loginlink">Login</a>
+    </div>
+    <div id="auth-loggedin" style="display:none">
+      Hi, <span id="auth-displayname"></span>
+    (<a href="#" id="auth-logoutlink">logout</a>)
+  </div>
+</div>

data/examples/tumblr_api.html

@@ -0,0 +1,22 @@
+<!doctype html>
+<body>
+  <h1>Latest news</h1>
+  <div id="news"></div>
+
+  <script type='text/javascript' src='http://code.jquery.com/jquery-1.8.2.min.js'></script>
+  <script type='text/javascript'>
+  $(function () {
+    var url = 'http://blog.howmanyleft.co.uk/api/read/json?callback=?&type=text&num=3&filter=text';
+    $.getJSON(url, function (data) {
+      $.each(data.posts, function (idx, post) {
+        var title = post['regular-title'];
+        var href = post['url-with-slug'];
+        var body = post['regular-body'];
+        $('#news').append(
+          '<h3><a href="' + href + '">' + title + '</a></h3>' +
+          '<p>' + body + '</p>');
+      });
+    });
+  })
+  </script>
+</body>

data/lib/agile_proxy.rb

@@ -0,0 +1,8 @@
+require 'agile_proxy/version'
+require 'agile_proxy/config'
+require 'agile_proxy/handlers/handler'
+require 'agile_proxy/handlers/request_handler'
+require 'agile_proxy/handlers/stub_handler'
+require 'agile_proxy/handlers/proxy_handler'
+require 'agile_proxy/server'
+require 'agile_proxy/proxy_connection'

data/lib/agile_proxy/api/applications.rb

@@ -0,0 +1,77 @@
+module AgileProxy
+  module Api
+    #
+    # = A grape api for applications
+    #
+    # An application is a central resource for the proxy, it is the 'application under test or development'
+    #
+    # The proxy server can handle multiple applications by assigning each one a different username and password
+    # that is used when connecting to the proxy.
+    # Each application can have its own set of stubs, can be set to record or not and much much more.
+    class Applications < Grape::API
+      include Grape::Kaminari
+      helpers do
+        # We only allow selected parameters through - spec and note
+        def permitted_params
+          @permitted_params ||= declared(
+              params,
+              { include_missing: false },
+              [:username, :password, :name, :record_requests]
+          )
+        end
+
+        # Convenient access to the record specified in the id parameter
+        def record
+          current_user.applications.where(id: params[:id]).first
+        end
+
+        # Convenient access to the record parameters from a POST or a PUT, only permitted will be returned
+        def record_params
+          permitted_params.with_indifferent_access
+        end
+
+        def default_json_spec
+          {}
+        end
+
+      end
+
+      resource :applications do
+        desc 'List all applications for the user'
+        paginate per_page: 20, max_per_page: 200
+        get do
+          authenticate!
+          scope = current_user.applications
+          { applications: paginate(scope).as_json(default_json_spec), total: scope.count }
+        end
+        desc 'Delete all applications for the user'
+        delete do
+          authenticate!
+          scope = current_user.applications
+          scope.destroy_all
+          { applications: [], total: 0 }
+        end
+        desc 'Create a new application for the user'
+        post do
+          authenticate!
+          current_user.applications.create!(record_params.merge user_id: current_user.id).as_json(default_json_spec)
+        end
+        desc 'Get an application by id'
+        get ':id' do
+          authenticate!
+          record.as_json(default_json_spec)
+        end
+        delete ':id' do
+          authenticate!
+          record.tap(&:destroy).as_json(default_json_spec)
+        end
+        desc 'Update a request application'
+        put ':id' do
+          authenticate!
+          record.tap { |r| r.update_attributes(record_params) }.as_json(default_json_spec)
+        end
+
+      end
+    end
+  end
+end

data/lib/agile_proxy/api/recordings.rb

@@ -0,0 +1,52 @@
+module AgileProxy
+  module Api
+    #
+    # = A grape API for recordings
+    #
+    # If the application is set to allow recordings, each HTTP request and response passing
+    # through the proxy server will be recorded.
+    #
+    # This API allows access to those recordings via REST
+    #
+    class Recordings < Grape::API
+      include Grape::Kaminari
+      helpers do
+        # Convenient access to the record specified in the id parameter
+        def record
+          current_application.recordings.where(id: params[:id]).first
+        end
+
+        def default_json_spec
+          {}
+        end
+      end
+
+      resource :recordings do
+        desc 'List all recordings made for the application'
+        paginate per_page: 20, max_per_page: 200
+        get do
+          authenticate!
+          scope = current_application.recordings
+          { recordings: paginate(scope).as_json(default_json_spec), total: scope.count }
+        end
+        desc 'Delete all rcordings for the application'
+        delete do
+          authenticate!
+          scope = current_application.recordings
+          scope.destroy_all
+          { recordings: [], total: 0 }
+        end
+        desc 'Get a recording by id'
+        get ':id' do
+          authenticate!
+          record.as_json(default_json_spec)
+        end
+        delete ':id' do
+          authenticate!
+          record.tap(&:destroy).as_json(default_json_spec)
+        end
+
+      end
+    end
+  end
+end

data/lib/agile_proxy/api/request_specs.rb

@@ -0,0 +1,85 @@
+require 'agile_proxy/model/request_spec'
+require 'grape-kaminari'
+module AgileProxy
+  module Api
+    #
+    # = A grape API for request specifications
+    #
+    # A 'request specification' is what is known as a 'Stub' in the UI.
+    #
+    # It defines an input and output spec for a HTTP(s) request.
+    #
+    # For example, we could say
+    # 'When http://www.mybing.com/search.html is requested with some specific query parameters, then respond with this'
+    #
+    # This API allows full CRUD access to these request specifications, but only those belonging to the logged in user.
+    #
+    class RequestSpecs < Grape::API
+      include Grape::Kaminari
+      helpers do
+        # We only allow selected parameters through - spec and note
+        def permitted_params
+          @permitted_params ||= declared(
+              params,
+              { include_missing: false },
+              [:spec, :note, :response, :http_method, :url, :url_type, :conditions]
+          )
+        end
+
+        # Convenient access to the record specified in the id parameter
+        def record
+          current_application.request_specs.where(id: params[:id]).first
+        end
+
+        # Convenient access to the record parameters from a POST or a PUT, only permitted will be returned
+        # Note that for some reason, to do with rack or grape,
+        # when we send a large body, the request_spec does not come through
+        # so, to work around this, we inject the request spec in afterwards if it is missing.
+        def record_params
+          p = permitted_params.with_indifferent_access
+          p.merge!(user_id: current_user.id, application_id: current_application.id)
+          p[:response_attributes] = p.delete(:response) if p.key?(:response)
+          p
+        end
+
+        def default_json_spec
+          { include: { response: { except: [:created_at, :updated_at] } } }
+        end
+
+      end
+      resource :request_specs do
+        desc 'List all request specifications for the application'
+        paginate per_page: 20, max_per_page: 200
+        get do
+          authenticate!
+          scope = current_application.request_specs
+          { request_specs: paginate(scope).as_json(default_json_spec), total: scope.count }
+        end
+        delete do
+          authenticate!
+          scope = current_application.request_specs
+          scope.delete_all
+          { request_specs: [], total: 0 }
+        end
+        desc 'Create a new request specification'
+        post do
+          authenticate!
+          current_application.request_specs.create(record_params).as_json(default_json_spec)
+        end
+        get ':id' do
+          authenticate!
+          record.as_json(default_json_spec)
+        end
+        desc 'Update a request specification'
+        put ':id' do
+          authenticate!
+          record.tap { |r| r.update_attributes(record_params) }.as_json(default_json_spec)
+        end
+        delete ':id' do
+          authenticate!
+          record.tap(&:destroy).as_json(default_json_spec)
+        end
+      end
+    end
+  end
+end

data/lib/agile_proxy/api/root.rb

@@ -0,0 +1,41 @@
+require_relative 'request_specs'
+require_relative 'applications'
+require_relative 'recordings'
+module AgileProxy
+  module Api
+    #
+    # = The API Root
+    #
+    # This is the root of the entire API for use with REST.  It will not be accessed directly
+    #
+    class Root < Grape::API
+      version 'v1', vendor: 'agile-proxy'
+      format :json
+      helpers do
+        # Provides easy access to the current user.
+        # As we are currently only single user, then we just return the first user
+        def current_user
+          ::AgileProxy::User.first
+        end
+        # Secured methods must call this first
+        def authenticate!
+          # Do nothing yet
+        end
+        # Provides easy access to the current application whether
+        # specified in the URL or not (defaults to the first if not)
+        def current_application
+          fail 'Application ID is missing' unless params.key?(:application_id)
+          applications = current_user.applications
+          applications.where(id: params[:application_id]).first
+        end
+      end
+      namespace 'users/:user_id' do
+        mount Api::Applications
+        namespace '/applications/:application_id' do
+          mount Api::Recordings
+          mount Api::RequestSpecs
+        end
+      end
+    end
+  end
+end