prontoforms 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d15ef56d13e8ea0e980e73be80c8a766b9d82ab5947899aea364e5e5f8562bd0
-  data.tar.gz: 75e60d77da7d5bfabf8494029a5e80f24f8548fb1f8781847e4adf2e4b43b797
+  metadata.gz: cf9bb12142b5957e341f48804ce06b73f8842cdcbe8e2831e34823299ca73017
+  data.tar.gz: c3760f082616943fa75dd0fad8f4bf0554390d75bea741f448baead8ce97bdfc
 SHA512:
-  metadata.gz: 7b3883d2eb0c2a740546ac2d9deb955dc90e68c66dec3409b3fa05ba025111b4fd8340c84b40861071a7a47851250df95062edcd08f43f3b24fb9b14954f1a90
-  data.tar.gz: 0d483ea0b5b6cb8bf112a3c6097c6ff2af4180a8c5b6c859afc7b724a57e5a0999b14c49aecc03d887f3bf09d5de85668254f52ab9a87bb9131bceb83515c713
+  metadata.gz: 4a5da5f5afda87fd00f326deba55c97169aad8918347f308df002c2525420e92d8a22983199a2bf498afa0b8a55ea32be25549a5b20ce86fb0578123100733c8
+  data.tar.gz: 8f0312762f55f92b0a3d5383fef1cc1558b9e65a7ba8d7c2f770c63a97d0ef695976e542459b839bf76966f05daf776c4b8aff9dad5ca4dad690448ed64c31da

data/lib/prontoforms/form.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'prontoforms/resource'
+require 'prontoforms/form_iteration'
 
 module ProntoForms
   # A form includes inputs, validations, logic, and other configuration that
@@ -18,5 +19,57 @@ module ProntoForms
     property :description, key: 'description'
     # @return [String] Form state
     property :state, key: 'state'
+
+    # Get the Form's form space ID
+    # @return [String] Form space identifier
+    def form_space_id
+      parent.id
+    end
+
+    def active_version_id
+      full_data.dig('activeVersion', 'identifier')
+    end
+
+    def current_version
+      res = client.connection.get do |req|
+        req.url "#{url}/iterations/#{active_version_id}"
+      end
+
+      FormIteration.new(JSON.parse(res.body), client, self)
+    end
+
+    def iteration(id)
+      raise ArgumentError, 'id must be provided' if id.nil?
+
+      res = client.connection.get do |req|
+        req.url "#{url}/iterations/#{id}"
+      end
+
+      FormIteration.new(JSON.parse(res.body), client, self)
+    end
+
+    def iterations(query: {})
+      res = client.connection.get do |req|
+        req.url "#{url}/iterations"
+      end
+
+      ResourceList.new(JSON.parse(res.body), {
+        'p' => 0,
+        's' => 100
+      }.merge(query), :iterations, FormIteration, client, self)
+    end
+
+    private
+
+    def full_data
+      return @full_data unless @full_data.nil?
+
+      @full_data = client.form_space(form_space_id).form(id).data
+      @full_data
+    end
+
+    def url
+      "formspaces/#{form_space_id}/forms/#{id}"
+    end
   end
 end

data/lib/prontoforms/form_iteration.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'prontoforms/resource'
+
+module ProntoForms
+  # A form iteration is a form configuration, distinct from a form version
+  # in that version numbers increment when a form iteration is deployed.
+  class FormIteration < Resource
+    def self.resource_name
+      'iterations'
+    end
+
+    # @return [String] The form iteration identifier
+    property :id, key: 'identifier'
+    # @return [Integer] Version number
+    property :version, key: 'version'
+    # @return [String] Form iteration state
+    property :state, key: 'state'
+    # @return [String] Initiation method for the form iteration
+    property :initiation_method, key: 'initiationMethod'
+    # @return [String] Can dispatched forms of this iteration be declined
+    property :dispatched_declinable, key: 'dispatchDeclinable'
+
+    alias can_decline_dispatch? dispatched_declinable
+
+    # @return [Array] Array of document IDs attached to this iteration
+    def document_ids
+      full_data.fetch('documentIds')
+    end
+
+    private
+
+    def full_data
+      return @full_data unless @full_data.nil?
+
+      @full_data = parent.iteration(id).data
+      @full_data
+    end
+  end
+end

data/lib/prontoforms/form_space.rb

@@ -31,6 +31,15 @@ module ProntoForms
       }, :documents, Document, self)
     end
 
+    def form(form_id)
+      res = client.connection.get do |req|
+        req.url "formspaces/#{id}/forms/#{form_id}"
+      end
+
+      data = JSON.parse(res.body)
+      Form.new(data, client, self)
+    end
+
     # Get all forms in the form space
     # @return [ResourceList] A ResourceList containing Form objects
     def forms(query: {})
@@ -42,7 +51,7 @@ module ProntoForms
       ResourceList.new(JSON.parse(res.body), {
         'p' => 0,
         's' => 100
-      }.merge(query), :forms, Form, self)
+      }.merge(query), :forms, Form, client, self)
     end
   end
 end

data/lib/prontoforms/form_submission.rb

@@ -64,43 +64,56 @@ module ProntoForms
     # Retrieve the form space for the form submission
     # @return [FormSpace] Form space for the submission's form
     def form_space
-      client.form_space(data.dig('form', 'formSpaceId'))
+      client.form_space(full_data.dig('form', 'formSpaceId'))
     end
 
     # Retrieve the form for the form submission
     # @return [Form] Form for the submission
     def form
-      client.form(data.dig('form', 'formId'))
+      form_space.form(full_data.dig('form', 'formId'))
     end
 
-    # Retrieve the standard PDF document for the form submission
-    # @return [IO] Readable stream containing the PDF contents
-    def pdf
+    # Retrieve the current version of the form
+    # @return [FormIteration] The form iteration
+    def form_version
+      form.current_version
+    end
+
+    # Retrieve all documents attached to this form submission
+    # @return [Array] Documents attached to the form submission
+    def documents(populate: false)
+      ids = form_version.document_ids
+      if populate
+        ids.map { |id| form.iteration(id) }
+      else
+        ids
+      end
+    end
+
+    # Download a specific document. The Document must have been attached to
+    # the form's current version at the time of submission.
+    # @return [IO] Data stream for the document
+    def download_document(document)
       io = StringIO.new
       client.connection.get do |req|
-        req.url "#{resource_name}/#{id}/documents/#{pdf_document.id}"
-        req.options.on_data = proc do |chunk|
-          io << chunk
-        end
+        req.url "#{url}/documents/#{document.id}"
+        req.options.on_data = proc { |chunk| io << chunk }
       end
-
       io.rewind
       io
     end
 
     private
 
-    # Retrieve the standard PDF document for the form submission
-    # @return [Document] PDF document for the form submission
-    # @raises RuntimeError
-    def pdf_document
-      document = form_space.documents.items.find do |doc|
-        doc.type == 'Pdf' && doc.standard?
-      end
+    def url
+      "#{resource_name}/#{id}"
+    end
 
-      raise "No PDF document found for form space #{fs.id}" if document.nil?
+    def full_data
+      return @full_data unless @full_data.nil?
 
-      document
+      @full_data = client.form_submission(id).data
+      @full_data
     end
 
     # Returns additional data about the submission. Uses cached data,

data/lib/prontoforms/resource.rb

@@ -20,7 +20,8 @@ module ProntoForms
         if block_given?
           instance_eval(&block)
         elsif !key.nil?
-          data.fetch(key)
+          key = [key] unless key.is_a?(Array)
+          key.inject(data) { |obj, k| obj.fetch(k) }
         end
       end
     end

data/lib/prontoforms/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProntoForms
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prontoforms
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,6 +159,7 @@ files:
 - lib/prontoforms/client.rb
 - lib/prontoforms/document.rb
 - lib/prontoforms/form.rb
+- lib/prontoforms/form_iteration.rb
 - lib/prontoforms/form_space.rb
 - lib/prontoforms/form_submission.rb
 - lib/prontoforms/resource.rb