filebound_client 0.1.0

data/lib/filebound_client/endpoints/assignments.rb

@@ -0,0 +1,21 @@
+module FileboundClient
+  module Endpoints
+    # Module for Assignments resource endpoint
+    module Assignments
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :assignment
+          allow_all :assignments
+        end
+      end
+
+      # Gets the projects that the user has assignments in
+      # @param [Hash] query_params optional query params to pass to the request
+      # @return [Array] array of assignments
+      def assignments_projects(query_params = nil)
+        get('/assignments/projects', query_params)
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/dividers.rb

@@ -0,0 +1,14 @@
+module FileboundClient
+  module Endpoints
+    # Module for Dividers resource endpoint
+    module Dividers
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :divider
+          allow_all :dividers
+        end
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/document_binary_data.rb

@@ -0,0 +1,53 @@
+module FileboundClient
+  module Endpoints
+    # Module for DocumentBinaryData resource endpoint
+    module DocumentBinaryData
+      # Retrieves document binary data
+      # @param [int] document_id the document key
+      # @param [Hash] query_params optional query parameters to pass to the request
+      # @return [binary] binary data for the document
+      def retrieve_binary_data(document_id, query_params = nil)
+        get_binary("/documentBinaryData/#{document_id}", query_params)
+      end
+
+      # Adds binary data
+      # @param [String] extension the file extension
+      # @param [int] file_id the file id to add the binary data to
+      # @param [String] binary_data the Base64 encoded binary data to add
+      # @return [Hash] the new document
+      def add_binary_data(extension, file_id, binary_data)
+        raise FileboundClientException.new('extension is required', 0) if extension.blank?
+        # rubocop:disable Metrics/LineLength
+        raise FileboundClientException.new('file_id is required and must be greater than 0 when adding binary data', 0) if file_id.blank? || file_id.zero?
+        # rubocop:enable Metrics/LineLength
+        raise FileboundClientException.new('binary_data is required', 0) if binary_data.blank?
+        post('/documentBinaryData/0', nil, id: 0, extension: extension, fileId: file_id, documentToUpload: binary_data)
+      end
+
+      # Updates binary data
+      # @param [int] document_id the document key
+      # @param [String] extension the file extension
+      # @param [String] binary_data the Base64 encoded binary data to update
+      # @return [Hash] the updated document
+      def update_binary_data(document_id, extension, binary_data)
+        raise FileboundClientException.new('extension is required', 0) if extension.blank?
+        raise FileboundClientException.new('binary_data is required', 0) if binary_data.blank?
+        post("/documentBinaryData/#{document_id}", nil, id: document_id, extension: extension,
+                                                        documentToUpload: binary_data)
+      end
+
+      # Adds binary data to the indexing queue
+      # @param [String] extension the file extension
+      # @param [String] binary_data the Base-64 encoded binary data to send to the indexing queue
+      # @param [int] project_id the optional project_id to assign the binary data to
+      # @return [Hash] the new document
+      def add_to_indexing_queue(extension, binary_data, project_id = nil)
+        raise FileboundClientException.new('extension is required', 0) if extension.blank?
+        raise FileboundClientException.new('binary_data is required', 0) if binary_data.blank?
+        body = { extension: extension, documentToUpload: binary_data }
+        body[:projectId] = project_id unless project_id.blank?
+        put('/documentBinaryData', nil, body)
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/documents.rb

@@ -0,0 +1,102 @@
+module FileboundClient
+  module Endpoints
+    # Module for Documents resource endpoint
+    module Documents
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :document
+          allow_all :documents
+        end
+      end
+
+      # Retrieves a single document
+      # @param [int] document_id the document key
+      # @return [Hash] the document hash
+      def document(document_id, query_params = nil)
+        get("/documents/#{document_id}", query_params)
+      end
+
+      # Returns the eform data for the document key
+      # @param [int] document_id the document key
+      # @param [Hash] query_params the additional query params to send in the request
+      # @return [Hash] the EFormData hash
+      def document_eform_data(document_id, query_params = nil)
+        get("/documents/#{document_id}/eformdata", query_params)
+      end
+
+      # Returns the eform detail for the document key
+      # @param [int] document_id the document key
+      # @param [Hash] query_params the additional query params to send in the request
+      # @return [Hash] the EFormDetail hash
+      def document_eform_detail(document_id, query_params = nil)
+        get("/documents/#{document_id}/eformdetail", query_params)
+      end
+
+      # Returns a rendition for the document key
+      # @param [int] document_id the document key
+      # @param [Hash] query_params the additional query params to send in the request (optional: page(int))
+      # @return [String] rendition for the document
+      def document_rendition(document_id, query_params = nil)
+        get("/documents/#{document_id}/rendition", query_params)
+      end
+
+      # Adds eform data to document
+      # @param [int] document_id the document key
+      # @param [Hash] eform_data the eform data hash to add
+      # @return [Hash] the newly added eform data hash
+      def document_add_eformdata(document_id, eform_data)
+        put("/documents/#{document_id}/eformdata", nil, eform_data)
+      end
+
+      # Adds eform detail to document
+      # @param [int] document_id the document key
+      # @param [Hash] eform_detail the eform detail to add
+      # @return [Hash] the newly added eform detail hash
+      def document_add_eformdetail(document_id, eform_detail)
+        put("/documents/#{document_id}/eformdetail", nil, eform_detail)
+      end
+
+      # Updates eform data for the document
+      # @param [int] document_id the document key
+      # @param [Hash] eform_data the eform data hash to update
+      # @param [Hash] query_params additional query parameters to pass to the request (optional: deleteNonMatches(bool))
+      # @return [Hash] the updated eform data hash
+      def document_update_eformdata(document_id, eform_data, query_params = nil)
+        post("/documents/#{document_id}/eformdata", query_params, eform_data)
+      end
+
+      # Updates eform detail for the document
+      # @param [int] document_id the document key
+      # @param [Hash] eform_detail the eform detail hash to update
+      # @param [Hash] query_params additional query parameters to pass to the request (optional: deleteNonMatches(bool))
+      # @return [Hash] the updated eform detail hash
+      def document_update_eformdetail(document_id, eform_detail, query_params = nil)
+        put("/documents/#{document_id}/eformdetail", query_params, eform_detail)
+      end
+
+      # Updates a document
+      # @param [Hash] document the document hash to update
+      # @param [Hash] query_params additional query parameters to pass to the request (optional: setBinaryData(bool))
+      # @return [int] the document id that was updated
+      def document_update(document, query_params = nil)
+        post("/documents/#{document[:id]}", query_params, document)
+      end
+
+      # Adds a document
+      # @param [Hash] document the document hash to add
+      # @return [Hash] the newly added document hash
+      def document_add(document)
+        raise FileboundClientException.new('File Id is required', 0) unless document && document[:fileId] > 0
+        put("/documents/#{document[:fileId]}", nil, document)
+      end
+
+      # Delete a document
+      # @param [int] document_id the document key
+      # @return [bool] true if document was deleted successfully
+      def document_delete(document_id)
+        delete("/documents/#{document_id}")
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/eform_data.rb

@@ -0,0 +1,14 @@
+module FileboundClient
+  module Endpoints
+    # Module for EFormData resource endpoint
+    module EFormData
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :eformdata
+          allow_all :eformdata
+        end
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/eform_detail.rb

@@ -0,0 +1,14 @@
+module FileboundClient
+  module Endpoints
+    # Module for EFormDetail resource endpoint
+    module EFormDetail
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :eformdetail
+          allow_all :eformdetail
+        end
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/files.rb

@@ -0,0 +1,69 @@
+module FileboundClient
+  module Endpoints
+    # Module for Files resource endpoint
+    module Files
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :file
+          allow_all :files
+        end
+      end
+
+      # Retrieves a single file by its key
+      # @param [int] file_id the file key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter)
+      # @return [Hash] the file hash
+      def file(file_id, query_params = nil)
+        get("/files/#{file_id}", query_params)
+      end
+
+      # Retrieves all documents for the specified file key
+      # @param [int] file_id the file key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter)
+      # @return [Array] an array of document hashes
+      def file_documents(file_id, query_params = nil)
+        get("/files/#{file_id}/documents", query_params)
+      end
+
+      # Retrieves file_id by specifying a project id and key value
+      # @param [int] project_id the project key
+      # @param [String] key_value the key value to search on
+      # @return [int] the file id
+      def file_by_key_value(project_id, key_value)
+        get("/files/#{project_id}/ByKeyValue", value: key_value)
+      end
+
+      # Updates a file
+      # @param [int] file_id the file key
+      # @param [Hash] file the file hash with updated fields
+      # @return [Hash] the updated file hash
+      def file_update(file_id, file)
+        post("files/#{file_id}", nil, file)
+      end
+
+      # Adds a file
+      # @param [Hash] file the file hash to add
+      # @return [Hash] the newly added file hash
+      def file_add(file)
+        put('/files', nil, file)
+      end
+
+      # Adds file based on project key value
+      # @param [int] project_id the project key value
+      # @param [String] key_value the key value
+      # @param [Hash] file the file hash with updated fields
+      # @return [Hash] the updated file hash
+      def file_update_by_key_value(project_id, key_value, file)
+        put("/files/#{project_id}/ByKeyValue", { value: key_value }, file)
+      end
+
+      # Deletes a file
+      # @param [int] file_id the file key
+      # @return [bool] true if the file deleted successfully
+      def file_delete(file_id)
+        delete("/files/#{file_id}")
+      end
+    end
+  end
+end

data/lib/filebound_client/endpoints/projects.rb

@@ -0,0 +1,160 @@
+module FileboundClient
+  module Endpoints
+    # Module for Projects resource endpoint
+    module Projects
+      # This will call macros to create resource methods on the fly
+      def self.included(klass)
+        klass.instance_eval do
+          allow_new :project
+          allow_all :projects
+        end
+      end
+
+      # Retrieves a single project by its key
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request
+      # @return [Project] project object
+      def project(project_id, query_params = nil)
+        get("/projects/#{project_id}", query_params)
+      end
+
+      # Retrieves fields for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String),
+      #                                                                            includeProjectLinkOptions(bool))
+      # @return [Array] array of fields
+      def project_fields(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves files for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String))
+      # @return [Array] array of files
+      def project_files(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves groups for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String))
+      # @return [Array] array of groups
+      def project_groups(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves dividers for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String))
+      # @return [Array] array of dividers
+      def project_dividers(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves routed items for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String),
+      #                                                                            userId(int), type(int))
+      # @return [Array] array of routed items
+      def project_routeditems(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves separators for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String))
+      # @return [Array] array of separators
+      def project_separators(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves assignments for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String))
+      # @return [Array] array of assignments
+      def project_assignments(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Retrieves routes for a project
+      # @param [int] project_id the project key
+      # @param [Hash] query_params additional query params to send in the request (optional params: filter(String),
+      #                                                                            xml(bool), hiddenRoutes(bool))
+      # @return [Array] array of routes
+      def project_routes(project_id, query_params = nil)
+        get_project_children(project_id, __method__, query_params)
+      end
+
+      # Adds a project.  The project.ProjectId must be nil or 0.
+      # @param [Project] project the project to add
+      # @return [int] the id of the newly created project
+      # @example Add a project
+      #   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')
+      def project_add(project)
+        raise Client::FileboundClientException.new('Id is required', 0) if project[:projectId].greater_than_zero?
+        put('/projects', nil, project)
+      end
+
+      # Edits a project.  The project.ProjectId must be not nil and > 0.
+      # @param [Hash] project the project to edit
+      # @return [int] the project id updated
+      # @example Update an existing project
+      #   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_update(ProjectId: 165, Name: 'Test API Project', ProjectType: 'HR', EnableMultiKeySearch: true)
+      def project_update(project)
+        raise Client::FileboundClientException.new('Id is required', 0) unless project[:projectId].greater_than_zero?
+        put('/projects', nil, project)
+      end
+
+      # Adds a divider to a project
+      # @param [int] project_id the project key to add the divider to
+      # @param [Hash] divider the divider hash to add to the project
+      # @return [int] the divider id
+      def project_divider_add(project_id, divider)
+        put("/projects/#{project_id}/dividers", nil, divider)
+      end
+
+      # Adds a separator to a project
+      # @param [int] project_id the project key to add the separator to
+      # @param [Hash] separator the separator hash to add to the project
+      # @return [int] the separator id
+      def project_separator_add(project_id, separator)
+        put("/projects/#{project_id}/separators", nil, separator)
+      end
+
+      # Adds a file to a project
+      # @param [int] project_id the project key to add the file to
+      # @param [Hash] file the file hash to add
+      # @return [int] the file id created
+      def project_file_add(project_id, file)
+        put("/projects/#{project_id}/files", nil, file)
+      end
+
+      # Adds an array of files to a project
+      # @param [int] project_id the project key to add the files to
+      # @param [Array] files the array of file hashes to add
+      # @return [Hash] true if adding the files was successful
+      def project_files_add(project_id, files)
+        put("/projects/#{project_id}/listfiles", nil, files)
+      end
+
+      # Deletes a project
+      # @param [int] project_id the project key of the project to delete
+      # @return [bool] true if deleting the project was successful
+      def project_delete(project_id)
+        delete("/projects/#{project_id}")
+      end
+
+      private
+
+      def get_project_children(project_id, child_name, query_params = nil)
+        get("/projects/#{project_id}/#{child_name.to_s.split('_')[1]}", query_params)
+      end
+    end
+  end
+end