discourse_api 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96b74f525ab0fe9d044cf6ca8bf4d3dd2eac1c14
-  data.tar.gz: f814acea9dba0c29147b5bf2569d1f95bb2a6af4
+  metadata.gz: 7b27fccecba3357cb727bb0b241e29613ddf4d6c
+  data.tar.gz: 9eff8ed55d066031a9ca7b875ecbae247c8f54b7
 SHA512:
-  metadata.gz: a60efaf52b2a8c43d5df74046b4df8a50ed5bbe6e39ef7f1565097fe37b2b706322691f78286dab090f7d0916a5961e9e12b2c0517383b45719424fbda589b8e
-  data.tar.gz: ea0d9fdf0f425e8bcc09ba8e959312b1fb1b879b5abbdb3f86531ef91250b3f6fad407e6077f1ffa4454831e122e012ddab692572ebd43585c902149a318fd71
+  metadata.gz: 2dc325485d107e56f286baa033ffbefaf646c32611cfbea7b285a7d628445be7d6e900d7a0626516f6d1fb428d6e8ac6363803349845f51cebba0dbf66c846df
+  data.tar.gz: cf520bd3e1baba478c6f4ad7ece1f3419dfccdfdb8fdf6d54cec01a3a1433d06bbf254656b457bfb39e14090e329b05e7a5923518b90af185d105f7065a789e8

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## master
+
+* Added `client.category_latest_posts("category-slug")` endpoint
+
+## 0.1.2
+
+* Release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Discourse
+Copyright (c) 2014 Civilized Discourse Construction Kit, Inc.
 
 MIT License
 

data/README.md

@@ -31,18 +31,18 @@ few endpoints available:
 client = DiscourseApi::Client.new("http://try.discourse.org")
 
 # 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
+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"
+client.search("sandbox")                        #=> Gets a list of topics that match "sandbox"
 
 # Categories endpoint
-client.categories         #=> Gets a list of categories
-
+client.categories                               #=> Gets a list of categories
+client.category_latest_posts("category-slug")   #=> Gets a list of latest posts in a category
 ```
 
 
@@ -53,3 +53,10 @@ client.categories         #=> Gets a list of categories
 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/`

data/Rakefile

@@ -4,4 +4,4 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 task test: :spec
-task default: :spec
+task default: :spec

data/discourse_api.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 0.8.8"
+  spec.add_dependency "faraday", "0.9.0"
   spec.add_dependency "faraday_middleware", "~> 0.9"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "rb-inotify"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rake", "10.3.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_development_dependency "guard-rspec", "~> 4.3"
+  spec.add_development_dependency "guard", "~> 2.6"
+  spec.add_development_dependency "rb-inotify", "~> 0.9"
+  spec.add_development_dependency "simplecov", "~> 0.9"
 end

data/examples/{post_topic.rb → create_topic.rb}

@@ -1,13 +1,11 @@
-# require 'discourse_api'
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
-client = DiscourseApi::Client.new("localhost", 3000)
+client = DiscourseApi::Client.new("http://localhost:3000")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
-client.post_create(
+client.create_topic(
   category: "Boing Boing",
   skip_validations: true,
   auto_track: false,

data/examples/disposable_invite_tokens.rb

@@ -0,0 +1,19 @@
+require 'csv'
+
+$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"
+
+# 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|
+    csv << [value]
+  end
+end

data/examples/example.rb

@@ -1,7 +1,9 @@
-# require 'discourse_api'
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
-client = DiscourseApi::Client.new("http://localhost:3000", '6157bad92b3b5f8004aedc82220281c5966e5d560bb2bb6f962123474db4ac98', 'user_name')
-puts client.latest_topics
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+# get latest topics
+puts client.latest_topics

data/examples/invite_users.rb

@@ -1,14 +1,12 @@
-# require 'discourse_api'
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
-client = DiscourseApi::Client.new("localhost",3000)
-client.api_key = "6157bad92b3b5f8004aedc82220281c5966e5d560bb2bb6f962123474db4ac98"
-client.api_username = "forumadmin"
+client = DiscourseApi::Client.new("http://localhost:3000")
+client.api_key = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
 
-client.topic_invite_user(topic_id: 1, email: "bob@bob.com")
+# invite to a topic
+client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1)
 
 # if the user is an admin you may invite to a group as well
-client.topic_invite_user(topic_id: 1, email: "bob@bob.com", group_ids: "1,2,3")
-client.topic_invite_user(topic_id: 1, email: "bob@bob.com", group_names: "bugs,cars,testers")
+client.invite_user_to_topic(email: "foo@bar.com", topic_id: 1, group_ids: "1,2,3")

data/examples/topic_lists.rb

@@ -1,13 +1,11 @@
-# require 'discourse_api'
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
-client = DiscourseApi::Client.new("localhost", 3000)
+client = DiscourseApi::Client.new("http://localhost:3000")
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
+# get latest topics
 puts client.latest_topics({})
-puts client.hot_topics({})
+# get all categories
 puts client.categories({})
-

data/examples/update_user.rb

@@ -1,5 +1,3 @@
-# require 'discourse_api'
-
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require File.expand_path('../../lib/discourse_api', __FILE__)
 
@@ -7,8 +5,11 @@ client = DiscourseApi::Client.new("localhost", 3000)
 client.api_key = "YOUR_API_KEY"
 client.api_username = "YOUR_USERNAME"
 
-puts client.username_update(username: "Batman", new_username: "Alfred")
-puts client.user_update(username: "Batman", name: "Bruce Wayne")
-puts client.email_update(username: "Batman", email: "batman@example.com")
-puts client.toggle_avatar(username: "Batman", use_uploaded_avatar: true)
-puts client.upload_avatar(username: "DiscourseHero", file: "http://cdn.discourse.org/assets/logo.png")
+# update username from "robin" to "batman"
+puts client.update_username("robin", "batman")
+# update name of user whose username is "batman"
+puts client.update_user("batman", name: "Bruce Wayne")
+# update email of user whose username is "batman"
+puts client.update_email("batman", "batman@gotham.com")
+# update avatar of user whose username is "batman"
+puts client.update_avatar("batman", "http://meta-discourse.r.worldssl.net/uploads/default/2497/724a6ef2e79d2bc7.png")

data/lib/discourse_api.rb

@@ -1,3 +1,3 @@
 require "discourse_api/client"
 require "discourse_api/error"
-require "discourse_api/version"
+require "discourse_api/version"

data/lib/discourse_api/api/categories.rb

@@ -5,6 +5,11 @@ module DiscourseApi
         response = get('/categories.json', args)
         response[:body]['category_list']['categories']
       end
+
+      def category_latest_topics(category_slug)
+        response = get("/category/#{category_slug}.json")
+        response[:body]['topic_list']['topics']
+      end
     end
   end
-end
+end

data/lib/discourse_api/api/invite.rb

@@ -0,0 +1,13 @@
+module DiscourseApi
+  module API
+    module Invite
+      def invite_user_to_topic(params={})
+        post("/t/#{params[:topic_id]}/invite", params)
+      end
+
+      def disposable_tokens(params={})
+        post("/invites/disposable", params)
+      end
+    end
+  end
+end

data/lib/discourse_api/api/search.rb

@@ -13,4 +13,4 @@ module DiscourseApi
       end
     end
   end
-end
+end

data/lib/discourse_api/api/topics.rb

@@ -1,14 +1,8 @@
 module DiscourseApi
   module API
     module Topics
-      def hot_topics(*args)
-        response = get('/hot.json', args)
-        response[:body]['topic_list']['topics']
-      end
-
-      def invite_user_to_topic(user_email, topic_id)
-        params = { email: user_email, topic_id: topic_id }
-        post "/t/#{topic_id}/invite.json", params
+      def create_topic(params={})
+        post("/posts", params)
       end
 
       def latest_topics(*args)
@@ -32,4 +26,4 @@ module DiscourseApi
       end
     end
   end
-end
+end

data/lib/discourse_api/api/users.rb

@@ -1,10 +1,6 @@
 module DiscourseApi
   module API
     module Users
-      def toggle_avatar(username, use_uploaded_avatar)
-        put("/users/#{username}/preferences/avatar/toggle", { use_uploaded_avatar: use_uploaded_avatar })
-      end
-
       def activate(id)
         put "/admin/users/#{id}/activate", api_key: api_key, api_username: api_username
       end
@@ -22,8 +18,8 @@ module DiscourseApi
         put("/users/#{username}/preferences/email", { email: email, api_key: api_key })
       end
 
-      def update_user(username, *args)
-        put("/users/#{username}", args)
+      def update_user(username, params={})
+        put("/users/#{username}", params)
       end
 
       def update_username(username, new_username)
@@ -42,4 +38,4 @@ module DiscourseApi
       end
     end
   end
-end
+end

data/lib/discourse_api/client.rb

@@ -6,6 +6,7 @@ require 'discourse_api/api/categories'
 require 'discourse_api/api/search'
 require 'discourse_api/api/topics'
 require 'discourse_api/api/users'
+require 'discourse_api/api/invite'
 
 module DiscourseApi
   class Client
@@ -16,10 +17,11 @@ module DiscourseApi
     include DiscourseApi::API::Search
     include DiscourseApi::API::Topics
     include DiscourseApi::API::Users
+    include DiscourseApi::API::Invite
 
     def initialize(host, api_key=nil, api_username=nil)
-      @host = host
-      @api_key = api_key
+      @host         = host
+      @api_key      = api_key
       @api_username = api_username
     end
 
@@ -57,10 +59,12 @@ module DiscourseApi
 
     def connection
       @connection ||= Faraday.new connection_options do |conn|
+        # Follow redirects
+        conn.use FaradayMiddleware::FollowRedirects, limit: 5
         # Convert request params to "www-form-encoded"
         conn.request :url_encoded
         # Parse responses as JSON
-        conn.response :json
+        conn.use FaradayMiddleware::ParseJson, content_type: 'application/json'
         # Use Faraday's default HTTP adapter
         conn.adapter Faraday.default_adapter
         #pass api_key and api_username on every request

data/lib/discourse_api/error.rb

@@ -11,4 +11,4 @@ module DiscourseApi
       exception.respond_to?(:message) ? super(exception.message) : super(exception.to_s)
     end
   end
-end
+end

data/lib/discourse_api/version.rb

@@ -1,3 +1,3 @@
 module DiscourseApi
-  VERSION = "0.1.2"
+  VERSION = "0.2.2"
 end

data/spec/discourse_api/api/categories_spec.rb

@@ -1,22 +1,39 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Categories do
-  subject { DiscourseApi::Client.new("http://localhost") }
+  subject { DiscourseApi::Client.new("http://localhost:3000") }
 
   describe "#categories" do
     before do
-      stub_get("http://localhost/categories.json").to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/categories.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("categories.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.categories
-      expect(a_get("http://localhost/categories.json")).to have_been_made
+      expect(a_get("http://localhost:3000/categories.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested categories" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       categories = subject.categories
       expect(categories).to be_an Array
       expect(categories.first).to be_a Hash
     end
   end
-end
+
+  describe '#category_latest_topics' do
+    before do
+      stub_get("http://localhost:3000/category/category-slug.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("category_latest_topics.json"), headers: { content_type: "application/json" })
+    end
+
+    it "returns the latest topics in a category" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      latest_topics = subject.category_latest_topics('category-slug')
+      expect(latest_topics).to be_an Array
+    end
+  end
+end

data/spec/discourse_api/api/search_spec.rb

@@ -1,22 +1,26 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Search do
-  subject { DiscourseApi::Client.new("http://localhost") }
+  subject { DiscourseApi::Client.new("http://localhost:3000") }
 
   describe "#search" do
     before do
-      stub_get("http://localhost/search.json").with(query: { term: "test"} ).to_return(body: fixture("search.json"), headers: { content_type: "application/json" })
+      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" })
     end
 
     it "requests the correct resource" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.search("test")
-      expect(a_get("http://localhost/search.json").with(query: { term: "test"} )).to have_been_made
+      expect(a_get("http://localhost:3000/search.json?api_key=test_d7fd0429940&api_username=test_user").with(query: { term: "test"} )).to have_been_made
     end
 
     it "returns the requested search" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       results = subject.search("test")
       expect(results).to be_an Array
       expect(results.first).to be_a Hash
     end
   end
-end
+end

data/spec/discourse_api/api/topics_spec.rb

@@ -1,24 +1,7 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Topics do
-  subject { DiscourseApi::Client.new("http://localhost") }
-
-  describe "#hot_topics" do
-    before do
-      stub_get("http://localhost/hot.json").to_return(body: fixture("hot.json"), headers: { content_type: "application/json" })
-    end
-
-    it "requests the correct resource" do
-      subject.hot_topics
-      expect(a_get("http://localhost/hot.json")).to have_been_made
-    end
-
-    it "returns the requested topics" do
-      topics = subject.hot_topics
-      expect(topics).to be_an Array
-      expect(topics.first).to be_a Hash
-    end
-  end
+  subject { DiscourseApi::Client.new("http://localhost:3000") }
 
   describe "#invite_user_to_topic" do
     it "needs to have a test written for it"
@@ -26,15 +9,19 @@ describe DiscourseApi::API::Topics do
 
   describe "#latest_topics" do
     before do
-      stub_get("http://localhost/latest.json").to_return(body: fixture("latest.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/latest.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("latest.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.latest_topics
-      expect(a_get("http://localhost/latest.json")).to have_been_made
+      expect(a_get("http://localhost:3000/latest.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topics" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       topics = subject.latest_topics
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
@@ -43,15 +30,19 @@ describe DiscourseApi::API::Topics do
 
   describe "#new_topics" do
     before do
-      stub_get("http://localhost/new.json").to_return(body: fixture("new.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/new.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("new.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.new_topics
-      expect(a_get("http://localhost/new.json")).to have_been_made
+      expect(a_get("http://localhost:3000/new.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topics" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       topics = subject.new_topics
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
@@ -60,15 +51,19 @@ describe DiscourseApi::API::Topics do
 
   describe "#topic" do
     before do
-      stub_get("http://localhost/t/57.json").to_return(body: fixture("topic.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/t/57.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("topic.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.topic(57)
-      expect(a_get("http://localhost/t/57.json")).to have_been_made
+      expect(a_get("http://localhost:3000/t/57.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topic" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       topic = subject.topic(57)
       expect(topic).to be_a Hash
       expect(topic["id"]).to eq(57)
@@ -77,18 +72,22 @@ describe DiscourseApi::API::Topics do
 
   describe "#topics_by" do
     before do
-      stub_get("http://localhost/topics/created-by/test_user.json").to_return(body: fixture("topics_created_by.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/topics/created-by/test.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("topics_created_by.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.topics_by('test_user')
-      expect(a_get("http://localhost/topics/created-by/test_user.json")).to have_been_made
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      subject.topics_by('test')
+      expect(a_get("http://localhost:3000/topics/created-by/test.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested topics" do
-      topics = subject.topics_by('test_user')
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      topics = subject.topics_by('test')
       expect(topics).to be_an Array
       expect(topics.first).to be_a Hash
     end
   end
-end
+end

data/spec/discourse_api/api/users_spec.rb

@@ -1,24 +1,24 @@
 require 'spec_helper'
 
 describe DiscourseApi::API::Users do
-  subject { DiscourseApi::Client.new("http://localhost") }
-
-  describe "#toggle_avatar" do
-    it "needs to have a test written for it"
-  end
+  subject { DiscourseApi::Client.new("http://localhost:3000") }
 
   describe "#user" do
     before do
-      stub_get("http://localhost/users/test_user.json").to_return(body: fixture("user.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/users/test.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("user.json"), headers: { content_type: "application/json" })
     end
 
     it "requests the correct resource" do
-      subject.user("test_user")
-      expect(a_get("http://localhost/users/test_user.json")).to have_been_made
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      subject.user("test")
+      expect(a_get("http://localhost:3000/users/test.json?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns the requested user" do
-      user = subject.user("test_user")
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      user = subject.user("test")
       expect(user).to be_a Hash
     end
   end
@@ -41,18 +41,22 @@ describe DiscourseApi::API::Users do
 
   describe "#create_user" do
     before do
-      stub_post("http://localhost/users").to_return(body: fixture("user_create_success.json"), headers: { content_type: "application/json" })
-      stub_get("http://localhost/users/hp.json").to_return(body: {"value"=>"foo", "challenge"=>"bar"}.to_json, headers: { content_type: "application/json" })
+      stub_post("http://localhost:3000/users?api_key=test_d7fd0429940&api_username=test_user").to_return(body: fixture("user_create_success.json"), headers: { content_type: "application/json" })
+      stub_get("http://localhost:3000/users/hp.json?api_key=test_d7fd0429940&api_username=test_user").to_return(body: {"value"=>"foo", "challenge"=>"bar"}.to_json, headers: { content_type: "application/json" })
     end
 
     it "makes the post request" do
-      subject.create_user :name => "Test User", :email => "test@example.com", :password => "P@ssword", :username => "test-user"
-      expect(a_post("http://localhost/users")).to have_been_made
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      subject.create_user :name => "Test User", :email => "test2@example.com", :password => "P@ssword", :username => "test2"
+      expect(a_post("http://localhost:3000/users?api_key=test_d7fd0429940&api_username=test_user")).to have_been_made
     end
 
     it "returns success" do
-      response = subject.create_user :name => "Test User", :email => "test@example.com", :password => "P@ssword", :username => "test-user"
-      expect(response[:body]['success']).to be_true
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
+      response = subject.create_user :name => "Test User", :email => "test2@example.com", :password => "P@ssword", :username => "test2"
+      expect(response[:body]['success']).to be_truthy
     end
   end
-end
+end

data/spec/discourse_api/client_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe DiscourseApi::Client do
-  subject { DiscourseApi::Client.new('http://localhost') }
+  subject { DiscourseApi::Client.new('http://localhost:3000') }
 
   describe ".new" do
     it "requires a host argument" do
@@ -17,20 +17,20 @@ describe DiscourseApi::Client do
     end
 
     it "accepts an api key argument" do
-      client = DiscourseApi::Client.new('http://localhost', 'test')
+      client = DiscourseApi::Client.new('http://localhost:3000', 'test')
       expect(client.api_key).to eq('test')
     end
 
     it "accepts an api username argument" do
-      client = DiscourseApi::Client.new('http://localhost', 'test', 'test_user')
+      client = DiscourseApi::Client.new('http://localhost:3000', 'test', 'test_user')
       expect(client.api_username).to eq('test_user')
     end
   end
 
   describe "#api_key" do
     it "is publically accessible" do
-      subject.api_key = "test_key"
-      expect(subject.api_key).to eq("test_key")
+      subject.api_key = "test_d7fd0429940"
+      expect(subject.api_key).to eq("test_d7fd0429940")
     end
   end
 
@@ -43,7 +43,7 @@ describe DiscourseApi::Client do
 
   describe "#host" do
     it "is publically readable" do
-      expect(subject.host).to eq("http://localhost")
+      expect(subject.host).to eq("http://localhost:3000")
     end
 
     it "is not publically writeable" do
@@ -55,7 +55,7 @@ describe DiscourseApi::Client do
     it "looks like a Faraday connection" do
       expect(subject.send(:connection)).to respond_to :run_request
     end
-    it "memoizes the connection" do
+    it "memorizes the connection" do
       c1, c2 = subject.send(:connection), subject.send(:connection)
       expect(c1.object_id).to eq(c2.object_id)
     end
@@ -63,32 +63,38 @@ describe DiscourseApi::Client do
 
   describe "#delete" do
     before do
-      stub_delete("http://localhost/test/delete").with(query: { deleted: "object" })
+      stub_delete("http://localhost:3000/test/delete?api_key=test_d7fd0429940&api_username=test_user").with(query: { deleted: "object" })
     end
     it "allows custom delete requests" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.delete("/test/delete", { deleted: "object" })
-      expect(a_delete("http://localhost/test/delete").with(query: { deleted: "object" })).to have_been_made
+      expect(a_delete("http://localhost:3000/test/delete?api_key=test_d7fd0429940&api_username=test_user").with(query: { deleted: "object" })).to have_been_made
     end
   end
 
   describe "#post" do
     before do
-      stub_post("http://localhost/test/post").with(body: { created: "object"})
+      stub_post("http://localhost:3000/test/post?api_key=test_d7fd0429940&api_username=test_user").with(body: { created: "object"})
     end
 
     it "allows custom post requests" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.post("/test/post", { created: "object" })
-      expect(a_post("http://localhost/test/post").with(body: { created: "object"})).to have_been_made
+      expect(a_post("http://localhost:3000/test/post?api_key=test_d7fd0429940&api_username=test_user").with(body: { created: "object"})).to have_been_made
     end
   end
 
   describe "#put" do
     before do
-      stub_put("http://localhost/test/put").with(body: { updated: "object" })
+      stub_put("http://localhost:3000/test/put?api_key=test_d7fd0429940&api_username=test_user").with(body: { updated: "object" })
     end
-    it "allows custom delete requests" do
+    it "allows custom put requests" do
+      subject.api_key = 'test_d7fd0429940'
+      subject.api_username = 'test_user'
       subject.put("/test/put", { updated: "object" })
-      expect(a_put("http://localhost/test/put").with(body: { updated: "object" })).to have_been_made
+      expect(a_put("http://localhost:3000/test/put?api_key=test_d7fd0429940&api_username=test_user").with(body: { updated: "object" })).to have_been_made
     end
   end
 

data/spec/fixtures/category_latest_topics.json

@@ -0,0 +1 @@
+{"users":[{"id":3,"username":"fuzzy","avatar_template":"//www.gravatar.com/avatar/c0c59575e86a794d733db4ee29b2baf4.png?s={size}&r=pg&d=identicon"}],"topic_list":{"can_create_topic":true,"draft":null,"draft_key":"new_topic","draft_sequence":2,"topics":[{"id":5,"title":"About the category","fancy_title":"About the category","slug":"about-the-category","posts_count":2,"reply_count":0,"highest_post_number":2,"image_url":null,"created_at":"2014-04-16T14:10:50.950-04:00","last_posted_at":"2014-04-16T14:31:10.406-04:00","bumped":true,"bumped_at":"2014-04-17T13:35:01.102-04:00","unseen":false,"last_read_post_number":2,"unread":0,"new_posts":0,"pinned":true,"unpinned":null,"excerpt":null,"visible":true,"closed":false,"archived":false,"views":0,"like_count":0,"starred":false,"has_summary":false,"archetype":"regular","last_poster_username":"fuzzy","category_id":2,"posters":[{"extras":"latest","description":"Original Poster, Most Recent Poster","user_id":3}]},{"id":4,"title":"This is a markdown post","fancy_title":"This is a markdown post","slug":"this-is-a-markdown-post","posts_count":2,"reply_count":0,"highest_post_number":2,"image_url":null,"created_at":"2014-04-16T13:52:58.777-04:00","last_posted_at":"2014-04-16T14:31:37.371-04:00","bumped":true,"bumped_at":"2014-04-16T14:31:37.371-04:00","unseen":false,"last_read_post_number":2,"unread":0,"new_posts":0,"pinned":false,"unpinned":null,"visible":true,"closed":false,"archived":false,"views":0,"like_count":0,"starred":false,"has_summary":false,"archetype":"regular","last_poster_username":"fuzzy","category_id":2,"posters":[{"extras":"latest","description":"Original Poster, Most Recent Poster","user_id":3}]}]}}

data/spec/fixtures/user.json

@@ -1 +1 @@
-{"user":{"id":1,"username":"test-user","avatar_template":"http://try.discourse.org/uploads/try_discourse/avatars/a/b/c/{size}.gif","name":"Test User","email":"test@example.com","last_posted_at":null,"last_seen_at":"2013-11-06T21:57:26.260-05:00","bio_raw":null,"bio_cooked":null,"created_at":"2013-11-06T10:56:23.687-05:00","website":"http://example.com","can_edit":true,"can_edit_username":true,"can_edit_email":true,"stats":[{"action_type":13,"count":1,"id":null}],"can_send_private_message_to_user":false,"bio_excerpt":"I'm a test user.","trust_level":1,"moderator":false,"admin":false,"title":null,"email_digests":false,"email_private_messages":true,"email_direct":true,"email_always":false,"digest_after_days":null,"auto_track_topics_after_msecs":240000,"new_topic_duration_minutes":2880,"external_links_in_new_tab":false,"dynamic_favicon":false,"enable_quoting":true,"use_uploaded_avatar":true,"has_uploaded_avatar":true,"gravatar_template":"//www.gravatar.com/avatar/test.png?s={size}&r=pg&d=identicon","uploaded_avatar_template":"http://try.discourse.org/uploads/try_discourse/avatars/a/b/c/{size}.gif","invited_by":null}}
+{"user_badges":[],"user":{"id":1,"username":"test_user","uploaded_avatar_id":null,"avatar_template":"/letter_avatar/test/{size}/2.png","name":"Test User","email":"test_user@example.com","last_posted_at":null,"last_seen_at":"2014-09-04T08:22:19.370-04:00","bio_cooked":null,"created_at":"2014-09-04T08:04:25.104-04:00","can_edit":true,"can_edit_username":true,"can_edit_email":true,"can_edit_name":true,"stats":[{"action_type":13,"count":1,"id":null}],"can_send_private_message_to_user":true,"bio_excerpt":"<div class='missing-profile'>test hasn't entered anything in the About Me field of their profile yet</div>","trust_level":0,"moderator":false,"admin":false,"title":null,"badge_count":0,"has_title_badges":false,"custom_fields":{},"number_of_deleted_posts":0,"number_of_flagged_posts":0,"number_of_flags_given":0,"number_of_suspensions":0,"locale":null,"email_digests":true,"email_private_messages":true,"email_direct":true,"email_always":false,"digest_after_days":7,"mailing_list_mode":false,"auto_track_topics_after_msecs":240000,"new_topic_duration_minutes":2880,"external_links_in_new_tab":false,"dynamic_favicon":false,"enable_quoting":true,"muted_category_ids":[],"tracked_category_ids":[],"watched_category_ids":[],"private_messages_stats":{"all":1,"mine":0,"unread":0},"disable_jump_reply":false,"gravatar_avatar_upload_id":null,"custom_avatar_upload_id":null,"invited_by":null,"custom_groups":[],"featured_user_badge_ids":[]}}

data/spec/fixtures/user_create_success.json

@@ -1,5 +1,5 @@
 {
   "success": true,
   "active": false,
-  "message": "You're almost done! We sent an activation email to <b>test@example.com</b>. Please follow the instructions in the email to activate your account."
-}
+  "message": "You're almost done! We sent an activation email to <b>test2@example.com</b>. Please follow the instructions in the email to activate your account."
+}

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ RSpec.configure do |config|
   end
 end
 
-WebMock.disable_net_connect!
+WebMock.disable_net_connect!(:allow_localhost => true)
 
 def a_delete(path)
   a_request(:delete, path)
@@ -57,4 +57,4 @@ end
 
 def fixture(file)
   File.new(fixture_path + '/' + file)
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discourse_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-11 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -58,100 +58,100 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.18'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: rb-inotify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: Discourse API
 email:
 - sam.saffron@gmail.com
@@ -163,19 +163,22 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - discourse_api.gemspec
+- examples/create_topic.rb
+- examples/disposable_invite_tokens.rb
 - examples/example.rb
 - examples/invite_users.rb
-- examples/post_topic.rb
 - examples/topic_lists.rb
 - examples/update_user.rb
 - lib/discourse_api.rb
 - lib/discourse_api/api/categories.rb
+- lib/discourse_api/api/invite.rb
 - lib/discourse_api/api/search.rb
 - lib/discourse_api/api/topics.rb
 - lib/discourse_api/api/users.rb
@@ -189,6 +192,7 @@ files:
 - spec/discourse_api/api/users_spec.rb
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/categories.json
+- spec/fixtures/category_latest_topics.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
 - spec/fixtures/new.json
@@ -229,6 +233,7 @@ test_files:
 - spec/discourse_api/api/users_spec.rb
 - spec/discourse_api/client_spec.rb
 - spec/fixtures/categories.json
+- spec/fixtures/category_latest_topics.json
 - spec/fixtures/hot.json
 - spec/fixtures/latest.json
 - spec/fixtures/new.json