discourse_api 0.3.0 → 0.3.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Mjg1NDk2YjJiNTdlYmVhYmMwMDZjNTc3NjIxN2EwZWJjYmMyMmVhZQ==
-  data.tar.gz: !binary |-
-    NDkwMWZjYTQ0MzkwZDY3ODNkMjdlNjFkOTZiMTUzOTMzMmQ5YzIyMQ==
+SHA1:
+  metadata.gz: 10a7f2e9839bfeea9edbb43a4f2fe535723e237e
+  data.tar.gz: d8de8c9500231bd8ba26593e2ac7b266e4be067c
 SHA512:
-  metadata.gz: !binary |-
-    NzJmZjQ1ZTA0MzA4MThmMzE3YWFhOWI5MDYyYmVjM2E5ZTE0Yjg3ZjI2ZDA3
-    MDllNzlkNmJkNjA5MjEzMzY1MDg5MTNlM2E1YWQxNTU1YmMxMzE0MjRlNTQz
-    YjdkZTNlMzEwYjQ3OTk2MzRhZjQ0ZWRmN2JlZWQ5YzBiMjc1NjE=
-  data.tar.gz: !binary |-
-    NmFhYzQyYTAwYjdjMzRiNzgxYmQ3OWM4NzE5MWVlOTkzZmFlNWQxYzI2NzBi
-    ZWY3ODNlODZmNzFjNGY1ZmZlN2I1NDY0MDBhODUzYjJiOTBiOTA0NGFhYjE2
-    ZWJjMDdiZTU4NWU4ODliOGQ4NWRiMjdiZmQ4Y2M3NGYwYjk3NjA=
+  metadata.gz: 14b552567338b8f699eeb77efa4de86e334052989a5cdbf6007ecfde4e1a128e9d03ae1d9d9c2c5a501fe1f3da2f76572122b26472f60c462c909bbf2107aaa4
+  data.tar.gz: 61ac275015ae01fef9b9e0b6434e2c175a1f17b7dab3bd291418b53284063e7da45373affab2a741e4f74eaf4f3de6b5748c5683258307411feee37e2a8ee442

data/CHANGELOG.md

@@ -2,8 +2,22 @@
 
 ## master
 
-* Added `client.category_latest_posts("category-slug")` endpoint
+- Added `client.category_latest_posts("category-slug")` endpoint
 
 ## 0.1.2
 
-* Release
+- Release
+
+## 0.3.5
+
+- Can now get a list of users by type: active, new, staff, etc.
+
+## 0.3.6
+
+- list badges
+- view email settings
+- list emails sent
+- list badges by user
+- be able to specify SSL connection settings
+- list api keys generated
+- list backups created

data/README.md

@@ -32,6 +32,8 @@ client = DiscourseApi::Client.new("http://try.discourse.org")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
+client.ssl(...)                                 #=> specify SSL connection settings if needed
+
 # Topic endpoints
 client.latest_topics                            #=> Gets a list of the latest topics
 client.hot_topics                               #=> Gets a list of hot topics

data/examples/category.rb

@@ -0,0 +1,12 @@
+$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"
+
+# get categories
+puts client.categories()
+
+# get sub categories for parent category with id 2
+puts client.categories(parent_category_id: 2)

data/lib/discourse_api/api/api_admin.rb

@@ -0,0 +1,10 @@
+module DiscourseApi
+  module API
+    module ApiAdmin
+      def api
+        response = get("/admin/api.json")
+        response.body
+      end
+    end
+  end
+end

data/lib/discourse_api/api/backups.rb

@@ -0,0 +1,10 @@
+module DiscourseApi
+  module API
+    module Backups
+      def backups
+        response = get("/admin/backups.json")
+        response.body
+      end
+    end
+  end
+end

data/lib/discourse_api/api/badges.rb

@@ -0,0 +1,15 @@
+module DiscourseApi
+  module API
+    module Badges
+      def badges
+        response = get("/admin/badges.json")
+        response.body
+      end
+
+      def user_badges(username)
+        response = get("/users/#{username}/activity/badges.json")
+        response.body['badges']
+      end
+    end
+  end
+end

data/lib/discourse_api/api/categories.rb

@@ -3,15 +3,16 @@ module DiscourseApi
     module Categories
       # :color and :text_color are RGB hexadecimal strings
       def create_category(args)
-        post("/categories", API.params(args)
-                               .required(:name)
-                               .optional(:color, :text_color)
-                               .default(parent_category_id: nil)
-            )
+        params = API.params(args)
+                 .required(:name, :color, :text_color)
+                 .optional(:description)
+                 .default(parent_category_id: nil)
+        response = (post "/categories", params)
+        response['category']
       end
 
-      def categories(*args)
-        response = get('/categories.json', args)
+      def categories(params={})
+        response = get('/categories.json', params)
         response[:body]['category_list']['categories']
       end
 
@@ -19,6 +20,11 @@ module DiscourseApi
         response = get("/category/#{category_slug}/l/latest.json")
         response[:body]['topic_list']['topics']
       end
+
+      def category(id)
+        response = get("/c/#{id}/show")
+        response.body['category']
+      end
     end
   end
 end

data/lib/discourse_api/api/email.rb

@@ -0,0 +1,15 @@
+module DiscourseApi
+  module API
+    module Email
+      def email_settings
+        response = get("/admin/email.json")
+        response.body
+      end
+
+      def list_email(filter)
+        response = get("/admin/email/#{filter}.json")
+        response.body
+      end
+    end
+  end
+end

data/lib/discourse_api/api/groups.rb

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

data/lib/discourse_api/api/params.rb

@@ -42,7 +42,7 @@ module DiscourseApi
             @args.dup
           else
             @optional.each do |k|
-              h[k] = @args[k]
+              h[k] = @args[k] if @args.include?(k)
             end
             h
           end

data/lib/discourse_api/api/posts.rb

@@ -3,7 +3,21 @@ module DiscourseApi
     module Posts
       def create_post(args)
         post("/posts", API.params(args)
-                          .required(:topic_id, :raw))
+                       .required(:topic_id, :raw))
+      end
+
+      def get_post(id, args = {})
+        response = get("/posts/#{id}.json", API.params(args)
+                                            .optional(:version))
+        response[:body]
+      end
+
+      def wikify_post(id)
+        put("/posts/#{id}/wiki", wiki: true)
+      end
+
+      def edit_post(id, raw)
+        put("/posts/#{id}", post: {raw: raw})
       end
     end
   end

data/lib/discourse_api/api/topics.rb

@@ -14,13 +14,13 @@ module DiscourseApi
         post("/posts", args.to_h)
       end
 
-      def latest_topics(*args)
-        response = get('/latest.json', args)
+      def latest_topics(params={})
+        response = get('/latest.json', params)
         response[:body]['topic_list']['topics']
       end
 
-      def new_topics(*args)
-        response = get("/new.json", args)
+      def new_topics(params={})
+        response = get("/new.json", params)
         response[:body]['topic_list']['topics']
       end
 
@@ -32,13 +32,13 @@ module DiscourseApi
         put("/t/#{topic_id}.json", { topic_id: topic_id, category_id: category_id })
       end
 
-      def topic(id, *args)
-        response = get("/t/#{id}.json", args)
+      def topic(id, params={})
+        response = get("/t/#{id}.json", params)
         response[:body]
       end
 
-      def topics_by(username, *args)
-        response = get("/topics/created-by/#{username}.json", args)
+      def topics_by(username, params={})
+        response = get("/topics/created-by/#{username}.json", params)
         response[:body]['topic_list']['topics']
       end
 

data/lib/discourse_api/api/users.rb

@@ -5,13 +5,18 @@ module DiscourseApi
         put "/admin/users/#{id}/activate", api_key: api_key, api_username: api_username
       end
 
-      def user(username, *args)
-        response = get("/users/#{username}.json", args)
+      def user(username, params={})
+        response = get("/users/#{username}.json", params)
         response[:body]['user']
       end
 
-      def update_avatar(username, file)
-        put("/users/#{username}/preferences/avatar", { file: file, api_key: api_key })
+      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)
+        put("/users/#{args[:username]}/preferences/avatar/pick", { upload_id: upload_response['upload_id'] })
       end
 
       def update_email(username, email)
@@ -26,16 +31,12 @@ module DiscourseApi
         put("/users/#{username}/preferences/username", { new_username: new_username, api_key: api_key })
       end
 
-      # 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
-
-        # POST the args
-        post("/users", args)
+      def create_user(args)
+        params = API.params(args)
+                    .required(:name, :email, :password, :username)
+                    .optional(:active)
+                    .to_h
+        post("/users", params)
       end
 
       def log_out(id)
@@ -45,6 +46,11 @@ module DiscourseApi
       def invite_admin(args={})
         post("/admin/users/invite_admin", args)
       end
+
+      def list_users(type)
+        response = get("admin/users/list/#{type}.json")
+        response[:body]
+      end
     end
   end
 end

data/lib/discourse_api/client.rb

@@ -13,6 +13,10 @@ require 'discourse_api/api/groups'
 require 'discourse_api/api/invite'
 require 'discourse_api/api/private_messages'
 require 'discourse_api/api/notifications'
+require 'discourse_api/api/badges'
+require 'discourse_api/api/email'
+require 'discourse_api/api/api_admin'
+require 'discourse_api/api/backups'
 
 module DiscourseApi
   class Client
@@ -29,6 +33,10 @@ module DiscourseApi
     include DiscourseApi::API::Invite
     include DiscourseApi::API::PrivateMessages
     include DiscourseApi::API::Notifications
+    include DiscourseApi::API::Badges
+    include DiscourseApi::API::Email
+    include DiscourseApi::API::ApiAdmin
+    include DiscourseApi::API::Backups
 
     def initialize(host = ENV["DISCOURSE_URL"],
                    api_key = ENV["DISCOURSE_API_KEY"],
@@ -41,14 +49,18 @@ module DiscourseApi
 
     def connection_options
       @connection_options ||= {
-          url: @host,
-          headers: {
-              accept: 'application/json',
-              user_agent: user_agent,
-          }
+        url: @host,
+        headers: {
+          accept: 'application/json',
+          user_agent: user_agent,
+        }
       }
     end
 
+    def ssl(options)
+      connection_options[:ssl] = options
+    end
+
     def delete(path, params={})
       request(:delete, path, params)
     end

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/api_admin_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::ApiAdmin do
+  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" })
+    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
+    end
+
+    it "returns the requested api keys" do
+      api = subject.api
+      expect(api).to be_an Array
+      expect(api.first).to be_a Hash
+      expect(api.first).to have_key('key')
+    end
+  end
+end

data/spec/discourse_api/api/backups_spec.rb

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

data/spec/discourse_api/api/badges_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::Badges do
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+
+  describe "#badges" do
+    before do
+      stub_get("http://localhost:3000/admin/badges.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("badges.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.badges
+      expect(a_get("http://localhost:3000/admin/badges.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns the requested badges" do
+      badges = subject.badges
+      expect(badges).to be_a Hash
+      expect(badges['badges']).to be_an Array
+    end
+  end
+
+  describe "#user_badges" do
+    before do
+      stub_get("http://localhost:3000/users/test_user/activity/badges.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("user_badges.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.user_badges('test_user')
+      expect(a_get("http://localhost:3000/users/test_user/activity/badges.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
+    end
+
+    it "returns the requested user badges" do
+      badges = subject.user_badges('test_user')
+      expect(badges).to be_an Array
+      expect(badges.first).to be_a Hash
+      expect(badges.first).to have_key('badge_type_id')
+    end
+  end
+end