jnunemaker-wufoo 0.1.1 → 0.2.0

data/Manifest

@@ -1,10 +1,14 @@
+examples/submission.rb
 History
+lib/wufoo/client.rb
+lib/wufoo/submission.rb
 lib/wufoo/version.rb
 lib/wufoo.rb
 Manifest
 MIT-LICENSE
 Rakefile
 README
+test/test_client.rb
 test/test_helper.rb
+test/test_submission.rb
 test/test_wufoo.rb
-wufoo.gemspec

data/examples/submission.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+require File.dirname(__FILE__) + '/../lib/wufoo'
+config = YAML::load(File.read(ENV['HOME'] + '/.wufoo'))
+
+client = Wufoo::Client.new('http://orderedlist.wufoo.com', config['api_key'])
+submission = Wufoo::Submission.new(client, 'orderedlistcom-project-request')
+
+response = submission.add_params({
+  '1'  => 'John Nunemaker',
+  '12' => 'nunemaker@gmail.com',
+  '4'  => '1231231234',
+  '5'  => 'http://addictedtonew.com',
+  '6'  => 'ASAP!',
+  '10' => '1,000,000',
+  '11' => 'My cool project!',
+}).process
+
+if response.success?
+  puts response.message
+else
+  # Something was wrong with the request
+  # (missing api key, invalid form, etc)
+  if response.fail?
+    puts response.error    
+  end
+  
+  # validation errors
+  unless response.valid?
+    errors = response.errors.collect { |e| "#{e.field_id} (#{e.code}): #{e.message}" }    
+    puts errors * "\n"
+  end
+end

data/lib/wufoo.rb

@@ -1,89 +1,9 @@
+$:.unshift File.dirname(__FILE__)
+
 require 'rubygems'
 gem 'httparty', '0.2.2'
 require 'httparty'
 
-class Wufoo
-  include HTTParty
-  
-  attr_accessor :url, :api_key, :form, :params
-  
-  def initialize(url, api_key, form, params={})
-    @url, @api_key, @form = url, api_key, form
-    @params = {}.merge(params || {})
-  end
-  
-  def add_params(new_params)
-    @params.merge!(new_params)
-    self
-  end
-  
-  def process
-    data = params.merge({
-      :w_api_key => api_key,
-      :w_form => form,
-    })
-    
-    Wufoo::Response.new(self.class.post("#{@url}/api/insert/", :query => data, :format => :json))
-  end
-  
-  class Response    
-    attr_accessor :data
-    
-    def initialize(data)
-      @data = data
-      populate
-    end
-    
-    def success?
-      return false if data.nil? || data == {}
-      data['wufoo_submit'].first['success'] == 'true'
-    end
-    
-    def fail?
-      return true if data.nil? || data == {}
-      error.size > 0
-    end
-    
-    def valid?
-      errors.size == 0
-    end
-    
-    def error
-      @error || ''
-    end
-    
-    def errors
-      @errors || []
-    end
-    
-    def message
-      @message || ''
-    end
-    
-    def entry_id
-      @entry_id
-    end
-    
-    private
-      def populate
-        @message  = data['wufoo_submit'].first['confirmation_message']
-        @entry_id = data['wufoo_submit'].first['entry_id']
-        @error    = data['wufoo_submit'].first['error']
-        @raw_errors   = data['wufoo_submit'].first['field_errors']
-        
-        if @raw_errors && @raw_errors.size > 0
-          @errors = @raw_errors.inject([]) { |acc, error| acc << FieldError.new(error) }
-        end
-      end
-  end
-  
-  class FieldError
-    attr_accessor :field_id, :code, :message
-    
-    def initialize(attrs)
-      @field_id = attrs['field_id']
-      @code     = attrs['error_code']
-      @message  = attrs['error_message']
-    end
-  end
-end
+require 'wufoo/client'
+require 'wufoo/submission'
+require 'wufoo/version'

data/lib/wufoo/client.rb

@@ -0,0 +1,18 @@
+module Wufoo
+  class Client
+    include HTTParty
+    
+    attr_accessor :url, :api_key
+    
+    def initialize(url, api_key)
+      @url, @api_key = url, api_key
+    end
+    
+    def post(path, data)
+      data.merge!({
+        :w_api_key => api_key,
+      })
+      self.class.post("#{@url}#{path}", :query => data, :format => :json)
+    end
+  end
+end

data/lib/wufoo/submission.rb

@@ -0,0 +1,81 @@
+module Wufoo
+  class Submission
+    attr_accessor :client, :form, :params
+    
+    def initialize(client, form, params={})
+      @client = client
+      @form = form
+      @params = {}.merge(params || {})
+    end
+    
+    def add_params(new_params)
+      @params.merge!(new_params)
+      self
+    end
+
+    def process
+      Response.new(@client.post('/api/insert/', params.merge({:w_form => form})))
+    end
+    
+    class Response    
+      attr_accessor :data
+
+      def initialize(data)
+        @data = data
+        populate
+      end
+
+      def success?
+        return false if data.nil? || data == {}
+        data['wufoo_submit'].first['success'] == 'true'
+      end
+
+      def fail?
+        return true if data.nil? || data == {}
+        error.size > 0
+      end
+
+      def valid?
+        errors.size == 0
+      end
+
+      def error
+        @error || ''
+      end
+
+      def errors
+        @errors || []
+      end
+
+      def message
+        @message || ''
+      end
+
+      def entry_id
+        @entry_id
+      end
+
+      private
+        def populate
+          @message  = data['wufoo_submit'].first['confirmation_message']
+          @entry_id = data['wufoo_submit'].first['entry_id']
+          @error    = data['wufoo_submit'].first['error']
+          @raw_errors   = data['wufoo_submit'].first['field_errors']
+
+          if @raw_errors && @raw_errors.size > 0
+            @errors = @raw_errors.inject([]) { |acc, error| acc << FieldError.new(error) }
+          end
+        end
+    end
+
+    class FieldError
+      attr_accessor :field_id, :code, :message
+
+      def initialize(attrs)
+        @field_id = attrs['field_id']
+        @code     = attrs['error_code']
+        @message  = attrs['error_message']
+      end
+    end
+  end
+end

data/lib/wufoo/version.rb

@@ -1,3 +1,3 @@
-class Wufoo
-  Version = '0.1.1'
+module Wufoo
+  Version = '0.2.0'
 end

data/test/test_client.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestClient < Test::Unit::TestCase
+  test 'initialize' do
+    client = Wufoo::Client.new('http://foobar.wufoo.com', 'somecrazyapikey')
+    assert_equal('http://foobar.wufoo.com', client.url)
+    assert_equal('somecrazyapikey', client.api_key)
+  end  
+end

data/test/test_helper.rb

@@ -2,4 +2,31 @@ require 'rubygems'
 require 'test/unit'
 require 'context'
 require 'stump'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'wufoo')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'wufoo')
+
+def successful_response_data
+  {"wufoo_submit" => [{
+      "confirmation_message" => "Success! Thanks for filling out my form!",
+      "entry_id"             => "1025",
+      "success"              => "true"
+    }]}
+end
+
+def error_response_data
+  {"wufoo_submit" => [{
+      "error"        => "The supplied form URL was not found.",
+      "field_errors" => [],
+      "success"      => "false"
+    }]}
+end
+
+def field_error_response_data
+  {"wufoo_submit" => [{
+      "error" => "",
+      "field_errors" => [
+        {"field_id" => "field0", "error_message" => "Invalid email address.", "error_code" => "2"},
+        {"field_id" => "field1", "error_message" => "Field is required.", "error_code" => "0"},
+      ],
+      "success" => "false"
+    }]}
+end

data/test/test_submission.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestSubmission < Test::Unit::TestCase
+  before do
+    @client = Wufoo::Client.new('http://foobar.wufoo.com', 'somecrazyapikey')
+  end
+  
+  test 'initialize' do
+    submission = Wufoo::Submission.new(@client, 'my-crazy-form')
+    assert_equal(@client, submission.client)
+    assert_equal('my-crazy-form', submission.form)
+    assert_equal({}, submission.params)
+  end
+  
+  test 'initialize with params' do
+    submission = Wufoo::Submission.new(@client, 'my-crazy-form', {'0' => 'Foo'})
+    assert_equal({'0' => 'Foo'}, submission.params)
+  end
+  
+  test 'add_params' do
+    submission = Wufoo::Submission.new(@client, 'my-crazy-form').add_params('0' => 'Foo')
+    assert_equal({'0' => 'Foo'}, submission.params)
+  end
+  
+  test 'add_params returns self' do
+    assert_kind_of(Wufoo::Submission, Wufoo::Submission.new(@client, 'my-crazy-form').add_params('0' => 'Foo'))
+  end
+  
+  context 'processing response that was successful' do
+    before do
+      @client.stub!(:post, :return => successful_response_data)
+      submission = Wufoo::Submission.new(@client, 'my-crazy-form').add_params({'0' => 'Foobar!'})
+      @response = submission.process
+    end
+    
+    test 'should have data' do
+      assert_equal(successful_response_data, @response.data)
+    end
+    
+    test 'should be success?' do
+      assert @response.success?
+    end
+    
+    test 'should not be fail?' do
+      assert ! @response.fail?
+    end
+    
+    test 'should be valid?' do
+      assert @response.valid?
+    end
+    
+    test 'should have message' do
+      assert_equal('Success! Thanks for filling out my form!', @response.message)
+    end
+    
+    test 'should have entry_id' do
+      assert_equal('1025', @response.entry_id)
+    end
+    
+    test 'should not have error' do
+      assert_equal('', @response.error)
+    end
+    
+    test 'should not have errors' do
+      assert_equal([], @response.errors)
+    end
+  end
+  
+  context 'processing a response that failed' do
+    before do
+      @client.stub!(:post, :return => error_response_data)
+      submission = Wufoo::Submission.new(@client, 'my-crazy-form').add_params({'0' => 'Foobar!'})
+      @response = submission.process
+    end
+    
+    test 'should have data' do
+      assert_equal(error_response_data, @response.data)
+    end
+    
+    test 'should not be success?' do
+      assert ! @response.success?
+    end
+    
+    test 'should be a fail?' do
+      assert @response.fail?
+    end
+    
+    test 'should be valid?' do
+      assert @response.valid?
+    end
+
+    test 'should have error' do
+      assert_equal('The supplied form URL was not found.', @response.error)
+    end
+  end
+  
+  context 'processing a response with field errors' do
+    before do
+      @client.stub!(:post, :return => field_error_response_data)
+      submission = Wufoo::Submission.new(@client, 'my-crazy-form').add_params({'0' => 'Foobar!'})
+      @response = submission.process
+    end
+    
+    test 'should have data' do
+      assert_equal(field_error_response_data, @response.data)
+    end
+    
+    test 'should not be success?' do
+      assert ! @response.success?
+    end
+    
+    test 'should not be fail?' do
+      assert ! @response.fail?
+    end
+    
+    test 'should not be valid?' do
+      assert ! @response.valid?
+    end
+    
+    test 'should have errors' do
+      field_ids = ['field0', 'field1']
+      messages = ['Invalid email address.', 'Field is required.']
+      codes = ['2', '0']
+      assert_equal(field_ids, @response.errors.collect { |e| e.field_id })
+      assert_equal(messages, @response.errors.collect { |e| e.message })
+      assert_equal(codes, @response.errors.collect { |e| e.code })
+    end
+  end
+end

data/test/test_wufoo.rb

@@ -1,155 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper'
 
 class TestWufoo < Test::Unit::TestCase
-  before do
-    @successful_response_data = {
-      "wufoo_submit" => [{
-        "confirmation_message" => "Success! Thanks for filling out my form!",
-        "entry_id"             => "1025",
-        "success"              => "true"
-      }]
-    }
-    
-    @error_response_data = {
-      "wufoo_submit" => [{
-        "error"        => "The supplied form URL was not found.",
-        "field_errors" => [],
-        "success"      => "false"
-      }]
-    }
-    
-    @field_error_response_data = {
-      "wufoo_submit" => [{
-        "error" => "",
-        "field_errors" => [
-          {"field_id" => "field0", "error_message" => "Invalid email address.", "error_code" => "2"},
-          {"field_id" => "field1", "error_message" => "Field is required.", "error_code" => "0"},
-        ],
-        "success" => "false"
-      }]
-    }
+  test 'should have version' do
+    assert_not_nil Wufoo::Version
   end
-  
-  test 'initialize' do
-    wufoo = Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form')
-    assert_equal('http://dummy.wufoo.com', wufoo.url)
-    assert_equal('foobar', wufoo.api_key)
-    assert_equal('my-crazy-form', wufoo.form)
-    assert_equal({}, wufoo.params)
-  end
-  
-  test 'initialize with params' do
-    wufoo = Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form', {'0' => 'Foo'})
-    assert_equal({'0' => 'Foo'}, wufoo.params)
-  end
-  
-  test 'add_params' do
-    wufoo = Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form').add_params('0' => 'Foo')
-    assert_equal({'0' => 'Foo'}, wufoo.params)
-  end
-  
-  test 'add_params returns self' do
-    assert_kind_of(Wufoo, Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form').add_params('0' => 'Foo'))
-  end
-  
-  context 'processing response that was successful' do
-    before do
-      Wufoo.stub!(:post, :return => @successful_response_data)
-      wufoo = Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form').add_params({'0' => 'Foobar!'})
-      @response = wufoo.process
-    end
-    
-    test 'should have data' do
-      assert_equal(@successful_response_data, @response.data)
-    end
-    
-    test 'should be success?' do
-      assert @response.success?
-    end
-    
-    test 'should not be fail?' do
-      assert ! @response.fail?
-    end
-    
-    test 'should be valid?' do
-      assert @response.valid?
-    end
-    
-    test 'should have message' do
-      assert_equal('Success! Thanks for filling out my form!', @response.message)
-    end
-    
-    test 'should have entry_id' do
-      assert_equal('1025', @response.entry_id)
-    end
-    
-    test 'should not have error' do
-      assert_equal('', @response.error)
-    end
-    
-    test 'should not have errors' do
-      assert_equal([], @response.errors)
-    end
-  end
-  
-  context 'processing a response that failed' do
-    before do
-      Wufoo.stub!(:post, :return => @error_response_data)
-      wufoo = Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form').add_params({'0' => 'Foobar!'})
-      @response = wufoo.process
-    end
-    
-    test 'should have data' do
-      assert_equal(@error_response_data, @response.data)
-    end
-    
-    test 'should not be success?' do
-      assert ! @response.success?
-    end
-    
-    test 'should be a fail?' do
-      assert @response.fail?
-    end
-    
-    test 'should be valid?' do
-      assert @response.valid?
-    end
-
-    test 'should have error' do
-      assert_equal('The supplied form URL was not found.', @response.error)
-    end
-  end
-  
-  context 'processing a response with field errors' do
-    before do
-      Wufoo.stub!(:post, :return => @field_error_response_data)
-      wufoo = Wufoo.new('http://dummy.wufoo.com', 'foobar', 'my-crazy-form').add_params({'0' => 'Foobar!'})
-      @response = wufoo.process
-    end
-    
-    test 'should have data' do
-      assert_equal(@field_error_response_data, @response.data)
-    end
-    
-    test 'should not be success?' do
-      assert ! @response.success?
-    end
-    
-    test 'should not be fail?' do
-      assert ! @response.fail?
-    end
-    
-    test 'should not be valid?' do
-      assert ! @response.valid?
-    end
-    
-    test 'should have errors' do
-      field_ids = ['field0', 'field1']
-      messages = ['Invalid email address.', 'Field is required.']
-      codes = ['2', '0']
-      assert_equal(field_ids, @response.errors.collect { |e| e.field_id })
-      assert_equal(messages, @response.errors.collect { |e| e.message })
-      assert_equal(codes, @response.errors.collect { |e| e.code })
-    end
-  end        
 end

data/wufoo.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wufoo}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
   s.date = %q{2008-12-16}
   s.description = %q{simple wrapper for the wufoo api}
   s.email = %q{nunemaker@gmail.com}
-  s.extra_rdoc_files = ["lib/wufoo/version.rb", "lib/wufoo.rb", "README"]
-  s.files = ["History", "lib/wufoo/version.rb", "lib/wufoo.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "test/test_helper.rb", "test/test_wufoo.rb", "wufoo.gemspec"]
+  s.extra_rdoc_files = ["lib/wufoo/client.rb", "lib/wufoo/submission.rb", "lib/wufoo/version.rb", "lib/wufoo.rb", "README"]
+  s.files = ["examples/submission.rb", "History", "lib/wufoo/client.rb", "lib/wufoo/submission.rb", "lib/wufoo/version.rb", "lib/wufoo.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README", "test/test_client.rb", "test/test_helper.rb", "test/test_submission.rb", "test/test_wufoo.rb", "wufoo.gemspec"]
   s.has_rdoc = true
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wufoo", "--main", "README"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{wufoo}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{simple wrapper for the wufoo api}
-  s.test_files = ["test/test_helper.rb", "test/test_wufoo.rb"]
+  s.test_files = ["test/test_client.rb", "test/test_helper.rb", "test/test_submission.rb", "test/test_wufoo.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jnunemaker-wufoo
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - John Nunemaker
@@ -37,18 +37,25 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- lib/wufoo/client.rb
+- lib/wufoo/submission.rb
 - lib/wufoo/version.rb
 - lib/wufoo.rb
 - README
 files: 
+- examples/submission.rb
 - History
+- lib/wufoo/client.rb
+- lib/wufoo/submission.rb
 - lib/wufoo/version.rb
 - lib/wufoo.rb
 - Manifest
 - MIT-LICENSE
 - Rakefile
 - README
+- test/test_client.rb
 - test/test_helper.rb
+- test/test_submission.rb
 - test/test_wufoo.rb
 - wufoo.gemspec
 has_rdoc: true
@@ -83,5 +90,7 @@ signing_key:
 specification_version: 2
 summary: simple wrapper for the wufoo api
 test_files: 
+- test/test_client.rb
 - test/test_helper.rb
+- test/test_submission.rb
 - test/test_wufoo.rb