redminerb 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fab0c9d47ded9d94c9f5493d83e86303c47eaac
-  data.tar.gz: 23719db05f4831efc40eb52cbf896ec0191f5c65
+  metadata.gz: d73c75d31889c043847cbfa88509d83971a19dd3
+  data.tar.gz: 757a41cad5019c335107d80a83058db166bd973c
 SHA512:
-  metadata.gz: 4e79942f238f54007293d5a9be204a69c894c9abc14df14ca486e7813af15dd479f0b6d1914820878a56dda54458604179ed14a4657ce88c311c3dd9561f4ed0
-  data.tar.gz: 954359ec39e9d9a983a765f962c30b7b305d8322748c0a086b0d5577ab60894a2fa0a72c19eaf83348b6fe7b5aa82c420d56decae5aa93ee1c734b036d673566
+  metadata.gz: 0546f70d8f26ec3ba49c0c12199b938808ba37349b39c1a0f921b8308a7c2446f3427e0828298a3fa8350f872121e71eaac90cc20c598419509d4ea55d9fd23d
+  data.tar.gz: 60eed842cc876d662fb9b4ee73c88ea91b2d0602e3cae0acf44da678cc733c11e89781712ebbf79d2f9e9df490b7d43140f88cec23ae94e28467a39b2c65296d

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.rubocop.yml

@@ -1,6 +1,8 @@
 # Personal preferences
+Metrics/MethodLength:
+  Max: 12
 Metrics/LineLength:
-  Max: 99
+  Max: 92
 Style/SpaceInsideBlockBraces:
   Enabled: false
 Style/TrailingWhitespace:

data/README.md

@@ -145,6 +145,8 @@ Will return only the ID following by the user's email.
 
 You can see **all the fields available** with `redminerb user me`.
 
+**To list all the users at the database** you can use the `--all` option. Internally it will make as many HTTP requests to the REST API as needed. Here the `--limit` option let's manage the maximum number of users it will get with each request (to search, if possible, consider using the `--query` option instead).
+
 #### Show our info in the Redmine server
 
     $ redminerb user me

data/lib/redminerb/cli/projects.rb

@@ -26,7 +26,9 @@ module Redminerb
       option :template, aliases: :t
       def show(project_id)
         Redminerb.init!
-        puts Redminerb::Template.render(:project, Redminerb::Projects.read(project_id), options)
+        puts Redminerb::Template.render(:project,
+                                        Redminerb::Projects.read(project_id),
+                                        options)
       end
     end
   end

data/lib/redminerb/cli/users.rb

@@ -12,6 +12,14 @@ module Redminerb
       option :name,   aliases: [:q, '--query'], banner: '<FILTER>'
       option :offset, aliases: :o
       option :limit, aliases: :l
+      option :all, type: :boolean,
+                   desc: "List all the users at the database. Internally it makes\n" + <<-DESC
+                                 # as many HTTP requests to the REST API as needed (the
+                                 # --limit option us manage that number setting the maximum
+                                 # number of users it will get each time). To search consider
+                                 # using the --query option instead (if possible).
+                               DESC
+
       def list(user_id = nil)
         if user_id
           show user_id
@@ -42,7 +50,8 @@ module Redminerb
             end
             initializer_data[:current_command].options.keys.each do |option|
               next if option == :ask
-              value = ask("#{option.capitalize} [#{options[option]}]:", Thor::Shell::Color::GREEN)
+              value = ask("#{option.capitalize} [#{options[option]}]:",
+                          Thor::Shell::Color::GREEN)
               options[option] = value unless value.empty?
             end
             break if yes?('Is everything OK? (NO/yes)')

data/lib/redminerb/client.rb

@@ -14,6 +14,23 @@ module Redminerb
       @connection.basic_auth(cfg.api_key, cfg.api_key)
     end
 
+    # Uses pagination (limit&offset) params to retreive all the resources of
+    # the collection "name" using "params" in each request. Returns an array
+    # with all the resources.
+    def get_collection(name, params = { 'limit': 100 })
+      offset = 0
+      limit = params['limit'].to_i
+      [].tap do |resources|
+        loop do
+          params['offset'] = offset
+          response = get_json("/#{name}.json", params)
+          resources << response[name.to_s]
+          offset += limit
+          break unless offset < response['total_count']
+        end
+      end.flatten
+    end
+
     # Makes a GET request of the given 'path' param and returns the body of the
     # response parsed as JSON.
     def get_json(path, params = {})

data/lib/redminerb/users.rb

@@ -14,13 +14,16 @@ module Redminerb
       #   end
       #
       # See lib/reminerb/cli/user.rb code to see other example/s.
-  
       def list(params)
-        Redminerb.client.get_json('/users.json', params)['users'].map do |user|
+        if params.delete('all')
+          Redminerb.client.get_collection(:users, params)
+        else
+          Redminerb.client.get_json('/users.json', params)['users']
+        end.map do |user|
           OpenStruct.new user
         end
       end
-  
+
       # Creates a brand new user with the given params. In lib/reminerb/cli/user.rb
       # you can see which ones are required (or running 'redminerb users create'
       # from the command line).

data/lib/redminerb/version.rb

@@ -1,4 +1,4 @@
 # Copyright (c) The Cocktail Experience S.L. (2015)
 module Redminerb
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redminerb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Fernando Garcia Samblas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor