paperform-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d483735478590697492be1a869f9536ef36275642a1ae95922cc94d65bc8caf8
+  data.tar.gz: 4c605b376aff5dd81ad32d21f63dc96436db4bb2b1ca19a090c6339af6c88ef6
+SHA512:
+  metadata.gz: 5f7f619a11e75537b0c858e0714f65f0ba5bd7b55c46e887bb12c3d838f2309907737c7b1b92535c48ed36280d28adba657ead24055bc97e34b8343a40f4f152
+  data.tar.gz: 482dd37a6075cfbf8c5e661015bf7e897e64b8a82510d8f7c187464bf5657801c96a7c99eb363fe113723fec4e731725b30474123530a0a2fb436a5d7be48945

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,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in paperform-ruby.gemspec
+gemspec
+
+gem 'curb'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    paperform-ruby (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    curb (0.9.10)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  curb
+  paperform-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Neeraj Kapoor
+
+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,63 @@
+# Paperform-Ruby
+
+This gem is a VERY basic wrapper around the very new Paperform API. I love Paperform and use it a lot in a lot of my projects. The API will help a lot and this wrapper should (hopefully!) make things easier as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paperform-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperform-ruby
+
+## Usage
+
+Head to the [developer documentation page](https://paperform.co/developer/api-v1-documentation/) on the paperform website for general info about the api. To get started, you'll need to generate a token. This will serve as the bearer token passed with every request you send to Paperform. Visit [this page](https://paperform.co/account/developer) in your paperform account to generate one. Note that you'll need to have a Pro or Agency account in order to use the API. Store this somewhere in your rails app (like a .env file or something). From there, you can use the gem like this:
+
+### Submissions
+
+```ruby
+require 'paperform'
+
+submission = Paperform::Submission.new(ENV['PAPERFORM_TOKEN']) # assuming I stored my paperform token in the env variable PAPERFORM_TOKEN
+
+submission.list('sample-form') # this is the slug prefix in your paperform url. Ie, sample-form.paperform.co.
+
+submission.list('<uuid>') # this is the uuid of the submission. You can find this value for a given submission in your paperform account
+
+```
+
+This will return a list of submitted forms. You can also pass an options hash as a second parameter. Check the developer documentation link above for attributes you can send in this options hash.
+
+
+### Partial Submissions
+
+```ruby
+require 'paperform'
+
+partial_sub = Paperform::PartialSubmission.new(ENV['PAPERFORM_TOKEN']) # assuming I stored my paperform token in the env variable PAPERFORM_TOKEN
+
+partial_sub.list('sample-form') # this is the slug prefix in your paperform url. Ie, sample-form.paperform.co.
+
+partial_sub.list('<uuid>') # this is the uuid of the submission. You can find this value for a given submission in your paperform account
+
+```
+
+This will return a list of partially submitted forms. You can also pass an options hash as a second parameter. Check the developer documentation link above for attributes you can send in this options hash.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nekapoor/paperform-ruby.
+
+## 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 "paperform"
+
+# 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/paperform.rb

@@ -0,0 +1,2 @@
+require 'paperform/partial_submission'
+require 'paperform/submission'

data/lib/paperform/partial_submission.rb

@@ -0,0 +1,32 @@
+module Paperform
+  class PartialSubmission
+    attr_reader :token
+
+    BASE_URL = 'https://api.paperform.co/v1/partial-submissions'
+
+    def initialize(token)
+      @token = token
+    end
+
+    def find(id)
+      params = { id: id }
+
+      response = Curl.get(BASE_URL, params) do |http|
+        http.headers['Authorization'] = "Bearer #{token}"
+      end
+
+      response.body
+    end
+
+    def list(form_id, options = nil)
+      params = { form: form_id }
+      params.merge!(options) if options
+
+      response = Curl.get(BASE_URL, params) do |http|
+        http.headers['Authorization'] = "Bearer #{token}"
+      end
+
+      response.body
+    end
+  end
+end

data/lib/paperform/submission.rb

@@ -0,0 +1,32 @@
+module Paperform
+  class Submission
+    attr_reader :token
+
+    BASE_URL = 'https://api.paperform.co/v1/submissions'
+
+    def initialize(token)
+      @token = token
+    end
+
+    def find(id)
+      params = { id: id }
+
+      response = Curl.get(BASE_URL, params) do |http|
+        http.headers['Authorization'] = "Bearer #{token}"
+      end
+
+      response.body
+    end
+
+    def list(form_id, options = nil)
+      params = { form: form_id }
+      params.merge!(options) if options
+
+      response = Curl.get(BASE_URL, params) do |http|
+        http.headers['Authorization'] = "Bearer #{token}"
+      end
+
+      response.body
+    end
+  end
+end

data/paperform-ruby.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperform-ruby"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Neeraj Kapoor"]
+  spec.email         = ["neeraj.kapoor@learntobe.org"]
+
+  spec.summary       = %q{A wrapper around the paperform api.}
+  spec.description   = %q{A wrapper around the paperform api.}
+  spec.homepage      = "https://github.com/nekapoor/paperform-ruby"
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: paperform-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Neeraj Kapoor
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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 wrapper around the paperform api.
+email:
+- neeraj.kapoor@learntobe.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/paperform.rb
+- lib/paperform/partial_submission.rb
+- lib/paperform/submission.rb
+- paperform-ruby.gemspec
+homepage: https://github.com/nekapoor/paperform-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: A wrapper around the paperform api.
+test_files: []