strawberry_api 0.1.0

data/lib/strawberry_api/client/teams.rb

@@ -0,0 +1,107 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Teams
+
+      # Fetches all teams
+      #
+      #
+      # @return [Array<StrawberryAPI::Team>] A list of teams
+      # 
+      def teams
+        get("/teams").parse['teams']&.map do |team|
+          Team.new(team)
+        end
+      end
+
+      # Fetches a team
+      #
+      # @param [Integer] id Id of the team to retrieve
+      #
+      # @return [StrawberryAPI::Team] The fetched team
+      # 
+      def team(id:)
+        data = get("/teams/#{id}").parse['team']
+        data.nil? ? nil : Team.new(data)
+      end
+
+      # Featches the current user team
+      #
+      #
+      # @return [Array<StrawberryAPI::Team>] The fetched current user teams
+      # 
+      def user_owned_teams
+        get("/teams/user_owned").parse['teams']&.map do |team|
+          Team.new(team)
+        end
+      end
+
+      # Creates a new team
+      #
+      # @param [String] name Name of the team to create
+      # @option [Integer] quota: nil Quota to assign to the team
+      # @option [Boolean] quota_mail_sent: false Enable quota email notification
+      #
+      # @return [StrawberryAPI::Team] The created team
+      # 
+      def create_team(name:, quota: nil, quota_mail_sent: false)
+        body = {
+          name: name,
+          quota: quota,
+          quota_mail_sent: quota_mail_sent
+        }.to_json
+        
+        data = post("/teams", body: body).parse['teams']
+        data.nil? ? nil : Team.new(data)
+      end
+
+      # Updates a team
+      #
+      # @param [Integer] id Id of the user to update
+      # @option options [String] :name
+      # @option options [String] :quota
+      # @option options [String] :quota_mail_sent
+      #
+      # @return [StrawberryAPI::Team] The updated team
+      # 
+      def update_team(id:, **options)
+        body = args.to_json
+        
+        data = put("/teams/#{id}", body: body).parse['team']
+        data.nil? ? nil : Team.new(data)
+      end
+      
+      # Deletes a team
+      #
+      # @param [Integer] id Id of the team to delete
+      #
+      # @return [Boolean] Success
+      # 
+      def destroy_team(id:)
+        delete("/teams/#{id}").success?
+      end  
+
+      # Adds a user to a team
+      #
+      # @param [Integer] team_id Id of the team the user should be added to
+      # @param [Integer] user_id Id of the user to add the team to
+      #
+      # @return [Boolean] Success
+      # 
+      def add_user_to_team(team_id:, user_id:)
+        post("/users/#{team_id}/teams/#{user_id}").success?
+      end
+
+      # Removes a user from a team
+      #
+      # @param [Integer] team_id Id of the team the user should be removed from
+      # @param [Integer] user_id Id of the user to remove from the team
+      #
+      # @return [Boolean] Success
+      # 
+      def remove_user_from_team(team_id:, user_id:)
+        delete("/users/#{team_id}/teams/#{user_id}").success?
+      end
+
+    end
+  end
+end

data/lib/strawberry_api/client/templates.rb

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

data/lib/strawberry_api/client/users.rb

@@ -0,0 +1,125 @@
+module StrawberryAPI
+  class Client < StrawberryAPI::HttpClient
+    module Users
+
+      # Fetches all users
+      #
+      #
+      # @return [Array<StrawberryAPI::User>] A list of users
+      # 
+      def users
+        get("/users").parse['users']&.map do |user|
+          User.new(user)
+        end
+      end
+
+      # Fetches all users
+      #
+      #
+      # @return [Array<StrawberryAPI::User>] A list of users
+      # 
+      def user(id:)
+        data = get("/users/#{id}?with_teams=true").parse['user']
+        data.nil? ? nil : User.new(data)
+      end
+
+      # Creates a new user
+      #
+      # @param [String] username Username of the user to create
+      # @param [String] firstname nil Firstname of the user to create
+      # @param [String] lastname nil Lastname of the user to create
+      # @param [String] password Password of the user to create
+      # @param [Integer] role_id Id of the role to assign the the user to
+      # @option [String] user_matrix_attributes Matric attributes to assign to the user to create
+      #
+      # @return [StrawberryAPI::User] The created user
+      # 
+      def create_user(username:, firstname: nil, lastname: nil, password:, role_id:, user_matrix_attributes: nil)
+        body = {
+          username: username,
+          firstname: firstname,
+          lastname: lastname,
+          password: password,
+          password_confirmation: password,
+          role_id: role_id,
+          user_matrix_attributes: user_matrix_attributes
+        }.to_json
+        
+        data = post("/users", body: body).parse['user']
+        data.nil? ? nil : User.new(data)
+      end
+
+      # Updates a user
+      #
+      # @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::User] The updated user
+      # 
+      def update_user(id:, **options)
+        body = args.to_json
+        
+        data = put("/users/#{id}", body: body).parse
+        data.nil? ? nil : User.new(data)
+      end
+
+      # Deletes a user
+      #
+      # @param [Integer] id Id of the user to delete
+      #
+      # @return [Boolean] Success
+      # 
+      def destroy_user(id:)
+        delete("/users/#{id}").success?
+      end
+
+      # Adds a team to a user
+      #
+      # @param [Integer] user_id Id of the user the team should be added to
+      # @param [Integer] team_id Id of the team to add the user to
+      #
+      # @return [Boolean] Success
+      # 
+      def add_team_to_user(user_id:, team_id:)
+        post("/users/#{user_id}/teams/#{team_id}").success?
+      end
+
+      # Removes a team from a user
+      #
+      # @param [Integer] user_id Id of the user to remove the team from
+      # @param [Integer] team_id Id of the team the user should be removed from
+      #
+      # @return [Boolean] Success
+      # 
+      def remove_team_from_user(user_id:, team_id:)
+        delete("/users/#{user_id}/teams/#{team_id}").success?
+      end
+
+      # Fetches a user settings
+      #
+      # @param [Integer] id Id of the user to retrieve settings
+      #
+      # @return [Hash] The fetched user settings
+      # 
+      def user_settings(id:)
+        get("/users/#{id}/settings").parse['user_settings']
+      end
+
+      # Fetches a user API keys
+      #
+      # @param [Integer] id Id of the user to retrieve API keys
+      #
+      # @return [StrawberryAPI::ApiKey] The fetched user API key
+      # 
+      def user_api_keys(id:)
+        ApiKey.find(user_id: id)
+      end
+      
+    end
+  end
+end

data/lib/strawberry_api/client.rb

@@ -0,0 +1,95 @@
+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/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'
+
+module StrawberryAPI
+  # Class Client provides methods for querying Strawberry API resources
+  #
+  # @author Pierre Lebrun <pierreyves.lebrun@gmail.com>
+  #
+  class Client < StrawberryAPI::HttpClient
+    include StrawberryAPI::Client::ApiKeys
+    include StrawberryAPI::Client::Assets
+    include StrawberryAPI::Client::Collections
+    include StrawberryAPI::Client::CustomMetadata
+    include StrawberryAPI::Client::CustomMetadataFields
+    include StrawberryAPI::Client::CustomMetadataOptions
+    include StrawberryAPI::Client::CustomMetadataSets
+    include StrawberryAPI::Client::Edits
+    include StrawberryAPI::Client::AssetFeedbacks
+    include StrawberryAPI::Client::CopyToFeedbacks
+    include StrawberryAPI::Client::ProjectFeedbacks
+    include StrawberryAPI::Client::Features
+    include StrawberryAPI::Client::Libraries
+    include StrawberryAPI::Client::Markers
+    include StrawberryAPI::Client::Projects
+    include StrawberryAPI::Client::Roles
+    include StrawberryAPI::Client::Schedules
+    include StrawberryAPI::Client::Searches
+    include StrawberryAPI::Client::Sessions
+    include StrawberryAPI::Client::Settings
+    include StrawberryAPI::Client::StatusFlags
+    include StrawberryAPI::Client::ArchiveStrategies
+    include StrawberryAPI::Client::AssetCopyToStrategies
+    include StrawberryAPI::Client::ProjectCopyToStrategies
+    include StrawberryAPI::Client::Teams
+    include StrawberryAPI::Client::Templates
+    include StrawberryAPI::Client::Users
+  end
+end

data/lib/strawberry_api/collection.rb

@@ -0,0 +1,16 @@
+module StrawberryAPI
+  
+  class Collection
+
+    attr_accessor :id
+    attr_accessor :user_id
+    attr_accessor :name
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/configuration.rb

@@ -0,0 +1,19 @@
+module StrawberryAPI
+  class Configuration
+    # Hostname or IP address of Strawberry server
+    attr_accessor :host
+
+    # API access key of Strawberry's user
+    attr_accessor :api_key
+
+    # Username of Strawberry's user
+    attr_accessor :username
+
+    # Password of Strawberry's user
+    attr_accessor :password
+
+    # TODO: Use logger within the API client
+    # Debugging intented logger
+    attr_accessor :logger
+  end
+end

data/lib/strawberry_api/custom_metadata/custom_metadata_field.rb

@@ -0,0 +1,30 @@
+module StrawberryAPI
+  
+  class CustomMetadataField
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :type
+    attr_accessor :maxlen
+    attr_accessor :mandatory
+    attr_accessor :position
+    attr_accessor :custom_metadata_set_id
+    attr_accessor :use_in_project_name
+    attr_accessor :restriction
+    attr_accessor :pattern
+    attr_accessor :select_field_options
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        if k == 'select_field_options'
+          v.map! do |custom_metadata_option|
+            CustomMetadataOption.new(custom_metadata_option)
+          end
+        end
+        
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/custom_metadata/custom_metadata_option.rb

@@ -0,0 +1,18 @@
+module StrawberryAPI
+  
+  class CustomMetadataOption
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :custom_metadata_field_id
+    attr_accessor :custom_metadata_sub_set_id
+    attr_accessor :safe_search
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+  end
+end

data/lib/strawberry_api/custom_metadata/custom_metadata_set.rb

@@ -0,0 +1,25 @@
+module StrawberryAPI
+  
+  class CustomMetadataSet
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :root
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :custom_metadata_fields
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        if k == 'custom_metadata_fields'
+          v.map! do |custom_metadata_field|
+            CustomMetadataField.new(custom_metadata_field)
+          end
+        end
+
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/custom_metadatum.rb

@@ -0,0 +1,30 @@
+module StrawberryAPI
+  
+  class CustomMetadatum
+
+    attr_accessor :project_id
+    attr_accessor :asset_id
+    attr_accessor :custom_metadata_field_id
+    attr_accessor :custom_metadata_field
+    attr_accessor :value
+    attr_accessor :safe_search
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+
+    def self.filthify(custom_metadata:)
+      filthy_hash = Hash.new
+
+      custom_metadata.each_with_index do |(key, val), i|
+        filthy_hash["custom_metadata[#{i}][custom_metadata_field]"] = key
+        filthy_hash["custom_metadata[#{i}][value]"] = val
+      end
+
+      return filthy_hash
+    end
+
+  end
+end

data/lib/strawberry_api/edit.rb

@@ -0,0 +1,19 @@
+module StrawberryAPI
+  
+  class Edit
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :password
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    attr_accessor :comment
+    
+    def initialize(params = {})
+        params.each do |k, v|
+          instance_variable_set("@#{k}", v) unless v.nil?
+        end
+    end
+    
+  end
+end

data/lib/strawberry_api/feature.rb

@@ -0,0 +1,18 @@
+module StrawberryAPI
+    
+  class Feature
+
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :active
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/feedback/asset_feedback.rb

@@ -0,0 +1,15 @@
+module StrawberryAPI
+  
+  class AssetFeedback < StrawberryAPI::Feedback
+
+    attr_accessor :success
+    attr_accessor :failure
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/feedback/copy_to_feedback.rb

@@ -0,0 +1,12 @@
+module StrawberryAPI
+  
+  class CopyToFeedback < StrawberryAPI::Feedback
+
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/feedback/project_feedback.rb

@@ -0,0 +1,15 @@
+module StrawberryAPI
+  
+  class ProjectFeedback < StrawberryAPI::Feedback
+
+    attr_accessor :edit_id
+    attr_accessor :project_id
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end

data/lib/strawberry_api/feedback.rb

@@ -0,0 +1,19 @@
+module StrawberryAPI
+  
+  class Feedback
+
+    attr_accessor :id
+    attr_accessor :action
+    attr_accessor :state
+    attr_accessor :error
+    attr_accessor :created_at
+    attr_accessor :updated_at
+    
+    def initialize(params = {})
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+    end
+    
+  end
+end