redminerb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09692d9434819135c770d6163223cb5e2cf92126
-  data.tar.gz: 0ec505a1977c800b76f21062722480d305335760
+  metadata.gz: 06151d01eec527cbe1bd4ffaae591261853927c5
+  data.tar.gz: aba32467e103b17ee396e9971ad962ee509420ce
 SHA512:
-  metadata.gz: d78eae292b557efd6293da0656d6151b19285a6bf8b824850c75c5e46cf6e96008fac23378ae5c008a02b6947b3533c76b39b7e8989e0d55ced27c423045d9f9
-  data.tar.gz: d09e236d5d596aca2ddb445f42e86c2013b59f45d011b86c3b6d547b116a3a70033377f3d28cd8d28e6045331dfaef7e141c37f933d516fedfeeae94a2cbf7eb
+  metadata.gz: aefb44e25b2fcd44cf66bb8bd369fb0e096b1a788b6379916fbbc6d0d6031a8f0177e0337796e1463277eea016057f1fc79b097999f7ad0e5817b1da0a9103fb
+  data.tar.gz: 6e1b9acab0953a026a0f88614b016c4fe69239845a6d449ee05f1485025af4254c57ca1850723318d49f6b6e1cddb04a26f0502e7a8d8d58c0b71275397f791a

data/CHANGELOG.rdoc

@@ -1,4 +1,11 @@
+== 0.2, released 2015-09-17
+
+* 'redminerb users create' to create a brand new user!
+
 == 0.1, released 2015-09-16
 
 * 'redminerb config' to get current config
 * 'redminerb users [list]' to see current users
+
+* 'redminerb config' to get current config
+* 'redminerb users [list]' to see current users

data/README.md

@@ -34,6 +34,12 @@ Or install it yourself as:
 
 ## Usage
 
+The URL of your Redmine server and your API key needs to be in your
+`~/.redminerb.yml` in order to connect to its REST API. For example:
+
+    url: http://localhost:3000/
+    api_key: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
+
 ### Configuration (config)
 
 To see the current configuration used by Redminerb we have the `config` command:
@@ -42,15 +48,25 @@ To see the current configuration used by Redminerb we have the `config` command:
     URL:     http://localhost:3000/
     API-KEY: 69b47d74e36a6757bac5d45f8398dd23bfa8f52c
 
-Currently the config is read only from the **~/.redminerb.yml** file.
-
+*NOTICE: soon will be possible to specify this values using env. vars and this
+command will have more sense.*
 
 ### Users
 
+**IMPORTANT: Be sure that you API key have the right permissions in the server.**
+
+#### List current users
+
     $ redminerb users # a.k.a. redminerb users list
 
 That should give you the current users on your Redmine server, one per line.
 
+#### Create new user
+
+    $ redminerb users create --login "wadus" --password "ultrasecret" \
+                             --firstname="Wadux" --lastname="Wallace" \
+                             --mail "wadus@waduxwallace.out"
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/redminerb/cli/users.rb

@@ -11,5 +11,16 @@ module Redminerb
         puts [user.id, user.login, user.mail].join("\t").green
       end
     end
+
+    desc 'create', 'Creates a user.'
+    option :login, required: true
+    option :password, required: true
+    option :firstname, required: true
+    option :lastname, required: true
+    option :mail, required: true
+    def create
+      Redminerb.init!
+      puts Redminerb.client.create_user(options).green
+    end
   end
 end

data/lib/redminerb/client.rb

@@ -6,6 +6,8 @@ require 'ostruct'
 module Redminerb
   # HTTP client to communicate w/ the Redmine server.
   class Client
+    class UnprocessableEntity < StandardError; end
+
     attr_reader :connection
 
     def initialize(cfg)
@@ -31,14 +33,57 @@ module Redminerb
       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).
+    #
+    # Example (missing required params):
+    #   Redminerb.init!
+    #   Redminerb.client.create_user login: 'wadus'
+
+    def create_user(params)
+      response = post_json('/users.json', user: params)
+
+      if response.success?
+        'Created'
+      else
+        raise_error! response
+      end
+    end
+
     private
 
-    # Requests the path that receives as param and parses the body of the
-    # response received as JSON.
+    # Makes a GET request of the given 'path' param and returns the body of the
+    # response parsed as JSON.
     def get_json(path)
       Redminerb.init_required!
-      JSON.parse(@connection.get(path).body)
+      res = @connection.get(path)
+      JSON.parse(res.body)
+    rescue JSON::ParserError => e
+      raise e, "HTTP status code #{res.status}"
+    end
+
+    # Makes a POST request to 'path' with 'params' in JSON format. 
+    def post_json(path, params)
+      @connection.post do |req|
+        req.url path
+        req.headers['Content-Type'] = 'application/json'
+        req.body = params.to_json
+      end
     end
 
+    # It raises an exception giving the validation messages for 422 responses
+    def raise_error!(res)
+      if res.status == 422
+        begin
+          errors = JSON.parse(res.body)['errors']
+        rescue JSON::ParserError
+          errors = [res.body]
+        end
+        fail UnprocessableEntity, errors.join("\n")
+      else
+        fail StandardError, "ERROR (status code #{res.status})"
+      end
+    end
   end
 end

data/lib/redminerb/version.rb

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

metadata

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