prontoforms 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad60a48189a843b3116774beae036174e1b606ff5b7be8e8ad65e08a5a94b7f
-  data.tar.gz: ca6fa882e2fa9f2bef9aa1753f1df168259d0aed49f316cd22bb7cb24f92aa37
+  metadata.gz: e363d8b04b4054609edf5c8e22598b3c6a86a04f0e749f4b25bd78b731960259
+  data.tar.gz: dc9862112d51ab6548238d9169ec9107115ca95d133a33c5ce44e369a4d11e9d
 SHA512:
-  metadata.gz: 0e3abe87d14de60e671bdf88cd6eade2ce65ea1152826de892596ecc22ec4724c80679771978e87aed72125b2be3944edde0e21ab7680293dfd57c0a4678d1b7
-  data.tar.gz: 126bd9432699a6cd954c770f91c41c050aff180ef0368351cba122cabcb661ef864bb9d4dffb7b07fbc56c4b0128fd5787e9ecaba28cccfa8d83dca98f08c99d
+  metadata.gz: 2c10a51687e5a8c06deed0034a90972ad0bf3f09c09dac034566fb8475eb7cdbd7996027d8ead0ce78be2d8f0af47d1f4017dae38c4f99c7ee6fe74da1c7f2f0
+  data.tar.gz: e064a89db1bad77d3bff769598c587649621e488e173cbec29664831d43a024c4ded3200d97cf8ba4be314bf4dcd15415d8ea2f5699994a9f8defc37c4988387

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 # prontoforms changelog
 
 
-## [Unreleased]
+## [v0.3.0]
 ### Added
 * Autogenerated documentation via YARD.
 
@@ -9,13 +9,14 @@
 * Errors now provide a message describing the issue
 * `ProntoForms::Client` now raises error on invalid resource definition.
 
-## [0.2.0] - 26 Aug 2020
+## [v0.2.0] - 26 Aug 2020
 ### Bugfixes
 * Corrected pagination of resource lists
 
-## [0.1.0] - 25 Aug 2020
+## [v0.1.0] - 25 Aug 2020
 * Initial release
 
-[Unreleased]: https://github.com/paulholden2/prontoforms/compare/v0.2.0...HEAD
-[0.1.0]: https://github.com/paulholden2/prontoforms/releases/tag/v0.1.0
-[0.2.0]: https://github.com/paulholden2/prontoforms/releases/tag/v0.2.0
+[Unreleased]: https://github.com/paulholden2/prontoforms/compare/v0.3.0...HEAD
+[v0.1.0]: https://github.com/paulholden2/prontoforms/releases/tag/v0.1.0
+[v0.2.0]: https://github.com/paulholden2/prontoforms/releases/tag/v0.2.0
+[v0.3.0]: https://github.com/paulholden2/prontoforms/releases/tag/v0.3.0

data/lib/prontoforms.rb

@@ -9,10 +9,4 @@ module ProntoForms
       @message = message
     end
   end
-
-  class InvalidHttpVerb < Error
-    def initialize(verb)
-      super("Invalid HTTP verb: #{verb}")
-    end
-  end
 end

data/lib/prontoforms/form_space.rb

@@ -2,9 +2,13 @@ require 'prontoforms/resource'
 
 module ProntoForms
   class FormSpace < Resource
+    # @return [String] The FormSpace identifier
     property :id, key: 'identifier'
+    # @return [String] The FormSpace name
     property :name, key: 'name'
+    # @return [String] The address that error emails are sent to
     property :problem_contact_email, key: 'problemContactEmail'
+    # @return [Boolean] Whether updates are automatically pushed to devices
     property :push_updates_to_device, key: 'pushUpdatesToDevice'
   end
 end

data/lib/prontoforms/form_submission.rb

@@ -25,10 +25,14 @@ module ProntoForms
       str.nil? ? nil : DateTime.strptime(str)
     end
 
+    # Retrieve the pages containing the form questions and answers
+    # @return [Hash] Hash of questions and answers for the FormSubmission
     def pages
       document.fetch('pages')
     end
 
+    # Retrieve the dispatching User, if the form was dispatched
+    # @return [User] The user that dispatched the form, or nil
     def dispatcher
       client.user(document.dig('dispatcher', 'identifier'))
     end

data/lib/prontoforms/resource_list.rb

@@ -11,10 +11,15 @@ module ProntoForms
       @resource = resource
     end
 
+    # Retrieve the next page of results, using the same number of items per
+    # page as the original request.
+    # @return [ResourceList] A ResourceList with the next set of results
     def next
       client.send(method, query: query.merge({ 'p' => query['p'] + 1}))
     end
 
+    # Retrieve the result set
+    # @return [Array] Array of resource objects
     def items
       @data.fetch('pageData').map { |item|
         resource.new(item, client, parent)

data/lib/prontoforms/user.rb

@@ -4,14 +4,24 @@ module ProntoForms
   class User < Resource
     def self.resource_name() 'users'; end
 
+    # @return [String] The User identifier
     property :id, key: 'identifier'
+    # @return [String] The user's username
     property :username, key: 'username'
+    # @return [String] The user's role
     property :role, key: 'role'
+    # @return [String] The user's email address
     property :email, key: 'email'
+    # @return [String] The user's first name
     property :first_name, key: 'firstName'
+    # @return [String] The user's last name
     property :last_name, key: 'lastName'
+    # @return [String] The user's preferred locale
     property :locale, key: 'locale'
 
+    # Get a display name consisting of the first name followed by last name
+    # e.g. "John Doe"
+    # @return [String] The display name for the user
     def display_name
       "#{first_name} #{last_name}"
     end

data/lib/prontoforms/version.rb

@@ -1,3 +1,3 @@
 module ProntoForms
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prontoforms
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Paul Holden