fulcrum 0.8.1 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21844b906c980b7f2d119ea117e10e528d8b8575
-  data.tar.gz: 0b5dd17ff88ddf767bed5ffac583e986aeb031de
+SHA256:
+  metadata.gz: a6da67d577a8e64b2f9a92ea5360b370e78f1fb253a1e1029f07b2c2c756fc05
+  data.tar.gz: 65684be4fc3cd0ec36b8f9a17b97d42e2f4e2664c8b29d4e611e321e6a8f150d
 SHA512:
-  metadata.gz: a0ed4ded8c9149b7f60703cb1eef7820e98a5452f8ff92d0861db8376b8945c1b82cf8ddbf0410d639eaf5b5c9c0862e0c1fa8b1fd6c7e8e775604611c1ce2ba
-  data.tar.gz: dc1abf45a5eeb3e41b6dab0085c270c78ab3efaa2dda3f446fcd2be0850921e9610c7b7d584b722dbf1661128b3b14c3a7a2edb726addebffef8ff88bc48d40c
+  metadata.gz: a78d0a12e1a5c7a1f57de8556271b3ad0733fdda72fb0ea3d2d4e41284c1b3fc255a7c03686a0cca22d3c12f59ef0edb4cb1145f36bec3ffb31cfc0bb21aac24
+  data.tar.gz: a9107b8ce100e57f2b0a7958519b4b3781deb32b36f72378ff09f918e400ab8a0b653b0b29424e3fe5e6bb3640715650124e390ebf95b908f682530a9e361366

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

@@ -2,9 +2,7 @@ require 'faraday'
 require 'faraday_middleware'
 
 module Fulcrum
-
   class Client
-
     DEFAULT_URL = 'https://api.fulcrumapp.com/api/v2'
 
     DEFAULT_USER_AGENT = "Fulcrum Ruby API Client, Version #{Fulcrum::VERSION}"
@@ -62,6 +60,7 @@ module Fulcrum
       connection.basic_auth(username, password)
 
       resp = connection.get('users.json')
+
       user = resp.body['user']
       user['contexts'] = user['contexts'].map{|c| c.except!('api_token')}
 
@@ -82,8 +81,8 @@ module Fulcrum
 
     def self.create_connection(url, key = nil)
       Faraday.new(url) do |connection|
-        connection.request  :multipart
-        connection.request  :json
+        connection.request :multipart
+        connection.request :json
 
         connection.response :raise_error
         connection.response :json, content_type: 'application/json'
@@ -120,6 +119,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/version.rb

@@ -1,3 +1,3 @@
 module Fulcrum
-  VERSION = "0.8.1"
+  VERSION = "0.9.1"
 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/client_spec.rb

@@ -23,14 +23,15 @@ describe Fulcrum::Client do
   end
 
   it 'can get_user' do
-    url = 'https://fred%40flinstones.com:secret@api.fulcrumapp.com/api/v2/users.json'
     response = '{"user":{"first_name":"Jason","last_name":"Sanford","email":"jason@fulcrumapp.com","image_small":"https://fulcrumapp-dev.s3.amazonaws.com/user-images/small_abc.jpg","image_large":"https://fulcrumapp-dev.s3.amazonaws.com/user-images/large_abc.jpg","id":"49d06ce5-1457-476c-9cb4-fd9d41ea43ef","contexts":[{"name":"Team Jason","id":"e09c1a03-819d-47d6-aebc-f8712d292b57","api_token":"abc123","image_small":"https://fulcrumapp-dev.s3.amazonaws.com/organization-images/small_abc.jpg","image_large":"https://fulcrumapp-dev.s3.amazonaws.com/organization-images/large_abc.jpg","type":"organization","role":{},"domain":null,"plan":{}}],"access":{"allowed":true}}}'
 
-    stub_request(:get, url)
-      .to_return(status: 200, body: response,
-                 headers: {"Content-Type" => "application/json"})
+    stub_request(:get, "https://api.fulcrumapp.com/api/v2/users.json")
+      .with(
+        headers: {
+          'Authorization' => 'Basic ZnJlZEBmbGluc3RvbmVzLmNvbTpzZWNyZXQ='
+        }
+      ).to_return(status: 200, body: response, headers: { 'Content-Type'=>'application/json' })
 
-    sql = 'select name from tables limit 1;'
     user = Fulcrum::Client.get_user('fred@flinstones.com', 'secret')
 
     expect(user['contexts'].length).to eq(1)
@@ -38,14 +39,16 @@ describe Fulcrum::Client do
   end
 
   it 'can create_authorization' do
-    url = 'https://fred%40flinstones.com:secret@api.fulcrumapp.com/api/v2/authorizations.json'
     body = '{"authorization":{"organization_id":"abc-123","note":"Tess Ting","timeout":null,"user_id":null}}'
     response = '{"authorization":{"note":"Tess Ting","expires_at":null,"timeout":null,"token_last_8":"46c5cb33","last_ip_address":null,"last_user_agent":null,"token":"ac493349cd4de0c376185c1d347d24ce5a3867bd3e04397bb875ed6b9b0546b768caa3bf46c5cb33","created_at":"2019-04-12T13:25:28Z","updated_at":"2019-04-12T13:25:28Z","id":"f1d84caa-da28-4fc5-a341-44bb9efa6266","last_used_at":null,"user_id":"4f1cfa091441405373000443"}}'
 
-    stub_request(:post, url)
-      .with(body: body)
-      .to_return(status: 200, body: response,
-                 headers: {"Content-Type" => "application/json"})
+    stub_request(:post, "https://api.fulcrumapp.com/api/v2/authorizations.json").
+      with(
+        body: body,
+        headers: {
+          'Authorization' => 'Basic ZnJlZEBmbGluc3RvbmVzLmNvbTpzZWNyZXQ='
+        }
+      ).to_return(status: 200, body: response, headers: { 'Content-Type'=>'application/json' })
 
     authorization = Fulcrum::Client.create_authorization('fred@flinstones.com', 'secret', 'abc-123', 'Tess Ting')
 

data/spec/resource_examples.rb

@@ -144,8 +144,6 @@ module Support
         object = resource.delete(resource_id)
 
         expect(client.response.status).to eq(204)
-
-        expect(object).to be_a(Hash)
       end
     end
   end

data/spec/spec_helper.rb

@@ -2,5 +2,4 @@ require 'rspec'
 require 'webmock/rspec'
 require 'fulcrum'
 require 'client_helper'
-require 'resource_examples'
-
+require 'resource_examples'

metadata

@@ -1,129 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: fulcrum
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.1
 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