discourse_api 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 831e6a472cbcaff97004039ba2eea26f3a21fd75
-  data.tar.gz: afcaa7863e713f022e40bc5b4677d69334870800
+  metadata.gz: 1f21e1da09f27385b726a7a6da00b6fd67a73bdb
+  data.tar.gz: b637a2ef55860b8024718f0b74453b1a1ff71f8d
 SHA512:
-  metadata.gz: 60dfe37fc068b570befdd131e3ccc58f458a362e565e17b6d12371b7340abda526c3dd63c52a58d69a742ad8c10e566a5402c6945e0cf39d3013e700ba93c3d7
-  data.tar.gz: 4df138687be5cb12299ac0f66bce1b7bce60d51f086894cbc0411ee756c1d7ebea76b94bbe002079be1ed8037cda2f9ba0f5ae3a308c0524a269843f08c6fae2
+  metadata.gz: 425557b85eb7f8b55607297b10b1ff2429004ba0b3de9956c983b273661a9a16f24a17574d2157b0abe2ba162f131a5288233d062584b213f1d86969bdc14c77
+  data.tar.gz: a0bec4403e81185fe7a990c0bf585e30f02381283bd567bda29ad9b79b26bb633bce7ffd5a79e2e7d935e82137e6e05aaf9b790a3d9d52548aeed342e564faac

data/examples/groups.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+Dotenv.load
+client = DiscourseApi::Client.new
+
+response = client.create_group(name: "engineering_team")
+group_id = response["basic_group"]["id"]
+
+client.group_add(group_id, "sam")
+client.group_add(group_id, "jeff")
+client.group_add(group_id, "neil")
+
+client.group_remove(group_id, "neil")

data/examples/update_user.rb

@@ -14,4 +14,4 @@ puts client.update_email("batman", "batman@gotham.com")
 # update avatar of user whose username is "batman"
 puts client.update_avatar("batman", "http://meta-discourse.r.worldssl.net/uploads/default/2497/724a6ef2e79d2bc7.png")
 # log out everywhere and refresh browser of user whose id is "2"
-puts client.log_out_and_refresh_browser(2)
+puts client.log_out(2)

data/lib/discourse_api/api/groups.rb

@@ -1,14 +1,22 @@
 module DiscourseApi
   module API
     module Groups
-      def create_group(name:, visible: false)
+      def create_group(name:, visible: true)
         post("/admin/groups", group: {name: name, visible: visible.to_s})
       end
 
       def groups
-        response = get("/admin/groups")
+        response = get("/admin/groups.json")
         response.body
       end
+
+      def group_add(group_id, *usernames)
+        patch("/admin/groups/#{group_id}", changes: {add: usernames})
+      end
+
+      def group_remove(group_id, *usernames)
+        patch("/admin/groups/#{group_id}", changes: {delete: usernames})
+      end
     end
   end
 end

data/lib/discourse_api/api/users.rb

@@ -29,6 +29,7 @@ module DiscourseApi
       # Create a user
       def create_user(args={})
         # First retrieve the honeypot values
+        # TODO, none of this should be needed via API
         response = get("/users/hp.json")
         args[:password_confirmation] = response[:body]['value']
         args[:challenge] = response[:body]['challenge'].reverse
@@ -37,8 +38,12 @@ module DiscourseApi
         post("/users", args)
       end
 
-      def log_out_and_refresh_browser(id)
-        post("/admin/users/#{id}/log_out_and_refresh_browser")
+      def log_out(id)
+        post("/admin/users/#{id}/log_out")
+      end
+
+      def invite_admin(args={})
+        post("/admin/users/invite_admin", args)
       end
     end
   end

data/lib/discourse_api/client.rb

@@ -71,6 +71,10 @@ module DiscourseApi
       request(:put, path, params)
     end
 
+    def patch(path, params={})
+      request(:patch, path, params)
+    end
+
     def user_agent
       @user_agent ||= "DiscourseAPI Ruby Gem #{DiscourseApi::VERSION}"
     end

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.2.5"
+  VERSION = "0.2.7"
 end

data/spec/discourse_api/api/groups_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::Groups do
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+
+  describe "#groups" do
+    before do
+      stub_get("http://localhost:3000/admin/groups.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("groups.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.groups
+      expect(a_get("http://localhost:3000/admin/groups.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns the requested groups" do
+      groups = subject.groups
+      expect(groups).to be_an Array
+      groups.each { |g| expect(g).to be_a Hash }
+    end
+
+    it "create new groups" do
+      stub_post("http://localhost:3000/admin/groups?api_key=test_d7fd0429940&api_username=test_user")
+      subject.create_group(name: "test_group")
+      expect(a_post("http://localhost:3000/admin/groups?api_key=test_d7fd0429940&api_username=test_user").
+              with(body: {group: {name: "test_group", visible: "true"}})
+            ).to have_been_made
+    end
+
+    it "adds members" do
+      stub_request(:patch, "http://localhost:3000/admin/groups/123?api_key=test_d7fd0429940&api_username=test_user")
+      subject.group_add(123, "sam")
+      expect(a_request(:patch, "http://localhost:3000/admin/groups/123?api_key=test_d7fd0429940&api_username=test_user").
+              with(body: {changes: {add: [ "sam" ]}})
+            ).to have_been_made
+    end
+
+    it "removes members" do
+      stub_request(:patch, "http://localhost:3000/admin/groups/123?api_key=test_d7fd0429940&api_username=test_user")
+      subject.group_remove(123, "sam")
+      expect(a_request(:patch, "http://localhost:3000/admin/groups/123?api_key=test_d7fd0429940&api_username=test_user").
+              with(body: {changes: {delete: [ "sam" ]}})
+            ).to have_been_made
+    end
+  end
+end

data/spec/fixtures/groups.json

@@ -0,0 +1,18 @@
+[
+    {
+        "id": 101,
+        "name": "group_1",
+        "user_count": 17,
+        "automatic": false,
+        "alias_level": 0,
+        "visible": true
+    },
+    {
+        "id": 102,
+        "name": "group_2",
+        "user_count": 4,
+        "automatic": false,
+        "alias_level": 0,
+        "visible": true
+    }
+]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -201,6 +201,7 @@ files:
 - examples/create_topic.rb
 - examples/disposable_invite_tokens.rb
 - examples/example.rb
+- examples/groups.rb
 - examples/invite_users.rb
 - examples/sso.rb
 - examples/topic_lists.rb
@@ -222,6 +223,7 @@ files:
 - lib/single_sign_on.rb
 - routes.txt
 - spec/discourse_api/api/categories_spec.rb
+- spec/discourse_api/api/groups_spec.rb
 - spec/discourse_api/api/notifications_spec.rb
 - spec/discourse_api/api/private_messages_spec.rb
 - spec/discourse_api/api/search_spec.rb
@@ -230,6 +232,7 @@ files:
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/categories.json
 - spec/fixtures/category_latest_topics.json
+- spec/fixtures/groups.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
 - spec/fixtures/new.json
@@ -270,6 +273,7 @@ specification_version: 4
 summary: Allows access to the Discourse API
 test_files:
 - spec/discourse_api/api/categories_spec.rb
+- spec/discourse_api/api/groups_spec.rb
 - spec/discourse_api/api/notifications_spec.rb
 - spec/discourse_api/api/private_messages_spec.rb
 - spec/discourse_api/api/search_spec.rb
@@ -278,6 +282,7 @@ test_files:
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/categories.json
 - spec/fixtures/category_latest_topics.json
+- spec/fixtures/groups.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
 - spec/fixtures/new.json