wuparty 1.0.2 → 1.1.0

data/README.rdoc

@@ -15,7 +15,6 @@ Make sure you have latest version installed (1.0.0 or higher).
 
 == Source & Download
 
-* {Homepage & Demo}[http://wuparty.71m.us]
 * {Source Code}[http://github.com/seven1m/wuparty]
 * {RDoc Documentation}[http://seven1m.github.com/wuparty]
 
@@ -25,6 +24,8 @@ Make sure you have latest version installed (1.0.0 or higher).
 
 == Usage
 
+=== Setup
+
     require 'wuparty'
 
     ACCOUNT = 'accountname'
@@ -33,24 +34,52 @@ Make sure you have latest version installed (1.0.0 or higher).
 
     wufoo = WuParty.new(ACCOUNT, API_KEY)
 
-    wufoo.forms # list all accessible forms and details
-    form = wufoo.form(FORM_ID) # or details for a specific form
+=== Login
+
+    result = WuParty.login(myIntegrationKey, users_email, users_password)
+    api_key = result['LoginResult']['ApiKey']
+
+=== Get Form Info
+
+    wufoo.forms
+    form = wufoo.form(FORM_ID)
+
+=== Get Entries
 
-    # query all entries
     form.entries
 
     # ...or filter entries (see http://wufoo.com/docs/api/v3/entries/get/#filter)
     form.entries([['Field1', 'Is_equal_to', 'Tim']])
 
+=== Submit
+
     # To submit, use field numbers shown on the 'API Information' page in Wufoo
-    result = wufoo.submit(
+    result = form.submit({
       'Field1' => 'Tim',
       'Field2' => 'Morgan'
     })
     if result['Success'] == 0
       puts result['ErrorText']
     end
-    
+
+=== Web Hooks
+
+    # Any submission to this form will now post to the given url.
+    result = form.add_webhook('http://www.postbin.org/zh9iy1')
+
+    # Tell the webhook to include metadata in its postback
+    result = form.add_webhook('http://www.postbin.org/zh9iy1', true)
+
+    result = form.delete_webhook(result["WebHookPutResult"]["Hash"])
+
+    # Or, directly through wufoo:
+    result = wufoo.add_webhook(FORM_ID, 'http://www.postbin.org/zh9iy1')
+
+    # Tell the webhook to include metadata in its postback
+    result = wufoo.add_webhook(FORM_ID, 'http://www.postbin.org/zh9iy1', true)
+
+    wufoo.delete_webhook(FORM_ID, result["WebHookPutResult"]["Hash"])
+
 == Feedback
 
 I’d love to hear from you if you have suggestions for improvement, bug fixes, or whatever.

data/lib/wuparty.rb

@@ -93,6 +93,18 @@ class WuParty
   ENDPOINT    = 'https://%s.wufoo.com/api/v3'
   API_VERSION = '3.0'
 
+  # uses the Login API to fetch a user's API key
+  def self.login(integration_key, email, password, account = nil)
+    result = self.post("https://wufoo.com/api/v3/login.json", { :body => { :integrationKey => integration_key, :email => email, :password => password, :subdomain => account }})
+    if result.is_a?(String)
+      raise ConnectionError, result
+    elsif result['HTTPCode']
+      raise HTTPError.new(result['HTTPCode'], result['Text'])
+    else
+      result
+    end
+  end
+
   # Create a new WuParty object
   def initialize(account, api_key)
     @account = account
@@ -128,6 +140,14 @@ class WuParty
     end
   end
 
+  def add_webhook(form_id, url, metadata = false)
+    put("forms/#{form_id}/webhooks", :body => {'url' => url, 'metadata' => metadata})
+  end
+
+  def delete_webhook(form_id, webhook_hash)
+    delete("forms/#{form_id}/webhooks/#{webhook_hash}")
+  end
+
   # Returns details about the specified report.
   def report(report_id)
     if r = get("reports/#{report_id}")['Reports']
@@ -136,29 +156,19 @@ class WuParty
   end
 
   def get(method, options={}) # :nodoc:
-    options.merge!(:basic_auth => {:username => @api_key})
-    url = "#{base_url}/#{method}.json"
-    result = self.class.get(url, options)
-    if result.is_a?(String)
-      raise ConnectionError, result
-    elsif result['HTTPCode']
-      raise HTTPError.new(result['HTTPCode'], result['Text'])
-    else
-      result
-    end
+    handle_http_verb(:get, method, options)
   end
 
   def post(method, options={}) # :nodoc:
-    options.merge!(:basic_auth => {:username => @api_key})
-    url = "#{base_url}/#{method}.json"
-    result = self.class.post(url, options)
-    if result.is_a?(String)
-      raise ConnectionError, result
-    elsif result['HTTPCode']
-      raise HTTPError.new(result['HTTPCode'], result['Text'])
-    else
-      result
-    end
+    handle_http_verb(:post, method, options)
+  end
+
+  def put(method, options={}) # :nodoc:
+    handle_http_verb(:put, method, options)
+  end
+
+  def delete(method, options={}) # :nodoc:
+    handle_http_verb(:delete, method, options)
   end
 
   private
@@ -167,6 +177,19 @@ class WuParty
       ENDPOINT % @account
     end
 
+    def handle_http_verb(verb, action, options={})
+      options.merge!(:basic_auth => {:username => @api_key})
+      url = "#{base_url}/#{action}.json"
+      result = self.class.send(verb, url, options)
+      if result.is_a?(String)
+        raise ConnectionError, result
+      elsif result['HTTPCode']
+        raise HTTPError.new(result['HTTPCode'], result['Text'])
+      else
+        result
+      end
+    end
+
   public
 
   # ----------
@@ -217,6 +240,14 @@ class WuParty
       @details[id]
     end
 
+    def add_webhook(url, metadata = false)
+      @party.add_webhook(@details["Hash"], url, metadata)
+    end
+
+    def delete_webhook(webhook_id)
+      @party.delete_webhook(@details["Hash"], webhook_id)
+    end
+
     # Returns fields and subfields, as a flattened array, e.g.
     #   [{'ID' => 'Field1', 'Title' => 'Name - First', 'Type' => 'shortname', 'Required' => true }, # (subfield)
     #    {'ID' => 'Field2', 'Title' => 'Name - Last',  'Type' => 'shortname', 'Required' => true }, # (subfield)

metadata

@@ -1,115 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wuparty
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Tim Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-17 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &18787920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 6
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.6.1
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: multipart-post
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *18787920
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: &18787120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mime-types
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *18787120
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &18786460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 1
-        - 16
-        version: "1.16"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.16'
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *18786460
 description: 
 email: tim@timmorgan.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.rdoc
 - lib/wuparty.rb
 - test/wuparty_test.rb
-has_rdoc: true
 homepage: http://seven1m.github.com/wuparty
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for Wufoo's REST API v3.
 test_files: []
-