namespace all apicast sources in own directory

so we don't pollute global namespace with files
and prevent clashes when new dependencies are installed

CHANGELOG.md

@@ -12,6 +12,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Resolver can resolve nginx upstreams [PR #478](https://github.com/3scale/apicast/pull/478)
 - Calls 3scale backend with the 'no_body' option enabled. This reduces network traffic in cases where APIcast does not need to parse the response body [PR #483](https://github.com/3scale/apicast/pull/483)
 
+## Changed
+
+- Namespace all APIcast code in `apicast` folder. Possible BREAKING CHANGE for some customizations. [PR #486](https://github.com/3scale/apicast/pull/486)
+
 ## [3.2.0-alpha1]
 
 ## Added

doc/config.ld

@@ -1,9 +1,9 @@
 file = {
-  '../gateway/src/proxy.lua',
-  '../gateway/src/configuration/service.lua',
+  '../gateway/src/apicast/proxy.lua',
+  '../gateway/src/apicast/configuration/service.lua',
   '../gateway/src/resty/http_ng.lua',
   '../gateway/src/resty/http_ng/backend/resty.lua',
-  '../gateway/src/backend_client.lua',
+  '../gateway/src/apicast/backend_client.lua',
   '../gateway/src/resty/synchronization.lua',
 }
 dir = '../doc/api'

examples/custom-module/blacklist.lua

@@ -1,6 +1,6 @@
 local apicast = require('apicast').new()
 local iputils = require("resty.iputils")
-local default_balancer = require('balancer').default_balancer
+local default_balancer = require('apicast.balancer').default_balancer
 local resty_balancer = require('resty.balancer')
 
 local _M = { _VERSION = '0.0' }

gateway/conf.d/apicast.conf

@@ -1,13 +1,13 @@
-set_by_lua $user_agent 'return require("user_agent")()';
+set_by_lua $user_agent 'return require("apicast.user_agent")()';
 set_by_lua_block $deployment {
-  local user_agent = require('user_agent')
+  local user_agent = require('apicast.user_agent')
   return user_agent.platform() .. '+' .. user_agent.deployment()
 }
 
 # TODO: enable in the future when we support SSL
-# ssl_certificate_by_lua_block { require('executor').call() }
-# ssl_session_fetch_by_lua_block { require('executor').call() }
-# ssl_session_store_by_lua_block { require('executor').call() }
+# ssl_certificate_by_lua_block { require('apicast.executor').call() }
+# ssl_session_fetch_by_lua_block { require('apicast.executor').call() }
+# ssl_session_store_by_lua_block { require('apicast.executor').call() }
 
 location = /___http_call {
   internal;
@@ -48,11 +48,11 @@ location @out_of_band_authrep_action {
 
   set_by_lua $original_request_time 'return ngx.var.request_time';
 
-  content_by_lua_block { require('executor'):post_action() }
+  content_by_lua_block { require('apicast.executor'):post_action() }
 
   log_by_lua_block {
     ngx.var.post_action_impact = ngx.var.request_time - ngx.var.original_request_time
-    require('executor'):log()
+    require('apicast.executor'):log()
   }
 }
 
@@ -81,12 +81,12 @@ location / {
 
   proxy_ignore_client_abort on;
 
-  rewrite_by_lua_block { require('executor'):rewrite() }
-  access_by_lua_block { require('executor'):access() }
-  body_filter_by_lua_block { require('executor'):body_filter() }
-  header_filter_by_lua_block { require('executor'):header_filter() }
+  rewrite_by_lua_block { require('apicast.executor'):rewrite() }
+  access_by_lua_block { require('apicast.executor'):access() }
+  body_filter_by_lua_block { require('apicast.executor'):body_filter() }
+  header_filter_by_lua_block { require('apicast.executor'):header_filter() }
 
-  content_by_lua_block { require('executor'):content() }
+  content_by_lua_block { require('apicast.executor'):content() }
 
   proxy_pass $proxy_pass;
   proxy_http_version 1.1;

gateway/conf.d/management.conf

@@ -1,3 +1,3 @@
 location / {
-  content_by_lua_block { require('management').call() }
+  content_by_lua_block { require('apicast.management').call() }
 }

gateway/http.d/init.conf

@@ -8,7 +8,7 @@ init_by_lua_block {
     require("resty.core")
     require('resty.resolver').init()
 
-    local module = require('executor')
+    local module = require('apicast.executor')
 
     if not module then
       ngx.log(ngx.EMERG, 'fatal error when loading the root module')
@@ -21,7 +21,7 @@ init_by_lua_block {
 }
 
 init_worker_by_lua_block {
-    require('executor'):init_worker()
+    require('apicast.executor'):init_worker()
 }
 
 lua_shared_dict init 16k;

gateway/http.d/upstream.conf

@@ -1,7 +1,7 @@
 upstream upstream {
   server 0.0.0.1:1;
 
-  balancer_by_lua_block { require('executor'):balancer() }
+  balancer_by_lua_block { require('apicast.executor'):balancer() }
 
   keepalive 1024;
 }

gateway/libexec/boot.lua

@@ -1,7 +1,7 @@
 pcall(require, 'luarocks.loader')
 package.path = package.path .. ";./src/?.lua"
 
-local configuration = require 'configuration_loader'
+local configuration = require 'apicast.configuration_loader'
 
 local config = configuration.boot()
 

gateway/src/apicast.lua

@@ -1,13 +1,13 @@
-local balancer = require('balancer')
+local balancer = require('apicast.balancer')
 local math = math
 local setmetatable = setmetatable
 
-local user_agent = require('user_agent')
+local user_agent = require('apicast.user_agent')
 
 local noop = function() end
 
 local _M = {
-  _VERSION = require('version'),
+  _VERSION = require('apicast.version'),
   _NAME = 'APIcast'
 }
 

gateway/src/backend_client.lua → gateway/src/apicast/backend_client.lua

@@ -16,7 +16,7 @@ local len = string.len
 local format = string.format
 
 local http_ng = require('resty.http_ng')
-local user_agent = require('user_agent')
+local user_agent = require('apicast.user_agent')
 local resty_url = require('resty.url')
 local resty_env = require('resty.env')
 

gateway/src/configuration.lua → gateway/src/apicast/configuration.lua

@@ -19,8 +19,8 @@ local inspect = require 'inspect'
 local re = require 'ngx.re'
 local env = require 'resty.env'
 local resty_url = require 'resty.url'
-local util = require 'util'
-local policy_chain = require 'policy_chain'
+local util = require 'apicast.util'
+local policy_chain = require 'apicast.policy_chain'
 
 local mt = { __index = _M, __tostring = function() return 'Configuration' end }
 
@@ -132,7 +132,7 @@ local function check_querystring_params(params, args)
   return match
 end
 
-local Service = require 'configuration.service'
+local Service = require 'apicast.configuration.service'
 
 local noop = function() end
 local function readonly_table(table)

gateway/src/configuration/service.lua → gateway/src/apicast/configuration/service.lua

@@ -11,7 +11,7 @@ local select = select
 
 local http_authorization = require 'resty.http_authorization'
 
-local oauth = require('oauth')
+local oauth = require('apicast.oauth')
 
 local _M = { }
 local mt = { __index = _M  }

gateway/src/configuration_loader.lua → gateway/src/apicast/configuration_loader.lua

@@ -1,10 +1,10 @@
-local configuration_store = require('configuration_store')
-local configuration_parser = require 'configuration_parser'
-local mock_loader = require 'configuration_loader.mock'
-local file_loader = require 'configuration_loader.file'
-local remote_loader_v1 = require 'configuration_loader.remote_v1'
-local remote_loader_v2 = require 'configuration_loader.remote_v2'
-local util = require 'util'
+local configuration_store = require('apicast.configuration_store')
+local configuration_parser = require 'apicast.configuration_parser'
+local mock_loader = require 'apicast.configuration_loader.mock'
+local file_loader = require 'apicast.configuration_loader.file'
+local remote_loader_v1 = require 'apicast.configuration_loader.remote_v1'
+local remote_loader_v2 = require 'apicast.configuration_loader.remote_v2'
+local util = require 'apicast.util'
 local env = require('resty.env')
 local resty_url = require('resty.url')
 local synchronization = require('resty.synchronization').new(1)
@@ -55,7 +55,7 @@ local function ttl()
 end
 
 function _M.global(contents)
-  local context = require('executor'):context()
+  local context = require('apicast.executor'):context()
 
   return _M.configure(context.configuration, contents)
 end

gateway/src/configuration_loader/file.lua → gateway/src/apicast/configuration_loader/file.lua

@@ -4,7 +4,7 @@ local tostring = tostring
 local open = io.open
 local assert = assert
 local sub = string.sub
-local util = require 'util'
+local util = require 'apicast.util'
 local env = require 'resty.env'
 
 local _M = {

gateway/src/configuration_loader/remote_v1.lua → gateway/src/apicast/configuration_loader/remote_v1.lua

@@ -6,8 +6,8 @@ local tonumber = tonumber
 local resty_url = require 'resty.url'
 local http = require "resty.resolver.http"
 local socket_resolver = require('resty.resolver.socket')
-local configuration_parser = require 'configuration_parser'
-local user_agent = require 'user_agent'
+local configuration_parser = require 'apicast.configuration_parser'
+local user_agent = require 'apicast.user_agent'
 local env = require 'resty.env'
 
 local _M = {

gateway/src/configuration_loader/remote_v2.lua → gateway/src/apicast/configuration_loader/remote_v2.lua

@@ -10,11 +10,11 @@ local type = type
 
 local resty_url = require 'resty.url'
 local http_ng = require "resty.http_ng"
-local user_agent = require 'user_agent'
+local user_agent = require 'apicast.user_agent'
 local cjson = require 'cjson'
 local resty_env = require 'resty.env'
 local re = require 'ngx.re'
-local configuration = require 'configuration'
+local configuration = require 'apicast.configuration'
 
 local _M = {
   _VERSION = '0.1'

gateway/src/configuration_parser.lua → gateway/src/apicast/configuration_parser.lua

@@ -1,4 +1,4 @@
-local configuration = require 'configuration'
+local configuration = require 'apicast.configuration'
 local cjson = require 'cjson'
 
 local type = type

gateway/src/executor.lua → gateway/src/apicast/executor.lua

@@ -4,18 +4,18 @@
 -- when calling the policy chain methods. This 'context' contains information
 -- shared among policies.
 
-local policy_chain = require('policy_chain')
-local policy = require('policy')
-local linked_list = require('linked_list')
+local policy_chain = require('apicast.policy_chain')
+local policy = require('apicast.policy')
+local linked_list = require('apicast.linked_list')
 
 local setmetatable = setmetatable
 
 local _M = { }
 
 local DEFAULT_POLICIES = {
-    'policy.load_configuration',
-    'policy.find_service',
-    'policy.local_chain'
+    'apicast.policy.load_configuration',
+    'apicast.policy.find_service',
+    'apicast.policy.local_chain'
 }
 
 local mt = { __index = _M }

gateway/src/management.lua → gateway/src/apicast/management.lua

@@ -1,10 +1,10 @@
 local _M = {}
 
 local cjson = require('cjson')
-local context = require('executor'):context()
+local context = require('apicast.executor'):context()
 local router = require('router')
-local configuration_parser = require('configuration_parser')
-local configuration_loader = require('configuration_loader')
+local configuration_parser = require('apicast.configuration_parser')
+local configuration_loader = require('apicast.configuration_loader')
 local inspect = require('inspect')
 local resolver_cache = require('resty.resolver.cache')
 local env = require('resty.env')
@@ -87,7 +87,7 @@ function _M.delete_config()
   ngx.say(response)
 end
 
-local util = require 'util'
+local util = require 'apicast.util'
 
 function _M.boot()
   local data = util.timer('configuration.boot', configuration_loader.boot)

gateway/src/apicast/oauth.lua

@@ -0,0 +1,11 @@
+local apicast_oauth = require 'apicast.oauth.apicast_oauth'
+local oidc = require 'apicast.oauth.oidc'
+
+local _M = {
+  _VERSION = '0.0.2',
+
+  apicast = apicast_oauth,
+  oidc = oidc,
+}
+
+return _M

gateway/src/oauth/apicast_oauth.lua → gateway/src/apicast/oauth/apicast_oauth.lua

@@ -1,6 +1,6 @@
-local get_token = require 'oauth.apicast_oauth.get_token'
-local callback = require 'oauth.apicast_oauth.authorized_callback'
-local authorize = require 'oauth.apicast_oauth.authorize'
+local get_token = require 'apicast.oauth.apicast_oauth.get_token'
+local callback = require 'apicast.oauth.apicast_oauth.authorized_callback'
+local authorize = require 'apicast.oauth.apicast_oauth.authorize'
 local router = require 'router'
 
 local setmetatable = setmetatable

gateway/src/oauth/apicast_oauth/authorize.lua → gateway/src/apicast/oauth/apicast_oauth/authorize.lua

@@ -1,6 +1,6 @@
-local random = require 'resty.random'
-local ts = require 'threescale_utils'
-local backend_client = require('backend_client')
+local random = require('resty.random')
+local ts = require('apicast.threescale_utils')
+local backend_client = require('apicast.backend_client')
 local http_ng_ngx = require('resty.http_ng.backend.ngx')
 
 -- returns a unique string for the client_id. it will be short lived

gateway/src/oauth/apicast_oauth/authorized_callback.lua → gateway/src/apicast/oauth/apicast_oauth/authorized_callback.lua

@@ -5,7 +5,7 @@
 -- to this endpoint, with the same status code that we sent him at the
 -- moment of the first redirect
 local random = require 'resty.random'
-local ts = require 'threescale_utils'
+local ts = require 'apicast.threescale_utils'
 
 -- The authorization server should send some data in the callback response to let the
 -- API Gateway know which user to associate with the token.

gateway/src/oauth/apicast_oauth/get_token.lua → gateway/src/apicast/oauth/apicast_oauth/get_token.lua

@@ -1,8 +1,8 @@
 local cjson = require 'cjson'
-local ts = require 'threescale_utils'
+local ts = require 'apicast.threescale_utils'
 local re = require 'ngx.re'
 local env = require 'resty.env'
-local backend_client = require('backend_client')
+local backend_client = require('apicast.backend_client')
 local http_ng_ngx = require('resty.http_ng.backend.ngx')
 local tonumber = tonumber
 

gateway/src/oauth/oidc.lua → gateway/src/apicast/oauth/oidc.lua

@@ -2,7 +2,7 @@ local jwt = require 'resty.jwt'
 local jwt_validators = require 'resty.jwt-validators'
 
 local lrucache = require 'resty.lrucache'
-local util = require 'util'
+local util = require 'apicast.util'
 
 local setmetatable = setmetatable
 local len = string.len

gateway/src/policy/echo.lua → gateway/src/apicast/policy/echo.lua

@@ -1,4 +1,4 @@
-local policy = require('policy')
+local policy = require('apicast.policy')
 local _M = policy.new('Echo Policy')
 
 function _M.access()

gateway/src/policy/find_service.lua → gateway/src/apicast/policy/find_service.lua

@@ -1,8 +1,8 @@
 local next = next
 
-local policy = require('policy')
+local policy = require('apicast.policy')
 local _M = policy.new('Find Service Policy')
-local configuration_store = require 'configuration_store'
+local configuration_store = require 'apicast.configuration_store'
 local new = _M.new
 
 local function find_service_strict(configuration, host)

gateway/src/policy/load_configuration.lua → gateway/src/apicast/policy/load_configuration.lua

@@ -1,7 +1,7 @@
-local _M = require('policy').new('Load Configuration')
+local _M = require('apicast.policy').new('Load Configuration')
 
-local configuration_loader = require('configuration_loader').new()
-local configuration_store = require('configuration_store')
+local configuration_loader = require('apicast.configuration_loader').new()
+local configuration_store = require('apicast.configuration_store')
 
 local new = _M.new