aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichel Etienne2012-03-23 16:14:08 +0100
committerMichel Etienne2012-03-23 16:14:08 +0100
commit397452509d86d527804e055a196c43753f49fa29 (patch)
treeca20a6ac187513bd4781fa69ce35d53e22b5e1a3
parentfa5833943881a7b0dbdffcce1e4b364986196f0f (diff)
downloadchouette-core-397452509d86d527804e055a196c43753f49fa29.tar.bz2
add hint and rest API info
-rw-r--r--Gemfile2
-rw-r--r--Gemfile.lock140
-rw-r--r--config/locales/companies.yml10
-rw-r--r--config/locales/lines.yml10
-rw-r--r--config/locales/networks.yml11
-rw-r--r--config/locales/stop_areas.yml12
-rw-r--r--doc/functional/index.textile19
-rw-r--r--doc/functional/restapis.textile21
8 files changed, 159 insertions, 66 deletions
diff --git a/Gemfile b/Gemfile
index 30bb3cb8f..b3739fa00 100644
--- a/Gemfile
+++ b/Gemfile
@@ -63,7 +63,7 @@ group :development do
gem 'capistrano-ext'
gem 'guard'
gem 'guard-rspec'
- #gem 'jekyll'
+ gem 'jekyll'
gem 'RedCloth'
end
diff --git a/Gemfile.lock b/Gemfile.lock
index 10456c7d0..58f789856 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -40,11 +40,11 @@ GIT
GIT
remote: git://github.com/thoughtbot/shoulda.git
- revision: 80545637b957fc68a3b7be8993033d089913ac66
+ revision: f75da7490e542d2da228b2dd74b3ca585f2bbdda
specs:
- shoulda (3.0.0.beta2)
- shoulda-context (~> 1.0.0.beta1)
- shoulda-matchers (~> 1.0.0.beta1)
+ shoulda (3.0.1)
+ shoulda-context (~> 1.0.0)
+ shoulda-matchers (~> 1.0.0)
GIT
remote: git://sim.dryade.priv/user_interface
@@ -59,9 +59,8 @@ GEM
GeoRuby (1.3.4)
RedCloth (4.2.9)
RedCloth (4.2.9-java)
- SyslogLogger (1.4.0)
- hoe (>= 1.2.0)
- ZenTest (4.5.0)
+ SyslogLogger (1.4.1)
+ ZenTest (4.7.0)
actionmailer (3.1.3)
actionpack (= 3.1.3)
mail (~> 2.3.0)
@@ -90,16 +89,18 @@ GEM
activesupport (= 3.1.3)
activesupport (3.1.3)
multi_json (~> 1.0)
- addressable (2.2.6)
+ addressable (2.2.7)
+ albino (1.3.3)
+ posix-spawn (>= 0.3.6)
arel (2.2.3)
autotest-notification (2.3.4)
autotest-standalone (~> 4.5)
- autotest-rails (4.1.1)
- ZenTest (= 4.5)
+ autotest-rails (4.1.2)
+ ZenTest (~> 4.5)
autotest-standalone (4.5.9)
bouncy-castle-java (1.5.0146.1)
builder (3.0.0)
- capistrano (2.9.0)
+ capistrano (2.11.2)
highline
net-scp (>= 1.0.0)
net-sftp (>= 2.0.0)
@@ -114,46 +115,50 @@ GEM
rack-test (>= 0.5.4)
selenium-webdriver (~> 2.0)
xpath (~> 0.1.4)
- childprocess (0.3.0)
+ childprocess (0.3.1)
ffi (~> 1.0.6)
+ classifier (1.3.3)
+ fast-stemmer (>= 1.0.0)
coffee-rails (3.1.1)
coffee-script (>= 2.2.0)
railties (~> 3.1.0)
coffee-script (2.2.0)
coffee-script-source
execjs
- coffee-script-source (1.1.2)
+ coffee-script-source (1.2.0)
composite_primary_keys (4.1.2)
activerecord (~> 3.1)
- cucumber (1.1.4)
+ cucumber (1.1.9)
builder (>= 2.1.2)
diff-lcs (>= 1.1.2)
- gherkin (~> 2.7.1)
+ gherkin (~> 2.9.0)
json (>= 1.4.6)
term-ansicolor (>= 1.0.6)
- cucumber-rails (1.2.1)
+ cucumber-rails (1.3.0)
capybara (>= 1.1.2)
- cucumber (>= 1.1.3)
+ cucumber (>= 1.1.8)
nokogiri (>= 1.5.0)
- database_cleaner (0.7.1)
+ database_cleaner (0.7.2)
diff-lcs (1.1.3)
+ directory_watcher (1.4.1)
erubis (2.7.0)
- execjs (1.2.13)
+ execjs (1.3.0)
multi_json (~> 1.0)
- factory_girl (2.5.0)
- activesupport
- factory_girl_rails (1.6.0)
- factory_girl (~> 2.5.0)
+ factory_girl (2.6.4)
+ activesupport (>= 2.3.9)
+ factory_girl_rails (1.7.0)
+ factory_girl (~> 2.6.0)
railties (>= 3.0.0)
+ fast-stemmer (1.0.0)
ffi (1.0.11)
ffi (1.0.11-java)
- formtastic (2.0.2)
- rails (~> 3.0)
+ formtastic (2.1.1)
+ actionpack (~> 3.0)
geokit (1.6.5)
multi_json
- gherkin (2.7.6)
+ gherkin (2.9.1)
json (>= 1.4.6)
- gherkin (2.7.6-java)
+ gherkin (2.9.1-java)
json (>= 1.4.6)
guard (1.0.1)
ffi (>= 0.5.0)
@@ -163,34 +168,43 @@ GEM
has_scope (0.5.1)
highline (1.6.11)
hike (1.2.1)
- hoe (2.14.0)
- rake (~> 0.8)
i18n (0.6.0)
- inherited_resources (1.3.0)
+ inherited_resources (1.3.1)
has_scope (~> 0.5.0)
- responders (~> 0.6.0)
+ responders (~> 0.6)
+ jekyll (0.11.2)
+ albino (~> 1.3)
+ classifier (~> 1.3)
+ directory_watcher (~> 1.1)
+ kramdown (~> 0.13)
+ liquid (~> 2.3)
+ maruku (~> 0.5)
jquery-rails (1.0.19)
railties (~> 3.0)
thor (~> 0.14)
- jruby-jars (1.6.5.1)
- jruby-openssl (0.7.4)
- bouncy-castle-java
- jruby-rack (1.1.2)
+ jruby-jars (1.6.7)
+ jruby-openssl (0.7.6.1)
+ bouncy-castle-java (>= 1.5.0146.1)
+ jruby-rack (1.1.4)
json (1.6.5)
json (1.6.5-java)
- launchy (2.0.5)
+ kramdown (0.13.5)
+ launchy (2.1.0)
addressable (~> 2.2.6)
- launchy (2.0.5-java)
+ launchy (2.1.0-java)
addressable (~> 2.2.6)
ffi (~> 1.0.9)
spoon (~> 0.0.1)
+ liquid (2.3.0)
mail (2.3.3)
i18n (>= 0.4.0)
mime-types (~> 1.16)
treetop (~> 1.4.8)
map_layers (0.0.5)
+ maruku (0.6.0)
+ syntax (>= 1.0.0)
mime-types (1.18)
- multi_json (1.0.4)
+ multi_json (1.1.0)
net-scp (1.0.4)
net-ssh (>= 1.99.1)
net-sftp (2.0.5)
@@ -198,12 +212,13 @@ GEM
net-ssh (2.3.0)
net-ssh-gateway (1.1.0)
net-ssh (>= 1.99.1)
- nokogiri (1.5.0)
- nokogiri (1.5.0-java)
+ nokogiri (1.5.2)
+ nokogiri (1.5.2-java)
pg (0.11.0)
polyamorous (0.5.0)
activerecord (~> 3.0)
polyglot (0.3.3)
+ posix-spawn (0.3.6)
rack (1.3.6)
rack-cache (1.2)
rack (>= 0.4)
@@ -244,31 +259,32 @@ GEM
remarkable (~> 4.0.0.alpha4)
remarkable_activemodel (~> 4.0.0.alpha4)
rspec (>= 2.0.0.alpha11)
- responders (0.6.4)
- rspec (2.8.0)
- rspec-core (~> 2.8.0)
- rspec-expectations (~> 2.8.0)
- rspec-mocks (~> 2.8.0)
- rspec-core (2.8.0)
- rspec-expectations (2.8.0)
- diff-lcs (~> 1.1.2)
- rspec-mocks (2.8.0)
- rspec-rails (2.8.1)
+ responders (0.9.0)
+ railties (~> 3.1)
+ rspec (2.9.0)
+ rspec-core (~> 2.9.0)
+ rspec-expectations (~> 2.9.0)
+ rspec-mocks (~> 2.9.0)
+ rspec-core (2.9.0)
+ rspec-expectations (2.9.0)
+ diff-lcs (~> 1.1.3)
+ rspec-mocks (2.9.0)
+ rspec-rails (2.9.0)
actionpack (>= 3.0)
activesupport (>= 3.0)
railties (>= 3.0)
- rspec (~> 2.8.0)
- rubyzip (0.9.5)
- sass (3.1.12)
- sass-rails (3.1.5)
+ rspec (~> 2.9.0)
+ rubyzip (0.9.6.1)
+ sass (3.1.15)
+ sass-rails (3.1.6)
actionpack (~> 3.1.0)
railties (~> 3.1.0)
- sass (~> 3.1.10)
+ sass (>= 3.1.10)
tilt (~> 1.3.2)
- selenium-webdriver (2.17.0)
+ selenium-webdriver (2.20.0)
childprocess (>= 0.2.5)
- ffi (~> 1.0.9)
- multi_json (~> 1.0.4)
+ ffi (~> 1.0)
+ multi_json (~> 1.0)
rubyzip
shoulda-context (1.0.0)
shoulda-matchers (1.0.0)
@@ -282,6 +298,7 @@ GEM
activerecord (~> 3.0)
activesupport (~> 3.0)
polyamorous (~> 0.5.0)
+ syntax (1.0.0)
term-ansicolor (1.0.7)
thor (0.14.6)
tilt (1.3.3)
@@ -289,10 +306,10 @@ GEM
polyglot
polyglot (>= 0.3.1)
tzinfo (0.3.32)
- uglifier (1.2.1)
+ uglifier (1.2.3)
execjs (>= 0.3.0)
multi_json (>= 1.0.2)
- warbler (1.3.2)
+ warbler (1.3.4)
jruby-jars (>= 1.4.0)
jruby-rack (>= 1.0.0)
rake (>= 0.8.7)
@@ -300,7 +317,7 @@ GEM
will_paginate (3.0.3)
xpath (0.1.4)
nokogiri (~> 1.3)
- yard (0.7.4)
+ yard (0.7.5)
PLATFORMS
java
@@ -329,6 +346,7 @@ DEPENDENCIES
guard
guard-rspec
inherited_resources
+ jekyll
jquery-rails
jruby-openssl
json
diff --git a/config/locales/companies.yml b/config/locales/companies.yml
index 1d205cbd2..a61e43ed4 100644
--- a/config/locales/companies.yml
+++ b/config/locales/companies.yml
@@ -33,6 +33,11 @@ en:
object_version: Version
creation_time: Created on
creator_id: Created by
+ formtastic:
+ hints:
+ company:
+ registration_number: only alphanumerical or underscore characters
+ objectid: "[prefix]:Company:[unique_key] : prefix contains only alphanumerical or underscore characters, unique_key accepts also minus character"
fr:
companies:
@@ -69,4 +74,9 @@ fr:
object_version: "Version"
creation_time: "Créé le"
creator_id: "Créé par"
+ formtastic:
+ hints:
+ company:
+ registration_number: "caractères autorisés : alphanumériques et 'souligné'"
+ objectid: "[prefixe]:Company:[clé_unique] caractères autorisés : alphanumériques et 'souligné' pour le préfixe, la clé unique accepte en plus le 'moins'"
diff --git a/config/locales/lines.yml b/config/locales/lines.yml
index 39cce218f..a24422b9b 100644
--- a/config/locales/lines.yml
+++ b/config/locales/lines.yml
@@ -33,6 +33,11 @@ en:
object_version: Version
creation_time: Created on
creator_id: Created by
+ formtastic:
+ hints:
+ line:
+ registration_number: only alphanumerical or underscore characters
+ objectid: "[prefix]:Line:[unique_key] : prefix contains only alphanumerical or underscore characters, unique_key accepts also minus character"
fr:
lines:
@@ -69,4 +74,9 @@ fr:
object_version: Version
creation_time: Créé le
creator_id: Créé par
+ formtastic:
+ hints:
+ line:
+ registration_number: "caractères autorisés : alphanumériques et 'souligné'"
+ objectid: "[prefixe]:Line:[clé_unique] caractères autorisés : alphanumériques et 'souligné' pour le préfixe, la clé unique accepte en plus le 'moins'"
diff --git a/config/locales/networks.yml b/config/locales/networks.yml
index cae65fc71..910afc509 100644
--- a/config/locales/networks.yml
+++ b/config/locales/networks.yml
@@ -32,6 +32,11 @@ en:
object_version: Version
creation_time: Created on
creator_id: Created by
+ formtastic:
+ hints:
+ network:
+ registration_number: only alphanumerical or underscore characters
+ objectid: "[prefix]:GroupOfLine:[unique_key] : prefix contains only alphanumerical or underscore characters, unique_key accepts also minus character"
fr:
networks:
@@ -67,3 +72,9 @@ fr:
object_version: "Version"
creation_time: "Créé le"
creator_id: "Créé par"
+ formtastic:
+ hints:
+ network:
+ registration_number: "caractères autorisés : alphanumériques et 'souligné'"
+ objectid: "[prefixe]:GroupOfLine:[clé_unique] caractères autorisés : alphanumériques et 'souligné' pour le préfixe, la clé unique accepte en plus le 'moins'"
+
diff --git a/config/locales/stop_areas.yml b/config/locales/stop_areas.yml
index 65e5603c9..cc62fdeb2 100644
--- a/config/locales/stop_areas.yml
+++ b/config/locales/stop_areas.yml
@@ -40,6 +40,11 @@ en:
object_version: Version
creation_time: Created on
creator_id: Created by
+ formtastic:
+ hints:
+ stop_area:
+ registration_number: only alphanumerical or underscore characters
+ objectid: "[prefix]:StopArea:[unique_key] : prefix contains only alphanumerical or underscore characters, unique_key accepts also minus character"
fr:
stop_areas:
@@ -84,3 +89,10 @@ fr:
object_version: Version
creation_time: Créé le
creator_id: Créé par
+ formtastic:
+ hints:
+ stop_area:
+ registration_number: "caractères autorisés : alphanumériques et 'souligné'"
+ objectid: "[prefixe]:StopArea:[clé_unique] caractères autorisés : alphanumériques et 'souligné' pour le préfixe, la clé unique accepte en plus le 'moins'"
+
+
diff --git a/doc/functional/index.textile b/doc/functional/index.textile
index 92c6e79d6..ac8c72995 100644
--- a/doc/functional/index.textile
+++ b/doc/functional/index.textile
@@ -3,5 +3,22 @@ layout: default
title: Présentation
---
-p. TODO
+h3. Sommaire
+
+# "Espaces de données":referentials
+# "Réseaux":networks
+# "Transporteurs":companies
+# "Lignes":lines
+## Séquences d'arrêts
+## Horaires
+# "Arrêts":stop_areas
+## Correspondances
+## Accès
+## Liaisons Arrêt-Accès
+# Calendriers d'application
+# Outils
+## Imports
+## Validation
+# Divers
+## "API Rest":restapis
diff --git a/doc/functional/restapis.textile b/doc/functional/restapis.textile
index e361c2404..4f732686d 100644
--- a/doc/functional/restapis.textile
+++ b/doc/functional/restapis.textile
@@ -5,10 +5,25 @@ title: API Rest
h3. Syntaxe
-p. TODO
-
+p. Les différents objets Neptune sont accessibles dans Chouette par une URL Rest:
+??[URL_server]/[referential_id]/[Objects]/[id].[format]??
+la liste des objets d'un même type peut être obtenue par l'URL REST :
+??[URL_server]/[referential_id]/[Objects].[format]??
+où :
+* URL_server : l'adresse web d'installation du serveur Chouette
+* referential_id: l'identifiant de l'espace de données
+* Objects: le type d'objet demandé (au pluriel)
+** networks
+** lines
+** companies
+** ...
+* id : l'identifiant de l'objet désiré
+* format : le format de sortie :
+** json
+** xml
h3. Exemples
+??http://chouette.dryade.net/chouette2/referentials/4/lines/674.json??
+??http://chouette.dryade.net/chouette2/referentials/4/lines/674.xml??
-p. TODO