formstack-api 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a09c170f5568dff06fdb8fdf3c24d4053aa3607e
-  data.tar.gz: 554fe3ca8294a748799b653f1392914c26136854
+  metadata.gz: ad366b35bf42497cc4d1735aeac2b9232523b97e
+  data.tar.gz: 302454bbbe75c49f7be732f234b6be5f19c81b34
 SHA512:
-  metadata.gz: 658128a10ab946674094b6834d963a29bf4de3c95c12946ebde22d8c08ff29d5a1fa45655e53aa97c33d869aaa3eed2e8b7ae0d222c5c8d1d94ceeefad2fe5d2
-  data.tar.gz: e1f76a65b2e54d89a3732a88d8dc2600a87f99986f92e293517fc86865267a3958db4f0468a736446174cf6ba62f5a96ca02e55bb670a1aac8e6eb821af4428f
+  metadata.gz: 58bcdfdbea8345d3668b493a7686dc296df7440847e76f97fd5a46384b23c2226c85d3da2455e40c2ef89f1ba13e4e8a15c9e6b0325ca7a666acc9ff17f4320a
+  data.tar.gz: dd1f98dfafda3c1d8765c7bcede742a42a36d79a3c401d0cad1f13ae9c965f9639ff34dd10129088ea46b36b1982e83b9d4ade893181b91ed98333f78e3b1d66

data/lib/formstack/api/version.rb

@@ -1,5 +1,5 @@
 module Formstack
   module Api
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

data/lib/formstack/api.rb

@@ -8,6 +8,27 @@ module Formstack
 
     include HTTParty
 
+    FIELD_TYPES = [
+      'text',
+      'textarea',
+      'name',
+      'address',
+      'email',
+      'phone',
+      'creditcard',
+      'datetime',
+      'file',
+      'number',
+      'select',
+      'radio',
+      'checkbox',
+      'matrix',
+      'richtext',
+      'embed',
+      'product',
+      'section',
+    ]
+
     def initialize(access_token)
       @access_token = access_token
       @api_url = 'https://www.formstack.com/api/v2/'
@@ -35,6 +56,10 @@ module Formstack
         response = self.class.get(url, arguments )
       when 'POST'
         response = self.class.post(url, arguments )
+      when 'PUT'
+        response = self.class.put(url, arguments )
+      when 'DELETE'
+        response = self.class.delete(url, arguments )
       end
 
       if response.code < 200 || response.code >= 300
@@ -118,17 +143,160 @@ module Formstack
           'expand_data'           =>  expand_data,
       }
 
+      arguments.delete('data') unless data
+      arguments.delete('expand_data') unless expand_data
+
+      arguments = API.clean_arguments(arguments)
+
       search_fields.each_with_index do |field, idx|
         arguments["search_field_#{idx}"] = search_field_ids[idx]
         arguments["search_value_#{idx}"] = search_field_values[idx]
       end
 
-      response = request(end_point, 'GET', arguments)
+      response = request(end_point, 'GET', { body: arguments })
       response['submissions']
     end
 
+    def submit_form(form_id,
+                    field_ids = [],
+                    field_values = [],
+                    timestamp = '',
+                    user_agent = '',
+                    ip_address = '',
+                    payment_status = '',
+                    read = false)
+
+      arguments = {
+        'timestamp' => timestamp,
+        'user_agent' => user_agent,
+        'remote_addr' => ip_address,
+        'payment_status' => payment_status,
+        'read' => read ? 1 : 0
+      }
+
+      is_numeric?(form_id)
+
+      unless timestamp.empty?
+        begin
+          Time.parse(timestamp)
+        rescue Exception => e
+          raise 'You must use a valid Date/Time string formatted in YYYY-MM-DD HH:MM:SS'
+        end
+      end
+
+      raise 'There must be a one-to-one relationship between Field IDs and their values' unless field_ids.size == field_values.size
+
+      arguments = API.clean_arguments(arguments)
+      arguments = API.add_field_data(arguments, field_ids, field_values)
+
+      response = request("form/#{form_id}/submission.json", 'POST', { body: arguments } )
+    end
+
+    def get_submission_details(submission_id, encryption_password = '')
+      arguments = {}
+      arguments['encryption_password'] = encryption_password unless encryption_password.empty?
+
+      raise 'Submission ID must be numeric' unless submission_id.is_a? Numeric
+
+      response = request("submission/#{submission_id}.json", 'GET', arguments)
+    end
+
+    def edit_submission_data(submission_id,
+                             field_ids = [],
+                             field_values = [],
+                             timestamp = '',
+                             user_agent = '',
+                             ip_address = '',
+                             payment_status = '',
+                             read = false)
+
+      arguments = {
+        'timestamp' => timestamp,
+        'user_agent' => user_agent,
+        'remote_addr' => ip_address,
+        'payment_status' => payment_status,
+        'read' => read ? 1 : 0
+      }
+
+      raise 'Submission ID must be numeric' unless submission_id.is_a? Numeric
+
+      unless timestamp.empty?
+        begin
+          Time.parse(timestamp)
+        rescue Exception => e
+          raise 'You must use a valid Date/Time string formatted in YYYY-MM-DD HH:MM:SS'
+        end
+      end
+
+      arguments = API.clean_arguments(arguments)
+      arguments = API.add_field_data(arguments, field_ids, field_values)
+
+      request("submission/#{submission_id}.json", 'PUT', { body: arguments } )
+    end
+
+    def delete_submission(submission_id)
+      raise 'Submission ID must be numeric' unless submission_id.is_a? Numeric
+
+      request("submission/#{submission_id}", 'DELETE' )
+    end
+
+    def create_field(form_id, field_type = '', label = '', hide_label = false,
+                     description = '', use_callout = false,
+                     field_specific_attributes = [], default_value = '',
+                     options = [], options_values = [], required = false,
+                     read_only = false, hidden = false, unique = false,
+                     column_span = nil, sort = nil)
+
+      is_numeric?(form_id)
+
+      raise 'Provided Field Type is not in the list of known Field types' unless FIELD_TYPES.include? field_type
+
+      arguments = {}
+
+      arguments['field_type'] = field_type
+      arguments['label'] = label unless label.empty?
+      arguments['hide_label'] = 1 if hide_label
+      arguments['description'] = description unless description.empty?
+      arguments['description_callout'] = 1 if use_callout
+      arguments['default_value'] = default_value unless default_value.empty?
+      arguments['options'] = options unless options.empty?
+      arguments['options_values'] = options_values unless options_values.empty?
+      arguments['required'] = 1 if required
+      arguments['read_only'] = 1 if read_only
+      arguments['hidden'] = 1 if hidden
+      arguments['unique'] = 1 if unique
+      arguments['colspan'] = column_span unless column_span.nil?
+      arguments['sort'] = sort unless sort.nil?
+
+      request("form/#{form_id}/field", 'POST', { body: arguments } )
+    end
+
     private
 
+    def self.add_field_data(arguments, field_ids, field_values)
+
+      if field_ids.empty?
+        raise 'There must be a one-to-one relationship between Field IDs and their values' if field_ids.size != field_values.size
+      end
+
+      field_ids.each_with_index do |id, i|
+        raise 'Field IDs must be numeric' unless id.is_a? Numeric
+        arguments["field_#{field_ids[i]}"] = field_values[i]
+      end
+
+      arguments
+    end
+
+    def self.clean_arguments(args)
+      arguments = {}
+
+      args.each_pair do |key, value|
+        arguments[key] = value unless value == ''
+      end
+
+      arguments
+    end
+
     def is_numeric?(form_id)
       unless form_id.is_a? Numeric
         raise 'Form ID must be numeric'

data/spec/support/vcr.rb

@@ -1,19 +1,46 @@
 require 'vcr'
 require 'rspec'
 
-# ACCESS_TOKEN = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
-# FORM_ID = 0000000
-# INACCESSIBLE_FORM_ID = 0000001
-ACCESS_TOKEN = '982cf05d56baa2f12db45bea51d68968'
-FORM_ID = 1832745
-INACCESSIBLE_FORM_ID = 1832744
+ACCESS_TOKEN = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
+INACCESSIBLE_FORM_ID = 0000001
+DELETE_SUBMISSION_FORM = 0000000
+UPLOAD_FORM_ID = 0000000
+UPLOAD_FIELD_IDS = 00000000
+LOGO_PATH = File.join(File.dirname(__FILE__), '../fs-logo.png')
+SUBMIT_FORM_ID = DELETE_SUBMISSION_FORM
+CREATE_FIELD_FORM_ID = DELETE_SUBMISSION_FORM
+SUBMISSION_DETAILS_ID = 000000000
+SUBMISSION_DETAILS_FORM_ID = 0000000
+EDIT_SUBMISSION_FIELD_ID = 00000000
+EDIT_SUBMISSION_ARRAY_FIELD_ID = 00000000
+
+# ACCESS_TOKEN = '982cf05d56baa2f12db45bea51d68968'
+# INACCESSIBLE_FORM_ID = 1832744
+# DELETE_SUBMISSION_FORM = 1873710
+# UPLOAD_FORM_ID = 1875940
+# UPLOAD_FIELD_IDS = 28762308
+# LOGO_PATH = File.join(File.dirname(__FILE__), '../fs-logo.png')
+# SUBMIT_FORM_ID = DELETE_SUBMISSION_FORM
+# CREATE_FIELD_FORM_ID = DELETE_SUBMISSION_FORM
+# SUBMISSION_DETAILS_ID = 171938670
+# SUBMISSION_DETAILS_FORM_ID = 1873710
+# EDIT_SUBMISSION_FIELD_ID = 28705506
+# EDIT_SUBMISSION_ARRAY_FIELD_ID = 28705506
 
 VCR.configure do |c|
     c.cassette_library_dir = 'spec/vcr'
     c.hook_into :webmock # or :fakeweb
     c.filter_sensitive_data('<ACCESS_TOKEN>') { ACCESS_TOKEN }
-    c.filter_sensitive_data('<FORM_ID>') { FORM_ID }
+    c.filter_sensitive_data('<FORM_ID>') { SUBMIT_FORM_ID }
     c.filter_sensitive_data('<INACCESSIBLE_FORM_ID>') { INACCESSIBLE_FORM_ID }
+    c.filter_sensitive_data('<SUBMISSION_DETAILS_ID>') { SUBMISSION_DETAILS_ID }
+    c.filter_sensitive_data('<UPLOAD_FORM_ID>') { UPLOAD_FORM_ID }
+    c.filter_sensitive_data('<UPLOAD_FIELD_IDS>') { UPLOAD_FIELD_IDS }
+    c.filter_sensitive_data('<LOGO_PATH>') { LOGO_PATH }
+    c.filter_sensitive_data('<SUBMISSION_DETAILS_FORM_ID>') { SUBMISSION_DETAILS_FORM_ID }
+    c.filter_sensitive_data('<DELETE_SUBMISSION_FORM>') { DELETE_SUBMISSION_FORM }
+    c.filter_sensitive_data('<EDIT_SUBMISSION_FIELD_ID>') { EDIT_SUBMISSION_FIELD_ID }
+    c.filter_sensitive_data('<EDIT_SUBMISSION_ARRAY_FIELD_ID>') { EDIT_SUBMISSION_ARRAY_FIELD_ID }
     c.default_cassette_options = { record: :new_episodes }
     c.configure_rspec_metadata!
 end