cybercoach 0.2.0 → 0.3.0

data/lib/cybercoach/partnership.rb

@@ -0,0 +1,151 @@
+module CyberCoach
+  #
+  # A Partnership consists of two Users, which participate in different Sport
+  # with Subscriptions, to which Entries are submitted.
+  #
+  class Partnership < Resource
+    #
+    # It is pageable.
+    #
+    include Pageable
+
+    #
+    # It is creatable by PUT.
+    #
+    include PutCreateable
+
+    #
+    # :attr: proposer
+    # The User who proposed it.
+    #
+
+    #
+    # :attr: proposed
+    # The User it is proposed to.
+    #
+
+    #
+    # :attr: subscriptions
+    # The Subscriptions.
+    #
+
+    #
+    # :attr: confirmed_by_proposer
+    # True if the proposing User has confirmed it, false otherwise.
+    #
+
+    #
+    # :attr: confirmed_by_proposed
+    # True if the proposed User has confirmed it, false otherwise.
+    #
+
+    #
+    # :attr: privacy_level
+    # The privacy level, see PrivacyLevel constants.
+    #
+
+    attr_accessor :proposer,
+                  :proposed,
+                  :subscriptions,
+                  :confirmed_by_proposer,
+                  :confirmed_by_proposed,
+                  :privacy_level
+
+    #
+    # :category: Serialization
+    #
+    # Creates itself from a serializable representation, which only contains
+    # simple data types.
+    # serializable:: A hash with the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    # * user1:: A User serializable of the proposer.
+    # * user2:: A User serializable of the proposed.
+    # * subscriptions:: Subscription serializables.
+    # * userconfirmed1:: True if the proposing User has confirmed it, false otherwise.
+    # * userconfirmed2:: True if the proposed User has confirmed it, false otherwise.
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    #
+    def from_serializable(serializable)
+      super(serializable)
+      @proposer = nil
+      unless serializable['user1'].nil?
+        @proposer = User.new
+        @proposer.from_serializable(serializable['user1'])
+      end
+      @proposed = nil
+      unless serializable['user2'].nil?
+        @proposed = User.new
+        @proposed.from_serializable(serializable['user2'])
+      end
+      @subscriptions = []
+      unless serializable['subscriptions'].nil?
+        @subscriptions = serializable['subscriptions'].map do
+        |subscription_serializable|
+          subscription = Subscription.new
+          subscription.from_serializable(subscription_serializable)
+          subscription
+        end
+      end
+      @confirmed_by_proposer = serializable['userconfirmed1']
+      @confirmed_by_proposed = serializable['userconfirmed2']
+      @privacy_level = serializable['publicvisible']
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Returns a serializable representation, which only contains simple data
+    # types.
+    # The hash has the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    # * user1:: A User serializable of the proposer.
+    # * user2:: A User serializable of the proposed.
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    #
+    def to_serializable
+      serializable = super
+      unless @proposer.nil?
+        serializable['user1'] = @proposer.to_serializable
+      end
+      unless @proposed.nil?
+        serializable['user2'] = @proposed.to_serializable
+      end
+      serializable['publicvisible'] = @privacy_level
+      serializable
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'partnership'.
+    #
+    def singular_name
+      'partnership'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'partnerships'.
+    #
+    def plural_name
+      'partnerships'
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the uri to the base uri and the proposer's and proposed's username if
+    # neither of them is nil.
+    #
+    def invalidate_uri
+      unless @proposer.nil? || @proposed.nil?
+        @uri = "#{resource_base_uri}#{@proposer.username};#{@proposed.username}/"
+      end
+    end
+  end
+end

data/lib/cybercoach/post_createable.rb

@@ -0,0 +1,49 @@
+module CyberCoach
+  #
+  # Mixin for a resource that gets its URI assigned from the server.
+  # Include it in a class to use it.
+  #
+  module PostCreateable
+    #
+    # Installs class and instance methods in the class it is included in.
+    #
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    #
+    # The class methods to install.
+    #
+    module ClassMethods
+    end
+
+    #
+    # The instance methods to install.
+    #
+    module InstanceMethods
+      #
+      # :category: CRUD
+      #
+      # Creates it.
+      # Gets the URI from the response and reads itself again.
+      # Raises HttpError if the request is unsuccessful.
+      # options:: A hash of options to send with the request.
+      #
+      def create(options = {})
+        invalidate_uri
+        invalidate_options
+        options = @options.merge(options).merge(
+          body: serialize
+        )
+        response = self.class.post(resource_base_uri, options)
+        if response.success?
+          @uri = response.headers['location']
+          read(options)
+        else
+          raise HttpError.new(response.response)
+        end
+      end
+    end
+  end
+end

data/lib/cybercoach/privacy_level.rb

@@ -0,0 +1,21 @@
+module CyberCoach
+  #
+  # The CyberCoach privacy levels.
+  #
+  module PrivacyLevel
+    #
+    # Only the owner of the resource can access its properties.
+    #
+    OWNER = 0
+
+    #
+    # Only registered users can access the resource's properties.
+    #
+    REGISTERED_USER = 1
+
+    #
+    # Everybody can access the resource's properties.
+    #
+    EVERYBODY = 2
+  end
+end

data/lib/cybercoach/put_createable.rb

@@ -0,0 +1,48 @@
+module CyberCoach
+  #
+  # Mixin for a resource that gets its URI assigned from the client.
+  # Include it in a class to use it.
+  #
+  module PutCreateable
+    #
+    # Installs class and instance methods in the class it is included in.
+    #
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    #
+    # The class methods to install.
+    #
+    module ClassMethods
+    end
+
+    #
+    # The instance methods to install.
+    #
+    module InstanceMethods
+      #
+      # :category: CRUD
+      #
+      # Creates it.
+      # Reads itself from the response.
+      # Raises HttpError if the request is unsuccessful.
+      # options:: A hash of options to send with the request.
+      #
+      def create(options = {})
+        invalidate_uri
+        invalidate_options
+        options = @options.merge(options).merge(
+          body: serialize
+        )
+        response = self.class.put(@uri, options)
+        if response.success?
+          deserialize(response)
+        else
+          raise HttpError.new(response.response)
+        end
+      end
+    end
+  end
+end

data/lib/cybercoach/resource.rb

@@ -0,0 +1,94 @@
+module CyberCoach
+  #
+  # A Resource can be created, read, updated and deleted.
+  #
+  class Resource < AbstractResource
+    #
+    # The identifier.
+    #
+    attr_accessor :id
+
+    #
+    # :category: CRUD
+    #
+    # Creates it.
+    # Must be overridden in a subclass.
+    # May use PutCreateable or PostCreateable.
+    # options:: A hash of options to send with the request.
+    #
+    def create(_options = {})
+      raise SubclassResponsibilityError.new
+    end
+
+    #
+    # :category: CRUD
+    #
+    # Updates it.
+    # Reads itself from the response.
+    # Raises HttpError if the request is unsuccessful.
+    # options:: A hash of options to send with the request.
+    #
+    def update(options = {})
+      invalidate_uri
+      invalidate_options
+      options = @options.merge(options).merge(
+        body: serialize
+      )
+      response = self.class.put(@uri, options)
+      if response.success?
+        deserialize(response)
+      else
+        raise HttpError.new(response.response)
+      end
+    end
+
+    #
+    # :category: CRUD
+    #
+    # Deletes it.
+    # Reads itself from the response.
+    # Raises HttpError if the request is unsuccessful.
+    # options:: A hash of options to send with the request.
+    #
+    def delete(options = {})
+      invalidate_uri
+      invalidate_options
+      options = @options.merge(options)
+      response = self.class.delete(@uri, options)
+      if response.success?
+        deserialize(response)
+      else
+        raise HttpError.new(response.response)
+      end
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Creates itself from a serializable representation, which only contains
+    # simple data types.
+    # serializable:: A hash with the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    #
+    def from_serializable(serializable)
+      super(serializable)
+      @id = serializable['id']
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Returns a serializable representation, which only contains simple data
+    # types.
+    # The hash has the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    #
+    def to_serializable
+      serializable = super
+      serializable['id'] = @id
+      serializable
+    end
+  end
+end

data/lib/cybercoach/resource_page.rb

@@ -0,0 +1,191 @@
+module CyberCoach
+  #
+  # A ResourcePage can be used to navigate through many resources of a type.
+  #
+  class ResourcePage < AbstractResource
+    #
+    # Raised when trying to get the next page from the last page.
+    #
+    class NoNextPageError < StandardError
+    end
+
+    #
+    # Raised when trying to get the previous page from the first page.
+    #
+    class NoPreviousPageError < StandardError
+    end
+
+    #
+    # :attr: start
+    # The start index.
+    #
+
+    #
+    # :attr: end
+    # The end index.
+    #
+
+    #
+    # :attr: size
+    # The size.
+    #
+
+    #
+    # :attr: available
+    # The resources available.
+    #
+
+    #
+    # :attr: type
+    # The class of the resource to page.
+    #
+
+    #
+    # :attr: resources
+    # The resources.
+    #
+
+    attr_accessor :start, :end, :size, :available, :type, :resources
+
+    #
+    # Create a ResourcePage of the specified type.
+    # type:: The class of resource to page.
+    #
+    def initialize(type)
+      super()
+      @type = type
+    end
+
+    #
+    # :category: CRUD
+    #
+    # Returns the next page.
+    # Raises NoNextPageError if the is none.
+    # options:: A hash of options to send with the request.
+    #
+    def next(options = {})
+      if @next.nil?
+        raise NoNextPageError.new
+      end
+      invalidate_options
+      options = @options.merge(options)
+      response = self.class.get(@next['href'], options)
+      if response.success?
+        page = self.class.new(@type)
+        page.deserialize(response)
+        page
+      else
+        raise HttpError.new(response.response)
+      end
+    end
+
+    #
+    # :category: CRUD
+    #
+    # Returns the previous page.
+    # Raises NoPreviousPageError if the is none.
+    # options:: A hash of options to send with the request.
+    #
+    def previous(options = {})
+      if @previous.nil?
+        raise NoPreviousPageError.new
+      end
+      invalidate_options
+      options = @options.merge(options)
+      response = self.class.get(@previous['href'], options)
+      if response.success?
+        page = self.class.new(@type)
+        page.deserialize(response)
+        page
+      else
+        raise HttpError.new(response.response)
+      end
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Creates itself from a serializable representation, which only contains
+    # simple data types.
+    # serializable:: A hash with the keys:
+    # * uri:: The URI.
+    # * start:: The start index.
+    # * end:: The end index.
+    # * size:: The size.
+    # * available:: The resources available.
+    # * links:: Links as hashes with the keys:
+    #   * description:: May be 'next' or 'previous'.
+    #   * href:: The URI of the referenced page.
+    # * @plural_name:: Items mapped to the plural name of the @type.
+    #
+    def from_serializable(serializable)
+      super(serializable)
+      @start = serializable['start']
+      @end = serializable['end']
+      @size = serializable['size']
+      @available = serializable['available']
+      if serializable['links'].nil?
+        @next = nil
+        @previous = nil
+      else
+        @next = serializable['links'].find { |link| link['description'] == 'next' }
+        @previous = serializable['links'].find { |link| link['description'] == 'previous' }
+      end
+      @resources = serializable[plural_name].map do |resource_serializable|
+        resource = @type.new
+        resource.from_serializable(resource_serializable)
+        resource
+      end
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Return the singular name of the type.
+    #
+    def singular_name
+      @type.new.singular_name
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Return the plural name of the type.
+    #
+    def plural_name
+      @type.new.plural_name
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Return the resource's base URI of the type.
+    #
+    def resource_base_uri
+      @type.new.resource_base_uri
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the start and size attributes as query parameters.
+    #
+    def invalidate_options
+      @options[:query] = {
+        start: @start,
+        size: @size
+      }
+    end
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the URI to the types' base URI.
+    #
+    def invalidate_uri
+      @uri = resource_base_uri
+    end
+  end
+end

data/lib/cybercoach/settings.rb

@@ -0,0 +1,16 @@
+module CyberCoach
+  #
+  # Settings to access CyberCoach.
+  #
+  class Settings
+    #
+    # The URI to the server.
+    #
+    SERVER_URI = 'diufvm31.unifr.ch:8090'
+
+    #
+    # The URI to the resources, relative to the server URI.
+    #
+    BASE_URI = '/CyberCoachServer/resources'
+  end
+end

data/lib/cybercoach/sport.rb

@@ -0,0 +1,104 @@
+module CyberCoach
+  #
+  # A Sport has Subscriptions to which Entries are submitted.
+  #
+  class Sport < Resource
+    #
+    # It is pageable.
+    #
+    include Pageable
+
+    #
+    # :attr: name
+    # The name.
+    #
+
+    #
+    # :attr: description
+    # The description.
+    #
+
+    #
+    # :attr: subscriptions
+    # The Subscriptions to it.
+    #
+
+    attr_accessor :name, :description, :subscriptions
+
+    #
+    # :category: Serialization
+    #
+    # Creates itself from a serializable representation, which only contains
+    # simple data types.
+    # serializable:: A hash with the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    # * name:: The name.
+    # * description:: The description.
+    # * subscriptions:: Subscription serializables.
+    #
+    def from_serializable(serializable)
+      super(serializable)
+      @name = serializable['name']
+      @description = serializable['description']
+      @subscriptions = []
+      unless serializable['subscriptions'].nil?
+        @subscriptions = serializable['subscriptions'].map do
+        |subscription_serializable|
+          subscription = Subscription.new
+          subscription.from_serializable(subscription_serializable)
+          subscription
+        end
+      end
+    end
+
+    #
+    # :category: Serialization
+    #
+    # Returns a serializable representation, which only contains simple data
+    # types.
+    # The hash has the keys:
+    # * uri:: The URI.
+    # * id:: The identifier.
+    # * name:: The name.
+    # * description:: The description.
+    #
+    def to_serializable
+      serializable = super
+      serializable['name'] = @name
+      serializable['description'] = @description
+      serializable
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'sport'.
+    #
+    def singular_name
+      'sport'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'sports'.
+    #
+    def plural_name
+      'sports'
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the uri to the base uri and the name.
+    #
+    def invalidate_uri
+      unless @name.nil?
+        @uri = "#{resource_base_uri}#{@name}/"
+      end
+    end
+  end
+end

data/lib/cybercoach/subclass_responsibility_error.rb

@@ -0,0 +1,7 @@
+module CyberCoach
+  #
+  # Raised when a method is abstract and should be implemented in a subclass.
+  #
+  class SubclassResponsibilityError < RuntimeError
+  end
+end