cybercoach 0.2.0 → 0.3.0

data/lib/cybercoach/subscription.rb

@@ -0,0 +1,145 @@
+module CyberCoach
+  #
+  # A Subscription to a Sport is placed by a User or a Partnership and contains
+  # Entries.
+  #
+  class Subscription < Resource
+    #
+    # It is creatable by PUT.
+    #
+    include PutCreateable
+
+    #
+    # :attr: subscriber
+    # Either a User or a Partnership, which places Entries to it.
+    #
+
+    #
+    # :attr: sport
+    # The Sport.
+    #
+
+    #
+    # :attr: entries
+    # The Entries already placed by the subscriber.
+    #
+
+    #
+    # :attr: privacy_level
+    # The privacy level, see PrivacyLevel constants.
+    #
+
+    #
+    # :attr: date_created
+    # The date it was created.
+    #
+
+    attr_accessor :subscriber, :sport, :entries, :privacy_level, :date_created
+
+    #
+    # :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.
+    # * user|partnership:: A User or Partnership serializable of the subscriber.
+    # * sport:: A Sport serializable.
+    # * entries:: Entry serializables.
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    # * datesubscribed:: The date it was created.
+    #
+    def from_serializable(serializable)
+      super(serializable)
+      @subscriber = nil
+      unless serializable['user'].nil?
+        @subscriber = User.new
+        @subscriber.from_serializable(serializable['user'])
+      end
+      unless serializable['partnership'].nil?
+        @subscriber = Partnership.new
+        @subscriber.from_serializable(serializable['partnership'])
+      end
+      @sport = nil
+      unless serializable['sport'].nil?
+        @sport = Sport.new
+        @sport.from_serializable(serializable['sport'])
+      end
+      @entries = []
+      unless serializable['entries'].nil?
+        @entries = serializable['entries'].map do |entry_serializable|
+          entry = Entry.new
+          entry.from_serializable(entry_serializable)
+          entry
+        end
+      end
+      @privacy_level = serializable['publicvisible']
+      @date_created = nil
+      unless serializable['datesubscribed'].nil?
+        @date_created = Time.at(serializable['datesubscribed']).to_datetime
+      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.
+    # * user|partnership:: A User or Partnership serializable of the subscriber.
+    # * sport:: A Sport serializable.
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    #
+    def to_serializable
+      serializable = super
+      serializable[@subscriber.singular_name] = @subscriber.to_serializable
+      serializable['sport'] = @sport.to_serializable
+      serializable['publicvisible'] = @privacy_level
+      serializable
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'subscription'.
+    #
+    def singular_name
+      'subscription'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'subscriptions'.
+    #
+    def plural_name
+      'subscriptions'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Return the URI of its subscriber and sport.
+    #
+    def resource_base_uri
+      "#{@subscriber.uri}#{@sport.name}/"
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the uri to the base uri if neither the subscriber, nor the sport is
+    # nil.
+    #
+    def invalidate_uri
+      unless @subscriber.nil? || @sport.nil?
+        @uri = resource_base_uri
+      end
+    end
+  end
+end

data/lib/cybercoach/user.rb

@@ -0,0 +1,159 @@
+module CyberCoach
+  #
+  # A User is needed to participate in Partnerships and Subscriptions, to which
+  # Entries are submitted.
+  #
+  class User < Resource
+    #
+    # It is pageable.
+    #
+    include Pageable
+
+    #
+    # It is creatable by PUT.
+    #
+    include PutCreateable
+
+    #
+    # :attr: username
+    # The username.
+    #
+
+    #
+    # :attr: email
+    # The email address.
+    #
+
+    #
+    # :attr: password
+    # The password, which is never received from the server.
+    #
+
+    #
+    # :attr: real_name
+    # The real name.
+    #
+
+    #
+    # :attr: privacy_level
+    # The privacy level, see PrivacyLevel constants.
+    #
+
+    #
+    # :attr: date_created
+    # The date it was created.
+    #
+
+    attr_accessor :username,
+      :email,
+      :password,
+      :real_name,
+      :privacy_level,
+      :date_created
+
+    #
+    # :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.
+    # * username:: The username.
+    # * email:: The email address.
+    # * realname:: The real name.
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    # * datecreated:: The date it was created.
+    #
+    def from_serializable(serializable)
+      super(serializable)
+      @username = serializable['username']
+      @email = serializable['email']
+      # the password is never received from the server, so don't set it
+      @real_name = serializable['realname']
+      @privacy_level = serializable['publicvisible']
+      @date_created = nil
+      unless serializable['datecreated'].nil?
+        @date_created = Time.at(serializable['datecreated']).to_datetime
+      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.
+    # * username:: The username.
+    # * email:: The email address.
+    # * realname:: The real name.
+    # * publicvisible:: The privacy level, see PrivacyLevel constants.
+    # * datecreated:: The date it was created.
+    #
+    def to_serializable
+      serializable = super
+      serializable['username'] = @username
+      serializable['email'] = @email
+      serializable['password'] = @password
+      serializable['realname'] = @real_name
+      serializable['publicvisible'] = @privacy_level
+      serializable
+    end
+
+    #
+    # Returns the authentication options for basic auth, to pass in CRUD methods
+    # of other resources.
+    #
+    def authentication
+      {
+        basic_auth: {
+          username: @username,
+          password: @password
+        }
+      }
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'user'.
+    #
+    def singular_name
+      'user'
+    end
+
+    #
+    # :category: Configuration
+    #
+    # Returns 'users'.
+    #
+    def plural_name
+      'users'
+    end
+
+    protected
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the uri to the base uri and the username, if it is not nil.
+    #
+    def invalidate_uri
+      unless @username.nil?
+        @uri = "#{resource_base_uri}#{@username}/"
+      end
+    end
+
+    #
+    # :category: Invalidation
+    #
+    # Sets the basic auth token to the login, so it can be updated and deleted
+    # without explicitly specifying the token.
+    #
+    def invalidate_options
+      @options = @options.merge(authentication)
+    end
+  end
+end

data/lib/cybercoach/version.rb

@@ -0,0 +1,10 @@
+#
+# Provides a proxy to CyberCoach resources.
+# Enables to make CRUD calls to them.
+#
+module CyberCoach
+  #
+  # The current version of the gem.
+  #
+  VERSION = '0.3.0'
+end

data/lib/cybercoach.rb

@@ -0,0 +1,19 @@
+require 'httparty'
+
+require 'cybercoach/version'
+require 'cybercoach/privacy_level'
+require 'cybercoach/settings'
+require 'cybercoach/format_not_supported_error'
+require 'cybercoach/http_error'
+require 'cybercoach/subclass_responsibility_error'
+require 'cybercoach/abstract_resource'
+require 'cybercoach/resource'
+require 'cybercoach/resource_page'
+require 'cybercoach/pageable'
+require 'cybercoach/post_createable'
+require 'cybercoach/put_createable'
+require 'cybercoach/sport'
+require 'cybercoach/user'
+require 'cybercoach/partnership'
+require 'cybercoach/subscription'
+require 'cybercoach/entry'

data/spec/lib/cybercoach/entry_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe 'Entry' do
+  before(:context) do
+    @proposer = UserHelper.make(6)
+    @proposed = UserHelper.make(7)
+    ResourceHelper.safe_delete(@proposer)
+    ResourceHelper.safe_delete(@proposed)
+    @proposer.create
+    @proposed.create
+    @partnership = CyberCoach::Partnership.new
+    @partnership.proposer = @proposer
+    @partnership.proposed = @proposed
+    @partnership.privacy_level = CyberCoach::PrivacyLevel::REGISTERED_USER
+    ResourceHelper.safe_delete(@partnership, UserHelper.options(@proposer))
+    ResourceHelper.safe_delete(@partnership, UserHelper.options(@proposed))
+    @partnership.create(UserHelper.options(@proposer))
+    @partnership.update(UserHelper.options(@proposed))
+    @sport = CyberCoach::Sport.new
+    @sport.name = 'Running'
+    @sport.read
+    @subscription = CyberCoach::Subscription.new
+    @subscription.subscriber = @partnership
+    @subscription.sport = @sport
+    @subscription.privacy_level = CyberCoach::PrivacyLevel::REGISTERED_USER
+    @subscription.create(UserHelper.options(@proposer))
+  end
+
+  after(:context) do
+    ResourceHelper.safe_delete(@subscription, UserHelper.options(@proposer))
+    ResourceHelper.safe_delete(@partnership, UserHelper.options(@proposer))
+    ResourceHelper.safe_delete(@partnership, UserHelper.options(@proposed))
+    ResourceHelper.safe_delete(@proposer)
+    ResourceHelper.safe_delete(@proposed)
+  end
+
+  before(:example) do
+    @entry = CyberCoach::Entry.new
+    @entry.subscription = @subscription
+    @entry.comment = 'I like pants'
+    @entry.location = 'In your pants'
+    @entry.duration = 1
+    @entry.privacy_level = CyberCoach::PrivacyLevel::REGISTERED_USER
+  end
+
+  it 'should raise an error if it does not exist' do
+    @entry.id = 1
+    expect { @entry.read(UserHelper.options(@proposer)) }.to raise_error(CyberCoach::HttpError)
+  end
+
+  describe 'crud' do
+    before(:example) do
+      ResourceHelper.safe_delete(@entry, UserHelper.options(@proposer))
+    end
+
+    after(:example) do
+      ResourceHelper.safe_delete(@entry, UserHelper.options(@proposer))
+    end
+
+    it 'should create itself' do
+      @entry.create(UserHelper.options(@proposer))
+      expect(@entry.id).not_to be_nil
+    end
+
+    it 'should read itself' do
+      @entry.create(UserHelper.options(@proposer))
+      @entry.read(UserHelper.options(@proposer))
+      expect(@entry.id).not_to be_nil
+      expect(@entry.uri).not_to be_nil
+      expect(@entry.subscription.uri).to eq(@subscription.uri)
+      expect(@entry.comment).not_to be_nil
+      expect(@entry.location).not_to be_nil
+      expect(@entry.duration).not_to be_nil
+      expect(@entry.privacy_level).not_to be_nil
+      expect(@entry.date_created).not_to be_nil
+      expect(@entry.date_modified).not_to be_nil
+    end
+
+    it 'should update itself' do
+      @entry.create(UserHelper.options(@proposer))
+      old_privacy_level = @entry.privacy_level
+      new_privacy_level = CyberCoach::PrivacyLevel::EVERYBODY
+      @entry.privacy_level = new_privacy_level
+      @entry.update(UserHelper.options(@proposer))
+      expect(@entry.privacy_level).not_to eq(old_privacy_level)
+      expect(@entry.privacy_level).to eq(new_privacy_level)
+    end
+
+    it 'should delete itself' do
+      @entry.create(UserHelper.options(@proposer))
+      @entry.delete(UserHelper.options(@proposer))
+      expect { @entry.read(UserHelper.options(@proposer)) }.to raise_error(CyberCoach::HttpError)
+    end
+  end
+end

data/spec/lib/cybercoach/partnership_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'Partnership' do
+  before(:context) do
+    @proposer = UserHelper.make(6)
+    @proposed = UserHelper.make(7)
+    ResourceHelper.safe_delete(@proposer)
+    ResourceHelper.safe_delete(@proposed)
+    @proposer.create
+    @proposed.create
+  end
+
+  after(:context) do
+    ResourceHelper.safe_delete(@proposer)
+    ResourceHelper.safe_delete(@proposed)
+  end
+
+  before(:example) do
+    @partnership = CyberCoach::Partnership.new
+    @partnership.proposer = @proposer
+    @partnership.proposed = @proposed
+    @partnership.privacy_level = CyberCoach::PrivacyLevel::REGISTERED_USER
+  end
+
+  it 'should raise an error if it does not exist' do
+    expect { @partnership.read(UserHelper.options(@proposer)) }.to raise_error(CyberCoach::HttpError)
+  end
+
+  it 'should read all' do
+    partnerships = CyberCoach::Partnership.read_all
+    expect(partnerships.resources).not_to be_empty
+    expect(partnerships.next).not_to be_nil
+    expect { partnerships.previous }.to raise_error(CyberCoach::ResourcePage::NoPreviousPageError)
+  end
+
+  describe 'crud' do
+    before(:example) do
+      ResourceHelper.safe_delete(@partnership, UserHelper.options(@proposer))
+    end
+
+    after(:example) do
+      ResourceHelper.safe_delete(@partnership, UserHelper.options(@proposer))
+    end
+
+    it 'should create itself' do
+      @partnership.create(UserHelper.options(@proposer))
+      expect(@partnership.id).not_to be_nil
+    end
+
+    it 'should read itself' do
+      @partnership.create(UserHelper.options(@proposer))
+      @partnership.read(UserHelper.options(@proposer))
+      expect(@partnership.id).not_to be_nil
+      expect(@partnership.uri).not_to be_nil
+      expect(@partnership.proposer.uri).to eq(@proposer.uri)
+      expect(@partnership.proposed.uri).to eq(@proposed.uri)
+      expect(@partnership.confirmed_by_proposer).to be_truthy
+      expect(@partnership.confirmed_by_proposed).to be_falsy
+      expect(@partnership.privacy_level).not_to be_nil
+      expect(@partnership.subscriptions).to be_empty
+    end
+
+    it 'should update itself' do
+      @partnership.create(UserHelper.options(@proposer))
+      old_privacy_level = @partnership.privacy_level
+      new_privacy_level = CyberCoach::PrivacyLevel::EVERYBODY
+      @partnership.privacy_level = new_privacy_level
+      @partnership.update(UserHelper.options(@proposer))
+      expect(@partnership.privacy_level).not_to eq(old_privacy_level)
+      expect(@partnership.privacy_level).to eq(new_privacy_level)
+    end
+
+    it 'should delete itself' do
+      @partnership.create(UserHelper.options(@proposer))
+      @partnership.delete(UserHelper.options(@proposer))
+      expect { @partnership.read(UserHelper.options(@proposer)) }.to raise_error(CyberCoach::HttpError)
+    end
+  end
+end

data/spec/lib/cybercoach/privacy_level_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'PrivacyLevel' do
+  it 'should have an OWNER level' do
+    expect(CyberCoach::PrivacyLevel::OWNER).to eq(0)
+  end
+
+  it 'should have an REGISTERED_USER level' do
+    expect(CyberCoach::PrivacyLevel::REGISTERED_USER).to eq(1)
+  end
+
+  it 'should have an EVERYBODY level' do
+    expect(CyberCoach::PrivacyLevel::EVERYBODY).to eq(2)
+  end
+end

data/spec/lib/cybercoach/resource_helper.rb

@@ -0,0 +1,11 @@
+require 'cybercoach'
+
+class ResourceHelper
+  def self.safe_delete(resource, options={})
+    begin
+      resource.delete(options)
+    rescue => error
+      $stderr.puts error
+    end
+  end
+end

data/spec/lib/cybercoach/resource_page_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'ResourcePage' do
+  before(:example) do
+    @page = CyberCoach::User.read_all
+  end
+
+  it 'should have meta data' do
+    expect(@page.resources.size).to eq(5)
+    expect(@page.start).to eq(0)
+    expect(@page.end).to eq(5)
+    expect(@page.available).to be > 5
+    expect(@page.type).to eq(CyberCoach::User)
+  end
+
+  it 'should have resources of its type' do
+    type = @page.type
+    @page.resources.each do |item|
+      expect(item).to be_a_kind_of(type)
+    end
+  end
+
+  it 'should read itself' do
+    @page.start = 1
+    @page.size = 2
+    @page.read
+    expect(@page.resources.size).to eq(2)
+    expect(@page.start).to eq(1)
+    expect(@page.end).to eq(3)
+  end
+
+  it 'should be able to navigate between pages' do
+    expect{@page.previous}.to raise_error(CyberCoach::ResourcePage::NoPreviousPageError)
+    next_page = @page.next
+    expect(next_page.resources).not_to be_empty
+    expect(next_page.start).to eq(@page.end)
+    expect(next_page.end).to eq(next_page.start + 5)
+    expect(next_page.available).to eq(@page.available)
+    expect(next_page.type).to eq(@page.type)
+    expect(next_page.resources[0].uri).not_to eq(@page.resources[0].uri)
+    next_previous_page = next_page.previous
+    expect(next_previous_page.resources[0].uri).to eq(@page.resources[0].uri)
+  end
+end

data/spec/lib/cybercoach/settings_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe 'Settings' do
+  it 'should have a base URI' do
+    expect(CyberCoach::Settings::BASE_URI).not_to be_nil
+  end
+  it 'should have a server URI' do
+    expect(CyberCoach::Settings::SERVER_URI).not_to be_nil
+  end
+end

data/spec/lib/cybercoach/sport_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'Sport' do
+  before(:example) do
+    @sport = CyberCoach::Sport.new
+  end
+
+  it 'should read itself' do
+    @sport.name = 'Running'
+    @sport.read
+    expect(@sport.id).not_to be_nil
+    expect(@sport.uri).not_to be_nil
+    expect(@sport.name).not_to be_nil
+    expect(@sport.description).not_to be_nil
+    expect(@sport.subscriptions).not_to be_empty
+  end
+
+  it 'should raise an error if it does not exist' do
+    @sport.name = 'Pants'
+    expect{@sport.read}.to raise_error(CyberCoach::HttpError)
+  end
+
+  it 'should read all' do
+    sports = CyberCoach::Sport.read_all
+    expect(sports.resources.size).to eq(4)
+    expect{sports.next}.to raise_error(CyberCoach::ResourcePage::NoNextPageError)
+    expect{sports.previous}.to raise_error(CyberCoach::ResourcePage::NoPreviousPageError)
+  end
+end