whurl_engine 2.1.0 → 2.1.2

data/README.markdown

@@ -24,28 +24,31 @@ Then in your main app's routes.rb file, add this to make the whurl_engine routab
 Figure out how you want to authorize users for setting up the documentation vs. viewing it. Whurl
 comes with a default CanCan adapter. To us it install the cancan gem in your app and add a new whurl.rb to config/initializers:
 
-    WhurlEngine.config do |config|
-        config.current_user_method { current_user }
-        config.authorize_with(:cancan)
-    end
+```ruby
+WhurlEngine.config do |config|
+    config.current_user_method { current_user }
+    config.authorize_with(:cancan)
+end
+```
 
 ...and your ability.rb file looks like this:
 
-    class Ability
-        include CanCan::Ability
-
-        def initialize(user)
-            user ||= User.new # guest user (not logged in)
-            if user.admin?
-                can :manage, :all
-            else
-                can :read, :all
-                can :access, :whurl_engine
-                can :create, WhurlEngine::Whurl
-            end
+```ruby
+class Ability
+    include CanCan::Ability
+
+    def initialize(user)
+        user ||= User.new # guest user (not logged in)
+        if user.admin?
+            can :manage, :all
+        else
+            can :read, :all
+            can :access, :whurl_engine
+            can :create, WhurlEngine::Whurl
         end
     end
-
+end
+```
 
 Finally, look at your new API playground by starting your rails server and hitting up the right URL:
 
@@ -53,7 +56,7 @@ Finally, look at your new API playground by starting your rails server and hitti
 
 ## Customize Whurl to Match Your Application
 
-Rails 3.1 Mountable Engines make it easy to override or extend many parts of Whurl.
+Rails Mountable Engines make it easy to override or extend many parts of Whurl.
 If you need to override a method, view or partial, create the corresponding file in your
 main app directory and it will be used instead.
 
@@ -70,22 +73,4 @@ To do so, simply create a new application.html.haml in the corresponding directo
           \_ whurl_engine
             \_ application.html.haml
 
-## Goals for this project
-
-Whurl is inspired by [hurl](http://hurl.it/), and the [Apigee Console](https://apigee.com/console/)
-
-* Use HTTPS for all requests, assume all users are passing sensitive data
-* Provide a usable tool for working with APIs
-* Further the use of Whurl through viral "whurls" - the urls that represent an API request
-* Prevent abuse - users should not be able to use Whurl as a proxy for a DoS attack or similar
-
-## Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally (actually, this should come before adding code, TDD!).
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request.
+Whurl is inspired by [hurl](http://hurl.it/), and the [Apigee Console](https://apigee.com/console/)

data/app/views/whurl_engine/categories/_form.html.haml

@@ -1,6 +1,6 @@
 :javascript
   $(function() {
-    $( ".new_whurl_engine_category, .edit_whurl_engine_category" ).dialog(
+    $( ".whurl_engine_category" ).dialog(
       {
         modal: true,
         autoOpen: false,
@@ -12,13 +12,13 @@
         }
       });
   });
-
-= form_for category, :remote => true do |f|
-  %div
-    = f.label :name
-    = f.text_field :name, :placeholder => 'eg. Users, Projects, Tweets, etc.'
-  %div
-    = f.label :description
-  %div
-    = f.text_area :description
-  = f.submit :value => 'Submit'
+.whurl_engine_category
+  = form_for category, :remote => true do |f|
+    %div
+      = f.label :name
+      = f.text_field :name, :placeholder => 'eg. Users, Projects, Tweets, etc.'
+    %div
+      = f.label :description
+    %div
+      = f.text_area :description
+    = f.submit :value => 'Submit'

data/app/views/whurl_engine/categories/edit.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:category => @category}))
 $('.content').append("#{content}");
-$('.edit_whurl_engine_category').dialog('open');
+$('.whurl_engine_category').dialog('open');

data/app/views/whurl_engine/categories/new.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:category => @category}))
 $('.content').append("#{content}");
-$('.new_whurl_engine_category').dialog('open');
+$('.whurl_engine_category').dialog('open');

data/app/views/whurl_engine/header_definitions/_form.html.haml

@@ -1,6 +1,6 @@
 :javascript
   $(function() {
-    $( ".new_whurl_engine_header_definition, .edit_whurl_engine_header_definition" ).dialog(
+    $( ".whurl_engine_header_definition" ).dialog(
       {
         modal: true,
         autoOpen: false,
@@ -12,20 +12,20 @@
         }
       });
   });
-
-= form_for(header_definition, :remote => true) do |f|
-  = f.hidden_field :resource_id
-  %div
-    = f.label :name
-    = f.text_field :name
-  %div
-    = f.check_box :required
-    = f.label :required
-  %div
-    = f.label :example_value
-    = f.text_field :example_value
-  %div
-    = f.label :description
-  %div
-    = f.text_area :description
-  = f.submit :value => 'Submit'
+.whurl_engine_header_definition
+  = form_for(header_definition, :remote => true) do |f|
+    = f.hidden_field :resource_id
+    %div
+      = f.label :name
+      = f.text_field :name
+    %div
+      = f.check_box :required
+      = f.label :required
+    %div
+      = f.label :example_value
+      = f.text_field :example_value
+    %div
+      = f.label :description
+    %div
+      = f.text_area :description
+    = f.submit :value => 'Submit'

data/app/views/whurl_engine/header_definitions/edit.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:header_definition => @header_definition}))
 $('.content').append("#{content}");
-$('.edit_whurl_engine_header_definition').dialog('open');
+$('.whurl_engine_header_definition').dialog('open');

data/app/views/whurl_engine/header_definitions/new.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:header_definition => @header_definition}))
 $('.content').append("#{content}");
-$('.new_whurl_engine_header_definition').dialog('open');
+$('.whurl_engine_header_definition').dialog('open');

data/app/views/whurl_engine/parameter_definitions/_form.html.haml

@@ -1,6 +1,6 @@
 :javascript
   $(function() {
-    $( ".new_whurl_engine_parameter_definition, .edit_whurl_engine_parameter_definition" ).dialog(
+    $( ".whurl_engine_parameter_definition" ).dialog(
       {
         modal: true,
         autoOpen: false,
@@ -13,19 +13,20 @@
       });
   });
 
-= form_for(parameter_definition, :remote => true) do |f|
-  = f.hidden_field :resource_id
-  %div
-    = f.label :name
-    = f.text_field :name
-  %div
-    = f.check_box :required
-    = f.label :required
-  %div
-    = f.label :example_value
-    = f.text_field :example_value
-  %div
-    = f.label :description
-  %div
-    = f.text_area :description
-  = f.submit :value => 'Submit'
+.whurl_engine_parameter_definition
+  = form_for(parameter_definition, :remote => true) do |f|
+    = f.hidden_field :resource_id
+    %div
+      = f.label :name
+      = f.text_field :name
+    %div
+      = f.check_box :required
+      = f.label :required
+    %div
+      = f.label :example_value
+      = f.text_field :example_value
+    %div
+      = f.label :description
+    %div
+      = f.text_area :description
+    = f.submit :value => 'Submit'

data/app/views/whurl_engine/parameter_definitions/edit.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:parameter_definition => @parameter_definition}))
 $('.content').append("#{content}");
-$('.edit_whurl_engine_parameter_definition').dialog('open');
+$('.whurl_engine_parameter_definition').dialog('open');

data/app/views/whurl_engine/parameter_definitions/new.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:parameter_definition => @parameter_definition}))
 $('.content').append("#{content}");
-$('.new_whurl_engine_parameter_definition').dialog('open');
+$('.whurl_engine_parameter_definition').dialog('open');

data/app/views/whurl_engine/resources/_form.html.haml

@@ -1,6 +1,6 @@
 :javascript
   $(function() {
-    $( ".new_whurl_engine_resource, .edit_whurl_engine_resource" ).dialog(
+    $( ".whurl_engine_resource" ).dialog(
       {
         modal: true,
         autoOpen: false,
@@ -12,29 +12,29 @@
         }
       });
   });
-
-= form_for @resource, :remote => true do |f|
-  = f.hidden_field :category_id
-  %div
-    = f.label :http_method
-    = f.select(:http_method, options_for_select(['GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS'], 'GET'))
-  %div
-    = f.label :base_uri
-    = f.text_field :base_uri, :placeholder => 'eg. https://api.twitter.com/1, https://api.groupon.com/v1, etc.'
-  %div
-    = f.label :relative_path
-    = f.text_field :relative_path, :placeholder => 'eg. statuses/home_timeline, users/:id/edit, etc.'
-  %div
-    = f.check_box :rate_limited
-    = f.label :rate_limited
-  %div
-    = f.check_box :requires_authentication
-    = f.label :requires_authentication
-  %div
-    = f.label :response_formats
-    = f.text_field :response_formats
-  %div
-    = f.label :description
-  %div
-    = f.text_area :description
-  = f.submit :value => 'Submit'
+.whurl_engine_resource
+  = form_for @resource, :remote => true do |f|
+    = f.hidden_field :category_id
+    %div
+      = f.label :http_method
+      = f.select(:http_method, options_for_select(['GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS'], 'GET'))
+    %div
+      = f.label :base_uri
+      = f.text_field :base_uri, :placeholder => 'eg. https://api.twitter.com/1, https://api.groupon.com/v1, etc.'
+    %div
+      = f.label :relative_path
+      = f.text_field :relative_path, :placeholder => 'eg. statuses/home_timeline, users/:id/edit, etc.'
+    %div
+      = f.check_box :rate_limited
+      = f.label :rate_limited
+    %div
+      = f.check_box :requires_authentication
+      = f.label :requires_authentication
+    %div
+      = f.label :response_formats
+      = f.text_field :response_formats
+    %div
+      = f.label :description
+    %div
+      = f.text_area :description
+    = f.submit :value => 'Submit'

data/app/views/whurl_engine/resources/edit.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:resource => @resource}))
 $('.content').append("#{content}");
-$('.edit_whurl_engine_resource').dialog('open');
+$('.whurl_engine_resource').dialog('open');

data/app/views/whurl_engine/resources/new.js.haml

@@ -1,3 +1,3 @@
 - content = escape_javascript(render(:partial => 'form', :locals => {:resource => @resource}))
 $('.content').append("#{content}");
-$('.new_whurl_engine_resource').dialog('open');
+$('.whurl_engine_resource').dialog('open');

data/app/views/whurl_engine/whurls/_edit_form.html.haml

@@ -13,17 +13,18 @@
       });
   });
 
-= form_for(whurl) do |f|
-  %div
-    = f.label :name
-    = f.text_field :name, :value => whurl.name || whurl.response_headers['Status']
+.edit_whurl_engine_whurl
+  = form_for(whurl) do |f|
+    %div
+      = f.label :name
+      = f.text_field :name, :value => whurl.name || whurl.response_headers['Status']
 
-  %div
-    = f.label :resource_id
-    = f.select(:resource_id, option_groups_from_collection_for_select(WhurlEngine::Category.all, :resources, :name, :id, :relative_path))
+    %div
+      = f.label :resource_id
+      = f.select(:resource_id, option_groups_from_collection_for_select(WhurlEngine::Category.all, :resources, :name, :id, :relative_path))
 
-  %div
-    = f.label :description
-  %div
-    = f.text_area :description
-  = f.submit :value => 'Submit'
+    %div
+      = f.label :description
+    %div
+      = f.text_area :description
+    = f.submit :value => 'Submit'

data/lib/whurl_engine/version.rb

@@ -1,3 +1,3 @@
 module WhurlEngine
-  VERSION = "2.1.0"
+  VERSION = "2.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whurl_engine
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,23 +9,23 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-20 00:00:00.000000000 -08:00
+date: 2012-02-27 00:00:00.000000000 -08:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &2152434520 !ruby/object:Gem::Requirement
+  requirement: &2154609800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *2152434520
+  version_requirements: *2154609800
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &2152434100 !ruby/object:Gem::Requirement
+  requirement: &2154609340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152434100
+  version_requirements: *2154609340
 - !ruby/object:Gem::Dependency
   name: httmultiparty
-  requirement: &2157985420 !ruby/object:Gem::Requirement
+  requirement: &2154608680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,65 +44,65 @@ dependencies:
         version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2157985420
+  version_requirements: *2154608680
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &2157984920 !ruby/object:Gem::Requirement
+  requirement: &2154608000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.4
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2157984920
+  version_requirements: *2154608000
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2157984460 !ruby/object:Gem::Requirement
+  requirement: &2154607420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2157984460
+  version_requirements: *2154607420
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2157984000 !ruby/object:Gem::Requirement
+  requirement: &2154606780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.3
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2157984000
+  version_requirements: *2154606780
 - !ruby/object:Gem::Dependency
   name: rinku
-  requirement: &2157983540 !ruby/object:Gem::Requirement
+  requirement: &2154606200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *2157983540
+  version_requirements: *2154606200
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &2157983080 !ruby/object:Gem::Requirement
+  requirement: &2154605620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.10
+        version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2157983080
+  version_requirements: *2154605620
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &2157982700 !ruby/object:Gem::Requirement
+  requirement: &2154605160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157982700
+  version_requirements: *2154605160
 - !ruby/object:Gem::Dependency
   name: heroku
-  requirement: &2157982240 !ruby/object:Gem::Requirement
+  requirement: &2154604540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157982240
+  version_requirements: *2154604540
 - !ruby/object:Gem::Dependency
   name: mysql
-  requirement: &2157981740 !ruby/object:Gem::Requirement
+  requirement: &2154603940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: 2.8.1
   type: :development
   prerelease: false
-  version_requirements: *2157981740
+  version_requirements: *2154603940
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2157981240 !ruby/object:Gem::Requirement
+  requirement: &2154603400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -143,7 +143,7 @@ dependencies:
         version: 1.7.10
   type: :development
   prerelease: false
-  version_requirements: *2157981240
+  version_requirements: *2154603400
 description: ! "Whurl is a mountable engine for Rails 3.1+ apps allowing\n                  you
   to show the functionality of your API. You can save API calls and share them with
   your team or the public."