discourse_api 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b27fccecba3357cb727bb0b241e29613ddf4d6c
-  data.tar.gz: 9eff8ed55d066031a9ca7b875ecbae247c8f54b7
+  metadata.gz: 30c8f8cfc3ece69e96755f29c5765f204d505b10
+  data.tar.gz: 80873e28b06c2912282a2a9482d579536d97e250
 SHA512:
-  metadata.gz: 2dc325485d107e56f286baa033ffbefaf646c32611cfbea7b285a7d628445be7d6e900d7a0626516f6d1fb428d6e8ac6363803349845f51cebba0dbf66c846df
-  data.tar.gz: cf520bd3e1baba478c6f4ad7ece1f3419dfccdfdb8fdf6d54cec01a3a1433d06bbf254656b457bfb39e14090e329b05e7a5923518b90af185d105f7065a789e8
+  metadata.gz: 4fb815d8b714c4c0a90e931265b4d76a027848303c47bec066dbc79a7c3844026c4c8800b9fe88d89ffe460cf17ce97a67de9ea2dc9711e3a2f4c70f3ada1ba0
+  data.tar.gz: eba82e043e294893e8655fa8efd1b0c923657f03aa691daf8455739d0bf6b6841b5b5f10624cd8333248494eaac7fa1e40a64b7578a4963adc5746bcfb50c28f

data/README.md

@@ -29,6 +29,8 @@ few endpoints available:
 
 ```ruby
 client = DiscourseApi::Client.new("http://try.discourse.org")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
 
 # Topic endpoints
 client.latest_topics                            #=> Gets a list of the latest topics
@@ -43,6 +45,15 @@ client.search("sandbox")                        #=> Gets a list of topics that m
 # Categories endpoint
 client.categories                               #=> Gets a list of categories
 client.category_latest_posts("category-slug")   #=> Gets a list of latest posts in a category
+
+# SSO endpoint
+client.sync_sso(                                #=> Synchronizes the SSO record
+  sso_secret: "discourse_sso_rocks",
+  name: "Test Name",
+  username: "test_name",
+  email: "name@example.com",
+  external_id: "2"
+)
 ```
 
 

data/examples/invite_users.rb

@@ -5,6 +5,9 @@ client = DiscourseApi::Client.new("http://localhost:3000")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
+# invite user
+client.invite_user(email: "name@example.com", group_ids: "41,42")
+
 # invite to a topic
 client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1)
 

data/examples/sso.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+client.sync_sso(
+  sso_secret: "discourse_sso_rocks",
+  name: "Test Name",
+  username: "test_name",
+  email: "name@example.com",
+  external_id: "2"
+)

data/examples/topic_lists.rb

@@ -7,5 +7,9 @@ client.api_username = "YOUR_USERNAME"
 
 # get latest topics
 puts client.latest_topics({})
+
+# recategorize topic
+puts client.recategorize_topic(topic_id: 108, category_id: 5)
+
 # get all categories
 puts client.categories({})

data/lib/discourse_api/api/categories.rb

@@ -7,7 +7,7 @@ module DiscourseApi
       end
 
       def category_latest_topics(category_slug)
-        response = get("/category/#{category_slug}.json")
+        response = get("/category/#{category_slug}/l/latest.json")
         response[:body]['topic_list']['topics']
       end
     end

data/lib/discourse_api/api/invite.rb

@@ -1,6 +1,10 @@
 module DiscourseApi
   module API
     module Invite
+      def invite_user(params={})
+        post("/invites", params)
+      end
+
       def invite_user_to_topic(params={})
         post("/t/#{params[:topic_id]}/invite", params)
       end

data/lib/discourse_api/api/notifications.rb

@@ -0,0 +1,10 @@
+module DiscourseApi
+  module API
+    module Notifications
+      def notifications
+        response = get('/notifications.json')
+        response[:body]
+      end
+    end
+  end
+end

data/lib/discourse_api/api/private_messages.rb

@@ -0,0 +1,10 @@
+module DiscourseApi
+  module API
+    module PrivateMessages
+      def private_messages(username, *args)
+        response = get("topics/private-messages/#{username}.json", args)
+        response[:body]['topic_list']['topics']
+      end
+    end
+  end
+end

data/lib/discourse_api/api/sso.rb

@@ -0,0 +1,17 @@
+require 'single_sign_on'
+
+module DiscourseApi
+  module API
+    module SSO
+      def sync_sso(params={})
+        sso = 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]
+        post("/admin/users/sync_sso/", sso.payload)
+      end
+    end
+  end
+end

data/lib/discourse_api/api/topics.rb

@@ -15,6 +15,14 @@ module DiscourseApi
         response[:body]['topic_list']['topics']
       end
 
+      def rename_topic(topic_id, title)
+        put("/t/#{topic_id}.json", { topic_id: topic_id, title: title })
+      end
+
+      def recategorize_topic(topic_id, category_id)
+        put("/t/#{topic_id}.json", { topic_id: topic_id, category_id: category_id })
+      end
+
       def topic(id, *args)
         response = get("/t/#{id}.json", args)
         response[:body]
@@ -24,6 +32,10 @@ module DiscourseApi
         response = get("/topics/created-by/#{username}.json", args)
         response[:body]['topic_list']['topics']
       end
+
+      def delete_topic(id)
+        delete("/t/#{id}.json")
+      end
     end
   end
 end

data/lib/discourse_api/api/users.rb

@@ -27,11 +27,11 @@ module DiscourseApi
       end
 
       # Create a user
-      def create_user(*args)
+      def create_user(args={})
         # First retrieve the honeypot values
         response = get("/users/hp.json")
-        args.first[:password_confirmation] = response[:body]['value']
-        args.first[:challenge] = response[:body]['challenge'].reverse
+        args[:password_confirmation] = response[:body]['value']
+        args[:challenge] = response[:body]['challenge'].reverse
 
         # POST the args
         post("/users", args)

data/lib/discourse_api/client.rb

@@ -4,9 +4,12 @@ require 'json'
 require 'discourse_api/version'
 require 'discourse_api/api/categories'
 require 'discourse_api/api/search'
+require 'discourse_api/api/sso'
 require 'discourse_api/api/topics'
 require 'discourse_api/api/users'
 require 'discourse_api/api/invite'
+require 'discourse_api/api/private_messages'
+require 'discourse_api/api/notifications'
 
 module DiscourseApi
   class Client
@@ -15,9 +18,12 @@ module DiscourseApi
 
     include DiscourseApi::API::Categories
     include DiscourseApi::API::Search
+    include DiscourseApi::API::SSO
     include DiscourseApi::API::Topics
     include DiscourseApi::API::Users
     include DiscourseApi::API::Invite
+    include DiscourseApi::API::PrivateMessages
+    include DiscourseApi::API::Notifications
 
     def initialize(host, api_key=nil, api_username=nil)
       @host         = host

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/lib/single_sign_on.rb

@@ -0,0 +1,98 @@
+require 'base64'
+require 'rack'
+require 'openssl'
+
+class SingleSignOn
+  ACCESSORS = [:nonce, :name, :username, :email, :avatar_url, :avatar_force_update,
+               :about_me, :external_id]
+  FIXNUMS = []
+  NONCE_EXPIRY_TIME = 600 # 10 minutes
+
+  attr_accessor(*ACCESSORS)
+  attr_accessor :sso_secret, :sso_url
+
+  def self.sso_secret
+    raise RuntimeError, "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"
+  end
+
+  def self.parse(payload, sso_secret = nil)
+    sso = new
+    sso.sso_secret = sso_secret if sso_secret
+
+    parsed = Rack::Utils.parse_query(payload)
+    if sso.sign(parsed["sso"]) != parsed["sig"]
+      raise RuntimeError, "Bad signature for payload"
+    end
+
+    decoded = Base64.decode64(parsed["sso"])
+    decoded_hash = Rack::Utils.parse_query(decoded)
+
+    ACCESSORS.each do |k|
+      val = decoded_hash[k.to_s]
+      val = val.to_i if FIXNUMS.include? k
+      sso.send("#{k}=", val)
+    end
+
+    decoded_hash.each do |k,v|
+      # 1234567
+      # custom.
+      #
+      if k[0..6] == "custom."
+        field = k[7..-1]
+        sso.custom_fields[field] = v
+      end
+    end
+
+    sso
+  end
+
+  def sso_secret
+    @sso_secret || self.class.sso_secret
+  end
+
+  def sso_url
+    @sso_url || self.class.sso_url
+  end
+
+  def custom_fields
+    @custom_fields ||= {}
+  end
+
+
+  def sign(payload)
+    OpenSSL::HMAC.hexdigest("sha256", sso_secret, payload)
+  end
+
+
+  def to_url(base_url=nil)
+    base = "#{base_url || sso_url}"
+    "#{base}#{base.include?('?') ? '&' : '?'}#{payload}"
+  end
+
+  def payload
+    payload = Base64.encode64(unsigned_payload)
+    "sso=#{CGI::escape(payload)}&sig=#{sign(payload)}"
+  end
+
+  def unsigned_payload
+    payload = {}
+    ACCESSORS.each do |k|
+     next unless (val = send k)
+
+     payload[k] = val
+    end
+
+    if @custom_fields
+      @custom_fields.each do |k,v|
+        payload["custom.#{k}"] = v.to_s
+      end
+    end
+
+    Rack::Utils.build_query(payload)
+  end
+
+end

data/spec/discourse_api/api/categories_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Categories do
-  subject { DiscourseApi::Client.new("http://localhost:3000") }
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
 
   describe "#categories" do
     before do
@@ -9,15 +9,11 @@ describe DiscourseApi::API::Categories do
     end
 
     it "requests the correct resource" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       subject.categories
       expect(a_get("http://localhost:3000/categories.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested categories" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       categories = subject.categories
       expect(categories).to be_an Array
       expect(categories.first).to be_a Hash
@@ -26,12 +22,10 @@ describe DiscourseApi::API::Categories do
 
   describe '#category_latest_topics' do
     before do
-      stub_get("http://localhost:3000/category/category-slug.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/category/category-slug/l/latest.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
     end
 
     it "returns the latest topics in a category" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       latest_topics = subject.category_latest_topics('category-slug')
       expect(latest_topics).to be_an Array
     end

data/spec/discourse_api/api/notifications_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::Notifications do
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user") }
+
+  describe "#notifications" do
+
+    before do
+      stub_get("http://localhost:3000/notifications.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("notifications.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.notifications
+      expect(a_get("http://localhost:3000/notifications.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns the requested notifications" do
+      notifications = subject.notifications
+      expect(notifications).to be_an Array
+      expect(notifications.first).to be_an Hash
+      expect(notifications[0]['notification_type']).to eq(9)
+    end
+  end
+end

data/spec/discourse_api/api/private_messages_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::PrivateMessages do
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user") }
+
+  describe "#private_messages" do
+    before do
+      stub_get("http://localhost:3000/topics/private-messages/test_user.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("private_messages.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.private_messages('test_user')
+      expect(a_get("http://localhost:3000/topics/private-messages/test_user.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns the requested private messages" do
+      private_messages = subject.private_messages('test_user')
+      expect(private_messages).to be_an Array
+    end
+  end
+
+end

data/spec/discourse_api/api/search_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Search do
-  subject { DiscourseApi::Client.new("http://localhost:3000") }
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
 
   describe "#search" do
     before do
@@ -9,15 +9,11 @@ describe DiscourseApi::API::Search do
     end
 
     it "requests the correct resource" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       subject.search("test")
       expect(a_get("http://localhost:3000/search.json?api_key=test_d7fd0429940&api_username=test_user").with(query: { term: "test"} )).to have_been_made
     end
 
     it "returns the requested search" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       results = subject.search("test")
       expect(results).to be_an Array
       expect(results.first).to be_a Hash

data/spec/discourse_api/api/topics_spec.rb

@@ -1,10 +1,22 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Topics do
-  subject { DiscourseApi::Client.new("http://localhost:3000") }
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user") }
 
   describe "#invite_user_to_topic" do
-    it "needs to have a test written for it"
+    before do
+      stub_post("http://localhost:3000/t/12/invite?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("topic_invite_user.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
+      expect(a_post("http://localhost:3000/t/12/invite?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns success" do
+      response = subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
+      expect(response[:body]['success']).to be_truthy
+    end
   end
 
   describe "#latest_topics" do
@@ -13,15 +25,11 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       subject.latest_topics
       expect(a_get("http://localhost:3000/latest.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topics" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       topics = subject.latest_topics
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
@@ -34,14 +42,11 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       subject.new_topics
       expect(a_get("http://localhost:3000/new.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topics" do
-      subject.api_key = 'test_d7fd0429940'
       subject.api_username = 'test_user'
       topics = subject.new_topics
       expect(topics).to be_an Array
@@ -55,36 +60,44 @@ describe DiscourseApi::API::Topics do
     end
 
     it "requests the correct resource" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       subject.topic(57)
       expect(a_get("http://localhost:3000/t/57.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topic" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       topic = subject.topic(57)
       expect(topic).to be_a Hash
       expect(topic["id"]).to eq(57)
     end
   end
 
+  describe "#update_topic" do
+    before do
+      stub_put("http://localhost:3000/t/57.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("topic.json"), headers: { content_type: "application/json" })
+    end
+
+    it "renames the topic" do
+      subject.rename_topic(57, "A new title!")
+      expect(a_put("http://localhost:3000/t/57.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "assigns the topic a new category" do
+      subject.recategorize_topic(57, 3)
+      expect(a_put("http://localhost:3000/t/57.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+  end
+
   describe "#topics_by" do
     before do
       stub_get("http://localhost:3000/topics/created-by/test.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("topics_created_by.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       subject.topics_by('test')
       expect(a_get("http://localhost:3000/topics/created-by/test.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topics" do
-      subject.api_key = 'test_d7fd0429940'
-      subject.api_username = 'test_user'
       topics = subject.topics_by('test')
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash