answers-ruby-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baa9d4aa429677971fc5b480e3e707cbfed9b1ce
+  data.tar.gz: 7423cfd98e65fb3c5dc193bcbda66279d5da54f8
+SHA512:
+  metadata.gz: 0d57390aaea67e5c27465e2cac93764a4081681ed81f316d253a4542f65118b6f87ea0f88e509ae9df1949b70a3fc78f40280e71c716db2d6aff7853df1376d4
+  data.tar.gz: 55e1a087acd6fe116e5db5b7f65f4c5004e9800ad4ee4980cb1f4f4d9e05277a3b902502458f420cf5450c4abdc14403e08b62f74439d9580740165f49bb4361

data/.env.example

@@ -0,0 +1,2 @@
+ANSWERS_USER_EMAIL=your@username.example
+ANSWERS_USER_TOKEN=your_user_tOkEn

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/.rbenv-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in answers-ruby-client.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org>

data/README.md

@@ -0,0 +1,120 @@
+[![Build Status](https://travis-ci.org/18F/answers-ruby-client.svg?branch=master)](https://travis-ci.org/18F/answers-ruby-client) [![Code Climate](https://codeclimate.com/github/18F/answers-ruby-client.png)](https://codeclimate.com/github/18F/answers-ruby-client) [![Coverage Status](https://coveralls.io/repos/18F/answers-ruby-client/badge.png)](https://coveralls.io/r/18F/answers-ruby-client)
+
+# answers-ruby-client
+
+Low level Ruby access to the [Answers Platform](https://github.com/18F/answers) API
+
+## Installation
+
+```ruby
+gem 'answers-ruby-client'
+```
+
+```sh
+gem install answers-ruby-client
+```
+
+## Usage
+
+### Synopsis
+
+```ruby
+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
+
+```ruby
+Answers::Question.new(text: 'hello').save
+Answers::Answer.new(text: 'hello').save
+```
+
+#### Read
+
+```ruby
+Answers.Question.find(1)
+Answers.Answer.find(1)
+```
+
+#### Update
+
+```ruby
+a = Answers::Question.find(1)
+a.text = 'new_text'
+a.save
+```
+
+#### Delete
+
+```ruby
+a = Answers::Question.find(1)
+a.text = 'new_text'
+a.delete
+```
+
+### Question attributes
+
+- `id` (`Integer`)
+- `created_at` (`String`)
+- `updated_at` (`String`)
+- `text` (`String`) - the text of the question
+- `in_language` (`String`) - the language of the question
+- `need_to_know` (`String`)
+
+
+### Answer
+
+- `id` (`Integer`)
+- `created_at` (`String`)
+- `updated_at` (`String`)
+- `text` (`String`) - the text of the answer
+- `in_language` (`String`) - the language of the answer
+- `question_id` (`Integer`) - the id of the question that the Answer belongs to
+
+## 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.

data/Rakefile

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

data/answers-ruby-client.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'answers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "answers-ruby-client"
+  spec.version       = Answers::VERSION
+  spec.authors       = ["Alan deLevie"]
+  spec.email         = ["alan.delevie@gsa.gov"]
+  spec.summary       = %q{Low level Ruby client to access the Answers Platform API.}
+  spec.description   = %q{Access the the Answers Platform's read/write API in idiomatic Ruby.}
+  spec.homepage      = ""
+  spec.license       = "Public Domain (see LICENSE.txt)"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+    
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "activesupport"
+end

data/lib/answers-ruby-client.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'answers/protocol'
+require 'answers/client'
+require 'answers/version'
+require 'answers/error'
+require 'answers/base_model'
+
+require 'answers/question'
+require 'answers/answer'
+
+module Answers
+end

data/lib/answers/answer.rb

@@ -0,0 +1,40 @@
+require 'active_support/inflector'
+
+module Answers
+  class Answer < BaseModel
+  
+    ANSWER_ATTRS = [
+      {name: :id, read_only: true},
+      {name: :created_at, read_only: true},
+      {name: :updated_at, read_only: true},
+      {name: :text, read_only: false},
+      {name: :in_language, read_only: false},
+      {name: :question_id, read_only: false}
+    ]
+  
+    ANSWER_ATTRS.each do |attribute|
+      attr_fn = attribute[:read_only] ? :attr_reader : :attr_accessor
+      send(attr_fn, attribute[:name])
+    end
+  
+    def initialize(params={})
+      ANSWER_ATTRS.each do |attribute|
+        instance_variable_set("@#{attribute[:name]}", params[attribute[:name]]) if params[attribute[:name]]
+      end
+      update_attributes!(params)
+    end
+  
+    def attributes
+      ivar_to_sym = Proc.new {|ivar| ivar.to_s.sub(/^@/, '').to_sym}
+      
+      attributes = instance_variables.inject({}) do |r, s|
+        r.merge!({ivar_to_sym[s] => instance_variable_get(s)})
+      end.delete_if do |k,v|
+        !ANSWER_ATTRS.map {|attribute| attribute[:name]}.include?(ivar_to_sym[k])
+      end 
+      
+      attributes
+    end
+
+  end
+end

data/lib/answers/base_model.rb

@@ -0,0 +1,79 @@
+module Answers
+  class BaseModel
+    
+    def new?
+      @id.nil?
+    end
+    
+    def self.resource_name
+      to_s.demodulize.downcase.to_sym
+    end
+    
+    def resource_name
+      self.class.resource_name
+    end
+    
+    def self.hash_key
+      self.resource_name.to_s.pluralize
+    end
+    
+    def hash_key
+      self.class.hash_key
+    end
+    
+    def self.find(id)
+      response = Answers.client.get(Protocol.uri(resource_name, id))
+      
+      if response.has_key?('status')
+        if response['status']
+          return nil
+        end
+      end
+      
+      item_hash = response[hash_key].first
+      item = new(item_hash)
+          
+      item
+    end
+    
+    def self.all
+      response = Answers.client.get(Protocol.uri(resource_name))
+      items = response[hash_key]
+      
+      items.map {|i| new(i)}
+    end
+    
+    def save
+      body   = attributes.delete_if {|k,v| v.nil?} 
+      path   = new? ? Protocol.uri(resource_name) : Protocol.uri(resource_name, @id)
+      method = new? ? :post : :put
+    
+      response = Answers.client.send(method, path, body)
+      item_hash = response[hash_key].first
+
+      update_attributes!(item_hash)
+    
+      self
+    end
+  
+    def delete
+      raise Answers::Error.new("Cannot delete unsaved object.") if new?
+      response = Answers.client.delete(Protocol.uri(resource_name, @id))
+    
+      response
+    end
+    
+    private
+  
+      def update_attributes!(attributes)
+        attributes.each_pair do |key, value|
+          update_attribute!(key.to_sym, value)
+        end
+      end
+  
+      def update_attribute!(attribute_name, attribute_value)
+        instance_variable_set("@#{attribute_name}", attribute_value)
+      end
+  
+  end
+end

data/lib/answers/client.rb

@@ -0,0 +1,111 @@
+require 'faraday'
+require 'json'
+
+require 'answers/protocol'
+
+module Answers
+  
+  def self.init(config = {})
+    # check env vars by default
+    defaulted = {
+      user_email: ENV['ANSWERS_USER_EMAIL'],
+      user_token: ENV['ANSWERS_USER_TOKEN']
+    }
+    # if credentials are passed, overwrite the defaults
+    defaulted.merge!(config)
+        
+    # instantiate a client
+    @@client = Client.new(config)
+  end
+  
+  def self.client?
+    return false if (defined?(@@client)).nil?
+    return false if @@client.nil?
+    
+    true
+  end
+  
+  # erases the current client, if one exists
+  def self.reset!
+    return if !client?
+    #return if (defined?(@@client)).nil?
+    @@client = nil
+    return
+  end
+  
+  # initialized client accessible from the Answers singleton
+  def self.client
+    if !client?
+      raise Answers::Error.new "Answers Platform API not initialized. Call Answers.init."
+    end
+    
+    @@client
+  end
+  
+  class Client
+    attr_reader :connection
+    
+    def initialize(config = {})
+      # use the default
+      url = Protocol::BASE_PATH
+      
+      # or use the provided url, if one is provided
+      if config[:url]
+        url = config[:url]
+      end
+      
+      # put it in a hash
+      faraday_defaults = {
+        url: url 
+      }
+      
+      @connection = Faraday.new(faraday_defaults) do |faraday|
+        #faraday.response :logger                  # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.headers['Content-Type'] = Protocol::DEFAULT_CONTENT_TYPE
+        faraday.headers[Protocol::EMAIL_HEADER_KEY] = config[:user_email] if config[:user_email]
+        faraday.headers[Protocol::TOKEN_HEADER_KEY] = config[:user_token] if config[:user_token]
+      end
+    end
+    
+    def request(method, path, &block)
+      response = @connection.send(method) do |req|
+        req.url(path)
+        block.call(req) if block_given?
+      end
+      
+      handle_response(response)
+    end
+    
+    def get(path, params=nil)
+      request(:get, path) do |req|
+        req.params = params if params
+      end
+    end
+    
+    def post(path, body=nil)
+      request(:post, path) do |req|
+        req.body = body.to_json if body
+      end
+    end
+    
+    def put(path, body=nil)
+      request(:put, path) do |req|
+        req.body = body.to_json if body
+      end
+    end
+    
+    def delete(path)
+      request(:delete, path)
+    end
+    
+    def handle_response(response)
+      if response.status == 401
+        raise Answers::Error.new "401 Unauthorized"
+      end
+        JSON.parse(response.body)
+    end
+  
+  end
+
+end