poptart 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 865e91a53026b224e7979cf26cbc977dedaa826b
+  data.tar.gz: 602e1c41cbfd6dde4cdcc4bbab922c04d8186f73
+SHA512:
+  metadata.gz: 78ac46448e35b3c2ea93fb1ceebf37621dae715e3bb212818e7ab587bd154ea33515c6e7dce8d66126d13a489b279383d5de77db8818b1f3e52bd65877d67548
+  data.tar.gz: 653ee77984bccdd17d6480ac8f4304191b847a76a09270fa007b32ad2b5d3cb374cb937dd6e80821a23b09df8324accef93386f46753f2aa981694c10afdfaad

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+pkg
+tags
+.rbenv-version
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    poptart (0.0.1)
+      activesupport (~> 3.2.13)
+      faraday
+      hashie
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    bourne (1.5.0)
+      mocha (>= 0.13.2, < 0.15)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.0.9)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.4)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    guard (2.0.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.0)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.0.0)
+      guard (~> 2.0)
+      rspec (~> 2.14)
+    hashie (2.1.1)
+    i18n (0.6.9)
+    listen (2.1.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    metaclass (0.0.1)
+    method_source (0.8.2)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    safe_yaml (0.9.7)
+    slop (3.4.6)
+    thor (0.18.1)
+    timers (1.1.0)
+    vcr (2.6.0)
+    webmock (1.14.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bourne (= 1.5.0)
+  guard
+  guard-rspec
+  mocha (~> 0.14.0)
+  poptart!
+  pry
+  rake
+  rspec
+  vcr
+  webmock

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+desc "Run specs"
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = './spec/**/*_spec.rb'
+  end
+end
+
+namespace :spec do
+  task :clean do
+    FileUtils.rm_rf(Dir.glob('spec/vcr/*'))
+  end
+end

data/lib/poptart/model.rb

@@ -0,0 +1,17 @@
+module Poptart
+  class Model
+    attr_accessor :id, :links, :params
+
+    def initialize(response)
+      if response.respond_to?(:has_key?)
+        @params = response
+      else
+        raise "Unauthorized"if response.status == 401
+        @params = JSON.parse(response.body)
+      end
+
+      @id = @params['id']
+      @links = Hashie::Mash.new(@params['_links'])
+    end
+  end
+end

data/lib/poptart/question.rb

@@ -0,0 +1,19 @@
+module Poptart
+  class Question < Model
+    extend Poptart::Request
+
+    def self.all(params = {})
+      root = Poptart::Root.get_root
+      response = get(root.links.questions.href)
+      JSON.parse(response.body).map do |question|
+        if params[:type]
+          if question['question_type'] == params[:type]
+            new(question)
+          end
+        else
+          new(question)
+        end
+      end.compact
+    end
+  end
+end

data/lib/poptart/request.rb

@@ -0,0 +1,48 @@
+module Poptart
+  module Request
+    def get(url, headers = {})
+      connection.get do |req|
+        req.url(url)
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['API-TOKEN'] = Poptart.api_token if Poptart.api_token
+        req.headers.merge!(headers)
+      end
+    end
+
+    def put(url, data, headers = {})
+      connection.put do |req|
+        req.url(url)
+        req.body = data.to_json if data
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['API-TOKEN'] = Poptart.api_token if Poptart.api_token
+        req.headers.merge!(headers)
+      end
+    end
+
+    def post(url, data, headers = {})
+      connection.post do |req|
+        req.url(url)
+        req.body = data.to_json if data
+        req.headers['Content-Type'] = 'application/json'
+        req.headers['API-TOKEN'] = Poptart.api_token if Poptart.api_token
+        req.headers.merge!(headers)
+      end
+    end
+
+    def connection
+      return @connection if @connection
+
+      # if Rails.env.production?
+        # url = ""
+      # else
+        url = "http://localhost:3000"
+      # end
+
+      @connection = Faraday.new(:url => url) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/poptart/root.rb

@@ -0,0 +1,11 @@
+module Poptart
+  class Root < Model
+    extend Poptart::Request
+    attr_accessor :links
+
+    def self.get_root
+      response =  get("/")
+      Poptart::Root.new(response)
+    end
+  end
+end

data/lib/poptart/survey.rb

@@ -0,0 +1,37 @@
+module Poptart
+  class Survey < Model
+    include Poptart::Request
+    attr_accessor :user_id, :survey_questions
+
+    def initialize(response)
+      super
+      @user_id = params['user_id']
+
+      @survey_questions = params['survey_questions'].map do |survey_question|
+        if survey_question['type'] == 'BooleanQuestion'
+          BooleanQuestion.new(survey_question)
+        else
+          SurveyQuestion.new(survey_question)
+        end
+      end.sort_by { |survey_question| survey_question.id }
+    end
+
+    def add_question(question)
+      response = post("#{links.self.href}/survey_questions",
+                                      { survey_question: { question_id: question.id } } )
+      response.status == 201
+    end
+
+    def survey_question_for_id(id)
+      survey_questions.find do |survey_question|
+        survey_question.id == id.to_i
+      end
+    end
+
+    def next_question
+      if links['next']
+        SurveyQuestion.for_url(links['next']['href'])
+      end
+    end
+  end
+end

data/lib/poptart/survey_question.rb

@@ -0,0 +1,42 @@
+module Poptart
+  class SurveyQuestion < Model
+    extend Poptart::Request
+    include Poptart::Request
+
+    attr_accessor :text, :answer, :type, :responses
+
+    def initialize(response)
+      super
+      @text = params['text']
+      @answer = params['answer']
+      @type = params['type']
+      @freeform = params['freeform']
+      @responses = params['responses']
+    end
+
+    def boolean?
+      type == "boolean"
+    end
+
+    def multiple?
+      type == "multiple"
+    end
+
+    def range?
+      type == "range"
+    end
+
+    def time?
+      type == "time"
+    end
+
+    def freeform?
+      @freeform == true
+    end
+
+    def submit
+      response = put(links.submit.href, { id: id, survey_question: { answer: answer} })
+      response.status == 204
+    end
+  end
+end

data/lib/poptart/user.rb

@@ -0,0 +1,46 @@
+module Poptart
+  class User < Model
+    extend Poptart::Request
+    include Poptart::Request
+    attr_accessor :external_user_id, :token
+
+    def initialize(response)
+      super
+      @external_user_id = params['external_user_id']
+      @token = params['token']
+    end
+
+    def self.create(external_user_id)
+      root = Poptart::Root.get_root
+      response = post(root.links.users.href, user: { external_user_id: external_user_id })
+      Poptart::User.new(response)
+    end
+
+    def self.for_id(external_user_id)
+      root = Poptart::Root.get_root
+      response = get("#{root.links.users.href}/#{external_user_id}")
+      Poptart::User.new(response)
+    end
+
+    def create_survey
+      root = Poptart::Root.get_root
+      response = post(root.links.surveys.href, survey: { user_id: id })
+      Poptart::Survey.new(response)
+    end
+
+    def create_random_survey
+      response = post("/api/surveys?random=true", survey: { user_id: id })
+      Poptart::Survey.new(response)
+    end
+
+    def survey_for_id(id)
+      response = get("/api/surveys/#{id}")
+      Poptart::Survey.new(response)
+    end
+
+    def survey_for_url(url)
+      response = get(url)
+      Survey.new.extend(SurveyRepresenter).from_json(response.body)
+    end
+  end
+end

data/lib/poptart.rb

@@ -0,0 +1,22 @@
+module Poptart
+  def self.api_token=(token)
+    @token = token
+  end
+
+  def self.api_token
+    @token
+  end
+end
+
+require 'faraday'
+require 'json'
+require 'hashie'
+
+require_relative 'version'
+require_relative 'poptart/model'
+require_relative 'poptart/request'
+require_relative 'poptart/root'
+require_relative 'poptart/survey'
+require_relative 'poptart/survey_question'
+require_relative 'poptart/question'
+require_relative 'poptart/user'

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Poptart
+  VERSION = "0.0.1"
+end

data/poptart.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'poptart'
+  gem.version       = Poptart::VERSION
+  gem.authors       = ['Austen Ito']
+  gem.email         = ['austen.dev@gmail.com']
+  gem.homepage      = 'https://github.com/austenito/poptart'
+  gem.summary       = 'The API client gem for the happines service'
+  gem.description   = gem.summary
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+  gem.license = 'MIT'
+
+  gem.add_dependency 'activesupport', "~> 3.2.13"
+  gem.add_dependency 'hashie'
+  gem.add_dependency 'faraday'
+
+  gem.add_development_dependency 'bourne', "1.5.0"
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'mocha', "~> 0.14.0"
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+end

data/spec/requests/answering_survey_questions_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe 'Answering survey questions', :vcr do
+  it "creates and returns an empty survey" do
+    user = Poptart::User.create(42)
+    survey = user.create_survey
+    survey.user_id.should == user.id
+    survey.survey_questions.count.should == 0
+  end
+
+  it "creates and returns a random question survey" do
+    user = Poptart::User.create(42)
+    survey = user.create_random_survey
+    survey.user_id.should == user.id
+    survey.survey_questions.count.should == 5
+  end
+
+  it "answers a survey question" do
+    user = Poptart::User.create(42)
+    survey = user.create_random_survey
+    survey_question = survey.survey_questions.first
+    survey_question.text.should be
+    survey_question.answer = "foo"
+    survey_question.submit.should be
+
+    survey = user.survey_for_id(survey.id)
+    survey.survey_questions.first.answer.should == "foo"
+  end
+
+  it "answers a survey question", record: :all do
+    boolean_questions = Poptart::Question.all(type: 'boolean')
+    user = Poptart::User.create(42)
+    survey = user.create_survey
+    survey.add_question(boolean_questions.first).should be
+
+    survey = user.survey_for_id(survey.id)
+    survey.survey_questions.count.should == 1
+    survey_question = survey.survey_questions.first
+    survey_question.responses.should == ['t', 'f']
+    survey_question.type.should == 'boolean'
+
+    survey_question.answer = 'true'
+    survey_question.submit.should be
+
+    survey = user.survey_for_id(survey.id)
+    survey.survey_questions.first.answer.should == 'true'
+  end
+
+  it "finds survey question for id" do
+    user = Poptart::User.create(42)
+    survey = user.create_random_survey
+    first_survey_question = survey.survey_questions.first
+    survey_question = survey.survey_question_for_id(first_survey_question.id)
+    first_survey_question.should == survey_question
+  end
+end

data/spec/requests/root_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Poptart::Root do
+  it "returns survey links", :vcr do
+    root = Poptart::Root.get_root
+    root.links.self.href.should == 'http://localhost:3000/api'
+  end
+end

data/spec/requests/user_management_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "User Management", :vcr do
+  it "creates a user" do
+    user = Poptart::User.create(42)
+    user.id.should be
+    user.external_user_id.should == 42
+    user.token.should be
+  end
+
+  it "returns a user" do
+    user = Poptart::User.create(43)
+    other_user = Poptart::User.for_id(user.external_user_id)
+    user.id.should == other_user.id
+    user.external_user_id.should == other_user.external_user_id
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,68 @@
+require_relative "../lib/poptart"
+
+require 'mocha/api'
+require 'bourne'
+require 'vcr'
+
+require 'active_support/inflector'
+require 'pry/test/helper'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  c.around(:each, :vcr) do |example|
+    name = example.metadata[:full_description].split(/\s+/, 2).join("/").underscore.gsub(/[^\w\/]+/, "_")
+    options = {}
+    options[:record] = example.metadata[:record] if example.metadata[:record]
+    VCR.use_cassette(name, options) { example.call }
+  end
+
+  include PryTestHelpers
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir        = 'spec/vcr'
+  c.hook_into                   :webmock
+
+  c.default_cassette_options    = {
+    :record                     => :once,
+    :decode_compressed_response => true,
+    # Because psych is binary encoding response headers marked with ASCII-8BIT
+    # https://groups.google.com/forum/?fromgroups#!topic/vcr-ruby/2sKrJa86ktU
+    # And syck's output is much easier to read
+    :serialize_with             => :psych,
+  }
+
+  # Pretty print your json so it's not all on one line
+  # From discussion here: https://github.com/myronmarston/vcr/pull/147
+  # https://gist.github.com/26edfe7669cc7b85e164
+  c.before_record do |i|
+    type = Array(i.response.headers['Content-Type']).join(',').split(';').first
+    code = i.response.status.code
+
+    if type =~ /[\/+]json$/ or 'text/javascript' == type
+      begin
+        data = JSON.parse i.response.body
+      rescue
+        if code != 404
+          puts
+          warn "VCR: JSON parse error for Content-type #{type}"
+          warn "Your unparseable json is: " + i.response.body.inspect
+          puts
+        end
+      else
+        i.response.body = JSON.pretty_generate data
+        i.response.update_content_length_header
+      end
+    end
+  end
+end
+
+class String
+  def unindent
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+  end
+end
+
+Poptart.api_token = "testing"