discourse_api 1.0.0 → 2.0.0

data/lib/discourse_api/api/users.rb

@@ -8,21 +8,19 @@ module DiscourseApi
 
       def user(username, params = {})
         response = get("/users/#{username}.json", params)
-        response[:body]['user']
+        response[:body]["user"]
       end
 
       def user_sso(user_id)
         response = get("/admin/users/#{user_id}.json")
-        response[:body]['single_sign_on_record']
+        response[:body]["single_sign_on_record"]
       end
 
       def update_avatar(username, args)
-        args = API.params(args)
-          .optional(:file, :url)
-          .default(type: 'avatar', synchronous: true)
-          .to_h
+        args =
+          API.params(args).optional(:file, :url).default(type: "avatar", synchronous: true).to_h
         upload_response = post("/uploads", args)
-        put("/u/#{username}/preferences/avatar/pick", upload_id: upload_response['id'])
+        put("/u/#{username}/preferences/avatar/pick", upload_id: upload_response["id"])
       end
 
       def update_email(username, email)
@@ -30,10 +28,24 @@ module DiscourseApi
       end
 
       def update_user(username, args)
-        args = API.params(args)
-          .optional(:name, :title, :bio_raw, :location, :website, :profile_background, :card_background,
-                    :email_messages_level, :mailing_list_mode, :homepage_id, :theme_ids, :user_fields)
-          .to_h
+        args =
+          API
+            .params(args)
+            .optional(
+              :name,
+              :title,
+              :bio_raw,
+              :location,
+              :website,
+              :profile_background,
+              :card_background,
+              :email_messages_level,
+              :mailing_list_mode,
+              :homepage_id,
+              :theme_ids,
+              :user_fields,
+            )
+            .to_h
         put("/u/#{username}", args)
       end
 
@@ -42,18 +54,18 @@ module DiscourseApi
       end
 
       def update_trust_level(user_id, args)
-        args = API.params(args)
-          .required(:level)
-          .to_h
+        args = API.params(args).required(:level).to_h
         response = put("/admin/users/#{user_id}/trust_level", args)
         response[:body]
       end
 
       def create_user(args)
-        args = API.params(args)
-          .required(:name, :email, :password, :username)
-          .optional(:active, :approved, :staged, :user_fields)
-          .to_h
+        args =
+          API
+            .params(args)
+            .required(:name, :email, :password, :username)
+            .optional(:active, :approved, :staged, :user_fields)
+            .to_h
         post("/users", args)
       end
 
@@ -91,7 +103,7 @@ module DiscourseApi
 
       def by_external_id(external_id)
         response = get("/users/by-external/#{external_id}")
-        response[:body]['user']
+        response[:body]["user"]
       end
 
       def suspend(user_id, suspend_until, reason)

data/lib/discourse_api/client.rb

@@ -1,29 +1,30 @@
 # frozen_string_literal: true
-require 'faraday'
-require 'faraday_middleware'
-require 'json'
-require 'uri'
-require 'discourse_api/version'
-require 'discourse_api/api/categories'
-require 'discourse_api/api/search'
-require 'discourse_api/api/sso'
-require 'discourse_api/api/tags'
-require 'discourse_api/api/topics'
-require 'discourse_api/api/polls'
-require 'discourse_api/api/posts'
-require 'discourse_api/api/users'
-require 'discourse_api/api/groups'
-require 'discourse_api/api/invite'
-require 'discourse_api/api/private_messages'
-require 'discourse_api/api/notifications'
-require 'discourse_api/api/badges'
-require 'discourse_api/api/email'
-require 'discourse_api/api/api_key'
-require 'discourse_api/api/backups'
-require 'discourse_api/api/dashboard'
-require 'discourse_api/api/uploads'
-require 'discourse_api/api/user_actions'
-require 'discourse_api/api/site_settings'
+require "faraday"
+require "faraday/follow_redirects"
+require "faraday/multipart"
+require "json"
+require "uri"
+require "discourse_api/version"
+require "discourse_api/api/categories"
+require "discourse_api/api/search"
+require "discourse_api/api/sso"
+require "discourse_api/api/tags"
+require "discourse_api/api/topics"
+require "discourse_api/api/polls"
+require "discourse_api/api/posts"
+require "discourse_api/api/users"
+require "discourse_api/api/groups"
+require "discourse_api/api/invite"
+require "discourse_api/api/private_messages"
+require "discourse_api/api/notifications"
+require "discourse_api/api/badges"
+require "discourse_api/api/email"
+require "discourse_api/api/api_key"
+require "discourse_api/api/backups"
+require "discourse_api/api/dashboard"
+require "discourse_api/api/uploads"
+require "discourse_api/api/user_actions"
+require "discourse_api/api/site_settings"
 
 module DiscourseApi
   class Client
@@ -55,9 +56,9 @@ module DiscourseApi
     include DiscourseApi::API::SiteSettings
 
     def initialize(host, api_key = nil, api_username = nil)
-      raise ArgumentError, 'host needs to be defined' if host.nil? || host.empty?
-      @host         = host
-      @api_key      = api_key
+      raise ArgumentError, "host needs to be defined" if host.nil? || host.empty?
+      @host = host
+      @api_key = api_key
       @api_username = api_username
       @use_relative = check_subdirectory(host)
     end
@@ -69,19 +70,19 @@ module DiscourseApi
 
     def api_username=(api_username)
       @api_username = api_username
-      @connection.headers['Api-Username'] = api_username unless @connection.nil?
+      @connection.headers["Api-Username"] = api_username unless @connection.nil?
     end
 
     def connection_options
       @connection_options ||= {
         url: @host,
         request: {
-          timeout: @timeout || DEFAULT_TIMEOUT
+          timeout: @timeout || DEFAULT_TIMEOUT,
         },
         headers: {
-          accept: 'application/json',
+          accept: "application/json",
           user_agent: user_agent,
-        }
+        },
       }
     end
 
@@ -126,43 +127,44 @@ module DiscourseApi
     private
 
     def connection
-      @connection ||= Faraday.new connection_options do |conn|
-        # Allow uploading of files
-        conn.request :multipart
+      @connection ||=
+        Faraday.new connection_options do |conn|
+          # Allow uploading of files
+          conn.request :multipart
 
-        # Convert request params to "www-form-encoded"
-        conn.request :url_encoded
+          # Convert request params to "www-form-encoded"
+          conn.request :url_encoded
 
-        # Allow to interact with forums behind basic HTTP authentication
-        if basic_auth
-          conn.request :basic_auth, basic_auth[:user], basic_auth[:password]
-        end
+          # Allow to interact with forums behind basic HTTP authentication
+          if basic_auth
+            conn.request :authorization, :basic, basic_auth[:user], basic_auth[:password]
+          end
 
-        # Follow redirects
-        conn.response :follow_redirects, limit: 5
+          # Follow redirects
+          conn.response :follow_redirects, limit: 5
 
-        # Parse responses as JSON
-        conn.response :json, content_type: 'application/json'
+          # Parse responses as JSON
+          conn.response :json, content_type: "application/json"
 
-        # For HTTP debugging, uncomment
-        # conn.response :logger
+          # For HTTP debugging, uncomment
+          # conn.response :logger
 
-        # Use Faraday's default HTTP adapter
-        conn.adapter Faraday.default_adapter
+          # Use Faraday's default HTTP adapter
+          conn.adapter Faraday.default_adapter
 
-        # Pass api_key and api_username on every request
-        unless api_username.nil?
-          conn.headers['Api-Key'] = api_key
-          conn.headers['Api-Username'] = api_username
+          # Pass api_key and api_username on every request
+          unless api_username.nil?
+            conn.headers["Api-Key"] = api_key
+            conn.headers["Api-Username"] = api_username
+          end
         end
-      end
     end
 
     def request(method, path, params = {})
       unless Hash === params
         params = params.to_h if params.respond_to? :to_h
       end
-      path = @use_relative ? path.sub(/^\//, '') : path
+      path = @use_relative ? path.sub(%r{^/}, "") : path
       response = connection.send(method.to_sym, path, params)
       handle_error(response)
       response.env
@@ -188,7 +190,7 @@ module DiscourseApi
     end
 
     def check_subdirectory(host)
-      URI(host).request_uri != '/'
+      URI(host).request_uri != "/"
     end
   end
 end

data/lib/discourse_api/example_helper.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-require 'yaml'
+require "yaml"
 
 module DiscourseApi
   class ExampleHelper
-
     def self.load_yml
-      config_yml = File.expand_path('../../../config.yml', __FILE__)
+      config_yml = File.expand_path("../../../config.yml", __FILE__)
       puts config_yml
       begin
         config = YAML.load_file config_yml
@@ -14,6 +13,5 @@ module DiscourseApi
       end
       config
     end
-
   end
 end

data/lib/discourse_api/single_sign_on.rb

@@ -1,49 +1,54 @@
 # frozen_string_literal: true
-require 'base64'
-require 'rack'
-require 'openssl'
+require "base64"
+require "rack"
+require "openssl"
 
 module DiscourseApi
   class SingleSignOn
-    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,
+    class ParseError < RuntimeError
+    end
+    class MissingConfigError < RuntimeError
+    end
+
+    ACCESSORS = %i[
+      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 = [
-      :admin,
-      :avatar_force_update,
-      :confirmed_2fa,
-      :locale_force_update,
-      :moderator,
-      :no_2fa_methods,
-      :require_2fa,
-      :require_activation,
-      :suppress_welcome_message,
+    BOOLS = %i[
+      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?
@@ -52,11 +57,11 @@ module DiscourseApi
     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"
+      raise MissingConfigError, "sso_secret not implemented on class, be sure to set it on instance"
     end
 
     def self.sso_url
-      raise RuntimeError, "sso_url not implemented on class, be sure to set it on instance"
+      raise MissingConfigError, "sso_url not implemented on class, be sure to set it on instance"
     end
 
     def self.parse_hash(payload)
@@ -69,9 +74,7 @@ module DiscourseApi
         val = payload[k]
 
         val = val.to_i if FIXNUMS.include? k
-        if BOOLS.include? k
-          val = ["true", "false"].include?(val) ? val == "true" : nil
-        end
+        val = %w[true false].include?(val) ? val == "true" : nil if BOOLS.include? k
         val = val.split(",") if ARRAYS.include?(k) && !val.nil?
         sso.send("#{k}=", val)
       end
@@ -96,11 +99,13 @@ module DiscourseApi
 
       parsed = Rack::Utils.parse_query(payload)
       if sso.sign(parsed["sso"]) != parsed["sig"]
-        diags = "\n\nsso: #{parsed["sso"]}\n\nsig: #{parsed["sig"]}\n\nexpected sig: #{sso.sign(parsed["sso"])}"
-        if parsed["sso"] =~ /[^a-zA-Z0-9=\r\n\/+]/m
-          raise RuntimeError, "The SSO field should be Base64 encoded, using only A-Z, a-z, 0-9, +, /, and = characters. Your input contains characters we don't understand as Base64, see http://en.wikipedia.org/wiki/Base64 #{diags}"
+        diags =
+          "\n\nsso: #{parsed["sso"]}\n\nsig: #{parsed["sig"]}\n\nexpected sig: #{sso.sign(parsed["sso"])}"
+        if parsed["sso"] =~ %r{[^a-zA-Z0-9=\r\n/+]}m
+          raise ParseError,
+                "The SSO field should be Base64 encoded, using only A-Z, a-z, 0-9, +, /, and = characters. Your input contains characters we don't understand as Base64, see http://en.wikipedia.org/wiki/Base64 #{diags}"
         else
-          raise RuntimeError, "Bad signature for payload #{diags}"
+          raise ParseError, "Bad signature for payload #{diags}"
         end
       end
 
@@ -110,9 +115,7 @@ module DiscourseApi
       ACCESSORS.each do |k|
         val = decoded_hash[k.to_s]
         val = val.to_i if FIXNUMS.include? k
-        if BOOLS.include? k
-          val = ["true", "false"].include?(val) ? val == "true" : nil
-        end
+        val = %w[true false].include?(val) ? val == "true" : nil if BOOLS.include? k
         val = val.split(",") if ARRAYS.include?(k) && !val.nil?
         sso.send("#{k}=", val)
       end
@@ -148,12 +151,12 @@ module DiscourseApi
 
     def to_url(base_url = nil)
       base = "#{base_url || sso_url}"
-      "#{base}#{base.include?('?') ? '&' : '?'}#{payload}"
+      "#{base}#{base.include?("?") ? "&" : "?"}#{payload}"
     end
 
     def payload
       payload = Base64.strict_encode64(unsigned_payload)
-      "sso=#{CGI::escape(payload)}&sig=#{sign(payload)}"
+      "sso=#{CGI.escape(payload)}&sig=#{sign(payload)}"
     end
 
     def unsigned_payload
@@ -164,11 +167,7 @@ module DiscourseApi
         payload[k] = val
       end
 
-      if @custom_fields
-        @custom_fields.each do |k, v|
-          payload["custom.#{k}"] = v.to_s
-        end
-      end
+      @custom_fields.each { |k, v| payload["custom.#{k}"] = v.to_s } if @custom_fields
 
       Rack::Utils.build_query(payload)
     end

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_key_spec.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::ApiKey do
-  subject {
-    DiscourseApi::Client.new(
-      "#{host}",
-      "test_d7fd0429940",
-      "test_user"
-    )
-  }
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#list_api_keys" do
     before do
       url = "#{host}/admin/api/keys"
-      stub_get(url).to_return(body: fixture("list_api_keys.json"),
-                              headers: { content_type: "application/json" })
+      stub_get(url).to_return(
+        body: fixture("list_api_keys.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -27,35 +25,43 @@ describe DiscourseApi::API::ApiKey do
       keys = subject.list_api_keys
       expect(keys["keys"]).to be_an Array
       expect(keys["keys"].first).to be_a Hash
-      expect(keys["keys"].first).to have_key('key')
+      expect(keys["keys"].first).to have_key("key")
     end
   end
 
   describe "#create_api_key" do
     before do
       url = "#{host}/admin/api/keys"
-      stub_post(url).to_return(body: fixture("api_key.json"),
-                               headers: { content_type: "application/json" })
+      stub_post(url).to_return(
+        body: fixture("api_key.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
-      subject.create_api_key(key: { username: 'robin' })
+      subject.create_api_key(key: { username: "robin" })
       url = "#{host}/admin/api/keys"
       expect(a_post(url)).to have_been_made
     end
 
     it "returns the generated api key" do
-      api_key = subject.create_api_key(key: { username: 'robin' })
+      api_key = subject.create_api_key(key: { username: "robin" })
       expect(api_key).to be_a Hash
-      expect(api_key['key']).to have_key('key')
+      expect(api_key["key"]).to have_key("key")
     end
   end
 
   describe "#revoke_api_key" do
     before do
       url = "#{host}/admin/api/keys/10/revoke"
-      stub_post(url).to_return(body: fixture("api_key.json"),
-                               headers: { content_type: "application/json" })
+      stub_post(url).to_return(
+        body: fixture("api_key.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -66,15 +72,19 @@ describe DiscourseApi::API::ApiKey do
 
     it "returns the api key" do
       api_key = subject.revoke_api_key(10)
-      expect(api_key['key']).to have_key('key')
+      expect(api_key["key"]).to have_key("key")
     end
   end
 
   describe "#undo_revoke_api_key" do
     before do
       url = "#{host}/admin/api/keys/10/undo-revoke"
-      stub_post(url).to_return(body: fixture("api_key.json"),
-                               headers: { content_type: "application/json" })
+      stub_post(url).to_return(
+        body: fixture("api_key.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -85,15 +95,19 @@ describe DiscourseApi::API::ApiKey do
 
     it "returns the api key" do
       api_key = subject.undo_revoke_api_key(10)
-      expect(api_key['key']).to have_key('key')
+      expect(api_key["key"]).to have_key("key")
     end
   end
 
   describe "#delete_api_key" do
     before do
       url = "#{host}/admin/api/keys/10"
-      stub_delete(url).to_return(body: '{"success": "OK"}',
-                                 headers: { content_type: "application/json" })
+      stub_delete(url).to_return(
+        body: '{"success": "OK"}',
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -104,7 +118,7 @@ describe DiscourseApi::API::ApiKey do
 
     it "returns 200" do
       response = subject.delete_api_key(10)
-      expect(response['status']).to eq(200)
+      expect(response["status"]).to eq(200)
     end
   end
 end

data/spec/discourse_api/api/backups_spec.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
-require 'spec_helper'
+require "spec_helper"
 
 describe DiscourseApi::API::Backups do
   subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#backups" do
     before do
-      stub_get("#{host}/admin/backups.json").to_return(body: fixture("backups.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/admin/backups.json").to_return(
+        body: fixture("backups.json"),
+        headers: {
+          content_type: "application/json",
+        },
+      )
     end
 
     it "requests the correct resource" do
@@ -18,7 +23,7 @@ describe DiscourseApi::API::Backups do
       backups = subject.backups
       expect(backups).to be_an Array
       expect(backups.first).to be_a Hash
-      expect(backups.first).to have_key('filename')
+      expect(backups.first).to have_key("filename")
     end
   end
 end