paperform-ruby 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d483735478590697492be1a869f9536ef36275642a1ae95922cc94d65bc8caf8
-  data.tar.gz: 4c605b376aff5dd81ad32d21f63dc96436db4bb2b1ca19a090c6339af6c88ef6
+  metadata.gz: 6060b4b81e688eb3c68472179a88537db75e07ff551ee978e015bfc17f3b973b
+  data.tar.gz: 38fe05801fb68fa25a66e19afabd55ed9930bcc7c47c85bae09410aaf00d6e4d
 SHA512:
-  metadata.gz: 5f7f619a11e75537b0c858e0714f65f0ba5bd7b55c46e887bb12c3d838f2309907737c7b1b92535c48ed36280d28adba657ead24055bc97e34b8343a40f4f152
-  data.tar.gz: 482dd37a6075cfbf8c5e661015bf7e897e64b8a82510d8f7c187464bf5657801c96a7c99eb363fe113723fec4e731725b30474123530a0a2fb436a5d7be48945
+  metadata.gz: 6059550d0a533cd613c6411fa20da16191b320c0ae115625a8bd2bf2e3df4955babe426298884d1479c17ec423a352415891355a67d5a9ff7fe84cf1bdede5bb
+  data.tar.gz: dc9beef02f378f066d90da442849cf8d174c705c6fb3a52224f48e2b41e8f38181f50a61f4ccbfa8ba2cb280e462c73d2e89b34daca1578252d2ee108a5520b4

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - master
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6", "2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: default
+          bundler-cache: true
+
+      - name: Run tests
+        run: |
+          bundle exec rake test

data/Gemfile

@@ -5,4 +5,3 @@ 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

@@ -1,37 +1,51 @@
 PATH
   remote: .
   specs:
-    paperform-ruby (1.0.0)
+    paperform-ruby (2.0.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
 
 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)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
+      multipart-post (>= 1.2, < 3)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    minitest (5.15.0)
+    multipart-post (2.1.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  curb
+  bundler (~> 2.3.4)
+  minitest (~> 5.0)
   paperform-ruby!
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
-   1.16.6
+   2.3.4

data/README.md

@@ -22,42 +22,81 @@ Or install it yourself as:
 
 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
+
+## Auth
+
+After we have gotten our token, we just need to initialize the client
 
 ```ruby
-require 'paperform'
+ client = Paperform::Client.new(token: token)
+```
 
-submission = Paperform::Submission.new(ENV['PAPERFORM_TOKEN']) # assuming I stored my paperform token in the env variable PAPERFORM_TOKEN
+Every request returns a JSON body response
 
-submission.list('sample-form') # this is the slug prefix in your paperform url. Ie, sample-form.paperform.co.
+## Forms
+```ruby
+client.forms
+```
+
+You can also pass in parameters that you need.
 
-submission.list('<uuid>') # this is the uuid of the submission. You can find this value for a given submission in your paperform account
+```ruby
+client.forms(limit: 200, skip: 3)
+``
 
+## Form
+
+```ruby
+client.form(slug_or_id)
+```
+
+## Form Fields
+
+```ruby
+client.form_fields(slug_or_id)
 ```
 
-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
+client.partial_submissions
+```
+You can also pass in parameters that you need.
 
-### Partial Submissions
+```ruby
+client.partial_submissions(limit: 200, skip: 3)
+```
+
+## Partial Submission
 
 ```ruby
-require 'paperform'
+client.partial_submission(slug_or_id)
+```
 
-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.
+## Submissions
 
-partial_sub.list('<uuid>') # this is the uuid of the submission. You can find this value for a given submission in your paperform account
+```ruby
+client.submissions
+```
+You can also pass in parameters that you need.
 
+```ruby
+client.submissions(limit: 200, skip: 3)
 ```
 
-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.
+## Submission
+
+```ruby
+client._submission(slug_or_id)
+```
 
 
 ## 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

@@ -1,6 +1,10 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "rake/testtask"
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
 
-task :default => :spec
+task default: :test

data/bin/console

@@ -10,5 +10,6 @@ require "paperform"
 # require "pry"
 # Pry.start
 
+client = Paperform::Client.new(token: ENV["PAPERFORM_TOKEN"])
 require "irb"
 IRB.start(__FILE__)

data/lib/paperform/client.rb

@@ -0,0 +1,79 @@
+module Paperform
+  class Client
+    BASE_URL = 'https://api.paperform.co/v1'
+    attr_reader :token
+
+    def initialize(token:, stubs: nil)
+      @token = token
+      @stubs = stubs
+    end
+
+    # GET /forms https://paperform.co/developer/api-v1-documentation/#tag/forms
+    def forms(**params)
+      handle_response connection.get('forms', params)
+    end
+
+    # GET https://paperform.co/developer/api-v1-documentation/#operation/Get%20Form
+    def form(slug_or_id)
+      handle_response connection.get("forms/#{slug_or_id}")
+    end
+
+    # GET https://paperform.co/developer/api-v1-documentation/#operation/Get%20Form%20Fields
+    def form_fields(slug_or_id)
+      handle_response connection.get("forms/#{slug_or_id}/fields")
+    end
+
+    # GET https://paperform.co/developer/api-v1-documentation/#operation/List%20Partial%20Submissions
+    def partial_submissions(**params)
+      handle_response connection.get('partial-submissions')
+    end
+
+
+    # GET https://paperform.co/developer/api-v1-documentation/#operation/Get%20Partial%20Submission
+    def partial_submission(slug_or_id)
+      handle_response connection.get("partial-submissions/#{slug_or_id}")
+    end
+
+    # GET https://paperform.co/developer/api-v1-documentation/#operation/List%20Submissions
+    def submissions(form:, **params)
+      handle_response(connection.get('submissions', {form: form}.merge(params)))
+    end
+
+    # GET https://paperform.co/developer/api-v1-documentation/#operation/Get%20Submission
+    def submission(slug_or_id)
+      handle_response connection.get("submissions/#{slug_or_id}")
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: BASE_URL) do |faraday|
+        faraday.headers['Authorization'] = "Bearer #{@token}"
+        if @stubs
+          faraday.adapter :test, @stubs
+        end
+      end
+    end
+
+
+    def handle_response(response)
+      case response.status
+      when 200
+        response.body
+      when 400
+        raise Error, response.body
+      when 401
+        raise Error, response.body
+      when 403
+        raise Error, response.body
+      when 404
+        raise Error, response.body
+      when 422
+        raise Error, response.body
+      when 500
+        raise Error, "Possible Internal Server Error"
+      end
+      JSON.parse response.body
+    end
+  end
+end

data/lib/paperform/error.rb

@@ -0,0 +1,3 @@
+module Paperform
+  class Error < StandardError; end
+end

data/lib/paperform-ruby.rb

@@ -0,0 +1 @@
+require 'paperform'

data/lib/paperform.rb

@@ -1,2 +1,8 @@
-require 'paperform/partial_submission'
-require 'paperform/submission'
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Paperform
+  autoload :Client, "paperform/client"
+  autoload :Error, "paperform/error"
+end

data/paperform-ruby.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "paperform-ruby"
-  spec.version       = "1.0.0"
+  spec.version       = "2.0.0"
   spec.authors       = ["Neeraj Kapoor"]
   spec.email         = ["neeraj.kapoor@learntobe.org"]
 
@@ -22,7 +22,10 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "bundler", "~> 2.3.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperform-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Neeraj Kapoor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.3.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: A wrapper around the paperform api.
 email:
 - neeraj.kapoor@learntobe.org
@@ -59,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -69,9 +98,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/paperform-ruby.rb
 - lib/paperform.rb
-- lib/paperform/partial_submission.rb
-- lib/paperform/submission.rb
+- lib/paperform/client.rb
+- lib/paperform/error.rb
 - paperform-ruby.gemspec
 homepage: https://github.com/nekapoor/paperform-ruby
 licenses:
@@ -92,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A wrapper around the paperform api.

data/lib/paperform/partial_submission.rb

@@ -1,32 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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