api_taster 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. data/.gitignore +11 -0
  2. data/.rspec +1 -0
  3. data/.travis.yml +3 -0
  4. data/Gemfile +6 -0
  5. data/README.md +68 -0
  6. data/Rakefile +40 -0
  7. data/api_taster.gemspec +27 -0
  8. data/app/assets/images/api_taster/.gitkeep +0 -0
  9. data/app/assets/javascripts/api_taster/01-prettify.js +28 -0
  10. data/app/assets/javascripts/api_taster/02-jquery.form.js +1076 -0
  11. data/app/assets/javascripts/api_taster/app.js +88 -0
  12. data/app/assets/javascripts/api_taster/application.js +16 -0
  13. data/app/assets/stylesheets/api_taster/01-prettify.css +1 -0
  14. data/app/assets/stylesheets/api_taster/02-prettify-sunburst.css +51 -0
  15. data/app/assets/stylesheets/api_taster/application.css +13 -0
  16. data/app/assets/stylesheets/api_taster/layout.css.scss +51 -0
  17. data/app/controllers/api_taster/application_controller.rb +5 -0
  18. data/app/controllers/api_taster/routes_controller.rb +12 -0
  19. data/app/helpers/api_taster/application_helper.rb +4 -0
  20. data/app/views/api_taster/routes/_param_form_element.html.erb +6 -0
  21. data/app/views/api_taster/routes/_param_form_legend.html.erb +1 -0
  22. data/app/views/api_taster/routes/_undefined_route.html.erb +7 -0
  23. data/app/views/api_taster/routes/index.html.erb +24 -0
  24. data/app/views/api_taster/routes/show.html.erb +55 -0
  25. data/app/views/layouts/api_taster/application.html.erb +29 -0
  26. data/config/routes.rb +5 -0
  27. data/lib/api_taster.rb +13 -0
  28. data/lib/api_taster/engine.rb +17 -0
  29. data/lib/api_taster/form_builder.rb +49 -0
  30. data/lib/api_taster/mapper.rb +30 -0
  31. data/lib/api_taster/route.rb +63 -0
  32. data/lib/api_taster/version.rb +3 -0
  33. data/lib/tasks/api_taster_tasks.rake +0 -0
  34. data/script/rails +8 -0
  35. data/spec/controllers/api_taster/routes_controller_spec.rb +21 -0
  36. data/spec/dummy/Rakefile +7 -0
  37. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  38. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  39. data/spec/dummy/app/controllers/application_controller.rb +4 -0
  40. data/spec/dummy/app/controllers/users_controller.rb +21 -0
  41. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  42. data/spec/dummy/app/mailers/.gitkeep +0 -0
  43. data/spec/dummy/app/models/.gitkeep +0 -0
  44. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  45. data/spec/dummy/config.ru +4 -0
  46. data/spec/dummy/config/application.rb +67 -0
  47. data/spec/dummy/config/boot.rb +10 -0
  48. data/spec/dummy/config/environment.rb +5 -0
  49. data/spec/dummy/config/environments/development.rb +37 -0
  50. data/spec/dummy/config/environments/production.rb +67 -0
  51. data/spec/dummy/config/environments/test.rb +37 -0
  52. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  53. data/spec/dummy/config/initializers/inflections.rb +15 -0
  54. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  55. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  56. data/spec/dummy/config/initializers/session_store.rb +8 -0
  57. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  58. data/spec/dummy/config/locales/en.yml +5 -0
  59. data/spec/dummy/config/routes.rb +33 -0
  60. data/spec/dummy/lib/assets/.gitkeep +0 -0
  61. data/spec/dummy/log/.gitkeep +0 -0
  62. data/spec/dummy/script/rails +6 -0
  63. data/spec/form_builder_spec.rb +29 -0
  64. data/spec/mapper_spec.rb +41 -0
  65. data/spec/route_spec.rb +71 -0
  66. data/spec/spec_helper.rb +12 -0
  67. metadata +503 -0
@@ -0,0 +1,30 @@
1
+ module ApiTaster
2
+ class Mapper
3
+ class << self
4
+ def get(path, params = {})
5
+ map_method(:get, path, params)
6
+ end
7
+
8
+ def post(path, params = {})
9
+ map_method(:post, path, params)
10
+ end
11
+
12
+ def put(path, params = {})
13
+ map_method(:put, path, params)
14
+ end
15
+
16
+ def delete(path, params = {})
17
+ map_method(:delete, path, params)
18
+ end
19
+
20
+ private
21
+
22
+ def map_method(method, path, params)
23
+ route = Route.find_by_verb_and_path(method, path)
24
+
25
+ Route.inputs[route[:id]] ||= []
26
+ Route.inputs[route[:id]] << params
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,63 @@
1
+ module ApiTaster
2
+ class Route
3
+ cattr_accessor :route_set
4
+ cattr_accessor :inputs
5
+
6
+ class << self
7
+ def routes
8
+ _routes = []
9
+
10
+ route_set.routes.each_with_index do |route, index|
11
+ next if route.verb.source.empty?
12
+
13
+ _routes << {
14
+ :id => index,
15
+ :name => route.name,
16
+ :verb => route.verb.source.gsub(/[$^]/, ''),
17
+ :path => route.path.spec.to_s.sub('(.:format)', ''),
18
+ :reqs => route.requirements
19
+ }
20
+ end
21
+
22
+ _routes
23
+ end
24
+
25
+ def grouped_routes
26
+ routes.group_by { |r| r[:reqs][:controller] }
27
+ end
28
+
29
+ def find(id)
30
+ routes.select { |r| r[:id] == id.to_i }[0]
31
+ end
32
+
33
+ def find_by_verb_and_path(verb, path)
34
+ routes.select do |r|
35
+ r[:path].to_s == path &&
36
+ r[:verb].to_s.downcase == verb.to_s.downcase
37
+ end[0]
38
+ end
39
+
40
+ def inputs_for(route)
41
+ unless inputs.has_key?(route[:id])
42
+ return { :undefined => route }
43
+ end
44
+
45
+ inputs[route[:id]].collect { |input| split_input(input, route) }
46
+ end
47
+
48
+ private
49
+
50
+ def split_input(input, route)
51
+ url_param_keys = route[:path].scan /:\w+/
52
+
53
+ url_params = input.select { |k| ":#{k}".in?(url_param_keys) }
54
+ post_params = input.diff(url_params)
55
+
56
+ {
57
+ :url_params => url_params,
58
+ :post_params => post_params
59
+ }
60
+ end
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,3 @@
1
+ module ApiTaster
2
+ VERSION = "0.1.0"
3
+ end
File without changes
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env ruby
2
+ # This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
3
+
4
+ ENGINE_ROOT = File.expand_path('../..', __FILE__)
5
+ ENGINE_PATH = File.expand_path('../../lib/api_taster/engine', __FILE__)
6
+
7
+ require 'rails/all'
8
+ require 'rails/engine/commands'
@@ -0,0 +1,21 @@
1
+ require 'spec_helper'
2
+
3
+ module ApiTaster
4
+ describe RoutesController do
5
+ it "#index" do
6
+ get :index, :use_route => :api_taster
7
+
8
+ assigns(:routes).should be_kind_of(Hash)
9
+ end
10
+
11
+ it "#show" do
12
+ Route.stub(:find).and_return(Route.new)
13
+ Route.stub(:inputs_for).and_return([])
14
+
15
+ get :show, :id => 1, :use_route => :api_taster
16
+
17
+ assigns(:route).should be_kind_of(Route)
18
+ assigns(:inputs).should be_kind_of(Array)
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env rake
2
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
3
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
4
+
5
+ require File.expand_path('../config/application', __FILE__)
6
+
7
+ Dummy::Application.load_tasks
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // the compiled file.
9
+ //
10
+ // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
11
+ // GO AFTER THE REQUIRES BELOW.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,13 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
9
+ * compiled file, but it's generally better to create a new file per style scope.
10
+ *
11
+ *= require_self
12
+ *= require_tree .
13
+ */
@@ -0,0 +1,4 @@
1
+ class ApplicationController < ActionController::Base
2
+ def home
3
+ end
4
+ end
@@ -0,0 +1,21 @@
1
+ class UsersController < ApplicationController
2
+ def index
3
+ render :json => { :hello => 'world' }
4
+ end
5
+
6
+ def show
7
+ render :json => params
8
+ end
9
+
10
+ def create
11
+ render :json => params
12
+ end
13
+
14
+ def update
15
+ render :json => params
16
+ end
17
+
18
+ def destroy
19
+ render :json => params
20
+ end
21
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
File without changes
File without changes
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application", :media => "all" %>
6
+ <%= javascript_include_tag "application" %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Dummy::Application
@@ -0,0 +1,67 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ # Pick the frameworks you want:
4
+ # require "active_record/railtie"
5
+ require "action_controller/railtie"
6
+ # require "action_mailer/railtie"
7
+ # require "active_resource/railtie"
8
+ require "sprockets/railtie"
9
+ # require "rails/test_unit/railtie"
10
+
11
+ Bundler.require
12
+ require "api_taster"
13
+
14
+ module Dummy
15
+ class Application < Rails::Application
16
+ # Settings in config/environments/* take precedence over those specified here.
17
+ # Application configuration should go into files in config/initializers
18
+ # -- all .rb files in that directory are automatically loaded.
19
+
20
+ # Custom directories with classes and modules you want to be autoloadable.
21
+ config.autoload_paths += %W(
22
+ #{ApiTaster::Engine.root}
23
+ )
24
+
25
+ # Only load the plugins named here, in the order given (default is alphabetical).
26
+ # :all can be used as a placeholder for all plugins not explicitly named.
27
+ # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
28
+
29
+ # Activate observers that should always be running.
30
+ # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
31
+
32
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
33
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
34
+ # config.time_zone = 'Central Time (US & Canada)'
35
+
36
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
37
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
38
+ # config.i18n.default_locale = :de
39
+
40
+ # Configure the default encoding used in templates for Ruby 1.9.
41
+ config.encoding = "utf-8"
42
+
43
+ # Configure sensitive parameters which will be filtered from the log file.
44
+ # config.filter_parameters += [:password]
45
+
46
+ # Enable escaping HTML in JSON.
47
+ # config.active_support.escape_html_entities_in_json = true
48
+
49
+ # Use SQL instead of Active Record's schema dumper when creating the database.
50
+ # This is necessary if your schema can't be completely dumped by the schema dumper,
51
+ # like if you have constraints or database-specific column types
52
+ # config.active_record.schema_format = :sql
53
+
54
+ # Enforce whitelist mode for mass assignment.
55
+ # This will create an empty whitelist of attributes available for mass-assignment for all models
56
+ # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
57
+ # parameters by using an attr_accessible or attr_protected declaration.
58
+ # config.active_record.whitelist_attributes = true
59
+
60
+ # Enable the asset pipeline
61
+ config.assets.enabled = true
62
+
63
+ # Version of your assets, change this if you want to expire all your assets
64
+ config.assets.version = '1.0'
65
+ end
66
+ end
67
+
@@ -0,0 +1,10 @@
1
+ require 'rubygems'
2
+ gemfile = File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ if File.exist?(gemfile)
5
+ ENV['BUNDLE_GEMFILE'] = gemfile
6
+ require 'bundler'
7
+ Bundler.setup
8
+ end
9
+
10
+ $:.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,5 @@
1
+ # Load the rails application
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the rails application
5
+ Dummy::Application.initialize!
@@ -0,0 +1,37 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the web server when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Log error messages when you accidentally call methods on nil.
10
+ config.whiny_nils = true
11
+
12
+ # Show full error reports and disable caching
13
+ config.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send
17
+ # config.action_mailer.raise_delivery_errors = false
18
+
19
+ # Print deprecation notices to the Rails logger
20
+ config.active_support.deprecation = :log
21
+
22
+ # Only use best-standards-support built into browsers
23
+ config.action_dispatch.best_standards_support = :builtin
24
+
25
+ # Raise exception on mass assignment protection for Active Record models
26
+ # config.active_record.mass_assignment_sanitizer = :strict
27
+
28
+ # Log the query plan for queries taking more than this (works
29
+ # with SQLite, MySQL, and PostgreSQL)
30
+ # config.active_record.auto_explain_threshold_in_seconds = 0.5
31
+
32
+ # Do not compress assets
33
+ config.assets.compress = false
34
+
35
+ # Expands the lines which load the assets
36
+ config.assets.debug = true
37
+ end
@@ -0,0 +1,67 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # Code is not reloaded between requests
5
+ config.cache_classes = true
6
+
7
+ # Full error reports are disabled and caching is turned on
8
+ config.consider_all_requests_local = false
9
+ config.action_controller.perform_caching = true
10
+
11
+ # Disable Rails's static asset server (Apache or nginx will already do this)
12
+ config.serve_static_assets = false
13
+
14
+ # Compress JavaScripts and CSS
15
+ config.assets.compress = true
16
+
17
+ # Don't fallback to assets pipeline if a precompiled asset is missed
18
+ # config.assets.compile = false
19
+
20
+ # Generate digests for assets URLs
21
+ config.assets.digest = true
22
+
23
+ # Defaults to nil and saved in location specified by config.assets.prefix
24
+ # config.assets.manifest = YOUR_PATH
25
+
26
+ # Specifies the header that your server uses for sending files
27
+ # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
28
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
29
+
30
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
31
+ # config.force_ssl = true
32
+
33
+ # See everything in the log (default is :info)
34
+ # config.log_level = :debug
35
+
36
+ # Prepend all log lines with the following tags
37
+ # config.log_tags = [ :subdomain, :uuid ]
38
+
39
+ # Use a different logger for distributed setups
40
+ # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
41
+
42
+ # Use a different cache store in production
43
+ # config.cache_store = :mem_cache_store
44
+
45
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server
46
+ # config.action_controller.asset_host = "http://assets.example.com"
47
+
48
+ # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
49
+ # config.assets.precompile += %w( search.js )
50
+
51
+ # Disable delivery errors, bad email addresses will be ignored
52
+ # config.action_mailer.raise_delivery_errors = false
53
+
54
+ # Enable threaded mode
55
+ # config.threadsafe!
56
+
57
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
58
+ # the I18n.default_locale when a translation can not be found)
59
+ config.i18n.fallbacks = true
60
+
61
+ # Send deprecation notices to registered listeners
62
+ config.active_support.deprecation = :notify
63
+
64
+ # Log the query plan for queries taking more than this (works
65
+ # with SQLite, MySQL, and PostgreSQL)
66
+ # config.active_record.auto_explain_threshold_in_seconds = 0.5
67
+ end
@@ -0,0 +1,37 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # The test environment is used exclusively to run your application's
5
+ # test suite. You never need to work with it otherwise. Remember that
6
+ # your test database is "scratch space" for the test suite and is wiped
7
+ # and recreated between test runs. Don't rely on the data there!
8
+ config.cache_classes = true
9
+
10
+ # Configure static asset server for tests with Cache-Control for performance
11
+ config.serve_static_assets = true
12
+ config.static_cache_control = "public, max-age=3600"
13
+
14
+ # Log error messages when you accidentally call methods on nil
15
+ config.whiny_nils = true
16
+
17
+ # Show full error reports and disable caching
18
+ config.consider_all_requests_local = true
19
+ config.action_controller.perform_caching = false
20
+
21
+ # Raise exceptions instead of rendering exception templates
22
+ config.action_dispatch.show_exceptions = false
23
+
24
+ # Disable request forgery protection in test environment
25
+ config.action_controller.allow_forgery_protection = false
26
+
27
+ # Tell Action Mailer not to deliver emails to the real world.
28
+ # The :test delivery method accumulates sent emails in the
29
+ # ActionMailer::Base.deliveries array.
30
+ # config.action_mailer.delivery_method = :test
31
+
32
+ # Raise exception on mass assignment protection for Active Record models
33
+ # config.active_record.mass_assignment_sanitizer = :strict
34
+
35
+ # Print deprecation notices to the stderr
36
+ config.active_support.deprecation = :stderr
37
+ end