discourse_api 0.45.0 → 0.45.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82cd748487d5d986f8327b702088ea4ea22c43cae311c2634dfa5d9cf4c4059f
-  data.tar.gz: a4fd68101134895f5071443f221a2327e9fe9e4a0a79df0d53a620c7e08d685d
+  metadata.gz: 10c80ce6388205a855042bd1093627508e4929c6bf79902487549568af7304b0
+  data.tar.gz: 4aab3d70ba9343f6717a4e4ffce233b015565904129fd4b1244e7bdac64ef565
 SHA512:
-  metadata.gz: 42546f17e134cd1e4ac6be81c8fdb53cf82461d60a73859dd757c2ec69e1128127f33a131e45dfec3d910012702256a173a7a1afd2a9873dc3d8a3e220c4af1a
-  data.tar.gz: 990fc89fd2a4935704e1512b858872b41ed7a6b7ba3ef28f583ad272e0675daff74f61b9a441632a8dc92c76892b8c507e53afce356317403c7c67f31a4fab18
+  metadata.gz: b37002fd695ca45872ba4b2ca09161173050f70692c8f051df737dd87370cb06c5103b51d5691807041ffbac9a0a9a1713fd74f406da192eeb8e29b41460c90a
+  data.tar.gz: 13163d2718c324780cb081aaca1e63f865e9b503bc008f4d1fbcb1145b6f3175e6621f6dbbaff14a30f8d730d9800ab6af8e3e1caee93b8baed8682d275f4b68

data/.github/workflows/ci.yml

@@ -5,8 +5,7 @@ on:
   push:
     branches:
       - master
-    tags:
-      - v*
+      - main
 
 jobs:
   build:
@@ -18,30 +17,25 @@ jobs:
           - 2.5
           - 2.6
           - 2.7
+          - 3.0
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
       - name: Setup ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
-
-      - name: Setup bundler
-        run: gem install bundler
-
-      - name: Setup gems
-        run: bundle install
+          bundler-cache: true
 
-      - name: Rubocop
+      - name: Lint
         run: bundle exec rubocop
 
-      - name: RSpec
-        run: bundle exec rspec
+      - name: Tests
+        run: bundle exec rake test
 
   publish:
-    if: contains(github.ref, 'refs/tags/v')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
     needs: build
     runs-on: ubuntu-latest
 
@@ -49,6 +43,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Release Gem
-        uses: CvX/publish-rubygems-action@master
+        uses: discourse/publish-rubygems-action@v2-beta
         env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.gitignore

@@ -1,22 +1,3 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-bin/
-.ruby-gemset
-.ruby-version
-.env
 /config.yml

data/discourse_api.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', '~> 1.0'
-  spec.add_dependency 'faraday_middleware', '~> 1.0'
-  spec.add_dependency 'rack', '>= 1.6'
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.0'
+  spec.add_runtime_dependency 'rack', '>= 1.6'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'guard', '~> 2.14'
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'simplecov', '~> 0.11'
   spec.add_development_dependency 'webmock', '~> 3.0'
-  spec.add_development_dependency 'rubocop-discourse'
+  spec.add_development_dependency 'rubocop-discourse', '~> 2.4.1'
 
   spec.required_ruby_version = '>= 2.5.0'
 end

data/examples/category.rb

@@ -14,6 +14,9 @@ puts client.categories()
 # get sub categories for parent category with id 2
 puts client.categories(parent_category_id: 2)
 
+# get the full categories response
+puts client.categories_full()
+
 # List topics in a category
 category_topics = client.category_latest_topics(category_slug: "test-category")
 puts category_topics

data/examples/notifications.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require File.expand_path('../../lib/discourse_api', __FILE__)
+
+config = DiscourseApi::ExampleHelper.load_yml
+
+client = DiscourseApi::Client.new(config['host'] || 'http://localhost:3000')
+client.api_key = config['api_key'] || "YOUR_API_KEY"
+client.api_username = config['api_username'] || "YOUR_USERNAME"
+
+# watch an entire category
+client.category_set_user_notification_level(1, notification_level: 3)
+
+# mute a topic
+client.topic_set_user_notification_level(1, notification_level: 0)

data/examples/topic_lists.rb

@@ -11,6 +11,9 @@ client.api_username = config['api_username'] || "YOUR_USERNAME"
 # get latest topics
 puts client.latest_topics({})
 
+# get top topics
+puts client.top_topics
+
 # recategorize topic
 puts client.recategorize_topic(topic_id: 108, category_id: 5)
 

data/lib/discourse_api/api/categories.rb

@@ -36,11 +36,24 @@ module DiscourseApi
       end
 
       def categories(params = {})
+        categories_full(params)['category_list']['categories']
+      end
+
+      def categories_full(params = {})
         response = get('/categories.json', params)
-        response[:body]['category_list']['categories']
+        response[:body]
       end
 
       def category_latest_topics(args = {})
+        response = category_latest_topics_full(args)
+        if response['errors']
+          response['errors']
+        else
+          response['topic_list']['topics']
+        end
+      end
+
+      def category_latest_topics_full(args = {})
         params = API.params(args)
           .required(:category_slug)
           .optional(:page).to_h
@@ -49,25 +62,31 @@ module DiscourseApi
           url = "#{url}?page=#{params[:page]}"
         end
         response = get(url)
-        if response[:body]['errors']
-          response[:body]['errors']
-        else
-          response[:body]['topic_list']['topics']
-        end
+        response[:body]
       end
 
       def category_top_topics(category_slug)
-        response = get("/c/#{category_slug}/l/top.json")
-        if response[:body]['errors']
-          response[:body]['errors']
+        response = category_top_topics_full(category_slug)
+        if response['errors']
+          response['errors']
         else
-          response[:body]['topic_list']['topics']
+          response['topic_list']['topics']
         end
       end
 
+      def category_top_topics_full(category_slug)
+        response = get("/c/#{category_slug}/l/top.json")
+        response[:body]
+      end
+
       def category_new_topics(category_slug)
+        response = category_new_topics_full(category_slug)
+        response['topic_list']['topics']
+      end
+
+      def category_new_topics_full(category_slug)
         response = get("/c/#{category_slug}/l/new.json")
-        response[:body]['topic_list']['topics']
+        response[:body]
       end
 
       def category(id)
@@ -75,12 +94,19 @@ module DiscourseApi
         response[:body]['category']
       end
 
+      # TODO: Deprecated. Remove after 20210727
       def category_set_user_notification(args = {})
         category_id = args[:id]
         args = API.params(args)
           .required(:notification_level)
         post("/category/#{category_id}/notifications", args)
       end
+
+      def category_set_user_notification_level(category_id, params)
+        params = API.params(params)
+          .required(:notification_level)
+        post("/category/#{category_id}/notifications", params)
+      end
     end
   end
 end

data/lib/discourse_api/api/search.rb

@@ -12,7 +12,7 @@ module DiscourseApi
         raise ArgumentError.new("#{term} is required but not specified") unless term
         raise ArgumentError.new("#{term} is required but not specified") unless !term.empty?
 
-        response = get('/search/query', options.merge(term: term))
+        response = get('/search', options.merge(q: term))
         response[:body]
       end
     end

data/lib/discourse_api/api/topics.rb

@@ -29,6 +29,11 @@ module DiscourseApi
         response[:body]['topic_list']['topics']
       end
 
+      def top_topics(params = {})
+        response = get("/top.json", params)
+        response[:body]['topic_list']['topics']
+      end
+
       def new_topics(params = {})
         response = get("/new.json", params)
         response[:body]['topic_list']['topics']
@@ -85,6 +90,12 @@ module DiscourseApi
 
         post("/t/#{topic_id}/change-owner.json", params)
       end
+
+      def topic_set_user_notification_level(topic_id, params)
+        params = API.params(params)
+          .required(:notification_level)
+        post("/t/#{topic_id}/notifications", params)
+      end
     end
   end
 end

data/lib/discourse_api/version.rb

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

data/spec/discourse_api/api/categories_spec.rb

@@ -28,6 +28,25 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe "#categories_full" do
+    before do
+      stub_get("#{host}/categories.json")
+        .to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.categories
+      expect(a_get("#{host}/categories.json")).to have_been_made
+    end
+
+    it "returns the entire categories response" do
+      categories = subject.categories_full
+      expect(categories).to be_a Hash
+      expect(categories).to have_key 'category_list'
+      expect(categories).to have_key 'featured_users'
+    end
+  end
+
   describe '#category_latest_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/latest.json")
@@ -40,6 +59,20 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_latest_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/latest.json")
+        .to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
+    end
+
+    it "returns the entire latest topics in a category response" do
+      latest_topics = subject.category_latest_topics_full(category_slug: 'category-slug')
+      expect(latest_topics).to be_a Hash
+      expect(latest_topics).to have_key 'topic_list'
+      expect(latest_topics).to have_key 'users'
+    end
+  end
+
   describe '#category_top_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/top.json")
@@ -55,6 +88,23 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_top_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/top.json")
+        .to_return(
+        body: fixture("category_topics.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "returns the entire top topics in a category response" do
+      topics = subject.category_top_topics_full('category-slug')
+      expect(topics).to be_a Hash
+      expect(topics).to have_key 'topic_list'
+      expect(topics).to have_key 'users'
+    end
+  end
+
   describe '#category_new_topics' do
     before do
       stub_get("#{host}/c/category-slug/l/new.json")
@@ -70,6 +120,23 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe '#category_new_topics_full' do
+    before do
+      stub_get("#{host}/c/category-slug/l/new.json")
+        .to_return(
+        body: fixture("category_topics.json"),
+        headers: { content_type: "application/json" }
+      )
+    end
+
+    it "returns the new topics in a category" do
+      topics = subject.category_new_topics_full('category-slug')
+      expect(topics).to be_a Hash
+      expect(topics).to have_key 'topic_list'
+      expect(topics).to have_key 'users'
+    end
+  end
+
   describe '#category_new_category' do
     before do
       stub_post("#{host}/categories")
@@ -85,4 +152,27 @@ describe DiscourseApi::API::Categories do
     end
   end
 
+  describe "#category_set_user_notification" do
+    before do
+      stub_post("#{host}/category/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.category_set_user_notification(id: 1, notification_level: 3)
+      expect(a_post("#{host}/category/1/notifications")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
+
+  describe "#category_set_user_notification_level" do
+    before do
+      stub_post("#{host}/category/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.category_set_user_notification_level(1, notification_level: 3)
+      expect(a_post("#{host}/category/1/notifications").with(body: "notification_level=3")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
 end

data/spec/discourse_api/api/search_spec.rb

@@ -6,12 +6,12 @@ describe DiscourseApi::API::Search do
 
   describe "#search" do
     before do
-      stub_get("#{host}/search/query").with(query: { term: "test" }).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
+      stub_get("#{host}/search").with(query: { q: "test" }).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
       subject.search("test")
-      expect(a_get("#{host}/search/query").with(query: { term: "test" })).to have_been_made
+      expect(a_get("#{host}/search").with(query: { q: "test" })).to have_been_made
     end
 
     it "returns the requested search" do

data/spec/discourse_api/api/topics_spec.rb

@@ -55,6 +55,29 @@ describe DiscourseApi::API::Topics do
     end
   end
 
+  describe "#top_topics" do
+    before do
+      stub_get("#{host}/top.json").to_return(body: fixture("top.json"), headers: { content_type: "application/json" })
+    end
+
+    it "requests the correct resource" do
+      subject.top_topics
+      expect(a_get("#{host}/top.json")).to have_been_made
+    end
+
+    it "returns the requested topics" do
+      topics = subject.top_topics
+      expect(topics).to be_an Array
+      expect(topics.first).to be_a Hash
+    end
+
+    it "can take a hash param" do
+      topics = subject.top_topics({})
+      expect(topics).to be_an Array
+      expect(topics.first).to be_a Hash
+    end
+  end
+
   describe "#new_topics" do
     before do
       stub_get("#{host}/new.json").to_return(body: fixture("new.json"), headers: { content_type: "application/json" })
@@ -166,4 +189,15 @@ describe DiscourseApi::API::Topics do
     end
   end
 
+  describe "#topic_set_user_notification_level" do
+    before do
+      stub_post("#{host}/t/1/notifications").to_return(body: fixture("notification_success.json"), headers: { content_type: "application/json" })
+    end
+
+    it "makes the post request" do
+      response = subject.topic_set_user_notification_level(1, notification_level: 3)
+      expect(a_post("#{host}/t/1/notifications").with(body: "notification_level=3")).to have_been_made
+      expect(response['success']).to eq('OK')
+    end
+  end
 end

data/spec/fixtures/notification_success.json

@@ -0,0 +1,3 @@
+{
+  "success": "OK"
+}

data/spec/fixtures/top.json

@@ -0,0 +1,108 @@
+{
+  "topic_list": {
+    "can_create_topic": false,
+    "more_topics_url": "/latest.json?page=1",
+    "draft": null,
+    "draft_key": "new_topic",
+    "draft_sequence": null,
+    "topics": [
+      {
+        "id": 1,
+        "title": "Test topic #1",
+        "fancy_title": "Test topic #1",
+        "slug": "test-topic-1",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 1,
+        "image_url": null,
+        "created_at": "2013-02-04T15:26:25.977-05:00",
+        "last_posted_at": "2013-02-05T12:14:17.364-05:00",
+        "bumped": true,
+        "bumped_at": "2013-02-07T13:43:11.191-05:00",
+        "unseen": false,
+        "pinned": true,
+        "excerpt": "Welcome! \n\nTry is a sandbox, a safe place to play with Discourse and its features.\n\nThis site is reset every day (or even more often). Any accounts or posts you create here will not exist tomorrow! \n\nFeel free to experim…",
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 268,
+        "like_count": 14,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "title": "Test topic #2",
+        "fancy_title": "Test topic #2",
+        "slug": "test-topic-1",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 2,
+        "image_url": null,
+        "created_at": "2013-11-06T13:57:47.984-05:00",
+        "last_posted_at": "2013-11-06T13:57:48.111-05:00",
+        "bumped": true,
+        "bumped_at": "2013-11-06T13:57:48.111-05:00",
+        "unseen": false,
+        "pinned": false,
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 1,
+        "like_count": 0,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "title": "Test topic #3",
+        "fancy_title": "Test topic #3",
+        "slug": "test-topic-3",
+        "posts_count": 1,
+        "reply_count": 0,
+        "highest_post_number": 1,
+        "image_url": null,
+        "created_at": "2013-02-04T21:46:58.194-05:00",
+        "last_posted_at": "2013-11-06T13:56:27.753-05:00",
+        "bumped": true,
+        "bumped_at": "2013-11-06T13:56:27.753-05:00",
+        "unseen": false,
+        "pinned": false,
+        "visible": true,
+        "closed": false,
+        "archived": false,
+        "views": 82,
+        "like_count": 10,
+        "has_best_of": false,
+        "archetype": "regular",
+        "last_poster_username": "test_user",
+        "category_id": 1,
+        "posters": [
+          {
+            "extras": null,
+            "description": "Original Poster, Most Recent Poster",
+            "user_id": 1
+          }
+        ]
+      }
+    ]
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.45.1
 platform: ruby
 authors:
 - Sam Saffron
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -171,16 +171,16 @@ dependencies:
   name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.1
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -217,6 +217,7 @@ files:
 - examples/groups.rb
 - examples/invite_users.rb
 - examples/manage_api_keys.rb
+- examples/notifications.rb
 - examples/polls.rb
 - examples/post_action.rb
 - examples/search.rb
@@ -290,6 +291,7 @@ files:
 - spec/fixtures/members_1.json
 - spec/fixtures/members_2.json
 - spec/fixtures/new.json
+- spec/fixtures/notification_success.json
 - spec/fixtures/notifications.json
 - spec/fixtures/polls_toggle_status.json
 - spec/fixtures/polls_vote.json
@@ -303,6 +305,7 @@ files:
 - spec/fixtures/replies.json
 - spec/fixtures/replies_and_topics.json
 - spec/fixtures/search.json
+- spec/fixtures/top.json
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topic_posts.json
@@ -341,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Allows access to the Discourse API
@@ -384,6 +387,7 @@ test_files:
 - spec/fixtures/members_1.json
 - spec/fixtures/members_2.json
 - spec/fixtures/new.json
+- spec/fixtures/notification_success.json
 - spec/fixtures/notifications.json
 - spec/fixtures/polls_toggle_status.json
 - spec/fixtures/polls_vote.json
@@ -397,6 +401,7 @@ test_files:
 - spec/fixtures/replies.json
 - spec/fixtures/replies_and_topics.json
 - spec/fixtures/search.json
+- spec/fixtures/top.json
 - spec/fixtures/topic.json
 - spec/fixtures/topic_invite_user.json
 - spec/fixtures/topic_posts.json