discourse_api 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea694de473b398c706c2b61333e05663dcb69423178a6bcb25c2f6b1ac4abde
-  data.tar.gz: 85fb225fd5d9ab4aa407510a437b7b92a55f4c117b480cecbfb026c0f0b3750f
+  metadata.gz: 47b23caec63bf36a246bfa9ce104e32ac5e1d0978e2e469154b976fed097aa91
+  data.tar.gz: afe90f37b0464d43df29b38884c77f747975f805a5f7d17797fbd82c62fa0d9f
 SHA512:
-  metadata.gz: fbdd42c087c47c52ea91ba75d70fba75989ee6242a914f1147755d851d2645403c5f153cefbd60f04073cf34bc94e1e2fb01247204bce128538fe5b485b0b332
-  data.tar.gz: 43cf32bef0aba4d313c2d198e04be5531cc9e52bb5473ff6e6dbbfe6406090fa121c18b681e45847f4624031e0c7e004bb62443cb79a03e3fe972703b9d73410
+  metadata.gz: 04a47e1164ab7b298292a840b5263967e333baff682839fe87ed791412364e4e87b6465d36737761ce98271258544519206484a8e06d9396fd2d9514fd6547c3
+  data.tar.gz: 895e1c5a9e021eb6b6a8fd12e0aa05e45b9865e11bdf10639d1b05941ce4512d311c71cf427b0e9395c94085a63831531e7903c2cbdb5c5fb79aabbacf438906

data/CHANGELOG.md

@@ -1,6 +1,16 @@
-# Change Log
+# Changelog
 All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.43.0] - 2020-11-04
+### Added
+- Add pagination to list groups endpoint
+### Deprecated
+- `change_topic_status` has been deprecated, use `update_topic_status` instead.
 
 ## [0.42.0] - 2020-07-09
 ### Added

data/README.md

@@ -34,7 +34,6 @@ client.ssl(...)                                 #=> specify SSL connection setti
 
 # Topic endpoints
 client.latest_topics                            #=> Gets a list of the latest topics
-client.hot_topics                               #=> Gets a list of hot topics
 client.new_topics                               #=> Gets a list of new topics
 client.topics_by("sam")                         #=> Gets a list of topics created by user "sam"
 client.topic(57)                                #=> Gets the topic with id 57

data/examples/change_topic_status.rb

@@ -16,9 +16,8 @@ response = client.create_topic(
     raw: "This is the raw markdown for my post"
 )
 
-# get topic_id and topic_slug from response
+# get topic_id from response
 topic_id = response['topic_id']
-topic_slug = response['topic_slug']
 
 ##
 # available options (guessing from reading discourse source)
@@ -28,8 +27,8 @@ topic_slug = response['topic_slug']
 
 # lock topic (note: api_username determines user that is performing action)
 params = { status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME" }
-client.change_topic_status(topic_slug, topic_id, params)
+client.change_topic_status(topic_id, params)
 
 # unlock topic (note: api_username determines user that is performing action)
 params = { status: 'closed', enabled: false, api_username: "YOUR USERNAME/USERS USERNAME" }
-client.change_topic_status(topic_slug, topic_id, params)
+client.change_topic_status(topic_id, params)

data/lib/discourse_api/api/groups.rb

@@ -60,8 +60,16 @@ module DiscourseApi
         put("/groups/#{group_id}", group: args)
       end
 
-      def groups
-        response = get("/groups.json")
+      def groups(args = {})
+        params = API.params(args)
+          .optional(:page)
+          .to_h
+
+        url = "/groups.json"
+        if params.include?(:page)
+          url += "?page=#{params[:page]}"
+        end
+        response = get(url)
         response.body
       end
 

data/lib/discourse_api/api/topics.rb

@@ -42,11 +42,17 @@ module DiscourseApi
         put("/t/#{topic_id}.json", topic_id: topic_id, category_id: category_id)
       end
 
+      # TODO: Deprecated. Remove after 20201231
       def change_topic_status(topic_slug, topic_id, params = {})
+        deprecated(__method__, 'update_topic_status')
+        update_topic_status(topic_id, params)
+      end
+
+      def update_topic_status(topic_id, params = {})
         params = API.params(params)
           .required(:status, :enabled)
           .optional(:api_username)
-        put("/t/#{topic_id}/status", params.to_h)
+        put("/t/#{topic_id}/status", params)
       end
 
       def topic(id, params = {})

data/lib/discourse_api/client.rb

@@ -109,6 +109,10 @@ module DiscourseApi
       @user_agent ||= "DiscourseAPI Ruby Gem #{DiscourseApi::VERSION}"
     end
 
+    def deprecated(old, new)
+      warn "[DEPRECATED]: `#{old}` is deprecated. Please use `#{new}` instead."
+    end
+
     private
 
     def connection

data/lib/discourse_api/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DiscourseApi
-  VERSION = "0.42.0"
+  VERSION = "0.43.0"
 end

data/spec/discourse_api/api/topics_spec.rb

@@ -10,7 +10,7 @@ describe DiscourseApi::API::Topics do
     end
 
     it "changes the topic status" do
-      subject.change_topic_status(nil, 57, { status: 'visible', enabled: false })
+      subject.update_topic_status(57, { status: 'visible', enabled: false })
       expect(a_put("#{host}/t/57/status")).to have_been_made
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.42.0
+  version: 0.43.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday