discourse_api 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10a7f2e9839bfeea9edbb43a4f2fe535723e237e
-  data.tar.gz: d8de8c9500231bd8ba26593e2ac7b266e4be067c
+  metadata.gz: ef1ea595c7e724545877e4a688f7f192a1f63573
+  data.tar.gz: f97ed183f55cae5b6cb01616264cabf5249bdbdb
 SHA512:
-  metadata.gz: 14b552567338b8f699eeb77efa4de86e334052989a5cdbf6007ecfde4e1a128e9d03ae1d9d9c2c5a501fe1f3da2f76572122b26472f60c462c909bbf2107aaa4
-  data.tar.gz: 61ac275015ae01fef9b9e0b6434e2c175a1f17b7dab3bd291418b53284063e7da45373affab2a741e4f74eaf4f3de6b5748c5683258307411feee37e2a8ee442
+  metadata.gz: 31b68b7b2101e74ca1dcb84c8528c129b630cdd1ff74a1c2eeadc42529562fc8dcfb5f13ed899dc94fe8513f1e4c0c314d6609fe7a1f0c3eef5436cb344b9751
+  data.tar.gz: eac6dbdd5cdecae47f0b2b4fac2a819b324437831b8aabb984db2f0b9f86efe0d4872b6a1970f67d2472665ce893ad13a09b238b60cff6c3726a7f94e31094f2

data/CHANGELOG.md

@@ -21,3 +21,10 @@
 - be able to specify SSL connection settings
 - list api keys generated
 - list backups created
+
+## 0.4.0
+
+- [FEATURE] generate an api key for a user
+- [FEATURE] revoke an api key for a user
+- [FEATURE] update user trust level
+- [FEATURE] grant user badge

data/examples/update_user.rb

@@ -13,5 +13,7 @@ puts client.update_user("batman", name: "Bruce Wayne")
 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")
+# update trust level of user whose id is "102"
+puts client.update_trust_level(user_id: 102, level: 2)
 # log out everywhere and refresh browser of user whose id is "2"
 puts client.log_out(2)

data/lib/discourse_api/api/api_admin.rb

@@ -5,6 +5,14 @@ module DiscourseApi
         response = get("/admin/api.json")
         response.body
       end
+
+      def generate_api_key(user_id)
+        response = post("/admin/users/#{user_id}/generate_api_key.json")
+      end
+
+      def revoke_api_key(user_id)
+        response = delete("/admin/users/#{user_id}/revoke_api_key.json")
+      end
     end
   end
 end

data/lib/discourse_api/api/badges.rb

@@ -10,6 +10,10 @@ module DiscourseApi
         response = get("/users/#{username}/activity/badges.json")
         response.body['badges']
       end
+
+      def grant_user_badge(params={})
+        post("/user_badges", params)
+      end
     end
   end
 end

data/lib/discourse_api/api/categories.rb

@@ -3,11 +3,11 @@ module DiscourseApi
     module Categories
       # :color and :text_color are RGB hexadecimal strings
       def create_category(args)
-        params = API.params(args)
-                 .required(:name, :color, :text_color)
-                 .optional(:description)
-                 .default(parent_category_id: nil)
-        response = (post "/categories", params)
+        args = API.params(args)
+                  .required(:name, :color, :text_color)
+                  .optional(:description)
+                  .default(parent_category_id: nil)
+        response = post("/categories", args)
         response['category']
       end
 

data/lib/discourse_api/api/groups.rb

@@ -2,11 +2,11 @@ module DiscourseApi
   module API
     module Groups
       def create_group(args)
-        params = API.params(args)
-                    .required(:name)
-                    .default(visible: true)
-                    .to_h
-        post("/admin/groups", group: params)
+        args = API.params(args)
+                  .required(:name)
+                  .default(visible: true)
+                  .to_h
+        post("/admin/groups", group: args)
       end
 
       def groups

data/lib/discourse_api/api/posts.rb

@@ -2,13 +2,15 @@ module DiscourseApi
   module API
     module Posts
       def create_post(args)
-        post("/posts", API.params(args)
-                       .required(:topic_id, :raw))
+        args = API.params(args)
+                  .required(:topic_id, :raw)
+        post("/posts", args)
       end
 
       def get_post(id, args = {})
-        response = get("/posts/#{id}.json", API.params(args)
-                                            .optional(:version))
+        args = API.params(args)
+                  .optional(:version)
+        response = get("/posts/#{id}.json", args)
         response[:body]
       end
 

data/lib/discourse_api/api/topics.rb

@@ -5,12 +5,9 @@ module DiscourseApi
       # :skip_validations OPTIONAL boolean
       # :auto_track OPTIONAL boolean
       def create_topic(args)
-
-        args =
-          API.params(args)
-            .required(:title, :raw)
-            .optional(:skip_validations, :category, :auto_track)
-
+        args = API.params(args)
+                  .required(:title, :raw)
+                  .optional(:skip_validations, :category, :auto_track)
         post("/posts", args.to_h)
       end
 

data/lib/discourse_api/api/users.rb

@@ -11,11 +11,11 @@ module DiscourseApi
       end
 
       def update_avatar(args)
-        params = API.params(args)
-                    .required(:username, :file)
-                    .default(image_type: 'avatar')
-                    .to_h
-        upload_response = post("/users/#{args[:username]}/preferences/user_image", params)
+        args = API.params(args)
+                  .required(:username, :file)
+                  .default(image_type: 'avatar')
+                  .to_h
+        upload_response = post("/users/#{args[:username]}/preferences/user_image", args)
         put("/users/#{args[:username]}/preferences/avatar/pick", { upload_id: upload_response['upload_id'] })
       end
 
@@ -31,12 +31,20 @@ module DiscourseApi
         put("/users/#{username}/preferences/username", { new_username: new_username, api_key: api_key })
       end
 
+      def update_trust_level(args)
+        args = API.params(args)
+                  .required(:user_id, :level)
+                  .to_h
+        response = put("/admin/users/#{args[:user_id]}/trust_level", args)
+        response[:body]
+      end
+
       def create_user(args)
-        params = API.params(args)
-                    .required(:name, :email, :password, :username)
-                    .optional(:active)
-                    .to_h
-        post("/users", params)
+        args = API.params(args)
+                  .required(:name, :email, :password, :username)
+                  .optional(:active)
+                  .to_h
+        post("/users", args)
       end
 
       def log_out(id)

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/spec/discourse_api/api/api_admin_spec.rb

@@ -1,16 +1,27 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::ApiAdmin do
-  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+  subject {
+    DiscourseApi::Client.new(
+      "http://localhost:3000",
+      "test_d7fd0429940",
+      "test_user"
+    )
+  }
 
   describe "#api" do
     before do
-      stub_get("http://localhost:3000/admin/api.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("api.json"), headers: { content_type: "application/json" })
+      url = "http://localhost:3000/admin/api.json?" +
+            "api_key=test_d7fd0429940&api_username=test_user"
+      stub_get(url).to_return(body: fixture("api.json"),
+                              headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.api
-      expect(a_get("http://localhost:3000/admin/api.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+      url = "http://localhost:3000/admin/api.json?" +
+            "api_key=test_d7fd0429940&api_username=test_user"
+      expect(a_get(url)).to have_been_made
     end
 
     it "returns the requested api keys" do
@@ -20,4 +31,33 @@ describe DiscourseApi::API::ApiAdmin do
       expect(api.first).to have_key('key')
     end
   end
+
+  describe "#generate_api_key" do
+    before do
+      url = "http://localhost:3000/admin/users/2/generate_api_key.json?" +
+            "api_key=test_d7fd0429940&api_username=test_user"
+      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_api_key(2)
+      expect(api_key).to be_a Hash
+      expect(api_key['api_key']).to have_key('key')
+    end
+  end
+
+  describe "#revoke_api_key" do
+    before do
+      url = "http://localhost:3000/admin/users/2/revoke_api_key.json?" +
+      "api_key=test_d7fd0429940&api_username=test_user"
+      stub_post(url).to_return(body: "",
+      headers: { content_type: "application/json" })
+    end
+
+    it "returns 200" do
+      response = subject.revoke_api_key(2)
+      expect(response['status']).to eq(200)
+    end
+  end
 end

data/spec/discourse_api/api/users_spec.rb

@@ -166,4 +166,26 @@ describe DiscourseApi::API::Users do
       expect(users.first).to be_a Hash
     end
   end
+
+  describe "#update_trust_level" do
+    before do
+      url = "http://localhost:3000/admin/users/2/trust_level?api_key=test_d7fd0429940&api_username=test_user"
+      stub_get(url).to_return(body: fixture("update_trust_level.json"),
+                              headers: { content_type: "application/json" })
+    end
+
+    it "makes the correct put request" do
+      params = { user_id: 2, level: 2 }
+      subject.update_trust_level(params)
+      url = "http://localhost:3000/admin/users/2/trust_level?api_key=test_d7fd0429940&api_username=test_user"
+      expect(a_put(url)).to have_been_made
+    end
+
+    it "updates the trust_level" do
+      params = { user_id: 2, level: 2 }
+      admin_user = subject.update_trust_level(params)
+      expect(admin_user).to be_a Hash
+      expect(admin_user['admin_user']).to have_key('trust_level')
+    end
+  end
 end

data/spec/fixtures/generate_api_key.json

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

data/spec/fixtures/update_trust_level.json

@@ -0,0 +1,37 @@
+{
+  "admin_user": {
+    "id": 2,
+    "username": "robin",
+    "uploaded_avatar_id": 3,
+    "avatar_template": "/user_avatar/localhost/robin/{size}/3.png",
+    "active": true,
+    "admin": false,
+    "moderator": false,
+    "last_seen_at": "2014-09-19T13:00:20.939Z",
+    "last_emailed_at": "2015-01-01T01:01:24.438Z",
+    "created_at": "2014-09-13T14:27:07.352Z",
+    "last_seen_age": "4mon",
+    "last_emailed_age": "13d",
+    "created_at_age": "4mon",
+    "username_lower": "robin",
+    "trust_level": 2,
+    "trust_level_locked": false,
+    "flag_level": 0,
+    "title": null,
+    "suspended_at": null,
+    "suspended_till": null,
+    "suspended": null,
+    "blocked": false,
+    "time_read": "< 1m",
+    "days_visited": 3,
+    "posts_read_count": 2,
+    "topics_entered": 2,
+    "post_count": 0,
+    "can_send_activation_email": true,
+    "can_activate": false,
+    "can_deactivate": true,
+    "ip_address": "127.0.0.1",
+    "registration_ip_address": "127.0.0.1",
+    "single_sign_on_record": null
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-11 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -249,6 +249,7 @@ files:
 - spec/fixtures/category_latest_topics.json
 - spec/fixtures/email_list_all.json
 - spec/fixtures/email_settings.json
+- spec/fixtures/generate_api_key.json
 - spec/fixtures/groups.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
@@ -260,6 +261,7 @@ files:
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topics_created_by.json
+- spec/fixtures/update_trust_level.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json
@@ -316,6 +318,7 @@ test_files:
 - spec/fixtures/category_latest_topics.json
 - spec/fixtures/email_list_all.json
 - spec/fixtures/email_settings.json
+- spec/fixtures/generate_api_key.json
 - spec/fixtures/groups.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
@@ -327,6 +330,7 @@ test_files:
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topics_created_by.json
+- spec/fixtures/update_trust_level.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json