discourse_api 0.39.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 949fba1e4447d9615d8d3457b79328a866cfe61f325c3cd4f6a2cf3083ad9322
-  data.tar.gz: 2cc4f93ec719eb99e0bbd02caeecc02c3ed36bcd33b4b6435b9cb56835e622ae
+  metadata.gz: e8e19227c879502b171c001c16ecef5ba35e1aa97db19430c30bf35cc7fe6bf0
+  data.tar.gz: 94571b5d801c0c89e18768bee1182f5d37114bb2e3b06e6665ace17e9acb001e
 SHA512:
-  metadata.gz: 781247a4d7644d9f58609f221da038f8f59e58114ba2450c63c1ef8e7adfda029c775e8b58b0237220c76d3db1d95232249a6d04ff9138da2aa759eaa6938fa2
-  data.tar.gz: 995b7de67aef36acab3ef778201032aa9c2e9c9762a02d80e6cfeeacccd8dac64c433fc5cda75bfca6fbbcade605ea3917fd6c92283253c7a79618b24d2b644d
+  metadata.gz: 32a0f6371f096dff33f1a71ab200d36824ca4a22f49500f7e06c5f245b53073215f3ae11b2410d11ca0a0a94c8d23546bb66faf48727c0bc241c689fd41795a6
+  data.tar.gz: 857e1f6535a4d1a49369101e351950f4c393b5f502f2dd7499874347b326b7731a761a97a6f0301b2b97cb64017bc5908bd7505642cb1c6e3524597299ab43fa

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

@@ -2,6 +2,35 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [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
+- Add `members_visibility_level` to group
+
+## [0.39.1] - 2020-03-27
+### Fixed
+- Ensure released gem version matches this commit
+
 ## [0.39.0] - 2020-03-27
 ### Added
 - Get latest posts across topics via posts.json
@@ -205,7 +234,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
@@ -262,8 +291,3 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ## [0.1.2] - 2014-05-11
 
 - Release
-
-
-
-
-

data/README.md

@@ -52,7 +52,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 +83,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/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

@@ -18,6 +18,7 @@ module DiscourseApi
                             :flair_bg_color,
                             :flair_color,
                             :bio_raw,
+                            :members_visibility_level,
                             :public_admission,
                             :public_exit,
                             :allow_membership_requests,
@@ -46,6 +47,7 @@ module DiscourseApi
                             :flair_bg_color,
                             :flair_color,
                             :bio_raw,
+                            :members_visibility_level,
                             :public_admission,
                             :public_exit,
                             :allow_membership_requests,

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/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
@@ -112,19 +113,30 @@ module DiscourseApi
 
     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

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_key_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::ApiKey do
@@ -30,33 +31,6 @@ describe DiscourseApi::API::ApiKey do
     end
   end
 
-  describe "#generate_user_api_key" do
-    before do
-      url = "#{host}/admin/users/2/generate_api_key.json"
-      stub_post(url).to_return(body: fixture("generate_api_key.json"),
-                               headers: { content_type: "application/json" })
-    end
-
-    it "returns the generated api key" do
-      api_key = subject.generate_user_api_key(2)
-      expect(api_key).to be_a Hash
-      expect(api_key['api_key']).to have_key('key')
-    end
-  end
-
-  describe "#revoke_user_api_key" do
-    before do
-      url = "#{host}/admin/users/2/revoke_api_key.json"
-      stub_delete(url).to_return(body: "",
-      headers: { content_type: "application/json" })
-    end
-
-    it "returns 200" do
-      response = subject.revoke_user_api_key(2)
-      expect(response['status']).to eq(200)
-    end
-  end
-
   describe "#generate_master_key" do
     before do
       url = "#{host}/admin/api/key"
@@ -95,7 +69,7 @@ describe DiscourseApi::API::ApiKey do
     before do
       url = "#{host}/admin/api/key"
       stub_put(url).to_return(body: fixture("regenerate_api_key.json"),
-                                 headers: { content_type: "application/json" })
+                              headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do

data/spec/discourse_api/api/backups_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Backups do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#backups" do
     before do

data/spec/discourse_api/api/badges_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Badges do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#badges" do
     before do

data/spec/discourse_api/api/categories_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Categories do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#categories" do
     before do
@@ -42,8 +43,8 @@ describe DiscourseApi::API::Categories do
   describe '#category_top_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/top.json")
-      .to_return(
-        body: fixture("category_topics.json"), 
+        .to_return(
+        body: fixture("category_topics.json"),
         headers: { content_type: "application/json" }
       )
     end
@@ -57,8 +58,8 @@ describe DiscourseApi::API::Categories do
   describe '#category_new_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/new.json")
-      .to_return(
-        body: fixture("category_topics.json"), 
+        .to_return(
+        body: fixture("category_topics.json"),
         headers: { content_type: "application/json" }
       )
     end
@@ -74,14 +75,14 @@ describe DiscourseApi::API::Categories do
       stub_post("#{host}/categories")
       subject.create_category(name: "test_category", color: "283890", text_color: "FFFFFF",
                               description: "This is a description",
-                              permissions: {"group_1" => 1, "admins" => 1})
+                              permissions: { "group_1" => 1, "admins" => 1 })
     end
-    
+
     it "makes a create category request" do
       expect(a_post("#{host}/categories").with(body:
           "color=283890&description=This+is+a+description&name=test_category&parent_category_id&permissions%5Badmins%5D=1&permissions%5Bgroup_1%5D=1&text_color=FFFFFF")
         ).to have_been_made
     end
-  end  
+  end
 
 end

data/spec/discourse_api/api/email_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Email do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#email_settings" do
     before do

data/spec/discourse_api/api/groups_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Groups do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#groups" do
     before do
@@ -51,28 +52,28 @@ describe DiscourseApi::API::Groups do
       it "adds a single member by username" do
         subject.group_add(123, username: "sam")
         expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: {usernames: "sam"})
+                with(body: { usernames: "sam" })
               ).to have_been_made
       end
 
       it "adds an array of members by username" do
         subject.group_add(123, usernames: ["sam", "jeff"])
         expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: {usernames: "sam,jeff"})
+                with(body: { usernames: "sam,jeff" })
               ).to have_been_made
       end
 
       it "adds a single member by user_id" do
         subject.group_add(123, user_id: 456)
         expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: {user_ids: "456"})
+                with(body: { user_ids: "456" })
               ).to have_been_made
       end
 
       it "adds an array of members by user_id" do
         subject.group_add(123, user_id: [123, 456])
         expect(a_request(:put, "#{host}/admin/groups/123/members.json").
-                with(body: {user_ids: "123,456"})
+                with(body: { user_ids: "123,456" })
               ).to have_been_made
       end
     end
@@ -122,7 +123,7 @@ describe DiscourseApi::API::Groups do
       it "updates user's notification level for group" do
         subject.group_set_user_notification_level("mygroup", 77, 3)
         expect(a_post("#{host}/groups/mygroup/notifications?user_id=77&notification_level=3"))
-            .to have_been_made
+          .to have_been_made
       end
     end
 

data/spec/discourse_api/api/notifications_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Notifications do

data/spec/discourse_api/api/params_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Params do
@@ -6,31 +7,31 @@ describe DiscourseApi::API::Params do
   end
 
   it "should raise on missing required params" do
-    expect { params_for({o1: "test"}).to_h }.to raise_error(ArgumentError)
+    expect { params_for({ o1: "test" }).to_h }.to raise_error(ArgumentError)
   end
 
   it "should not raise when a required param is false" do
-    expect { params_for({r1: false}).to_h }.not_to raise_error
+    expect { params_for({ r1: false }).to_h }.not_to raise_error
   end
 
   it "should not include optional params when not provided" do
-    expect(params_for({r1: "test"}).to_h).not_to include(:o1)
+    expect(params_for({ r1: "test" }).to_h).not_to include(:o1)
   end
 
   it "should include optional params if provided but blank" do
-    expect(params_for({r1: "test", o2: nil}).to_h).to include(:o2)
+    expect(params_for({ r1: "test", o2: nil }).to_h).to include(:o2)
   end
 
   it "should include default params when defined but not provided" do
-    expect(params_for({r1: "test"}).to_h).to include(d1: "default")
+    expect(params_for({ r1: "test" }).to_h).to include(d1: "default")
   end
 
   it "should include default params when defined and provided" do
-    expect(params_for({r1: "test", d1: "override"}).to_h).to include(d1: "override")
+    expect(params_for({ r1: "test", d1: "override" }).to_h).to include(d1: "override")
   end
 
   it "should include optional and default params when defined and provided" do
-    expect(params_for({r1: "test", o1: "optional", d1: "override"}).to_h).to include(o1: "optional", d1: "override")
+    expect(params_for({ r1: "test", o1: "optional", d1: "override" }).to_h).to include(o1: "optional", d1: "override")
   end
 
 end

data/spec/discourse_api/api/polls_spec.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Polls do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#poll vote" do
     before do
       path = "#{host}/polls/vote"
       stub_put(path)
-          .to_return(body: fixture("polls_vote.json"), headers: { content_type: "application/json" })
-    
+        .to_return(body: fixture("polls_vote.json"), headers: { content_type: "application/json" })
+
     end
 
     it "requests the correct resource" do
@@ -29,7 +30,7 @@ describe DiscourseApi::API::Polls do
     before do
       path = "#{host}/polls/toggle_status"
       stub_put(path)
-          .to_return(body: fixture("polls_toggle_status.json"), headers: { content_type: "application/json" })
+        .to_return(body: fixture("polls_toggle_status.json"), headers: { content_type: "application/json" })
 
     end
 
@@ -49,7 +50,7 @@ describe DiscourseApi::API::Polls do
   describe "#poll voters" do
     before do
       stub_get("#{host}/polls/voters.json?post_id=5&poll_name=poll")
-          .to_return(body: fixture("polls_voters.json"), headers: { content_type: "application/json" })
+        .to_return(body: fixture("polls_voters.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
@@ -64,7 +65,7 @@ describe DiscourseApi::API::Polls do
       expect(voters['voters']['e539a9df8700d0d05c69356a07b768cf']).to be_an Array
       expect(voters['voters']['e539a9df8700d0d05c69356a07b768cf'][0]['id']).to eq(356)
     end
-   end
+  end
 
   end
 end

data/spec/discourse_api/api/posts_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Posts do

data/spec/discourse_api/api/private_messages_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::PrivateMessages do

data/spec/discourse_api/api/search_spec.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Search do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#search" do
     before do
-      stub_get("#{host}/search/query").with(query: { term: "test"} ).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/search/query").with(query: { term: "test" }).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.search("test")
-      expect(a_get("#{host}/search/query").with(query: { term: "test"} )).to have_been_made
+      expect(a_get("#{host}/search/query").with(query: { term: "test" })).to have_been_made
     end
 
     it "returns the requested search" do

data/spec/discourse_api/api/site_settings_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::SiteSettings do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
 
   describe "#site_setting_update" do
     before do

data/spec/discourse_api/api/sso_spec.rb

@@ -1,15 +1,58 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::SSO do
-  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user" )}
+  subject { DiscourseApi::Client.new("#{host}", "test_d7fd0429940", "test_user") }
+
+  let(:params) do
+    {
+      sso_secret: 'abc',
+      sso_url: 'www.google.com',
+      name: 'Some User',
+      username: 'some_user',
+      email: 'some@email.com',
+      external_id: 'abc',
+      suppress_welcome_message: false,
+      avatar_url: 'https://www.website.com',
+      title: 'ruby',
+      avatar_force_update: false,
+      add_groups: ['a', 'b'],
+      remove_groups: ['c', 'd'],
+      # old format (which results in custom.custom.field_1 in unsigned_payload)
+      'custom.field_1' => 'tomato',
+      # new format
+      custom_fields: {
+        field_2: 'potato'
+      }
+    }
+  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'
+  end
+  let(:sso_double) { DiscourseApi::SingleSignOn.parse_hash(params) }
 
   describe "#sync_sso" do
     before do
-      stub_post(/.*sync_sso.*/).to_return(body: fixture("user.json"), headers: { content_type: "application/json" })
+      stub_post(/.*sync_sso.*/).to_return(
+        body: fixture("user.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it 'assigns params to sso instance' do
+      allow(DiscourseApi::SingleSignOn).to(receive(:parse_hash).with(params).and_return(sso_double))
+
+      subject.sync_sso(params)
+
+      expect(sso_double.custom_fields).to eql({ 'custom.field_1' => 'tomato', :field_2 => 'potato' })
+      expect(sso_double.unsigned_payload).to eql(expected_unsigned_payload)
     end
 
     it "requests the correct resource" do
-      subject.sync_sso({sso_secret: "test_d7fd0429940", "custom.riffle_url" => "test"})
+      subject.sync_sso({ sso_secret: "test_d7fd0429940", "custom.riffle_url" => "test" })
       expect(a_post(/.*sync_sso.*/)).to have_been_made
     end
   end

data/spec/discourse_api/api/topics_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Topics do

data/spec/discourse_api/api/uploads_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Uploads do

data/spec/discourse_api/api/user_actions_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::UserActions do

data/spec/discourse_api/api/users_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::API::Users do
@@ -113,12 +114,12 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the post request" do
-      subject.create_user :name => "Test User", :email => "test2@example.com", :password => "P@ssword", :username => "test2"
+      subject.create_user name: "Test User", email: "test2@example.com", password: "P@ssword", username: "test2"
       expect(a_post("#{host}/users")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.create_user :name => "Test User", :email => "test2@example.com", :password => "P@ssword", :username => "test2"
+      response = subject.create_user name: "Test User", email: "test2@example.com", password: "P@ssword", username: "test2"
       expect(response).to be_a Hash
       expect(response['success']).to be_truthy
     end
@@ -163,7 +164,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "Raises API Error" do
-      expect{subject.log_out(90)}.to raise_error DiscourseApi::NotFoundError
+      expect { subject.log_out(90) }.to raise_error DiscourseApi::NotFoundError
     end
   end
 

data/spec/discourse_api/client_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe DiscourseApi::Client do
@@ -90,26 +91,26 @@ describe DiscourseApi::Client do
 
   describe "#post" do
     before do
-      stub_post("#{host}/test/post").with(body: { created: "object"})
+      stub_post("#{host}/test/post").with(body: { created: "object" })
       subject.api_key = 'test_d7fd0429940'
       subject.api_username = 'test_user'
     end
 
     it "allows custom post requests" do
       subject.post("/test/post", { created: "object" })
-      expect(a_post("#{host}/test/post").with(body: { created: "object"})).to have_been_made
+      expect(a_post("#{host}/test/post").with(body: { created: "object" })).to have_been_made
     end
 
     context 'when using a host with a subdirectory' do
       subject { DiscourseApi::Client.new("#{host}/forum") }
 
       before do
-        stub_post("#{host}/forum/test/post").with(body: { created: "object"})
+        stub_post("#{host}/forum/test/post").with(body: { created: "object" })
       end
 
       it "allows custom post requests" do
         subject.post("/test/post", { created: "object" })
-        expect(a_post("#{host}/forum/test/post").with(body: { created: "object"})).to have_been_made
+        expect(a_post("#{host}/forum/test/post").with(body: { created: "object" })).to have_been_made
       end
     end
   end
@@ -144,18 +145,18 @@ describe DiscourseApi::Client do
     it "catches 500 errors" do
       connection = instance_double(Faraday::Connection)
       allow(connection).to receive(:get).and_return(OpenStruct.new(env: { body: 'error page html' }, status: 500))
-      allow(subject).to receive(:connection).and_return(connection)
-      expect{subject.send(:request, :get, "/test")}.to raise_error DiscourseApi::Error
+      allow(Faraday).to receive(:new).and_return(connection)
+      expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end
 
     it "catches Faraday errors" do
-      allow(subject).to receive(:connection).and_raise(Faraday::ClientError.new("BOOM!"))
-      expect{subject.send(:request, :get, "/test")}.to raise_error DiscourseApi::Error
+      allow(Faraday).to receive(:new).and_raise(Faraday::ClientError.new("BOOM!"))
+      expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end
 
     it "catches JSON::ParserError errors" do
-      allow(subject).to receive(:connection).and_raise(JSON::ParserError.new("unexpected token"))
-      expect{subject.send(:request, :get, "/test")}.to raise_error DiscourseApi::Error
+      allow(Faraday).to receive(:new).and_raise(JSON::ParserError.new("unexpected token"))
+      expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'simplecov'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
@@ -18,7 +19,7 @@ RSpec.configure do |config|
   end
 end
 
-WebMock.disable_net_connect!(:allow_localhost => true)
+WebMock.disable_net_connect!(allow_localhost: true)
 
 def host
   'http://localhost:3000'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,28 +19,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -101,16 +101,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
@@ -139,20 +139,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.69'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.69'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -185,30 +171,16 @@ dependencies:
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -219,9 +191,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -307,7 +279,6 @@ files:
 - spec/fixtures/category_topics.json
 - spec/fixtures/email_list_all.json
 - spec/fixtures/email_settings.json
-- spec/fixtures/generate_api_key.json
 - spec/fixtures/generate_master_key.json
 - spec/fixtures/group.json
 - spec/fixtures/groups.json
@@ -401,7 +372,6 @@ test_files:
 - spec/fixtures/category_topics.json
 - spec/fixtures/email_list_all.json
 - spec/fixtures/email_settings.json
-- spec/fixtures/generate_api_key.json
 - spec/fixtures/generate_master_key.json
 - spec/fixtures/group.json
 - spec/fixtures/groups.json

data/.travis.yml

@@ -1,11 +0,0 @@
-language: 'ruby'
-
-before_install:
-  - 'gem update --system'
-  - 'gem install bundler'
-
-rvm:
-  - '2.5.5'
-  - '2.6.2'
-
-script: 'bundle exec rake'

data/spec/fixtures/generate_api_key.json

@@ -1,12 +0,0 @@
-{
-  "api_key": {
-    "id": 5,
-    "key": "e722e04df8cf6d097d565ca04eea1ff8e9e8f09beb405bae6f0c79852916f334",
-    "user": {
-      "id": 2,
-      "username": "robin",
-      "uploaded_avatar_id": 3,
-      "avatar_template": "/user_avatar/localhost/robin/{size}/3.png"
-    }
-  }
-}