Moved the interface renderer logic to the client

client/renderer/interfaces/interface_0.0.1.yaml

@@ -0,0 +1,52 @@
+---
+- name: cdb_geocode_admin0_polygon
+  return_type: Geometry
+  params:
+    - { name: country_name, type: text }
+
+- name: cdb_geocode_admin1_polygon
+  return_type: Geometry
+  params:
+    - { name: admin1_name, type: text }
+
+- name: cdb_geocode_admin1_polygon
+  return_type: Geometry
+  params:
+    - { name: admin1_name,  type: text }
+    - { name: country_name, type: text }
+
+- name: cdb_geocode_namedplace_point
+  return_type: Geometry
+  params:
+    - { name: city_name, type: text}
+
+- name: cdb_geocode_namedplace_point
+  return_type: Geometry
+  params:
+    - { name: city_name,    type: text}
+    - { name: country_name, type: text}
+
+- name: cdb_geocode_namedplace_point
+  return_type: Geometry
+  params:
+    - { name: city_name,    type: text}
+    - { name: admin1_name,  type: text}
+    - { name: country_name, type: text}
+
+
+- name: cdb_geocode_postalcode_polygon
+  return_type: Geometry
+  params:
+    - { name: postal_code,  type: text}
+    - { name: country_name, type: text}
+
+- name: cdb_geocode_postalcode_point
+  return_type: Geometry
+  params:
+    - { name: postal_code,  type: text}
+    - { name: country_name, type: text}
+
+- name: cdb_geocode_ipaddress_point
+  return_type: Geometry
+  params:
+    - { name: ip_address,  type: text}

client/renderer/interfaces/interface_0.1.0.yaml

@@ -0,0 +1,60 @@
+---
+- name: cdb_geocode_admin0_polygon
+  return_type: Geometry
+  params:
+    - { name: country_name, type: text }
+
+- name: cdb_geocode_admin1_polygon
+  return_type: Geometry
+  params:
+    - { name: admin1_name, type: text }
+
+- name: cdb_geocode_admin1_polygon
+  return_type: Geometry
+  params:
+    - { name: admin1_name,  type: text }
+    - { name: country_name, type: text }
+
+- name: cdb_geocode_namedplace_point
+  return_type: Geometry
+  params:
+    - { name: city_name, type: text}
+
+- name: cdb_geocode_namedplace_point
+  return_type: Geometry
+  params:
+    - { name: city_name,    type: text}
+    - { name: country_name, type: text}
+
+- name: cdb_geocode_namedplace_point
+  return_type: Geometry
+  params:
+    - { name: city_name,    type: text}
+    - { name: admin1_name,  type: text}
+    - { name: country_name, type: text}
+
+
+- name: cdb_geocode_postalcode_polygon
+  return_type: Geometry
+  params:
+    - { name: postal_code,  type: text}
+    - { name: country_name, type: text}
+
+- name: cdb_geocode_postalcode_point
+  return_type: Geometry
+  params:
+    - { name: postal_code,  type: text}
+    - { name: country_name, type: text}
+
+- name: cdb_geocode_ipaddress_point
+  return_type: Geometry
+  params:
+    - { name: ip_address,  type: text}
+
+- name: cdb_geocode_street_point
+  return_type: Geometry
+  params:
+    - { name: searchtext,  type: text}
+    - { name: city,  type: text, default: 'NULL'}
+    - { name: state_province,  type: text, default: 'NULL'}
+    - { name: country,  type: text, default: 'NULL'}

client/renderer/sql-template-renderer

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+# A script to automatically generate SQL files from an interface definition.
+# To be called like this: sql-template-renderer interface.yaml sql-template.erb
+
+require 'yaml'
+require 'erb'
+
+class SqlTemplateRenderer
+
+  GEOCODER_CLIENT_SCHEMA = 'cdb_geocoder_client'
+
+  def initialize(template_file, function_signature)
+    @function_signature = function_signature
+    @template = File.read(template_file)
+  end
+
+  def render
+    ERB.new(@template).result(binding)
+  end
+
+  def name
+    @function_signature['name']
+  end
+
+  def return_type
+    @function_signature['return_type']
+  end
+
+  def user_config_key
+    @function_signature['user_config_key']
+  end
+
+  def geocoder_config_key
+    @function_signature['geocoder_config_key']
+  end
+
+  def params
+    @function_signature['params'].map { |p| p['name'] }.join(', ')
+  end
+
+  def params_with_type
+    @function_signature['params'].map { |p| "#{p['name']} #{p['type']}" }.join(', ')
+  end
+
+  def params_with_type_and_default
+    parameters = @function_signature['params'].map do |p|
+      if not p['default'].nil?
+        "#{p['name']} #{p['type']} DEFAULT #{p['default']}"
+      else
+        "#{p['name']} #{p['type']}"
+      end
+    end
+    return parameters.join(', ')
+  end
+end
+
+
+if ARGV.length != 2 then
+  puts "Usage: sql-template-renderer <interface.yaml> <template.erb>"
+  exit
+end
+
+interface_source_file = ARGV[0]
+template_file = ARGV[1]
+
+
+functions = YAML.load(File.open(interface_source_file))
+
+functions.each do |f|
+  puts SqlTemplateRenderer.new(template_file, f).render
+end

client/renderer/templates/20_public_functions.erb

@@ -0,0 +1,26 @@
+--
+-- Public geocoder API function
+--
+-- These are the only ones with permissions to publicuser role
+-- and should also be the only ones with SECURITY DEFINER
+
+CREATE OR REPLACE FUNCTION <%= GEOCODER_CLIENT_SCHEMA %>.<%= name %> (<%= params_with_type_and_default %>)
+RETURNS <%= return_type %> AS $$
+DECLARE
+  ret <%= return_type %>;
+  username text;
+  orgname text;
+BEGIN
+  IF session_user = 'publicuser' OR session_user ~ 'cartodb_publicuser_*' THEN
+    RAISE EXCEPTION 'The api_key must be provided';
+  END IF;
+  SELECT u, o INTO username, orgname FROM <%= GEOCODER_CLIENT_SCHEMA %>._cdb_entity_config() AS (u text, o text);
+  -- JSON value stored "" is taken as literal
+  IF username IS NULL OR username = '' OR username = '""' THEN
+    RAISE EXCEPTION 'Username is a mandatory argument, check it out';
+  END IF;
+  SELECT <%= GEOCODER_CLIENT_SCHEMA %>._<%= name %>(username, orgname, <%= params %>) INTO ret;
+  RETURN ret;
+END;
+$$ LANGUAGE 'plpgsql' SECURITY DEFINER;
+

client/renderer/templates/30_plproxy_functions.erb

@@ -0,0 +1,6 @@
+CREATE OR REPLACE FUNCTION <%= GEOCODER_CLIENT_SCHEMA %>._<%= name %> (username text, organization_name text, <%= params_with_type_and_default %>)
+RETURNS <%= return_type %> AS $$
+  CONNECT <%= GEOCODER_CLIENT_SCHEMA %>._server_conn_str();
+  SELECT cdb_geocoder_server.<%= name %> (username, organization_name, <%= params %>);
+$$ LANGUAGE plproxy;
+

client/renderer/templates/90_grant_execute.erb

@@ -0,0 +1 @@
+GRANT EXECUTE ON FUNCTION <%= GEOCODER_CLIENT_SCHEMA %>.<%= name %>(<%= params_with_type %>) TO publicuser;