formio 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 381a07d7ab5966796ebd564c3dc997dbc0e0c1d109fcacd24d35d9e693e88f52
+  data.tar.gz: b371922c91953de976f9a2547e438caa154d522c5c61c4d7023baedf6766a753
+SHA512:
+  metadata.gz: 77b94aa40862154e11b62198282041f11e40aeeeb2951ade5800deebf6b7c434aa7b9ce161dbe6d2e864188420bbbe44a46ce1bf2cf25837ccd78c7466832474
+  data.tar.gz: d29b5954e9520659406a56b2475e8fadf78af0e40bce8d8911ee66eb161956d8205c6e2ab13925ed27b4bfdae73f69b0e8068fe8ef0f65088337c8d2d2791fcc

data/README.md

@@ -0,0 +1 @@
+This is a gem to integrate ruby the formio platform

data/lib/formio.rb

@@ -0,0 +1,6 @@
+module Formio
+end
+
+require 'formio/client'
+require 'formio/record'
+require 'formio/form'

data/lib/formio/client.rb

@@ -0,0 +1,209 @@
+module Formio
+  class Client
+    def initialize(project_url, email: nil, password: nil, auth_token: nil)
+      @project_url = project_url
+      @email = email
+      @password = password
+      @auth_token = auth_token
+      login if email.present? && password.present?
+    end
+
+    def index(form)
+      response = connection.get do |req|
+        req.url "/#{form}/submission?limit=1000000&skip=0&sort=-created"
+        set_headers(req)
+      end
+      parse_response(response.body).map do |formio_hash|
+        Record.new(formio_hash)
+      end
+    end
+
+    def create(form:, values:)
+      values.each do |(k,_)|
+        values[k] ||= ""
+      end
+      response = connection.post do |req|
+        req.url "/#{form}/submission/"
+        set_headers(req)
+        req.body = {
+          data: values
+        }.to_json
+      end
+      if response.status >= 200 && response.status < 300
+        Record.new(parse_response(response.body))
+      else
+        parse_response(response.body)['details'].map { |x| x['message'] }
+      end
+    end
+
+    def update(record)
+      raise "Must supply a formio form" unless record.is_a?(Record)
+      response = connection.put do |req|
+        req.url "/#{record.form_name}/submission/#{record.id}"
+        req.url "/form/#{record.form_id}/submission/#{record.id}" if record.form_id
+        set_headers(req)
+        req.body = record.to_json
+      end
+
+      return update(record) if response.status == 502
+      if response.status >= 200 && response.status < 300
+        Record.new(parse_response(response.body))
+      else
+        parse_response(response.body)['details'].map { |x| x['message'] }
+      end
+    end
+
+    def find_by_id(form, submission_id)
+      response = connection.get do |req|
+        req.url "/#{form}/submission/#{submission_id}"
+        set_headers(req)
+      end
+      return find_by_id form, submission_id if response.status == 502
+      if response.status == 200
+        Record.new(parse_response(response.body))
+      else
+        Record::Nil.new
+      end
+    end
+
+    def find_by(form, values=[])
+      response = connection.get do |req|
+        req.url "/#{form}/exists"
+        set_headers(req)
+        values.each do |(k,v)|
+          k = 'data.' + k.to_s unless k.to_s.start_with?('data.')
+          req.params[k] = v
+        end
+      end
+      return find_by(form, values) if response.status == 502
+      if response.status == 200
+        return find_by_id(form, JSON.parse(response.body)['_id'])
+      else
+        Record::Nil.new
+      end
+    end
+
+    def delete(form, submission_id)
+      response = connection.delete do |req|
+        req.url "/#{form}/submission/#{submission_id}"
+        set_headers(req)
+      end
+      response.status == 200
+    end
+
+    def form_meta_data(form = 'form')
+      response = connection.get do |req|
+        req.url "/#{form}"
+        set_headers(req)
+      end
+      response = parse_response(response.body)
+      if response.is_a?(Array)
+        return response.map do |f|
+          FormioForm.new f
+        end
+      end
+      FormioForm.new(response)
+    end
+
+    def create_form(formio_form)
+      raise "Must supply a formio form" unless formio_form.is_a?(FormioForm)
+      response = connection.post do |req|
+        req.url "/form"
+        set_headers(req)
+        req.body = formio_form.to_json
+      end
+      if response.status != 201
+        raise (JSON.parse(response.body)['message'])
+      end
+      true
+    end
+
+    def delete_form(form_name)
+      response = connection.delete do |req|
+        req.url "/#{form_name}"
+        set_headers(req)
+      end
+      response.status == 200 || response.body == 'Invalid alias'
+    end
+
+    def set_headers(req)
+      req.headers['Content-Type'] = 'application/json'
+      req.headers['Accept'] = 'application/json'
+      req.headers['x-jwt-token'] = auth_token
+    end
+
+    def parse_response(response)
+      # return early if it's already valid json
+      # Some requests simply return json, some
+      # have to be decoded
+      begin
+        return JSON.parse(response)
+      rescue JSON::ParserError
+      end
+
+      read_gzip_data = -> (stringio) {
+        begin
+          Zlib::GzipReader.new(stringio, encoding: 'ASCII-8BIT')
+        rescue Zlib::GzipFile::Error
+          puts "An issue occured with formio: #{response}"
+        rescue
+          puts "An issue occured with formio"
+        end
+      }
+
+      response
+        .try { |it| StringIO.new(it) }
+        .try { |stringio| read_gzip_data.call(stringio) }
+        .try { |reader| reader.read }
+        .try { |json_string| JSON.parse(json_string) }
+        .yield_self { |parsed_json| parsed_json || [] }
+    end
+
+    def connection
+      require 'faraday/detailed_logger'
+      @connection ||= Faraday::Connection.new(project_url,
+        ssl: { verify: true }
+      ) do |builder|
+        # builder.request  :multipart
+        # builder.use ::FaradayMiddleware::ParseJson, content_type: 'application/json'
+        # builder.request  :url_encoded
+        builder.request :curl
+        builder.adapter  :net_http
+        # builder.response :detailed_logger # <-- Inserts the logger into the connection.
+      end
+    end
+
+    def current_user
+      response = connection.get do |req|
+        req.url '/current'
+        set_headers(req)
+      end
+      Record.new(parse_response(response.body))
+    end
+
+    def login
+      @auth_token ||= begin
+        Rails.cache.fetch("formio_login_" + email, expires_in: 12.hours) do
+          formio_conn = Faraday::Connection.new("https://formio.form.io", ssl: { verify: true })
+
+          login_response = formio_conn.post do |req|
+            req.url "/user/login"
+            req.headers['Content-Type'] = 'application/json'
+            req.headers['Accept'] = 'application/json'
+            req.body = {
+              data: {
+                email: email,
+                password: password
+              }
+            }.to_json
+          end
+          login_response.headers['x-jwt-token']
+        end
+      end
+    end
+    alias auth_token login
+
+    private
+    attr_reader :email, :password, :project_url
+  end
+end

data/lib/formio/form.rb

@@ -0,0 +1,45 @@
+module Formio
+  class Form
+    attr_accessor(
+      :formio_hash,
+      :type,
+      :formio_id,
+      :components,
+      :name,
+      :title,
+      :path,
+      :created_at,
+      :updated_at
+    )
+
+    def initialize(formio_hash)
+      @formio_hash = formio_hash
+      @type = formio_hash['type']
+      @formio_id = formio_hash['_id']
+      @components = formio_hash['components']
+      @name = @title = formio_hash['title']
+      @path = formio_hash['path']
+      @created_at = DateTime.parse formio_hash['created']
+      @updated_at = DateTime.parse formio_hash['modified']
+    end
+
+    def name=(name)
+      @name = @title = name
+    end
+    
+    def title=(title)
+      @name = @title = title
+    end
+
+    def to_json
+      {
+        title: title,
+        display: 'form',
+        type: type,
+        name: name,
+        path: path,
+        components: components,
+      }.to_json
+    end
+  end
+end

data/lib/formio/record.rb

@@ -0,0 +1,48 @@
+module Formio
+  class Record
+    def initialize(formio_hash)
+      if formio_hash.empty? || formio_hash.nil?
+        raise "cannot construct FormioRecord"
+      end
+      @_id = @id = formio_hash['_id']
+      @form_id = formio_hash['form'] if formio_hash['form']
+      @formio_hash = formio_hash
+      @form_name = formio_hash['form_name']
+      if formio_hash['created']
+        @created_at = Time.parse formio_hash['created']
+      end
+      if formio_hash['modified']
+        @updated_at = Time.parse formio_hash['modified']
+      end
+    end
+
+    def to_json
+      formio_hash.to_json
+    end
+
+    def to_h
+      formio_hash
+    end
+
+    attr_reader(
+      :id,
+      :_id,
+      :form_id,
+      :form_name,
+      :created_at,
+      :updated_at,
+      :formio_hash
+      )
+
+    class Nil < Record
+      def initialize
+        @_id = @id = nil
+        @form_id = nil
+        @formio_hash = nil
+        @form_name = nil
+        @created_at = nil
+        @updated_at = nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: formio
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jonathan Frias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-04 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby adapter for the form.io platform
+email: jonathan.frias1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/formio.rb
+- lib/formio/client.rb
+- lib/formio/form.rb
+- lib/formio/record.rb
+homepage: http://rubygems.org/gems/formio
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: A Ruby adapter for the form.io platform
+test_files: []