prontoforms 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7c768e20e9e5d22ed71d1670d805adf5aea683eda22749b414813fd7db7e072
-  data.tar.gz: 41ce8c58c17c213b2836109cb6f61d122453c70e848004c6c554ebd129fca3f5
+  metadata.gz: 5ad60a48189a843b3116774beae036174e1b606ff5b7be8e8ad65e08a5a94b7f
+  data.tar.gz: ca6fa882e2fa9f2bef9aa1753f1df168259d0aed49f316cd22bb7cb24f92aa37
 SHA512:
-  metadata.gz: 900424f174118c59d4fc7879d60f062054fca5dbc5d7404a047e9737b872ed3db69d2f1eb8cff3d23770e317ada5ea0014295c46c30201e84a29b64086040523
-  data.tar.gz: 2c46e843c469f31915e19b54193804890ab88d9d4632127e84c39895587e157561917cedd35a1a927d6cd25522692675f3a4606a7e23d85301aca3c81ed269bc
+  metadata.gz: 0e3abe87d14de60e671bdf88cd6eade2ce65ea1152826de892596ecc22ec4724c80679771978e87aed72125b2be3944edde0e21ab7680293dfd57c0a4678d1b7
+  data.tar.gz: 126bd9432699a6cd954c770f91c41c050aff180ef0368351cba122cabcb661ef864bb9d4dffb7b07fbc56c4b0128fd5787e9ecaba28cccfa8d83dca98f08c99d

data/.gitignore

@@ -11,3 +11,5 @@ Gemfile.lock
 
 # rspec failure tracking
 .rspec_status
+
+**/.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# prontoforms changelog
+
+
+## [Unreleased]
+### Added
+* Autogenerated documentation via YARD.
+
+### Changed
+* Errors now provide a message describing the issue
+* `ProntoForms::Client` now raises error on invalid resource definition.
+
+## [0.2.0] - 26 Aug 2020
+### Bugfixes
+* Corrected pagination of resource lists
+
+## [0.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

data/lib/prontoforms.rb

@@ -2,5 +2,17 @@ require 'prontoforms/version'
 require 'prontoforms/client'
 
 module ProntoForms
-  class Error < StandardError; end
+  class Error < StandardError
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+  end
+
+  class InvalidHttpVerb < Error
+    def initialize(verb)
+      super("Invalid HTTP verb: #{verb}")
+    end
+  end
 end

data/lib/prontoforms/client.rb

@@ -3,21 +3,32 @@ require 'json'
 require 'prontoforms/resource_list'
 require 'prontoforms/form_space'
 require 'prontoforms/form_submission'
+require 'prontoforms/user'
 
 module ProntoForms
   class Client
-    attr_reader :api_key_id, :api_key_secret
+    # @return [String]
+    attr_reader :api_key_id
+    # @return [String]
+    attr_reader :api_key_secret
 
+    # @param api_key_id Your ProntoForms REST API key
+    # @param api_key_secret Your ProntoForms REST API secret
     def initialize(api_key_id, api_key_secret)
       @api_key_id = api_key_id
       @api_key_secret = api_key_secret
     end
 
-    def self.resource(method, verb: :get, resource:, url: resource.resource_name)
-      # TODO: Raise error if verb is invalid
-
+    # Defines a resource that can be retrieved in a list
+    # @return [nil]
+    # @api private
+    # @!macro [attach] resource_list
+    #   @method $1
+    #   Retrieve a list of $2 resources
+    #   @return [ResourceList] A ResourceList containing $2 results
+    def self.resource_list(method, resource, url = resource.resource_name)
       define_method(method) do |query: {}|
-        res = connection.send(verb) do |req|
+        res = connection.get do |req|
           req.url url
           query.each { |k, v| req.params[k] = v }
         end
@@ -32,9 +43,42 @@ module ProntoForms
       end
     end
 
-    resource :form_spaces, resource: FormSpace
-    resource :form_submissions, resource: FormSubmission
+    resource_list :form_spaces, FormSpace
+    resource_list :form_submissions, FormSubmission
+
+    # Retrieve a user by identifier
+    # @param id [String] The user identifier
+    # @return [User] A User object for the requested user
+    def user(id)
+      return nil if id.nil?
+      res = connection.get do |req|
+        req.url "users/#{id.to_s}"
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        User.new(data, self)
+      else
+        nil
+      end
+    end
+
+    def form_submission(id)
+      return nil if id.nil?
+      res = connection.get do |req|
+        req.url "data/#{id.to_s}"
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        FormSubmission.new(data, self)
+      else
+        nil
+      end
+    end
 
+    # Create a connection that can be used to execute a request against the
+    # ProntoForms API.
+    # @return [Faraday::Connection]
+    # @api private
     def connection
       Faraday.new(url: 'https://api.prontoforms.com/api/1.1') do |conn|
         conn.basic_auth(api_key_id, api_key_secret)

data/lib/prontoforms/form_submission.rb

@@ -18,6 +18,7 @@ module ProntoForms
     property :data_persisted?, key: 'dataPersisted'
     property :submitter_id, key: 'userId'
     property :submitter_username, key: 'username'
+    property :dispatcher, key: 'dispatcher'
 
     property :server_receive_date do
       str = data.fetch('serverReceiveDate')
@@ -25,11 +26,30 @@ module ProntoForms
     end
 
     def pages
+      document.fetch('pages')
+    end
+
+    def dispatcher
+      client.user(document.dig('dispatcher', 'identifier'))
+    end
+
+    private
+
+    # Returns additional data about the submission. Uses cached data,
+    # otherwise it loads and returns the data via #document!
+    def document
+      return @document if !@document.nil?
+      document!
+    end
+
+    # Force loads the submission document
+    def document!
       res = client.connection.get do |req|
         req.url "#{resource_name}/#{id}/document.json"
       end
       if res.success?
-        JSON.parse(res.body).fetch('pages')
+        @document = JSON.parse(res.body)
+        @document
       end
     end
   end

data/lib/prontoforms/user.rb

@@ -0,0 +1,19 @@
+require 'prontoforms/resource'
+
+module ProntoForms
+  class User < Resource
+    def self.resource_name() 'users'; end
+
+    property :id, key: 'identifier'
+    property :username, key: 'username'
+    property :role, key: 'role'
+    property :email, key: 'email'
+    property :first_name, key: 'firstName'
+    property :last_name, key: 'lastName'
+    property :locale, key: 'locale'
+
+    def display_name
+      "#{first_name} #{last_name}"
+    end
+  end
+end

data/lib/prontoforms/version.rb

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

data/prontoforms.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prontoforms
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: A library for using the ProntoForms REST API in Ruby applications.
 email:
 - paul@holdensoftware.com
@@ -89,6 +103,7 @@ files:
 - lib/prontoforms/form_submission.rb
 - lib/prontoforms/resource.rb
 - lib/prontoforms/resource_list.rb
+- lib/prontoforms/user.rb
 - lib/prontoforms/version.rb
 - prontoforms.gemspec
 homepage: https://github.com/paulholden2/prontoforms