fulcrum 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '042913b24cb5329436bfbd8654dca7acfe06f78a'
-  data.tar.gz: d9412eb5815aeb76f06a1216fbdbde3aa66be5f4
+SHA256:
+  metadata.gz: e109e3981651935f824c5685b7e40ff48cf623a8e446ebf2d2523f5c0bf0901a
+  data.tar.gz: 7b0db440781edb8b8e20d07172faa41253791a050200a52ff5659fd3d04c2bab
 SHA512:
-  metadata.gz: 93c2c1fd1c06c468459d89b8a716a3940acddbaebab3bb1e4477d755750ec9eacdf873bb0aed7db0b7afb4e01a5e21e401a1bc63bc60ab606fdf602fd5620dfa
-  data.tar.gz: 1b5ba47cdd2ac875ad5bc870c4c1830895db1309d58b67089600240722c9fd9a3e3c16db4c10df9811d39037b10188c83658af78c1789d4493ec6aa10aed50dd
+  metadata.gz: 5d5c671acf8d1b0e23dac08eddbe724eed9f133e79028b455e12c10fe7e9b88c1bf3848e8c123883c97c429f29e08f9fe9439fd978ae9064ba8080ef48767881
+  data.tar.gz: 4fcc76118fb41b6788a79786f257de432008642f6e94ee3f44d5c799cd5b028478b6ae08f736aa6f18626d6d019b97d8858395ad2307c8efdc40011423e29a14

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.8.0 (February 20, 2020)
+* Add form history support (#28)
+
 ## v0.7.0 (April 12, 2019)
 * Add roles support (#20)
 * Add audit logs support (#13)

data/README.md

@@ -291,6 +291,22 @@ Format can be 'json', 'geojson', 'gpx', or 'kml'.
 
 
 
+## Attachments
+
+### client.attachments.all(params = {})
+
+### client.attachments.find(id)
+
+### client.attachments.create(file_or_path, attributes = {})
+
+Suggestion pass a File.open(file) to this as parameter
+
+### client.attachments.finalize(id)
+
+### client.attachments.delete(id)
+
+
+
 ## Changesets
 
 ### client.changesets.all(params = {})

data/fulcrum.gemspec

@@ -16,11 +16,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Fulcrum::VERSION
 
-  gem.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
-  gem.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
-  gem.add_development_dependency 'webmock', '~> 1.12', '>= 1.12.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
 
-  gem.add_dependency 'activesupport', '>= 4.1.0'
-  gem.add_dependency 'faraday', '~> 0.9', '>= 0.9.1'
-  gem.add_dependency 'faraday_middleware', '~> 0.9', '>= 0.9.1'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'faraday_middleware'
 end

data/lib/fulcrum/attachment.rb

@@ -0,0 +1,46 @@
+module Fulcrum
+  class Attachment < MediaResource
+    include Actions::Delete
+
+    def finalize(id)
+      call(:post, "#{collection}/finalize", {id: id})
+    end
+
+    def collection
+      resources_name
+    end
+
+    def member(id)
+      "#{resources_name}/#{id}"
+    end
+
+    def find(id)
+      call(:get, member(id))
+    end
+
+    def all(params = {})
+      call(:get, collection, params)
+    end
+
+    def create(file, attrs = {})
+      response = call(:post, create_action, attrs)
+      binary_upload(file, response['url'], attrs[:file_size])
+      { name: attrs[:name], attachment_id: response['id'] }
+    end
+
+    private
+
+    def binary_upload(file, url, file_size)
+      connection = Faraday.new(url: url) do |faraday|
+        faraday.request :multipart
+        faraday.adapter :net_http
+      end
+      connection.put do |req|
+        req.headers['Content-Type'] = 'octet/stream'
+        req.headers['Content-Length'] = "#{file_size}"
+        req.headers['Content-Transfer-Encoding'] = 'binary'
+        req.body = Faraday::UploadIO.new(file, 'octet/stream')
+      end
+    end
+  end
+end

data/lib/fulcrum/client.rb

@@ -120,6 +120,10 @@ module Fulcrum
       @audio ||= Fulcrum::Audio.new(self)
     end
 
+    def attachments
+      @attachment ||= Fulcrum::Attachment.new(self)
+    end
+
     def signatures
       @signatures ||= Fulcrum::Signature.new(self)
     end

data/lib/fulcrum/form.rb

@@ -5,5 +5,12 @@ module Fulcrum
     include Actions::Create
     include Actions::Update
     include Actions::Delete
+
+    def history(id, params = {})
+      result = call(:get, member_action(id, 'history'), params)
+
+      Page.new(result, resources_name)
+    end
+
   end
 end

data/lib/fulcrum/version.rb

@@ -1,3 +1,3 @@
 module Fulcrum
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/fulcrum.rb

@@ -17,6 +17,7 @@ require 'fulcrum/actions/media_versions'
 require 'fulcrum/actions/gps_track'
 require 'fulcrum/video'
 require 'fulcrum/audio'
+require 'fulcrum/attachment'
 require 'fulcrum/signature'
 require 'fulcrum/project'
 require 'fulcrum/record'
@@ -26,5 +27,4 @@ require 'fulcrum/webhook'
 require 'fulcrum/role'
 require 'fulcrum/audit_log'
 require 'fulcrum/authorization'
-require 'fulcrum/client'
-
+require 'fulcrum/client'

data/spec/data/test.pdf

@@ -0,0 +1,56 @@
+%PDF-1.7
+%����
+1 0 obj
+<</Pages 2 0 R /Type/Catalog>>
+endobj
+2 0 obj
+<</Count 2/Kids[ 4 0 R  8 0 R ]/Type/Pages>>
+endobj
+3 0 obj
+<</CreationDate(D:20210803100643)/Creator(PDFium)/Producer(PDFium)>>
+endobj
+4 0 obj
+<</Contents 5 0 R /MediaBox[ 0 0 612 792]/Parent 2 0 R /Resources<</Font<</F1 6 0 R >>/ProcSet 7 0 R >>/Type/Page>>
+endobj
+5 0 obj
+<</Filter/FlateDecode/Length 311>>stream
+x����j�0����[h������ɡ(��.b�Q��`ɥ��k'$�@�J��;}�β�a�(€a�}���EIF�,a�8'.CQ��
+�����Ryz������9s_S�G��V�sNrNy��r���>�d��hv}nr���A;�T�q	��V� �o�/,��
+endstream
+endobj
+6 0 obj
+<</BaseFont/Helvetica/Encoding/WinAnsiEncoding/Name/F1/Subtype/Type1/Type/Font>>
+endobj
+7 0 obj
+[/PDF/Text]
+endobj
+8 0 obj
+<</Contents 9 0 R /MediaBox[ 0 0 612 792]/Parent 2 0 R /Resources<</Font<</F1 6 0 R >>/ProcSet 7 0 R >>/Type/Page>>
+endobj
+9 0 obj
+<</Filter/FlateDecode/Length 274>>stream
+x����j�0����[X�1��+��Bi�^z�k�,E#v߾YE��"%�̐��f�p��^���e
+V�Z³)n�{�R���&��ۙ�ъ�$7�
+����?ݠM{�#F;�%!�,Lg���%͹=֗x�7�$#�y�\�b8�����2r3����z�����
+endstream
+endobj
+xref
+0 10
+0000000000 65535 f
+0000000017 00000 n
+0000000066 00000 n
+0000000129 00000 n
+0000000216 00000 n
+0000000350 00000 n
+0000000733 00000 n
+0000000832 00000 n
+0000000862 00000 n
+0000000996 00000 n
+trailer
+<<
+/Root 1 0 R
+/Info 3 0 R
+/Size 10/ID[<06CD5B1232D77C2A68B8A7743652C304><06CD5B1232D77C2A68B8A7743652C304>]>>
+startxref
+1342
+%%EOF

data/spec/lib/attachment_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Attachment do
+  let(:test_file) { './spec/data/test.pdf' }
+
+  include_context 'with client'
+  include_context 'with media resource'
+  include_context 'with resource parameters'
+
+  let(:resource) { client.attachments }
+
+  include_examples 'finds resource'
+  include_examples 'deletes resource'
+
+  let(:create_url) do
+    "#{client.url}/#{resource.create_action}"
+  end
+
+  describe '#all' do
+    let(:list_response) do
+      data = {}
+      data["form_id"] = {}
+      data.to_json
+    end
+
+    it 'lists all attachments' do
+      stub_request(:get, create_url)
+        .to_return(status: 200, body: list_response,
+                   headers: {"Content-Type" => "application/json"})
+
+      resources = resource.all
+
+      expect(client.response.status).to eq(200)
+
+      expect(resources).to be_a(Hash)
+    end
+  end
+
+  describe '#create' do
+    let(:ws_url) do
+      'https://fulcrumapp.s3.amazonaws.com/attachments/example'
+    end
+
+    let(:attrs) do
+      { "name": "Test",
+        "owners": [ {
+          "type": "form",
+          "id": "12345"
+      } ] }
+    end
+
+    let(:response) do
+      data = {}
+      data['url'] = ws_url
+      data['id'] = "123"
+      data.to_json
+    end
+    
+    let(:create_parameters) { [ File.open(test_file) , attrs ] }
+
+    it 'creates attachment data' do
+      stub_request(:post, create_url)
+        .with(body: attrs)
+          .to_return(status: 200, body: response,
+                   headers: {"Content-Type" => "application/json"})
+      stub_request(:put, ws_url)
+          .to_return(status: 200,
+                   headers: {"Content-Type" => "application/json"})
+
+      object = resource.create(*create_parameters)
+
+      expect(client.response.status).to eq(200)
+
+      expect(object[:name]).to eq(attrs[:name])
+
+      expect(object[:attachment_id]).to eq(JSON.parse(response)['id'])
+    end
+  end
+
+  describe '#finalize' do
+    it 'finalizes the attachment' do
+      stub_request(:post, "#{create_url}/finalize")
+        .to_return(status: 201,
+                   headers: {"Content-Type" => "application/json"})
+
+      object = resource.finalize(resource_id)
+
+      expect(client.response.status).to eq(201)
+    end
+  end
+end

data/spec/lib/form_spec.rb

@@ -13,4 +13,24 @@ describe Fulcrum::Form do
   include_examples 'creates resource'
   include_examples 'updates resource'
   include_examples 'deletes resource'
+
+  it 'lists all resources' do
+    url = "#{client.url}/forms/8ae9115-0430-459e-a1b7-7ac46011e0ce/history.json"
+
+    stub_request(:get, url)
+      .to_return(status: 200, body: list_response,
+                 headers: {"Content-Type" => "application/json"})
+
+    page = resource.history('8ae9115-0430-459e-a1b7-7ac46011e0ce')
+
+    expect(client.response.status).to eq(200)
+
+    expect(page).to respond_to(:current_page)
+    expect(page).to respond_to(:total_pages)
+    expect(page).to respond_to(:total_count)
+    expect(page).to respond_to(:per_page)
+
+    expect(page.objects).to be_a(Array)
+  end
+
 end

metadata

@@ -1,129 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: fulcrum
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Fulcrum
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 description: Fulcrum API
 email:
 - info@fulcrumapp.com
@@ -147,6 +117,7 @@ files:
 - lib/fulcrum/actions/list.rb
 - lib/fulcrum/actions/media_versions.rb
 - lib/fulcrum/actions/update.rb
+- lib/fulcrum/attachment.rb
 - lib/fulcrum/audio.rb
 - lib/fulcrum/audit_log.rb
 - lib/fulcrum/authorization.rb
@@ -172,7 +143,9 @@ files:
 - spec/data/test.jpg
 - spec/data/test.m4a
 - spec/data/test.mp4
+- spec/data/test.pdf
 - spec/data/test.png
+- spec/lib/attachment_spec.rb
 - spec/lib/audio_spec.rb
 - spec/lib/audit_log_spec.rb
 - spec/lib/authorization_spec.rb
@@ -195,7 +168,7 @@ homepage: https://github.com/fulcrumapp/fulcrum-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -210,9 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: Fulcrum API client for ruby
 test_files:
@@ -220,7 +192,9 @@ test_files:
 - spec/data/test.jpg
 - spec/data/test.m4a
 - spec/data/test.mp4
+- spec/data/test.pdf
 - spec/data/test.png
+- spec/lib/attachment_spec.rb
 - spec/lib/audio_spec.rb
 - spec/lib/audit_log_spec.rb
 - spec/lib/authorization_spec.rb