quandora 0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Hamid
+
+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,178 @@
+# Quandora
+
+a simple gem to connect to the [quandora](https://www.quandora.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quandora'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quandora
+
+
+## Configuration
+
+Add this to your `config/application.rb`.
+
+```ruby
+Quandora.configure do |config|
+  config.url = 'https://example.quandora.com/m/json'
+  config.username = 'example@example.com'
+  config.password = 'password'
+end
+
+# Alternative way to configure
+
+config = Quandora::Configuration.new
+config.url = 'https://example.quandora.com/m/json'
+config.username = 'example@example.com'
+config.password = 'password'
+```
+
+## Usage
+
+```ruby
+activity apis:
+index: Quandora.activity.index
+
+------------------------------------------------------
+
+badges apis:
+index: Quandora.badges.index
+
+------------------------------------------------------
+
+end points apis:
+index: Quandora.end_points.index
+
+------------------------------------------------------
+
+users apis:
+index: Quandora.end_points.index
+show: Quandora.end_points.show(user_id)
+me: Quandora.end_points.me
+create: Quandora.end_points.create(args)
+the args it must be:
+{
+  "email": "email",
+  "password": "password",
+  "firstName": "first_name",
+  "lastName": "last_name",
+  "title": "title",
+  "isManager": "is_manager",
+  "aliases": "aliases",
+  "groups": "groups"
+}
+
+------------------------------------------------------
+
+bases apis:
+index: Quandora.bases.index
+questions: Quandora.bases.questions('base_id')
+show: Quandora.bases.show('base_id')
+ask: Quandora.bases.ask('base_id', args)
+the args it must be:
+{
+  "title": "title",
+  "content": "content",
+  "content_type": "default is markdown"
+}
+
+follow: Quandora.bases.follow('base_id')
+mlt: Quandora.bases.mlt('base_id')
+
+bases tags apis:
+index: Quandora.bases.tag('base_id').list
+show: Quandora.bases.tag('base_id').show('tag_name')
+
+create: Quandora.bases.tag('base_id').create(args)
+the args it must be:
+{
+  "name": "name",
+  "url": "url",
+  "content": "content"
+}
+
+udpate: Quandora.bases.tag('base_id').udpate(args)
+the args it must be:
+{
+  "uid": "uid",
+  "content": "content"
+}
+
+delete: Quandora.bases.tag('base_id').delete('tag_name')
+
+bases reports apis:
+asked: Quandora.bases.report('base_id').asked
+users_reputation_change: Quandora.bases.report('base_id').users_reputation_change
+most_voted_question: Quandora.bases.report('base_id').most_voted_question
+
+------------------------------------------------------
+
+question apis:
+detail: Quandora.question.detail('question_id')
+view: Quandora.question.view('question_id')
+mlt: Quandora.question.mlt('question_id')
+
+answer: Quandora.question.answer('question_id', args)
+the args it must be:
+{
+  "content_type": "default is markdown",
+  "content": "content"
+}
+
+vote: Quandora.question.vote('question_id', args)
+the args it must be:
+{
+  "data": "true or false"
+}
+
+question tag apis:
+set: Quandora.question.tag('question_id').set('tag1,tag2,tag3')
+add: Quandora.question.tag('question_id').add('tag1,tag2,tag3')
+
+question comments apis:
+create: Quandora.question.comment('question_id').create(args)
+the args it must be:
+{
+  'comment': 'comment'
+}
+
+update: Quandora.question.comment('question_id').update(args)
+the args it must be:
+{
+  'comment': 'comment',
+  'hash': 'hash',
+}
+
+delete: Quandora.question.comment('question_id').delete('hash')
+```
+
+For more information please go to the [quandora api document](https://www.quandora.com/quandora-rest-api-documentation/)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/quandora. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Quandora project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/quandora/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "quandora"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/quandora.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'faraday'
+require "quandora/version"
+require "quandora/configuration"
+
+# api calls
+require "quandora/request"
+require "quandora/activity"
+require "quandora/answer"
+require "quandora/badges"
+require "quandora/bases"
+require "quandora/comment"
+require "quandora/end_points"
+require "quandora/question"
+require "quandora/report"
+require "quandora/tag"
+require "quandora/users"
+
+module Quandora
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    [
+      :activity, :question, :badges, :bases,
+      :end_points, :report, :users
+    ].each do |api|
+      define_method :"#{api}" do |args = {}|
+        @conn = Faraday.new(url: configuration.url) do |conn|
+          conn.adapter Faraday.default_adapter # make requests with Net::HTTP
+          conn.basic_auth(configuration.username, configuration.password)
+        end
+
+        find_api(api).new(@conn, api, args)
+      end
+    end
+
+    def find_api(api)
+      class_name = api.to_s.split('_').collect(&:capitalize).join
+      Object.const_get("Quandora::#{class_name}")
+    end
+  end
+end

data/lib/quandora/activity.rb

@@ -0,0 +1,8 @@
+# index
+
+class Quandora::Activity < Quandora::Request
+  def index(args = {})
+    @params.merge!("userId": args["user_id"]) unless args.fetch('user_id', nil).nil?
+    super
+  end
+end

data/lib/quandora/answer.rb

@@ -0,0 +1,29 @@
+class Quandora::Answer < Quandora::Request
+  def vote(answer_id, args)
+    body = {
+      "type": "boolean",
+      "data": args["vote"]
+    }
+
+    resp = @conn.post("a/#{id}/vote") do |req|
+      req.body = body.to_s
+      req.headers['Content-Type'] = 'application/json'
+    end
+  end
+
+  def accept(answer_id, args)
+    body = {
+      "type": "boolean",
+      "data": args["accept"]
+    }
+
+    resp = @conn.post("a/#{id}/accept") do |req|
+      req.body = body.to_json
+      req.headers['Content-Type'] = 'application/json'
+    end
+  end
+
+  def comment(answer_id)
+    Comment.new(@conn, "a", answer_id)    
+  end
+end

data/lib/quandora/badges.rb

@@ -0,0 +1,2 @@
+class Quandora::Badges < Quandora::Request
+end

data/lib/quandora/bases.rb

@@ -0,0 +1,51 @@
+class Quandora::Bases < Quandora::Request
+  def list
+    @api = "kb/"
+    index
+  end
+
+  def questions(base_id, args = {})
+    @api = "kb/#{base_id}/list"
+    @params.merge!("o": args["o"]) unless args.fetch('o', nil).nil?
+    @params.merge!("l": args["l"]) unless args.fetch('l', nil).nil?
+    @params.merge!("q": args["q"]) unless args.fetch('q', nil).nil?
+    @params.merge!("tag": args["tag"]) unless args.fetch('tag', nil).nil?
+    @params.merge!("s": args["s"]) unless args.fetch('s', nil).nil?
+    index
+  end
+
+  def mlt(base_id, args = {})
+    @api = "kb/#{base_id}/mlt"
+    @params.merge!("q": args["q"]) unless args.fetch('q', nil).nil?
+    index
+  end
+
+  def ask(base_id, args = {})
+    body = {
+      "type": "post-question",
+      "data": {
+        "title": args["title"],
+        "content": args["content"],
+        "contentType": args["content_type"] || "markdown"
+      }
+    }
+
+    resp = @conn.post("kb/#{base_id}/ask") do |req|
+      req.body = body.to_json
+      req.headers['Content-Type'] = 'application/json'
+    end
+  end
+
+  def follow(base_id, args = {})
+    @api = "kb/#{base_id}/follow"
+    index
+  end
+
+  def tag(kb_id)
+    Quandora::Tag.new(@conn, "kb", kb_id)    
+  end
+
+  def report(kb_id)
+    Quandora::Report.new(@conn, "kb", kb_id)    
+  end
+end

data/lib/quandora/comment.rb

@@ -0,0 +1,40 @@
+class Quandora::Comment
+  def initialize(conn, api, id)
+    @conn = conn
+    @api = api
+    @id = id
+  end
+
+  def create(args)
+    body = {
+      "type": "post-comment",
+      "data": {
+        "content": args["comment"]
+      }
+    }
+
+    resp = @conn.post("#{@api}/#{@id}/comment") do |req|
+      req.body = body.to_s
+      req.headers['Content-Type'] = 'application/json'
+    end
+  end
+
+  def update(args)
+    body = {
+      "type": "post-comment",
+      "data": {
+        "content": args["comment"],
+        "hash": args["hash"]
+      }
+    }
+
+    resp = @conn.put("#{@api}/#{@id}/comment") do |req|
+      req.body = body.to_s
+      req.headers['Content-Type'] = 'application/json'
+    end
+  end
+
+  def delete(hash)
+    resp = @conn.delete("#{@api}/#{@id}/comment/#{hash}")
+  end
+end

data/lib/quandora/configuration.rb

@@ -0,0 +1,11 @@
+module Quandora
+  class Configuration
+    attr_accessor :url, :username, :password
+
+    def initialize
+      @url = ''
+      @username = ''
+      @password = ''
+    end
+  end
+end

data/lib/quandora/end_points.rb

@@ -0,0 +1,6 @@
+class Quandora::EndPoints < Quandora::Request
+  def index(args = {})
+    @api = ""
+    super
+  end
+end