discourse_api 0.35.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c528dfd53262df7af997ea5f9da09b4ea423e9425dc98d18c944af293f15ef94
-  data.tar.gz: e0df934c4e39a5eed50f080bf6d02be0aec29aa3b21ddd21875782ad456867eb
+  metadata.gz: 5f10d2acddddb15742c1a996952b9fabffade3d803a57bc8fd4a418891d491ad
+  data.tar.gz: a16816326aa5d4adf54262b8a043de73703e0437d76bc19216f7c09b4b22bc87
 SHA512:
-  metadata.gz: bf4d4859413e6c923bd0c0162b13997133536e6d9d176ba8220364ed7cdbb58962e3a4ce27940bc5c5d96bd2e39fe601accc27fe813eabd1aabb209913351fe4
-  data.tar.gz: 46117b013a50ccc7fc3e6bd7f1fa4f117b1166cb846e34f76821db62ef66eeb4d7a87b21cbc6273494bcece664c1b6520639c016b430b0a47d970556df8b9ea9
+  metadata.gz: 4810cfb72e3eeca6828759ba8ddd6480767626f24ef8831bb8ff164ed68a4f295117042f4a072813ff2305cd3bc2a88427a6cdb9b5acfad64307bcd2b5ba4699
+  data.tar.gz: a3f9a96b2b7ef9c4f37257f0e17cbac2fa9f86d67062808cdb2f55807349512b3d7ca6b968a83ac6912b833a4871d9f664f701967a06fc30422de7dd186553bb

data/CHANGELOG.md

@@ -2,7 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.35.0] - 2019-04-02
+## [0.36.0] - 2019-07-18
+### Added
+- Added poll methods
+### Fixed
+- Updated create topic example
+- Fixed capialization for header auth keys
+
+## [0.35.0] - 2019-05-15
 ### Added
 - Added `custom_fields` param to create/update category
 - Added `frozen_string_literal: true` to all the files

data/examples/change_topic_status.rb

@@ -7,7 +7,7 @@ client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
 response = client.create_topic(
-    category: "Boing Boing",
+    category: 1,
     skip_validations: true,
     auto_track: false,
     title: "Concert Master: A new way to choose",

data/examples/create_topic.rb

@@ -7,7 +7,7 @@ client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
 client.create_topic(
-  category: "Boing Boing",
+  category: 1,
   skip_validations: true,
   auto_track: false,
   title: "Concert Master: A new way to choose",
@@ -16,7 +16,7 @@ client.create_topic(
 
 # create Poll topic
 client.create_topic(
-  category: "general",
+  category: 2,
   skip_validations: false,
   auto_track: false,
   title: "Your Favorite Color?",

data/examples/polls.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+$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"
+
+options = ['8b4736b1ae3dfb5a28088530f036f9e5']
+poll_option_votes = client.poll_vote post_id: 5, poll_name: 'poll', options: options
+puts poll_option_votes.body['vote']
+
+poll_option_votes = client.toggle_poll_status(post_id: 5, poll_name: 'poll', status: 'closed')
+puts poll_option_votes[:body]['poll']['status']
+
+poll_option_votes = client.poll_voters(post_id: 5, poll_name: 'poll')
+puts poll_option_votes['voters']

data/lib/discourse_api/api/polls.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DiscourseApi
+  module API
+    module Polls
+      def poll_vote(args)
+        args = API.params(args)
+          .required(:post_id, :poll_name, :options)
+          .optional(:created_at)
+        put("/polls/vote", args)
+      end
+
+      def toggle_poll_status(args)
+        args = API.params(args)
+          .required(:post_id, :poll_name, :status)
+          .optional(:api_username)
+          .optional(:raise_errors)
+            put("/polls/toggle_status", args)
+      end
+
+      def poll_voters(args)
+        args = API.params(args)
+          .required(:post_id, :poll_name)
+          .optional(:opts)
+        response = get("/polls/voters.json", args)
+        response[:body]
+      end
+
+    end
+  end
+end

data/lib/discourse_api/client.rb

@@ -9,6 +9,7 @@ require 'discourse_api/api/search'
 require 'discourse_api/api/sso'
 require 'discourse_api/api/tags'
 require 'discourse_api/api/topics'
+require 'discourse_api/api/polls'
 require 'discourse_api/api/posts'
 require 'discourse_api/api/users'
 require 'discourse_api/api/groups'
@@ -34,6 +35,7 @@ module DiscourseApi
     include DiscourseApi::API::SSO
     include DiscourseApi::API::Tags
     include DiscourseApi::API::Topics
+    include DiscourseApi::API::Polls
     include DiscourseApi::API::Posts
     include DiscourseApi::API::Users
     include DiscourseApi::API::Groups
@@ -59,7 +61,7 @@ module DiscourseApi
 
     def api_username=(api_username)
       @api_username = api_username
-      @connection.headers['Api-username'] = api_username unless @connection.nil?
+      @connection.headers['Api-Username'] = api_username unless @connection.nil?
     end
 
     def connection_options
@@ -118,12 +120,14 @@ module DiscourseApi
         conn.request :url_encoded
         # Parse responses as JSON
         conn.use FaradayMiddleware::ParseJson, content_type: 'application/json'
+        # For HTTP debugging, uncomment
+        # conn.response :logger
         # Use Faraday's default HTTP adapter
         conn.adapter Faraday.default_adapter
         #pass api_key and api_username on every request
         unless api_username.nil?
-          conn.headers['Api-key'] = api_key
-          conn.headers['Api-username'] = api_username
+          conn.headers['Api-Key'] = api_key
+          conn.headers['Api-Username'] = api_username
         end
       end
     end

data/lib/discourse_api/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DiscourseApi
-  VERSION = "0.35.0"
+  VERSION = "0.36.0"
 end

data/spec/discourse_api/api/polls_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe DiscourseApi::API::Polls do
+  subject { DiscourseApi::Client.new("http://localhost:3000", "test_d7fd0429940", "test_user" )}
+
+  describe "#poll vote" do
+    before do
+      path = "http://localhost:3000/polls/vote"
+      stub_put(path)
+          .to_return(body: fixture("polls_vote.json"), headers: { content_type: "application/json" })
+    
+    end
+
+    it "requests the correct resource" do
+      options = ['8b4736b1ae3dfb5a28088530f036f9e5']
+      subject.poll_vote post_id: 5, poll_name: 'poll', options: options
+      expect(a_put("http://localhost:3000/polls/vote")).to have_been_made
+    end
+
+    it "returns the expected votes" do
+      options = ['8b4736b1ae3dfb5a28088530f036f9e5']
+      vote = subject.poll_vote post_id: 5, poll_name: 'poll', options: options
+      expect(vote.body).to be_a Hash
+      expect(vote.body['poll']['options']).to be_an Array
+      expect(vote.body['vote']).to eq(['8b4736b1ae3dfb5a28088530f036f9e5'])
+    end
+
+  describe "#poll toggle_status" do
+    before do
+      path = "http://localhost:3000/polls/toggle_status"
+      stub_put(path)
+          .to_return(body: fixture("polls_toggle_status.json"), headers: { content_type: "application/json" })
+
+    end
+
+    it "toggles the poll status to closed" do
+      subject.toggle_poll_status post_id: 5, poll_name: 'poll', status: 'closed'
+      expect(a_put("http://localhost:3000/polls/toggle_status")).to have_been_made
+    end
+
+    it "returns the expected results of closed poll" do
+      returned_poll_status = subject.toggle_poll_status post_id: 5, poll_name: 'poll', status: 'closed'
+      expect(returned_poll_status.body).to be_a Hash
+      returned_poll_status.body['poll']['options'].each { |g| expect(g).to be_a Hash }
+    end
+
+  end
+
+  describe "#poll voters" do
+    before do
+      stub_get("http://localhost:3000/polls/voters.json?post_id=5&poll_name=poll")
+          .to_return(body: fixture("polls_voters.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.poll_voters post_id: 5, poll_name: 'poll'
+      expect(a_get("http://localhost:3000/polls/voters.json?post_id=5&poll_name=poll")).to have_been_made
+    end
+
+    it "returns the expected votes" do
+      voters = subject.poll_voters post_id: 5, poll_name: 'poll'
+      expect(voters).to be_a Hash
+      voters.each { |g| expect(g).to be_an Array }
+      expect(voters['voters']['e539a9df8700d0d05c69356a07b768cf']).to be_an Array
+      expect(voters['voters']['e539a9df8700d0d05c69356a07b768cf'][0]['id']).to eq(356)
+    end
+   end
+
+  end
+end

data/spec/fixtures/polls_toggle_status.json

@@ -0,0 +1,54 @@
+{
+  "poll": {
+    "name": "poll",
+    "type": "regular",
+    "status": "closed",
+    "public": true,
+    "results": "always",
+    "options": [
+      {
+        "id": "8b4736b1ae3dfb5a28088530f036f9e5",
+        "html": "I will attend the Apr 25, 2019 Launchpad meeting.",
+        "votes": 1
+      },
+      {
+        "id": "e09884fbf9b72d83e804050078847643",
+        "html": "I want to lead the meeting.",
+        "votes": 0
+      },
+      {
+        "id": "e539a9df8700d0d05c69356a07b768cf",
+        "html": "I’ll not attend this meeting.",
+        "votes": 2
+      }
+    ],
+    "voters": 3,
+    "preloaded_voters": {
+      "8b4736b1ae3dfb5a28088530f036f9e5": [
+        {
+          "id": 17,
+          "username": "Kim_Miller",
+          "name": "Kim Miller",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/user_one/{size}/3220_2.png",
+          "title": "New Owners Council"
+        }
+      ],
+      "e539a9df8700d0d05c69356a07b768cf": [
+        {
+          "id": 356,
+          "username": "David_Ashby",
+          "name": "David Ashby",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/user_two/{size}/2403_2.png",
+          "title": "Team Agape"
+        },
+        {
+          "id": 72,
+          "username": "David_Kirk",
+          "name": "David Kirk",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/user_three/{size}/236_2.png",
+          "title": "Foundry"
+        }
+      ]
+    }
+  }
+}

data/spec/fixtures/polls_vote.json

@@ -0,0 +1,64 @@
+{
+  "poll": {
+    "name": "poll",
+    "type": "regular",
+    "status": "open",
+    "public": true,
+    "results": "always",
+    "options": [
+      {
+        "id": "8b4736b1ae3dfb5a28088530f036f9e5",
+        "html": "I will attend the Apr 25, 2019 Launchpad meeting.",
+        "votes": 2
+      },
+      {
+        "id": "e09884fbf9b72d83e804050078847643",
+        "html": "I want to lead the meeting.",
+        "votes": 0
+      },
+      {
+        "id": "e539a9df8700d0d05c69356a07b768cf",
+        "html": "I’ll not attend this meeting.",
+        "votes": 2
+      }
+    ],
+    "voters": 4,
+    "preloaded_voters": {
+      "8b4736b1ae3dfb5a28088530f036f9e5": [
+        {
+          "id": 17,
+          "username": "Kim_Miller",
+          "name": "Kim Miller",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/kim_miller/{size}/3220_2.png",
+          "title": "New Owners Council"
+        },
+        {
+          "id": 150,
+          "username": "KM_Admin",
+          "name": "Kim Miller",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/km_admin/{size}/1232_2.png",
+          "title": "Admin"
+        }
+      ],
+      "e539a9df8700d0d05c69356a07b768cf": [
+        {
+          "id": 356,
+          "username": "David_Ashby",
+          "name": "David Ashby",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/david_ashby/{size}/2403_2.png",
+          "title": "Team Agape"
+        },
+        {
+          "id": 72,
+          "username": "David_Kirk",
+          "name": "David Kirk",
+          "avatar_template": "/user_avatar/discourse.gomomentum.org/david_kirk/{size}/236_2.png",
+          "title": "Foundry"
+        }
+      ]
+    }
+  },
+  "vote": [
+    "8b4736b1ae3dfb5a28088530f036f9e5"
+  ]
+}

data/spec/fixtures/polls_voters.json

@@ -0,0 +1,20 @@
+{
+  "voters": {
+    "e539a9df8700d0d05c69356a07b768cf": [
+      {
+        "id": 356,
+        "username": "David_Ashby",
+        "name": "David Ashby",
+        "avatar_template": "/user_avatar/discourse.gomomentum.org/david_ashby/{size}/2403_2.png",
+        "title": "Team Agape"
+      },
+      {
+        "id": 72,
+        "username": "David_Kirk",
+        "name": "David Kirk",
+        "avatar_template": "/user_avatar/discourse.gomomentum.org/david_kirk/{size}/236_2.png",
+        "title": "Foundry"
+      }
+    ]
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.35.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-15 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -215,6 +215,7 @@ files:
 - examples/group_set_user_notification_level.rb
 - examples/groups.rb
 - examples/invite_users.rb
+- examples/polls.rb
 - examples/post_action.rb
 - examples/search.rb
 - examples/sent_private_messages.rb
@@ -233,6 +234,7 @@ files:
 - lib/discourse_api/api/invite.rb
 - lib/discourse_api/api/notifications.rb
 - lib/discourse_api/api/params.rb
+- lib/discourse_api/api/polls.rb
 - lib/discourse_api/api/posts.rb
 - lib/discourse_api/api/private_messages.rb
 - lib/discourse_api/api/search.rb
@@ -255,6 +257,7 @@ files:
 - spec/discourse_api/api/groups_spec.rb
 - spec/discourse_api/api/notifications_spec.rb
 - spec/discourse_api/api/params_spec.rb
+- spec/discourse_api/api/polls_spec.rb
 - spec/discourse_api/api/posts_spec.rb
 - spec/discourse_api/api/private_messages_spec.rb
 - spec/discourse_api/api/search_spec.rb
@@ -284,6 +287,9 @@ files:
 - spec/fixtures/members_1.json
 - spec/fixtures/new.json
 - spec/fixtures/notifications.json
+- spec/fixtures/polls_toggle_status.json
+- spec/fixtures/polls_vote.json
+- spec/fixtures/polls_voters.json
 - spec/fixtures/post.json
 - spec/fixtures/post_action_users.json
 - spec/fixtures/private_messages.json
@@ -340,6 +346,7 @@ test_files:
 - spec/discourse_api/api/groups_spec.rb
 - spec/discourse_api/api/notifications_spec.rb
 - spec/discourse_api/api/params_spec.rb
+- spec/discourse_api/api/polls_spec.rb
 - spec/discourse_api/api/posts_spec.rb
 - spec/discourse_api/api/private_messages_spec.rb
 - spec/discourse_api/api/search_spec.rb
@@ -369,6 +376,9 @@ test_files:
 - spec/fixtures/members_1.json
 - spec/fixtures/new.json
 - spec/fixtures/notifications.json
+- spec/fixtures/polls_toggle_status.json
+- spec/fixtures/polls_vote.json
+- spec/fixtures/polls_voters.json
 - spec/fixtures/post.json
 - spec/fixtures/post_action_users.json
 - spec/fixtures/private_messages.json