server side of the comment service
Ruby Shell JavaScript
Switch branches/tags
Latest commit e45c410 Jul 26, 2017 @iloveagent57 iloveagent57 committed on GitHub Merge pull request #248 from edx/aed/EDUCATOR-313
EDUCATOR-313: Bump ruby to 2.4.1
Permalink
Failed to load latest commit information.
.travis EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
.tx Update Transifex project name Feb 10, 2014
api Add support for Elasticsearch 1.5.2 May 3, 2017
bin Added binstubs Jan 6, 2016
config Fixed issues with app.rb require Jul 18, 2017
edx_specs Remove email from User model and API May 2, 2014
lib EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
locale Add a default response size and a response size limit. Nov 3, 2016
models Remove trace_execution_scoped blocks Mar 17, 2017
presenters Add logging of LoadError in relation to missing NewRelic module Mar 15, 2017
scripts MA-2678: replace use of 'updated_at' for 'read' state Sep 2, 2016
spec EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
.gitignore EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
.ruby-gemset Replaced .rvmrc with .ruby-version and .ruby-gemset Dec 31, 2015
.travis.yml EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
AUTHORS Add Clinton Blackburn as an author Dec 30, 2015
CHANGELOG.rst Fix Content-Type header Nov 6, 2013
Gemfile EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
Gemfile.lock EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
Guardfile Actually use guard for something useful and restart Unicorn when file… Sep 17, 2012
LICENSE.txt clarify LICENSE Jul 10, 2013
Procfile fix unicorn defaults; keep using old version of config in Procfile Feb 21, 2014
README.rst EDUCATOR-313: Bump ruby to 2.4.1; Use latest newrelic_rpm package; Ad… Jul 26, 2017
Rakefile Adjust and add search rake tasks. Feb 9, 2017
app.rb Adjust and add search rake tasks. Feb 9, 2017
config.ru Add message for rack config load. Aug 10, 2016
openedx.yaml Specify an owner Sep 7, 2016

README.rst

Part of edX code.

edX Comments Service/Forums Travis Codecov

An independent comment system which supports voting and nested comments. It also supports features including instructor endorsement for education-aimed discussion platforms.

Getting Started

If you are running cs_comments_service as part of edx-platform development under devstack, it is strongly recommended to read those setup documents first. Note that devstack will take care of just about all of the installation, configuration, and service management on your behalf. If running outside of devstack, continue reading below.

This service relies on Elasticsearch and MongoDB. By default the service will use the Elasticsearch server available at http://localhost:9200 and the MongoDB server available at localhost:27017. This is suitable for local development; however, if you wish to change these values, refer to config/application.yml and config/mongoid.yml for the environment variables that can be set to override the defaults.

Install the requisite gems:

$ bundle install

To initialize the index:

Setup the search index. Note that the command below creates an alias with a unique name (e.g. content_20161220185820323), and assigns it a known alias: content. If you choose not to use the command below, you should still opt to reference your index by an alias rather than the actual index name. This will enable you to swap out indices (e.g. rebuild_index) without having to take downtime or modify code with a new index name.

$ bin/rake search:initialize

To validate the 'content' alias exists and contains the proper mappings:

$ bin/rake search:validate_index

To rebuild the index:

To rebuild a new index from the database and then point the alias 'content' to it, you can use the rebuild_index task. This task will also run catchup before and after the alias is moved, to minimize time where the alias does not contain all documents.

$ bin/rake search:rebuild_index

To rebuild a new index without moving the alias and without running catchup, use the following:

$ bin/rake search:rebuild_index[false]

You can also adjust the batch size (e.g. 200) and the sleep time (e.g. 2 seconds) between batches to lighten the load on MongoDB.

$ bin/rake search:rebuild_index[true,200,2]

Run the server:

$ ruby app.rb

By default Sinatra runs on port 4567. If you'd like to use a different port pass the -p parameter:

$ ruby app.rb -p 5678

Running Tests

Tests are built using the rspec framework, and can be run with the command below:

$ bin/rspec

If you'd like to view additional options for the command, append the --help option:

$ bin/rspec --help

Running Tests with Docker

You can also use docker-compose to run your tests as follows (assuming you have docker-compose installed):

$ docker-compose -f .travis/docker-compose-travis.yml run --rm test-forum

Internationalization (i18n) and Localization (l10n)

To run the comments service in a language other than English, set the SERVICE_LANGUAGE environment variable to the language code for the desired language. Its default value is en-US.

Setting the language has no effect on user content stored by the service. However, there are a few data validation messages that may be seen by end users via the frontend in edx-platform. These will be translated to SERVICE_LANGUAGE assuming a suitable translation file is found in the locale/ directory.

edX uses Transifex to host translations. To use the Transifex client, be sure it is installed (pip install transifex-client will do this for you), and follow the instructions here to set up your .transifexrc file.

To upload strings to Transifex for translation when you change the set of translatable strings: bin/rake i18n:push

To fetch the latest translations from Transifex: bin/rake i18n:pull

The repository includes some translations so they will be available upon deployment. To commit an update to these: bin/rake i18n:commit

License

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.

Please see LICENSE.txt for details.

How to Contribute

Contributions are very welcome. The easiest way is to fork this repo, and then make a pull request from your fork. The first time you make a pull request, you may be asked to sign a Contributor Agreement.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org

Mailing List and IRC Channel

You can discuss this code on the edx-code Google Group or in the edx-code IRC channel on Freenode.