discourse_api 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8330a94a826de63e8b485e79b0ee6e43dfc0cbe2
-  data.tar.gz: d8145df00cfb45f265fe8fc2e3af9e1d0e35e230
+  metadata.gz: 55956e7fcbb398abf377f1f648453fb5cecda82a
+  data.tar.gz: cbaf89c085414d8a6db32a4c9ac782cfaa4dde7b
 SHA512:
-  metadata.gz: f9ea65210238643e2233e73f28ea1945a877472c4581794c93cf208a99232b135669fa476a400f69ac43c39b6fdf47a0dd33189c67009da65a8137b23bfbdca6
-  data.tar.gz: f0753dc07dc1c480e2ee6e78a8565b96cf5605ea40bee94a5c3eed2022fb10b6c848cf9ff58f1eafb306e2a319ca0b181f9b3517f3e0a5424285de90985432bf
+  metadata.gz: df81f31669c828560956873d6d2059f2914fcd8a88319538c3e47aa9d5ce9c049f6adfc1ce1cdfe66cafe70a2657bede0c64ddad7254311cf614645d47c47d4f
+  data.tar.gz: 7b300c7418237936b66c1c504e176025506bc8c01de018ab76f5fe79165d7da3e1f318a37f107ce929b51880e3cec7301939491aeddce36c5ea5b3d2a5627468

data/discourse_api.gemspec

@@ -18,10 +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", "0.9.0"
+  spec.add_dependency "faraday", "~>0.9.0"
   spec.add_dependency "faraday_middleware", "~> 0.9"
   spec.add_dependency "rack", "~> 1.5"
-  spec.add_dependency "dotenv", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "10.3.2"
@@ -31,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard", "~> 2.6"
   spec.add_development_dependency "rb-inotify", "~> 0.9"
   spec.add_development_dependency "simplecov", "~> 0.9"
+  spec.add_development_dependency "dotenv", ">= 1.0", "< 3.0"
 end

data/examples/backups.rb

@@ -0,0 +1,18 @@
+$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 list of backup files
+puts client.backups()
+
+# create backup
+puts client.create_backup()
+
+# restore backup
+puts client.restore_backup("backup_file_name.tar.gz")
+
+# download backup
+puts client.download_backup("backup_file_name.tar.gz")

data/examples/disposable_invite_tokens.rb

@@ -9,11 +9,10 @@ client.api_username = "YOUR_USERNAME"
 
 # fetch email-less invite tokens
 invite_tokens = client.disposable_tokens(username: "eviltrout", quantity: 5, group_names: "security,support")
-invite_tokens_array = invite_tokens.body
 
 # write to CSV file
 CSV.open(File.expand_path("../invite_tokens.csv", __FILE__), "w") do |csv|
-  invite_tokens_array.each do |value|
+  invite_tokens.each do |value|
     csv << [value]
   end
 end

data/lib/discourse_api/api/backups.rb

@@ -5,6 +5,20 @@ module DiscourseApi
         response = get("/admin/backups.json")
         response.body
       end
+
+      def create_backup
+        post("/admin/backups", with_uploads: true)
+      end
+
+      def restore_backup(file_name)
+        post("/admin/backups/#{file_name}/restore")
+      end
+
+      def download_backup(file_name)
+        response = get("/admin/backups/#{file_name}")
+        # write file
+        File.open('examples/backup.tar.gz', 'wb') { |fp| fp.write(response.body) }
+      end
     end
   end
 end

data/lib/discourse_api/api/search.rb

@@ -8,7 +8,7 @@ module DiscourseApi
       # @option options [String] :type_filter Returns results of the specified type.
       # @return [Array] Return results as an array of Hashes.
       def search(term, options={})
-        response = get('/search.json', options.merge(term: term))
+        response = get('/search/query', options.merge(term: term))
         response[:body]
       end
     end

data/lib/discourse_api/api/sso.rb

@@ -8,6 +8,9 @@ module DiscourseApi
         sso.username = params[:username]
         sso.email = params[:email]
         sso.external_id = params[:external_id]
+        sso.suppress_welcome_message = params[:suppress_welcome_message] === true
+        sso.avatar_url = params[:avatar_url]
+        sso.avatar_force_update = params[:avatar_force_update] === true
         post("/admin/users/sync_sso/", sso.payload)
       end
     end

data/lib/discourse_api/api/tags.rb

@@ -0,0 +1,10 @@
+module DiscourseApi
+  module API
+    module Tags
+      def show_tag(tag)
+        response = get("/tags/#{tag}")
+        response[:body]
+      end
+    end
+  end
+end

data/lib/discourse_api/client.rb

@@ -6,6 +6,7 @@ require 'discourse_api/version'
 require 'discourse_api/api/categories'
 require 'discourse_api/api/search'
 require 'discourse_api/api/sso'
+require 'discourse_api/api/tags'
 require 'discourse_api/api/topics'
 require 'discourse_api/api/posts'
 require 'discourse_api/api/users'
@@ -26,6 +27,7 @@ module DiscourseApi
     include DiscourseApi::API::Categories
     include DiscourseApi::API::Search
     include DiscourseApi::API::SSO
+    include DiscourseApi::API::Tags
     include DiscourseApi::API::Topics
     include DiscourseApi::API::Posts
     include DiscourseApi::API::Users

data/lib/discourse_api/single_sign_on.rb

@@ -5,9 +5,10 @@ require 'openssl'
 module DiscourseApi
   class SingleSignOn
     ACCESSORS = [:nonce, :name, :username, :email, :avatar_url, :avatar_force_update,
-                 :about_me, :external_id, :return_sso_url, :admin, :moderator]
+                 :about_me, :external_id, :return_sso_url, :admin, :moderator, :suppress_welcome_message]
     FIXNUMS = []
-    BOOLS = [:avatar_force_update, :admin, :moderator]
+    BOOLS = [:avatar_force_update, :admin, :moderator, :suppress_welcome_message]
+    #NONCE_EXPIRY_TIME = 10.minutes # minutes is a rails method and is causing an error. Is this needed in the api?
 
     attr_accessor(*ACCESSORS)
     attr_accessor :sso_secret, :sso_url
@@ -26,7 +27,12 @@ module DiscourseApi
 
       parsed = Rack::Utils.parse_query(payload)
       if sso.sign(parsed["sso"]) != parsed["sig"]
-        raise RuntimeError, "Bad signature for payload"
+        diags = "\n\nsso: #{parsed["sso"]}\n\nsig: #{parsed["sig"]}\n\nexpected sig: #{sso.sign(parsed["sso"])}"
+        if parsed["sso"] =~ /[^a-zA-Z0-9=\r\n\/+]/m
+          raise RuntimeError, "The SSO field should be Base64 encoded, using only A-Z, a-z, 0-9, +, /, and = characters. Your input contains characters we don't understand as Base64, see http://en.wikipedia.org/wiki/Base64 #{diags}"
+        else
+          raise RuntimeError, "Bad signature for payload #{diags}"
+        end
       end
 
       decoded = Base64.decode64(parsed["sso"])
@@ -98,5 +104,7 @@ module DiscourseApi
 
       Rack::Utils.build_query(payload)
     end
+
   end
+
 end

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/spec/discourse_api/api/search_spec.rb

@@ -5,12 +5,12 @@ describe DiscourseApi::API::Search do
 
   describe "#search" do
     before do
-      stub_get("http://localhost:3000/search.json?api_key=test_d7fd0429940&api_username=test_user").with(query: { term: "test"} ).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/search/query?api_key=test_d7fd0429940&api_username=test_user").with(query: { term: "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("http://localhost:3000/search.json?api_key=test_d7fd0429940&api_username=test_user").with(query: { term: "test"} )).to have_been_made
+      expect(a_get("http://localhost:3000/search/query?api_key=test_d7fd0429940&api_username=test_user").with(query: { term: "test"} )).to have_been_made
     end
 
     it "returns the requested search" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,20 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
@@ -54,20 +54,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -180,6 +166,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -198,6 +204,7 @@ files:
 - README.md
 - Rakefile
 - discourse_api.gemspec
+- examples/backups.rb
 - examples/category.rb
 - examples/create_topic.rb
 - examples/disposable_invite_tokens.rb
@@ -221,6 +228,7 @@ files:
 - lib/discourse_api/api/private_messages.rb
 - lib/discourse_api/api/search.rb
 - lib/discourse_api/api/sso.rb
+- lib/discourse_api/api/tags.rb
 - lib/discourse_api/api/topics.rb
 - lib/discourse_api/api/users.rb
 - lib/discourse_api/client.rb
@@ -296,7 +304,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Allows access to the Discourse API