strawberry_api 0.1.0

data/lib/strawberry_api/client/edits.rb

@@ -0,0 +1,47 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Edits
+
+      # Fetches all edits
+      #
+      #
+      # @return [Array<StrawberryAPI::Edit>] A list of edits
+      # 
+      def edits
+        get("/edits").parse['edits']&.map do |edit|
+          Edit.new(edit)
+        end
+      end
+
+      # Fetches an edit
+      #
+      # @param [Integer] id Id of the edit to retrieve
+      #
+      # @return [StrawberryAPI::Edit] The fetched edit
+      # 
+      def edit(id:)
+        data = get("/edits/#{id}").parse['edit']
+        data.nil? ? nil : Edit.new(data)
+      end
+
+      # Fetches an edit status 
+      #
+      #
+      # @return [<type>] <description>
+      # 
+      def edit_status
+        get("/edit/status").parse['hash']
+      end
+
+      # Clears an edit
+      #
+      #
+      # @return [Boolean] Success
+      # 
+      def edit_clear
+        put("/edit/clear").success?
+      end
+      
+    end
+  end
+end

data/lib/strawberry_api/client/features.rb

@@ -0,0 +1,29 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Features
+
+      # Fetches all features
+      #
+      #
+      # @return [Array<StrawberryAPI::Feature>] A list of features
+      # 
+      def features
+        get("/features").parse['features']&.map do |feature|
+          Feature.new(feature)
+        end
+      end
+
+      # Fetches a feature
+      #
+      # @param [Integer] id Id of the feature to retrieve
+      #
+      # @return [StrawberryAPI::Feature] The fetched feature
+      # 
+      def feature(id:)
+         data = get("/features/#{id}").parse['feature']
+         data.nil? ? nil : Feature.new(data)
+      end
+    
+    end
+  end
+end

data/lib/strawberry_api/client/libraries.rb

@@ -0,0 +1,30 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Libraries
+
+      # Fetches all libraries
+      #
+      #
+      # @return [Array<StrawberryAPI::Library>] A list of libraries
+      # 
+      def libraries
+        get("/library_ingests").parse['array']&.map do |library|
+          Library.new(library)
+        end
+      end
+
+      # Fetches a library
+      #
+      # @param [Integer] id Id of the library to retrieve
+      #
+      # @return [StrawberryAPI::Library] The fetched library
+      # 
+      def library(id: nil, project_id: nil)
+        libraries.find do |library|
+          library.id == id.to_i || library.project_id == project_id.to_i
+        end
+      end
+
+    end
+  end
+end

data/lib/strawberry_api/client/markers.rb

@@ -0,0 +1,19 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Markers
+
+      # Fetches an asset marker descriptions
+      #
+      # @param [Interger] asset_id Id of the asset to retrieve marker descriptions from
+      #
+      # @return [Array<StrawberryAPI::Marker>] The fetched asset marker descriptions
+      # 
+      def marker(asset_id:)
+        get("/assets/#{asset_id}/marker_descriptions").parse['array']&.map do |marker|
+          Marker.new(marker)
+        end
+      end
+      
+    end
+  end
+end

data/lib/strawberry_api/client/project_copy_to_strategies.rb

@@ -0,0 +1,88 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module ProjectCopyToStrategies
+
+      # Fetches all project copy to strategies
+      #
+      #
+      # @return [Array<StrawberryAPI::ProjectCopyToStrategy>] A list of project copy to strategies
+      # 
+      def project_copy_to_strategies
+        get("/project_copy_to_strategies").parse['array']&.map do |project_copy_to_strategy|
+          ProjectCopyToStrategy.new(project_copy_to_strategy)
+        end
+      end
+
+      # Fetches a project copy to strategy
+      #
+      # @param [Integer] id Id of the project copy to strategy to retrieve
+      #
+      # @return [StrawberryAPI::ProjectCopyToStrategy] The fetched project copy to strategy
+      # 
+      def project_copy_to_strategy(id:)
+        data = get("/project_copy_to_strategies/#{id}").parse['projectcopytostrategy']
+        data.nil? ? nil : ProjectCopyToStrategy.new(data)
+      end
+
+      # Creates a project copy to strategy
+      #
+      # @param [String] name
+      # @param [String] destination
+      # @param [String] format 'plain'
+      # @param [Boolean] admin_only true
+      # @param [String] includes 'none'
+      # @param [String] enabled true
+      # @param [String] strategy_type 'native'
+      # @param [String] contents 'both'
+      # @param [Boolean] delete_project false
+      #
+      # @return [StrawberryAPI::ProjectCopyToStrategy] The created project copy to strategy
+      # 
+      def create_project_copy_to_strategy(name:, destination:, format: 'plain', admin_only: true, includes: 'none', enabled: true, strategy_type: 'native', contents: 'both', delete_project: false)
+        body = {
+          name: name,
+          destination: destination,
+          format: format,
+          admin_only: admin_only,
+          enabled: enabled,
+          contents: contents,
+          includes: includes,
+          delete_project: delete_project
+        }.to_json
+        
+        data = post("/project_copy_to_strategies", body: body).parse['projectcopytostrategy']
+        data.nil? ? nil : ProjectCopyToStrategy.new(data)
+      end
+
+      # Updates a project copy to trategy
+      #
+      # @param [Integer] id Id of the user to update
+      # @option options [String] :username
+      # @option options [String] :firstname
+      # @option options [String] :lastname
+      # @option options [String] :password
+      # @option options [String] :role_id
+      # @option options [String] :user_matrix_attributes
+      #
+      # @return [StrawberryAPI::ProjectCopyToStrategy] The updated project copy to strategy
+      # 
+      def update_project_copy_to_strategy(id:, **options)
+        body = args.to_json
+        
+        data = put("/project_copy_to_strategies/#{id}", body: body).parse['projectcopytostrategy']
+        data.nil? ? nil : ProjectCopyToStrategy.new(data)
+      end
+
+      # Deletes a project copy to strategy
+      #
+      # @param [Integer] id Id of the project copy to strategy to delete
+      #
+      # @return [Boolean>] Success
+      # 
+      def destroy_project_copy_to_strategy(id:)
+        delete("/project_copy_to_strategies/#{id}").success?
+      end
+      
+    end
+  end
+end

data/lib/strawberry_api/client/project_feedbacks.rb

@@ -0,0 +1,18 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module ProjectFeedbacks
+
+      # Fetches a project feedback
+      #
+      # @param [Integer] id Id of the project feedback to retrieve
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The fetched project feedback
+      # 
+      def project_feedback(id:)
+       data = get("/status/#{id}").parse['job']
+       data.nil? ? nil : ProjectFeedback.new(data)
+      end
+      
+    end
+  end
+end

data/lib/strawberry_api/client/projects.rb

@@ -0,0 +1,305 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Projects
+
+      # Fetches all projects
+      #
+      #
+      # @return [Array<StrawberryAPI::Project>] A list of projects
+      # 
+      def projects
+        get("/projects").parse['projects']&.map do |project|
+          Project.new(project)
+        end
+      end
+
+      # Fetches all library projects
+      #
+      #
+      # @return [Array<StrawberryAPI::Project>] A list of library projects
+      # 
+      def library_projects
+        projects.select do |project|
+          !project.deleted && project.is_library_project
+        end
+      end
+
+      # Fetches all online projects
+      #
+      #
+      # @return [Array<StrawberryAPI::Project>] A list of online projects
+      # 
+      def online_projects
+        projects.select do |project|
+          project.archive_strategy_id.nil? && !project.deleted && !project.is_library_project
+        end
+      end
+
+      # Fetches all archived projects
+      #
+      #
+      # @return [Array<StrawberryAPI::Project>] A list of archived projects
+      # 
+      def archived_projects
+        projects.select do |project|
+          project.archive_strategy_id && !project.deleted && !project.is_library_project
+        end
+      end
+
+      # Fetches a project
+      #
+      # @param [Integer] id Id of the project to retrieve
+      #
+      # @return [StrawberryAPI::Project] The fetched project
+      # 
+      def project(id:)
+        data = get("/projects/#{id}").parse['project']
+        data.nil? ? nil : Project.new(data)
+      end
+
+      # Creates a project
+      #
+      # @param [String] name Name of the project to create
+      # @param [String] templatename Name of the template to use
+      #
+      # @return [StrawberryAPI::Project] The created project
+      # 
+      def create_project(name:, templatename:)
+        body = {
+          name: name,
+          templatename: templatename
+        }.to_json
+        
+        data = post("/projects", body: body).parse['project']
+        data.nil? ? nil : Project.new(data)
+      end
+
+      # Deletes a project
+      #
+      # @param [Integer] id Id of the project to delete
+      #
+      # @return [Boolean] Success
+      # 
+      def destroy_project(id:)
+        delete("/projects/#{id}").success?
+      end
+
+      # Opens a project
+      #
+      # @param [Integer] id Id of the project to open
+      #
+      # @return [Boolean] Success
+      # 
+      def open_project(id:)
+        put("/projects/#{id}/open").success?
+      end
+
+      # Syncs a project
+      #
+      # @param [Integer] id Id of the project to sync
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def sync_project(id:)
+        data = put("/projects/#{id}/sync").parse['job']
+        data.nil? ? nil : ProjectFeedback.new(data)
+      end
+      
+      # Closes a project
+      #
+      # @param [Integer] id Id of the project to close
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def close_project(id:, edit:)
+        delete("/projects/#{id}/close", headers: {'X-FLAVOURSYS-EDIT' => edit}).parse['job']
+        data.nil? ? nil : ProjectFeedback.new(data)
+      end
+
+      # Forcecloses a project
+      #
+      # @param [Integer] id Id of the project to forceclose
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def forceclose_project(id:, edit:)
+        data = delete("/projects/#{id}/forceclose", headers: {'X-FLAVOURSYS-EDIT' => edit}).parse['job']
+        data.nil? ? nil : ProjectFeedback.new(data)
+      end
+
+      # Mounts a project
+      #
+      # @param [Integer] id Id of the project to mount
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def mount_project(id:, edit:)
+        data = put("/projects/#{id}/mount", headers: {'X-FLAVOURSYS-EDIT' => edit}).parse['job']
+        data.nil? ? nil : ProjectFeedback.new(data)
+      end
+
+      # Unmounts a project
+      #
+      # @param [Integer] id Id of the project to unmount
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def umount_project(id:, edit:)
+        data = delete("/projects/#{id}/umount", headers: {'X-FLAVOURSYS-EDIT' => edit}).parse['job']
+        data.nil? ? nil : ProjectFeedback.new(data)
+      end
+
+      # Refreshes a mounted project
+      #
+      # @param [Integer] id Id of the mounted project to refresh
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def refresh_mounted_project(id:)
+        put("/projects/#{id}/refreshmountedproject", headers: {'X-FLAVOURSYS-EDIT' => edit}).parse['job']
+        data.nil? ? nil : ProjectFeedback.new(data)
+      end
+
+      # Archives a project
+      #
+      # @param [Integer] id Id of the project to archive
+      #
+      # @return [StrawberryAPI::ProjectFeedback] The operation status
+      # 
+      def archive_project(id:, archive_strategy_id:, exclude_linked_files: false)
+        body = {
+          strategy: archive_strategy_id,
+          exclude_linked_files: exclude_linked_files
+        }.to_json
+        
+        put("/projects/#{id}/archive", body: body).parse['archivestrategystate']&.map do |state|
+          ArchiveStrategyState.new(state)
+        end
+      end
+
+      # Unarchives a project
+      #
+      # @param [Integer] id Id of the project to unarchive
+      #
+      # @return [StrawberryAPI::ArchiveStrategyState] The operation status
+      # 
+      def unarchive_project(id:)
+        put("/projects/#{id}/unarchive").parse['archivestrategystate']&.map do |state|
+          ArchiveStrategyState.new(state)
+        end
+      end
+
+      # Searches for a substring in project names
+      #
+      # @param [String] name Substring to look for
+      #
+      # @return [Array<StrawberryAPI::Project>] A list of project matching the substring
+      # 
+      def search_project(name:)
+        get("/projects/search", body: {name: name}).parse['projects']&.map do |project|
+          Project.new(project)
+        end
+      end
+
+      # Fetches all teams assigned to a project
+      #
+      # @param [Interger] id If of the project to retrieve teams from
+      #
+      # @return [Array<StrawberryAPI::Team>] The fetched project teams
+      # 
+      def project_teams(id:)
+        teams = get("/projects/#{id}/teams").parse['array']
+         teams.map do |team|
+          Team.new(team.first)
+        end
+      end
+
+      # Fetches all access rights of a project
+      #
+      # @param [Integer] id Id of the project to retrieve access rights from
+      #
+      # @return [Array<StrawberryAPI::AccessRight>] The fetched project access rights 
+      # 
+      def project_effective_access_rights(id:)
+        access_rights = get("/projects/#{id}/effective_access_rights").parse['hash']
+        access_rights.map do |accessright|
+          AccessRight.new(accessright)
+        end
+      end
+
+      # Assigns a team to a project
+      #
+      # @param [Integer] id Id of the project to which the team should be added
+      # @param [Integer] team_id Id of the team to add to the project
+      # @param [Boolean] write false Write access to the project
+      #
+      # @return [Boolean] Success
+      # 
+      def add_team_to_project(id:, team_id:, write: false)
+        body = {
+          team_id: team_id,
+          write: write
+        }.to_json
+
+        put("/projects/#{id}/teams", body: body).success?
+      end
+
+      # Removes a team from a project
+      #
+      # @param [Integer] id Id of the project from which the team should be deleted
+      # @param [Integer] team_id Id of the team to remove from the project
+      #
+      # @return [Boolean] Success
+      # 
+      def remove_team_from_project(id:, team_id:)
+        delete("/projects/#{id}/teams/#{team_id}").success?
+      end
+
+      # Fetches a project status flags
+      #
+      # @param [Integer] id Id of the project to retrieve status flags from
+      #
+      # @return [Hash] The fetched project status flags
+      # 
+      def project_status_flags(id:)
+        status_flags = get("/projects/#{id}/status_flags").parse['array']
+      end
+
+      # Fetches a project custom metadata
+      #
+      # @param [Integer] id Id of the project to retrieve custom metadata from
+      #
+      # @return [Array<StrawberryAPI::CustomMetadata>] The fetched project custom metadata
+      # 
+      def project_custom_metadata(id:)
+        custom_metadata = get("/projects/#{id}/custom_metadata").parse['array']
+        custom_metadata.map do |custom_metadata|
+          CustomMetadata.new(custom_metadata)
+        end
+      end
+
+      # Fetches a project assets
+      #
+      # @param [Integer] id Id of the project to retrieve which to retrieve assets from
+      #
+      # @return [Array<StrawberryAPI::Asset>] The fetched project assets
+      # 
+      def project_assets(id:)
+        assets = get("/projects/#{id}/assets").parse['assets']
+        assets.map do |asset|
+          Asset.new(asset)
+        end
+      end
+
+      # Fetches projects report
+      #
+      #
+      # @return [Hash] The fetched projects report
+      # 
+      def projects_report
+        get("/projects_report").parse
+      end
+
+    end
+  end
+end

data/lib/strawberry_api/client/roles.rb

@@ -0,0 +1,18 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Roles
+
+      # Fetches all roles
+      #
+      #
+      # @return [Array<StrawberryAPI::Role>] A list of roles
+      # 
+      def roles
+        get("/roles").parse['array']&.map do |role|
+          Role.new(role)
+        end
+      end
+
+    end
+  end
+end

data/lib/strawberry_api/client/schedules.rb

@@ -0,0 +1,29 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Schedules
+
+      # Fetches all schedules
+      #
+      #
+      # @return [Array<StrawberryAPI::Schedule>] A list of schedules
+      # 
+      def schedules
+        get("/schedules").parse['schedules']&.map do |schedule|
+          Schedule.new(schedule)
+        end
+      end
+
+      # Fetches a schedule
+      #
+      # @param [Integer] id Id of the schedule to retrieve
+      #
+      # @return [StrawberryAPI::Schedule] The fetched schedule
+      # 
+      def schedule(id:)
+        data = get("/schedules/#{id}").parse['schedule']
+        data.nil? ? nil : Schedule.new(data)
+      end
+    
+    end
+  end
+end

data/lib/strawberry_api/client/searches.rb

@@ -0,0 +1,25 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Searches
+
+      # Searches for a term through projects and/or assets
+      #
+      # @param [String] term
+      # @option [String] order_by 'updated_at'
+      # @option [String] order 'desc'
+      # @option [Integer] per_page 10
+      # @option [Integer] page 1
+      # @option [Boolean] projects true
+      # @option [Boolean] assets true
+      #
+      # @return [Hash] A list of projets and/or assets matching the search term
+      # 
+      def search(term:, order_by: 'updated_at', order: 'desc', per_page: 10, page: 1, projects: true, assets: true)
+        body = {term: term, order_by: order_by, order: order, per_page: per_page, page: page, projects: projets, assets: assets}
+        
+        get("/search", body: body)
+      end
+    
+    end
+  end
+end

data/lib/strawberry_api/client/sessions.rb

@@ -0,0 +1,33 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Sessions
+
+      # Determines whether the session is valid
+      #
+      #
+      # @return [Boolean] Success
+      # 
+      def logged_in?
+        get("/session").success?
+      end
+
+      # Closes the current session
+      #
+      #
+      # @return [Boolean] Success
+      # 
+      def logout
+        delete('/session').success?
+      end
+
+      # Fetches the current user information
+      #
+      #
+      # @return [StrawberryAPI::User] The fetched user
+      # 
+      def session_info
+        data = get('/session')
+      end
+    end
+  end
+end

data/lib/strawberry_api/client/settings.rb

@@ -0,0 +1,16 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Settings
+
+      # Fetches all settings
+      #
+      #
+      # @return [Hash] A list of all settings
+      # 
+      def settings
+        get("/settings").parse['settings']
+      end
+
+    end
+  end
+end

data/lib/strawberry_api/client/status_flags.rb

@@ -0,0 +1,27 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module StatusFlags
+
+      # Fetches all status flags
+      #
+      #
+      # @return [Array<StrawberryAPI::StatusFlag>] A list of status flags
+      # 
+      def status_flags
+        get("/status_flags").parse['array']
+      end
+
+      # Fetches a status flag
+      #
+      # @param [Integer] id Id of the status flag to retrieve
+      #
+      # @return [StrawberryAPI::StatusFlag] The fetched status flag
+      # 
+      def status_flag(id:)
+        data = get("/status_flags/#{id}").parse['status_flag']
+        data.nil? ? nil : StatusFlag.new(data)
+      end
+      
+    end
+  end
+end