teamdrive_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15376afa64dfc8c22ae13e7fa17a7db37a024c07
-  data.tar.gz: 696fa1373cb02aaf07268a445826bfc812832e0d
+  metadata.gz: 4004e15801a70734a32aa812d2a8ab6d28f02998
+  data.tar.gz: 7fbb6b1045159a5dd4e0e94ce5668fd71d834913
 SHA512:
-  metadata.gz: 7dadbf7786a00898f8dd1bcc7aa274287946885044ae70eef6f72a47cff262c7fdfadbc2856413ab03c6248092ae695997dc785ef9be404fa1794030b14f9fbb
-  data.tar.gz: 9275a3033668d93e2b4807c80c1ced9bc393277d8efa65d9764f666a2b03248ca0a014addf8c88c226bf6c8dd48cac0f0767b64867c11b1d5f8aefa2cb119f2d
+  metadata.gz: 418127519db85d91e0956515bf2ddf7f7585f88e5964ad2eb2722ce9fbb7a84531f2b8f055014156cfbd63485191831b1e78bd5c7d487cf0ebc81fd671f71227
+  data.tar.gz: 75896c17dbbb51a0681c777216a406bcf41b3b2d286e4f187100e859aa4e0338026dfc71ba386056c930428a07ea8806f0f7c20cd164c7bcb440c90e7f3ed3d8

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.2.1
+addons:
+  code_climate:
+    repo_token: e3716abd1175de1df9e93752138689064884581ad221e4d02d79c8ce734fe916

data/README.md

@@ -1,5 +1,9 @@
 # TeamdriveApi
 
+[![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)
+[![Test Coverage](https://codeclimate.com/github/mhutter/teamdrive_api/badges/coverage.svg)](https://codeclimate.com/github/mhutter/teamdrive_api)
+
 Client library for the TeamDrive XML API.
 
 ## Project State

data/Rakefile

@@ -6,3 +6,5 @@ Rake::TestTask.new do |t|
   t.libs << 'test'
   t.verbose = true
 end
+
+task default: [:test]

data/lib/teamdrive_api/base.rb

@@ -3,6 +3,7 @@ require 'httparty'
 require 'uri'
 
 module TeamdriveApi
+  # API-Baseclass for all XML RPC APIs
   class Base # :nodoc:
     include ::HTTParty
     attr_reader :uri
@@ -16,15 +17,15 @@ module TeamdriveApi
     # Generates the XML payload for the RPC
     def payload_for(command, query = {})
       out = ''
-      out << %q{<?xml version='1.0' encoding='UTF-8' ?>}
+      out << "<?xml version='1.0' encoding='UTF-8' ?>"
       out << '<teamdrive>'
       out << "<apiversion>#{@api_version}</apiversion>"
       out << "<command>#{command}</command>"
       out << "<requesttime>#{Time.now.to_i}</requesttime>"
-      query.each do |k,v|
+      query.each do |k, v|
         next if v.nil?
         v = v.to_s
-        v = %w{true false}.include?(v) ? '$' + v : v
+        v = %w(true false).include?(v) ? '$' + v : v
         out << "<#{k}>#{v}</#{k}>"
       end
       out << '</teamdrive>'
@@ -32,21 +33,36 @@ module TeamdriveApi
 
     private
 
+    def check_for(method, hash, params, message)
+      keys = [params].flatten
+      return if keys.send(method) { |k| hash.key?(k) }
+      msg = keys.map { |k| %("#{k}") }.join(', ')
+      fail ArgumentError, "Provide #{message} of #{msg}"
+    end
+
+    # make sure at least one of the keys in +of+ exists in +in_hash+. Raise an
+    # +ArgumentError+ if not so.
+    def require_one(of: [], in_hash: {})
+      check_for(:any?, in_hash, of, 'at least one')
+    end
+
+    # make sure all of the keys in +of+ exists in +in_hash+. Raise an
+    # +ArgumentError+ if not so.
+    def require_all(of: [], in_hash: {})
+      check_for(:all?, in_hash, of, 'all')
+    end
+
     def send_request(command, data = {})
       body = payload_for(command, data)
       res = self.class.post @uri,
         headers: { 'User-Agent' => "TeamdriveApi v#{TeamdriveApi::VERSION}" },
         body: body,
-        query: {
-          checksum: Digest::MD5.hexdigest(body + @api_checksum_salt)
-        }
+        query: { checksum: Digest::MD5.hexdigest(body + @api_checksum_salt) }
 
       res = res['teamdrive'].symbolize_keys
       unless res[:exception].nil?
-        fail TeamdriveApi::Error.new(
-          res[:exception][:primarycode],
-          res[:exception][:message]
-        )
+        fail TeamdriveApi::Error.new res[:exception][:primarycode],
+                                     res[:exception][:message]
       end
       res
     end

data/lib/teamdrive_api/register.rb

@@ -11,18 +11,56 @@ module TeamdriveApi
       @uri = URI.join(@host + '/', 'pbas/td2api/api/api.htm').to_s
     end
 
+    # Assign user to license (added in 1.0.003)
+    #
+    # @param [String] username
+    # @param [String] number License Number
+    def assign_user_to_license(username, number)
+      res = send_request :assignusertolicense, username: username, number: number
+      res[:intresult].eql?('0')
+    end
+
+    # Create license without user (added in 1.0.003)
+    #
+    # @param [Hash] opts license options
+    # @option opts [String] :productname +server+, +client+
+    # @option opts [String] :type +monthly+ / +yearly+ / +permanent+
+    # @option opts [String] :featurevalue one of +webdavs+, +personal+, +professional+, +enterprise+
+    # @option opts [String] :limit Amount (for a client license)
+    # @option opts [String] :licensereference An optional external reference. Added with v1.0.004
+    # @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
+    def create_license_without_user(opts = {})
+      require_all of: [:productname, :type, :featurevalue], in_hash: opts
+      res = send_request :createlicensewithoutuser, opts
+      res[:intresult].eql?('0')
+    end
+
+    # Get User Data
+    #
+    # @param [String] username
+    # @param [String] distributor (optional, added in API release 1.0.003)
+    def get_user_data(username, distributor = nil)
+      send_request(:getuserdata, {
+        username: username,
+        distributor: distributor
+      })
+    end
+
     # Remove user (added in +1.0.003+)
     #
     # @param [String] username to be deleted
     # @param [Boolean] delete the user's license aswell
-    # @param [String] distributor will only be used if allowed by the API (see +APIAllowSettingDistributor+ in the Teamdrive Register docs).
+    # @param [String] distributor will only be used if allowed by the API (see
+    #   +APIAllowSettingDistributor+ in the Teamdrive Register docs).
     def remove_user(username, delete_license = false, distributor = nil)
-      res = send_request :removeuser, {
+      res = send_request :removeuser,
         username: username,
         delete_license: delete_license,
         distributor: distributor
-      }
-      return res[:intresult].eql?('0')
+
+      res[:intresult].eql?('0')
     end
 
     # Search user
@@ -34,7 +72,7 @@ module TeamdriveApi
     # @option query [Boolean] :showdevice (false)
     # @option query [Boolean] :onlyownusers (false)
     def search_user(query = {})
-      fail ArgumentError if query.keys.length < 1
+      require_one of: [:username, :email], in_hash: query
       query = {
         showdevice: false,
         onlyownusers: false

data/lib/teamdrive_api/version.rb

@@ -1,3 +1,3 @@
 module TeamdriveApi
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/teamdrive_api.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "httparty", "~> 0.13"
 
   spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "minitest", "~> 5.5"
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamdrive_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Manuel Hutter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: minitest
   requirement: !ruby/object:Gem::Requirement