From 824d78231a54e6f8585f7d437d7341402b76e451 Mon Sep 17 00:00:00 2001 From: Georg Kahest Date: Mon, 9 Sep 2019 20:04:19 +0300 Subject: [PATCH 1/2] Follow Rails file naming convention Fixes #189 --- .ruby-gemset | 2 +- .travis.yml | 4 ++-- README.md | 10 +++++----- ...lication-example.yml => application.yml.sample} | 0 .../{database-example.yml => database.yml.sample} | 2 +- ...lopment.yml => database_development.yml.sample} | 0 ...gistrant.yml => database_registrant.yml.sample} | 0 .../{database-travis.yml => database_travis.yml} | 0 config/{deploy-example.rb => deploy.rb.sample} | 0 ...evelopment-example.rb => development.rb.sample} | 0 .../{staging-example.rb => staging.rb.sample} | 0 doc/application_build_doc.md | 12 ++++++------ doc/epp/contact.md | 10 +++++----- doc/epp/domain.md | 14 +++++++------- doc/epp/keyrelay.md | 2 +- doc/epp/session.md | 8 ++++---- doc/{epp-examples.md => epp_examples.md} | 0 doc/que/README.md | 2 +- doc/que/{que-init-example => que_init_sample} | 0 doc/{registrant-api.md => registrant_api.md} | 0 doc/{repp-doc.md => repp_doc.md} | 0 21 files changed, 33 insertions(+), 33 deletions(-) rename config/{application-example.yml => application.yml.sample} (100%) rename config/{database-example.yml => database.yml.sample} (92%) rename config/{database-example-development.yml => database_development.yml.sample} (100%) rename config/{database-example-registrant.yml => database_registrant.yml.sample} (100%) rename config/{database-travis.yml => database_travis.yml} (100%) rename config/{deploy-example.rb => deploy.rb.sample} (100%) rename config/environments/{development-example.rb => development.rb.sample} (100%) rename config/environments/{staging-example.rb => staging.rb.sample} (100%) rename doc/{epp-examples.md => epp_examples.md} (100%) rename doc/que/{que-init-example => que_init_sample} (100%) rename doc/{registrant-api.md => registrant_api.md} (100%) rename doc/{repp-doc.md => repp_doc.md} (100%) diff --git a/.ruby-gemset b/.ruby-gemset index 14bc599bf..4dcdb08b2 100644 --- a/.ruby-gemset +++ b/.ruby-gemset @@ -1 +1 @@ -registry +-global \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index d92f21450..60b453f63 100644 --- a/.travis.yml +++ b/.travis.yml @@ -16,8 +16,8 @@ before_install: - "gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true" - "gem install bundler -v '< 2'" before_script: - - "cp config/application-example.yml config/application.yml" - - "cp config/database-travis.yml config/database.yml" + - "cp config/application.yml.sample config/application.yml" + - "cp config/database_travis.yml config/database.yml" - "bundle exec rake db:setup:all" - "curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter" - "chmod +x ./cc-test-reporter" diff --git a/README.md b/README.md index e2ba0b90f..d85fdfebc 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,15 @@ Documentation ------------- * [EPP documentation](/doc/epp) -* [EPP request-response examples](/doc/epp-examples.md) -* [REPP documentation](/doc/repp-doc.md) +* [EPP request-response examples](/doc/epp_examples.md) +* [REPP documentation](/doc/repp_doc.md) * [Database diagram](/doc/models_complete.svg) * [Controllers diagram](/doc/controllers_complete.svg) ### Updating documentation AUTODOC=true rspec spec/requests - EPP_DOC=true rspec spec/epp --tag epp --require support/epp_doc.rb --format EppDoc > doc/epp-examples.md + EPP_DOC=true rspec spec/epp --tag epp --require support/epp_doc.rb --format EppDoc > doc/epp_examples.md Installation ------------ @@ -41,8 +41,8 @@ Manual demo install and database setup: cd demo-registry rbenv local 2.2.2 bundle - cp config/application-example.yml config/application.yml # and edit it - cp config/database-example.yml config/database.yml # and edit it + cp config/application.yml.sample config/application.yml # and edit it + cp config/database.yml.sample config/database.yml # and edit it bundle exec rake db:setup:all # for production, please follow deployment howto bundle exec rake bootstrap bundle exec rake assets:precompile diff --git a/config/application-example.yml b/config/application.yml.sample similarity index 100% rename from config/application-example.yml rename to config/application.yml.sample diff --git a/config/database-example.yml b/config/database.yml.sample similarity index 92% rename from config/database-example.yml rename to config/database.yml.sample index ca47a9979..a3eab11ed 100644 --- a/config/database-example.yml +++ b/config/database.yml.sample @@ -1,7 +1,7 @@ # # EPP, REPP, Admin and Registrar config # -# Registrant example is at database-example-registrant.yml file +# Registrant example is at database_registrant.yml.sample file default: &default adapter: postgresql diff --git a/config/database-example-development.yml b/config/database_development.yml.sample similarity index 100% rename from config/database-example-development.yml rename to config/database_development.yml.sample diff --git a/config/database-example-registrant.yml b/config/database_registrant.yml.sample similarity index 100% rename from config/database-example-registrant.yml rename to config/database_registrant.yml.sample diff --git a/config/database-travis.yml b/config/database_travis.yml similarity index 100% rename from config/database-travis.yml rename to config/database_travis.yml diff --git a/config/deploy-example.rb b/config/deploy.rb.sample similarity index 100% rename from config/deploy-example.rb rename to config/deploy.rb.sample diff --git a/config/environments/development-example.rb b/config/environments/development.rb.sample similarity index 100% rename from config/environments/development-example.rb rename to config/environments/development.rb.sample diff --git a/config/environments/staging-example.rb b/config/environments/staging.rb.sample similarity index 100% rename from config/environments/staging-example.rb rename to config/environments/staging.rb.sample diff --git a/doc/application_build_doc.md b/doc/application_build_doc.md index 1f565d4d6..9b4ba9289 100644 --- a/doc/application_build_doc.md +++ b/doc/application_build_doc.md @@ -25,14 +25,14 @@ Deploy overview: (database schema should be loaded and seeds should be present) cd registry rbenv local 2.2.2 # more info about rbenv at debian doc gem install mina # or any other deployment tool - cp config/deploy-example.rb config/deploy.rb # and edit it + cp config/deploy.rb.sample config/deploy.rb # and edit it mina pr setup # one time, only creates missing directories ssh registry # at your server cd registry - cp current/config/application-example.yml shared/config/application.yml # and edit it - cp current/config/database-example.yml shared/config/database.yml # and edit it + cp current/config/application.yml.sample shared/config/application.yml # and edit it + cp current/config/database.yml.sample shared/config/database.yml # and edit it vi /etc/apache2/sites-enabled/registry.conf # add conf and all needed serts vi /etc/apache2/sites-enabled/epp.conf # add epp conf, restart apache @@ -48,7 +48,7 @@ We recommend [Mina](https://github.com/mina-deploy/mina) instead of Capistrano o All deploy code locates at config/deploy.rb, please copy content from example file and edit it. - cp config/deploy-example.rb config/deploy.rb # and edit it + cp config/deploy.rb.sample config/deploy.rb # and edit it First add shortcuts to your local machine ssh config file, @@ -117,13 +117,13 @@ General rake and mina tips: ### CRON -Crontab can be setup after deploy. Jobs can be viewed [here](/config/schedule.rb). Some jobs are dependent on `cron_group` variable set in [deploy-example.rb](/config/deploy-example.rb) file. +Crontab can be setup after deploy. Jobs can be viewed [here](/config/schedule.rb). Some jobs are dependent on `cron_group` variable set in [deploy.rb.sample](/config/deploy.rb.sample) file. mina pr cron:setup # to update the crontab. mina pr cron:clear # to clear crontab. ### Application settings -Application settings locate at [config/application-example.yml](/config/application-example.yml) +Application settings locate at [config/application.yml.sample](/config/application.yml.sample) diff --git a/doc/epp/contact.md b/doc/epp/contact.md index 633e16cff..fd8ce602c 100644 --- a/doc/epp/contact.md +++ b/doc/epp/contact.md @@ -47,7 +47,7 @@ More info: https://en.wikipedia.org/wiki/Latin_script_in_Unicode Attribute: type="pdf/asice/sce/adoc/asics/scs/edoc/adoc/bdoc/ddoc/zip/rar/gz/tar/7z" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-contact-with-valid-user-create-command-successfully-creates-a-contact) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-contact-with-valid-user-create-command-successfully-creates-a-contact) ### Contact update @@ -85,7 +85,7 @@ More info: https://en.wikipedia.org/wiki/Latin_script_in_Unicode 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-contact-with-valid-user-update-command-is-succesful) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-contact-with-valid-user-update-command-is-succesful) ### Contact delete @@ -102,7 +102,7 @@ More info: https://en.wikipedia.org/wiki/Latin_script_in_Unicode Attribute: type="pdf/asice/sce/adoc/asics/scs/edoc/adoc/bdoc/ddoc/zip/rar/gz/tar/7z" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-contact-with-valid-user-delete-command-deletes-contact) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-contact-with-valid-user-delete-command-deletes-contact) ### Contact check @@ -114,7 +114,7 @@ More info: https://en.wikipedia.org/wiki/Latin_script_in_Unicode 1-n Contact id 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-contact-with-valid-user-check-command-returns-info-about-contact-availability) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-contact-with-valid-user-check-command-returns-info-about-contact-availability) ### Contact info @@ -128,4 +128,4 @@ More info: https://en.wikipedia.org/wiki/Latin_script_in_Unicode 1 Contact password. Attribute: roid="String" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-contact-with-valid-user-info-command-return-info-about-contact) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-contact-with-valid-user-info-command-return-info-about-contact) diff --git a/doc/epp/domain.md b/doc/epp/domain.md index df7611709..006cc00a6 100644 --- a/doc/epp/domain.md +++ b/doc/epp/domain.md @@ -45,7 +45,7 @@ Domain name mapping protocol short version: 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-citizen-as-a-registrant-creates-a-domain) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-citizen-as-a-registrant-creates-a-domain) ### Domain update @@ -95,7 +95,7 @@ Domain name mapping protocol short version: Attribute: type="pdf/asice/sce/adoc/asics/scs/edoc/adoc/bdoc/ddoc/zip/rar/gz/tar/7z" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-domain-updates-domain-and-adds-objects) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-valid-domain-updates-domain-and-adds-objects) ### Domain delete @@ -111,7 +111,7 @@ Domain name mapping protocol short version: Attribute: type="pdf/asice/sce/adoc/asics/scs/edoc/adoc/bdoc/ddoc/zip/rar/gz/tar/7z" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-domain-deletes-domain) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-valid-domain-deletes-domain) ### Domain info @@ -125,7 +125,7 @@ Domain name mapping protocol short version: 1 Domain transfer code. Attribute: roid="String" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-domain-returns-domain-info) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-valid-domain-returns-domain-info) ### Domain renew @@ -145,7 +145,7 @@ Domain name mapping protocol short version: Attribute: type="pdf/asice/sce/adoc/asics/scs/edoc/adoc/bdoc/ddoc/zip/rar/gz/tar/7z" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-domain-renews-a-domain) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-valid-domain-renews-a-domain) ### Domain transfer @@ -162,7 +162,7 @@ Domain name mapping protocol short version: Attribute: type="pdf/asice/sce/adoc/asics/scs/edoc/adoc/bdoc/ddoc/zip/rar/gz/tar/7z" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-domain-transfers-a-domain) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-valid-domain-transfers-a-domain) ### Domain check @@ -173,4 +173,4 @@ Domain name mapping protocol short version: 1 Domain name. Can contain unicode characters. 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-domain-with-valid-domain-checks-a-domain) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-domain-with-valid-domain-checks-a-domain) diff --git a/doc/epp/keyrelay.md b/doc/epp/keyrelay.md index cda7dfa56..4239682bf 100644 --- a/doc/epp/keyrelay.md +++ b/doc/epp/keyrelay.md @@ -22,4 +22,4 @@ NB! Keyrelay not implemented. Required if ext:relative is not specified 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-keyrelay-makes-a-keyrelay-request) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-keyrelay-makes-a-keyrelay-request) diff --git a/doc/epp/session.md b/doc/epp/session.md index 1e10dce2b..4f97a9095 100644 --- a/doc/epp/session.md +++ b/doc/epp/session.md @@ -8,7 +8,7 @@ Here are functions like login, logout, hello, poll -[EXAMPLE RESPONSE](/doc/epp-examples.md#epp-session-when-not-connected-greets-client-upon-connection) +[EXAMPLE RESPONSE](/doc/epp_examples.md#epp-session-when-not-connected-greets-client-upon-connection) ### Login request @@ -27,7 +27,7 @@ Here are functions like login, logout, hello, poll 0-n Extension URI that is going to be used in current connection. 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-session-when-connected-with-valid-user-logs-in-epp-user) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-session-when-connected-with-valid-user-logs-in-epp-user) ### Logout request @@ -36,7 +36,7 @@ Here are functions like login, logout, hello, poll 1 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-session-when-connected-with-valid-user-logs-out-epp-user) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-session-when-connected-with-valid-user-logs-out-epp-user) ### Poll request @@ -46,4 +46,4 @@ Here are functions like login, logout, hello, poll Attribute: op="req / ack" 0-1 Client transaction id -[EXAMPLE REQUEST AND RESPONSE](/doc/epp-examples.md#epp-poll-queues-and-dequeues-messages) +[EXAMPLE REQUEST AND RESPONSE](/doc/epp_examples.md#epp-poll-queues-and-dequeues-messages) diff --git a/doc/epp-examples.md b/doc/epp_examples.md similarity index 100% rename from doc/epp-examples.md rename to doc/epp_examples.md diff --git a/doc/que/README.md b/doc/que/README.md index e7d3032d0..1fd0ef664 100644 --- a/doc/que/README.md +++ b/doc/que/README.md @@ -16,7 +16,7 @@ In both serarious que requires working Registry deployment and full access to Re Installation at deployed server: cd /home/registry/registry/current - sudo cp doc/que/que-init-example /etc/init.d/que # and edit it + sudo cp doc/que/que_init_sample /etc/init.d/que # and edit it sudo chmod +x /etc/init.d/que sudo /etc/init.d/que # for help and other commands sudo /etc/init.d/que start # for manual start diff --git a/doc/que/que-init-example b/doc/que/que_init_sample similarity index 100% rename from doc/que/que-init-example rename to doc/que/que_init_sample diff --git a/doc/registrant-api.md b/doc/registrant_api.md similarity index 100% rename from doc/registrant-api.md rename to doc/registrant_api.md diff --git a/doc/repp-doc.md b/doc/repp_doc.md similarity index 100% rename from doc/repp-doc.md rename to doc/repp_doc.md From 22b803ef83a0492dc4299ad90c81862af7fc5690 Mon Sep 17 00:00:00 2001 From: Artur Beljajev Date: Tue, 10 Sep 2019 15:16:49 +0300 Subject: [PATCH 2/2] Fix typos --- doc/debian_build_doc.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/debian_build_doc.md b/doc/debian_build_doc.md index ff619fd0a..2328c6d9b 100644 --- a/doc/debian_build_doc.md +++ b/doc/debian_build_doc.md @@ -7,7 +7,7 @@ however officially Debian 7 is supported and tested. ### Manual build * Consider using [RBENV](https://github.com/sstephenson/rbenv) -* Compile requried [ruby version](https://github.com/internetee/registry/blob/master/.ruby-version) +* Compile required [ruby version](https://github.com/internetee/registry/blob/master/.ruby-version) * [Phusion passenger](https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html) * [Postgresql](http://www.postgresql.org/docs/) (requires postgresql-contrib package) * [Mailcatcher](https://mailcatcher.me/) (optional) @@ -80,9 +80,9 @@ iptables -A INPUT -p tcp --dport 43 -m recent --set --rsource --name whois -j AC #### EPP -Configure epp server ip in applicatin.yml +Configure epp server ip in application.yml iptables_server_ip: 'x.x.x.x' -Iptables hitcounter is updated by application. For every registrar there is one recent table, where the request counters are stored, registrar handles and sources ips are "connected" with iptables rules. +Iptables hit counter is updated by application. For every registrar there is one recent table, where the request counters are stored, registrar handles and sources ips are "connected" with iptables rules. ```` #!/bin/bash @@ -99,8 +99,8 @@ iptables -A INPUT -p tcp --dport 700 -j CHKLIMITS ```` #### Mailcatcher for staging (optional) -We recommend using mailcatcher for staging env, so that all outgoing e-mails are caught and not actualy sent out. -The mailcatcher website explains how it should be intsalled and configured. +We recommend using mailcatcher for staging env, so that all outgoing e-mails are caught and not actually sent out. +The mailcatcher website explains how it should be installed and configured. [Mailcatcher](https://mailcatcher.me/) `````