module Sinatra::API
Copyright © 2013 Algol Labs, LLC. <dev@algollabs.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copyright © 2013 Algol Labs, LLC. <dev@algollabs.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copyright © 2013 Algol Labs, LLC. <dev@algollabs.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Constants
- ResourcePrefix
- VERSION
Attributes
@!attribute instance
@return [Sinatra::Base] The Sinatra application.
@!attribute config
@return [Sinatra::API::Config] Runtime configuration options.
@!attribute instance
@return [Sinatra::Application] The Sinatra instance that is evaluating the current request.
@!attribute logger
@return [ActiveSupport::Logger] A Logger instance.
Public Class Methods
# File lib/sinatra/api.rb, line 79 def configure(options = {}) self.config = Config.new(options) end
Parse a JSON construct from a string stream.
Override this to use a custom JSON parser, if necessary.
@param [String] stream The raw JSON stream.
@return [Hash] A Hash of the parsed JSON.
# File lib/sinatra/api.rb, line 75 def parse_json(stream) ::JSON.parse(stream) end
# File lib/sinatra/api.rb, line 83 def process!(params, request) request.body.rewind raw_json = request.body.read.to_s || '' unless raw_json.empty? begin params.merge!(self.parse_json(raw_json)) rescue ::JSON::ParserError => e logger.warn e.message logger.warn e.backtrace instance.halt 400, "Malformed JSON content" end end end
# File lib/sinatra/api.rb, line 102 def self.registered(app) api = self self.app = app self.logger = ActiveSupport::Logger.new(STDOUT) self.logger.level = 100 app.helpers Helpers, Parameters, Resources ParameterValidator.install(api) on :with_errors_setting do |setting| app.helpers ErrorHandler if setting end on :verbose_setting do |setting| logger.level = setting ? 0 : 100 end app.before do api.instance = self api.trigger :request, self api.process!(params, request) if api_call? end end