strawberry_api 0.5.4 → 0.6.0

data/doc/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Fri Mar  1 18:29:42 2019 by
+  Generated on Thu Mar 26 12:41:04 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.16 (ruby-2.5.0).
 </div>

data/lib/strawberry_api.rb

@@ -1,7 +1,7 @@
-require 'strawberry_api/configuration'
-require 'strawberry_api/http_client'
-require 'strawberry_api/client'
-require 'strawberry_api/version'
+require_relative 'strawberry_api/configuration'
+require_relative 'strawberry_api/http_client'
+require_relative 'strawberry_api/client'
+require_relative 'strawberry_api/version'
 
 # module StrawberryAPI provides access to Strawberry REST API
 #

data/lib/strawberry_api/client.rb

@@ -1,63 +1,63 @@
-require 'strawberry_api/access_right'
-require 'strawberry_api/api_key'
-require 'strawberry_api/asset'
-require 'strawberry_api/client'
-require 'strawberry_api/collection'
-require 'strawberry_api/metadatum'
-require 'strawberry_api/custom_metadatum'
-require 'strawberry_api/custom_metadata/custom_metadata_field'
-require 'strawberry_api/custom_metadata/custom_metadata_option'
-require 'strawberry_api/custom_metadata/custom_metadata_set'
-require 'strawberry_api/edit'
-require 'strawberry_api/feature'
-require 'strawberry_api/feedback'
-require 'strawberry_api/feedback/asset_feedback'
-require 'strawberry_api/feedback/copy_to_feedback'
-require 'strawberry_api/feedback/project_feedback'
-require 'strawberry_api/library'
-require 'strawberry_api/marker'
-require 'strawberry_api/project'
-require 'strawberry_api/proxy'
-require 'strawberry_api/role'
-require 'strawberry_api/schedule'
-require 'strawberry_api/session'
-require 'strawberry_api/setting'
-require 'strawberry_api/status_flag'
-require 'strawberry_api/strategy'
-require 'strawberry_api/strategy/archive_strategy'
-require 'strawberry_api/strategy/archive_strategy_state'
-require 'strawberry_api/strategy/asset_copy_to_strategy'
-require 'strawberry_api/strategy/project_copy_to_strategy'
-require 'strawberry_api/team'
-require 'strawberry_api/template'
-require 'strawberry_api/user'
-require 'strawberry_api/client/api_keys'
-require 'strawberry_api/client/assets'
-require 'strawberry_api/client/asset_feedbacks'
-require 'strawberry_api/client/copy_to_feedbacks'
-require 'strawberry_api/client/project_feedbacks'
-require 'strawberry_api/client/collections'
-require 'strawberry_api/client/custom_metadata'
-require 'strawberry_api/client/custom_metadata_fields'
-require 'strawberry_api/client/custom_metadata_options'
-require 'strawberry_api/client/custom_metadata_sets'
-require 'strawberry_api/client/edits'
-require 'strawberry_api/client/features'
-require 'strawberry_api/client/libraries'
-require 'strawberry_api/client/markers'
-require 'strawberry_api/client/projects'
-require 'strawberry_api/client/roles'
-require 'strawberry_api/client/schedules'
-require 'strawberry_api/client/searches'
-require 'strawberry_api/client/sessions'
-require 'strawberry_api/client/settings'
-require 'strawberry_api/client/status_flags'
-require 'strawberry_api/client/archive_strategies'
-require 'strawberry_api/client/asset_copy_to_strategies'
-require 'strawberry_api/client/project_copy_to_strategies'
-require 'strawberry_api/client/teams'
-require 'strawberry_api/client/templates'
-require 'strawberry_api/client/users'
+require_relative 'access_right'
+require_relative 'api_key'
+require_relative 'asset'
+require_relative 'client'
+require_relative 'collection'
+require_relative 'metadatum'
+require_relative 'custom_metadatum'
+require_relative 'custom_metadata/custom_metadata_field'
+require_relative 'custom_metadata/custom_metadata_option'
+require_relative 'custom_metadata/custom_metadata_set'
+require_relative 'edit'
+require_relative 'feature'
+require_relative 'feedback'
+require_relative 'feedback/asset_feedback'
+require_relative 'feedback/copy_to_feedback'
+require_relative 'feedback/project_feedback'
+require_relative 'library'
+require_relative 'marker'
+require_relative 'project'
+require_relative 'proxy'
+require_relative 'role'
+require_relative 'schedule'
+require_relative 'session'
+require_relative 'setting'
+require_relative 'status_flag'
+require_relative 'strategy'
+require_relative 'strategy/archive_strategy'
+require_relative 'strategy/archive_strategy_state'
+require_relative 'strategy/asset_copy_to_strategy'
+require_relative 'strategy/project_copy_to_strategy'
+require_relative 'team'
+require_relative 'template'
+require_relative 'user'
+require_relative 'client/api_keys'
+require_relative 'client/assets'
+require_relative 'client/asset_feedbacks'
+require_relative 'client/copy_to_feedbacks'
+require_relative 'client/project_feedbacks'
+require_relative 'client/collections'
+require_relative 'client/custom_metadata'
+require_relative 'client/custom_metadata_fields'
+require_relative 'client/custom_metadata_options'
+require_relative 'client/custom_metadata_sets'
+require_relative 'client/edits'
+require_relative 'client/features'
+require_relative 'client/libraries'
+require_relative 'client/markers'
+require_relative 'client/projects'
+require_relative 'client/roles'
+require_relative 'client/schedules'
+require_relative 'client/searches'
+require_relative 'client/sessions'
+require_relative 'client/settings'
+require_relative 'client/status_flags'
+require_relative 'client/archive_strategies'
+require_relative 'client/asset_copy_to_strategies'
+require_relative 'client/project_copy_to_strategies'
+require_relative 'client/teams'
+require_relative 'client/templates'
+require_relative 'client/users'
 
 module StrawberryAPI
   # Class Client provides methods for querying Strawberry API resources
@@ -93,4 +93,4 @@ module StrawberryAPI
     include StrawberryAPI::Client::Templates
     include StrawberryAPI::Client::Users
   end
-end
+end

data/lib/strawberry_api/client/projects.rb

@@ -7,7 +7,7 @@ module StrawberryAPI
       # @option [Boolean] include_libraries false Include project libraries
       #
       # @return [Array<StrawberryAPI::Project>] A list of projects
-      # 
+      #
       def projects(include_libraries: false)
         projects = get("/projects").parse['projects']&.map do |project|
           Project.new(project)
@@ -26,12 +26,12 @@ module StrawberryAPI
       #
       #
       # @return [Array<StrawberryAPI::Project>] A list of library projects
-      # 
+      #
       def library_projects
         projects = get("/projects").parse['projects']&.map do |project|
           Project.new(project)
         end
-        
+
         projects.keep_if do |project|
           project.is_library_project
         end
@@ -41,7 +41,7 @@ module StrawberryAPI
       #
       #
       # @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
@@ -52,7 +52,7 @@ module StrawberryAPI
       #
       #
       # @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
@@ -64,7 +64,7 @@ module StrawberryAPI
       # @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)
@@ -76,7 +76,7 @@ module StrawberryAPI
       # @param [String] templatename Name of the template to use
       #
       # @return [StrawberryAPI::Project] The created project
-      # 
+      #
       def create_project(name:, templatename:, custom_metadata: nil)
         if custom_metadata
             custom_metadata = custom_metadata.each_with_object(Array.new) do |field, memo|
@@ -90,7 +90,7 @@ module StrawberryAPI
           custom_metadata: custom_metadata
         }.to_json
 
-        data = post("/projects", body: body).parse['project']
+        temp = post("/projects", body: body).parse['job']
 
         data.nil? ? nil : Project.new(data)
       end
@@ -101,7 +101,7 @@ module StrawberryAPI
       # @param [Hash] options Hash of options
       #
       # @return [StrawberryAPI::Project] The updated project
-      # 
+      #
       def update_project(id:, options: {})
         data = put("/projects/#{id}", body: options.to_json).parse['project']
         data.nil? ? nil : Project.new(data)
@@ -112,7 +112,7 @@ module StrawberryAPI
       # @param [Integer] id Id of the project to delete
       #
       # @return [Boolean] Success
-      # 
+      #
       def delete_project(id:)
         delete("/projects/#{id}").success?
       end
@@ -122,7 +122,7 @@ module StrawberryAPI
       # @param [Integer] id Id of the project to open
       #
       # @return [Boolean] Success
-      # 
+      #
       def open_project(id:)
         put("/projects/#{id}/open").success?
       end
@@ -132,7 +132,7 @@ module StrawberryAPI
       # @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)
@@ -143,7 +143,7 @@ module StrawberryAPI
       # @param [Integer] id Id of the project to freeze
       #
       # @return [Boolean] Success
-      # 
+      #
       def freeze_project(id:)
         put("/projects/#{id}/freeze").success?
       end
@@ -153,17 +153,17 @@ module StrawberryAPI
       # @param [Integer] id Id of the project to unfreeze
       #
       # @return [Boolean] Success
-      # 
+      #
       def unfreeze_project(id:)
         delete("/projects/#{id}/unfreeze").success?
       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)
@@ -174,7 +174,7 @@ module StrawberryAPI
       # @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)
@@ -185,7 +185,7 @@ module StrawberryAPI
       # @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)
@@ -196,7 +196,7 @@ module StrawberryAPI
       # @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)
@@ -207,7 +207,7 @@ module StrawberryAPI
       # @param [Integer] id Id of the mounted project to refresh
       #
       # @return [StrawberryAPI::ProjectFeedback] The operation status
-      # 
+      #
       def refresh_mounted_project(id:)
         data = put("/projects/#{id}/refreshmountedproject", headers: {'X-FLAVOURSYS-EDIT' => edit}).parse['job']
         data.nil? ? nil : ProjectFeedback.new(data)
@@ -218,13 +218,13 @@ module StrawberryAPI
       # @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
-        
+
         data = put("/projects/#{id}/archive", body: body).parse['archivestrategystate']
         data.nil? ? nil : ArchiveStrategyState.new(data)
       end
@@ -234,7 +234,7 @@ module StrawberryAPI
       # @param [Integer] id Id of the project to unarchive
       #
       # @return [StrawberryAPI::ArchiveStrategyState] The operation status
-      # 
+      #
       def unarchive_project(id:)
         data = put("/projects/#{id}/unarchive").parse['archivestrategystate']
         data.nil? ? nil : ArchiveStrategyState.new(data)
@@ -245,7 +245,7 @@ module StrawberryAPI
       # @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)
@@ -257,7 +257,7 @@ module StrawberryAPI
       # @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|
@@ -269,8 +269,8 @@ module StrawberryAPI
       #
       # @param [Integer] id Id of the project to retrieve access rights from
       #
-      # @return [Array<StrawberryAPI::AccessRight>] The fetched project access rights 
-      # 
+      # @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|
@@ -285,7 +285,7 @@ module StrawberryAPI
       # @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,
@@ -301,7 +301,7 @@ module StrawberryAPI
       # @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
@@ -311,7 +311,7 @@ module StrawberryAPI
       # @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
@@ -321,7 +321,7 @@ module StrawberryAPI
       # @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|
@@ -335,7 +335,7 @@ module StrawberryAPI
       # @param [Hash] custom_metadata Custom metadata to update the project with
       #
       # @return [Boolean] Success
-      # 
+      #
       def update_project_custom_metadata(id:, custom_metadata: nil)
         filthy_hash = StrawberryAPI::CustomMetadatum.filthify(custom_metadata: custom_metadata)
         put("/projects/#{id}/update_metadata", query: filthy_hash).success?
@@ -346,7 +346,7 @@ module StrawberryAPI
       # @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|
@@ -358,7 +358,7 @@ module StrawberryAPI
       #
       #
       # @return [Hash] The fetched projects size
-      # 
+      #
       def projects_size
         get("/total_project_size").parse
       end
@@ -367,11 +367,11 @@ module StrawberryAPI
       #
       #
       # @return [Hash] The fetched projects report
-      # 
+      #
       def projects_repor
         get("/projects_report").parse
       end
 
     end
   end
-end
+end

data/lib/strawberry_api/http_client.rb

@@ -10,7 +10,7 @@ module StrawberryAPI
 
     include HTTParty
     headers 'Accept': 'application/json', 'Content-Type': 'application/json', 'X-FLAVOURSYS-CLIENT': 'API client 1.0'
-    
+
     # Class HTTParty::Response provides methods to handle HTTP reponses
     #
     # @author John Nunemaker <nunemaker@gmail.com>
@@ -44,7 +44,7 @@ module StrawberryAPI
 
       if api_key
         self.class.get("/session", headers: {Authorization: "Bearer #{api_key}"}).success?
-        
+
         @headers = self.class.headers.dup
         @headers[:Authorization] = "Bearer #{api_key}"
       elsif username && password
@@ -61,9 +61,9 @@ module StrawberryAPI
     def request(method, path, mute_failure: false, **options)
       options[:headers] = @headers
       options[:cookies] = @cookies
-      
+
       response = self.class.send(method, path, options)
-      
+
       if mute_failure
         response
       else
@@ -78,7 +78,7 @@ module StrawberryAPI
     # @return [HTTParty::Response] HTTP reponse
     #
     # @raise [String] Indicates the reponse error code and information
-    # 
+    #
     def handle_response(response)
       if response.success?
         response
@@ -86,14 +86,14 @@ module StrawberryAPI
         raise "#{response.code} #{response['error']}"
       end
     end
-    
+
     # Overrides HTTPary reponse handling
     #
     # @param [String] path
     # @param [String] mute_failure Prevents error raise if request fails
     #
     # @return [HTTParty::Response] API response
-    # 
+    #
     def get(path, mute_failure: false, **options)
       request(:get, path, mute_failure: false, **options)
     end
@@ -104,7 +104,7 @@ module StrawberryAPI
     # @param [String] mute_failure Prevents error raise if request fails
     #
     # @return [HTTParty::Response] API response
-    # 
+    #
     def post(path, mute_failure: false, **options)
       request(:post, path, mute_failure: false, **options)
     end
@@ -115,7 +115,7 @@ module StrawberryAPI
     # @param [String] mute_failure Prevents error raise if request fails
     #
     # @return [HTTParty::Response] API response
-    # 
+    #
     def put(path, mute_failure: false, **options)
       request(:put, path, mute_failure: false, **options)
     end
@@ -126,10 +126,10 @@ module StrawberryAPI
     # @param [String] mute_failure Prevents error raise if request fails
     #
     # @return [HTTParty::Response] API response
-    # 
+    #
     def delete(path, mute_failure: false, **options)
       request(:delete, path, mute_failure: false, **options)
     end
 
   end
-end
+end