discourse_api 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b96cb437020181b21b8ee3d42e65483029431aaa
-  data.tar.gz: e78ccede0ae62ae085a66b704a5f89d2299a6236
+  metadata.gz: dd0f97c2f0145c221f69cb373249f6a86f676452
+  data.tar.gz: 79f6fc05d914c6c166ac982dcb91d9975894b70d
 SHA512:
-  metadata.gz: 4eff3f9a2d5ebdb95776dde3d3b64eba61699ea73d4a467ac8be6a6994dae5bfae8bc097769ec0f4b5b8804921e7db656b685173d15c3b10ecc6943af16a22d9
-  data.tar.gz: 9582bf8fc7278050d8638d288904c5ab922ae1eef85850aef1086853b0f721d57b662aca741b025970aef96bd2935c1e0759dee6bf713acfbdb35b6a61a3b62c
+  metadata.gz: 93dac12e3814440fc9a76d6deebdbacee7fd11b7a17532863db640982024cf2d498e00c649d6d6d0c1901bc29b181daa2821b5ba8e3fe5a67202b1e4aa3102e6
+  data.tar.gz: ca30cadbaa7677528a6c8f6771417a85e42c7c24bd619c48afe57283536c1657df0f391b1ae2f0cdf9c754189b5b77a3a73c29ca2017edebed0b1df7ac98e78d

data/.gitignore

@@ -1,21 +1,21 @@
-*.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
+*.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

data/.travis.yml

@@ -1,5 +1,5 @@
-language: ruby
-rvm:
-  - 2.2.5
-  - 2.3.1
-script: 'bundle exec rake test'
+language: ruby
+rvm:
+  - 2.2.5
+  - 2.3.1
+script: 'bundle exec rake test'

data/CHANGELOG.md

@@ -1,99 +1,105 @@
-# Change Log
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-
-## [0.11.0] - 2016-09-03
-### Fixed
-- add destination folder to backup download
-- `post_action_users`
-### Added
-- `change_topic_status`
-- set username of topic on creation
-
-## [0.10.1] - 2016-05-04
-### Fixed
-- raise an error if search is empty
-- fix /category path to be just /c
-- return errors for category_latest_topics if there are some
-
-## [0.10.0] - 2016-04-19
-### Added
-- group_members: Allows you to retrieve more than 100 users with pagination (offset &
-  limit)
-### Fixed
-- Deprication warning with SimpleCov
-- updated rack dependency and added ruby 2.3 to travis config
-
-## [0.9.1] - 2016-03-23
-### Fixed
-- topic and post like/flag need to use `:id`
-
-## [0.9.0] - 2016-03-22
-### Added
-- can now like/flag topics and posts
-
-## [0.8.1] - 2016-03-03
-### Fixed
-- enable use of discourse_api to make unauthenticated requests to discourse
-  endpoints like /categories and /topics 
-
-## [0.8.0] - 2016-02-28
-### Added
-- get stats from admin dashboard
-- get only stat totals from admin dashboard
-
-## [0.7.0] - 2015-12-09
-### Added
-- get user by external_id
-
-## [0.6.2] - 2015-12-02
-### Fixed
-- `API::Params` will not work correctly when both optional and defaults are
-  specified
-
-## [0.6.1] - 2015-11-28
-### Fixed
-- typo in topic_posts method
-
-## [0.6.0] - 2015-11-27
-### Added
-- get posts in topic by an array of id's
-
-## [0.5.1] - 2015-11-21
-### Fixed
-- remove puts statement
-
-## [0.5.0] - 2015-11-21
-### Added
-- get latest category topics by page
-
-## [0.4.0] - 2015-01-15
-### Added
-- generate an api key for a user
-- revoke an api key for a user
-- update user trust level
-- grant user badge
-
-## [0.3.6] - 2015-01-11
-### Added
-- list badges
-- view email settings
-- list emails sent
-- list badges by user
-- be able to specify SSL connection settings
-- list api keys generated
-- list backups created
-
-## [0.3.5] - 2015-01-06
-### Added
-- Can now get a list of users by type: active, new, staff, etc.
-- `client.category_latest_posts("category-slug")` endpoint
-
-## [0.1.2] - 2014-05-11
-
-- Release
-
-
-
-
-
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.12.0] - 2016-10-06
+### Added
+- add endpoint for `/admin/users/{id}/suspend`
+- add endpoint for `/admin/users/{id}/unsuspend`
+
+## [0.11.0] - 2016-09-03
+### Fixed
+- add destination folder to backup download
+- `post_action_users`
+
+### Added
+- `change_topic_status`
+- set username of topic on creation
+
+## [0.10.1] - 2016-05-04
+### Fixed
+- raise an error if search is empty
+- fix /category path to be just /c
+- return errors for category_latest_topics if there are some
+
+## [0.10.0] - 2016-04-19
+### Added
+- group_members: Allows you to retrieve more than 100 users with pagination (offset &
+  limit)
+### Fixed
+- Deprication warning with SimpleCov
+- updated rack dependency and added ruby 2.3 to travis config
+
+## [0.9.1] - 2016-03-23
+### Fixed
+- topic and post like/flag need to use `:id`
+
+## [0.9.0] - 2016-03-22
+### Added
+- can now like/flag topics and posts
+
+## [0.8.1] - 2016-03-03
+### Fixed
+- enable use of discourse_api to make unauthenticated requests to discourse
+  endpoints like /categories and /topics 
+
+## [0.8.0] - 2016-02-28
+### Added
+- get stats from admin dashboard
+- get only stat totals from admin dashboard
+
+## [0.7.0] - 2015-12-09
+### Added
+- get user by external_id
+
+## [0.6.2] - 2015-12-02
+### Fixed
+- `API::Params` will not work correctly when both optional and defaults are
+  specified
+
+## [0.6.1] - 2015-11-28
+### Fixed
+- typo in topic_posts method
+
+## [0.6.0] - 2015-11-27
+### Added
+- get posts in topic by an array of id's
+
+## [0.5.1] - 2015-11-21
+### Fixed
+- remove puts statement
+
+## [0.5.0] - 2015-11-21
+### Added
+- get latest category topics by page
+
+## [0.4.0] - 2015-01-15
+### Added
+- generate an api key for a user
+- revoke an api key for a user
+- update user trust level
+- grant user badge
+
+## [0.3.6] - 2015-01-11
+### Added
+- list badges
+- view email settings
+- list emails sent
+- list badges by user
+- be able to specify SSL connection settings
+- list api keys generated
+- list backups created
+
+## [0.3.5] - 2015-01-06
+### Added
+- Can now get a list of users by type: active, new, staff, etc.
+- `client.category_latest_posts("category-slug")` endpoint
+
+## [0.1.2] - 2014-05-11
+
+- Release
+
+
+
+
+

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in discourse_api.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in discourse_api.gemspec
+gemspec

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2014 Civilized Discourse Construction Kit, Inc.
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2014 Civilized Discourse Construction Kit, Inc.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,73 +1,73 @@
-# DiscourseApi
-
-[![Code Climate](https://codeclimate.com/github/discourse/discourse_api.png)][codeclimate]
-
-[codeclimate]: https://codeclimate.com/github/discourse/discourse_api
-
-The Discourse API gem allows you to consume the Discourse API
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'discourse_api'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install discourse_api
-
-## Usage
-
-Over time this project intends to have a full Discourse API. At the moment there are only a
-few endpoints available:
-
-```ruby
-client = DiscourseApi::Client.new("http://try.discourse.org")
-client.api_key = "YOUR_API_KEY"
-client.api_username = "YOUR_USERNAME"
-
-client.ssl(...)                                 #=> specify SSL connection settings if needed
-
-# Topic endpoints
-client.latest_topics                            #=> Gets a list of the latest topics
-client.hot_topics                               #=> Gets a list of hot topics
-client.new_topics                               #=> Gets a list of new topics
-client.topics_by("sam")                         #=> Gets a list of topics created by user "sam"
-client.topic(57)                                #=> Gets the topic with id 57
-
-# Search endpoint
-client.search("sandbox")                        #=> Gets a list of topics that match "sandbox"
-
-# Categories endpoint
-client.categories                               #=> Gets a list of categories
-client.category_latest_posts("category-slug")   #=> Gets a list of latest posts in a category
-
-# SSO endpoint
-client.sync_sso(                                #=> Synchronizes the SSO record
-  sso_secret: "discourse_sso_rocks",
-  name: "Test Name",
-  username: "test_name",
-  email: "name@example.com",
-  external_id: "2"
-)
-```
-
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-## Testing
-
-1. Install discourse locally
-2. Inside of your discourse directory, run: `bundle exec rake db:api_test_seed`
-3. Start discourse: `bundle exec rails s`
-4. Inside of your discourse_api directory, run: `bundle exec rspec spec/`
+# DiscourseApi
+
+[![Code Climate](https://codeclimate.com/github/discourse/discourse_api.png)][codeclimate]
+
+[codeclimate]: https://codeclimate.com/github/discourse/discourse_api
+
+The Discourse API gem allows you to consume the Discourse API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'discourse_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install discourse_api
+
+## Usage
+
+Over time this project intends to have a full Discourse API. At the moment there are only a
+few endpoints available:
+
+```ruby
+client = DiscourseApi::Client.new("http://try.discourse.org")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+client.ssl(...)                                 #=> specify SSL connection settings if needed
+
+# Topic endpoints
+client.latest_topics                            #=> Gets a list of the latest topics
+client.hot_topics                               #=> Gets a list of hot topics
+client.new_topics                               #=> Gets a list of new topics
+client.topics_by("sam")                         #=> Gets a list of topics created by user "sam"
+client.topic(57)                                #=> Gets the topic with id 57
+
+# Search endpoint
+client.search("sandbox")                        #=> Gets a list of topics that match "sandbox"
+
+# Categories endpoint
+client.categories                               #=> Gets a list of categories
+client.category_latest_posts("category-slug")   #=> Gets a list of latest posts in a category
+
+# SSO endpoint
+client.sync_sso(                                #=> Synchronizes the SSO record
+  sso_secret: "discourse_sso_rocks",
+  name: "Test Name",
+  username: "test_name",
+  email: "name@example.com",
+  external_id: "2"
+)
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Testing
+
+1. Install discourse locally
+2. Inside of your discourse directory, run: `bundle exec rake db:api_test_seed`
+3. Start discourse: `bundle exec rails s`
+4. Inside of your discourse_api directory, run: `bundle exec rspec spec/`