discourse_api 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c0790579478eedc23d1ee9c2845584fc2eeb35e
-  data.tar.gz: 4fc797b4a90520a46f7ac3b64c51fb8129868149
+  metadata.gz: e774662e2101d7cc9efd59ecc530b1fd850d9aae
+  data.tar.gz: e957df497e9510660dfb359f0e2964279c069036
 SHA512:
-  metadata.gz: 2ff4ce4800eca2118a78afc0953b65fe1786b6dd0ba1889909e8054ec21e7fdb4c1006b771d149571bc73e63df1ae88ac56849d49d5e31df654945150dff1a42
-  data.tar.gz: 23a89130ee7d7976895713207a95dbec071b6108a7f3d22ef6f3d91c68388004888af27be422907b4667df40200a9af4c321f4d54e7ee20605c2053d790465ff
+  metadata.gz: 5cb7f3d6efe4850225c1ed35a2e0ff8508afa97f358e1d1b68a45f15ff37d42f70a72b23981779d3b2315f8495d2d9258848f5411cc8da14ccd3f2480d216ca2
+  data.tar.gz: 76422bb639def262ac7ab4c075f063a6bf972e950d9d098813cd7b702a113c00bde43ccd548ae343a77b7cacbaf451f0f978a05a0814b413f94718d864698e09

data/examples/create_topic.rb

@@ -12,3 +12,12 @@ client.create_topic(
   title: "Concert Master: A new way to choose",
   raw: "This is the raw markdown for my post"
 )
+
+# create Poll topic
+client.create_topic(
+  category: "general",
+  skip_validations: false,
+  auto_track: false,
+  title: "Your Favorite Color?",
+  raw: "[poll name=color]\n- Green\n- Blue\n- Red\n[/poll]"
+)

data/examples/dashboard.rb

@@ -0,0 +1,13 @@
+$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 all dashboard status as json 
+puts client.get_dashboard_stats
+
+# get hash of some dashboard total value 
+puts client.get_dashboard_stats_totals
+# sample output: {"users"=>9, "topics"=>230, "posts"=>441}

data/lib/discourse_api/api/dashboard.rb

@@ -0,0 +1,24 @@
+module DiscourseApi
+  module API
+    module Dashboard
+      def get_dashboard_stats
+        response = get("admin/dashboard.json")
+        response[:body]
+      end  
+      
+      def get_dashboard_stats_totals
+        stats = get_dashboard_stats
+        global_reports = stats['global_reports']        
+        users = global_reports[1]
+        topics = global_reports[3]
+        posts = global_reports[4]
+        
+        totals = {
+          'users'  => users['total'],
+          'topics' => topics['total'],
+          'posts'  => posts['total']
+        }
+      end
+    end
+  end
+end

data/lib/discourse_api/client.rb

@@ -17,6 +17,7 @@ require 'discourse_api/api/badges'
 require 'discourse_api/api/email'
 require 'discourse_api/api/api_key'
 require 'discourse_api/api/backups'
+require 'discourse_api/api/dashboard'
 
 module DiscourseApi
   class Client
@@ -38,6 +39,7 @@ module DiscourseApi
     include DiscourseApi::API::Email
     include DiscourseApi::API::ApiKey
     include DiscourseApi::API::Backups
+    include DiscourseApi::API::Dashboard
 
     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.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,7 @@ files:
 - examples/category.rb
 - examples/create_topic.rb
 - examples/create_user.rb
+- examples/dashboard.rb
 - examples/disposable_invite_tokens.rb
 - examples/example.rb
 - examples/groups.rb
@@ -203,6 +204,7 @@ files:
 - lib/discourse_api/api/backups.rb
 - lib/discourse_api/api/badges.rb
 - lib/discourse_api/api/categories.rb
+- lib/discourse_api/api/dashboard.rb
 - lib/discourse_api/api/email.rb
 - lib/discourse_api/api/groups.rb
 - lib/discourse_api/api/invite.rb