worlddb-service 0.1.0

data/History.md

@@ -0,0 +1,3 @@
+### 0.1.0 / 2013-03-03
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.md
+Manifest.txt
+README.md
+Rakefile
+lib/worlddb/service.rb
+lib/worlddb/service/public/style.css
+lib/worlddb/service/server.rb
+lib/worlddb/service/version.rb
+lib/worlddb/service/views/_debug.erb
+lib/worlddb/service/views/_version.erb
+lib/worlddb/service/views/debug.erb
+lib/worlddb/service/views/index.erb
+lib/worlddb/service/views/layout.erb

data/README.md

@@ -0,0 +1,26 @@
+# world.db.api
+
+world.db web service - open world database web service sample // world.db HTTP API sample (JSON / CSV / HTML)
+
+
+* home  :: [github.com/geraldb/world.db.api](https://github.com/geraldb/world.db.api)
+* bugs  :: [github.com/geraldb/world.db.api/issues](https://github.com/geraldb/world.db.api/issues)
+* gem   :: [rubygems.org/gems/world-service](https://rubygems.org/gems/worlddb-service)
+* rdoc  :: [rubydoc.info/gems/world-service](http://rubydoc.info/gems/worlddb-service)
+* forum :: [groups.google.com/group/opensport](https://groups.google.com/group/opensport)
+
+
+## Demo
+
+Try the `world.db` Web Service demo running
+on Heroku [`worlddb.herokuapp.com/api`](http://worlddb.herokuapp.com/api).
+
+
+## License
+
+The `world.db.api` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Send them along to the [Open Sports Database & Friends Forum/Mailing List](http://groups.google.com/group/opensport). Thanks!

data/Rakefile

@@ -0,0 +1,30 @@
+require 'hoe'
+require './lib/worlddb/service/version.rb'
+
+
+Hoe.spec 'worlddb-service' do
+  
+  self.version = WorldDB::Service::VERSION
+  
+  self.summary = 'worlddb plugin for web service/HTTP API (JSON/CSV/HTML)'
+  self.description = summary
+
+  self.urls    = ['https://github.com/geraldb/world.db.api']
+  
+  self.author  = 'Gerald Bauer'
+  self.email   = 'opensport@googlegroups.com'
+    
+  self.readme_file  = 'README.md'
+  self.history_file = 'History.md'
+  
+  self.extra_deps = [
+    ['sinatra', '~> 1.3.5']
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   :required_ruby_version => '>= 1.9.2'
+  }
+  
+end

data/lib/worlddb/service.rb

@@ -0,0 +1,45 @@
+######
+# NB: use rackup to startup Sinatra service (see config.ru)
+#
+#  e.g. config.ru:
+#   require './boot'
+#   run WorldDb::Service::Server
+
+
+# stdlibs
+
+require 'csv'
+
+# 3rd party libs/gems
+
+require 'sinatra/base'
+
+# our own code
+
+require 'worlddb/service/version'
+
+
+module WorldDB::Service
+
+  def self.banner
+    "worlddb-service #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] on Sinatra/#{Sinatra::VERSION} (#{ENV['RACK_ENV']})"
+  end
+
+### fix: move to WorldDB
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+
+=begin  
+  def self.config_path
+    ## needed? use default db connection?
+    "#{root}/config"
+  end
+=end
+
+end #  module WorldDB
+
+require 'worlddb/service/server'
+
+# say hello
+puts WorldDB::Service.banner

data/lib/worlddb/service/public/style.css

@@ -0,0 +1,36 @@
+body {
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; }
+
+a {
+  color: black;
+  text-decoration: none; }
+  a:hover {
+    color: black;
+    background-color: aqua;
+    text-decoration: underline; }
+  a:visited {
+    color: black; }
+
+.params {
+  color: green;
+  font-style: italic;
+  font-weight: bold; }
+
+pre {
+  background-color: #F3F3F3;
+  border-bottom: 1px solid #BBBBBB;
+  border-top: 1px solid #BBBBBB;
+  padding: 4px; }
+
+
+/**********
+ * version / powered by
+ */
+
+.version {
+  text-align: center;
+  margin-top: 10px;
+  color: grey; }
+  .version a, .version span {
+    font-size: 12px;
+    color: grey; }

data/lib/worlddb/service/server.rb

@@ -0,0 +1,186 @@
+
+module WorldDB::Service
+
+class Server < Sinatra::Base
+
+  PUBLIC_FOLDER = "#{WorldDB::Service.root}/lib/worlddb/service/public"
+  VIEWS_FOLDER  = "#{WorldDB::Service.root}/lib/worlddb/service/views"
+
+  puts "[debug] worlddb-service - setting public folder to: #{PUBLIC_FOLDER}"
+  puts "[debug] worlddb-service - setting views folder to: #{VIEWS_FOLDER}" 
+  
+  set :public_folder, PUBLIC_FOLDER   # set up the static dir (with images/js/css inside)   
+  set :views,         VIEWS_FOLDER    # set up the views dir
+
+  set :static, true   # set up static file routing
+
+  #####################
+  # Models
+
+  include WorldDB::Models
+
+  ##############################################
+  # Controllers / Routing / Request Handlers
+
+  get '/' do
+    erb :index
+  end
+
+
+  get '/countries.?:format?' do
+    # todo: remove .all why? why not?
+    data = data_for_countries( Country.by_key.all )
+
+    format = params[:format] || 'json'
+
+    render_data( data, format )
+  end
+
+
+  get '/cities.?:format?' do
+    # todo: remove .all why? why not?
+    data = data_for_cities( City.by_key.all )
+
+    format = params[:format] || 'json'
+
+    render_data( data, format )
+  end
+
+
+  get '/tag/:part' do   # e.g. /tag/north_america.txt
+  
+    ##############
+    # NB:
+    #  get '/tag/:key.?:format?'
+    #   will NOT work - key is greedy and will include the optional format part
+  
+    # split part into slug/key and optional format
+    slug, format = params[:part].split('.')
+    format ||= 'json'
+  
+    data = data_for_countries( Tag.find_by_slug!( slug ).countries )
+
+    render_data( data, format )
+  end
+
+
+  get '/d*' do
+    erb :debug
+  end
+
+
+  private
+
+=begin
+  def csv_content_type
+    case request.user_agent
+    when /windows/i then 'application/vnd.ms-excel'
+    else                 'text/csv'
+    end
+  end
+=end
+
+  def data_for_cities( cities )
+    ## fix: move to model? why? why not?
+    
+    ## add virtual column like kind for metro, metro|city, city, district
+  
+    ## todo add region.title if present  
+  
+    data = []
+    cities.each do |city|
+      data << { key:      city.key,
+                title:    city.title,
+                code:     city.code,
+                pop:      city.pop,
+                popm:     city.popm,
+                area:     city.area,
+                synonyms: city.synonyms,
+                country:  city.country.title }      
+    end # each city
+    data
+  end
+
+  def data_for_countries( countries )
+    ## fix: move to model? why? why not?  
+  
+    ## todo: add tags too??
+    
+    data = []
+    countries.each do |country|
+      data << { key:      country.key,
+                title:    country.title,
+                code:     country.code,
+                pop:      country.pop,
+                area:     country.area,
+                synonyms: country.synonyms }
+    end # each country
+    data  
+  end
+  
+  
+  def csv_for_data( data )
+    ## :col_sep => "\t"
+    ## :col_sep => ";"
+
+    ## todo: use rec.key for headers/first row
+    
+    csv_string = CSV.generate() do |csv|
+      data.each do |rec|
+        csv << rec.values
+      end
+    end
+    csv_string
+  end # method csv_for_data
+
+
+  def table_for_data( data )
+    buf = ""
+    buf << "<html><head><meta http-equiv='Content-Type' content='text/html; charset=utf-8'></head><body>\n"
+    buf << "<table>\n"
+    data.each do |rec|
+      buf << "  <tr>"
+      rec.values.each do |value|
+        buf << "<td>#{value}</td>"
+      end
+      buf << "</tr>\n"
+    end
+    buf << "</table>\n"
+    buf << "</body></html>"
+    buf
+  end # method table_for_data
+
+### helper for json or jsonp response (depending on callback para)
+
+def json_or_jsonp( data )
+  callback = params.delete('callback')
+  response = ''
+
+  if callback
+    content_type :js
+    response = "#{callback}(#{data.to_json})"
+  else
+    content_type :json
+    response = data.to_json
+  end
+  
+  response
+end
+
+
+  def render_data( data, format )
+    if format == 'csv' || format == 'txt'
+      headers 'Content-Type' => 'text/plain; charset=utf-8'
+      csv_for_data( data )
+    elsif format == 'html' || format == 'htm'
+      table_for_data( data )
+    else
+      json_or_jsonp( data )
+    end
+  end
+
+
+end # class Server
+
+
+end #  module WorldDB::Service

data/lib/worlddb/service/version.rb

@@ -0,0 +1,6 @@
+
+module WorldDB
+  module Service
+    VERSION='0.1.0'
+  end
+end

data/lib/worlddb/service/views/_debug.erb

@@ -0,0 +1,17 @@
+
+<h3>Debug</h3>
+
+<pre>
+  request.scheme          <%= request.scheme %>
+  request.script_name     <%= request.script_name %>
+  request.path_info       <%= request.path_info %>
+  request.port            <%= request.port %>
+  request.request_method  <%= request.request_method %>
+  request.query_string    <%= request.query_string %>
+  request.host            <%= request.host %>
+  request.referrer        <%= request.referrer %>
+  request.user_agent      <%= request.user_agent %>
+  request.url             <%= request.url %>
+  request.path            <%= request.path %>
+  request.ip              <%= request.ip %>
+</pre>

data/lib/worlddb/service/views/_version.erb

@@ -0,0 +1,7 @@
+<div class='version'>
+  <a href="http://groups.google.com/group/opensport">Questions? Comments?</a> |
+  <a href="https://github.com/geraldb/world.db">world.db/<%= WorldDB::VERSION %></a>,
+  <a href="https://github.com/geraldb/world.db.api">world.db.api/<%= WorldDB::Service::VERSION %></a> -
+  <span>Ruby/<%= "#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}/#{RUBY_PLATFORM})" %> on</span>
+  <span>Sinatra/<%= Sinatra::VERSION %> (<%= ENV['RACK_ENV'] %>)</span>
+</div>

data/lib/worlddb/service/views/debug.erb

@@ -0,0 +1,2 @@
+
+<%= erb :'_debug' %>

data/lib/worlddb/service/views/index.erb

@@ -0,0 +1,131 @@
+
+<h1>world.db JSON(P) API Demo</h1>
+
+<h2>Examples</h2>
+
+
+<h3>List all countries <code>/countries.(txt|html)</code></h3>
+
+<table>
+  <td>
+    <code>
+     <a href='<%= url("/countries") %>'>
+        /countries
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/countries.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/countries.html") %>'>.html</a></code>
+  </td>
+ </tr>
+</table>
+
+<h3>List all countries for a tag <code>/tag/<span class='params'>:tag</span></code></h3>
+
+<table>
+ <tr>
+  <td>
+    <code>
+     <a href='<%= url("/tag/europe") %>'>
+        /tag/<span class='params'>europe</span>
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/tag/europe.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/tag/europe.html") %>'>.html</a></code>
+  </td>
+ </tr>
+
+ <tr>
+  <td>
+    <code>
+     <a href='<%= url("/tag/south_america") %>'>
+        /tag/<span class='params'>south_america</span>
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/tag/south_america.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/tag/south_america.html") %>'>.html</a></code>
+  </td>
+ </tr>
+
+ <tr>
+  <td>
+    <code>
+     <a href='<%= url("/tag/un") %>'>
+        /tag/<span class='params'>un</span>
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/tag/un.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/tag/un.html") %>'>.html</a></code>
+  </td>
+ </tr>
+
+<tr>
+  <td>
+    <code>
+     <a href='<%= url("/tag/eu") %>'>
+        /tag/<span class='params'>eu</span>
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/tag/eu.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/tag/eu.html") %>'>.html</a></code>
+  </td>
+ </tr>
+
+ <tr>
+  <td>
+    <code>
+     <a href='<%= url("/tag/uefa") %>'>
+        /tag/<span class='params'>uefa</span>
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/tag/uefa.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/tag/uefa.html") %>'>.html</a></code>
+  </td>
+ </tr>
+
+</table>
+
+<h3>List all cities <code>/cities.(txt|html)</code></h3>
+
+<table>
+  <td>
+    <code>
+     <a href='<%= url("/cities") %>'>
+        /cities
+     </a>
+    </code>
+  </td>
+  <td>
+     &nbsp; &nbsp; &nbsp; &nbsp;
+     Alternative Formats:
+     <code><a href='<%= url("/cities.txt") %>'>.txt</a></code> |
+     <code><a href='<%= url("/cities.html") %>'>.html</a></code>
+  </td>
+ </tr>
+</table>
+
+
+<%= erb :'_debug' %>

data/lib/worlddb/service/views/layout.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='UTF-8'>  
+  <title>world.db web service / HTTP API sample (JSON / CSV / HTML)</title>
+  <link href="<%= url('/style.css') %>" rel='stylesheet'>
+</head>
+<body>
+
+<%= yield %>
+
+<%= erb :'_version' %>
+
+</body>
+</html>

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: worlddb-service
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &78697180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *78697180
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &78696960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: *78696960
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &78696740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: *78696740
+description: worlddb plugin for web service/HTTP API (JSON/CSV/HTML)
+email: opensport@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Manifest.txt
+files:
+- History.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/worlddb/service.rb
+- lib/worlddb/service/public/style.css
+- lib/worlddb/service/server.rb
+- lib/worlddb/service/version.rb
+- lib/worlddb/service/views/_debug.erb
+- lib/worlddb/service/views/_version.erb
+- lib/worlddb/service/views/debug.erb
+- lib/worlddb/service/views/index.erb
+- lib/worlddb/service/views/layout.erb
+homepage: https://github.com/geraldb/world.db.api
+licenses:
+- Public Domain
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: worlddb-service
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: worlddb plugin for web service/HTTP API (JSON/CSV/HTML)
+test_files: []