formstack 0.0.1

data/lib/formstack.rb

@@ -0,0 +1,23 @@
+require 'httparty'
+require 'hashie'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+Hash.send :include, Hashie::HashExtensions
+
+module Formstack
+  
+  VERSION = "0.0.1".freeze
+
+  
+  class FormstackError < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+end
+
+require File.join(directory, 'formstack', 'client')

data/lib/formstack/client.rb

@@ -0,0 +1,82 @@
+module Formstack
+  class Client
+    include HTTParty
+    base_uri "https://www.formstack.com/api/"
+    format :json
+
+    def initialize(key)
+      self.class.default_params(:api_key => key, :type => 'json')
+    end
+    
+    def forms
+      self.class.get("/forms").forms.map{|f| handle_form(f)}
+    end
+    
+    def form(form_id)
+      handle_form(self.class.get("/form", :query => {:id => form_id}))
+    end
+    
+    def data(form_id, options={})
+      api_response = self.class.get("/data", :query => {:id => form_id}.merge(options))
+      api_response.submissions = api_response.submissions.map{|s| handle_submission(s) }
+      api_response
+    end
+    alias :submissions :data
+    
+    def submission(submission_id, options={})
+      handle_submission(self.class.get("/submission", :query => {:id => submission_id}.merge(options)))
+    end
+
+    
+    def submit(form_id, options={})
+      self.class.post("/submit", :body => {:id => form_id}.merge(prepare_params(form_id, options)))['id']
+    end
+    
+    def edit(submission_id, options={})
+      self.class.post("/edit", :body => {:id => submission_id}.merge(prepare_params(submission_id, options)))['id']
+    end
+    
+    def delete(submission_id)
+      self.class.post("/delete", :body => {:id => submission_id})['id']
+    end
+    
+    
+    def prepare_params(form_id, params={})
+      data = params.delete(:data)
+      form = form(form_id)
+      data.each do |field, value|
+        field_id = form.fields.any? {|f| f['name'] == field.to_s} ? form.fields.find {|f| f['name'] == field.to_s}['id'] : field
+        params["field_#{field_id}"] = value
+      end
+      params
+    end
+    
+    def handle_form(form)
+      form.created = Time.parse(form.created) unless form.created.nil?
+      form
+    end
+    
+    def handle_submission(submission)
+      data = submission.data      
+      data.each do |datum|
+        submission[datum.field] = datum.value
+      end
+      submission.timestamp = Time.parse(submission.timestamp)
+      submission
+    end
+
+    def self.get(*args); handle_response super end
+    def self.post(*args); handle_response super end
+    
+    def self.handle_response(response)
+      case response.code
+      when 500...600; raise FormstackError.new(Hashie::Mash.new(response).error)
+      else; response
+      end
+      
+      Hashie::Mash.new(response).response
+      
+    end
+    
+  end
+end

data/test/formstack_test.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+class FormstackTest < Test::Unit::TestCase
+  
+  context "Formstack API" do
+    
+    setup do
+      @client = Formstack::Client.new("OU812")
+    end
+    
+    should "list forms for an account" do
+      stub_get("/forms?type=json&api_key=OU812", "forms.json")
+      forms = @client.forms
+      forms.size.should == 1
+      forms.first.name.should == 'Contact'
+    end
+    
+    should "get details for a form" do
+      stub_get("/form?id=1234&type=json&api_key=OU812", "form.json")
+      form = @client.form(1234)
+      form.fields.size.should == 5
+      form.fields.first.section_heading.should == 'Contact Information'
+    end
+    
+    should "get submitted data for a form" do
+      stub_get("/data?id=1234&page=1&type=json&api_key=OU812", "data.json")
+      submissions = @client.data(1234, :page => 1).submissions
+      submissions.size.should == 2
+      submissions.first['1111'].should == "John Smith"
+      submissions.first.timestamp.year.should == 2007
+    end
+    
+    should "return a single submission collected for a form" do
+      stub_get("/submission?id=1001&type=json&api_key=OU812", "submission.json")
+      submission = @client.submission(1001)
+      submission['2222'].should == "Apple"
+      submission.timestamp.year.should == 2007
+    end
+    
+    should "prepare data for form submission" do
+      stub_get("/form?id=1234&type=json&api_key=OU812", "form.json")
+      params = {:page => 3, :data => {:name => "Wynn Netherland", :phone => "940-867-5309", '123' => 'foo'}}
+      prepared = @client.prepare_params(1234, params)
+      prepared['field_7344054'].should == 'Wynn Netherland'
+      prepared['field_7344057'].should == '940-867-5309'
+      prepared['field_123'].should == 'foo'
+    end
+    
+    should "submit data for a form" do
+      stub_post("/submit?type=json&api_key=OU812", "submit.json")
+      id = @client.submit(1234, :data => {:foo => 'bar'})
+      id.should == 10001
+    end
+    
+    should "update submitted data for a form" do
+      stub_post("/edit?type=json&api_key=OU812", "submit.json")
+      id = @client.edit(1234, :data => {:foo => 'bar'})
+      id.should == 10001
+    end
+    
+    should "delete submitted data for a form" do
+      stub_post("/delete?type=json&api_key=OU812", "submit.json")
+      id = @client.delete(1234)
+      id.should == 10001
+    end
+
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+require 'redgreen'
+require 'matchy'
+require 'fakeweb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'formstack'
+
+
+# Set the default allow_net_connect option--usually you'll want this off.
+# You don't usually want your test suite to make HTTP connections, do you?
+FakeWeb.allow_net_connect = false
+
+class Test::Unit::TestCase
+end
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def formstack_url(url, options={})
+  url =~ /^http/ ? url : "https://www.formstack.com/api#{url}"
+end
+
+def stub_request(method, url, filename, status=nil)
+  options = {:body => ""}
+  options.merge!({:body => fixture_file(filename)}) if filename
+  options.merge!({:body => status.last}) if status
+  options.merge!({:status => status}) if status
+
+  FakeWeb.register_uri(method, formstack_url(url), options)
+end
+
+def stub_get(*args); stub_request(:get, *args) end
+def stub_post(*args); stub_request(:post, *args) end
+
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: formstack
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Wynn Netherland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  name: hashie
+  prerelease: false
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  name: httparty
+  prerelease: false
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 1
+        version: 2.10.1
+  name: shoulda
+  prerelease: false
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  name: matchy
+  prerelease: false
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  name: fakeweb
+  prerelease: false
+  requirement: *id005
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  prerelease: false
+  requirement: *id006
+  type: :development
+description: Wrapper for the Formstack API
+email: wynn.netherland@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/formstack/client.rb
+- lib/formstack.rb
+has_rdoc: true
+homepage: http://github.com/pengwynn/formstack
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Wrapper for the Formstack API
+test_files: 
+- test/helper.rb
+- test/formstack_test.rb