the_wizard_of_api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef0bec6a9854b4f1162cd1ecdda53a09a4aa855
-  data.tar.gz: d1944f330aaad723f15356154f3f3d18374cedb2
+  metadata.gz: cf9b2e9d6271e57b48f843c4acfbd9d093b36106
+  data.tar.gz: 590cb0698da72963df534396fea4d9624a14cc12
 SHA512:
-  metadata.gz: f1bca7f40dbacdce9a46875cc4d0289e62c2ea2074e65c1703b3276de88d67cd4f4071d7ff9ac75dfe043bf1930b61393041437330ba191f6363b2fd82d2b98d
-  data.tar.gz: 8d0d442ad538a7a601045e10d162c6e6f425ab9fd98e47943a1d143f9ec125ac78c4448e7d08abbbd46aadd23bf441ae6fa41e27e610afbefe2d1369dc2953a1
+  metadata.gz: cc3fbaa708376e3bdd32ef5188ee634c2036085d49d5c77019a47039eb2faa79a26f41d422409daf79c1d1395beb6f864d7ae0de2da8c88a6d0291e66131c9da
+  data.tar.gz: dfd5d921116c7a34601c1d83129418516dcb3cbab6bca118e1fb587a098e769497aba6304c1c28ba02e609c9c31bc5f11d1847a61ec60dbabd049eaf794ee3f2

data/features/javascript_frontend.feature

@@ -0,0 +1,24 @@
+Feature: Javascript form for submitting responses
+  In order to create responses faster
+  As The Wizard
+  I want to compose the responses from a page in my browser
+
+  Scenario: A simple request and response
+    Given TheWizardOfApi is running in the browser
+    And someone else makes a GET request to "/api"
+    When I submit a "response" with:
+    """
+    Always believe in who you are Dorothy and let no one stand in your way.
+    """
+    Then they should see:
+    """
+    Always believe in who you are Dorothy and let no one stand in your way.
+    """
+    And I should see:
+    """
+    HTTP/1.1 200 OK
+    Content-Type: application/json
+
+    Always believe in who you are Dorothy and let no one stand in your way.
+    """
+

data/features/step_definitions/javascript_frontend_steps.rb

@@ -0,0 +1,18 @@
+Given(/^TheWizardOfApi is running in the browser$/) do
+  unset_bundler_env_vars
+
+  install_the_wizard_of_api
+
+  start_the_wizard_of_api
+
+  visit throne_url
+
+  avoid_timing_errors do
+    expect(page).to have_text("Throne Room")
+  end
+end
+
+When(/^I submit a "(.*?)" with:$/) do |field, value|
+  fill_in(field, with: value)
+  click_on("Submit")
+end

data/features/step_definitions/streaming_requests_to_the_throne_room_steps.rb

@@ -1,37 +1,31 @@
-require 'restclient'
-
 Given(/^TheWizardOfApi is running with defaults$/) do
   unset_bundler_env_vars
 
-  write_file("Gemfile", <<-GEMFILE)
-    gem 'the_wizard_of_api', path: '../../'
-  GEMFILE
-
-  write_file("config.ru",<<-RACKUP)
-    require 'bundler/setup'
-    require 'the_wizard_of_api'
-    run TheWizardOfApi.new
-  RACKUP
-
-  run_simple("bundle")
+  install_the_wizard_of_api
 
-  run_process(start: thin("-R config.ru start"),
-              stop: thin("-R config.ru stop"))
+  start_the_wizard_of_api
 
-  until thin_pid_path.exist?
-    $stdout.write('.') if ENV['DEBUG']
-  end
-
-  visit throne_url
+  the_wizard_takes_their_seat
 end
 
 When(/^someone else makes a GET request to "(.*?)"$/) do |path|
   last_response = avoid_timing_errors do
-    run_process(start: "curl -s localhost:3000#{path} & echo $! > curl.pid",
-                stop: "kill -9 `cat curl.pid`")
+    dorothy_request(path)
   end
 end
 
 Then(/^I should see:$/) do |string|
-  expect(page).to have_text(string)
+  avoid_timing_errors(2) do
+    expect(page).to have_text(string)
+  end
+end
+
+Then(/^they should see:$/) do |string|
+  avoid_timing_errors(2) do
+    check_file_content(log_path("dorothy").basename,string,true)
+  end
+end
+
+When(/^I respond with:$/) do |response|
+  wizard_response(response)
 end

data/features/streaming_requests_to_the_throne_room.feature

@@ -1,17 +1,28 @@
 Feature: The Wizard sees all requests
   In order to create the illusion of a service
   As The Wizard
-  I want to see all the requests coming to me
+  I want to see all the requests coming to me so that I may respond
 
   Scenario: A GET request to the default mount point
     Given TheWizardOfApi is running with defaults
     When someone else makes a GET request to "/api"
     Then I should see:
     """
-    GET / HTTP/1.1
-    Accept: */*; q=0.5, application/xml
-    Accept-Encoding: gzip, deflate
-    User-Agent: Ruby
-    Host: 0.0.0.0:9292
+    GET /api HTTP/1.1
+    Accept: */*
+    User-Agent: curl
+    Host: localhost:3000
+    """
+
+  Scenario: A POST request to the Wizard's response mount point
+    Given TheWizardOfApi is running with defaults
+    And someone else makes a GET request to "/api"
+    When I respond with:
+    """
+    {"dorothy": "You may have your wish"}
+    """
+    Then they should see:
+    """
+    {"dorothy": "You may have your wish"}
     """
 

data/features/support/curl_helper.rb

@@ -0,0 +1,20 @@
+module CurlHelper
+  def curl(flag, request, options = {})
+    pid_path = options.fetch(:pid, "#{flag}.pid")
+    log_path = options.fetch(:log, "#{flag}.log")
+
+    run = ["curl -sN -A 'curl'"]
+    run << "-o #{log_path}" if log_path
+    run << request
+    run << " & echo $! > #{pid_path}" if pid_path
+
+    debug(run.join(" "))
+    run.join(" ")
+  end
+
+  def cleanup_curl(flag, options = {})
+    pid_path = options.fetch(:pid, "#{flag}.pid")
+
+    "kill -9 `cat #{pid_path}`"
+  end
+end

data/features/support/env.rb

@@ -21,7 +21,10 @@ After(&ProcessHelper::After)
 
 require 'the_wizard_of_api_helper'
 
-World(DebuggingPryHelper,
+require 'curl_helper'
+
+World(CurlHelper,
+      DebuggingPryHelper,
       ProcessHelper,
       ThinHelper,
       TimingErrorHelper,

data/features/support/process_helper.rb

@@ -19,6 +19,18 @@ module ProcessHelper
     end
   end
 
+  def wait_for_log_to_contain(path,string=false)
+    until path.exist? && !path.read.empty?
+      debug(".")
+    end
+
+    if string
+      until path.read.include?(string)
+        debug(".")
+      end
+    end
+  end
+
   After = lambda do |scenario|
     stop_services
   end

data/features/support/the_wizard_of_api_helper.rb

@@ -2,4 +2,46 @@ module TheWizardOfApiHelper
   def throne_url
     "http://localhost:3000/throne"
   end
+
+  def install_the_wizard_of_api
+    write_file("Gemfile", <<-GEMFILE)
+      gem 'the_wizard_of_api', path: '../../'
+    GEMFILE
+
+    write_file("config.ru",<<-RACKUP)
+      require 'bundler/setup'
+      require 'the_wizard_of_api'
+      run TheWizardOfApi.new
+    RACKUP
+
+    run_simple("bundle")
+  end
+
+  def start_the_wizard_of_api
+    run_process(
+      start: thin(:start, pid: thin_pid_path.basename, log: thin_log_path.basename, rackup: "config.ru"),
+      stop: thin(:stop, pid: thin_pid_path.basename))
+
+      wait_for_log_to_contain(thin_log_path,"Listening on")
+  end
+
+  def dorothy_request(path)
+    # Curl or new webkit process, or rest client
+    run_process(start: curl("dorothy", "http://localhost:3000#{path}"),
+                stop: cleanup_curl("dorothy"))
+
+    wait_for_log_to_contain(log_path("dorothy"))
+  end
+
+  def wizard_response(data)
+    run_simple("curl -sN --form 'response=#{data}' http://localhost:3000/throne/response")
+  end
+
+  def the_wizard_takes_their_seat
+    visit throne_url
+  end
+
+  def log_path(name)
+    Pathname.new(current_dir) + "#{name}.log"
+  end
 end

data/features/support/thin_helper.rb

@@ -15,8 +15,20 @@ module ThinHelper
     thin_pid_path.read.to_i
   end
 
-  def thin(command)
-    "thin -d -P #{thin_pid_path.basename} -l #{thin_log_path.basename} #{command}"
+  def thin(command, options = {})
+    pid_path = options.fetch(:pid,false)
+    log_path = options.fetch(:log,false)
+    rackup   = options.fetch(:rackup,false)
+    run = ["thin -DV"]
+    run << "-d"             if pid_path
+    run << "-P #{pid_path}" if pid_path
+    run << "-l #{log_path}" if log_path
+    run << "-R #{rackup}"   if rackup
+
+    debug(run.join(" "))
+
+    run << command
+    run.join(" ")
   end
 
   Before = lambda do |scenario|

data/features/support/timing_error_helper.rb

@@ -1,6 +1,6 @@
 module TimingErrorHelper
   def debug(string)
-    if ENV['DEBUG'] == true
+    if ENV['DEBUG']
       if string.length == 1
         $stdout.write(string)
       else
@@ -9,23 +9,42 @@ module TimingErrorHelper
     end
   end
 
-  def avoid_timing_errors
-    begin
-      yield
-    rescue Timeout::Error => e
-      debug('.')
-      retry
-    rescue Errno::ECONNREFUSED => e
-      debug(',')
-      retry
-    rescue Capybara::Webkit::InvalidResponseError => e
-      if e.message.include?("Unable to load URL")
-        debug('!')
+  def avoid_timing_errors(time=false,&block)
+    carefully = lambda do |*args|
+      begin
+        block.call
+      rescue Timeout::Error => e
+        debug('.')
         retry
+      rescue Errno::ECONNREFUSED => e
+        debug(',')
+        retry
+      rescue Capybara::Webkit::InvalidResponseError => e
+        if e.message.include?("Unable to load URL")
+          debug('!')
+          retry
+        end
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+        if e.message.include?("Diff:")
+          debug('`')
+          retry
+        end
+      rescue => e
+        pry(binding)
+        raise e
       end
-    rescue => e
-      pry(binding)
-      raise e
+    end
+
+    if time
+      begin
+        Timeout::timeout(time,&carefully)
+      rescue Timeout::Error => e
+        debug('.')
+      end
+
+      block.call
+    else
+      carefully.call
     end
   end
 end

data/lib/the_wizard_of_api/version.rb

@@ -1,3 +1,3 @@
 module TheWizardOfApi
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/the_wizard_of_api.rb

@@ -1,5 +1,6 @@
 require "the_wizard_of_api/version"
 require 'faye'
+require 'rack/try_static'
 
 class DeferrableBody
   include EventMachine::Deferrable
@@ -21,25 +22,27 @@ module TheWizardOfApi
   def self.new(app = nil)
     wizard = Rack::Builder.new do
 
-      self.class.class_eval do
-        def stream_line(body, shown_key, env, http_key)
-          value = env[http_key]
-
-          if value
-            line = ["#{shown_key}:",value].join(" ")
-            puts line
-            body.call [line+"\n"]
-          else
-            puts
-            puts env.inspect
-            puts
-          end
+      map "/throne" do
+        map "/response" do
+          run Proc.new { |env|
+            client = env.fetch('faye.client')
+
+            req = Rack::Request.new(env)
+
+            client.publish('/wizard_response',req.params['response'])
+
+            [200,{},[]]
+          }
         end
+
+        run Rack::TryStatic.new(app,{
+          root: Pathname.new(__FILE__).dirname.dirname.join("public").to_s,
+          urls: %w[/],
+          try: ['.html', 'index.html', '/index.html']})
       end
 
-      map "/throne" do
+      map "/api" do
         run Proc.new { |env|
-
           body = DeferrableBody.new
 
           client = env.fetch('faye.client')
@@ -49,35 +52,13 @@ module TheWizardOfApi
             body.call [" " * 1024]
           }
 
-          EventMachine::add_timer(0.5) {
-            body.call ["Throne Room\n"]
-          }
-
-          client.subscribe('/api') do |message|
-            first_line = message.values_at("REQUEST_METHOD","REQUEST_PATH","HTTP_VERSION").join(" ")+"\n"
-
-            puts first_line
-            body.call [first_line]
-
-            stream_line(body, "Accept", message, "HTTP_ACCEPT")
-            stream_line(body, "Accept-Encoding", message, "HTTP_ACCEPT_ENCODING")
-            stream_line(body, "User-Agent", message, "HTTP_USER_AGENT")
-            stream_line(body, "Host", message, "HTTP_HOST")
-          end
-          ASYNC
-        }
-      end
-
-      map "/api" do
-        run Proc.new { |env|
-          client = env.fetch('faye.client')
-
           client.publish('/api', env)
 
           callback = env['async.callback']
 
           client.subscribe('/wizard_response') do |message|
-            callback.call(message)
+            body.call [message]
+            body.succeed
           end
 
           ASYNC

data/public/index.html

@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+  <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+  <title>Throne Room</title>
+  <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+  <script src="/faye/client.js" type="text/javascript"></script>
+</head>
+<body>
+  <h1>Throne Room</h1>
+  <form action="/throne/response" method="POST">
+    <label for="response_field">Response</label>
+    <input  id="response_field" name="response" type="text" />
+
+    <input type="submit" value="Submit" />
+  </form>
+
+  <script type="text/javascript">
+    var client = new Faye.Client('/faye');
+    Faye.logger = console;
+
+    $("form").on("submit",function(e){
+      var $form = $(e.target);
+      var $response = $("#response_field");
+
+      $("<pre>HTTP/1.1 200 OK\nContent-Type: application/json\n\n"+$response.val()+"</pre>").insertBefore($form);
+
+      $.ajax($form.attr("action"), {"data": $form.serializeArray()});
+      return false;
+    });
+
+    client.subscribe("/api", function(message){
+        request = [
+          formatFirstLine(message),
+          formatLine("Accept", message, "HTTP_ACCEPT"),
+          formatLine("User-Agent", message, "HTTP_USER_AGENT"),
+          formatLine("Host", message, "HTTP_HOST")
+        ]
+
+        document.body.querySelector("form").insertAdjacentHTML("beforeBegin","<pre>"+request.join("\n")+"</pre>")
+        });
+
+    function formatFirstLine(request) {
+      return [request.REQUEST_METHOD,request.REQUEST_PATH,request.HTTP_VERSION].join(" ")
+    }
+
+    function formatLine(label, request, key) {
+      var value = request[key];
+
+      if (value) {
+        return [label+":", value].join(" ");
+      } else {
+        console.log(label,request,key);
+      }
+    }
+  </script>
+</body>
+</html>
+

data/spec/lib/the_wizard_of_api_spec.rb

@@ -15,17 +15,19 @@ describe TheWizardOfApi do
   context "Throne Room" do
     subject { get "/throne" }
 
-    it "should stream the response" do
-      expect(subject.status).to eql(-1)
-    end
+    it { expect(subject).to be_ok }
 
-    pending "this isn't the actual feature-value i'm looking for" do
-      it "should stream Throne Room first" do
-        expect(subject.body).to include("Throne Room")
-      end
+    it "should stream Throne Room first" do
+      expect(subject.body).to include("Throne Room")
     end
   end
 
+  context "Throne Room response" do
+    subject { post "/throne/response", "response"=>"something" }
+
+    it { should be_ok }
+  end
+
   context "api mount point" do
     # default
     let(:api_mount_point) { "/api" }

data/the_wizard_of_api.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faye", "~> 0.8"
   spec.add_dependency "rack", "~> 1.5"
+  spec.add_dependency "rack-try_static2", "~> 1.1"
   spec.add_dependency "thin", "~> 1.5"
   spec.add_development_dependency "bcat", "~> 0.6"
   spec.add_development_dependency "capybara", "~> 2.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_wizard_of_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Caleb Buxton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rack-try_static2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -220,10 +234,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- features/javascript_frontend.feature
 - features/readme.feature
+- features/step_definitions/javascript_frontend_steps.rb
 - features/step_definitions/readme_steps.rb
 - features/step_definitions/streaming_requests_to_the_throne_room_steps.rb
 - features/streaming_requests_to_the_throne_room.feature
+- features/support/curl_helper.rb
 - features/support/debugging_pry_helper.rb
 - features/support/env.rb
 - features/support/process_helper.rb
@@ -232,6 +249,7 @@ files:
 - features/support/timing_error_helper.rb
 - lib/the_wizard_of_api.rb
 - lib/the_wizard_of_api/version.rb
+- public/index.html
 - spec/lib/the_wizard_of_api_spec.rb
 - the_wizard_of_api.gemspec
 homepage: ''
@@ -259,10 +277,13 @@ signing_key:
 specification_version: 4
 summary: Enables a human-wizard to craft each response for a yet unimplemented API.
 test_files:
+- features/javascript_frontend.feature
 - features/readme.feature
+- features/step_definitions/javascript_frontend_steps.rb
 - features/step_definitions/readme_steps.rb
 - features/step_definitions/streaming_requests_to_the_throne_room_steps.rb
 - features/streaming_requests_to_the_throne_room.feature
+- features/support/curl_helper.rb
 - features/support/debugging_pry_helper.rb
 - features/support/env.rb
 - features/support/process_helper.rb