discourse_api 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30c8f8cfc3ece69e96755f29c5765f204d505b10
-  data.tar.gz: 80873e28b06c2912282a2a9482d579536d97e250
+  metadata.gz: 831e6a472cbcaff97004039ba2eea26f3a21fd75
+  data.tar.gz: afcaa7863e713f022e40bc5b4677d69334870800
 SHA512:
-  metadata.gz: 4fb815d8b714c4c0a90e931265b4d76a027848303c47bec066dbc79a7c3844026c4c8800b9fe88d89ffe460cf17ce97a67de9ea2dc9711e3a2f4c70f3ada1ba0
-  data.tar.gz: eba82e043e294893e8655fa8efd1b0c923657f03aa691daf8455739d0bf6b6841b5b5f10624cd8333248494eaac7fa1e40a64b7578a4963adc5746bcfb50c28f
+  metadata.gz: 60dfe37fc068b570befdd131e3ccc58f458a362e565e17b6d12371b7340abda526c3dd63c52a58d69a742ad8c10e566a5402c6945e0cf39d3013e700ba93c3d7
+  data.tar.gz: 4df138687be5cb12299ac0f66bce1b7bce60d51f086894cbc0411ee756c1d7ebea76b94bbe002079be1ed8037cda2f9ba0f5ae3a308c0524a269843f08c6fae2

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 bin/
 .ruby-gemset
 .ruby-version
+.env

data/discourse_api.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", "0.9.0"
   spec.add_dependency "faraday_middleware", "~> 0.9"
+  spec.add_dependency "rack", "~> 1.5"
+  spec.add_dependency "dotenv", "~> 1.0"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "10.3.2"
   spec.add_development_dependency "rspec", "~> 3.0"

data/examples/update_user.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
-client = DiscourseApi::Client.new("localhost", 3000)
+client = DiscourseApi::Client.new("http://localhost:3000")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
@@ -13,3 +13,5 @@ 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")
+# log out everywhere and refresh browser of user whose id is "2"
+puts client.log_out_and_refresh_browser(2)

data/lib/discourse_api/api/categories.rb

@@ -1,6 +1,15 @@
 module DiscourseApi
   module API
     module Categories
+      # :color and :text_color are RGB hexadecimal strings
+      def create_category(name:, color:, text_color:, parent_category_id: nil)
+        post("/categories",
+             name: name,
+             color: color,
+             text_color: text_color,
+             parent_category_id: parent_category_id)
+      end
+
       def categories(*args)
         response = get('/categories.json', args)
         response[:body]['category_list']['categories']

data/lib/discourse_api/api/groups.rb

@@ -0,0 +1,14 @@
+module DiscourseApi
+  module API
+    module Groups
+      def create_group(name:, visible: false)
+        post("/admin/groups", group: {name: name, visible: visible.to_s})
+      end
+
+      def groups
+        response = get("/admin/groups")
+        response.body
+      end
+    end
+  end
+end

data/lib/discourse_api/api/posts.rb

@@ -0,0 +1,9 @@
+module DiscourseApi
+  module API
+    module Posts
+      def create_post(topic_id:, raw:)
+        post("/posts", topic_id: topic_id, raw: raw)
+      end
+    end
+  end
+end

data/lib/discourse_api/api/topics.rb

@@ -1,8 +1,16 @@
 module DiscourseApi
   module API
     module Topics
-      def create_topic(params={})
-        post("/posts", params)
+      # :category OPTIONAL name of category, not ID
+      # :skip_validations OPTIONAL boolean
+      # :auto_track OPTIONAL boolean
+      def create_topic(title:, raw:, category: nil, skip_validations: nil, auto_track: nil)
+        post("/posts",
+             title: title,
+             raw: raw,
+             category: category,
+             skip_validations: skip_validations,
+             auto_track: auto_track)
       end
 
       def latest_topics(*args)

data/lib/discourse_api/api/users.rb

@@ -36,6 +36,10 @@ module DiscourseApi
         # POST the args
         post("/users", args)
       end
+
+      def log_out_and_refresh_browser(id)
+        post("/admin/users/#{id}/log_out_and_refresh_browser")
+      end
     end
   end
 end

data/lib/discourse_api/client.rb

@@ -1,3 +1,4 @@
+require 'dotenv'
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
@@ -6,7 +7,9 @@ require 'discourse_api/api/categories'
 require 'discourse_api/api/search'
 require 'discourse_api/api/sso'
 require 'discourse_api/api/topics'
+require 'discourse_api/api/posts'
 require 'discourse_api/api/users'
+require 'discourse_api/api/groups'
 require 'discourse_api/api/invite'
 require 'discourse_api/api/private_messages'
 require 'discourse_api/api/notifications'
@@ -20,12 +23,17 @@ module DiscourseApi
     include DiscourseApi::API::Search
     include DiscourseApi::API::SSO
     include DiscourseApi::API::Topics
+    include DiscourseApi::API::Posts
     include DiscourseApi::API::Users
+    include DiscourseApi::API::Groups
     include DiscourseApi::API::Invite
     include DiscourseApi::API::PrivateMessages
     include DiscourseApi::API::Notifications
 
-    def initialize(host, api_key=nil, api_username=nil)
+    def initialize(host = ENV["DISCOURSE_URL"],
+                   api_key = ENV["DISCOURSE_API_KEY"],
+                   api_username = ENV["DISCOURSE_USERNAME"])
+      raise ArgumentError, 'host needs to be defined' if host.nil? || host.empty?
       @host         = host
       @api_key      = api_key
       @api_username = api_username
@@ -50,7 +58,13 @@ module DiscourseApi
     end
 
     def post(path, params={})
-      request(:post, path, params)
+      response = request(:post, path, params)
+      case response.status
+      when 200
+        response.body
+      else
+        raise ApiError, response.body
+      end
     end
 
     def put(path, params={})
@@ -86,4 +100,6 @@ module DiscourseApi
       raise DiscourseApi::Error
     end
   end
+
+  class ApiError < Exception; end
 end

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/topics_spec.rb

@@ -15,7 +15,8 @@ describe DiscourseApi::API::Topics do
 
     it "returns success" do
       response = subject.invite_user_to_topic(email: "fake_user@example.com", topic_id: 12)
-      expect(response[:body]['success']).to be_truthy
+      expect(response).to be_a Hash
+      expect(response['success']).to be_truthy
     end
   end
 

data/spec/discourse_api/api/users_spec.rb

@@ -92,7 +92,8 @@ describe DiscourseApi::API::Users do
 
     it "returns success" do
       response = subject.create_user :name => "Test User", :email => "test2@example.com", :password => "P@ssword", :username => "test2"
-      expect(response[:body]['success']).to be_truthy
+      expect(response).to be_a Hash
+      expect(response['success']).to be_truthy
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,6 +40,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -179,8 +207,10 @@ files:
 - examples/update_user.rb
 - lib/discourse_api.rb
 - lib/discourse_api/api/categories.rb
+- lib/discourse_api/api/groups.rb
 - lib/discourse_api/api/invite.rb
 - lib/discourse_api/api/notifications.rb
+- lib/discourse_api/api/posts.rb
 - lib/discourse_api/api/private_messages.rb
 - lib/discourse_api/api/search.rb
 - lib/discourse_api/api/sso.rb