wuparty 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09a964df85dabf867074ea0b08ab6513a04d878c6e9dd6c1e8d0f35b40a0dd93'
-  data.tar.gz: ab0a9f3fbc5c15d6a0bc8303be4e6c9f995d72f253d8dc8e5bf400b590dd8645
+  metadata.gz: 234b301e801407f22b72b131811d66f55a01a181caf57abbd38d8b910e5ba46b
+  data.tar.gz: 3ad467ad15196ba565133fd4c0aa229838e73f8fb1e682b1f3267837ff46bb06
 SHA512:
-  metadata.gz: 6943a1829998b90acfe6c3f8b6de7f64942adc05b164f8ef82d6a251604d326c9b98f41883917f5feaf051253a892c68a2f0e67cbed1dacce9dc2566c1ef5921
-  data.tar.gz: 5e13f8e94e47ae54dddc8e3e3c35e081d47c2be2bbc093bf7b6e9166d29e7556f33fe561bc488f197972299e1269b6f77bcf9ca9f41c2a04528689aa96561b09
+  metadata.gz: c51e66a8b3e8a39659932763c153633590eb339317bf552cf96103f1a7067155a5b6f09cb6061ca30b1099062069ccde5e2ea2156ed32ea4be0f6202f3ee58d1
+  data.tar.gz: c67eea8b6b4b0177ae6c3bff4d46f061daa11e96f24c64f779b8da7c78c67d42e77711836a86f599eb70f43349b88599dface3e93a05ee74933085691f9da4a6

data/README.rdoc

@@ -32,8 +32,15 @@ Make sure you have latest version installed (1.0.0 or higher).
     API_KEY = 'AAAA-BBBB-CCCC-DDDD'
     FORM_ID = 'my-form-id'
 
+    ENDPOINT_DOMAIN = 'wufoo.com'
+    ENDPOINT_PREFIX = 'YourPrefix'
+
     wufoo = WuParty.new(ACCOUNT, API_KEY)
 
+If your Wufoo domain is not "wufoo.com" (e.g. "wufoo.eu") and/or your account prefix does not match your account name, you can pass those in:
+
+    wufoo = WuParty.new(ACCOUNT, API_KEY, domain: 'wufoo.eu', account_prefix: 'myaccount')
+
 === Login
 
     result = WuParty.login(myIntegrationKey, users_email, users_password)

data/lib/wuparty.rb

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'httparty'
-gem 'multipart-post'
-require 'net/http/post/multipart'
-gem 'mime-types'
-require 'mime/types'
+
+require_relative './wuparty/entity'
+require_relative './wuparty/form'
+require_relative './wuparty/report'
+require_relative './wuparty/user'
+require_relative './wuparty/version'
 
 class WuParty
   include HTTParty
   format :json
 
-  VERSION = '1.2.3'
-
   # Represents a general error connecting to the Wufoo service
   class ConnectionError < RuntimeError; end
 
@@ -24,58 +26,69 @@ class WuParty
     attr_reader :code
   end
 
-  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
+    result = post(
+      'https://wufoo.com/api/v3/login.json',
+      body: {
+        integrationKey: integration_key,
+        email:          email,
+        password:       password,
+        subdomain:      account
+      }
+    )
+    raise ConnectionError, result if result.is_a?(String)
+    raise HTTPError.new(result['HTTPCode'], result['Text']) if result['HTTPCode']
+    result
   end
 
   # Create a new WuParty object
-  def initialize(account, api_key)
+  def initialize(account, api_key, domain: 'wufoo.com', account_prefix: nil)
     @account = account
     @api_key = api_key
+    @domain = domain
+    @account_prefix = account_prefix || @account
     @field_numbers = {}
   end
 
   # Returns list of forms and details accessible by the user account.
   def forms
     get(:forms)['Forms'].map do |details|
-      Form.new(details['Url'], :party => self, :details => details)
+      Form.new(details['Url'], party: self, details: details)
     end
   end
 
   # Returns list of reports and details accessible by the user account.
   def reports
     get(:reports)['Reports'].map do |details|
-      Report.new(details['Url'], :party => self, :details => details)
+      Report.new(details['Url'], party: self, details: details)
     end
   end
 
   # Returns list of users and details.
   def users
     get(:users)['Users'].map do |details|
-      User.new(details['Url'], :party => self, :details => details)
+      User.new(details['Url'], party: self, details: details)
     end
   end
 
   # Returns details about the specified form.
   def form(form_id)
-    if f = get("forms/#{form_id}")['Forms']
-      Form.new(f.first['Url'], :party => self, :details => f.first)
-    end
+    return unless (f = get("forms/#{form_id}")['Forms'])
+    Form.new(f.first['Url'], party: self, details: f.first)
   end
 
-  def add_webhook(form_id, url, metadata = false, handshakeKey = "")
-    put("forms/#{form_id}/webhooks", :body => {'url' => url, 'handshakeKey' => handshakeKey, 'metadata' => metadata})
+  def add_webhook(form_id, url, metadata = false, handshake_key = '')
+    put(
+      "forms/#{form_id}/webhooks",
+      body: {
+        'url' => url,
+        'handshakeKey' => handshake_key,
+        'metadata' => metadata
+      }
+    )
   end
 
   def delete_webhook(form_id, webhook_hash)
@@ -84,274 +97,43 @@ class WuParty
 
   # Returns details about the specified report.
   def report(report_id)
-    if r = get("reports/#{report_id}")['Reports']
-      Report.new(r.first['Url'], :party => self, :details => r.first)
-    end
+    return unless (r = get("reports/#{report_id}")['Reports'])
+    Report.new(r.first['Url'], party: self, details: r.first)
   end
 
-  def get(method, options={}) # :nodoc:
+  def get(method, options = {}) # :nodoc:
     handle_http_verb(:get, method, options)
   end
 
-  def post(method, options={}) # :nodoc:
+  def post(method, options = {}) # :nodoc:
     handle_http_verb(:post, method, options)
   end
 
-  def put(method, options={}) # :nodoc:
+  def put(method, options = {}) # :nodoc:
     handle_http_verb(:put, method, options)
   end
 
-  def delete(method, options={}) # :nodoc:
+  def delete(method, options = {}) # :nodoc:
     handle_http_verb(:delete, method, options)
   end
 
   private
 
-    def base_url
-      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)
-      begin
-        result.to_s # trigger parse error if possible
-      rescue MultiJson::DecodeError => e
-        raise HTTPError.new(500, e.message)
-      end
-      if result.is_a?(String)
-        raise ConnectionError, result
-      elsif result['HTTPCode']
-        raise HTTPError.new(result['HTTPCode'], result['Text'])
-      else
-        result
-      end
-    end
-
-  public
-
-  # ----------
-
-  class Entity # :nodoc:
-    include HTTParty
-    format :json
-
-    def initialize(id, options)
-      @id = id
-      if options[:party]
-        @party = options[:party]
-      elsif options[:account] and options[:api_key]
-        @party = WuParty.new(options[:account], options[:api_key])
-      else
-        raise WuParty::InitializationException, "You must either specify a :party object or pass the :account and :api_key options. Please see the README."
-      end
-      @details = options[:details]
-    end
-
-    attr_reader :id
-    attr_accessor :details
-  end
-
-  # Wraps an individual Wufoo Form.
-  # == Instantiation
-  # There are two ways to instantiate a Form object:
-  # 1. Via the parent WuParty object that represents the account.
-  # 2. Via the WuParty::Form class directly.
-  #   wufoo = WuParty.new(ACCOUNT, API_KEY)
-  #   form = wufoo.form(FORM_ID)
-  #   # or...
-  #   form = WuParty::Form.new(FORM_ID, :account => ACCOUNT, :api_key => API_KEY)
-  # The first technique makes a call to the Wufoo API to get the form details,
-  # while the second technique lazily loads the form details, once something is accessed via [].
-  # == \Form Details
-  # Access form details like it is a Hash, e.g.:
-  #   form['Name']
-  #   form['RedirectMessage']
-  class Form < Entity
-    # Returns field details for the form.
-    def fields
-      @party.get("forms/#{@id}/fields")['Fields']
-    end
-
-    # Access form details.
-    def [](id)
-      @details ||= @party.form(@id)
-      @details[id]
-    end
-
-    def add_webhook(url, metadata = false, handshakeKey = "")
-      @party.add_webhook(@details["Hash"], url, metadata, handshakeKey)
-    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)
-    #    {'ID' => 'Field3', 'Title' => 'Birthday',     'Type' => 'date',      'Required' => flase}] # (field)
-    # By default, only fields that can be submitted are returned. Pass *true* as the first arg to return all fields.
-    def flattened_fields(all=false)
-      flattened = []
-      fields.each do |field|
-        next unless all or field['ID'] =~ /^Field/
-        if field['SubFields']
-          field['SubFields'].each do |sub_field|
-            flattened << {'ID' => sub_field['ID'], 'Title' => field['Title'] + ' - ' + sub_field['Label'], 'Type' => field['Type'], 'Required' => field['IsRequired'] == '1'}
-          end
-        else
-          flattened << {'ID' => field['ID'], 'Title' => field['Title'], 'Type' => field['Type'], 'Required' => field['IsRequired'] == '1'}
-        end
-      end
-      flattened
-    end
-
-    # Return entries already submitted to the form.
-    #
-    # Supports:
-    #   - filtering:
-    #   entries(:filters => [['Field1', 'Is_equal_to', 'Tim']])
-    #   entries(:filters => [['Field1', 'Is_equal_to', 'Tim'], ['Field2', 'Is_equal_to', 'Morgan']], :filter_match => 'OR')
-    #
-    #   - sorting:
-    #   entries(:sort => 'EntryId DESC')
-    #
-    #   - limiting:
-    #   entries(:limit => 5)
-    #
-    # See http://wufoo.com/docs/api/v3/entries/get/#filter for details
-    def entries(options={})
-      query = {}
-
-      if options[:filters]
-        query['match'] = options[:filter_match] || 'AND'
-        options[:filters].each_with_index do |filter, index|
-          query["Filter#{ index + 1 }"] = filter.join(' ')
-        end
-      end
-
-      if options[:limit]
-        query[:pageSize] = options[:limit]
-      end
-
-      if options[:pageStart]
-        query[:pageStart] = options[:pageStart]
-      end
-
-      if options[:system]
-        query[:system] = true
-      end
-
-      if options[:sort]
-        field, direction = options[:sort].split(' ')
-        query[:sort] = field
-        query[:sortDirection] = direction || 'ASC'
-      end
-      
-      @party.get("forms/#{@id}/entries", :query => query)['Entries']
-    end
-
-    # Return entries already submitted to the form.
-    #
-    # Supports:
-    # Same as Entries above with filtering.
-    # form.count(:filters => [['Field1', 'Is_equal_to', 'Tim']])
-    #
-    # See http://wufoo.com/docs/api/v3/entries/get/#filter for details
-    def count(options={})
-      query = {}
-
-      if options[:filters]
-        query['match'] = options[:filter_match] || 'AND'
-        options[:filters].each_with_index do |filter, index|
-          query["Filter#{ index + 1 }"] = filter.join(' ')
-        end
-      end   
-
-      if options[:system]
-        query[:system] = true
-      end
-
-      @party.get("forms/#{@id}/entries/count", :query => query)['EntryCount']
-    end
-
-
-    # Submit form data to the form.
-    # Pass data as a hash, with field ids as the hash keys, e.g.
-    #   submit('Field1' => 'Tim', 'Field2' => 'Morgan')
-    # Return value is a Hash that includes the following keys:
-    # * Status
-    # * ErrorText
-    # * FieldErrors
-    # You must submit values for required fields (including all sub fields),
-    # and dates must be formatted as <tt>YYYYMMDD</tt>.
-    def submit(data)
-      options = {}
-      data.each do |key, value|
-        if value.is_a?(Hash)
-          type = MIME::Types.of(value[:path]).first.content_type rescue 'application/octet-stream'
-          options[:multipart] ||= {}
-          options[:multipart][key] = {:type => type, :path => value[:path]}
-        else
-          options[:body] ||= {}
-          options[:body][key] = value
-        end
-      end
-      @party.post("forms/#{@id}/entries", options)
-    end
-
-    # Returns comment details for the form.
-    # See Wufoo API documentation for possible options,
-    # e.g. to filter comments for a specific form entry:
-    #   form.comments('entryId' => 123)
-    def comments(options={})
-      options = {:query => options} if options.any?
-      @party.get("forms/#{@id}/comments", options)['Comments']
-    end
+  def base_url
+    "https://#{@account_prefix}.#{@domain}/api/v3"
   end
 
-  # Wraps an individual Wufoo Report.
-  # == Instantiation
-  # There are two ways to instantiate a Report object:
-  # 1. Via the parent WuParty object that represents the account.
-  # 2. Via the WuParty::Report class directly.
-  #   wufoo = WuParty.new(ACCOUNT, API_KEY)
-  #   report = wufoo.report(REPORT_ID)
-  #   # or...
-  #   report = WuParty::Report.new(REPORT_ID, :account => ACCOUNT, :api_key => API_KEY)
-  # The first technique makes a call to the Wufoo API to get the report details,
-  # while the second technique lazily loads the report details, once something is accessed via [].
-  # == \Report Details
-  # Access report details like it is a Hash, e.g.:
-  #   report['Name']
-  class Report < Entity
-    # Access report details.
-    def [](id)
-      @details ||= @party.report(@id)
-      @details[id]
+  def handle_http_verb(verb, action, options = {})
+    options[:basic_auth] = { username: @api_key }
+    url = "#{base_url}/#{action}.json"
+    result = self.class.send(verb, url, options)
+    begin
+      result.to_s # trigger parse error if possible
+    rescue MultiJson::DecodeError => e
+      raise HTTPError.new(500, e.message)
     end
-
-    # Returns field details for the report
-    def fields
-      @party.get("reports/#{@id}/fields")['Fields']
-    end
-
-    # Returns widget details for the report
-    def widgets
-      @party.get("reports/#{@id}/widgets")['Widgets']
-    end
-  end
-
-  # Wraps an individual Wufoo User.
-  class User < Entity
-
-    # Access user details.
-    def [](id)
-      @details ||= @party.report(@id)
-      @details[id]
-    end
-
+    raise ConnectionError, result if result.is_a?(String)
+    raise HTTPError.new(result['HTTPCode'], result['Text']) if result['HTTPCode']
+    result
   end
 end

data/test/wuparty_test.rb

@@ -2,14 +2,13 @@ require './lib/wuparty'
 require 'test/unit'
 
 class WuPartyTest < Test::Unit::TestCase
-
   # Must create a form called "Test Form" and pass in its id
   # via the ENV variable WUFOO_FORM_ID.
   # Give the form standard name and address fields.
   # Make the name field required.
 
   def setup
-    if ENV['WUFOO_ACCOUNT'] and ENV['WUFOO_API_KEY'] and ENV['WUFOO_FORM_ID']
+    if ENV['WUFOO_ACCOUNT'] && ENV['WUFOO_API_KEY'] && ENV['WUFOO_FORM_ID']
       @wufoo = WuParty.new(ENV['WUFOO_ACCOUNT'], ENV['WUFOO_API_KEY'])
       @form_id = ENV['WUFOO_FORM_ID']
     else
@@ -29,7 +28,7 @@ class WuPartyTest < Test::Unit::TestCase
   end
 
   def test_get_form_id
-    assert_equal 1, @wufoo.forms.select {|f| f.id == 'test-form'}.length
+    assert_equal 1, @wufoo.forms.select { |f| f.id == 'test-form' }.length
   end
 
   def test_form_by_hash
@@ -38,7 +37,7 @@ class WuPartyTest < Test::Unit::TestCase
   end
 
   def test_form_directly
-    form = WuParty::Form.new(@form_id, :account => ENV['WUFOO_ACCOUNT'], :api_key => ENV['WUFOO_API_KEY'])
+    form = WuParty::Form.new(@form_id, account: ENV['WUFOO_ACCOUNT'], api_key: ENV['WUFOO_API_KEY'])
     assert_equal 'Test Form', form['Name']
   end
 
@@ -65,7 +64,14 @@ class WuPartyTest < Test::Unit::TestCase
 
   def test_form_submit
     form = @wufoo.form(@form_id)
-    result = form.submit('Field1' => 'Tim', 'Field2' => 'Morgan', 'Field3' => '4010 W. New Orleans', 'Field5' => 'Broken Arrow', 'Field6' => 'OK', 'Field7' => '74011')
+    result = form.submit(
+      'Field1' => 'Tim',
+      'Field2' => 'Morgan',
+      'Field3' => '4010 W. New Orleans',
+      'Field5' => 'Broken Arrow',
+      'Field6' => 'OK',
+      'Field7' => '74011'
+    )
     assert_equal 1, result['Success']
     assert result['EntryId']
     assert result['EntryLink']
@@ -84,7 +90,7 @@ class WuPartyTest < Test::Unit::TestCase
     assert_equal 1, result['FieldErrors'].length
     error = result['FieldErrors'].first
     assert_equal 'Field1', error['ID']
-    assert_match /required/i, error['ErrorText']
+    assert_match(/required/i, error['ErrorText'])
   end
 
   def test_entries
@@ -97,17 +103,16 @@ class WuPartyTest < Test::Unit::TestCase
     form = @wufoo.form(@form_id)
     form.submit('Field1' => 'Tim', 'Field2' => 'Morgan')
     id = form.submit('Field1' => 'Jane', 'Field2' => 'Smith')['EntryId']
-    assert form.entries(:filters => [['Field2', 'Is_equal_to', 'Morgan']]).any?
-    assert_equal 1, form.entries(:filters => [['EntryId', 'Is_equal_to', id]]).length
+    assert form.entries(filters: [%w[Field2 Is_equal_to Morgan]]).any?
+    assert_equal 1, form.entries(filters: [['EntryId', 'Is_equal_to', id]]).length
   end
 
   def test_add_webhook
     # test with optional parameters
-    response = @wufoo.add_webhook(@form_id, "http://#{ENV['WUFOO_ACCOUNT']}.com/#{@form_id}", true, "handshakeKey01")
-    assert_match /[a-z0-9]{6}/i, response['WebHookPutResult']['Hash']
+    response = @wufoo.add_webhook(@form_id, "http://#{ENV['WUFOO_ACCOUNT']}.com/#{@form_id}", true, 'handshakeKey01')
+    assert_match(/[a-z0-9]{6}/i, response['WebHookPutResult']['Hash'])
     # test without optional parameters
     response = @wufoo.add_webhook(@form_id, "http://#{ENV['WUFOO_ACCOUNT']}.com/#{@form_id}-2")
-    assert_match /[a-z0-9]{6}/i, response['WebHookPutResult']['Hash']
+    assert_match(/[a-z0-9]{6}/i, response['WebHookPutResult']['Hash'])
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wuparty
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Tim Morgan
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.16.0
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 1.0.1
 description: 
 email: tim@timmorgan.org
 executables: []