discourse_api 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 730d29945a35c74f70e468ae35c3079b68019bd3eed8ae578e30658c1dbc638a
-  data.tar.gz: '0728d384637cfd505efe9c86a895b9915e6638f6576f3907d06f34eac816fa53'
+  metadata.gz: 72fb97a4c52606e5839c8749c6108312686530417bfd5dd5b9a2a0af3786dd43
+  data.tar.gz: 670e5bca1055f0bb7b76c936d7e40f643106d1a6cb3f4aa366f9a6d472702bbb
 SHA512:
-  metadata.gz: a32c491fd381e24e5c11c3e73fc1ecfabe014c31e4d14cdc5975869d73663eb35cd0711fa77cf74c65ecd91b3d657e28a413edcceb3d0f7230b0ece0ba7598a4
-  data.tar.gz: 78099bb35c97d711fbf9c574148230d5e79d0dd45b3f384aeb335a7354faaa89267c4f40673a08e7a07e1cadbbc051990f392742176fa436748ebcb676b0c1db
+  metadata.gz: 721d458fc214443c3c07c01b7e19faf1ca7dc71c5a47b542ee1a6786dff8b43537e941cfdac19fd7e904d42a4b3e867595b6ee0d0f587a3d7b1021629eed071a
+  data.tar.gz: 96f568076b20018c1a04894b94464c38aea655224f36f4efd358e6405071869f96f8ca6401632e2cb54daf616de7e5f5ab4be807930d3fd09a12d0b2353eea0c

data/.github/workflows/ci.yml

@@ -7,16 +7,32 @@ on:
       - main
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.2'
+          bundler-cache: true
+
+      - name: Rubocop
+        run: bundle exec rubocop
+
+      - name: syntax_tree
+        if: ${{ !cancelled() }}
+        run: |
+          set -E
+          bundle exec stree check Gemfile $(git ls-files '*.rb') $(git ls-files '*.rake')
+
+  test:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        ruby:
-          - '2.6'
-          - '2.7'
-          - '3.0'
-          - '3.1'
+        ruby: ['2.7', '3.0', '3.1', '3.2']
 
     steps:
       - uses: actions/checkout@v3
@@ -27,15 +43,12 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Lint
-        run: bundle exec rubocop
-
       - name: Tests
         run: bundle exec rake test
 
   publish:
     if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    needs: build
+    needs: [lint, test]
     runs-on: ubuntu-latest
 
     steps:

data/.rubocop.yml

@@ -1,2 +1,2 @@
 inherit_gem:
-  rubocop-discourse: default.yml
+  rubocop-discourse: stree-compat.yml

data/.streerc

@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma,disable_ternary

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.0] - 2023-05-26
+### Changed
+- The package now requires ruby 2.7+
+- The package now requires faraday 2.7+
+
+## [1.1.0] - 2022-07-05
+### Changed
+- `DiscourseApi::SingleSignOn.parse` now raises `DiscourseApi::SingleSignOn::ParseError` (inherits from `RuntimeError` to preserve backward compatibility) instead of `RuntimeError` when there's a signature mismatch.
+- `DiscourseApi::SingleSignOn.parse` now raises `DiscourseApi::SingleSignOn::MissingConfigError` (also inherits from `RuntimeError`) if `sso_secret` or `sso_url` are missing.
+
 ## [1.0.0] - 2022-05-01
 ### Changed
 - The package now requires ruby 2.6+

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in discourse_api.gemspec
 gemspec

data/README.md

@@ -1,9 +1,5 @@
 # DiscourseApi
 
-[![Code Climate](https://codeclimate.com/github/discourse/discourse_api.png)][codeclimate]
-
-[codeclimate]: https://codeclimate.com/github/discourse/discourse_api
-
 The Discourse API gem allows you to consume the Discourse API
 
 ## Installation

data/discourse_api.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~> 1.0'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_runtime_dependency 'faraday', '~> 2.7'
+  spec.add_runtime_dependency 'faraday-follow_redirects'
+  spec.add_runtime_dependency 'faraday-multipart'
   spec.add_runtime_dependency 'rack', '>= 1.6'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
@@ -30,7 +31,9 @@ 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.5.0'
+  spec.add_development_dependency 'rubocop-discourse', '~> 3.2.0'
+  spec.add_development_dependency 'syntax_tree', '~> 6.1.1'
+  spec.add_development_dependency 'syntax_tree-disable_ternary', '~> 1.0.0'
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 end

data/examples/backups.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # get list of backup files
 puts client.backups()

data/examples/badges.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # get badges
 puts client.badges

data/examples/bookmark_topic.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # Bookmark topic
 puts client.bookmark_topic(1418)

data/examples/category.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # get categories
 puts client.categories()
@@ -26,5 +26,9 @@ category_topics_paged = client.category_latest_topics(category_slug: "test-categ
 puts category_topics_paged
 
 # update category notification_level
-update_response = client.category_set_user_notification(id: "test-id", notification_level: "test-notification-level")
+update_response =
+  client.category_set_user_notification(
+    id: "test-id",
+    notification_level: "test-notification-level",
+  )
 puts update_response

data/examples/change_topic_status.rb

@@ -1,23 +1,24 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
-response = client.create_topic(
+response =
+  client.create_topic(
     category: 1,
     skip_validations: true,
     auto_track: false,
     title: "Concert Master: A new way to choose",
-    raw: "This is the raw markdown for my post"
-)
+    raw: "This is the raw markdown for my post",
+  )
 
 # get topic_id from response
-topic_id = response['topic_id']
+topic_id = response["topic_id"]
 
 ##
 # available options (guessing from reading discourse source)
@@ -26,9 +27,9 @@ topic_id = response['topic_id']
 ##
 
 # lock topic (note: api_username determines user that is performing action)
-params = { status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME" }
+params = { status: "closed", enabled: true, api_username: "YOUR USERNAME/USERS USERNAME" }
 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" }
+params = { status: "closed", enabled: false, api_username: "YOUR USERNAME/USERS USERNAME" }
 client.change_topic_status(topic_id, params)

data/examples/create_private_message.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 client.create_private_message(
   title: "Confidential: Hello World!",
   raw: "This is the raw markdown for my private message",
-  target_usernames: "user1,user2"
+  target_usernames: "user1,user2",
 )

data/examples/create_topic.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 client.create_topic(
   category: 1,
   skip_validations: true,
   auto_track: false,
   title: "Concert Master: A new way to choose",
-  raw: "This is the raw markdown for my post"
+  raw: "This is the raw markdown for my post",
 )
 
 # create Poll topic
@@ -22,7 +22,7 @@ client.create_topic(
   skip_validations: false,
   auto_track: false,
   title: "Your Favorite Color?",
-  raw: "[poll name=color]\n- Green\n- Blue\n- Red\n[/poll]"
+  raw: "[poll name=color]\n- Green\n- Blue\n- Red\n[/poll]",
 )
 
 # Create Topic with Tags
@@ -31,6 +31,6 @@ client.create_topic(
   skip_validations: true,
   auto_track: false,
   title: "Concert Master: A new way to choose",
-  raw: "This is the raw markdown for my post"
-  tags: ['asdf', 'fdsa']
+  raw: "This is the raw markdown for my post",
+  tags: %w[asdf fdsa],
 )

data/examples/create_update_category.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 ###
 # Required category params:
@@ -17,19 +17,16 @@ client.api_username = config['api_username'] || "YOUR_USERNAME"
 ###
 
 # Create category
-new_category = client.create_category(
-    name: "Test Category",
-    color: "AB9364",
-    text_color: "FFFFFF"
-)
-puts 'Created category: ' + new_category.to_s
+new_category = client.create_category(name: "Test Category", color: "AB9364", text_color: "FFFFFF")
+puts "Created category: " + new_category.to_s
 
 # Update category
-response = client.update_category(
-    id: new_category['id'],
+response =
+  client.update_category(
+    id: new_category["id"],
     name: "The Best Test Category",
     slug: "the-best-test-category",
     color: "0E76BD",
-    text_color: "000000"
-)
-puts 'Updated category: ' + response.to_s
+    text_color: "000000",
+  )
+puts "Updated category: " + response.to_s

data/examples/create_user.rb

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # create user
-user = client.create_user(
-  name: "Bruce Wayne",
-  email: "bruce@wayne.com",
-  username: "batman",
-  password: "WhySoSerious"
-)
+user =
+  client.create_user(
+    name: "Bruce Wayne",
+    email: "bruce@wayne.com",
+    username: "batman",
+    password: "WhySoSerious",
+  )
 
 # activate user
 client.activate(user["user_id"])

data/examples/dashboard.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # get all dashboard status as json
 puts client.get_dashboard_stats

data/examples/disposable_invite_tokens.rb

@@ -1,23 +1,22 @@
 # frozen_string_literal: true
 # requires this plugin => https://github.com/discourse/discourse-invite-tokens
 
-require 'csv'
+require "csv"
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # fetch email-less invite tokens
-invite_tokens = client.disposable_tokens(username: "eviltrout", quantity: 5, group_names: "security,support")
+invite_tokens =
+  client.disposable_tokens(username: "eviltrout", quantity: 5, group_names: "security,support")
 
 # write to CSV file
 CSV.open(File.expand_path("../invite_tokens.csv", __FILE__), "w") do |csv|
-  invite_tokens.each do |value|
-    csv << [value]
-  end
+  invite_tokens.each { |value| csv << [value] }
 end

data/examples/example.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # get latest topics
 puts client.latest_topics

data/examples/group_set_user_notification_level.rb

@@ -1,38 +1,37 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 @target_username = "YOUR_TARGET_USERNAME"
-@target_group_id =   # YOUR NUMERIC TARGET GROUP ID
-
-@user = client.user(@target_username)
+@target_group_id = # YOUR NUMERIC TARGET GROUP ID
+  @user = client.user(@target_username)
 
 # each user's group and the group's default notification level are stored under user['groups']
-@user['groups'].each do |group|
-  if group['id'] == @target_group_id
-    @group_name = group['name']
-    @default_level = group['default_notification_level']
+@user["groups"].each do |group|
+  if group["id"] == @target_group_id
+    @group_name = group["name"]
+    @default_level = group["default_notification_level"]
   end
 end
 
 # and the user's notification setting for each group is stored under user['group_users]
-@user['group_users'].each do |users_group|
-  if users_group['group_id'] == @target_group_id
-    @notification_level = users_group['notification_level']
+@user["group_users"].each do |users_group|
+  if users_group["group_id"] == @target_group_id
+    @notification_level = users_group["notification_level"]
     puts "Group ID:#{@target_group_id} #{@group_name}    Current Notification Level: #{@notification_level}    Default: #{@default_level}"
-    response = client.group_set_user_notification_level(@group_name, @user['id'], @default_level)
+    response = client.group_set_user_notification_level(@group_name, @user["id"], @default_level)
     puts response
-    @users_group_users_after_update = client.user(@target_username)['group_users']
+    @users_group_users_after_update = client.user(@target_username)["group_users"]
     # this just pulls the user from the database again to make sure we updated the user's group notification level
     @users_group_users_after_update.each do |users_group_second_pass|
-      if users_group_second_pass['group_id'] == @target_group_id
-        puts "Updated ID:#{@target_group_id} #{@group_name}    Notification Level: #{users_group_second_pass['notification_level']}    Default: #{@default_level}"
+      if users_group_second_pass["group_id"] == @target_group_id
+        puts "Updated ID:#{@target_group_id} #{@group_name}    Notification Level: #{users_group_second_pass["notification_level"]}    Default: #{@default_level}"
       end
     end
   end

data/examples/groups.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 response = client.create_group(name: "engineering_team")
 group_id = response["basic_group"]["id"]
 
 client.group_add(group_id, username: "sam")
 client.group_add(group_id, username: "jeff")
-client.group_add(group_id, usernames: ["neil", "dan"])
+client.group_add(group_id, usernames: %w[neil dan])
 client.group_add(group_id, user_id: 123)
 client.group_add(group_id, user_ids: [123, 456])
 
@@ -24,5 +24,5 @@ client.delete_group(group_id)
 
 ## List users of a group
 
-members = client.group_members('trust_level_0')
+members = client.group_members("trust_level_0")
 puts members

data/examples/invite_users.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # invite user
 invite = client.invite_user(email: "name@example.com", group_ids: "41,42")

data/examples/manage_api_keys.rb

@@ -1,20 +1,15 @@
 # frozen_string_literal: true
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require File.expand_path('../../lib/discourse_api', __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require File.expand_path("../../lib/discourse_api", __FILE__)
 
 config = DiscourseApi::ExampleHelper.load_yml
 
-client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
-client.api_key = config['api_key'] || "YOUR_API_KEY"
-client.api_username = config['api_username'] || "YOUR_USERNAME"
+client = DiscourseApi::Client.new(config["host"] || "http://localhost:3000")
+client.api_key = config["api_key"] || "YOUR_API_KEY"
+client.api_username = config["api_username"] || "YOUR_USERNAME"
 
 # generate user api key
-response = client.create_api_key(
-  key: {
-    description: "Key to The Batmobile",
-    username: "batman"
-  }
-)
+response = client.create_api_key(key: { description: "Key to The Batmobile", username: "batman" })
 
 api_key_id = response["key"]["id"]