discourse_api 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd0f97c2f0145c221f69cb373249f6a86f676452
-  data.tar.gz: 79f6fc05d914c6c166ac982dcb91d9975894b70d
+  metadata.gz: b5e090466c70d88bfb066f1c386941a3ef8dfef2
+  data.tar.gz: 5f0d7f3b8ce464254a7d60dcab7f0cf5278da843
 SHA512:
-  metadata.gz: 93dac12e3814440fc9a76d6deebdbacee7fd11b7a17532863db640982024cf2d498e00c649d6d6d0c1901bc29b181daa2821b5ba8e3fe5a67202b1e4aa3102e6
-  data.tar.gz: ca30cadbaa7677528a6c8f6771417a85e42c7c24bd619c48afe57283536c1657df0f391b1ae2f0cdf9c754189b5b77a3a73c29ca2017edebed0b1df7ac98e78d
+  metadata.gz: de5bfc7a37df4f79cce7c1ccc357f47e9e7f6335f723b1577ef3743d19e55b503d8c6ccbdfd8beec9989ae31f86dd1d7396df6b2ad21b455a4f3403c65517d10
+  data.tar.gz: 3a2020987363559ec2bd44080716d4bfe526c81d169cfeeb8ce467f80c83576bed655f6cbe9866c57f8aac93c4373465f5a9d8932636a8c6c5d677599a04aa86

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.13.0] - 2016-10-09
+### Added
+- added `update_category`
+- added `upload_post_image`
+
 ## [0.12.0] - 2016-10-06
 ### Added
 - add endpoint for `/admin/users/{id}/suspend`

data/examples/create_update_category.rb

@@ -0,0 +1,38 @@
+$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 = DiscourseApi::Client.new("http://localhost:8080")
+client.api_key = "a56a349e1870529d8d8da11453ea782ce8ab8de34d6564a65727171163be4338"
+client.api_username = "system"
+
+###
+# Required category params:
+#   :name, :color, :text_color
+# Optional category params:
+#   :slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
+#   :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template
+###
+
+
+# Create category
+new_category = client.create_category(
+    name: "Test Category",
+    color: "AB9364",
+    text_color: "FFFFFF"
+)
+puts 'Created category: ' + new_category.to_s
+
+# Update category
+response = client.update_category(
+    id: new_category['id'],
+    name: "The Best Test Category",
+    slug: "the-best-test-category",
+    color: "0E76BD",
+    text_color: "000000"
+)
+puts 'Updated category: ' + response.to_s

data/examples/upload.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"
+
+# Upload an image via file
+client.upload_post_image(file: 'grumpy_cat.gif')
+
+# Upload an image via URL
+client.upload_post_image(url: 'https://giphy.com/grumpy_cat.gif')

data/lib/discourse_api/api/categories.rb

@@ -13,6 +13,17 @@ module DiscourseApi
         response['category']
       end
 
+      def update_category(args={})
+        category_id = args[:id]
+        args = API.params(args)
+                   .required(:id, :name, :color, :text_color)
+                   .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
+                             :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template)
+                   .default(parent_category_id: nil)
+        response = put("/categories/#{category_id}", args)
+        response['body']['category'] if response['body']
+      end
+
       def categories(params={})
         response = get('/categories.json', params)
         response[:body]['category_list']['categories']
@@ -25,7 +36,7 @@ module DiscourseApi
         url = "/c/#{params[:category_slug]}/l/latest.json"
         if params.include?(:page)
           url = "#{url}?page=#{params[:page]}"
-        end 
+        end
         response = get(url)
         if response[:body]['errors']
           response[:body]['errors']

data/lib/discourse_api/api/topics.rb

@@ -68,9 +68,9 @@ module DiscourseApi
           url << '?'
           post_ids.each do |id|
             url << "post_ids[]=#{id}&"
-          end 
+          end
         end
-        response = get(url) 
+        response = get(url)
         response[:body]
       end
     end

data/lib/discourse_api/api/uploads.rb

@@ -0,0 +1,13 @@
+module DiscourseApi
+  module API
+    module Uploads
+      def upload_post_image(args)
+        args = API.params(args)
+                  .optional(:file, :url)
+                  .default(type: 'composer', synchronous: true)
+                  .to_h
+        post('/uploads', args)
+      end
+    end
+  end
+end

data/lib/discourse_api/api/users.rb

@@ -2,7 +2,7 @@ module DiscourseApi
   module API
     module Users
       def activate(id)
-        put "/admin/users/#{id}/activate", api_key: api_key, api_username: api_username
+        put("/admin/users/#{id}/activate")
       end
 
       def user(username, params={})

data/lib/discourse_api/client.rb

@@ -18,6 +18,7 @@ require 'discourse_api/api/email'
 require 'discourse_api/api/api_key'
 require 'discourse_api/api/backups'
 require 'discourse_api/api/dashboard'
+require 'discourse_api/api/uploads'
 
 module DiscourseApi
   class Client
@@ -40,6 +41,7 @@ module DiscourseApi
     include DiscourseApi::API::ApiKey
     include DiscourseApi::API::Backups
     include DiscourseApi::API::Dashboard
+    include DiscourseApi::API::Uploads
 
     def initialize(host, api_key = nil, api_username = nil)
       raise ArgumentError, 'host needs to be defined' if host.nil? || host.empty?

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/spec/discourse_api/api/uploads_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::Uploads do
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user") }
+
+  describe "#upload_post_image" do
+    before do
+      stub_post("http://localhost:3000/uploads?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("upload_post_image.json"), headers: { content_type: "application/json" })
+    end
+
+    it "uploads an image via URL" do
+      image = "https://meta-discourse.global.ssl.fastly.net/user_avatar/meta.discourse.org/sam/120/5243.png"
+      args = { url: image }
+      response = subject.upload_post_image(args)
+      expect(response["url"]).to eq("/uploads/default/original/1X/417e624d2453925e6c68748b9aa67637c284b5aa.jpg")
+    end
+  end
+end

data/spec/discourse_api/api/users_spec.rb

@@ -197,7 +197,7 @@ describe DiscourseApi::API::Users do
     end
 
     it "makes the correct put request" do
-      result = subject.grant_admin(11)
+      subject.grant_admin(11)
       url = "http://localhost:3000/admin/users/11/grant_admin?api_key=test_d7fd0429940&api_username=test_user"
       expect(a_put(url)).to have_been_made
     end

data/spec/fixtures/upload_post_image.json

@@ -0,0 +1,14 @@
+{
+  "id": 11,
+  "user_id": 1,
+  "original_filename": "grumpy_cat.gif",
+  "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.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,7 @@ files:
 - examples/category.rb
 - examples/change_topic_status.rb
 - examples/create_topic.rb
+- examples/create_update_category.rb
 - examples/create_user.rb
 - examples/dashboard.rb
 - examples/disposable_invite_tokens.rb
@@ -201,6 +202,7 @@ files:
 - examples/sso.rb
 - examples/topic_lists.rb
 - examples/update_user.rb
+- examples/upload.rb
 - lib/discourse_api.rb
 - lib/discourse_api/api/api_key.rb
 - lib/discourse_api/api/backups.rb
@@ -218,6 +220,7 @@ files:
 - lib/discourse_api/api/sso.rb
 - lib/discourse_api/api/tags.rb
 - lib/discourse_api/api/topics.rb
+- lib/discourse_api/api/uploads.rb
 - lib/discourse_api/api/users.rb
 - lib/discourse_api/client.rb
 - lib/discourse_api/error.rb
@@ -237,6 +240,7 @@ files:
 - spec/discourse_api/api/search_spec.rb
 - spec/discourse_api/api/sso_spec.rb
 - spec/discourse_api/api/topics_spec.rb
+- spec/discourse_api/api/uploads_spec.rb
 - spec/discourse_api/api/users_spec.rb
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/api.json
@@ -266,6 +270,7 @@ files:
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
 - spec/fixtures/upload_avatar.json
+- spec/fixtures/upload_post_image.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json
@@ -315,6 +320,7 @@ test_files:
 - spec/discourse_api/api/search_spec.rb
 - spec/discourse_api/api/sso_spec.rb
 - spec/discourse_api/api/topics_spec.rb
+- spec/discourse_api/api/uploads_spec.rb
 - spec/discourse_api/api/users_spec.rb
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/api.json
@@ -344,6 +350,7 @@ test_files:
 - spec/fixtures/topics_created_by.json
 - spec/fixtures/update_trust_level.json
 - spec/fixtures/upload_avatar.json
+- spec/fixtures/upload_post_image.json
 - spec/fixtures/user.json
 - spec/fixtures/user_activate_success.json
 - spec/fixtures/user_badges.json