discourse_api 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f12aa5327c6d59b3d258745ef391b3ce97da58367cd0056b7513735a6a530d42
-  data.tar.gz: f8b5f8eca097239993c8553bb0de9f3a1ec70348d511c16304e8586a0eda2e9e
+  metadata.gz: e8e19227c879502b171c001c16ecef5ba35e1aa97db19430c30bf35cc7fe6bf0
+  data.tar.gz: 94571b5d801c0c89e18768bee1182f5d37114bb2e3b06e6665ace17e9acb001e
 SHA512:
-  metadata.gz: 31f454b2b7b8ea518a03298fbcd179b5ecd7d4463a68ca574f081c7f6b261093bb2ffa10ea01ab752d281f33e2c028d56a639342e30481c9227dc7603467d840
-  data.tar.gz: 852e2a8aa5082f3850fbfd6e404d71a5d3a074c613305d0018c6d1b3c735182a45295043784954a8fd0a9d25caea585c87092971c9c5db730d6f60f67b3b67fc
+  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/CHANGELOG.md

@@ -2,6 +2,16 @@
 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`
@@ -224,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
@@ -281,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,8 +18,8 @@ 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'

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

@@ -3,24 +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.profile_background_url = params[:profile_background_url]
-        sso.card_background_url = params[:card_background_url]
-        sso.bio = params[:bio]
-        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

@@ -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.40.0"
+  VERSION = "0.41.0"
 end

data/spec/discourse_api/api/api_key_spec.rb

@@ -31,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"

data/spec/discourse_api/api/sso_spec.rb

@@ -4,9 +4,51 @@ require 'spec_helper'
 describe DiscourseApi::API::SSO do
   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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-07 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
@@ -191,9 +191,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -279,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
@@ -373,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"
-    }
-  }
-}