filebound_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5430818e9e9bb023e023b877145a3ad2d49e34faa526095eeca9d539570d0424
-  data.tar.gz: c96ef4679daf8250c0917de85c671c68e3e831605f2e7018e3b7200f58af0839
+  metadata.gz: 3b857083501fad5a2cc689c18a3869939ba514679259f68809ac94ececc66cc4
+  data.tar.gz: 6217a7f015e0811a60e8231f7809401eac6d847830fb7122881c09e690c27c1d
 SHA512:
-  metadata.gz: '09da2bf6aa663fd2be1f91883406fca201ed71de8958762fe3ea90575d925d58651c4d8848a02c9ea9a7c228797efb0cc6c55676bf42ab00b06b7e16deb5fc95'
-  data.tar.gz: 7da1a67a86028ce37f3373dfd4839db06288a30bad281a6e3a77b99210bb78db8ae5dcb1d86671c6ad43f5ca04c593a689049e5801f6476b87df65e024842cfd
+  metadata.gz: 33ff1b9695aa36f1525be4b849edb22595d96f57019412518b53c22ea9ba409fba6170a2401a0de8199b57d2641359975ba9c6bbb94b0060af3bc0e9db88bc7e
+  data.tar.gz: 855fced0bf0da18243c51ab1c5379726ce67f0b690ab9148148af1b631b27438e0858d3f7992d5afe8a3d561de6fc8d0a26304f9b076cd7e613d05908a41e904

data/.rubocop.yml

@@ -1,2 +1,4 @@
 Metrics/LineLength:
-  Max: 120
+  Max: 120
+Metrics/MethodLength:
+  Max: 20

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 
 Changes to this gem will be noted here.
 
+## [0.3.0] - 2019-01-22
+
+### Changed
+
+- Upgraded httpi to 2.4.4.
+
+### Added
+- User resource endpoint.
+- Route resource endpoint.
+- RoutedItem resource endpoint.
+
 ## [0.2.0] - 2018-08-07
 ### Changed
 - Replaced ruby-ntlm dependency with httpi.  httpi gem is actively being developed while ruby-ntlm hasn't had a new

data/Gemfile.lock

@@ -10,7 +10,7 @@ GEM
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
-    httpi (2.4.3)
+    httpi (2.4.4)
       rack
       socksify
     jaro_winkler (1.5.1)
@@ -18,7 +18,7 @@ GEM
     parser (2.5.1.2)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    rack (2.0.5)
+    rack (2.0.6)
     rainbow (3.0.0)
     rake (12.3.1)
     rspec (3.7.0)

data/README.md

@@ -125,7 +125,7 @@ puts f[:notes]
 ```ruby
 data = Base64.encode64(File.read('somefile.pdf'))
 d = c.document_new
-d[:allowSaveBinaryData] = false
+d[:allowSaveBinaryData] = true
 d[:binaryData] = data
 d[:extension] = 'pdf'
 d[:fileId] = 123
@@ -154,6 +154,37 @@ d = c.document(document_id)
 puts d[:name]
 ```
 
+### Create document and assign it to a workflow and user
+
+Here is a more detail example of a more complex API interaction.
+This example shows how you can create a file, a document in the file and then
+assign that document to a workflow and then a user. Obviously this a quick example
+and still requires null checks and exception handling.
+
+First create your [file](#create-a-file).
+Then create your [document](#create-document-with-attached-binary-file-data).
+Then build out the routed item and update it:
+
+```ruby
+user = c.users(filter: 'name_someuser').first
+project = c.projects(filter: 'name_someproject').first
+route = c.project_routes(project[:id], filter: 'name_someroute', hiddenRoutes: true).first
+routed_item = c.route_document_to_workflow(route[:id], d[:id], 'test note')
+routed_item[:userId] = user[:id]
+routed_item[:userName] = user[:name]
+routed_item_id = c.routed_item_update(routed_item)
+```
+
+### Send an additional filter in the querystring
+
+The FileBound API also gives you the ability to send an additional filter on certain calls to further filter 
+a GET result by any of the fields in the resource.  See below for an example:
+
+```ruby
+u = c.users(filter: 'name_someusername')
+puts u[:displayName]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Setup your Filebound connection information

data/lib/filebound_client/endpoints.rb

@@ -1,13 +1,4 @@
-require 'filebound_client/endpoints/projects'
-require 'filebound_client/endpoints/files'
-require 'filebound_client/endpoints/documents'
-require 'filebound_client/endpoints/version'
-require 'filebound_client/endpoints/assignments'
-require 'filebound_client/endpoints/dividers'
-require 'filebound_client/endpoints/document_binary_data'
-require 'filebound_client/endpoints/eform_data'
-require 'filebound_client/endpoints/separators'
-require 'filebound_client/endpoints/query'
+Dir[File.join(__dir__, '/endpoints/*.rb')].each { |file| require file }
 
 module FileboundClient
   # Module for resource endpoints
@@ -45,8 +36,12 @@ module FileboundClient
         include FileboundClient::Endpoints::Dividers
         include FileboundClient::Endpoints::DocumentBinaryData
         include FileboundClient::Endpoints::EFormData
+        include FileboundClient::Endpoints::EFormDetail
         include FileboundClient::Endpoints::Separators
         include FileboundClient::Endpoints::Query
+        include FileboundClient::Endpoints::Users
+        include FileboundClient::Endpoints::Routes
+        include FileboundClient::Endpoints::RoutedItems
       end
     end
     # rubocop:enable Metrics/MethodLength, Metrics/AbcSize

data/lib/filebound_client/endpoints/projects.rb

@@ -92,7 +92,7 @@ module FileboundClient
       #   c = FileboundClient::Client.connect(host: url, username: 'username', password: 'password', use_ntlm: true,
       #                                       ntlm_user: 'ntlm_user', ntlm_password: 'ntlm_password',
       #                                       ntlm_domain: 'ntlm_domain')
-      #   c.project_add(ProjectId: 165, Name: 'Test API Project', ProjectType: 'HR')
+      #   c.project_add(ProjectId: nil, Name: 'Test API Project', ProjectType: 'HR')
       def project_add(project)
         raise Client::FileboundClientException.new('Id is required', 0) if project[:projectId].greater_than_zero?
         put('/projects', nil, project)

data/lib/filebound_client/endpoints/routed_items.rb

@@ -0,0 +1,59 @@
+module FileboundClient
+  module Endpoints
+    # Module for RoutedItems resource endpoint
+    module RoutedItems
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :routeditem
+          allow_all :routeditems
+        end
+      end
+
+      # Edits a routed item.  The routed_item.id must be not nil and > 0.
+      # @param [Hash] routed_item the routed item to edit
+      # @return [nil]
+      # @example Update an existing routed item
+      #   c = FileboundClient::Client.connect(host: url, username: 'username', password: 'password', use_ntlm: true,
+      #                                       ntlm_user: 'ntlm_user', ntlm_password: 'ntlm_password',
+      #                                       ntlm_domain: 'ntlm_domain')
+      #   c.routed_item_update(routed_item)
+      def routed_item_update(routed_item)
+        raise Client::FileboundClientException.new('Id is required', 0) unless routed_item[:id].greater_than_zero?
+        post("/routeditems/#{routed_item[:id]}", nil, routed_item)
+      end
+
+      # Completes the current step for the routed item.  The routed_item.id must be not nil and > 0.
+      # @param [int] routed_item_id the routed item key to update
+      # @param [int] step_number the step number to route to
+      # @param [string] step_caption the step caption for the step
+      # @param [string] comment optional comment for the step
+      # @param [DateTime] due_date optional due date for the routed item
+      # @param [long] user_id optional; if reassigning this the user id to reassign to
+      # @param [string] checklist_data optional comma-seperated checklist values
+      # @param [long] route_step_id optional RouteStep key
+      # @param [long] route_step_task_id options RouteStepTask key
+      # @return [Array] array of RouteTask for the specified route step
+      # @example Complete the current route step
+      #   c = FileboundClient::Client.connect(host: url, username: 'username', password: 'password', use_ntlm: true,
+      #                                       ntlm_user: 'ntlm_user', ntlm_password: 'ntlm_password',
+      #                                       ntlm_domain: 'ntlm_domain')
+      #   c.routed_item_complete_step(routed_item)
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/ParameterLists, Metrics/PerceivedComplexity
+      def routed_item_complete_step(routed_item_id, step_number:, step_caption:, comment:, due_date:, user_id:,
+                                    checklist_data:, route_step_id:, route_step_task_id:)
+        raise Client::FileboundClientException.new('Id is required', 0) unless routed_item_id.greater_than_zero?
+        params = {}
+        params[:stepNumber] = step_number if step_number
+        params[:stepCaption] = step_caption if step_caption
+        params[:comment] = comment if comment
+        params[:dueDate] = due_date if due_date
+        params[:userId] = user_id if user_id
+        params[:checklistData] = checklist_data if checklist_data
+        params[:routeStepId] = route_step_id if route_step_id
+        params[:routeStepTaskId] = route_step_task_id if route_step_task_id
+        put("/routeditems/#{routed_item_id}/complete", params, nil)
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/ParameterLists, Metrics/PerceivedComplexity
+    end
+  end
+end

data/lib/filebound_client/endpoints/routes.rb

@@ -0,0 +1,67 @@
+module FileboundClient
+  module Endpoints
+    # Module for Routes resource endpoint
+    module Routes
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :route
+          allow_all :routes
+        end
+      end
+
+      # Retrieves xml for a route
+      # @param [int] route_id the route key
+      # @param [Hash] query_params additional query params to send in the request
+      # @return [string] string of xml representing route
+      def route_xml(route_id, query_params = nil)
+        get("/routes/#{route_id}/xml", query_params)
+      end
+
+      # Routes a document to the start of a workflow
+      # @param [long] route_id the route key
+      # @param [int] document_id the document key to route
+      # @param [string] notes optional notes to from the user who started the document down the route
+      # @return [RoutedItem] a hash of the RoutedItem resource that was added
+      def route_document_to_workflow(route_id, document_id, notes)
+        params = { documentId: document_id }
+        params[:notes] = notes if notes
+        put("/routes/#{route_id}", params, nil)
+      end
+
+      # Routes a document to a specified step
+      # @param [long] routed_item_id the RoutedItem key
+      # @param [int] step_number the step number to route to
+      # @param [string] comment optional comment for the step
+      # @param [DateTime] due_date optional due date for the routed item
+      # @param [long] user_id optional; if reassigning this the user id to reassign to
+      # @param [string] checklist_data optional comma-seperated checklist values
+      # @param [long] route_step_id optional RouteStep key
+      # @param [long] route_step_task_id options RouteStepTask key
+      # @return [nil]
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/ParameterLists
+      def route_document_to_step(routed_item_id, step_number, comment:, due_date:, user_id:, checklist_data:,
+                                 route_step_id:, route_step_task_id:)
+        params = { id: routed_item_id, stepNumber: step_number }
+        params[:comment] = comment if comment
+        params[:dueDate] = due_date if due_date
+        params[:userId] = user_id if user_id
+        params[:checklistData] = checklist_data if checklist_data
+        params[:routeStepId] = route_step_id if route_step_id
+        params[:routeStepTaskId] = route_step_task_id if route_step_task_id
+        put('/routes', params, nil)
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/ParameterLists
+
+      # Routes a document to a user
+      # @param [long] document_id document key to route
+      # @param [long] user_id user key to route to
+      # @param [bool] route_back whether to route the document back when completed
+      # @param [DateTime] due_date due date for the document
+      # @return [nil]
+      def route_document_to_user(document_id, user_id, route_back, due_date)
+        params = { documentId: document_id, userId: user_id, routeBack: route_back, dueDate: due_date }
+        put('/routes', params, nil)
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/users.rb

@@ -0,0 +1,80 @@
+module FileboundClient
+  module Endpoints
+    # Module for Users resource endpoint
+    module Users
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :user
+          allow_all :users
+        end
+      end
+
+      # Retrieves a single user by its key
+      # @param [int] user_id the user key
+      # @param [Hash] query_params additional query params to send in the request
+      # @return [User] user object
+      def user(user_id, query_params = nil)
+        get("/users/#{user_id}", query_params)
+      end
+
+      # Retrieves routed items for a user
+      # @param [int] user_id the user key
+      # @param [Hash] query_params additional query params to send in the request
+      # @return [Array] array of routed items
+      def user_routeditems(user_id, query_params = nil)
+        get_user_children(user_id, __method__, query_params)
+      end
+
+      # Retrieves groups for a user
+      # @param [int] user_id the user key
+      # @param [Hash] query_params additional query params to send in the request
+      # @return [Array] array of groups
+      def user_groups(user_id, query_params = nil)
+        get_user_children(user_id, __method__, query_params)
+      end
+
+      # Retrieves assignments for a user
+      # @param [int] user_id the user key
+      # @param [Hash] query_params additional query params to send in the request
+      # @return [Array] array of assignments
+      def user_assignments(user_id, query_params = nil)
+        get_user_children(user_id, __method__, query_params)
+      end
+
+      # Edits a user.  The user.Id must be not nil and > 0.
+      # @param [Hash] user the user to edit
+      # @param [string] groups a comma-delimited string of group ids to add the user to
+      # @return [int] the user id updated
+      # @example Update an existing user
+      #   c = FileboundClient::Client.connect(host: url, username: 'username', password: 'password', use_ntlm: true,
+      #                                       ntlm_user: 'ntlm_user', ntlm_password: 'ntlm_password',
+      #                                       ntlm_domain: 'ntlm_domain')
+      #   c.user_update(id: 165, displayName: 'Test User', email: 'someone@somewhere.com', name: 'username')
+      def user_update(user, groups)
+        raise Client::FileboundClientException.new('Id is required', 0) unless user[:dd].greater_than_zero?
+        put('/users', nil, user: user, groups: groups)
+      end
+
+      # Adds a user.  The user.id must be nil or 0.
+      # @param [user] user the user to add
+      # @param [string] groups a comma-delimited string of group ids to add the user to
+      # @return [int] the id of the newly created user
+      # @example Add a user
+      #   c = FileboundClient::Client.connect(host: url, username: 'username', password: 'password', use_ntlm: true,
+      #                                       ntlm_user: 'ntlm_user', ntlm_password: 'ntlm_password',
+      #                                       ntlm_domain: 'ntlm_domain')
+      #   c.user_add(id: nil, displayName: 'Test User', email: 'someone@somewhere.com', name: 'username')
+      def user_add(user, groups)
+        raise Client::FileboundClientException.new('Id is required', 0) if user[:userId].greater_than_zero?
+        put('/users', nil, user, user: user, groups: groups)
+      end
+
+      private
+
+      def get_user_children(user_id, child_name, query_params = nil)
+        get("/users/#{user_id}/#{child_name.to_s.split('_')[1]}", query_params)
+      end
+    end
+  end
+end

data/lib/filebound_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filebound_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryan Richardson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-07 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,7 +122,10 @@ files:
 - lib/filebound_client/endpoints/files.rb
 - lib/filebound_client/endpoints/projects.rb
 - lib/filebound_client/endpoints/query.rb
+- lib/filebound_client/endpoints/routed_items.rb
+- lib/filebound_client/endpoints/routes.rb
 - lib/filebound_client/endpoints/separators.rb
+- lib/filebound_client/endpoints/users.rb
 - lib/filebound_client/endpoints/version.rb
 - lib/filebound_client/version.rb
 - test.txt