discourse_api 0.47.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fffa65d4ed129c229766cecd20c2b5684570d22dcd08deaa44474f37cbe0b7c
-  data.tar.gz: 35db4a119a91642c632b43b78cbde678c2a753f28adb88b376bf1b5ab9bb6a2b
+  metadata.gz: 730d29945a35c74f70e468ae35c3079b68019bd3eed8ae578e30658c1dbc638a
+  data.tar.gz: '0728d384637cfd505efe9c86a895b9915e6638f6576f3907d06f34eac816fa53'
 SHA512:
-  metadata.gz: 7353e073896a9e70d38336cba97d0c0f53f951c925e21e4333cc67fd8bfbd40ce5745f50ee6c6a87ce3e5c69c77d67e3287458a96418f033c9ee88901da7e3fa
-  data.tar.gz: 8a3cbddb1585c72dcf3eeaa3723e4742007b076c239e47a23cbf98c87024a95e4712e54eed85be4b48f9100acef41b282b91007c05237cc10048d5753ed82db4
+  metadata.gz: a32c491fd381e24e5c11c3e73fc1ecfabe014c31e4d14cdc5975869d73663eb35cd0711fa77cf74c65ecd91b3d657e28a413edcceb3d0f7230b0ece0ba7598a4
+  data.tar.gz: 78099bb35c97d711fbf9c574148230d5e79d0dd45b3f384aeb335a7354faaa89267c4f40673a08e7a07e1cadbbc051990f392742176fa436748ebcb676b0c1db

data/.github/workflows/ci.yml

@@ -4,7 +4,6 @@ on:
   pull_request:
   push:
     branches:
-      - master
       - main
 
 jobs:
@@ -14,13 +13,13 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - 2.5
-          - 2.6
-          - 2.7
-          - 3.0
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
@@ -35,15 +34,15 @@ jobs:
         run: bundle exec rake test
 
   publish:
-    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     needs: build
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2-beta
+        uses: discourse/publish-rubygems-action@v2
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           GIT_EMAIL: team@discourse.org

data/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] - 2022-05-01
+### Changed
+- The package now requires ruby 2.6+
+
+## [0.48.1] - 2022-04-13
+### Added
+- New attributes for Discourse Connect (aka SSO)
+
+## [0.48.0] - 2022-01-28
+### Added
+- `group_add_owners` method (#239)
+- `group_remove_owners` method (#239)
+- `anonymize` method (#241)
+
+### Changed
+- `DiscourseApi::Timeout` error now inherits from `DiscourseApi::Error` (#240)
+- `DiscourseApi::SingleSignOn#groups` now returns an array of strings where each string is a group name, rather than an array with a single string that contains all the groups comma-concatenated (#243)
+
 ## [0.47.0] - 2021-07-19
 ### Added
 - Update invite method
@@ -17,7 +35,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Pass params to get notifications API
 
 ### Deprecated
-- `invite_user_to_topic` has been deprecated, use `invite_user` instead.
+- `invite_user_to_topic` has been deprecated, use `invite_to_topic` instead.
 - `create_private_message` has been deprecated, use `create_pm` instead.
 
 ## [0.46.0] - 2021-04-12
@@ -51,7 +69,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.43.1] - 2020-11-04
 ### Fixed
-- Tagged version 0.43.0 got pushed without commmit due to new master branch
+- Tagged version 0.43.0 got pushed without commit due to new master branch
   protections in github. No, code changes here just making sure tags align with
   commits.
 
@@ -104,7 +122,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.38.0] - 2019-10-18
 ### Added
 - Allow setting locale in SingleSignOn
-- Optional param to group memebrs to include owners as well as members
+- Optional param to group members to include owners as well as members
 
 ## [0.37.0] - 2019-09-23
 ### Added
@@ -117,7 +135,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added poll methods
 ### Fixed
 - Updated create topic example
-- Fixed capialization for header auth keys
+- Fixed capitalization for header auth keys
 
 ## [0.35.0] - 2019-05-15
 ### Added
@@ -279,7 +297,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - group_members: Allows you to retrieve more than 100 users with pagination (offset &
   limit)
 ### Fixed
-- Deprication warning with SimpleCov
+- Deprecation warning with SimpleCov
 - updated rack dependency and added ruby 2.3 to travis config
 
 ## [0.9.1] - 2016-03-23

data/discourse_api.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'webmock', '~> 3.0'
-  spec.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
+  spec.add_development_dependency 'rubocop-discourse', '~> 2.5.0'
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.6.0'
 end

data/examples/invite_users.rb

@@ -18,10 +18,10 @@ client.update_invite(invite["id"], email: "namee@example.com")
 client.resend_invite("namee@example.com")
 
 # invite to a topic
-client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1)
+client.invite_to_topic(1, email: "foo@bar.com")
 
 # if the user is an admin you may invite to a group as well
-client.invite_user_to_topic(email: "foo@bar.com", group_ids: "1,2,3", topic_id: 1)
+client.invite_to_topic(1, email: "foo@bar.com", group_ids: "1,2,3")
 
 # retrieve invite
 puts client.retrieve_invite(email: "foo@bar.com")

data/lib/discourse_api/api/dashboard.rb

@@ -14,10 +14,10 @@ module DiscourseApi
         topics = global_reports[3]
         posts = global_reports[4]
 
-        totals = {
+        {
           'users' => users['total'],
           'topics' => topics['total'],
-          'posts' => posts['total']
+          'posts' => posts['total'],
         }
       end
     end

data/lib/discourse_api/api/groups.rb

@@ -38,7 +38,6 @@ module DiscourseApi
                             :messageable_level,
                             :name,
                             :automatic_membership_email_domains,
-                            :automatic_membership_retroactive,
                             :title,
                             :primary_group,
                             :grant_trust_level,
@@ -47,19 +46,31 @@ module DiscourseApi
                             :flair_bg_color,
                             :flair_color,
                             :bio_raw,
-                            :members_visibility_level,
+                            :visibility_level,
                             :public_admission,
                             :public_exit,
                             :allow_membership_requests,
                             :full_name,
                             :default_notification_level,
-                            :usernames,
-                            :owner_usernames,
                             :membership_request_template)
           .to_h
         put("/groups/#{group_id}", group: args)
       end
 
+      def group_add_owners(group_id, args)
+        args = API.params(args)
+          .required(:usernames)
+          .to_h
+        put("/admin/groups/#{group_id}/owners.json", group: args)
+      end
+
+      def group_remove_owners(group_id, args)
+        args = API.params(args)
+          .required(:usernames)
+          .to_h
+        delete("/admin/groups/#{group_id}/owners.json", group: args)
+      end
+
       def groups(args = {})
         params = API.params(args)
           .optional(:page)

data/lib/discourse_api/api/site_settings.rb

@@ -3,10 +3,10 @@ module DiscourseApi
   module API
     module SiteSettings
       def site_setting_update(args = {})
-        params = API.params(args)
-          .required(:name, :value).to_h
+        params = API.params(args).required(:name, :value).to_h
         new_site_setting = { params[:name] => params[:value] }
-        response = put("/admin/site_settings/#{params[:name]}", new_site_setting)
+
+        put("/admin/site_settings/#{params[:name]}", new_site_setting)
       end
     end
   end

data/lib/discourse_api/api/users.rb

@@ -102,6 +102,10 @@ module DiscourseApi
         put("/admin/users/#{user_id}/unsuspend")
       end
 
+      def anonymize(user_id)
+        put("/admin/users/#{user_id}/anonymize")
+      end
+
       def delete_user(user_id, delete_posts = false)
         delete("/admin/users/#{user_id}.json?delete_posts=#{delete_posts}")
       end

data/lib/discourse_api/error.rb

@@ -34,6 +34,6 @@ module DiscourseApi
   class TooManyRequests < DiscourseError
   end
 
-  class Timeout < DiscourseError
+  class Timeout < Error
   end
 end

data/lib/discourse_api/single_sign_on.rb

@@ -5,18 +5,51 @@ require 'openssl'
 
 module DiscourseApi
   class SingleSignOn
-    ACCESSORS = [:nonce, :name, :username, :email, :avatar_url, :profile_background_url, :card_background_url, :avatar_force_update, :require_activation,
-                 :bio, :external_id, :return_sso_url, :admin, :moderator, :suppress_welcome_message, :title,
-                 :add_groups, :remove_groups, :groups, :locale, :locale_force_update]
+    ACCESSORS = [
+      :add_groups,
+      :admin,
+      :avatar_force_update,
+      :avatar_url,
+      :bio,
+      :card_background_url,
+      :confirmed_2fa,
+      :email,
+      :external_id,
+      :groups,
+      :locale,
+      :locale_force_update,
+      :moderator,
+      :name,
+      :no_2fa_methods,
+      :nonce,
+      :profile_background_url,
+      :remove_groups,
+      :require_2fa,
+      :require_activation,
+      :return_sso_url,
+      :suppress_welcome_message,
+      :title,
+      :username,
+    ]
+
     FIXNUMS = []
-    BOOLS = [:avatar_force_update, :admin, :moderator, :require_activation, :suppress_welcome_message,
-      :locale_force_update]
+
+    BOOLS = [
+      :admin,
+      :avatar_force_update,
+      :confirmed_2fa,
+      :locale_force_update,
+      :moderator,
+      :no_2fa_methods,
+      :require_2fa,
+      :require_activation,
+      :suppress_welcome_message,
+    ]
     ARRAYS = [:groups]
     #NONCE_EXPIRY_TIME = 10.minutes # minutes is a rails method and is causing an error. Is this needed in the api?
 
     attr_accessor(*ACCESSORS)
-    attr_accessor :custom_fields
-    attr_writer :sso_secret, :sso_url
+    attr_writer :custom_fields, :sso_secret, :sso_url
 
     def self.sso_secret
       raise RuntimeError, "sso_secret not implemented on class, be sure to set it on instance"
@@ -27,7 +60,6 @@ module DiscourseApi
     end
 
     def self.parse_hash(payload)
-      payload
       sso = new
 
       sso.sso_secret = payload.delete(:sso_secret)
@@ -40,11 +72,13 @@ module DiscourseApi
         if BOOLS.include? k
           val = ["true", "false"].include?(val) ? val == "true" : nil
         end
-        val = Array(val) if ARRAYS.include?(k) && !val.nil?
+        val = val.split(",") if ARRAYS.include?(k) && !val.nil?
         sso.send("#{k}=", val)
       end
+
       # Set custom_fields
       sso.custom_fields = payload[:custom_fields]
+
       # Add custom_fields (old format)
       payload.each do |k, v|
         if field = k[/^custom\.(.+)$/, 1]
@@ -79,7 +113,7 @@ module DiscourseApi
         if BOOLS.include? k
           val = ["true", "false"].include?(val) ? val == "true" : nil
         end
-        val = Array(val) if ARRAYS.include?(k) && !val.nil?
+        val = val.split(",") if ARRAYS.include?(k) && !val.nil?
         sso.send("#{k}=", val)
       end
 
@@ -127,7 +161,7 @@ module DiscourseApi
 
       ACCESSORS.each do |k|
         next if (val = send k) == nil
-       payload[k] = val
+        payload[k] = val
       end
 
       if @custom_fields

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/groups_spec.rb

@@ -91,6 +91,35 @@ describe DiscourseApi::API::Groups do
       end
     end
 
+    describe "add owners" do
+      let(:url) { "#{host}/admin/groups/123/owners.json" }
+
+      before do
+        stub_put(url)
+      end
+
+      it "makes the member an owner" do
+        subject.group_add_owners(123, usernames: "sam")
+        params = escape_params("group[usernames]" => "sam")
+        expect(a_request(:put, "#{host}/admin/groups/123/owners.json").
+                with(body: params)
+              ).to have_been_made
+      end
+    end
+
+    describe "remove owners" do
+      let(:url) { "#{host}/admin/groups/123/owners.json?group%5Busernames%5D=sam" }
+
+      before do
+        stub_delete(url)
+      end
+
+      it "removes the owner role from the group member" do
+        subject.group_remove_owners(123, usernames: "sam")
+        expect(a_delete(url)).to have_been_made
+      end
+    end
+
     describe "group members" do
       it "list members" do
         stub_get("#{host}/groups/mygroup/members.json?limit=100&offset=0").to_return(body: fixture("members_0.json"), headers: { content_type: "application/json" })

data/spec/discourse_api/api/sso_spec.rb

@@ -27,10 +27,10 @@ describe DiscourseApi::API::SSO do
     }
   end
   let(:expected_unsigned_payload) do
-    'name=Some+User&username=some_user&email=some%40email.com&'\
-    'avatar_url=https%3A%2F%2Fwww.website.com&external_id=abc&title=ruby'\
-    '&add_groups=a&add_groups=b&remove_groups=c&remove_groups=d&custom.field_2=potato&'\
-    'custom.custom.field_1=tomato'
+    'add_groups=a&add_groups=b&avatar_url=https%3A%2F%2Fwww.website.com'\
+    '&email=some%40email.com&external_id=abc&name=Some+User&remove_groups=c'\
+    '&remove_groups=d&title=ruby&username=some_user&custom.field_2=potato'\
+    '&custom.custom.field_1=tomato'
   end
   let(:sso_double) { DiscourseApi::SingleSignOn.parse_hash(params) }
 

data/spec/discourse_api/api/topics_spec.rb

@@ -15,23 +15,18 @@ describe DiscourseApi::API::Topics do
     end
   end
 
-  describe "#invite_user_to_topic" do
+  describe "#invite_to_topic" do
     before do
       stub_post("#{host}/t/12/invite").to_return(body: fixture("topic_invite_user.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
-      expect(a_post("#{host}/t/12/invite")).to have_been_made
-    end
-
-    it "requests the correct resource with new method 'invite_to_topic'" do
       subject.invite_to_topic(12, email: "fake_user@example.com")
       expect(a_post("#{host}/t/12/invite")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
+      response = subject.invite_to_topic(12, email: "fake_user@example.com")
       expect(response).to be_a Hash
       expect(response['success']).to be_truthy
     end

data/spec/discourse_api/api/users_spec.rb

@@ -306,6 +306,20 @@ describe DiscourseApi::API::Users do
     end
   end
 
+  describe "#anonymize" do
+    before do
+      url = "#{host}/admin/users/11/anonymize"
+      stub_put(url).to_return(body: '', status: 200)
+    end
+
+    it "makes the correct put request" do
+      result = subject.anonymize(11)
+      url = "#{host}/admin/users/11/anonymize"
+      expect(a_put(url)).to have_been_made
+      expect(result.status).to eq(200)
+    end
+  end
+
   describe "#delete_user" do
     before do
       url = "#{host}/admin/users/11.json?delete_posts=true"

data/spec/discourse_api/client_spec.rb

@@ -41,6 +41,12 @@ describe DiscourseApi::Client do
         expect(subject.send(:connection).options.timeout).to eq(25)
       end
     end
+
+    it "raises DiscourseApi::Timeout" do
+      stub_get("#{host}/t/1.json").to_timeout
+
+      expect { subject.topic(1) }.to raise_error(DiscourseApi::Timeout)
+    end
   end
 
   describe "#api_key" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.47.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2022-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -173,14 +173,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.5.0
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -340,7 +340,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="