discourse_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85bfc87d0fafa517bf76b417bc63d77cc1e4981f
+  data.tar.gz: 220503a989f470fdb0b9edec7732e8b53eebf7ab
+SHA512:
+  metadata.gz: 0e78225f1b54155f57a86f147f4323c96aadfb20737a294df74cd41cb3eda9cc9ed95578bbbd9c5bfdfef6563b6798fe357ba4e2d8cbd533d8a7b5988e9f09e3
+  data.tar.gz: 9390284acb2d3b7660dabeae0fdcc953e4f4707772977f88ee295020901430d17285550c4163efa0ef6ff10bd5804147f0601a97a8aa06f5e62cf1553d434588

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: 'bundle exec rake test'

data/Gemfile

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

data/Guardfile

@@ -0,0 +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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Discourse
+
+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

@@ -0,0 +1,55 @@
+# DiscourseApi
+
+[![Build Status](https://travis-ci.org/discourse/discourse_api.pong?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/discourse/discourse_api.png)][codeclimate]
+
+[travis]: http://travis-ci.org/discourse/discourse_api
+[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")
+
+# 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
+
+```
+
+
+## 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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec

data/discourse_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'discourse_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "discourse_api"
+  spec.version       = DiscourseApi::VERSION
+  spec.authors       = ["Sam Saffron", "John Paul Ashenfelter", "Michael Herold"]
+  spec.email         = ["sam.saffron@gmail.com", "john@ashenfelter.com", "michael.j.herold@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.files         = `git ls-files`.split($/)
+  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.add_dependency "faraday", "~> 0.8.8"
+  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"
+end

data/examples/example.rb

@@ -0,0 +1,7 @@
+# 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')
+puts client.latest

data/examples/invite_users.rb

@@ -0,0 +1,10 @@
+# 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.topic_invite_user(topic_id: 1, email: "bob@bob.com")

data/examples/post_topic.rb

@@ -0,0 +1,16 @@
+# 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 = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+client.post_create(
+  category: "Boing Boing",
+  skip_validations: true,
+  auto_track: false,
+  title: "Concert Master: A new way to choose",
+  raw: "This is the raw markdown for my post"
+)

data/examples/topic_lists.rb

@@ -0,0 +1,13 @@
+# 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 = "YOUR_API_KEY"
+client.api_username = "YOUR_USERNAME"
+
+puts client.topics_latest({})
+puts client.topics_hot({})
+puts client.categories({})
+

data/examples/update_user.rb

@@ -0,0 +1,14 @@
+# 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 = "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")

data/lib/discourse_api.rb

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

data/lib/discourse_api/api/categories.rb

@@ -0,0 +1,10 @@
+module DiscourseApi
+  module API
+    module Categories
+      def categories(*args)
+        response = get('/categories.json', args)
+        response[:body]['category_list']['categories']
+      end
+    end
+  end
+end

data/lib/discourse_api/api/search.rb

@@ -0,0 +1,16 @@
+module DiscourseApi
+  module API
+    module Search
+      # Returns search results that match the specified term.
+      #
+      # @param term [String] a search term
+      # @param options [Hash] A customizable set of options
+      # @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[:body]
+      end
+    end
+  end
+end

data/lib/discourse_api/api/topics.rb

@@ -0,0 +1,35 @@
+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
+      end
+
+      def latest_topics(*args)
+        response = get('/latest.json', args)
+        response[:body]['topic_list']['topics']
+      end
+
+      def new_topics(*args)
+        response = get("/new.json", args)
+        response[:body]['topic_list']['topics']
+      end
+
+      def topic(id, *args)
+        response = get("/t/#{id}.json", args)
+        response[:body]
+      end
+
+      def topics_by(username, *args)
+        response = get("/topics/created-by/#{username}.json", args)
+        response[:body]['topic_list']['topics']
+      end
+    end
+  end
+end

data/lib/discourse_api/api/users.rb

@@ -0,0 +1,30 @@
+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 user(username, *args)
+        response = get("/user/#{username}.json", args)
+        response[:body]['user']
+      end
+
+      def update_avatar(username, file)
+        put("/users/#{username}/preferences/avatar", { file: file })
+      end
+
+      def update_email(username, email)
+        put("/users/#{username}/preferences/email", { email: email })
+      end
+
+      def update_user(username, *args)
+        put("/users/#{username}", args)
+      end
+
+      def update_username(username, new_username)
+        put("/users/#{username}/preferences/username", { new_username: new_username })
+      end
+    end
+  end
+end

data/lib/discourse_api/client.rb

@@ -0,0 +1,76 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'discourse_api/version'
+require 'discourse_api/api/categories'
+require 'discourse_api/api/search'
+require 'discourse_api/api/topics'
+require 'discourse_api/api/users'
+
+module DiscourseApi
+  class Client
+    attr_accessor :api_key, :api_username
+    attr_reader :host
+
+    include DiscourseApi::API::Categories
+    include DiscourseApi::API::Search
+    include DiscourseApi::API::Topics
+    include DiscourseApi::API::Users
+
+    def initialize(host, api_key=nil, api_username=nil)
+      @host = host
+      @api_key = api_key
+      @api_username = api_username
+    end
+
+    def connection_options
+      @connection_options ||= {
+          url: @host,
+          headers: {
+              accept: 'application/json',
+              user_agent: user_agent,
+          }
+      }
+    end
+
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    def post(path, params={})
+      request(:post, path, params)
+    end
+
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+    def user_agent
+      @user_agent ||= "DiscourseAPI Ruby Gem #{DiscourseApi::VERSION}"
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new connection_options do |conn|
+        # Convert request params to "www-form-encoded"
+        conn.request :url_encoded
+        # Parse responses as JSON
+        conn.response :json
+        # Use Faraday's default HTTP adapter
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def request(method, path, params={})
+      response = connection.send(method.to_sym, path, params)
+      response.env
+    rescue Faraday::Error::ClientError, JSON::ParserError
+      raise DiscourseApi::Error
+    end
+  end
+end

data/lib/discourse_api/error.rb

@@ -0,0 +1,14 @@
+module DiscourseApi
+  class Error < StandardError
+    attr_reader :wrapped_exception
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @return [DiscourseApi::Error]
+    def initialize(exception=$!)
+      @wrapped_exception = exception
+      exception.respond_to?(:message) ? super(exception.message) : super(exception.to_s)
+    end
+  end
+end

data/lib/discourse_api/version.rb

@@ -0,0 +1,3 @@
+module DiscourseApi
+  VERSION = "0.1.1"
+end