discourse_api 2.0.0 → 2.1.0

data/spec/discourse_api/client_spec.rb

@@ -2,7 +2,7 @@
 require "spec_helper"
 
 describe DiscourseApi::Client do
-  subject { DiscourseApi::Client.new(host) }
+  subject(:client) { DiscourseApi::Client.new(host) }
 
   describe ".new" do
     it "requires a host argument" do
@@ -10,11 +10,11 @@ describe DiscourseApi::Client do
     end
 
     it "defaults api key to nil" do
-      expect(subject.api_key).to be_nil
+      expect(client.api_key).to be_nil
     end
 
     it "defaults api username to nil" do
-      expect(subject.api_username).to be_nil
+      expect(client.api_username).to be_nil
     end
 
     it "accepts an api key argument" do
@@ -31,55 +31,55 @@ describe DiscourseApi::Client do
   describe "#timeout" do
     context "with a custom timeout" do
       it "is set to Faraday connection" do
-        expect(subject.send(:connection).options.timeout).to eq(30)
+        expect(client.send(:connection).options.timeout).to eq(30)
       end
     end
 
     context "with the default timeout" do
       it "is set to Faraday connection" do
-        subject.timeout = 25
-        expect(subject.send(:connection).options.timeout).to eq(25)
+        client.timeout = 25
+        expect(client.send(:connection).options.timeout).to eq(25)
       end
     end
 
     it "raises DiscourseApi::Timeout" do
       stub_get("#{host}/t/1.json").to_timeout
 
-      expect { subject.topic(1) }.to raise_error(DiscourseApi::Timeout)
+      expect { client.topic(1) }.to raise_error(DiscourseApi::Timeout)
     end
   end
 
   describe "#api_key" do
     it "is publicly accessible" do
-      subject.api_key = "test_d7fd0429940"
-      expect(subject.api_key).to eq("test_d7fd0429940")
+      client.api_key = "test_d7fd0429940"
+      expect(client.api_key).to eq("test_d7fd0429940")
     end
   end
 
   describe "#api_username" do
     it "is publicly accessible" do
-      subject.api_username = "test_user"
-      expect(subject.api_username).to eq("test_user")
+      client.api_username = "test_user"
+      expect(client.api_username).to eq("test_user")
     end
   end
 
   describe "#host" do
     it "is publicly readable" do
-      expect(subject.host).to eq("#{host}")
+      expect(client.host).to eq("#{host}")
     end
 
     it "is not publicly writeable" do
-      expect(subject).not_to respond_to(:host=)
+      expect(client).not_to respond_to(:host=)
     end
   end
 
   describe "#connection" do
     it "looks like a Faraday connection" do
-      expect(subject.send(:connection)).to respond_to :run_request
+      expect(client.send(:connection)).to respond_to :run_request
     end
 
     it "memorizes the connection" do
-      c1, c2 = subject.send(:connection), subject.send(:connection)
+      c1, c2 = client.send(:connection), client.send(:connection)
       expect(c1.object_id).to eq(c2.object_id)
     end
   end
@@ -87,22 +87,22 @@ describe DiscourseApi::Client do
   describe "#delete" do
     before do
       stub_delete("#{host}/test/delete").with(query: { deleted: "object" })
-      subject.api_key = "test_d7fd0429940"
-      subject.api_username = "test_user"
+      client.api_key = "test_d7fd0429940"
+      client.api_username = "test_user"
     end
 
     it "allows custom delete requests" do
-      subject.delete("/test/delete", { deleted: "object" })
+      client.delete("/test/delete", { deleted: "object" })
       expect(a_delete("#{host}/test/delete").with(query: { deleted: "object" })).to have_been_made
     end
 
     context "when using a host with a subdirectory" do
-      subject { DiscourseApi::Client.new("#{host}/forum") }
+      subject(:client) { DiscourseApi::Client.new("#{host}/forum") }
 
       before { stub_delete("#{host}/forum/test/delete").with(query: { deleted: "object" }) }
 
       it "allows custom delete requests" do
-        subject.delete("/test/delete", { deleted: "object" })
+        client.delete("/test/delete", { deleted: "object" })
         expect(
           a_delete("#{host}/forum/test/delete").with(query: { deleted: "object" }),
         ).to have_been_made
@@ -113,22 +113,22 @@ describe DiscourseApi::Client do
   describe "#post" do
     before do
       stub_post("#{host}/test/post").with(body: { created: "object" })
-      subject.api_key = "test_d7fd0429940"
-      subject.api_username = "test_user"
+      client.api_key = "test_d7fd0429940"
+      client.api_username = "test_user"
     end
 
     it "allows custom post requests" do
-      subject.post("/test/post", { created: "object" })
+      client.post("/test/post", { created: "object" })
       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") }
+      subject(:client) { DiscourseApi::Client.new("#{host}/forum") }
 
       before { stub_post("#{host}/forum/test/post").with(body: { created: "object" }) }
 
       it "allows custom post requests" do
-        subject.post("/test/post", { created: "object" })
+        client.post("/test/post", { created: "object" })
         expect(
           a_post("#{host}/forum/test/post").with(body: { created: "object" }),
         ).to have_been_made
@@ -139,22 +139,22 @@ describe DiscourseApi::Client do
   describe "#put" do
     before do
       stub_put("#{host}/test/put").with(body: { updated: "object" })
-      subject.api_key = "test_d7fd0429940"
-      subject.api_username = "test_user"
+      client.api_key = "test_d7fd0429940"
+      client.api_username = "test_user"
     end
 
     it "allows custom put requests" do
-      subject.put("/test/put", { updated: "object" })
+      client.put("/test/put", { updated: "object" })
       expect(a_put("#{host}/test/put").with(body: { updated: "object" })).to have_been_made
     end
 
     context "when using a host with a subdirectory" do
-      subject { DiscourseApi::Client.new("#{host}/forum") }
+      subject(:client) { DiscourseApi::Client.new("#{host}/forum") }
 
       before { stub_put("#{host}/forum/test/put").with(body: { updated: "object" }) }
 
       it "allows custom post requests" do
-        subject.put("/test/put", { updated: "object" })
+        client.put("/test/put", { updated: "object" })
         expect(a_put("#{host}/forum/test/put").with(body: { updated: "object" })).to have_been_made
       end
     end
@@ -167,17 +167,17 @@ describe DiscourseApi::Client do
         OpenStruct.new(env: { body: "error page html" }, status: 500),
       )
       allow(Faraday).to receive(:new).and_return(connection)
-      expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
+      expect { client.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end
 
     it "catches Faraday errors" do
       allow(Faraday).to receive(:new).and_raise(Faraday::ClientError.new("BOOM!"))
-      expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
+      expect { client.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end
 
     it "catches JSON::ParserError errors" do
       allow(Faraday).to receive(:new).and_raise(JSON::ParserError.new("unexpected token"))
-      expect { subject.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
+      expect { client.send(:request, :get, "/test") }.to raise_error DiscourseApi::Error
     end
   end
 end

data/spec/discourse_api/single_sign_on_spec.rb

@@ -32,12 +32,29 @@ describe DiscourseApi::SingleSignOn do
   end
 
   describe ".parse" do
-    it "raises ParseError when there's a signature mismatch" do
-      sso = described_class.new
-      sso.sso_secret = "abcd"
-      expect { described_class.parse(sso.payload, "dcba") }.to raise_error(
-        DiscourseApi::SingleSignOn::ParseError,
-      )
+    context "when sso is present" do
+      it "raises ParseError when there's a signature mismatch" do
+        sso = described_class.new
+        sso.sso_secret = "abcd"
+        expect { described_class.parse(sso.payload, "dcba") }.to raise_error(
+          DiscourseApi::SingleSignOn::ParseError,
+        )
+      end
+    end
+
+    context "when sso is missing" do
+      it "raises ParseError when there's a signature mismatch" do
+        sso = described_class.new
+        sso.sso_secret = "abcd"
+        missing_sso = Rack::Utils.parse_query(sso.payload)
+        missing_sso.delete("sso")
+        malformed_query = Rack::Utils.build_query(missing_sso)
+
+        expect { described_class.parse(malformed_query, "dcba") }.to raise_error(
+          DiscourseApi::SingleSignOn::ParseError,
+          /The SSO field should/i,
+        )
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ SimpleCov.start { add_filter "/spec/" }
 require "discourse_api"
 require "rspec"
 require "webmock/rspec"
+require "ostruct"
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sam Saffron
 - John Paul Ashenfelter
 - Michael Herold
 - Blake Erickson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -185,44 +184,30 @@ dependencies:
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.8.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.8.1
 - !ruby/object:Gem::Dependency
   name: syntax_tree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.1
-- !ruby/object:Gem::Dependency
-  name: syntax_tree-disable_ternary
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 6.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 6.2.0
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -376,7 +361,6 @@ homepage: http://github.com/discourse/discourse_api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -391,8 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Allows access to the Discourse API
 test_files: