Skip to content

C
cs_comments_service
Commit f8fb343a by jimabramson Committed by jsa
Options

set up i18n 

* add i18n gem
* configure default_locale (en-US)
* externalize strings
* configure locale fallbacks
* add tests
parent 735334e4
Showing with 77 additions and 17 deletions
Gemfile
......@@ -55,3 +55,4 @@ gem 'newrelic_rpm'
gem 'newrelic_moped'
gem 'unicorn'
gem "rack-timeout", "0.1.0beta3"
gem "i18n"
Gemfile.lock
......@@ -178,6 +178,7 @@ DEPENDENCIES
faker
guard
guard-unicorn
i18n
kaminari!
mongo
mongoid (~> 3.0)
......
app.rb
......@@ -59,6 +59,17 @@ Mongoid.load!("config/mongoid.yml", environment)
Mongoid.logger.level = Logger::INFO
Moped.logger.level = ENV["ENABLE_MOPED_DEBUGGING"] ? Logger::DEBUG : Logger::INFO
# set up i18n
I18n.load_path += Dir[File.join(File.dirname(__FILE__), 'locale', '*.yml').to_s]
I18n.default_locale = CommentService.config[:default_locale]
I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
helpers do
def t(*args)
I18n.t(*args)
end
end
Dir[File.dirname(__FILE__) + '/lib/**/*.rb'].each {|file| require file}
Dir[File.dirname(__FILE__) + '/models/*.rb'].each {|file| require file}
Dir[File.dirname(__FILE__) + '/presenters/*.rb'].each {|file| require file}
......@@ -124,11 +135,11 @@ if RACK_ENV.to_s == "development"
end
error Moped::Errors::InvalidObjectId do
error 400, ["requested object not found"].to_json
error 400, [t(:requested_object_not_found)].to_json
end
error Mongoid::Errors::DocumentNotFound do
error 400, ["requested object not found"].to_json
error 400, [t(:requested_object_not_found)].to_json
end
error ArgumentError do
......
config/application.yml
......@@ -2,3 +2,4 @@ level_limit: 3
api_key: <%= ENV['API_KEY'] || 'PUT_YOUR_API_KEY_HERE' %>
elasticsearch_server: <%= ENV['SEARCH_SERVER'] || 'http://localhost:9200' %>
max_deep_search_comment_count: 5000
default_locale: en-US
lib/helpers.rb
......@@ -7,7 +7,7 @@ helpers do
end
def user # TODO handle 404 if integrated user service
raise ArgumentError, "User id is required" unless @user || params[:user_id]
raise ArgumentError, t(:user_id_is_required) unless @user || params[:user_id]
@user ||= User.find_by(external_id: params[:user_id])
end
......@@ -28,27 +28,27 @@ helpers do
when "other"
Commentable.find(params["source_id"])
else
raise ArgumentError, "Source type must be 'user', 'thread' or 'other'"
raise ArgumentError, t(:source_type_must_be_user_thread_or_other)
end
end
def vote_for(obj)
raise ArgumentError, "User id is required" unless user
raise ArgumentError, "Value is required" unless params["value"]
raise ArgumentError, "Value is invalid" unless %w[up down].include? params["value"]
raise ArgumentError, t(:user_id_is_required) unless user
raise ArgumentError, t(:value_is_required) unless params["value"]
raise ArgumentError, t(:value_is_invalid) unless %w[up down].include? params["value"]
user.vote(obj, params["value"].to_sym)
obj.reload.to_hash.to_json
end
def flag_as_abuse(obj)
raise ArgumentError, "User id is required" unless user
raise ArgumentError, t(:user_id_is_required) unless user
obj.abuse_flaggers << user.id unless obj.abuse_flaggers.include? user.id
obj.save
obj.reload.to_hash.to_json
end
def un_flag_as_abuse(obj)
raise ArgumentError, "User id is required" unless user
raise ArgumentError, t(:user_id_is_required) unless user
if params["all"]
obj.historical_abuse_flaggers += obj.abuse_flaggers
obj.historical_abuse_flaggers = obj.historical_abuse_flaggers.uniq
......@@ -62,21 +62,21 @@ helpers do
end
def undo_vote_for(obj)
raise ArgumentError, "must provide user id" unless user
raise ArgumentError, t(:user_id_is_required) unless user
user.unvote(obj)
obj.reload.to_hash.to_json
end
def pin(obj)
raise ArgumentError, "User id is required" unless user
raise ArgumentError, t(:user_id_is_required) unless user
obj.pinned = true
obj.save
obj.reload.to_hash.to_json
end
def unpin(obj)
raise ArgumentError, "User id is required" unless user
raise ArgumentError, t(:user_id_is_required) unless user
obj.pinned = nil
obj.save
obj.reload.to_hash.to_json
......@@ -268,7 +268,7 @@ helpers do
end
content_obj = {}
content_obj["username"] = c.author_with_anonymity(:username, "(anonymous)")
content_obj["username"] = c.author_with_anonymity(:username, t(:anonymous))
content_obj["updated_at"] = c.updated_at
content_obj["body"] = c.body
t["content"] << content_obj
......@@ -289,8 +289,9 @@ helpers do
return
end
if CommentService.blocked_hashes.include? hash then
logger.warn "blocked content with body hash [#{hash}]"
error 503
msg = t(:blocked_content_with_body_hash, :hash => hash)
logger.warn msg
error 503, [msg].to_json
end
end
......
locale/en-US.yml 0 → 100644
en-US:
requested_object_not_found: "requested object not found"
user_id_is_required: "User id is required"
source_type_must_be_user_thread_or_other: "Source type must be 'user', 'thread' or 'other'"
value_is_required: "Value is required"
value_is_invalid: "Value is invalid"
anonymous: "anonymous"
blocked_content_with_body_hash: blocked content with body hash %{hash}
spec/api/abuse_spec.rb
......@@ -52,10 +52,12 @@ describe "app" do
it "returns 400 when the comment does not exist" do
create_comment_flag("does_not_exist", User.first.id)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
create_comment_flag("#{Comment.first.id}", nil)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
#Would like to test the output of to_hash, but not sure how to deal with a Moped::BSON::Document object
#it "has a correct hash" do
......@@ -78,10 +80,12 @@ describe "app" do
it "returns 400 when the thread does not exist" do
create_thread_flag("does_not_exist", User.first.id)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
create_thread_flag("#{Comment.first.comment_thread.id}", nil)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
#Would like to test the output of to_hash, but not sure how to deal with a Moped::BSON::Document object
#it "has a correct hash" do
......@@ -106,13 +110,20 @@ describe "app" do
comment.abuse_flaggers.count.should == prev_abuse_flaggers_count - 1
comment.abuse_flaggers.to_a.should_not include User.first.id
end
it "returns 400 when the thread does not exist" do
it "returns 400 when the comment does not exist" do
remove_comment_flag("does_not_exist", User.first.id)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when the thread does not exist" do
remove_thread_flag("does_not_exist", User.first.id)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
remove_comment_flag("#{Comment.first.comment_thread.id}", nil)
remove_thread_flag("#{Comment.first.comment_thread.id}", nil)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
#Would like to test the output of to_hash, but not sure how to deal with a Moped::BSON::Document object
#it "has a correct hash" do
......@@ -140,10 +151,12 @@ describe "app" do
it "returns 400 when the thread does not exist" do
remove_thread_flag("does_not_exist", User.first.id)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
remove_thread_flag("#{Comment.first.comment_thread.id}", nil)
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
#Would like to test the output of to_hash, but not sure how to deal with a Moped::BSON::Document object
#it "has a correct hash" do
......
spec/api/comment_spec.rb
......@@ -37,6 +37,7 @@ describe "app" do
it "returns 400 when the comment does not exist" do
get "/api/v1/comments/does_not_exist"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
end
describe "PUT /api/v1/comments/:comment_id" do
......@@ -51,11 +52,13 @@ describe "app" do
it "returns 400 when the comment does not exist" do
put "/api/v1/comments/does_not_exist", body: "new body", endorsed: true
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 503 when the post hash is blocked" do
comment = Comment.first
put "/api/v1/comments/#{comment.id}", body: "BLOCKED POST", endorsed: true
last_response.status.should == 503
parse(last_response.body).first.should == I18n.t(:blocked_content_with_body_hash, :hash => Digest::MD5.hexdigest("blocked post"))
end
end
describe "POST /api/v1/comments/:comment_id" do
......@@ -73,12 +76,14 @@ describe "app" do
it "returns 400 when the comment does not exist" do
post "/api/v1/comments/does_not_exist", body: "new comment", course_id: "1", user_id: User.first.id
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 503 when the post hash is blocked" do
comment = Comment.first.to_hash(recursive: true)
user = User.first
post "/api/v1/comments/#{comment["id"]}", body: "BLOCKED POST", course_id: "1", user_id: User.first.id
last_response.status.should == 503
parse(last_response.body).first.should == I18n.t(:blocked_content_with_body_hash, :hash => Digest::MD5.hexdigest("blocked post"))
end
end
describe "DELETE /api/v1/comments/:comment_id" do
......@@ -93,6 +98,7 @@ describe "app" do
it "returns 400 when the comment does not exist" do
delete "/api/v1/comments/does_not_exist"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
end
end
......
spec/api/comment_thread_spec.rb
......@@ -366,8 +366,10 @@ describe "app" do
it "returns 400 when the thread does not exist" do
get "/api/v1/threads/does_not_exist"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
get "/api/v1/threads/5016a3caec5eb9a12300000b1"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "get information of a single comment thread with its tags" do
......@@ -406,6 +408,7 @@ describe "app" do
it "returns 400 when the thread does not exist" do
put "/api/v1/threads/does_not_exist", body: "new body", title: "new title"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 503 if the post body has been blocked" do
thread = CommentThread.first
......@@ -465,6 +468,7 @@ describe "app" do
it "returns 400 when the thread does not exist" do
post "/api/v1/threads/does_not_exist/comments", default_params
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns error when body or course_id does not exist, or when body is blank" do
post "/api/v1/threads/#{CommentThread.first.id}/comments", default_params.merge(body: nil)
......@@ -489,6 +493,7 @@ describe "app" do
it "returns 400 when the thread does not exist" do
delete "/api/v1/threads/does_not_exist"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
end
end
......
spec/api/commentable_spec.rb
......@@ -99,6 +99,7 @@ describe "app" do
it "returns 503 when the post content is blocked" do
post '/api/v1/question_1/threads', default_params.merge(body: "BLOCKED POST")
last_response.status.should == 503
parse(last_response.body).first.should == I18n.t(:blocked_content_with_body_hash, :hash => Digest::MD5.hexdigest("blocked post"))
end
it "create a new comment thread with tag" do
old_count = CommentThread.count
......
spec/api/vote_spec.rb
......@@ -17,16 +17,20 @@ describe "app" do
it "returns 400 when the comment does not exist" do
put "/api/v1/comments/does_not_exist/votes", user_id: User.first.id, value: "down"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
put "/api/v1/comments/#{Comment.first.id}/votes", value: "down"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
it "returns 400 when value is not provided or invalid" do
put "/api/v1/comments/#{Comment.first.id}/votes", user_id: User.first.id
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:value_is_required)
put "/api/v1/comments/#{Comment.first.id}/votes", user_id: User.first.id, value: "superdown"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:value_is_invalid)
end
end
describe "DELETE /api/v1/comments/:comment_id/votes" do
......@@ -43,10 +47,12 @@ describe "app" do
it "returns 400 when the comment does not exist" do
delete "/api/v1/comments/does_not_exist/votes", user_id: User.first.id
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
delete "/api/v1/comments/#{Comment.first.id}/votes"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
end
describe "PUT /api/v1/threads/:thread_id/votes" do
......@@ -63,16 +69,20 @@ describe "app" do
it "returns 400 when the thread does not exist" do
put "/api/v1/threads/does_not_exist/votes", user_id: User.first.id, value: "down"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
put "/api/v1/threads/#{CommentThread.first.id}/votes", value: "down"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
it "returns 400 when value is not provided or invalid" do
put "/api/v1/threads/#{CommentThread.first.id}/votes", user_id: User.first.id
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:value_is_required)
put "/api/v1/threads/#{CommentThread.first.id}/votes", user_id: User.first.id, value: "superdown"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:value_is_invalid)
end
end
describe "DELETE /api/v1/threads/:thread_id/votes" do
......@@ -89,10 +99,12 @@ describe "app" do
it "returns 400 when the comment does not exist" do
delete "/api/v1/threads/does_not_exist/votes", user_id: User.first.id
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:requested_object_not_found)
end
it "returns 400 when user_id is not provided" do
delete "/api/v1/threads/#{CommentThread.first.id}/votes"
last_response.status.should == 400
parse(last_response.body).first.should == I18n.t(:user_id_is_required)
end
end
end
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment