base-api-io 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e74548e5c837271421a840efb03a5f1628fd966d983c4c625b5e9f9cfb46030
-  data.tar.gz: 29fb96e090096e92481bf4f5dd469cb78209b1bb0e2c10c781a30e747abfb491
+  metadata.gz: 2f086dfdafe3a95bac7eeae96906a961d0384c0f084362764b36255e88ef020c
+  data.tar.gz: 8a2e73d49677a5fa9abf2ab1361c5c0d3533cf70e26a3e13553321cae5643e23
 SHA512:
-  metadata.gz: d7ebd5db36d69905b2865580e7af8789e62c94a81044421d80fc9eabcaeb6edd661f5ce56238bd4ac37c9d071c9c0d081820a7843adc75e8e73aad34279b04e9
-  data.tar.gz: a0a1580044bbb747f038840f3976b75477c312add6df34d2228e13a8ef98981c50e9ddfe98e6cfb796caf5e2b7fbb68790133a5cc579bc9b97e9db393b408876
+  metadata.gz: 065f852cf4e48ac7ef6a535c804b8658e2948fd474e902d7d3160ef48da0c19ffb1fbc4941fffd369dcfd7e71fa7cea61ca01b60c1b9926d528375cc988af09f
+  data.tar.gz: ee36bec80f5c6940b9e24382da0355dcdd6eee658112bb4e2e8e8fb310347e900b0d5e4fc01e96229f7a3ffd0259dce9cc7f5d3a9c2236ef6685ea6f9789e9ac

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    base-api-io (1.3.0)
+    base-api-io (1.4.0)
       faraday (~> 0.15.4)
+      mimetype-fu (~> 0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -17,6 +18,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     hashdiff (1.0.0)
     jaro_winkler (1.5.3)
+    mimetype-fu (0.1.2)
     multipart-post (2.1.1)
     parallel (1.17.0)
     parser (2.6.3.0)

data/README.md

@@ -232,6 +232,53 @@ results =
     text: 'Text')
 ```
 
+### Forms
+
+A project can have many forms and those form can have many submissions.
+
+The `forms` endpoint allows you to programatically create, submit and manage forms.
+
+```ruby
+# List forms
+forms = client.forms.list(page: 1, per_page: 10)
+forms.items     # The array of forms
+forms.metadata  # The metadata object containing the total count
+
+# Create a form
+form =
+  client.forms.create(name: 'Form')
+
+# Get a form
+form =
+  client.forms.get('form_id')
+
+# Delete a form (and it's submissions)
+form =
+  client.forms.delete('form_id')
+
+# Submit a form
+submission =
+  client.forms.submit(
+    id: 'form_id',
+    form: {
+      file: File.open('description.txt'),
+      key: 'value'
+    })
+
+# List form submissions
+submissions = client.forms.submissions(id: 'form_id', page: 1, per_page: 10)
+submissions.items     # The array of forms submissions
+submissions.metadata  # The metadata object containing the total count
+
+# Get a submission
+submission =
+  client.forms.get_submission('form_id', 'submission_id')
+
+# Delete a submission
+submission =
+  client.forms.delete_submission('form_id', 'submission_id')
+```
+
 ## Development
 
 This library uses [Faraday](https://lostisland.github.io/faraday/), you can run the

data/base-api-io.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday', '~> 0.15.4'
+  spec.add_dependency 'mimetype-fu', '~> 0.1.2'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/base.rb

@@ -2,5 +2,6 @@
 
 require 'faraday'
 require 'json'
+require 'mimetype_fu'
 
 require_relative 'base/client'

data/lib/base/client.rb

@@ -11,6 +11,7 @@ require_relative 'endpoints/images'
 require_relative 'endpoints/emails'
 require_relative 'endpoints/users'
 require_relative 'endpoints/files'
+require_relative 'endpoints/forms'
 
 module Base
   # A client containing all the endpoints.
@@ -36,6 +37,9 @@ module Base
     # Endpoint for the files.
     attr_reader :files
 
+    # Endpoint for the files.
+    attr_reader :forms
+
     # Initializes a new client with an access_token and optional url.
     def initialize(access_token:, url: 'https://api.base-api.io')
       @users =
@@ -79,6 +83,12 @@ module Base
           access_token: access_token,
           url: url
         )
+
+      @forms =
+        Endpoints::Forms.new(
+          access_token: access_token,
+          url: url
+        )
     end
   end
 end

data/lib/base/endpoints/forms.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Base
+  module Endpoints
+    # This endpoint contains methods for forms.
+    class Forms < Endpoint
+      # Initializes this endpoint.
+      def initialize(access_token:, url:)
+        @path = 'forms'
+        super
+      end
+
+      # Lists the forms of a project
+      def list(page: 1, per_page: 10)
+        request do
+          response =
+            connection.get('', per_page: per_page, page: page)
+
+          parse(response.body)
+        end
+      end
+
+      # Creates a form with the given name
+      def create(name:)
+        request do
+          response =
+            connection.post('', 'name' => name)
+
+          parse(response.body)
+        end
+      end
+
+      # Returns the form with the given ID.
+      def get(id)
+        request do
+          response =
+            connection.get id
+
+          parse(response.body)
+        end
+      end
+
+      # Deletes the form with the given ID.
+      def delete(id)
+        request do
+          response =
+            connection.delete id
+
+          parse(response.body)
+        end
+      end
+
+      # Submits a new submission for the form with the given ID.
+      def submit(id:, form:)
+        request do
+          payload =
+            form.each_with_object({}) do |(key, value), memo|
+              memo[key] =
+                case value
+                when File, Tempfile
+                  Faraday::UploadIO.new(
+                    value.path,
+                    File.mime_type?(value),
+                    File.basename(value)
+                  )
+                else
+                  value
+                end
+            end
+
+          response =
+            connection.post("#{id}/submit", payload)
+
+          parse(response.body)
+        end
+      end
+
+      # Returns the submission for the form with the given ID.
+      def submissions(id:,
+                      page: 1,
+                      per_page: 10)
+        request do
+          response =
+            connection.get("#{id}/submissions", per_page: per_page, page: page)
+
+          parse(response.body)
+        end
+      end
+
+      # Returns the submission with the given ID of the form with the given ID.
+      def get_submission(id, submission_id)
+        request do
+          response =
+            connection.get "#{id}/submissions/#{submission_id}"
+
+          parse(response.body)
+        end
+      end
+
+      # Deletes the submission with the given ID of the form with the given ID.
+      def delete_submission(id, submission_id)
+        request do
+          response =
+            connection.delete "#{id}/submissions/#{submission_id}"
+
+          parse(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/base/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Base
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base-api-io
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Gusztáv Szikszai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: mimetype-fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ files:
 - lib/base/endpoint.rb
 - lib/base/endpoints/emails.rb
 - lib/base/endpoints/files.rb
+- lib/base/endpoints/forms.rb
 - lib/base/endpoints/images.rb
 - lib/base/endpoints/mailing_lists.rb
 - lib/base/endpoints/passwords.rb