api.ly

api.ly.g0v.tw endpoint source and utility scripts

Development

We recommend using vagrant for developing

Prepare

Install Virtualbox 4.2.18

Install Vagrant 1.2.7 (1.3.x does not work with berkshelf yet)

Install berkshelf:

$ sudo gem install berkshelf

Install vagrant plugins:

$ vagrant plugin install vagrant-berkshelf
$ vagrant plugin install vagrant-cachier

Using Vagrant for Development

% cd cookbooks/ly.g0v.tw/
% vagrant up

You should now have localhost:6988 served by pgrest within the vagrant, try to access http://localhost:6988/v0/collections/sittings

Host

Besides Vagrant, of course you can run a api server in your host.

the server provides RESTFUL service by pgrest. pgrest rely on postgresql, so you should install postgresql and related components to your host.

For example, in Debian

$ sudo aptitude install postgresql
$ sudo aptitude install skytools3 skytools3-ticker postgresql-9.2-pgq3  # for pgq
$ sudo aptitude install postgresql-plv8  # for plv8 extension

init

% npm i

Then refer to the cookbook to initialize your postgresql.

Bootstrap with the initial dump file:

% createdb ly
% psql ly -c 'create extension plv8'
% curl https://dl.dropboxusercontent.com/u/30657009/ly/api.ly.bz2 | bzcat |  psql ly -f -

run pgrest

$ lsc app.ls tcp://ly:password@localhost/ly
or
$ lsc app.ls tcp://ly:password@localhost:5433/ly    # if your postgresql is running on port 5433

pgrest will bind a local port to serve

calendar

% DB=ly lsc populate-calendar.ls  --year 2013

sitting

populated via pgq with calendar-sitting.ls

meeting agenda and proceeding

populated via pgq with ys-misq.ls

bill details

populated via pgq with bill-details.ls

bill and motion metadata

interpellation

See TTS for setting up casperjs environment.

Run:

% casperjs scripts/tts.coffee --type=i --session=0803 --output=i0803.html

Note that you'll need to run a read-write-enabled pgrest for inserting data, so kill the app.ls above if you have it up and running.

% env PATH=node_modules/.bin:$PATH pgrest --db ly
% lsc node_modules/twlyparser/parse-tts.ls i0803.html | curl -i -H "Content-Type: application/json" -X POST -d @- http://127.0.0.1:3000/collections/ttsinter

Note that there's a bug with pgrest that if you are running multiple POST into a new collection (like ttsinter here), you need to restart the server after the first POST.

Written Answers

% env PLV8XDB=ly ./scripts/gen-wrans.ls | curl -i -H "Content-Type: application/json" -X POST -d @- http://127.0.0.1:3000/collections/wrans

Debates

% env PLV8XDB=ly ./scripts/gen-debates.ls | curl -i -H "Content-Type: application/json" -X POST -d @- http://127.0.0.1:3000/collections/debates

fulltext from gazettes

TTS data (WIP)

National Parliament Library provides a database called TTS. to work with it you'll need to have lisproxy.psgi up and running, and install phatomjs and casperjs to use scripts/tts.coffee

% cpanm Plack::App::Proxy
% npm i -g bower
% bower install jquery

% plackup lisproxy.psgi &
% casperjs scripts/tts.coffee --type=m --session=0803 --output=m0803.html

API listing for api.ly

http://docs.twly.apiary.io/

To regenerate api, just run docgen.s then commit apiary.apib, the document will hook to apiary automatically

cd ~/api.ly
lsc docgen.ls
git commit apiary.apib

License

MIT: http://g0v.mit-license.org

chhsiao1981 / api.ly Goto Github PK

api.ly's Introduction