discourse_api 0.34.0 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52056720fe38a8e6345ebdaa427c8da352681b88bcf3a2de2b21636b251181ce
-  data.tar.gz: 81f2c6c41121d1b15cc5c389d4f067314b271eb96b7976a12ed2625e1927861b
+  metadata.gz: c528dfd53262df7af997ea5f9da09b4ea423e9425dc98d18c944af293f15ef94
+  data.tar.gz: e0df934c4e39a5eed50f080bf6d02be0aec29aa3b21ddd21875782ad456867eb
 SHA512:
-  metadata.gz: 75583ba2ac5bc68bba59ba127d87b9660de4101baf7eeb5a79454b536254eb07596d98df5610b67f47445e0f362f1a928d36e2cbdf08a74b57e66eb7aef20409
-  data.tar.gz: '019c08c76bd3150b6eea2f990f7e3194931d04d96522e51a7662b5a2aa1b3cbbc7424b43833ef549d5e351baeeb7890564c0c0f473b6fa8af42ec871666b458d'
+  metadata.gz: bf4d4859413e6c923bd0c0162b13997133536e6d9d176ba8220364ed7cdbb58962e3a4ce27940bc5c5d96bd2e39fe601accc27fe813eabd1aabb209913351fe4
+  data.tar.gz: 46117b013a50ccc7fc3e6bd7f1fa4f117b1166cb846e34f76821db62ef66eeb4d7a87b21cbc6273494bcece664c1b6520639c016b430b0a47d970556df8b9ea9

data/.gitignore

@@ -19,3 +19,6 @@ bin/
 .ruby-gemset
 .ruby-version
 .env
+
+
+.rubocop-https---raw-githubusercontent-com-discourse-discourse-master--rubocop-yml

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.4
+  DisabledByDefault: true
+  Exclude:
+    - 'spec/**/**/*.rb'

data/.travis.yml

@@ -1,5 +1,11 @@
-language: ruby
+language: 'ruby'
+
+before_install:
+  - 'gem update --system'
+  - 'gem install bundler'
+
 rvm:
-  - 2.2.5
-  - 2.3.1
-script: 'bundle exec rake test'
+  - '2.5.5'
+  - '2.6.2'
+
+script: 'bundle exec rake'

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 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
+### Added
+- Added `custom_fields` param to create/update category
+- Added `frozen_string_literal: true` to all the files
+- Added rubocop and all the changes that went along with it
+### Fixed
+- Allow `api_username` to be changed for an initialized client
+- Update many of the `/users` routes to use the `/u` route
+### Changed
+- Changed `update_trust_level` to follow consistent method param syntax where
+  you specify the id first followed by params
+
 ## [0.34.0] - 2019-04-02
 ### Added
 - Header based authentication

data/Gemfile

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

data/Guardfile

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 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" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/Rakefile

@@ -1,7 +1,12 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
 task test: :spec
-task default: :spec
+task lint: :rubocop
+task default: [:spec, :lint]

data/discourse_api.gemspec

@@ -1,35 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'discourse_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "discourse_api"
+  spec.name          = 'discourse_api'
   spec.version       = DiscourseApi::VERSION
-  spec.authors       = ["Sam Saffron", "John Paul Ashenfelter", "Michael Herold", "Blake Erickson"]
-  spec.email         = ["sam.saffron@gmail.com", "john@ashenfelter.com", "michael.j.herold@gmail.com", "o.blakeerickson@gmail.com"]
-  spec.description   = %q{Discourse API}
-  spec.summary       = %q{Allows access to the Discourse API}
-  spec.homepage      = "http://github.com/discourse/discourse_api"
-  spec.license       = "MIT"
+  spec.authors       = ['Sam Saffron', 'John Paul Ashenfelter', 'Michael Herold', 'Blake Erickson']
+  spec.email         = ['sam.saffron@gmail.com', 'john@ashenfelter.com', 'michael.j.herold@gmail.com', 'o.blakeerickson@gmail.com']
+  spec.description   = 'Discourse API'
+  spec.summary       = 'Allows access to the Discourse API'
+  spec.homepage      = 'http://github.com/discourse/discourse_api'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "faraday", "~> 0.9"
-  spec.add_dependency "faraday_middleware", "~> 0.10"
-  spec.add_dependency "rack", ">= 1.6"
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.10'
+  spec.add_dependency 'rack', '>= 1.6'
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "webmock", "~> 2.0"
-  spec.add_development_dependency "guard-rspec", "~> 4.7"
-  spec.add_development_dependency "guard", "~> 2.14"
-  spec.add_development_dependency "rb-inotify", "~> 0.9"
-  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'rb-inotify', '~> 0.9'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'webmock', '~> 2.0'
 
   spec.required_ruby_version = '>= 2.2.3'
 end

data/examples/backups.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/badges.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/category.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/change_topic_status.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
@@ -17,7 +18,6 @@ response = client.create_topic(
 topic_id = response['topic_id']
 topic_slug = response['topic_slug']
 
-
 ##
 # available options (guessing from reading discourse source)
 # status can be: ['autoclose', 'closed', 'archived', 'disabled', 'visible']
@@ -25,9 +25,9 @@ topic_slug = response['topic_slug']
 ##
 
 # lock topic (note: api_username determines user that is performing action)
-params = {status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME"}
+params = { status: 'closed', enabled: true, api_username: "YOUR USERNAME/USERS USERNAME" }
 client.change_topic_status(topic_slug, topic_id, params)
 
 # unlock topic (note: api_username determines user that is performing action)
-params = {status: 'closed', enabled: false, api_username: "YOUR USERNAME/USERS USERNAME"}
+params = { status: 'closed', enabled: false, api_username: "YOUR USERNAME/USERS USERNAME" }
 client.change_topic_status(topic_slug, topic_id, params)

data/examples/create_private_message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/create_topic.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/create_update_category.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
@@ -18,7 +19,6 @@ client.api_username = "system"
 #   :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template
 ###
 
-
 # Create category
 new_category = client.create_category(
     name: "Test Category",

data/examples/create_user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/dashboard.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
@@ -5,9 +6,9 @@ client = DiscourseApi::Client.new("http://localhost:3000")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
-# get all dashboard status as json 
+# get all dashboard status as json
 puts client.get_dashboard_stats
 
-# get hash of some dashboard total value 
+# get hash of some dashboard total value
 puts client.get_dashboard_stats_totals
 # sample output: {"users"=>9, "topics"=>230, "posts"=>441}

data/examples/disposable_invite_tokens.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # requires this plugin => https://github.com/discourse/discourse-invite-tokens
 
 require 'csv'

data/examples/example.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/group_set_user_notification_level.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
@@ -34,4 +35,3 @@ end
     end
   end
 end
-

data/examples/groups.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/invite_users.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/post_action.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/search.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/sent_private_messages.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/sso.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/topic_lists.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/update_user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/examples/upload_file.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 

data/lib/discourse_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discourse_api/api/params"
 require "discourse_api/client"
 require "discourse_api/error"

data/lib/discourse_api/api/api_key.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module ApiKey
@@ -19,11 +20,11 @@ module DiscourseApi
       end
 
       def revoke_api_key(id)
-        response = delete("/admin/api/key", {id: id})
+        response = delete("/admin/api/key", id: id)
       end
 
       def regenerate_api_key(id)
-        response = put("/admin/api/key", {id: id})
+        response = put("/admin/api/key", id: id)
         response.body
       end
     end

data/lib/discourse_api/api/backups.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Backups

data/lib/discourse_api/api/badges.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Badges
@@ -11,14 +12,14 @@ module DiscourseApi
         response.body['badges']
       end
 
-      def grant_user_badge(params={})
+      def grant_user_badge(params = {})
         post("/user_badges", params)
       end
 
-      def create_badge(params={})
+      def create_badge(params = {})
         args = API.params(params)
-                  .required(:name, :badge_type_id)
-                  .optional(:description, :allow_title, :multiple_grant, :icon, :listable,
+          .required(:name, :badge_type_id)
+          .optional(:description, :allow_title, :multiple_grant, :icon, :listable,
                             :target_posts, :query, :enabled, :auto_revoke, :badge_grouping_id,
                             :trigger, :show_posts, :image, :long_description)
         post("/admin/badges.json", args)

data/lib/discourse_api/api/categories.rb

@@ -1,38 +1,39 @@
+# frozen_string_literal: true
 module DiscourseApi
   module API
     module Categories
       # :color and :text_color are RGB hexadecimal strings
       # :permissions is a hash with the group name and permission_type which is
       # an integer 1 = Full 2 = Create Post 3 = Read Only
-      def create_category(args={})
+      def create_category(args = {})
         args = API.params(args)
-                  .required(:name, :color, :text_color)
-                  .optional(:description, :permissions)
-                  .default(parent_category_id: nil)
+          .required(:name, :color, :text_color)
+          .optional(:description, :permissions, :custom_fields)
+          .default(parent_category_id: nil)
         response = post("/categories", args)
         response['category']
       end
 
-      def update_category(args={})
+      def update_category(args = {})
         category_id = args[:id]
         args = API.params(args)
-                   .required(:id, :name, :color, :text_color)
-                   .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
-                             :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template)
-                   .default(parent_category_id: nil)
+          .required(:id, :name, :color, :text_color)
+          .optional(:slug, :permissions, :auto_close_hours, :auto_close_based_on_last_post, :position, :email_in,
+                             :email_in_allow_strangers, :logo_url, :background_url, :allow_badges, :topic_template, :custom_fields)
+          .default(parent_category_id: nil)
         response = put("/categories/#{category_id}", args)
         response['body']['category'] if response['body']
       end
 
-      def categories(params={})
+      def categories(params = {})
         response = get('/categories.json', params)
         response[:body]['category_list']['categories']
       end
 
-      def category_latest_topics(args={})
+      def category_latest_topics(args = {})
         params = API.params(args)
-                    .required(:category_slug)
-                    .optional(:page).to_h
+          .required(:category_slug)
+          .optional(:page).to_h
         url = "/c/#{params[:category_slug]}/l/latest.json"
         if params.include?(:page)
           url = "#{url}?page=#{params[:page]}"
@@ -64,10 +65,10 @@ module DiscourseApi
         response[:body]['category']
       end
 
-      def category_set_user_notification(args={})
+      def category_set_user_notification(args = {})
         category_id = args[:id]
         args = API.params(args)
-                   .required(:notification_level)
+          .required(:notification_level)
         post("/category/#{category_id}/notifications", args)
       end
     end

data/lib/discourse_api/api/dashboard.rb

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