discourse_api 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8bfbf08cac232e8db407b3c443cf5c0a231b203
-  data.tar.gz: 2d738a394e1bfafbc019055380adc1a865878e2d
+  metadata.gz: eac07223361b0ddc7428468198b3a764d602560a
+  data.tar.gz: be2c419474dd915e32a76eca7f7c5d1757ea761c
 SHA512:
-  metadata.gz: e16cbaa04e7bc0976b85e7c56445d252ea166c724215349f4cef2389536e16b3f204dda6d4823f08d389e4e4c363b87ebc3c9b70d11924cb7c3da36a9a3935d0
-  data.tar.gz: 9365bb0c6b7a48f744ac89bca8389def7655b1d74e10715488547298c1306f6c85da1f01394c16fdc969bd775f2c1d399821fced83a598d23a777167a4950223
+  metadata.gz: cc02e2ac5803e71f44f505071e8ea6564f2c606db45c2a6253464efd43d980d864b643b402a3d96b0922e1991d74a44495bfcb529c97e3ef66e3b22d23787d73
+  data.tar.gz: 5656c1a6228a091101c92536829fc40472807595e701f26b8ed3a8e810f1671d42f4587c5d2c8def889c4e34b7b4e32a2202af2fc77817976161f9e0315393dc

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 2.0.0
+  - 2.1
+  - 2.2
 script: 'bundle exec rake test'

data/CHANGELOG.md

@@ -28,3 +28,7 @@
 - [FEATURE] revoke an api key for a user
 - [FEATURE] update user trust level
 - [FEATURE] grant user badge
+
+## 0.5.0
+
+- [FEATURE] get latest category topics by page

data/examples/category.rb

@@ -10,3 +10,12 @@ puts client.categories()
 
 # get sub categories for parent category with id 2
 puts client.categories(parent_category_id: 2)
+
+# List topics in a category
+category_topics = client.category_latest_topics(category_slug: "test-category")
+puts category_topics
+
+# List topics in a category paged
+category_topics_paged = client.category_latest_topics(category_slug: "test-category", page: "5")
+puts category_topics_paged
+

data/examples/groups.rb

@@ -1,7 +1,9 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
-client = DiscourseApi::Client.new
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
 
 response = client.create_group(name: "engineering_team")
 group_id = response["basic_group"]["id"]
@@ -14,3 +16,5 @@ client.group_add(group_id, user_ids: [123, 456])
 
 client.group_remove(group_id, username: "neil")
 client.group_remove(group_id, user_id: 123)
+
+client.delete_group(group_id)

data/examples/search.rb

@@ -0,0 +1,9 @@
+$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"
+
+# search for term
+puts client.search("discourse")

data/examples/update_user.rb

@@ -12,8 +12,11 @@ puts client.update_user("batman", name: "Bruce Wayne")
 # update email of user whose username is "batman"
 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")
+puts client.update_avatar(username: "batman", url: "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)
+# update user bio, location or website
+puts client.update_user("batman", bio_raw: "I am Batman.", location: "Gotham", website: "https://en.wikipedia.org/wiki/Batman")
+
 # log out everywhere and refresh browser of user whose id is "2"
 puts client.log_out(2)

data/lib/discourse_api/api/badges.rb

@@ -14,6 +14,15 @@ module DiscourseApi
       def grant_user_badge(params={})
         post("/user_badges", params)
       end
+
+      def create_badge(params={})
+        args = API.params(params)
+                  .required(:name, :badge_type_id)
+                  .optional(:description, :allow_title, :multiple_grant, :icon, :listable,
+                            :target_posts, :query, :enabled, :auto_revoke, :badge_grouping_id,
+                            :trigger, :show_posts, :image, :long_description)
+        post("/admin/badges.json", args)
+      end
     end
   end
 end

data/lib/discourse_api/api/categories.rb

@@ -2,10 +2,12 @@ module DiscourseApi
   module API
     module Categories
       # :color and :text_color are RGB hexadecimal strings
-      def create_category(args)
+      # :permissions is a hash with the group name and permission_type which is
+      # an integer 1 = Full 2 = Create Post 3 = Read Only
+      def create_category(args={})
         args = API.params(args)
                   .required(:name, :color, :text_color)
-                  .optional(:description)
+                  .optional(:description, :permissions)
                   .default(parent_category_id: nil)
         response = post("/categories", args)
         response['category']
@@ -16,8 +18,16 @@ module DiscourseApi
         response[:body]['category_list']['categories']
       end
 
-      def category_latest_topics(category_slug)
-        response = get("/category/#{category_slug}/l/latest.json")
+      def category_latest_topics(args={})
+        params = API.params(args)
+                    .required(:category_slug)
+                    .optional(:page).to_h
+        url = "/c/#{params[:category_slug]}/l/latest.json"
+        if params.include?(:page)
+          puts params[:page]
+          url = "#{url}?page=#{params[:page]}"
+        end 
+        response = get(url)
         response[:body]['topic_list']['topics']
       end
 

data/lib/discourse_api/api/groups.rb

@@ -34,6 +34,10 @@ module DiscourseApi
       def group_remove(group_id, user)
         delete("/admin/groups/#{group_id}/members.json", user)
       end
+
+      def delete_group(group_id)
+        delete("/admin/groups/#{group_id}.json")
+      end
     end
   end
 end

data/lib/discourse_api/api/params.rb

@@ -6,6 +6,7 @@ module DiscourseApi
 
     class Params
       def initialize(args)
+        raise ArgumentError.new("Required to be initialized with a Hash") unless args.is_a? Hash
         @args = args
         @required = []
         @optional = []

data/lib/discourse_api/api/topics.rb

@@ -4,7 +4,7 @@ module DiscourseApi
       # :category OPTIONAL name of category, not ID
       # :skip_validations OPTIONAL boolean
       # :auto_track OPTIONAL boolean
-      def create_topic(args)
+      def create_topic(args={})
         args = API.params(args)
                   .required(:title, :raw)
                   .optional(:skip_validations, :category, :auto_track)

data/lib/discourse_api/api/users.rb

@@ -17,11 +17,12 @@ module DiscourseApi
 
       def update_avatar(args)
         args = API.params(args)
-                  .required(:username, :file)
-                  .default(image_type: 'avatar')
+                  .required(:username)
+                  .optional(:file, :url)
+                  .default(type: 'avatar', synchronous: true)
                   .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'] })
+        upload_response = post("/uploads", args)
+        put("/users/#{args[:username]}/preferences/avatar/pick", { upload_id: upload_response['id'] })
       end
 
       def update_email(username, email)

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

data/spec/discourse_api/api/categories_spec.rb

@@ -5,7 +5,8 @@ describe DiscourseApi::API::Categories do
 
   describe "#categories" do
     before do
-      stub_get("http://localhost:3000/categories.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/categories.json?api_key=test_d7fd0429940&api_username=test_user")
+        .to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
@@ -28,11 +29,12 @@ describe DiscourseApi::API::Categories do
 
   describe '#category_latest_topics' do
     before do
-      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" })
+      stub_get("http://localhost:3000/c/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
-      latest_topics = subject.category_latest_topics('category-slug')
+      latest_topics = subject.category_latest_topics(category_slug: 'category-slug')
       expect(latest_topics).to be_an Array
     end
   end
@@ -66,4 +68,20 @@ describe DiscourseApi::API::Categories do
       expect(topics).to be_an Array
     end
   end
+
+  describe '#category_new_category' do
+    before do
+      stub_post("http://localhost:3000/categories?api_key=test_d7fd0429940&api_username=test_user")
+      subject.create_category(name: "test_category", color: "283890", text_color: "FFFFFF",
+                              description: "This is a description",
+                              permissions: {"group_1" => 1, "admins" => 1})
+    end
+    
+    it "makes a create category request" do
+      expect(a_post("http://localhost:3000/categories?api_key=test_d7fd0429940&api_username=test_user").with(body: 
+          "color=283890&description=This+is+a+description&name=test_category&parent_category_id&permissions%5Badmins%5D=1&permissions%5Bgroup_1%5D=1&text_color=FFFFFF")
+        ).to have_been_made
+    end
+  end  
+
 end

data/spec/discourse_api/api/users_spec.rb

@@ -26,13 +26,13 @@ describe DiscourseApi::API::Users do
 
   describe "#update_avatar" do
     before do
-      stub_post("http://localhost:3000/users/test_user/preferences/user_image?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("user_update_avatar_success.json"), headers: { content_type: "application/json" })
+      stub_post("http://localhost:3000/uploads?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("upload_avatar.json"), headers: { content_type: "application/json" })
       stub_put("http://localhost:3000/users/test_user/preferences/avatar/pick?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("user_update_avatar_success.json"), headers: { content_type: "application/json" })
     end
 
     it "uploads an image" do
       sam = "https://meta-discourse.global.ssl.fastly.net/user_avatar/meta.discourse.org/sam/120/5243.png"
-      args = { username: 'test_user', file: sam }
+      args = { username: 'test_user', url: sam }
       response = subject.update_avatar(args)
       expect(response[:body]['success']).to eq('OK')
     end

data/spec/fixtures/upload_avatar.json

@@ -0,0 +1,14 @@
+{
+  "id": 11,
+  "user_id": 1,
+  "original_filename": "avatar.jpg",
+  "filesize": 86900,
+  "width": 360,
+  "height": 360,
+  "url": "/uploads/default/original/1X/417e624d2453925e6c68748b9aa67637c284b5aa.jpg",
+  "created_at": "2015-06-21T12:35:45.182Z",
+  "updated_at": "2015-06-21T12:35:45.195Z",
+  "sha1": "417e624d2453925e6c68748b9aa67637c284b5aa",
+  "origin": null,
+  "retain_hours": null
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -192,6 +192,7 @@ files:
 - examples/example.rb
 - examples/groups.rb
 - examples/invite_users.rb
+- examples/search.rb
 - examples/sso.rb
 - examples/topic_lists.rb
 - examples/update_user.rb
@@ -255,6 +256,7 @@ files:
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
+- spec/fixtures/upload_avatar.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json
@@ -286,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Allows access to the Discourse API
@@ -329,6 +331,7 @@ test_files:
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
+- spec/fixtures/upload_avatar.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json