discourse_api 0.39.2 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7751bb77d63663884ff92f87d34b6dc96803cfe6c0600a25fdcbfcba965398b5
-  data.tar.gz: 1957c02159087873d698ad51c355f82f21e03871cca48c5278b35790027490dc
+  metadata.gz: 47b23caec63bf36a246bfa9ce104e32ac5e1d0978e2e469154b976fed097aa91
+  data.tar.gz: afe90f37b0464d43df29b38884c77f747975f805a5f7d17797fbd82c62fa0d9f
 SHA512:
-  metadata.gz: 8ac17e058a704dbc07ed571118fd8a4bd5be2722d19867305a081711ea787597ce7ccc581903b702f1349dc9c31e49e279c4b759e20658bb6c6ec1290b0067b1
-  data.tar.gz: '0971e59124c23adb2e3dca41e0985142586523cabec565cb4696e92e7efb6b7fb5dc8302db42af09b79050394a7067e85cda42efe51c884aff184ae7bd75d34b'
+  metadata.gz: 04a47e1164ab7b298292a840b5263967e333baff682839fe87ed791412364e4e87b6465d36737761ce98271258544519206484a8e06d9396fd2d9514fd6547c3
+  data.tar.gz: 895e1c5a9e021eb6b6a8fd12e0aa05e45b9865e11bdf10639d1b05941ce4512d311c71cf427b0e9395c94085a63831531e7903c2cbdb5c5fb79aabbacf438906

data/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+
+      - name: Setup bundler
+        run: gem install bundler
+
+      - name: Setup gems
+        run: bundle install
+
+      - name: Rubocop
+        run: bundle exec rubocop
+
+      - name: RSpec
+        run: bundle exec rspec
+
+  publish:
+    if: contains(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: CvX/publish-rubygems-action@master
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.gitignore

@@ -20,5 +20,3 @@ bin/
 .ruby-version
 .env
 /config.yml
-
-.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rubocop.yml

@@ -1,6 +1,2 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
-AllCops:
-  TargetRubyVersion: 2.4
-  DisabledByDefault: true
-  Exclude:
-    - 'spec/**/**/*.rb'
+inherit_gem:
+  rubocop-discourse: default.yml

data/CHANGELOG.md

@@ -1,6 +1,41 @@
-# 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
+- Create topics with tags
+
+## [0.41.0] - 2020-06-17
+### Added
+- Add basic auth support
+
+### Fixed
+- Fix SSO custom field prefixes
+
+### Removed
+- Obsolete api key endpoints
+
+## [0.40.0] - 2020-05-07
+### Fixed
+- Add missing attributes to `sync_sso`
+
+### Added
+- Add delete category method
+
+## [0.39.3] - 2020-04-30
+### Fixed
+- Add `reviewable_by_group_name` to categories
 
 ## [0.39.2] - 2020-04-30
 ### Fixed
@@ -213,7 +248,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [0.8.1] - 2016-03-03
 ### Fixed
 - enable use of discourse_api to make unauthenticated requests to discourse
-  endpoints like /categories and /topics 
+  endpoints like /categories and /topics
 
 ## [0.8.0] - 2016-02-28
 ### Added
@@ -270,8 +305,3 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [0.1.2] - 2014-05-11
 
 - Release
-
-
-
-
-

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
@@ -52,7 +51,10 @@ client.sync_sso(                                #=> Synchronizes the SSO record
   name: "Test Name",
   username: "test_name",
   email: "name@example.com",
-  external_id: "2"
+  external_id: "2",
+  custom_fields: {
+    field_1: 'potato'
+  }
 )
 
 # Private messages
@@ -80,6 +82,15 @@ end
 
 Check out [lib/discourse_api/error.rb](lib/discourse_api/error.rb) and [lib/discourse_api/client.rb](lib/discourse_api/client.rb)'s `handle_error` method for the types of errors raised by the API.
 
+If your forum has a basic HTTP authentication enabled, set user and password:
+
+```ruby
+client.basic_auth = {
+  user: "test",
+  password: "secret"
+}
+```
+
 ## Contributing
 
 1. Fork it

data/discourse_api.gemspec

@@ -18,21 +18,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'faraday_middleware', '~> 0.10'
+  spec.add_dependency 'faraday', '~> 1.0'
+  spec.add_dependency 'faraday_middleware', '~> 1.0'
   spec.add_dependency 'rack', '>= 1.6'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rb-inotify', '~> 0.9'
   spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'rubocop', '~> 0.69'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'webmock', '~> 2.0'
-  spec.add_development_dependency 'rubocop-discourse', '~> 1.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.0'
+  spec.add_development_dependency 'rubocop-discourse'
 
   spec.required_ruby_version = '>= 2.2.3'
 end

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/examples/create_topic.rb

@@ -24,3 +24,13 @@ client.create_topic(
   title: "Your Favorite Color?",
   raw: "[poll name=color]\n- Green\n- Blue\n- Red\n[/poll]"
 )
+
+# Create Topic with Tags
+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"
+  tags: ['asdf', 'fdsa']
+)

data/lib/discourse_api/api/api_key.rb

@@ -7,14 +7,6 @@ module DiscourseApi
         response.body
       end
 
-      def generate_user_api_key(user_id)
-        response = post("/admin/users/#{user_id}/generate_api_key.json")
-      end
-
-      def revoke_user_api_key(user_id)
-        response = delete("/admin/users/#{user_id}/revoke_api_key.json")
-      end
-
       def generate_master_key
         response = post("/admin/api/key")
       end

data/lib/discourse_api/api/categories.rb

@@ -9,7 +9,8 @@ module DiscourseApi
         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)
+                             :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)
           .default(parent_category_id: nil)
         response = post("/categories", args)
         response['category']
@@ -20,12 +21,18 @@ module DiscourseApi
         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)
+                             :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)
           .default(parent_category_id: nil)
         response = put("/categories/#{category_id}", args)
         response['body']['category'] if response['body']
       end
 
+      def delete_category(id)
+        response = delete("/categories/#{id}")
+        response[:body]['success']
+      end
+
       def categories(params = {})
         response = get('/categories.json', params)
         response[:body]['category_list']['categories']

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/sso.rb

@@ -3,21 +3,7 @@ module DiscourseApi
   module API
     module SSO
       def sync_sso(params = {})
-        sso = DiscourseApi::SingleSignOn.new
-        sso.sso_secret = params[:sso_secret]
-        sso.name = params[:name]
-        sso.username = params[:username]
-        sso.email = params[:email]
-        sso.external_id = params[:external_id]
-        sso.suppress_welcome_message = params[:suppress_welcome_message] === true
-        sso.avatar_url = params[:avatar_url]
-        sso.title = params[:title]
-        sso.avatar_force_update = params[:avatar_force_update] === true
-        sso.add_groups = params[:add_groups]
-        sso.remove_groups = params[:remove_groups]
-        params.keys.select { |key| key.to_s.start_with?("custom") }.each do |custom_key|
-          sso.custom_fields[custom_key] = params[custom_key]
-        end
+        sso = DiscourseApi::SingleSignOn.parse_hash(params)
 
         post("/admin/users/sync_sso", sso.payload)
       end

data/lib/discourse_api/api/topics.rb

@@ -9,7 +9,7 @@ module DiscourseApi
       def create_topic(args = {})
         args = API.params(args)
           .required(:title, :raw)
-          .optional(:skip_validations, :category, :auto_track, :created_at, :api_username)
+          .optional(:skip_validations, :category, :auto_track, :created_at, :api_username, :tags)
         post("/posts", args.to_h)
       end
 
@@ -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

@@ -28,6 +28,7 @@ require 'discourse_api/api/site_settings'
 module DiscourseApi
   class Client
     attr_accessor :api_key
+    attr_accessor :basic_auth
     attr_reader :host, :api_username
 
     include DiscourseApi::API::Categories
@@ -108,23 +109,38 @@ 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
       @connection ||= Faraday.new connection_options do |conn|
-        # Follow redirects
-        conn.use FaradayMiddleware::FollowRedirects, limit: 5
         # Allow uploading of files
         conn.request :multipart
+
         # 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
+
+        # Follow redirects
+        conn.response :follow_redirects, limit: 5
+
         # Parse responses as JSON
-        conn.use FaradayMiddleware::ParseJson, content_type: 'application/json'
+        conn.response :json, content_type: 'application/json'
+
         # For HTTP debugging, uncomment
         # conn.response :logger
+
         # Use Faraday's default HTTP adapter
         conn.adapter Faraday.default_adapter
-        #pass api_key and api_username on every request
+
+        # 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

data/lib/discourse_api/single_sign_on.rb

@@ -5,7 +5,7 @@ require 'openssl'
 
 module DiscourseApi
   class SingleSignOn
-    ACCESSORS = [:nonce, :name, :username, :email, :avatar_url, :avatar_force_update, :require_activation,
+    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]
     FIXNUMS = []
@@ -15,6 +15,7 @@ module DiscourseApi
     #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
 
     def self.sso_secret
@@ -25,6 +26,36 @@ module DiscourseApi
       raise RuntimeError, "sso_url not implemented on class, be sure to set it on instance"
     end
 
+    def self.parse_hash(payload)
+      payload
+      sso = new
+
+      sso.sso_secret = payload.delete(:sso_secret)
+      sso.sso_url = payload.delete(:sso_url)
+
+      ACCESSORS.each do |k|
+        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 = Array(val) 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]
+          # Maintain adding of .custom bug
+          sso.custom_fields["custom.#{field}"] = v
+        end
+      end
+
+      sso
+    end
+
     def self.parse(payload, sso_secret = nil)
       sso = new
       sso.sso_secret = sso_secret if sso_secret
@@ -107,7 +138,5 @@ module DiscourseApi
 
       Rack::Utils.build_query(payload)
     end
-
   end
-
 end