prontoforms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1aa48580fd863fe9681a3ba6f901415e0775c082929532bd63e8c93de86bf121
+  data.tar.gz: 5a21dd84aef6f4da5d285fa1587aebf79fec6d279aa10048efa0f1c6a29a1f48
+SHA512:
+  metadata.gz: 80299aa7c0a311c26467325e425b6f9ec39c5eda4692a9d613b40a07fe267b7751a88ecdca714071292a6f827520c35781bba0202023e9fd877dd3d6e851e0d4
+  data.tar.gz: '08f2da72649027dee6103e24b7d932047069d9e9ebabd36b1688928ec6f2359100d4d2d6a2e22eeef4e17e1b5941752b306b9351c37a86f65dc980adf1c0c15a'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prontoforms.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    prontoforms (0.1.0)
+      faraday (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  prontoforms!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paul Holden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# ProntoForms
+
+A library for interacting with the ProntoForms REST API in Ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prontoforms'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install prontoforms
+
+## Usage
+
+Check back later
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/paulholden2/prontoforms.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prontoforms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prontoforms.rb

@@ -0,0 +1,6 @@
+require 'prontoforms/version'
+require 'prontoforms/client'
+
+module ProntoForms
+  class Error < StandardError; end
+end

data/lib/prontoforms/client.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+require 'json'
+require 'prontoforms/resource_list'
+require 'prontoforms/form_space'
+require 'prontoforms/form_submission'
+
+module ProntoForms
+  class Client
+    attr_reader :api_key_id, :api_key_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
+
+      define_method(method) do |query: {}|
+        res = connection.send(verb) do |req|
+          req.url url
+          query.each { |k, v| req.params[k] = v }
+        end
+        if res.success?
+          ResourceList.new(JSON.parse(res.body), 0, 20, method, resource, self)
+        else
+          nil
+        end
+      end
+    end
+
+    resource :form_spaces, resource: FormSpace
+    resource :form_submissions, resource: FormSubmission
+
+    def connection
+      Faraday.new(url: 'https://api.prontoforms.com/api/1.1') do |conn|
+        conn.basic_auth(api_key_id, api_key_secret)
+      end
+    end
+  end
+end

data/lib/prontoforms/form_space.rb

@@ -0,0 +1,10 @@
+require 'prontoforms/resource'
+
+module ProntoForms
+  class FormSpace < Resource
+    property :id, key: 'identifier'
+    property :name, key: 'name'
+    property :problem_contact_email, key: 'problemContactEmail'
+    property :push_updates_to_device, key: 'pushUpdatesToDevice'
+  end
+end

data/lib/prontoforms/form_submission.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'prontoforms/resource'
+
+module ProntoForms
+  class FormSubmission < Resource
+    def self.resource_name() 'data'; end
+
+    property :id, key: 'identifier'
+    property :reference_number, key: 'referenceNumber'
+    property :state, key: 'state'
+    property :data_state, key: 'dataState'
+    property :data_persisted, key: 'dataPersisted'
+    property :form_version_id, key: 'formVersionId'
+    property :form_id, key: 'formId'
+    property :user_id, key: 'userId'
+    property :username, key: 'username'
+    # Aliases
+    property :data_persisted?, key: 'dataPersisted'
+    property :submitter_id, key: 'userId'
+    property :submitter_username, key: 'username'
+
+    property :server_receive_date do
+      str = data.fetch('serverReceiveDate')
+      str.nil? ? nil : DateTime.strptime(str)
+    end
+
+    def pages
+      res = client.connection.get do |req|
+        req.url "#{resource_name}/#{id}/document.json"
+      end
+      if res.success?
+        JSON.parse(res.body).fetch('pages')
+      end
+    end
+  end
+end

data/lib/prontoforms/resource.rb

@@ -0,0 +1,34 @@
+require 'date'
+
+module ProntoForms
+  class Resource
+    attr_reader :data, :client, :parent
+
+    def self.property(name, key: nil, &block)
+      define_method(name) {
+        if block_given?
+          instance_eval(&block)
+        elsif !key.nil?
+          data.fetch(key)
+        else
+          nil
+        end
+      }
+    end
+
+    def initialize(data, client, parent = nil)
+      @data = data
+      @client = client
+      @parent = parent
+    end
+
+    def self.resource_name
+      name = self.to_s.split("::").last
+      "#{name.downcase}s"
+    end
+
+    def resource_name
+      self.class.resource_name
+    end
+  end
+end

data/lib/prontoforms/resource_list.rb

@@ -0,0 +1,25 @@
+require 'prontoforms/resource'
+
+module ProntoForms
+  class ResourceList < Resource
+    attr_reader :limit, :offset, :method, :resource, :client, :parent
+
+    def initialize(data, offset, limit, method, resource, client, parent = nil)
+      super(data, client)
+      @limit = limit
+      @offset = offset
+      @method = method
+      @resource = resource
+    end
+
+    def next
+      client.send(method, limit: limit, offset: offset + limit)
+    end
+
+    def items
+      @data.fetch('pageData').map { |item|
+        resource.new(item, client, parent)
+      }
+    end
+  end
+end

data/lib/prontoforms/version.rb

@@ -0,0 +1,3 @@
+module ProntoForms
+  VERSION = '0.1.0'
+end

data/prontoforms.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/prontoforms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prontoforms'
+  spec.version       = ProntoForms::VERSION
+  spec.authors       = ['Paul Holden']
+  spec.email         = ['paul@holdensoftware.com']
+
+  spec.summary       = 'A library for using the ProntoForms REST API in Ruby applications.'
+  spec.description   = 'A library for using the ProntoForms REST API in Ruby applications.'
+  spec.homepage      = 'https://github.com/paulholden2/prontoforms'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/paulholden2/prontoforms'
+  spec.metadata['changelog_uri'] = 'https://github.com/paulholden2/prontoforms/blog/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: prontoforms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Holden
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A library for using the ProntoForms REST API in Ruby applications.
+email:
+- paul@holdensoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prontoforms.rb
+- lib/prontoforms/client.rb
+- lib/prontoforms/form_space.rb
+- lib/prontoforms/form_submission.rb
+- lib/prontoforms/resource.rb
+- lib/prontoforms/resource_list.rb
+- lib/prontoforms/version.rb
+- prontoforms.gemspec
+homepage: https://github.com/paulholden2/prontoforms
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/paulholden2/prontoforms
+  source_code_uri: https://github.com/paulholden2/prontoforms
+  changelog_uri: https://github.com/paulholden2/prontoforms/blog/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A library for using the ProntoForms REST API in Ruby applications.
+test_files: []