Module: DiscourseApi::API::Categories

Included in:
Client
Defined in:
lib/discourse_api/api/categories.rb

Instance Method Summary collapse

Instance Method Details

#categories(params = {}) ⇒ Object 



38
39
40
 
# File 'lib/discourse_api/api/categories.rb', line 38

def categories(params = {})
  categories_full(params)['category_list']['categories']
end

#categories_full(params = {}) ⇒ Object 



42
43
44
45
 
# File 'lib/discourse_api/api/categories.rb', line 42

def categories_full(params = {})
  response = get('/categories.json', params)
  response[:body]
end

#category(id) ⇒ Object 



92
93
94
95
 
# File 'lib/discourse_api/api/categories.rb', line 92

def category(id)
  response = get("/c/#{id}/show")
  response[:body]['category']
end

#category_latest_topics(args = {}) ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'lib/discourse_api/api/categories.rb', line 47

def category_latest_topics(args = {})
  response = category_latest_topics_full(args)
  if response['errors']
    response['errors']
  else
    response['topic_list']['topics']
  end
end

#category_latest_topics_full(args = {}) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/discourse_api/api/categories.rb', line 56

def category_latest_topics_full(args = {})
  params = API.params(args)
    .required(:category_slug)
    .optional(:page).to_h
  url = "/c/#{params[:category_slug]}/l/latest.json"
  if params.include?(:page)
    url = "#{url}?page=#{params[:page]}"
  end
  response = get(url)
  response[:body]
end

#category_new_topics(category_slug) ⇒ Object 



82
83
84
85
 
# File 'lib/discourse_api/api/categories.rb', line 82

def category_new_topics(category_slug)
  response = category_new_topics_full(category_slug)
  response['topic_list']['topics']
end

#category_new_topics_full(category_slug) ⇒ Object 



87
88
89
90
 
# File 'lib/discourse_api/api/categories.rb', line 87

def category_new_topics_full(category_slug)
  response = get("/c/#{category_slug}/l/new.json")
  response[:body]
end

#category_set_user_notification(args = {}) ⇒ Object

TODO: Deprecated. Remove after 20210727



98
99
100
101
102
103
 
# File 'lib/discourse_api/api/categories.rb', line 98

def category_set_user_notification(args = {})
  category_id = args[:id]
  args = API.params(args)
    .required(:notification_level)
  post("/category/#{category_id}/notifications", args)
end

#category_set_user_notification_level(category_id, params) ⇒ Object 



105
106
107
108
109
 
# File 'lib/discourse_api/api/categories.rb', line 105

def category_set_user_notification_level(category_id, params)
  params = API.params(params)
    .required(:notification_level)
  post("/category/#{category_id}/notifications", params)
end

#category_top_topics(category_slug) ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/discourse_api/api/categories.rb', line 68

def category_top_topics(category_slug)
  response = category_top_topics_full(category_slug)
  if response['errors']
    response['errors']
  else
    response['topic_list']['topics']
  end
end

#category_top_topics_full(category_slug) ⇒ Object 



77
78
79
80
 
# File 'lib/discourse_api/api/categories.rb', line 77

def category_top_topics_full(category_slug)
  response = get("/c/#{category_slug}/l/top.json")
  response[:body]
end

#create_category(args = {}) ⇒ Object

:color and :text_color are RGB hexadecimal strings :permissions is a hash with the group name and permission_type which is an integer 1 = Full 2 = Create Post 3 = Read Only



8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/discourse_api/api/categories.rb', line 8

def create_category(args = {})
  args = API.params(args)
    .required(:name, :color, :text_color)
    .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
                       :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template, :custom_fields, :description,
                       :reviewable_by_group_name, :show_subcategory_list, :subcategory_list_style,
                       :allowed_tags, :allowed_tag_groups, :required_tag_group_name)
    .default(parent_category_id: nil)
  response = post("/categories", args)
  response['category']
end

#delete_category(id) ⇒ Object 



33
34
35
36
 
# File 'lib/discourse_api/api/categories.rb', line 33

def delete_category(id)
  response = delete("/categories/#{id}")
  response[:body]['success']
end

#update_category(args = {}) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/discourse_api/api/categories.rb', line 20

def update_category(args = {})
  category_id = args[:id]
  args = API.params(args)
    .required(:id, :name, :color, :text_color)
    .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
                       :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template, :custom_fields, :description,
                       :reviewable_by_group_name, :show_subcategory_list, :subcategory_list_style,
                       :allowed_tags, :allowed_tag_groups, :required_tag_group_name)
    .default(parent_category_id: nil)
  response = put("/categories/#{category_id}", args)
  response['body']['category'] if response['body']
end