endpoint_base 0.0.1 → 0.1.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 (80) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.travis.yml +1 -2
  4. data/Rakefile +18 -1
  5. data/app/views/application/500.json.jbuilder +2 -0
  6. data/app/views/application/response.json.jbuilder +21 -0
  7. data/endpoint_base.gemspec +17 -6
  8. data/lib/endpoint_base.rb +29 -8
  9. data/lib/endpoint_base/concerns.rb +7 -0
  10. data/lib/endpoint_base/concerns/all.rb +15 -0
  11. data/lib/endpoint_base/concerns/exception_handler.rb +26 -0
  12. data/lib/endpoint_base/concerns/param_processor.rb +54 -0
  13. data/lib/endpoint_base/concerns/rails_responder.rb +20 -0
  14. data/lib/endpoint_base/concerns/response_dsl.rb +44 -0
  15. data/lib/endpoint_base/concerns/sinatra_responder.rb +38 -0
  16. data/lib/endpoint_base/concerns/token_authorization.rb +28 -0
  17. data/lib/endpoint_base/rails.rb +1 -0
  18. data/lib/endpoint_base/rails/engine.rb +5 -0
  19. data/lib/endpoint_base/sinatra.rb +2 -0
  20. data/lib/endpoint_base/sinatra/base.rb +11 -0
  21. data/lib/endpoint_base/sinatra/integrator_utils.rb +17 -0
  22. data/spec/rails/controllers/failing_controller_spec.rb +29 -0
  23. data/spec/rails/controllers/happy_controller_spec.rb +35 -0
  24. data/spec/rails/dummy/.gitignore +16 -0
  25. data/spec/rails/dummy/Gemfile +46 -0
  26. data/spec/rails/dummy/README.rdoc +28 -0
  27. data/spec/rails/dummy/Rakefile +6 -0
  28. data/spec/rails/dummy/app/assets/images/.keep +0 -0
  29. data/spec/rails/dummy/app/assets/javascripts/application.js +16 -0
  30. data/spec/rails/dummy/app/assets/stylesheets/application.css +13 -0
  31. data/spec/rails/dummy/app/controllers/application_controller.rb +5 -0
  32. data/spec/rails/dummy/app/controllers/concerns/.keep +0 -0
  33. data/spec/rails/dummy/app/controllers/failing_controller.rb +7 -0
  34. data/spec/rails/dummy/app/controllers/happy_controller.rb +13 -0
  35. data/spec/rails/dummy/app/helpers/application_helper.rb +2 -0
  36. data/spec/rails/dummy/app/mailers/.keep +0 -0
  37. data/spec/rails/dummy/app/models/.keep +0 -0
  38. data/spec/rails/dummy/app/models/concerns/.keep +0 -0
  39. data/spec/rails/dummy/app/views/layouts/application.html.erb +14 -0
  40. data/spec/rails/dummy/bin/bundle +3 -0
  41. data/spec/rails/dummy/bin/rails +4 -0
  42. data/spec/rails/dummy/bin/rake +4 -0
  43. data/spec/rails/dummy/config.ru +4 -0
  44. data/spec/rails/dummy/config/application.rb +28 -0
  45. data/spec/rails/dummy/config/boot.rb +4 -0
  46. data/spec/rails/dummy/config/database.yml +25 -0
  47. data/spec/rails/dummy/config/environment.rb +5 -0
  48. data/spec/rails/dummy/config/environments/development.rb +29 -0
  49. data/spec/rails/dummy/config/environments/production.rb +80 -0
  50. data/spec/rails/dummy/config/environments/test.rb +36 -0
  51. data/spec/rails/dummy/config/initializers/backtrace_silencers.rb +7 -0
  52. data/spec/rails/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  53. data/spec/rails/dummy/config/initializers/inflections.rb +16 -0
  54. data/spec/rails/dummy/config/initializers/mime_types.rb +5 -0
  55. data/spec/rails/dummy/config/initializers/secret_token.rb +12 -0
  56. data/spec/rails/dummy/config/initializers/session_store.rb +3 -0
  57. data/spec/rails/dummy/config/initializers/wrap_parameters.rb +14 -0
  58. data/spec/rails/dummy/config/locales/en.yml +23 -0
  59. data/spec/rails/dummy/config/routes.rb +4 -0
  60. data/spec/rails/dummy/db/seeds.rb +7 -0
  61. data/spec/rails/dummy/lib/assets/.keep +0 -0
  62. data/spec/rails/dummy/lib/tasks/.keep +0 -0
  63. data/spec/rails/dummy/log/.keep +0 -0
  64. data/spec/rails/dummy/public/404.html +58 -0
  65. data/spec/rails/dummy/public/422.html +58 -0
  66. data/spec/rails/dummy/public/500.html +57 -0
  67. data/spec/rails/dummy/public/favicon.ico +0 -0
  68. data/spec/rails/dummy/public/robots.txt +5 -0
  69. data/spec/rails/dummy/vendor/assets/javascripts/.keep +0 -0
  70. data/spec/rails/dummy/vendor/assets/stylesheets/.keep +0 -0
  71. data/spec/rails/spec_helper.rb +13 -0
  72. data/spec/rails/support/controllers.rb +17 -0
  73. data/spec/sinatra/endpoint_base_spec.rb +55 -0
  74. data/spec/sinatra/spec_helper.rb +55 -0
  75. data/spec/spec_helper.rb +3 -32
  76. metadata +217 -18
  77. data/lib/cross_origin.rb +0 -49
  78. data/lib/integrator_utils.rb +0 -58
  79. data/spec/cross_origin_spec.rb +0 -20
  80. data/spec/integrator_utils_spec.rb +0 -52
@@ -0,0 +1,36 @@
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
+ # Do not eager load code on boot. This avoids loading your whole application
11
+ # just for the purpose of running a single test. If you are using a tool that
12
+ # preloads Rails for running tests, you may have to set it to true.
13
+ config.eager_load = false
14
+
15
+ # Configure static asset server for tests with Cache-Control for performance.
16
+ config.serve_static_assets = true
17
+ config.static_cache_control = "public, max-age=3600"
18
+
19
+ # Show full error reports and disable caching.
20
+ config.consider_all_requests_local = true
21
+ config.action_controller.perform_caching = false
22
+
23
+ # Raise exceptions instead of rendering exception templates.
24
+ config.action_dispatch.show_exceptions = false
25
+
26
+ # Disable request forgery protection in test environment.
27
+ config.action_controller.allow_forgery_protection = false
28
+
29
+ # Tell Action Mailer not to deliver emails to the real world.
30
+ # The :test delivery method accumulates sent emails in the
31
+ # ActionMailer::Base.deliveries array.
32
+ config.action_mailer.delivery_method = :test
33
+
34
+ # Print deprecation notices to the stderr.
35
+ config.active_support.deprecation = :stderr
36
+ end
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,4 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Configure sensitive parameters which will be filtered from the log file.
4
+ Rails.application.config.filter_parameters += [:password]
@@ -0,0 +1,16 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format. Inflections
4
+ # are locale specific, and you may define rules for as many different
5
+ # locales as you wish. All of these examples are active by default:
6
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
7
+ # inflect.plural /^(ox)$/i, '\1en'
8
+ # inflect.singular /^(ox)en/i, '\1'
9
+ # inflect.irregular 'person', 'people'
10
+ # inflect.uncountable %w( fish sheep )
11
+ # end
12
+
13
+ # These inflection rules are supported but not enabled by default:
14
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
15
+ # inflect.acronym 'RESTful'
16
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,12 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key is used for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+
6
+ # Make sure the secret is at least 30 characters and all random,
7
+ # no regular words or you'll be exposed to dictionary attacks.
8
+ # You can use `rake secret` to generate a secure secret key.
9
+
10
+ # Make sure your secret_key_base is kept private
11
+ # if you're sharing your code publicly.
12
+ Dummy::Application.config.secret_key_base = '40a4b95aa0a2f46ced0c3199d0726f8f0e1ebf552a60ab559d4ac4081f34173a069215e10815daea0d6164956f3b2d9bf8c7feb474a393e27eba3f6ce3dec2a6'
@@ -0,0 +1,3 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
@@ -0,0 +1,14 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # This file contains settings for ActionController::ParamsWrapper which
4
+ # is enabled by default.
5
+
6
+ # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7
+ ActiveSupport.on_load(:action_controller) do
8
+ wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
9
+ end
10
+
11
+ # To enable root element in JSON for ActiveRecord objects.
12
+ # ActiveSupport.on_load(:active_record) do
13
+ # self.include_root_in_json = true
14
+ # end
@@ -0,0 +1,23 @@
1
+ # Files in the config/locales directory are used for internationalization
2
+ # and are automatically loaded by Rails. If you want to use locales other
3
+ # than English, add the necessary files in this directory.
4
+ #
5
+ # To use the locales, use `I18n.t`:
6
+ #
7
+ # I18n.t 'hello'
8
+ #
9
+ # In views, this is aliased to just `t`:
10
+ #
11
+ # <%= t('hello') %>
12
+ #
13
+ # To use a different locale, set it with `I18n.locale`:
14
+ #
15
+ # I18n.locale = :es
16
+ #
17
+ # This would use the information in config/locales/es.yml.
18
+ #
19
+ # To learn more, please read the Rails Internationalization guide
20
+ # available at http://guides.rubyonrails.org/i18n.html.
21
+
22
+ en:
23
+ hello: "Hello world"
@@ -0,0 +1,4 @@
1
+ Dummy::Application.routes.draw do
2
+ post 'failing' => 'failing#index'
3
+ post 'happy' => 'happy#index'
4
+ end
@@ -0,0 +1,7 @@
1
+ # This file should contain all the record creation needed to seed the database with its default values.
2
+ # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
3
+ #
4
+ # Examples:
5
+ #
6
+ # cities = City.create([{ name: 'Chicago' }, { name: 'Copenhagen' }])
7
+ # Mayor.create(name: 'Emanuel', city: cities.first)
File without changes
File without changes
File without changes
@@ -0,0 +1,58 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <style>
6
+ body {
7
+ background-color: #EFEFEF;
8
+ color: #2E2F30;
9
+ text-align: center;
10
+ font-family: arial, sans-serif;
11
+ }
12
+
13
+ div.dialog {
14
+ width: 25em;
15
+ margin: 4em auto 0 auto;
16
+ border: 1px solid #CCC;
17
+ border-right-color: #999;
18
+ border-left-color: #999;
19
+ border-bottom-color: #BBB;
20
+ border-top: #B00100 solid 4px;
21
+ border-top-left-radius: 9px;
22
+ border-top-right-radius: 9px;
23
+ background-color: white;
24
+ padding: 7px 4em 0 4em;
25
+ }
26
+
27
+ h1 {
28
+ font-size: 100%;
29
+ color: #730E15;
30
+ line-height: 1.5em;
31
+ }
32
+
33
+ body > p {
34
+ width: 33em;
35
+ margin: 0 auto 1em;
36
+ padding: 1em 0;
37
+ background-color: #F7F7F7;
38
+ border: 1px solid #CCC;
39
+ border-right-color: #999;
40
+ border-bottom-color: #999;
41
+ border-bottom-left-radius: 4px;
42
+ border-bottom-right-radius: 4px;
43
+ border-top-color: #DADADA;
44
+ color: #666;
45
+ box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
46
+ }
47
+ </style>
48
+ </head>
49
+
50
+ <body>
51
+ <!-- This file lives in public/404.html -->
52
+ <div class="dialog">
53
+ <h1>The page you were looking for doesn't exist.</h1>
54
+ <p>You may have mistyped the address or the page may have moved.</p>
55
+ </div>
56
+ <p>If you are the application owner check the logs for more information.</p>
57
+ </body>
58
+ </html>
@@ -0,0 +1,58 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <style>
6
+ body {
7
+ background-color: #EFEFEF;
8
+ color: #2E2F30;
9
+ text-align: center;
10
+ font-family: arial, sans-serif;
11
+ }
12
+
13
+ div.dialog {
14
+ width: 25em;
15
+ margin: 4em auto 0 auto;
16
+ border: 1px solid #CCC;
17
+ border-right-color: #999;
18
+ border-left-color: #999;
19
+ border-bottom-color: #BBB;
20
+ border-top: #B00100 solid 4px;
21
+ border-top-left-radius: 9px;
22
+ border-top-right-radius: 9px;
23
+ background-color: white;
24
+ padding: 7px 4em 0 4em;
25
+ }
26
+
27
+ h1 {
28
+ font-size: 100%;
29
+ color: #730E15;
30
+ line-height: 1.5em;
31
+ }
32
+
33
+ body > p {
34
+ width: 33em;
35
+ margin: 0 auto 1em;
36
+ padding: 1em 0;
37
+ background-color: #F7F7F7;
38
+ border: 1px solid #CCC;
39
+ border-right-color: #999;
40
+ border-bottom-color: #999;
41
+ border-bottom-left-radius: 4px;
42
+ border-bottom-right-radius: 4px;
43
+ border-top-color: #DADADA;
44
+ color: #666;
45
+ box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
46
+ }
47
+ </style>
48
+ </head>
49
+
50
+ <body>
51
+ <!-- This file lives in public/422.html -->
52
+ <div class="dialog">
53
+ <h1>The change you wanted was rejected.</h1>
54
+ <p>Maybe you tried to change something you didn't have access to.</p>
55
+ </div>
56
+ <p>If you are the application owner check the logs for more information.</p>
57
+ </body>
58
+ </html>
@@ -0,0 +1,57 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <style>
6
+ body {
7
+ background-color: #EFEFEF;
8
+ color: #2E2F30;
9
+ text-align: center;
10
+ font-family: arial, sans-serif;
11
+ }
12
+
13
+ div.dialog {
14
+ width: 25em;
15
+ margin: 4em auto 0 auto;
16
+ border: 1px solid #CCC;
17
+ border-right-color: #999;
18
+ border-left-color: #999;
19
+ border-bottom-color: #BBB;
20
+ border-top: #B00100 solid 4px;
21
+ border-top-left-radius: 9px;
22
+ border-top-right-radius: 9px;
23
+ background-color: white;
24
+ padding: 7px 4em 0 4em;
25
+ }
26
+
27
+ h1 {
28
+ font-size: 100%;
29
+ color: #730E15;
30
+ line-height: 1.5em;
31
+ }
32
+
33
+ body > p {
34
+ width: 33em;
35
+ margin: 0 auto 1em;
36
+ padding: 1em 0;
37
+ background-color: #F7F7F7;
38
+ border: 1px solid #CCC;
39
+ border-right-color: #999;
40
+ border-bottom-color: #999;
41
+ border-bottom-left-radius: 4px;
42
+ border-bottom-right-radius: 4px;
43
+ border-top-color: #DADADA;
44
+ color: #666;
45
+ box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
46
+ }
47
+ </style>
48
+ </head>
49
+
50
+ <body>
51
+ <!-- This file lives in public/500.html -->
52
+ <div class="dialog">
53
+ <h1>We're sorry, but something went wrong.</h1>
54
+ </div>
55
+ <p>If you are the application owner check the logs for more information.</p>
56
+ </body>
57
+ </html>
File without changes
@@ -0,0 +1,5 @@
1
+ # See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
2
+ #
3
+ # To ban all spiders from the entire site uncomment the next two lines:
4
+ # User-agent: *
5
+ # Disallow: /
@@ -0,0 +1,13 @@
1
+ ENV["RAILS_ENV"] ||= 'test'
2
+ require File.expand_path("../dummy/config/environment", __FILE__)
3
+ require 'rspec/rails'
4
+
5
+ Dir["./spec/rails/support/**/*.rb"].each {|f| require f}
6
+
7
+ RSpec.configure do |config|
8
+ config.infer_base_class_for_anonymous_controllers = false
9
+ config.order = "random"
10
+ config.render_views
11
+ end
12
+
13
+ ENV['ENDPOINT_KEY'] = 'x123'
@@ -0,0 +1,17 @@
1
+ module Controllers
2
+ def Controllers.included(mod)
3
+ mod.before do
4
+ request.env["HTTP_ACCEPT"] = "application/json"
5
+ request.env["CONTENT_TYPE"] = "application/json"
6
+ request.env["HTTP_X_AUGURY_TOKEN"] = "x123"
7
+ end
8
+ end
9
+
10
+ def json_response
11
+ @json_response ||= ActiveSupport::JSON.decode(response.body)
12
+ end
13
+ end
14
+
15
+ RSpec.configure do |config|
16
+ config.include Controllers, :type => :controller
17
+ end
@@ -0,0 +1,55 @@
1
+ require File.join(File.dirname(__FILE__), 'spec_helper')
2
+
3
+ module EndpointBase::Sinatra
4
+ describe Base do
5
+ let(:payload) { { :message_id => 'abc456', :payload => {} }.to_json }
6
+ let(:headers) { {'HTTP_X_AUGURY_TOKEN' => 'x123', "CONTENT_TYPE" => "application/json"} }
7
+
8
+ it 'rejects request without auth' do
9
+ post '/', payload
10
+ expect(last_response.status).to eq 401
11
+ end
12
+
13
+ it 'accepts POST with auth' do
14
+ post '/', payload, headers
15
+ expect(last_response).to be_ok
16
+ end
17
+
18
+ it 'redirects to endpoint.json for GET on root url' do
19
+ get '/', nil, {}
20
+ expect(last_response.status).to eq 302
21
+ expect(last_response.location).to eq 'http://example.org/endpoint.json'
22
+ end
23
+
24
+ it 'returns a 200 for /auth check' do
25
+ get '/auth', {}, headers
26
+ expect(last_response).to be_ok
27
+ end
28
+
29
+ it 'parses valid json from body' do
30
+ post '/payload', {payload: {test: 1} }.to_json, headers
31
+
32
+ expect(::JSON.parse(last_response.body)['payload']['test']).to eq 1
33
+ end
34
+
35
+ it 'returns 406 if body is not valid json' do
36
+ post '/', 'notjson', headers
37
+ expect(last_response.status).to eq 406
38
+ end
39
+
40
+ it 'finds parameters' do
41
+ body = { 'payload' => { 'parameters' => [{'name' => 'x', 'value' => 1}, {'name' => '2', 'value' => 3}] } }.to_json
42
+ post '/config', body, headers
43
+
44
+ response = ::JSON.parse(last_response.body)['params']
45
+ expect(response['x']).to eq 1
46
+ expect(response['2']).to eq 3
47
+ end
48
+
49
+ it 'responds with application/json' do
50
+ post '/', payload, headers
51
+
52
+ expect(last_response.content_type).to eq 'application/json;charset=utf-8'
53
+ end
54
+ end
55
+ end
@@ -0,0 +1,55 @@
1
+ require 'simplecov'
2
+ SimpleCov.start do
3
+ add_filter 'spec/spec_helper'
4
+ add_filter 'lib/endpoint_base.rb'
5
+ coverage_dir 'coverage/sinatra'
6
+ end
7
+
8
+ require File.join(File.dirname(__FILE__), '../spec_helper')
9
+ require 'rubygems'
10
+ require 'bundler'
11
+ require 'vcr'
12
+ require 'json'
13
+ require 'sinatra'
14
+
15
+ Bundler.require(:default, :test)
16
+ require 'rack/test'
17
+
18
+ require File.join(File.dirname(__FILE__), '../..', 'lib', 'endpoint_base', 'sinatra', 'base.rb')
19
+
20
+ Sinatra::Base.environment = 'test'
21
+
22
+ def app
23
+ TestEndpoint
24
+ end
25
+
26
+ RSpec.configure do |config|
27
+ config.include Rack::Test::Methods
28
+ end
29
+
30
+ ENV['ENDPOINT_KEY'] = 'x123'
31
+
32
+ class TestEndpoint < EndpointBase::Sinatra::Base
33
+
34
+ set :logging, true
35
+
36
+ post '/' do
37
+ process_result 200
38
+ end
39
+
40
+ post '/payload' do
41
+ add_value :payload, @message[:payload]
42
+
43
+ process_result 200
44
+ end
45
+
46
+ post '/deprecated' do
47
+ process_result 200, @message
48
+ end
49
+
50
+ post '/config' do
51
+ add_value :params, @config
52
+
53
+ process_result 200
54
+ end
55
+ end