Skip to content
This repository has been archived by the owner on Dec 8, 2017. It is now read-only.

Latest commit

 

History

History
115 lines (81 loc) · 2.24 KB

README.md

File metadata and controls

115 lines (81 loc) · 2.24 KB

Build Status Code Climate Coverage Status

answers-ruby-client

Low level Ruby access to the Answers Platform API

Installation

gem 'answers-ruby-client'
gem install answers-ruby-client

Usage

Synopsis

require 'answers'

Answers.init

questions = Answers::Question.all
questions.each do |question|
  p question.id
  p question.text
end

answers = Answers::Answer.all
answers.each do |answer|
  p answer.id
  p answer.text
  p answer.question_id
  q = Answers::Question.find(question.id)
  p q.text
end

# write API (requires authentication)

Answers.init({
  user_email: 'person@email.tld',
  user_token: '1234567890qwertyuiop'
})

question = Answers::Question.new
question.text = 'Is this a question?'
question.save

answer = Answers::Answer.new
answer.text = 'Yes, this is a question.'
answer.question_id = question.id
answer.save

CRUD

Create

Answers::Question.new(text: 'hello').save
Answers::Answer.new(text: 'hello').save

Read

Answers.Question.find(1)
Answers.Answer.find(1)

Update

a = Answers::Question.find(1)
a.text = 'new_text'
a.save

Delete

a = Answers::Question.find(1)
a.text = 'new_text'
a.delete

Question attributes

  • id (Integer)
  • text (String) - the text of the question
  • in_language (String) - the language of the question
  • need_to_know (String)

Answer

  • text (String) - the text of the answer
  • in_language (String) - the language of the answer
  • question_id (Integer) - the

Contributing

  1. Fork it ( https://github.com/18F/answers-ruby-client/fork )
  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 a new Pull Request

License

Public Domain. See LICENSE.txt.