wufoo_party 0.1.0

data/README.rdoc

@@ -0,0 +1,44 @@
+= WufooParty
+
+Lightweight wrapper for Wufoo API over HTTP using HTTParty.
+
+== About
+
+This is a very simple class that utilizes HTTParty -- a wonderful gem for
+consuming REST APIs.
+
+This lib supports both Wufoo's query and submit api version 2.0.
+
+== Installation
+
+    sudo gem install wufoo_party
+
+== Usage
+
+    require 'wufoo_party'
+    
+    ACCOUNT = 'accountname'
+    API_KEY = 'AAAA-BBBB-CCCC-DDDD'
+    FORM_ID = 'my-form-id'
+    
+    wufoo = WufooParty.new(ACCOUNT, API_KEY)
+    # you must use field numbers, shown on the 'API Information' page in Wufoo
+    wufoo.submit(FORM_ID, {
+      '1' => 'Tim',
+      '2' => 'Morgan'
+    })
+    result = wufoo.query(FORM_ID)
+    pp result['form']['Entries'].last['Pretty']
+    # {"Last"=>"Morgan",
+    #  "Name"=>"Tim"}
+    
+== Feedback
+
+I’d love to hear from you if you have suggestions for improvement, bug fixes, or whatever. Email me at tim@timmorgan.org or fork the project and send a pull request.
+
+To run the tests, do this:
+
+    WUFOO_ACCOUNT=accountname \
+    WUFOO_API_KEY=AAAA-BBBB-CCCC-DDDD \
+    WUFOO_FORM_ID=my-form-id \
+    ruby -rrubygems test/wufoo_party_test.rb

data/lib/wufoo_party.rb

@@ -0,0 +1,67 @@
+require 'httparty'
+
+class WufooParty
+  include HTTParty
+  format :json
+  
+  QUERY_ENDPOINT = 'http://%s.wufoo.com/api/query/'
+  SUBMIT_ENDPOINT = 'http://%s.wufoo.com/api/insert/'
+  API_VERSION = '2.0'
+  
+  def initialize(account, api_key)
+    @account = account
+    @api_key = api_key
+    @field_numbers = {}
+  end
+  
+  # Perform a query on a specific form_id.
+  # Returns details about the form, as well as individual form submission details.
+  def query(form_id)
+    args = {
+      'w_api_key' => @api_key,
+      'w_version' => API_VERSION,
+      'w_form'    => form_id
+    }
+    result = self.class.post(QUERY_ENDPOINT % @account, :body => args)
+    add_title_to_fields!(result)
+    result
+  end
+  
+  # Perform a submission to a specific form_id.
+  # Returns status of operation.
+  def submit(form_id, data={})
+    args = {
+      'w_api_key' => @api_key,
+      'w_form'    => form_id
+    }.merge(data)
+    self.class.post(SUBMIT_ENDPOINT % @account, :body => args)
+  end
+
+  # Converts an array of field specs (returned by Wufoo) into a simple hash of <tt>{FIELDNUM => FIELDNAME}</tt>
+  def get_field_numbers(field_data)
+    field_data.inject({}) do |hash, field|
+      if field['SubFields']
+        hash.merge!(get_field_numbers(field['SubFields']))
+      else
+        hash[field['ColumnId']] = field['Title']
+      end
+      hash
+    end
+  end
+  
+  # Given the result of a query, adds a 'Pretty' key to each form entry
+  # that includes the field titles.
+  def add_title_to_fields!(query_result)
+    if query_result['form'] and query_result['form']['Entries']
+      nums = get_field_numbers(query_result['form']['Fields'])
+      query_result['form']['Entries'].each do |entry|
+        entry['Pretty'] = {}
+        entry.keys.each do |key|
+          if key =~ /^Field(\d+)$/ and title = nums[$1]
+            entry['Pretty'][title] = entry[key]
+          end
+        end
+      end
+    end
+  end
+end

data/test/wufoo_party_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../lib/wufoo_party'
+require 'test/unit'
+
+class WufooPartyTest < Test::Unit::TestCase
+  
+  def setup
+    if ENV['WUFOO_ACCOUNT'] and ENV['WUFOO_API_KEY'] and ENV['WUFOO_FORM_ID']
+      @wufoo = WufooParty.new(ENV['WUFOO_ACCOUNT'], ENV['WUFOO_API_KEY'])
+      @form_id = ENV['WUFOO_FORM_ID']
+    else
+      puts 'Must set WUFOO_ACCOUNT, WUFOO_API_KEY and WUFOO_FORM_ID env variables before running.'
+      exit(1)
+    end
+  end
+  
+  def test_connection
+    assert @wufoo.query(@form_id)['form']
+  end
+  
+  def test_submission
+    start_count = @wufoo.query(@form_id)['form']['EntryCount'].to_i
+    result = @wufoo.submit(@form_id) # blank submission - only works if no required fields
+    assert_equal 'true', result['wufoo_submit'][0]['success']
+    end_count = @wufoo.query(@form_id)['form']['EntryCount'].to_i
+    assert_equal start_count+1, end_count
+  end
+  
+  def test_get_field_numbers
+    assert_equal(
+      {'1' => 'Name', '2' => 'Last', '3' => 'Foo'},
+      @wufoo.get_field_numbers([
+        {"Title" => "Name", "SubFields" => [
+          {"Title" => "Name", "ColumnId" => "1"},
+          {"Title" => "Last", "ColumnId" => "2"}
+        ]},
+        {"Title" => "Foo", "ColumnId" => "3"}
+      ])
+    )
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: wufoo_party
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-07 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: tim@timmorgan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/wufoo_party.rb
+- test/wufoo_party_test.rb
+has_rdoc: true
+homepage: http://seven1m.github.com/wufoo_party
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Lightweight wrapper for Wufoo API over HTTP using HTTParty
+test_files: []
+