coach_client 0.1.1

data/lib/coach_client/user.rb

@@ -0,0 +1,207 @@
+module CoachClient
+  # A user resource of the CyberCoach service.
+  class User < CoachClient::Resource
+    # The size of the requests for the {.list} with all = true
+    LIST_ALL_SIZE = 1000
+
+    # @return [String]
+    attr_reader :username
+
+    # @return [Integer]
+    attr_reader :datecreated
+
+    # @return [Array<CoachClient::Partnership>]
+    attr_reader :partnerships
+
+    # @return [Array<CoachClient::UserSubscription>]
+    attr_reader :subscriptions
+
+    # @return [String]
+    attr_accessor :password, :realname, :email, :newpassword
+
+    # @return [Integer]
+    attr_accessor :publicvisible
+
+    # Returns the relative path to the user resource.
+    #
+    # @return [String] the relative path
+    def self.path
+      'users/'
+    end
+
+    # Returns the total number of users present on the CyberCoach service.
+    #
+    # @param [CoachClient::Client] client
+    # @return [Integer] the total number of users
+    def self.total(client)
+      response = CoachClient::Request.get(client.url + path,
+                                          params: { size: 0 })
+      response.to_h[:available]
+    end
+
+    # Returns a list of users from the CyberCoach service for which the given
+    # block returns a true value.
+    #
+    # If no block is given, the whole list is returned.
+    #
+    # @param [CoachClient::Client] client
+    # @param [Integer] size
+    # @param [Integer] start
+    # @param [Boolean] all
+    # @yieldparam [CoachClient::User] user the user
+    # @yieldreturn [Boolean] whether the user should be added to the list
+    # @return [Array<CoachClient::User>] the list of users
+    def self.list(client, size: 20, start: 0, all: false)
+      userlist  = []
+      if all
+        total = self.total(client)
+        start = 0
+        size = LIST_ALL_SIZE
+      end
+      loop do
+        response = CoachClient::Request.get(client.url + path,
+                                            params: { start: start, size: size })
+        response.to_h[:users].each do |u|
+          user = self.new(client, u[:username])
+          userlist << user if !block_given? || yield(user)
+        end
+        break unless all
+        start += size
+        break if start >= total
+      end
+      userlist
+    end
+
+    # Creates a new user.
+    #
+    # @param [CoachClient::Client] client
+    # @param [String] username
+    # @param [Hash] info additional user informations
+    # @option info [String] :password
+    # @option info [String] :realname
+    # @option info [String] :email
+    # @option info [Integer] :publicvisible
+    # @return [CoachClient::User]
+    def initialize(client, username, info = {})
+      super(client)
+      @username = username
+      @password = info[:password]
+      @realname = info[:realname]
+      @email = info[:email]
+      @publicvisible = info[:publicvisible]
+    end
+
+    # Updates the user with the data from the CyberCoach service.
+    #
+    # @raise [CoachClient::NotFound] if the user does not exist
+    # @return [CoachClient::User] the updated user
+    def update
+      raise CoachClient::NotFound, 'User not found' unless exist?
+      response = if authenticated?
+                   CoachClient::Request.get(url, username: @username,
+                                            password: @password)
+                 else
+                   CoachClient::Request.get(url)
+                 end
+      response = response.to_h
+      @realname = response[:realname]
+      @email = response[:email]
+      @publicvisible = response[:publicvisible]
+      @datecreated = response[:datecreated]
+      @partnerships = []
+      unless response[:partnerships].nil?
+        response[:partnerships].each do |p|
+          users = CoachClient::Partnership.extract_users_from_uri(p[:uri])
+          users.reject! { |username| username == @username }
+          @partnerships << CoachClient::Partnership.new(client, self, users.first)
+        end
+      end
+      @subscriptions = []
+      unless response[:subscriptions].nil?
+        response[:subscriptions].each do |s|
+          sport = s[:uri].match(/\/(\w+)\/\z/).captures.first
+          @subscriptions << CoachClient::UserSubscription.new(client, self, sport)
+        end
+      end
+      self
+    end
+
+    # Saves the user to the CyberCoach service.
+    #
+    # The user is created if it does not exist on the CyberCoach service,
+    # otherwise it tries to overwrite it.
+    #
+    # @raise [CoachClient::Unauthorized] if the user is not authorized
+    # @raise [CoachClient::IncompleteInformation] if not all needed information
+    #   is given
+    # @raise [CoachClient::NotSaved] if the user could not be saved
+    # @return [CoachClient::User] the saved user
+    def save
+      vals = self.to_h
+      vals.delete(:username)
+      vals.delete_if { |_k, v| v.nil? || v.to_s.empty? }
+      vals[:password] = vals.delete(:newpassword) if vals[:newpassword]
+      payload = Gyoku.xml(user: vals)
+      response = if exist?
+                   unless authenticated?
+                     raise CoachClient::Unauthorized.new(self), 'Unauthorized'
+                   end
+                   CoachClient::Request.put(url, username: @username,
+                                            password: @password,
+                                            payload: payload,
+                                            content_type: :xml)
+                 else
+                   begin
+                     CoachClient::Request.put(url, payload: payload,
+                                              content_type: :xml)
+                   rescue RestClient::Conflict
+                     raise CoachClient::IncompleteInformation.new(self),
+                       'Incomplete user information'
+                   end
+                 end
+      unless response.code == 200 || response.code == 201
+        raise CoachClient::NotSaved.new(self), 'Could not save user'
+      end
+      @password = vals[:password]
+      @newpassword = nil
+      self
+    end
+
+    # Deletes the user on the CyberCoach service.
+    #
+    # @raise [CoachClient::NotFound] if the user does not exist
+    # @raise [CoachClient::Unauthorized] if the user is not authorized
+    # @return [true]
+    def delete
+      raise CoachClient::NotFound unless exist?
+      unless authenticated?
+        raise CoachClient::Unauthorized.new(self), 'Unauthorized'
+      end
+      CoachClient::Request.delete(url, username: @username, password: @password)
+      true
+    end
+
+    # Returns whether the user is authenticated.
+    #
+    # @return [Boolean]
+    def authenticated?
+      false if @password.nil?
+      @client.authenticated?(@username, @password)
+    end
+
+    # Returns the URL of the user.
+    #
+    # @return [String] the url of the user
+    def url
+      @client.url + self.class.path + @username
+    end
+
+    # Returns the string representation of the user.
+    #
+    # @return [String]
+    def to_s
+      @username.to_s
+    end
+  end
+end
+

data/lib/coach_client/user_subscription.rb

@@ -0,0 +1,79 @@
+module CoachClient
+  # A user subscription resource of the CyberCoach service.
+  class UserSubscription < CoachClient::Subscription
+    # @return [Integer]
+    attr_reader :id, :datesubscribed
+
+    # @return [CoachClient::User]
+    attr_accessor :user
+
+    # Returns the relative path to the user subscription resource.
+    #
+    # @return [String] the relative path
+    def self.path
+      'users/'
+    end
+
+    # Creates a new user subscription.
+    #
+    # @param [CoachClient::Client] client
+    # @param [String, CoachClient::User] user
+    # @param [String, Symbol, CoachClient::Sport] sport
+    # @param [Integer] publicvisible
+    # @return [CoachClient::UserSubscription]
+    def initialize(client, user, sport, publicvisible: nil)
+      super(client, sport, publicvisible: publicvisible)
+      @user = if user.is_a?(CoachClient::User)
+                user
+              else
+                CoachClient::User.new(client, user)
+              end
+    end
+
+    # Updates the user subscription with the data from the CyberCoach service.
+    #
+    # @raise [CoachClient::NotFound] if the user subscription does not exist
+    # @return [CoachClient::UserSubscription] the updated user subscription
+    def update
+      super(@user)
+    end
+
+    # Saves the user subscription to the CyberCoach service.
+    #
+    # The user subscription is created if it does not exist on the CyberCoach
+    # service, otherwise it tries to overwrite it.
+    #
+    # @raise [CoachClient::Unauthorized] if not authorized
+    # @raise [CoachClient::IncompleteInformation] if not all needed information
+    #   is given
+    # @raise [CoachClient::NotSaved] if the user subscription could not be saved
+    # @return [CoachClient::UserSubscription] the saved user subscription
+    def save
+      super(@user)
+    end
+
+    # Deletes the user subscription on the CyberCoach service.
+    #
+    # @raise [CoachClient::NotFound] if the user subscription does not exist
+    # @raise [CoachClient::Unauthorized] if not authorized
+    # @return [true]
+    def delete
+      super(@user)
+    end
+
+    # Returns the URL of the user subscription.
+    #
+    # @return [String] the url of the user subscription
+    def url
+      "#{@user.url}/#{@sport}"
+    end
+
+    # Returns the string representation of the user subscription.
+    #
+    # @return [String]
+    def to_s
+      "#{@user.username}/#{@sport}"
+    end
+  end
+end
+

data/lib/coach_client/version.rb

@@ -0,0 +1,5 @@
+module CoachClient
+  # The version of the gem
+  VERSION = '0.1.1'
+end
+

data/lib/coach_client.rb

@@ -0,0 +1,21 @@
+require 'gyoku'
+require 'rest-client'
+
+require 'coach_client/client'
+require 'coach_client/exceptions.rb'
+require 'coach_client/resource'
+require 'coach_client/entry'
+require 'coach_client/partnership'
+require 'coach_client/request'
+require 'coach_client/response'
+require 'coach_client/sport'
+require "coach_client/subscription"
+require 'coach_client/partnership_subscription'
+require 'coach_client/user_subscription'
+require 'coach_client/user'
+require 'coach_client/version'
+
+# A wrapper around the CyberCoach service of the University of Fribourg
+module CoachClient
+end
+

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: coach_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael Jungo
+- Amanda Karavolia
+- Andrea Liechti
+- Jocelyn Thode
+- Simon Brulhart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.3
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: 
+email:
+- michael.jungo@unifr.ch
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- coach_client.gemspec
+- lib/coach_client.rb
+- lib/coach_client/client.rb
+- lib/coach_client/entry.rb
+- lib/coach_client/exceptions.rb
+- lib/coach_client/partnership.rb
+- lib/coach_client/partnership_subscription.rb
+- lib/coach_client/request.rb
+- lib/coach_client/resource.rb
+- lib/coach_client/response.rb
+- lib/coach_client/sport.rb
+- lib/coach_client/subscription.rb
+- lib/coach_client/user.rb
+- lib/coach_client/user_subscription.rb
+- lib/coach_client/version.rb
+homepage: https://github.com/jungomi/coach_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A wrapper around the CyberCoach API of unifr
+test_files: []