filebound_client 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8156e7efc52c251f7da708595679f9cef56dbe2f1ccfe2e3c885bb3984bf0e58
-  data.tar.gz: 28b7efd8ab5961dbda136b339463837e82c4bd7340a50916e59aecd2f6b35ea7
+  metadata.gz: e4c298380990383c5572e670540c81fa7ba921ad6ed6fc89569c2feaab43da05
+  data.tar.gz: 1c7317c2116217d0f27c469e584402af783e5dd4568488e01a84d9b3319f53c5
 SHA512:
-  metadata.gz: b11fb0336dc19655ea72ff67e6eff8ddff378cfc988fbe539b40f6c85ef75b5396ee2a1d84f1b03bf899bd3590d637035406cce9dd3918a2eff07197f122d78a
-  data.tar.gz: d784366f53fe5e96cf8764ee7f68f3714c8c16913cda326067b32948953c84846f93f7abfc88e24f0c399208c4c643b36bf93bf33ab09646d5ebc796d9983863
+  metadata.gz: 5d42ec2aac7f053fd6d05e278d3b56ad9c38d58d87ad3a2ec0232a1a236fbb099293a70c72f4f77b3135ec82ce630b076ab6498e96b2a26b06a10c8f004ddb6e
+  data.tar.gz: 1778bf7e70fa174a231d50fecea4b4acfdc495702be32c4135e77d2071322090e3e43265e41aed237970f19f0f440e078aec53f1a19516a811a4e0bb419b5099

data/.github/workflows/gempush.yml

@@ -0,0 +1,30 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/CHANGELOG.md

@@ -3,7 +3,52 @@
 
 Changes to this gem will be noted here.
 
-## [0.3.3] - 2019-03-20
+## [0.4.1] - 2021-01-13
+
+### Changed
+
+- Allowed for the possibility that the Filebound API may return an empty string in the response body
+
+### Added
+
+- Spec for creating a document note
+
+## [0.4.0] - 2020-12-30
+
+### Added
+
+- Created FileboundClient::Endpoints::Documents#document_comments for retrieve comments for a document
+- Created FileboundClient::Endpoints::Documents#document_add_comment for creating new comments on a document
+- Created FileboundClient::Endpoints::Files#file_comments for retrieve comments for a file
+- Created FileboundClient::Endpoints::Files#file_add_comment for creating new comments on a file
+
+## [0.3.8] - 2020-04-15
+
+### Changed
+
+- Updated bundler to 2.1.4
+- Updated gem dependencies to latest versions
+
+## [0.3.7] - 2019-07-29
+
+### Changed
+
+- Updated yard to fix a security vulnerability (https://github.com/lsegal/yard/security/advisories/GHSA-xfhh-rx56-rxcr)
+- Updated bundler to 1.17.3
+
+## [0.3.6] - 2019-06-06
+
+### Added
+
+- Partially implemented Groups endpoint
+
+## [0.3.5] - 2019-03-20
+
+### Changed
+
+- Enabled quirks mode on the JSON parser for all responses being parsed.
+
+## [0.3.4] - 2019-03-20
 
 ### Changed
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    filebound_client (0.3.3)
+    filebound_client (0.4.1)
       httpi (~> 2.4.0)
       rubyntlm (~> 0.6.0)
 
@@ -10,30 +10,30 @@ GEM
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
-    httpi (2.4.4)
+    httpi (2.4.5)
       rack
       socksify
-    jaro_winkler (1.5.1)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.1.1)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    rack (2.0.6)
+    rack (2.2.3)
     rainbow (3.0.0)
-    rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
     rubocop (0.58.2)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -42,22 +42,19 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.10.1)
     rubyntlm (0.6.2)
     socksify (1.7.1)
-    unicode-display_width (1.4.0)
-    yard (0.9.15)
+    unicode-display_width (1.7.0)
+    yard (0.9.24)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16.0)
+  bundler (~> 2.1.4)
   filebound_client!
   rake (~> 12.3.0)
   rspec (~> 3.0)
   rubocop (~> 0.58.2)
-  yard (~> 0.9.0)
-
-BUNDLED WITH
-   1.16.2
+  yard (>= 0.9.20)

data/README.md

@@ -1,6 +1,6 @@
 # FileboundClient
 
-This gem provides a easy way for you to access the Filebound API.
+This gem provides an easy way for you to access the Filebound API.
 
 [![Build Status](https://travis-ci.org/JDHeiskell/filebound_client.svg?branch=master)](https://travis-ci.org/JDHeiskell/filebound_client)
 

data/filebound_client.gemspec

@@ -21,9 +21,9 @@ 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.0'
+  spec.add_development_dependency 'bundler', '~> 2.1.4'
   spec.add_development_dependency 'rake', '~> 12.3.0'
-  spec.add_development_dependency 'yard', '~> 0.9.0'
+  spec.add_development_dependency 'yard', '>= 0.9.20'
 
   spec.add_runtime_dependency 'httpi', '~> 2.4.0'
   spec.add_runtime_dependency 'rubyntlm', '~> 0.6.0'

data/lib/filebound_client.rb

@@ -42,7 +42,7 @@ module FileboundClient
     # @param [Hash] query_params the optional query parameters to pass to the GET request
     # @return [Hash] the JSON parsed hash of the response body
     def get(url, query_params = nil)
-      JSON.parse(perform('get', url, query: query_params), symbolize_names: true)
+      JSON.parse(perform('get', url, query: query_params), symbolize_names: true, quirks_mode: true)
     end
 
     # Executes a GET request on the current Filebound client session expecting binary in the body of the response
@@ -60,7 +60,7 @@ module FileboundClient
     # @return [Hash] the JSON parsed hash of the response body
     def put(url, query_params = nil, body = nil)
       params = { headers: { 'Content-Type' => 'application/json' }, query: query_params, body: body }
-      JSON.parse(perform('put', url, params), symbolize_names: true)
+      JSON.parse(perform('put', url, params), symbolize_names: true, quirks_mode: true)
     end
 
     # Executes a POST request on the current Filebound client session expecting JSON in the body of the request/response
@@ -70,7 +70,7 @@ module FileboundClient
     # @return [Hash] the JSON parsed hash of the response body
     def post(url, query_params = nil, body = nil)
       params = { headers: { 'Content-Type' => 'application/json' }, query: query_params, body: body }
-      JSON.parse(perform('post', url, params), symbolize_names: true)
+      JSON.parse(perform('post', url, params), symbolize_names: true, quirks_mode: true)
     end
 
     # Executes a DELETE request on the current Filebound client session
@@ -101,7 +101,11 @@ module FileboundClient
         raise FileboundClientException.new(message, response.code)
       end
 
-      response.body
+      if response.body.nil? || response.body.to_s == ''
+        '{}'
+      else
+        response.body
+      end
     end
   end
 end

data/lib/filebound_client/endpoints.rb

@@ -42,6 +42,7 @@ module FileboundClient
         include FileboundClient::Endpoints::Users
         include FileboundClient::Endpoints::Routes
         include FileboundClient::Endpoints::RoutedItems
+        include FileboundClient::Endpoints::Groups
       end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/lib/filebound_client/endpoints/documents.rb

@@ -94,9 +94,24 @@ module FileboundClient
       # Delete a document
       # @param [int] document_id the document key
       # @return [bool] true if document was deleted successfully
-      def document_delete(document_id)
+      def document_delete(document_id, query_params = nil)
         delete("/documents/#{document_id}")
       end
+
+      # Returns the document comments for the supplied document key
+      # @param [int] document_id the document key
+      # @param [Hash] query_params the additional query params to send in the request
+      def document_comments(document_id, query_params = nil)
+        get("/documents/#{document_id}/comments", query_params)
+      end
+
+      # Adds a comment to document
+      # @param [int] document_id the document key
+      # @param [Hash] comment_data the comment to add
+      # @return [Hash] the newly added document comment hash
+      def document_add_comment(document_id, comment_data, query_params = nil)
+        put("/documents/#{document_id}/comments", nil, comment_data)
+      end
     end
   end
 end

data/lib/filebound_client/endpoints/files.rb

@@ -64,6 +64,21 @@ module FileboundClient
       def file_delete(file_id)
         delete("/files/#{file_id}")
       end
+
+      # Returns the file comments for the supplied file key
+      # @param [int] file_id the file key
+      # @param [Hash] query_params the additional query params to send in the request
+      def file_comments(file_id, query_params = nil)
+        get("/files/#{file_id}/comments", query_params)
+      end
+
+      # Adds a comment to file
+      # @param [int] file_id the file key
+      # @param [Hash] comment_data the comment to add
+      # @return [Hash] the newly added file comment hash
+      def file_add_comment(file_id, comment_data, query_params = nil)
+        put("/files/#{file_id}/comments", nil, comment_data)
+      end
     end
   end
 end

data/lib/filebound_client/endpoints/groups.rb

@@ -0,0 +1,30 @@
+module FileboundClient
+  module Endpoints
+    # Module for Groups resource endpoint
+    module Groups
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :group
+          allow_all :groups
+        end
+      end
+
+      # Retrieves a single group by its key
+      # @param [int] group_id the group key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter)
+      # @return [Hash] the group hash
+      def group(group_id, query_params = nil)
+        get("/groups/#{group_id}", query_params)
+      end
+
+      # Retrieves projects assigned to the group
+      # @param [int] group_id the group key
+      # @param [Hash] query_params additional query params to send in the request (option params: filter)
+      # @return [Hash] the group hash
+      def group_projects(group_id, query_params = nil)
+        get("/groups/#{group_id}/projects", query_params)
+      end
+    end
+  end
+end

data/lib/filebound_client/version.rb

@@ -1,4 +1,4 @@
 module FileboundClient
   # Current version of gem
-  VERSION = '0.3.4'.freeze
+  VERSION = '0.4.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filebound_client
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Bryan Richardson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2021-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.20
 - !ruby/object:Gem::Dependency
   name: httpi
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/gempush.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -120,6 +121,7 @@ files:
 - lib/filebound_client/endpoints/eform_data.rb
 - lib/filebound_client/endpoints/eform_detail.rb
 - lib/filebound_client/endpoints/files.rb
+- lib/filebound_client/endpoints/groups.rb
 - lib/filebound_client/endpoints/projects.rb
 - lib/filebound_client/endpoints/query.rb
 - lib/filebound_client/endpoints/routed_items.rb
@@ -148,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Provides connection to FileBound API