grape_ape_rails 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +18 -0
  3. data/.rspec +2 -0
  4. data/.ruby-gemset +1 -0
  5. data/.ruby-version +1 -0
  6. data/Gemfile +4 -0
  7. data/LICENSE.txt +22 -0
  8. data/README.md +29 -0
  9. data/Rakefile +1 -0
  10. data/grape_ape_rails.gemspec +46 -0
  11. data/lib/generators/setup_generator.rb +59 -0
  12. data/lib/generators/templates/initializer.rb +22 -0
  13. data/lib/grape_ape_rails/api.rb +88 -0
  14. data/lib/grape_ape_rails/base.rb +27 -0
  15. data/lib/grape_ape_rails/handlers/formatters.rb +134 -0
  16. data/lib/grape_ape_rails/handlers/header_versioning.rb +27 -0
  17. data/lib/grape_ape_rails/handlers/locale.rb +24 -0
  18. data/lib/grape_ape_rails/handlers/rails_logging.rb +33 -0
  19. data/lib/grape_ape_rails/handlers/responses.rb +32 -0
  20. data/lib/grape_ape_rails/handlers.rb +22 -0
  21. data/lib/grape_ape_rails/railtie.rb +9 -0
  22. data/lib/grape_ape_rails/version.rb +3 -0
  23. data/lib/grape_ape_rails.rb +55 -0
  24. data/lib/swagger/grape_swagger_modified.rb +470 -0
  25. data/lib/tasks/routes.rake +13 -0
  26. data/spec/dummy/.rspec +1 -0
  27. data/spec/dummy/README.rdoc +28 -0
  28. data/spec/dummy/Rakefile +15 -0
  29. data/spec/dummy/app/assets/images/.keep +0 -0
  30. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  31. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  32. data/spec/dummy/app/controllers/api/base.rb +18 -0
  33. data/spec/dummy/app/controllers/api/v1/monkeys.rb +17 -0
  34. data/spec/dummy/app/controllers/api/v1/widgets.rb +57 -0
  35. data/spec/dummy/app/controllers/api/v2/widgets.rb +18 -0
  36. data/spec/dummy/app/controllers/application_controller.rb +5 -0
  37. data/spec/dummy/app/controllers/concerns/.keep +0 -0
  38. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  39. data/spec/dummy/app/mailers/.keep +0 -0
  40. data/spec/dummy/app/models/.keep +0 -0
  41. data/spec/dummy/app/models/concerns/.keep +0 -0
  42. data/spec/dummy/app/models/monkey.rb +3 -0
  43. data/spec/dummy/app/models/monkey_serializer.rb +7 -0
  44. data/spec/dummy/app/models/widget.rb +6 -0
  45. data/spec/dummy/app/views/api/v1/base_widget.rabl +1 -0
  46. data/spec/dummy/app/views/api/v1/widget.rabl +2 -0
  47. data/spec/dummy/app/views/api/v1/widgets.rabl +2 -0
  48. data/spec/dummy/app/views/api/v2/base_widget.rabl +2 -0
  49. data/spec/dummy/app/views/api/v2/widget.rabl +2 -0
  50. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  51. data/spec/dummy/bin/bundle +3 -0
  52. data/spec/dummy/bin/rails +4 -0
  53. data/spec/dummy/bin/rake +4 -0
  54. data/spec/dummy/config/application.rb +28 -0
  55. data/spec/dummy/config/boot.rb +5 -0
  56. data/spec/dummy/config/database.yml +25 -0
  57. data/spec/dummy/config/environment.rb +5 -0
  58. data/spec/dummy/config/environments/development.rb +29 -0
  59. data/spec/dummy/config/environments/production.rb +80 -0
  60. data/spec/dummy/config/environments/test.rb +36 -0
  61. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  62. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  63. data/spec/dummy/config/initializers/grape_ape_rails.rb +23 -0
  64. data/spec/dummy/config/initializers/inflections.rb +16 -0
  65. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  66. data/spec/dummy/config/initializers/secret_token.rb +12 -0
  67. data/spec/dummy/config/initializers/session_store.rb +3 -0
  68. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  69. data/spec/dummy/config/locales/en.yml +23 -0
  70. data/spec/dummy/config/routes.rb +5 -0
  71. data/spec/dummy/config.ru +4 -0
  72. data/spec/dummy/db/development.sqlite3 +0 -0
  73. data/spec/dummy/db/migrate/20140714154355_create_widgets.rb +10 -0
  74. data/spec/dummy/db/migrate/20140804173544_create_monkeys.rb +9 -0
  75. data/spec/dummy/db/schema.rb +30 -0
  76. data/spec/dummy/db/test.sqlite3 +0 -0
  77. data/spec/dummy/lib/assets/.keep +0 -0
  78. data/spec/dummy/public/404.html +58 -0
  79. data/spec/dummy/public/422.html +58 -0
  80. data/spec/dummy/public/500.html +57 -0
  81. data/spec/dummy/public/favicon.ico +0 -0
  82. data/spec/requests/v1/monkeys_spec.rb +22 -0
  83. data/spec/requests/v1/widgets_spec.rb +125 -0
  84. data/spec/requests/v2/widgets_spec.rb +41 -0
  85. data/spec/spec_helper.rb +102 -0
  86. metadata +524 -0
@@ -0,0 +1,13 @@
1
+ namespace :api do
2
+ desc "API Routes"
3
+ task :routes => :environment do
4
+ puts " #{'Method'.ljust(10)} #{'Version'.ljust(15)} #{'Path'}"
5
+ puts " #{'------'.ljust(10)} #{'-------'.ljust(15)} #{'----'}"
6
+ API::Base.routes.each do |api|
7
+ method = api.route_method.ljust(10)
8
+ version = (api.route_version || '').ljust(15)
9
+ path = api.route_path.gsub(":version", '')
10
+ puts " #{method} #{version} #{path}"
11
+ end
12
+ end
13
+ end
data/spec/dummy/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color
@@ -0,0 +1,28 @@
1
+ == README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
25
+
26
+
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.
@@ -0,0 +1,15 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require File.expand_path('../config/application', __FILE__)
5
+
6
+ Dummy::Application.load_tasks
7
+ desc "Print out Grape routes"
8
+ task :grape_routes => :environment do
9
+ API::Base.routes.each do |route|
10
+ info = route.instance_variable_get :@options
11
+ description = "%-40s..." % info[:description][0..39]
12
+ method = "%-7s" % info[:method]
13
+ puts "#{description} [#{info[:version]}] #{method}#{info[:path]}"
14
+ end
15
+ end
File without changes
@@ -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
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11
+ // about supported directives.
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,18 @@
1
+ module API
2
+ class Base < GrapeApeRails::API
3
+
4
+ grape_apis do
5
+ # always mount admins first and public-facing versions after
6
+ # with newest version lowest
7
+ api "V2" do
8
+ grape_mount :widgets
9
+ end
10
+
11
+ api "V1", ['V2', 'V1'] do
12
+ grape_mount :widgets
13
+ grape_mount :monkeys
14
+ end
15
+ end
16
+
17
+ end
18
+ end
@@ -0,0 +1,17 @@
1
+ module API
2
+ module V1
3
+ class Monkeys < GrapeApeRails::API
4
+ include GrapeApeRails::Handlers::All
5
+
6
+ formatter :json, Grape::Formatter::GarActiveModelSerializers
7
+
8
+ resource :monkeys do
9
+ desc "Get a single Monkey"
10
+ get ':id' do
11
+ @monkey = Monkey.find(params[:id])
12
+ @monkey
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,57 @@
1
+ module API
2
+ module V1
3
+ class Widgets < GrapeApeRails::API
4
+ include GrapeApeRails::Handlers::All
5
+
6
+ resource :widgets do
7
+ desc "Get a single Widget"
8
+ get ':id', rabl: 'v1/widget' do
9
+ @widget = Widget.find(params[:id])
10
+ @widget
11
+ end
12
+
13
+ desc "Get all Widgets"
14
+ get '/', rabl: 'v1/widgets' do
15
+ @widgets = Widget.all
16
+ @widgets
17
+ end
18
+
19
+ desc "Get a Widget, requiring a name"
20
+ params do
21
+ requires :name
22
+ end
23
+ get ':id/named', rabl: 'v1/widget' do
24
+ @widget = Widget.first
25
+ @widget
26
+ end
27
+
28
+ desc "Create a Widget"
29
+ params do
30
+ requires :name
31
+ requires :color
32
+ end
33
+ post "/", rabl: 'v1/widget' do
34
+ widget_params = params.except(:route_info, :format)
35
+ @widget = Widget.new widget_params
36
+ unless @widget.save
37
+ errs = @widget.errors.messages.map{ |a, m| "#{a} #{m.join(', ')}" }.join('; ')
38
+ error!({ code: 'CREATE_WIDGET_FAILED', message: "Resource failed validation. #{errs}" }, 422)
39
+ end
40
+ @widget
41
+ end
42
+
43
+ desc "Update a Widget"
44
+ put ":id", rabl: 'v1/widget' do
45
+ widget_params = params.except(:route_info, :format)
46
+ @widget = Widget.find(params[:id])
47
+ unless @widget.update_attributes widget_params
48
+ errs = @widget.errors.messages.map{ |a, m| "#{a} #{m.join(', ')}" }.join('; ')
49
+ error!({ code: 'UPDATE_WIDGET_FAILED', message: "Resource failed validation. #{errs}" }, 422)
50
+ end
51
+ @widget
52
+ end
53
+
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,18 @@
1
+ module API
2
+ module V2
3
+ class Widgets < GrapeApeRails::API
4
+ include GrapeApeRails::Handlers::All
5
+
6
+ resource :widgets do
7
+
8
+ desc "Get a single Widget [v2]"
9
+ get ':id', rabl: 'v2/widget' do
10
+ @widget = Widget.find(params[:id])
11
+ @widget
12
+ end
13
+
14
+ end
15
+
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,5 @@
1
+ class ApplicationController < ActionController::Base
2
+ # Prevent CSRF attacks by raising an exception.
3
+ # For APIs, you may want to use :null_session instead.
4
+ protect_from_forgery with: :exception
5
+ end
File without changes
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
File without changes
File without changes
File without changes
@@ -0,0 +1,3 @@
1
+ class Monkey < ActiveRecord::Base
2
+ validates_presence_of :name, :color
3
+ end
@@ -0,0 +1,7 @@
1
+ class MonkeySerializer < ActiveModel::Serializer
2
+ attributes :name, :color, :description, :created_at
3
+
4
+ def description
5
+ "#{object.name} is #{object.color} and was born on #{object.created_at}."
6
+ end
7
+ end
@@ -0,0 +1,6 @@
1
+ class Widget < ActiveRecord::Base
2
+
3
+ validates_presence_of :name, :color
4
+ validates_inclusion_of :color, in: %w[ red green blue orange ]
5
+
6
+ end
@@ -0,0 +1 @@
1
+ attributes *Widget.column_names
@@ -0,0 +1,2 @@
1
+ collection [@widget] => :widgets
2
+ extends "v1/base_widget"
@@ -0,0 +1,2 @@
1
+ collection @widgets => :widgets
2
+ extends "v1/base_widget"
@@ -0,0 +1,2 @@
1
+ attributes *Widget.column_names
2
+ node(:radioactive) { |w| { rads: w.rads, per_day: 7 } }
@@ -0,0 +1,2 @@
1
+ collection [@widget] => :widgets
2
+ extends "v2/base_widget"
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true %>
6
+ <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
3
+ require_relative '../config/boot'
4
+ require 'rails/commands'
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require_relative '../config/boot'
3
+ require 'rake'
4
+ Rake.application.run
@@ -0,0 +1,28 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ Bundler.require(*Rails.groups)
6
+
7
+ module Dummy
8
+ class Application < Rails::Application
9
+ # Settings in config/environments/* take precedence over those specified here.
10
+ # Application configuration should go into files in config/initializers
11
+ # -- all .rb files in that directory are automatically loaded.
12
+
13
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
14
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
15
+ # config.time_zone = 'Central Time (US & Canada)'
16
+
17
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
18
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
19
+ # config.i18n.default_locale = :de
20
+
21
+
22
+ config.middleware.use(Rack::Config) do |env|
23
+ env['api.tilt.root'] = Rails.root.join "app/views/api"
24
+ end
25
+
26
+ end
27
+ end
28
+
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
5
+ $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,25 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ development:
7
+ adapter: sqlite3
8
+ database: db/development.sqlite3
9
+ pool: 5
10
+ timeout: 5000
11
+
12
+ # Warning: The database defined as "test" will be erased and
13
+ # re-generated from your development database when you run "rake".
14
+ # Do not set this db to the same as development or production.
15
+ test:
16
+ adapter: sqlite3
17
+ database: db/test.sqlite3
18
+ pool: 5
19
+ timeout: 5000
20
+
21
+ production:
22
+ adapter: sqlite3
23
+ database: db/production.sqlite3
24
+ pool: 5
25
+ timeout: 5000
@@ -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,29 @@
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
+ # Do not eager load code on boot.
10
+ config.eager_load = false
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
+ # Raise an error on page load if there are pending migrations
23
+ # config.active_record.migration_error = :page_load
24
+
25
+ # Debug mode disables concatenation and preprocessing of assets.
26
+ # This option may cause significant delays in view rendering with a large
27
+ # number of complex assets.
28
+ config.assets.debug = true
29
+ end
@@ -0,0 +1,80 @@
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
+ # Eager load code on boot. This eager loads most of Rails and
8
+ # your application in memory, allowing both thread web servers
9
+ # and those relying on copy on write to perform better.
10
+ # Rake tasks automatically ignore this option for performance.
11
+ config.eager_load = true
12
+
13
+ # Full error reports are disabled and caching is turned on.
14
+ config.consider_all_requests_local = false
15
+ config.action_controller.perform_caching = true
16
+
17
+ # Enable Rack::Cache to put a simple HTTP cache in front of your application
18
+ # Add `rack-cache` to your Gemfile before enabling this.
19
+ # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
20
+ # config.action_dispatch.rack_cache = true
21
+
22
+ # Disable Rails's static asset server (Apache or nginx will already do this).
23
+ config.serve_static_assets = false
24
+
25
+ # Compress JavaScripts and CSS.
26
+ config.assets.js_compressor = :uglifier
27
+ # config.assets.css_compressor = :sass
28
+
29
+ # Do not fallback to assets pipeline if a precompiled asset is missed.
30
+ config.assets.compile = false
31
+
32
+ # Generate digests for assets URLs.
33
+ config.assets.digest = true
34
+
35
+ # Version of your assets, change this if you want to expire all your assets.
36
+ config.assets.version = '1.0'
37
+
38
+ # Specifies the header that your server uses for sending files.
39
+ # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
40
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
41
+
42
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
43
+ # config.force_ssl = true
44
+
45
+ # Set to :debug to see everything in the log.
46
+ config.log_level = :info
47
+
48
+ # Prepend all log lines with the following tags.
49
+ # config.log_tags = [ :subdomain, :uuid ]
50
+
51
+ # Use a different logger for distributed setups.
52
+ # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
53
+
54
+ # Use a different cache store in production.
55
+ # config.cache_store = :mem_cache_store
56
+
57
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
58
+ # config.action_controller.asset_host = "http://assets.example.com"
59
+
60
+ # Precompile additional assets.
61
+ # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
62
+ # config.assets.precompile += %w( search.js )
63
+
64
+ # Ignore bad email addresses and do not raise email delivery errors.
65
+ # Set this to true and configure the email server for immediate delivery to raise delivery errors.
66
+ # config.action_mailer.raise_delivery_errors = false
67
+
68
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
69
+ # the I18n.default_locale when a translation can not be found).
70
+ config.i18n.fallbacks = true
71
+
72
+ # Send deprecation notices to registered listeners.
73
+ config.active_support.deprecation = :notify
74
+
75
+ # Disable automatic flushing of the log to improve performance.
76
+ # config.autoflush_log = false
77
+
78
+ # Use default logging formatter so that PID and timestamp are not suppressed.
79
+ config.log_formatter = ::Logger::Formatter.new
80
+ end