teamdrive_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba5238b1fa4ed98698e6a63451b942d8bf00b6c
-  data.tar.gz: 8399fc3422dde2957af01fdda909237cbf52ab67
+  metadata.gz: 3907c9541d30a306e0115d2e0f1d057d57d06ffb
+  data.tar.gz: ee7502e5870a9d00ee1091d54dd3f9f3953b913c
 SHA512:
-  metadata.gz: 5d00faa1441326182374f7b378afe03f6770f79d3df1f0d7e6e01e729ee45954f42c71d8b5277e916d8c9031f10528b7435c526f0415c9b0833114a0e89c521c
-  data.tar.gz: d8142ecce1f780538cbce731aa19237678a0d269a0cd4281b258c9d9c47cea3edda0838eb93327334cd00db4a957f19a5f22a1f7bdfba3147099a6b4455d3fc0
+  metadata.gz: 961ca480bde4d9ef0bf034fd4c33b055bd7488a998f5e8b41746eb287f31abbcc35144e43cd808e1dc53332279eb38ae7a0a6582e8a74421b03afa2cfb815a80
+  data.tar.gz: 3210a0e0ed635772dd470548a3daa35cf486ac698780041442c22320659f8b263789d5b8cb2333b75fb3d12def3d26376b3273170c938eb7209c9fb88043dd23

data/README.md

@@ -1,5 +1,6 @@
 # TeamdriveApi
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/teamdrive_api/frames)
 [![Gem Version](https://badge.fury.io/rb/teamdrive_api.svg)](http://badge.fury.io/rb/teamdrive_api)
 [![Build Status](https://travis-ci.org/mhutter/teamdrive_api.svg?branch=master)](https://travis-ci.org/mhutter/teamdrive_api)
 [![Code Climate](https://codeclimate.com/github/mhutter/teamdrive_api/badges/gpa.svg)](https://codeclimate.com/github/mhutter/teamdrive_api)

data/lib/teamdrive_api/base.rb

@@ -62,6 +62,7 @@ module TeamdriveApi
       res = res['teamdrive'].symbolize_keys
       unless res[:exception].nil?
         fail TeamdriveApi::Error.new res[:exception][:primarycode],
+                                     res[:exception][:secondarycode],
                                      res[:exception][:message]
       end
       res

data/lib/teamdrive_api/error.rb

@@ -1,9 +1,10 @@
 module TeamdriveApi
   # An exception raised by the TeamDrive API
   class Error < StandardError
-    def initialize(code, msg)
-      super msg
-      @code, @msg = code, msg
+    attr_reader :code, :secondarycode, :message
+    def initialize(code, secondarycode, message)
+      super message
+      @code, @secondarycode, @message = code, secondarycode, message
     end
   end
 end

data/lib/teamdrive_api/register.rb

@@ -11,6 +11,17 @@ module TeamdriveApi
       @uri = URI.join(@host + '/', 'pbas/td2api/api/api.htm').to_s
     end
 
+    # Assign license to client (added in RegServ API 1.0.004)
+    #
+    # @param [String] username
+    # @param [String] number License Number
+    # @param [Array] devices optional list of devices the user posses. If empty, all of the user’s devices will be used
+    # @return [Boolean] success?
+    def assign_license_to_client(username, number, devices = [])
+      res = send_request :assignlicensetoclient, username: username, number: number, devices: devices
+      res[:intresult].eql?(0)
+    end
+
     # Assign user to license (added in RegServ API v1.0.003)
     #
     # @param [String] username
@@ -32,11 +43,36 @@ module TeamdriveApi
     # @option opts [String] :contactnumber An optional contact number. Added with v1.0.004
     # @option opts [String] :validuntil An optional valid-until date. Format must be +DD.MM.YYYY+. Added with v1.0.004
     # @option opts [String] :changeid An optional change id for license changes. Added with v1.0.004
-    # @return [Boolean] success?
+    # @return [Hash] The created license?
     def create_license_without_user(opts = {})
       require_all of: [:productname, :type, :featurevalue], in_hash: opts
-      res = send_request :createlicensewithoutuser, opts
-      res[:intresult].eql?('0')
+      send_request :createlicensewithoutuser, opts
+    end
+
+    # Get default-license for a user
+    #
+    # @param [String] username
+    # @param [String] distributor (optional)
+    # @return [Hash] the license data
+    def get_default_license_for_user(username, distributor = nil)
+      res = send_request(:getdefaultlicense, {
+        username: username,
+        distributor: distributor
+      })
+      res[:licensedata]
+    end
+
+    # Get license data for a user
+    #
+    # @param [String] username
+    # @param [String] distributor (optional)
+    # @return [Hash] the license data
+    def get_license_data_for_user(username, distributor = nil)
+      res = send_request(:getlicensedata, {
+        username: username,
+        distributor: distributor
+      })
+      res[:licensedata]
     end
 
     # Get User Data
@@ -51,6 +87,28 @@ module TeamdriveApi
       })
     end
 
+    # Create a new Account
+    #
+    # @note The range of possible Usernames depend on the +RegNameComplexity+
+    #   setting as described in the Registration Server documentation.
+    #   Similary, the length of passwords can be restricted by the
+    #   +ClientPasswordLength+ setting. However, these restriction only apply
+    #   when creating a new account, they will not be checked when a user
+    #   attempts to log in.
+    #
+    # @param [Hash] Data for the new user.
+    # @option opts [String] :username
+    # @option opts [String] :useremail
+    # @option opts [String] :password
+    # @option opts [String] :language
+    # @option opts [String] :reference
+    # @option opts [String] :department
+    # @option opts [String] :distributor
+    def register_user(opts = {})
+      send_request(:registeruser, opts)
+    end
+    alias_method :create_account, :register_user
+
     # Remove user (added in RegServ API v1.0.003)
     #
     # @param [String] username to be deleted

data/lib/teamdrive_api/version.rb

@@ -1,3 +1,3 @@
 module TeamdriveApi
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamdrive_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Manuel Hutter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty