coach_client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2805cca046500eb765764e207fc3a7e843346d1c
-  data.tar.gz: cdb44876983b95577e726c7edea17551caca7a9f
+  metadata.gz: f56caba59cad3e4f6b474404f424f6aceb7bf122
+  data.tar.gz: a5f0daf07795f2dba5e4d1ed971c255aee38bcfb
 SHA512:
-  metadata.gz: 259446f6fdfc66499a6bc45634a6c8db5d40f1f2c264f6ea3153e7e1c95261b90194fa28472a470aff18c91c2790245e9534384a3e45db48595fa6a546acf21c
-  data.tar.gz: 0efc7375b3d25d7589276123d0756d683af2cc31ffce6774f6a5efb5e4ea61231a3135e8772757bd7bac69e49f30dd5bf95fcb664a933d5bbf34afb0f5618d60
+  metadata.gz: 4ce465fa9b72cf70969cfe6d32d5b59f5aba3fce72c2ac59e5d83793ad35d6b38b2524dc765fd06b6c8fd401a022188cb0c5ecc236223afafe4b53951058edea
+  data.tar.gz: e60dcef34395f31f26221a4a6bd407596751c2da537e3b1839b293a61d7081e9f42b115652617d1c573d7c4a0131cf3525550d2470c58da3c10f6e25a74f91d4

data/.codeclimate.yml

@@ -3,11 +3,11 @@ engines:
   fixme:
     enabled: true
     exclude_fingerprints:
-      - cdc1cac1f5cb7afe72dca9f9bca8a237
-      - c42b72af850c2590419dfa0bb4d15004
-      - ee0a31701f95b21db4aff40647a56a3d
-      - b86af833d6b2b1fa18da63471e2278d9
-      - 8084d978e026eb97e18591af98ff5572
+    - cdc1cac1f5cb7afe72dca9f9bca8a237
+    - c42b72af850c2590419dfa0bb4d15004
+    - ee0a31701f95b21db4aff40647a56a3d
+    - b86af833d6b2b1fa18da63471e2278d9
+    - 8084d978e026eb97e18591af98ff5572
   rubocop:
     enabled: true
 ratings:

data/.rubocop.yml

@@ -70,7 +70,7 @@ Style/Attr:
 Style/BeginBlock:
   Description: 'Avoid the use of BEGIN blocks.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks'
-  Enabled: false
+  Enabled: true
 
 Style/BarePercentLiterals:
   Description: 'Checks if usage of %() or %Q() matches configuration.'
@@ -111,7 +111,7 @@ Style/CaseIndentation:
 Style/CharacterLiteral:
   Description: 'Checks for uses of character literals.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
-  Enabled: false
+  Enabled: true
 
 Style/ClassAndModuleCamelCase:
   Description: 'Use CamelCase for classes and modules.'
@@ -120,7 +120,7 @@ Style/ClassAndModuleCamelCase:
 
 Style/ClassAndModuleChildren:
   Description: 'Checks style of children classes and modules.'
-  Enabled: false
+  Enabled: true
 
 Style/ClassCheck:
   Description: 'Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.'
@@ -213,23 +213,23 @@ Style/EmptyLines:
 
 Style/EmptyLinesAroundAccessModifier:
   Description: "Keep blank lines around access modifiers."
-  Enabled: false
+  Enabled: true
 
 Style/EmptyLinesAroundBlockBody:
   Description: "Keeps track of empty lines around block bodies."
-  Enabled: false
+  Enabled: true
 
 Style/EmptyLinesAroundClassBody:
   Description: "Keeps track of empty lines around class bodies."
-  Enabled: false
+  Enabled: true
 
 Style/EmptyLinesAroundModuleBody:
   Description: "Keeps track of empty lines around module bodies."
-  Enabled: false
+  Enabled: true
 
 Style/EmptyLinesAroundMethodBody:
   Description: "Keeps track of empty lines around method bodies."
-  Enabled: false
+  Enabled: true
 
 Style/EmptyLiteral:
   Description: 'Prefer literals to Array.new/Hash.new/String.new.'
@@ -282,7 +282,7 @@ Style/For:
 Style/FormatString:
   Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf'
-  Enabled: false
+  Enabled: true
 
 Style/GlobalVars:
   Description: 'Do not introduce global variables.'
@@ -341,12 +341,12 @@ Style/InfiniteLoop:
 Style/Lambda:
   Description: 'Use the new lambda literal syntax for single-line blocks.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#lambda-multi-line'
-  Enabled: false
+  Enabled: true
 
 Style/LambdaCall:
   Description: 'Use lambda.call(...) instead of lambda.(...).'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc-call'
-  Enabled: false
+  Enabled: true
 
 Style/LeadingCommentSpace:
   Description: 'Comments should start with a space.'
@@ -388,7 +388,7 @@ Style/MultilineBlockChain:
 
 Style/MultilineBlockLayout:
   Description: 'Ensures newlines after multiline block do statements.'
-  Enabled: false
+  Enabled: true
 
 Style/MultilineIfThen:
   Description: 'Do not use then for multi-line if/unless.'
@@ -457,7 +457,7 @@ Style/OneLineConditional:
                  Favor the ternary operator(?:) over
                  if/then/else/end constructs.
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
-  Enabled: false
+  Enabled: true
 
 Style/OpMethod:
   Description: 'When defining binary operators, name the argument other.'
@@ -479,7 +479,7 @@ Style/ParallelAssignment:
                   This also provides performance benefits
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parallel-assignment'
   Reference: 'https://github.com/JuanitoFatas/fast-ruby#parallel-assignment-vs-sequential-assignment-code'
-  Enabled: false
+  Enabled: true
 
 Style/ParenthesesAroundCondition:
   Description: >-
@@ -491,7 +491,7 @@ Style/ParenthesesAroundCondition:
 Style/PercentLiteralDelimiters:
   Description: 'Use `%`-literal delimiters consistently'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-literal-braces'
-  Enabled: false
+  Enabled: true
 
 Style/PercentQLiterals:
   Description: 'Checks if uses of %Q/%q match the configured preference.'
@@ -515,7 +515,7 @@ Style/Proc:
 Style/RaiseArgs:
   Description: 'Checks the arguments passed to raise/fail.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#exception-class-messages'
-  Enabled: false
+  Enabled: true
 
 Style/RedundantBegin:
   Description: "Don't use begin blocks when they are not needed."
@@ -549,7 +549,7 @@ Style/RescueEnsureAlignment:
 Style/RescueModifier:
   Description: 'Avoid using rescue in its modifier form.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-rescue-modifiers'
-  Enabled: false
+  Enabled: true
 
 Style/SelfAssignment:
   Description: >-
@@ -613,13 +613,13 @@ Style/SpaceAfterNot:
 Style/SpaceAfterSemicolon:
   Description: 'Use spaces after semicolons.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#spaces-operators'
-  Enabled: false
+  Enabled: true
 
 Style/SpaceBeforeBlockBraces:
   Description: >-
                  Checks that the left block brace has or doesn't have space
                  before it.
-  Enabled: false
+  Enabled: true
 
 Style/SpaceBeforeComma:
   Description: 'No spaces before commas.'
@@ -640,7 +640,7 @@ Style/SpaceInsideBlockBraces:
                  Checks that block braces have or don't have surrounding space.
                  For blocks taking parameters, checks that the left brace has
                  or doesn't have trailing space.
-  Enabled: false
+  Enabled: true
 
 Style/SpaceAroundBlockParameters:
   Description: 'Checks the spacing inside and after block parameters pipes.'
@@ -661,7 +661,7 @@ Style/SpaceAroundOperators:
 
 Style/SpaceBeforeModifierKeyword:
   Description: 'Put a space before the modifier keyword.'
-  Enabled: false
+  Enabled: true
 
 Style/SpaceInsideBrackets:
   Description: 'No spaces after [ or before ].'
@@ -711,11 +711,11 @@ Style/StructInheritance:
 
 Style/SymbolLiteral:
   Description: 'Use plain symbols instead of string symbols when possible.'
-  Enabled: false
+  Enabled: true
 
 Style/SymbolProc:
   Description: 'Use symbols as procs instead of blocks when possible.'
-  Enabled: false
+  Enabled: true
 
 Style/Tab:
   Description: 'No hard tabs.'
@@ -725,7 +725,7 @@ Style/Tab:
 Style/TrailingBlankLines:
   Description: 'Checks trailing blank lines and final newline.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#newline-eof'
-  Enabled: false
+  Enabled: true
 
 Style/TrailingComma:
   Description: 'Checks for trailing comma in parameter lists and literals.'
@@ -751,12 +751,12 @@ Style/UnlessElse:
 
 Style/UnneededCapitalW:
   Description: 'Checks for %W when interpolation is not needed.'
-  Enabled: false
+  Enabled: true
 
 Style/UnneededPercentQ:
   Description: 'Checks for %q/%Q when single quotes or double quotes would do.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-q'
-  Enabled: false
+  Enabled: true
 
 Style/TrailingUnderscoreVariable:
   Description: >-
@@ -796,7 +796,7 @@ Style/WhileUntilModifier:
 Style/WordArray:
   Description: 'Use %w or %W for arrays of words.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
-  Enabled: false
+  Enabled: true
 
 ##########################################################
 Metrics/AbcSize:

data/coach_client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Michael Jungo", "Amanda Karavolia", "Andrea Liechti", "Jocelyn Thode", "Simon Brulhart"]
   spec.email         = ["michael.jungo@unifr.ch"]
 
-  spec.summary       = %q{A wrapper around the CyberCoach API of the University of Fribourg}
+  spec.summary       = "A wrapper around the CyberCoach API of the University of Fribourg"
   spec.homepage      = "https://github.com/jungomi/coach_client"
   spec.license       = "MIT"
 

data/lib/coach_client.rb

@@ -18,4 +18,3 @@ require 'coach_client/version'
 # A wrapper around the CyberCoach service of the University of Fribourg
 module CoachClient
 end
-

data/lib/coach_client/client.rb

@@ -6,13 +6,20 @@ module CoachClient
     # @return [String]
     attr_reader :url
 
+    # The maximum size of the requests
+    #
+    # @return [Integer]
+    attr_accessor :max_size
+
     # Creates a new client with the CyberCoach informations.
     #
     # @param [String] host the host address
     # @param [String] path the path to the resources
+    # @param [Integer] max_size the maximum size of requests
     # @return [CoachClient::Client]
-    def initialize(host, path = '/')
+    def initialize(host, path = '/', max_size = 1000)
       @url = host + path
+      @max_size = max_size
     end
 
     # Returns whether the given credentials are valid.
@@ -81,4 +88,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/entry.rb

@@ -226,4 +226,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/exceptions.rb

@@ -75,4 +75,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/partnership.rb

@@ -1,9 +1,6 @@
 module CoachClient
   # A partnership resource of the CyberCoach service.
   class Partnership < CoachClient::Resource
-    # The size of the requests for the {.list} with all = true
-    LIST_ALL_SIZE = 1000
-
     # @return [Integer]
     attr_reader :id, :datecreated
 
@@ -62,7 +59,7 @@ module CoachClient
       if all
         total = self.total(client)
         start = 0
-        size = LIST_ALL_SIZE
+        size = client.max_size
       end
       loop do
         response = CoachClient::Request.get(client.url + path,
@@ -283,4 +280,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/partnership_subscription.rb

@@ -35,15 +35,18 @@ module CoachClient
     # Updates the partnership subscription with the data from the CyberCoach
     # service.
     #
+    # @param [Integer] size the number of entries
+    # @param [Integer] start the start of entries list
+    # @param [Boolean] all whether all entries are retrieved
     # @raise [CoachClient::NotFound] if the partnership subscription does not
     #   exist
     # @return [CoachClient::PartnershipSubscription] the updated partnership
     #   subscription
-    def update
+    def update(size: 20, start: 0, all: false)
       begin
-        super(@partnership.user1)
+        super(@partnership.user1, size: size, start: start, all: all)
       rescue CoachClient::Exception
-        super(@partnership.user2)
+        super(@partnership.user2, size: size, start: start, all: all)
       end
     end
 
@@ -96,4 +99,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/request.rb

@@ -101,4 +101,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/resource.rb

@@ -43,6 +43,12 @@ module CoachClient
       end
       hash
     end
+
+    private
+
+    def next?(links)
+      return false if links.nil?
+      links.any? { |link| link[:description] == "next" }
+    end
   end
 end
-

data/lib/coach_client/response.rb

@@ -34,4 +34,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/sport.rb

@@ -84,4 +84,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/subscription.rb

@@ -37,22 +37,34 @@ module CoachClient
     #
     # @raise [CoachClient::NotFound] if the subscription does not exist
     # @param [CoachClient::User] user
+    # @param [Integer] size the number of entries
+    # @param [Integer] start the start of entries list
+    # @param [Boolean] all whether all entries are retrieved
     # @return [CoachClient::Subscription] the updated subscription
-    def update(user)
-      response = CoachClient::Request.get(url, username: user.username,
-                                          password: user.password)
-      response = response.to_h
-      @id = response[:id]
-      @datesubscribed = response[:datesubscribed]
-      @publicvisible = response[:publicvisible]
+    def update(user, size: 20, start: 0, all: false)
+      response = {}
+      if all
+        start = 0
+        size = @client.max_size
+      end
       @entries = []
-      unless response[:entries].nil?
+      loop do
+        response = CoachClient::Request.get(url, username: user.username,
+                                            password: user.password,
+                                            params: { start: start, size: size })
+        response = response.to_h
+        break if response[:entries].nil?
         response[:entries].each do |e|
           tag = "entry#{@sport}"
           id = CoachClient::Entry.extract_id_from_uri(e[tag.to_sym][:uri])
           @entries << CoachClient::Entry.new(client, self, id: id)
         end
+        break unless all && next?(response[:links])
+        start += size
       end
+      @id = response[:id]
+      @datesubscribed = response[:datesubscribed]
+      @publicvisible = response[:publicvisible]
       self
     end
 
@@ -97,4 +109,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/user.rb

@@ -1,9 +1,6 @@
 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
 
@@ -56,7 +53,7 @@ module CoachClient
       if all
         total = self.total(client)
         start = 0
-        size = LIST_ALL_SIZE
+        size = client.max_size
       end
       loop do
         response = CoachClient::Request.get(client.url + path,
@@ -93,24 +90,36 @@ module CoachClient
 
     # Updates the user with the data from the CyberCoach service.
     #
+    # @param [Integer] size the number of partnerships
+    # @param [Integer] start the start of partnerships list
+    # @param [Boolean] all whether all partnerships are retrieved
     # @raise [CoachClient::NotFound] if the user does not exist
     # @return [CoachClient::User] the updated user
-    def update
-      response = CoachClient::Request.get(url, username: @username,
-                                          password: @password)
-      response = response.to_h
-      @realname = response[:realname]
-      @email = response[:email]
-      @publicvisible = response[:publicvisible]
-      @datecreated = response[:datecreated]
+    def update(size: 20, start: 0, all: false)
+      response = {}
+      if all
+        start = 0
+        size = @client.max_size
+      end
       @partnerships = []
-      unless response[:partnerships].nil?
+      loop do
+        response = CoachClient::Request.get(url, username: @username,
+                                            password: @password,
+                                            params: { start: start, size: size })
+        response = response.to_h
+        break if 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
+        break unless all && next?(response[:links])
+        start += size
       end
+      @realname = response[:realname]
+      @email = response[:email]
+      @publicvisible = response[:publicvisible]
+      @datecreated = response[:datecreated]
       @subscriptions = []
       unless response[:subscriptions].nil?
         response[:subscriptions].each do |s|
@@ -183,4 +192,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/user_subscription.rb

@@ -32,10 +32,13 @@ module CoachClient
 
     # Updates the user subscription with the data from the CyberCoach service.
     #
+    # @param [Integer] size the number of entries
+    # @param [Integer] start the start of entries list
+    # @param [Boolean] all whether all entries are retrieved
     # @raise [CoachClient::NotFound] if the user subscription does not exist
     # @return [CoachClient::UserSubscription] the updated user subscription
-    def update
-      super(@user)
+    def update(size: 20, start: 0, all: false)
+      super(@user, size: size, start: start, all: all)
     end
 
     # Saves the user subscription to the CyberCoach service.
@@ -76,4 +79,3 @@ module CoachClient
     end
   end
 end
-

data/lib/coach_client/version.rb

@@ -1,5 +1,4 @@
 module CoachClient
   # The version of the gem
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coach_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Jungo
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler