whurl_engine 2.0.0 → 2.0.1

data/README.markdown

@@ -21,6 +21,14 @@ Then in your main app's routes.rb file, add this to make the whurl_engine routab
 
     mount WhurlEngine::Engine => "/whurl", :as => "whurl_engine"
 
+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
+
 Finally, look at your new API playground by starting your rails server and hitting up the right URL:
 
     http://localhost:3000/whurl

data/db/migrate/20110209054322_create_whurls_table.rb

@@ -0,0 +1,14 @@
+class CreateWhurlsTable < ActiveRecord::Migration
+  def self.up
+    create_table :whurls do |t|
+      t.string :hash_key, :limit => 6, :null => false
+      t.text :data
+      t.timestamps
+    end
+    add_index :whurls, :hash_key, :unique => true
+  end
+
+  def self.down
+    drop_table :whurls
+  end
+end

data/db/migrate/20111210192724_add_description_to_whurl.rb

@@ -0,0 +1,9 @@
+class AddDescriptionToWhurl < ActiveRecord::Migration
+  def self.up
+    add_column :whurls, :description, :string
+  end
+
+  def self.down
+    remove_column :whurls, :description
+  end
+end

data/db/migrate/20111210201607_add_custom_url_to_whurl.rb

@@ -0,0 +1,9 @@
+class AddCustomUrlToWhurl < ActiveRecord::Migration
+  def self.up
+    add_column :whurls, :custom_url, :string
+  end
+
+  def self.down
+    remove_column :whurls, :custom_url
+  end
+end

data/db/migrate/20111211030904_rename_whurls_to_requests.rb

@@ -0,0 +1,8 @@
+class RenameWhurlsToRequests < ActiveRecord::Migration
+  def change
+    rename_table :whurls, :whurl_engine_requests
+  end
+
+  def down
+  end
+end

data/db/migrate/20111220233800_create_fields_for_whurl_requests.rb

@@ -0,0 +1,18 @@
+class CreateFieldsForWhurlRequests < ActiveRecord::Migration
+  def self.up
+    add_column :whurl_engine_requests, :http_method, :string, :limit => 10
+    add_column :whurl_engine_requests, :body, :text
+    add_column :whurl_engine_requests, :query, :text
+    add_column :whurl_engine_requests, :headers, :text
+    add_column :whurl_engine_requests, :url, :text
+
+  end
+
+  def self.down
+    remove_column :whurl_engine_requests, :http_method
+    remove_column :whurl_engine_requests, :body
+    remove_column :whurl_engine_requests, :query
+    remove_column :whurl_engine_requests, :headers
+    remove_column :whurl_engine_requests, :url
+  end
+end

data/db/migrate/20111221011145_drop_data_from_requests.rb

@@ -0,0 +1,9 @@
+class DropDataFromRequests < ActiveRecord::Migration
+  def self.up
+    remove_column :whurl_engine_requests, :data
+  end
+
+  def self.down
+    add_column :whurl_engine_requests, :data, :text
+  end
+end

data/db/migrate/20120106033416_create_responses.rb

@@ -0,0 +1,11 @@
+class CreateResponses < ActiveRecord::Migration
+  def change
+    create_table :whurl_engine_responses do |t|
+      t.integer :request_id
+      t.string :content_type
+      t.text :body
+      t.text :headers
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120106190508_create_categories_table.rb

@@ -0,0 +1,9 @@
+class CreateCategoriesTable < ActiveRecord::Migration
+  def change
+    create_table :whurl_engine_categories do |t|
+      t.string :name
+      t.text :description
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120107011500_create_resources_table.rb

@@ -0,0 +1,15 @@
+class CreateResourcesTable < ActiveRecord::Migration
+  def change
+    create_table :whurl_engine_resources do |t|
+      t.integer :category_id
+      t.string :base_uri
+      t.string :relative_path
+      t.string :http_method
+      t.text :description
+      t.boolean :rate_limited
+      t.boolean :requires_authentication
+      t.text :response_formats
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120107065652_create_parameters_table.rb

@@ -0,0 +1,12 @@
+class CreateParametersTable < ActiveRecord::Migration
+  def change
+    create_table :whurl_engine_parameters do |t|
+      t.integer :resource_id
+      t.string :name
+      t.string :example_value
+      t.text :description
+      t.boolean :required
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20120110205837_rename_parameters_to_parameter_definitions.rb

@@ -0,0 +1,5 @@
+class RenameParametersToParameterDefinitions < ActiveRecord::Migration
+  def change
+    rename_table :whurl_engine_parameters, :whurl_engine_parameter_definitions
+  end
+end

data/db/migrate/20120110205853_rename_requests_to_whurls.rb

@@ -0,0 +1,19 @@
+class RenameRequestsToWhurls < ActiveRecord::Migration
+  def up
+    rename_table :whurl_engine_requests, :whurl_engine_whurls
+    drop_table :whurl_engine_responses
+    rename_column :whurl_engine_whurls, :custom_url, :name
+    rename_column :whurl_engine_whurls, :query, :request_parameters
+    rename_column :whurl_engine_whurls, :body, :request_body
+    rename_column :whurl_engine_whurls, :headers, :request_headers
+    rename_column :whurl_engine_whurls, :http_method, :request_method
+    rename_column :whurl_engine_whurls, :url, :request_url
+    add_column :whurl_engine_whurls, :resource_id, :integer
+    add_column :whurl_engine_whurls, :response_body, :text
+    add_column :whurl_engine_whurls, :response_content_type, :string
+    add_column :whurl_engine_whurls, :response_headers, :text
+  end
+
+  def down
+  end
+end

data/db/migrate/20120111014928_add_raw_request_to_whurls.rb

@@ -0,0 +1,5 @@
+class AddRawRequestToWhurls < ActiveRecord::Migration
+  def change
+    add_column :whurl_engine_whurls, :raw_request, :text
+  end
+end

data/db/migrate/20120118011913_create_header_definitions_table.rb

@@ -0,0 +1,10 @@
+class CreateHeaderDefinitionsTable < ActiveRecord::Migration
+  create_table :whurl_engine_header_definitions do |t|
+      t.integer :resource_id
+      t.string :name
+      t.string :example_value
+      t.text :description
+      t.boolean :required
+      t.timestamps
+    end
+end

data/lib/whurl_engine/version.rb

@@ -1,3 +1,3 @@
 module WhurlEngine
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whurl_engine
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-14 00:00:00.000000000 -08:00
+date: 2012-02-15 00:00:00.000000000 -08:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
-  requirement: &2157756400 !ruby/object:Gem::Requirement
+  requirement: &2158232900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.9.6
   type: :runtime
   prerelease: false
-  version_requirements: *2157756400
+  version_requirements: *2158232900
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &2157755980 !ruby/object:Gem::Requirement
+  requirement: &2158232480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157755980
+  version_requirements: *2158232480
 - !ruby/object:Gem::Dependency
   name: httmultiparty
-  requirement: &2157755440 !ruby/object:Gem::Requirement
+  requirement: &2158231940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2157755440
+  version_requirements: *2158231940
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &2157754940 !ruby/object:Gem::Requirement
+  requirement: &2158231440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 3.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *2157754940
+  version_requirements: *2158231440
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2157754480 !ruby/object:Gem::Requirement
+  requirement: &2158230980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: 1.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *2157754480
+  version_requirements: *2158230980
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2157754020 !ruby/object:Gem::Requirement
+  requirement: &2158230520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2157754020
+  version_requirements: *2158230520
 - !ruby/object:Gem::Dependency
   name: rinku
-  requirement: &2157770700 !ruby/object:Gem::Requirement
+  requirement: &2158230060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2157770700
+  version_requirements: *2158230060
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &2157770240 !ruby/object:Gem::Requirement
+  requirement: &2158229600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +99,10 @@ dependencies:
         version: 3.1.10
   type: :runtime
   prerelease: false
-  version_requirements: *2157770240
+  version_requirements: *2158229600
 - !ruby/object:Gem::Dependency
   name: uglifier
-  requirement: &2157769860 !ruby/object:Gem::Requirement
+  requirement: &2158229220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157769860
+  version_requirements: *2158229220
 - !ruby/object:Gem::Dependency
   name: heroku
-  requirement: &2157769400 !ruby/object:Gem::Requirement
+  requirement: &2158228760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157769400
+  version_requirements: *2158228760
 - !ruby/object:Gem::Dependency
   name: mysql
-  requirement: &2157768900 !ruby/object:Gem::Requirement
+  requirement: &2158228260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: 2.8.1
   type: :development
   prerelease: false
-  version_requirements: *2157768900
+  version_requirements: *2158228260
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &2157768400 !ruby/object:Gem::Requirement
+  requirement: &2158227760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -143,7 +143,7 @@ dependencies:
         version: 1.7.10
   type: :development
   prerelease: false
-  version_requirements: *2157768400
+  version_requirements: *2158227760
 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."
@@ -195,18 +195,6 @@ files:
 - app/assets/stylesheets/whurl_engine/custom-theme/images/ui-icons_ef8c08_256x240.png
 - app/assets/stylesheets/whurl_engine/custom-theme/images/ui-icons_ffffff_256x240.png
 - app/assets/stylesheets/whurl_engine/custom-theme/jquery-ui-1.8.16.custom.css
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/off.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/on.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_center.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_left.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/ios-style-checkboxes/slider_right.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/off.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/on.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_center.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_left.png
-- app/assets/stylesheets/whurl_engine/iphone-style-checkboxes/images/iphone-style-checkboxes/slider_right.png
 - app/assets/stylesheets/whurl_engine/whurl.css.scss
 - app/controllers/whurl_engine/application_controller.rb
 - app/controllers/whurl_engine/categories_controller.rb
@@ -267,7 +255,20 @@ files:
 - config/initializers/nilclass.rb
 - config/initializers/string.rb
 - config/routes.rb
-- db/migrate/20120212182833_create_schema.rb
+- db/migrate/20110209054322_create_whurls_table.rb
+- db/migrate/20111210192724_add_description_to_whurl.rb
+- db/migrate/20111210201607_add_custom_url_to_whurl.rb
+- db/migrate/20111211030904_rename_whurls_to_requests.rb
+- db/migrate/20111220233800_create_fields_for_whurl_requests.rb
+- db/migrate/20111221011145_drop_data_from_requests.rb
+- db/migrate/20120106033416_create_responses.rb
+- db/migrate/20120106190508_create_categories_table.rb
+- db/migrate/20120107011500_create_resources_table.rb
+- db/migrate/20120107065652_create_parameters_table.rb
+- db/migrate/20120110205837_rename_parameters_to_parameter_definitions.rb
+- db/migrate/20120110205853_rename_requests_to_whurls.rb
+- db/migrate/20120111014928_add_raw_request_to_whurls.rb
+- db/migrate/20120118011913_create_header_definitions_table.rb
 - db/migrate/20120214074332_add_message_to_whurls.rb
 - lib/tasks/whurl_engine_tasks.rake
 - lib/whurl_engine/config.rb

data/db/migrate/20120212182833_create_schema.rb

@@ -1,57 +0,0 @@
-class CreateSchema < ActiveRecord::Migration
-  def up
-    create_table :whurl_engine_categories do |t|
-      t.string   :name
-      t.text     :description
-      t.timestamps
-    end
-
-    create_table :whurl_engine_header_definitions do |t|
-      t.integer  :resource_id
-      t.string   :name
-      t.string   :example_value
-      t.text     :description
-      t.boolean  :required
-      t.timestamps
-    end
-
-    create_table :whurl_engine_parameter_definitions do |t|
-      t.integer  :resource_id
-      t.string   :name
-      t.string   :example_value
-      t.text     :description
-      t.boolean  :required
-      t.timestamps
-    end
-
-    create_table :whurl_engine_resources do |t|
-      t.integer  :category_id
-      t.string   :base_uri
-      t.string   :relative_path
-      t.string   :http_method
-      t.text     :description
-      t.boolean  :rate_limited
-      t.boolean  :requires_authentication
-      t.text     :response_formats
-      t.timestamps
-    end
-
-    create_table :whurl_engine_whurls do |t|
-      t.string   :hash_key, :limit => 6,  :null => false
-      t.string   :description
-      t.string   :request_method, :limit => 10
-      t.text     :request_body
-      t.text     :request_parameters
-      t.text     :request_headers
-      t.text     :request_url
-      t.integer  :resource_id
-      t.text     :response_body
-      t.string   :response_content_type
-      t.text     :response_headers
-      t.text     :raw_request
-      t.timestamps
-    end
-
-    add_index :whurl_engine_whurls, [:hash_key], :name => :index_whurls_on_hash_key, :unique => true
-  end
-end