teamdrive_api 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b45c3b25d1dcb7013098b0b29ae3fb9bbde24ea4
-  data.tar.gz: 75b8a46bdaef8a8ad26d6dcdb0cc1228e561bb85
+  metadata.gz: 1d8d46801ef006ccd36dfefe91ee157089896aa6
+  data.tar.gz: d121207c9faece16f2ea037a9297dd27d0a5b1d6
 SHA512:
-  metadata.gz: 4b32c14ab8a45eb5e507d8d6127cfb056dfdc137331b57d43579dfc0b4303a6d62904ac6a5a5dbc6794801f215197f8ce44ebdc66178c4b81637e2dd118b9999
-  data.tar.gz: c9288130c22f13fb8a3c421d39933bdc85d4d8c1e87ecd03e1751e3ae106fdfa47f8c18056ba1597677fc3aee4e39ff533abd1a8904d6d10ca875829dc66f256
+  metadata.gz: 87e474fd5a313073ceb3968afd8922dfa3eee16de8141fe231dd7af688272317a6fcbf9bfcb43db086681457978d58b05419b57d5d0491051555b6b9d8ee9337
+  data.tar.gz: 00dd0e749bb1756e9f1058d6b8c992d24a213066dbd382e54847d68cba10de9b2b830f55b24b85a0f05806326747636fdeb9858212e4f21c48624bcb10d61508

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/LineLength:
+  Exclude:
+    - teamdrive_api.gemspec

data/bin/console

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "teamdrive_api"
+require 'bundler/setup'
+require 'teamdrive_api'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-require "pry"
+require 'pry'
 Pry.start

data/lib/teamdrive_api/base.rb

@@ -4,28 +4,24 @@ require 'uri'
 
 module TeamdriveApi
   # API-Baseclass for all XML RPC APIs
-  class Base # :nodoc:
+  class Base
     include ::HTTParty
     attr_reader :uri
     format :xml
 
     def initialize(host, api_checksum_salt, api_version)
-      @api_checksum_salt, @api_version = api_checksum_salt, api_version
+      @api_checksum_salt = api_checksum_salt
+      @api_version       = api_version
       @host = host.start_with?('http') ? host : 'https://' + host
     end
 
     # Generates the XML payload for the RPC
     def payload_for(command, query = {})
-      out = ''
-      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>"
+      out = header_for(command)
       query.each do |k, v|
         next if v.nil?
         v = v.to_s
-        v = %w(true false).include?(v) ? '$' + v : v
+        v = '$' + v if %w(true false).include?(v)
         out << "<#{k}>#{v}</#{k}>"
       end
       out << '</teamdrive>'
@@ -33,6 +29,15 @@ module TeamdriveApi
 
     private
 
+    # Generates the XML header for the RPC
+    def header_for(command)
+      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>"
+    end
+
     def check_for(method, hash, params, message)
       keys = [params].flatten
       return if keys.send(method) { |k| hash.key?(k) }
@@ -52,20 +57,26 @@ module TeamdriveApi
       check_for(:all?, in_hash, of, 'all')
     end
 
+    # actually send a HTTP request
     def send_request(command, data = {})
       body = payload_for(command, data)
-      res = self.class.post @uri,
+      res = self.class.post(
+        @uri,
         headers: { 'User-Agent' => "TeamdriveApi v#{TeamdriveApi::VERSION}" },
         body: body,
         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][:secondarycode],
-                                     res[:exception][:message]
-      end
-      res
+      return_or_fail(res['teamdrive'].symbolize_keys)
+    end
+
+    # raise TeamdriveApi::Error if +response+ contains an exception, return
+    # +response+ otherwise
+    def return_or_fail(response)
+      return response if response[:exception].nil?
+      fail TeamdriveApi::Error.new response[:exception][:primarycode],
+                                   response[:exception][:secondarycode],
+                                   response[:exception][:message]
     end
   end
 end

data/lib/teamdrive_api/core_ext/array.rb

@@ -1,15 +1,15 @@
-class Array
+class Array # :nodoc:
   # Returns an Array with all elements' keys converted to symbols, as long as
   # they respond to +symbolize_keys+.
   def symbolize_keys
-    self.map { |e| e.symbolize_keys rescue e }
+    map { |e| e.respond_to?(:symbolize_keys) ? e.symbolize_keys : e }
   end
 
   # Converts the keys of all elements to symbols, as long as the elements
   # respond to +symbolize_keys!+
   def symbolize_keys!
-    self.each do |e|
-      e.symbolize_keys! rescue nil
+    each do |e|
+      e.symbolize_keys! if e.respond_to?(:symbolize_keys!)
     end
   end
 end

data/lib/teamdrive_api/core_ext/hash.rb

@@ -1,4 +1,4 @@
-class Hash
+class Hash # :nodoc:
   # Returns a new hash with all keys converted to symbols, as long as
   # they respond to +to_sym+.
   #
@@ -10,9 +10,9 @@ class Hash
   # Borrowed from ActiveSupport.
   def symbolize_keys
     result = self.class.new
-    each_key do |key|
-      new_key = key.to_sym rescue key
-      new_value = self[key].symbolize_keys rescue self[key]
+    each do |key, val|
+      new_key = key.respond_to?(:to_sym) ? key.to_sym : key
+      new_value = val.respond_to?(:symbolize_keys) ? val.symbolize_keys : val
       result[new_key] = new_value
     end
     result
@@ -23,10 +23,11 @@ class Hash
   #
   # Borrowed from ActiveSupport.
   def symbolize_keys!
+    # we have to use `keys.each` because we can't modify a Hash during `each`
     keys.each do |key|
-      new_key = key.to_sym rescue key
-      old_value = delete(key)
-      new_value = old_value.symbolize_keys! rescue old_value
+      new_key = key.respond_to?(:to_sym) ? key.to_sym : key
+      val = delete(key)
+      new_value = val.respond_to?(:symbolize_keys!) ? val.symbolize_keys! : val
       self[new_key] = new_value
     end
     self

data/lib/teamdrive_api/error.rb

@@ -4,7 +4,9 @@ module TeamdriveApi
     attr_reader :code, :secondarycode, :message
     def initialize(code, secondarycode, message)
       super message
-      @code, @secondarycode, @message = code, secondarycode, message
+      @code          = code
+      @secondarycode = secondarycode
+      @message       = message
     end
   end
 end

data/lib/teamdrive_api/register.rb

@@ -1,10 +1,12 @@
 module TeamdriveApi
-  # API Client for the TeamDrive Register Server. See the TeamDrive Register docs for more informations on specific commands.
+  # API Client for the TeamDrive Register Server. See the TeamDrive Register
+  # docs for more informations on specific commands.
   class Register < Base
     # Create a new Register API Client.
     #
     # @param [String] host the API Server
-    # @param [String] api_checksum_salt the +APIChecksumSalt+ system setting ("Edit Settings -> RegServer").
+    # @param [String] api_checksum_salt the +APIChecksumSalt+ system setting
+    #   ("Edit Settings -> RegServer").
     # @param [String] api_version optionally overwrite the api_version
     def initialize(host, api_checksum_salt, api_version = '1.0.005')
       super
@@ -15,11 +17,16 @@ module TeamdriveApi
     #
     # @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
+    # @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)
+      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)
@@ -28,37 +35,57 @@ module TeamdriveApi
     # @param [String] number License Number
     # @return [Boolean] success?
     def assign_user_to_license(username, number)
-      res = send_request :assignusertolicense, username: username, number: number
+      res = send_request :assignusertolicense,
+                         username: username,
+                         number: number
+
       res[:intresult].eql?('0')
     end
 
-    # Create license without user (added in RegServ API v1.0.003)
+    # Create a license and assign it to a user.
     #
     # @param [Hash] opts license options
+    # @option opts [String] :username User to assign license to
     # @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
-    # @return [Hash] The created license?
+    # @option opts [String] :featurevalue one of +webdavs+, +personal+,
+    #   +professional+, +enterprise+
+    # @option opts [String] :limit Amount, only for client licenses
+    # @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
+    # @return [String] The license number of the created license
+    def create_license(opts = {})
+      require_all of: [:username, :productname, :type, :featurevalue],
+                  in_hash: opts
+      res = send_request :createlicense, opts
+      res[:licensedata][:number]
+    end
+
+    # Create license without user (added in RegServ API v1.0.003)
+    #
+    # @see #create_license
     def create_license_without_user(opts = {})
       require_all of: [:productname, :type, :featurevalue], in_hash: opts
-      send_request :createlicensewithoutuser, opts
+      res = send_request :createlicensewithoutuser, opts
+      res[:licensedata][:number]
     end
 
     # Get default-license for a user
     #
     # @param [String] username
-    # @param [String] distributor (optional)
+    # @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 = send_request :getdefaultlicense,
+                         username: username,
+                         distributor: distributor
+
       res[:licensedata]
     end
 
@@ -68,10 +95,10 @@ module TeamdriveApi
     # @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 = send_request :getlicensedata,
+                         username: username,
+                         distributor: distributor
+
       res[:licensedata]
     end
 
@@ -81,10 +108,9 @@ module TeamdriveApi
     # @param [String] distributor (optional, added in RegServ API v1.0.003)
     # @return [Hash] the user data
     def get_user_data(username, distributor = nil)
-      send_request(:getuserdata, {
-        username: username,
-        distributor: distributor
-      })
+      send_request :getuserdata,
+                   username: username,
+                   distributor: distributor
     end
 
     # Create a new Account
@@ -96,34 +122,34 @@ module TeamdriveApi
     #   when creating a new account, they will not be checked when a user
     #   attempts to log in.
     #
-    # @param [Hash] Data for the new user.
+    # @param [Hash] opts Data for the new user.
     # @option opts [String] :username
     # @option opts [String] :useremail
     # @option opts [String] :password
-    # @option opts [String] :language (optional)
-    # @option opts [String] :reference (optional)
-    # @option opts [String] :department (optional)
-    # @option opts [String] :distributor (optional)
+    # @option opts [String] :language _optional_
+    # @option opts [String] :reference _optional_
+    # @option opts [String] :department _optional_
+    # @option opts [String] :distributor _optional_
     # @return [Boolean] +true+ if the User has been created
     def register_user(opts = {})
       require_all of: [:username, :useremail, :password], in_hash: opts
-      send_request(:registeruser, opts)
+      res = send_request(:registeruser, opts)
       res[:intresult].eql?('0')
     end
     alias_method :create_account, :register_user
 
     # Remove user (added in RegServ API v1.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
+    # @param [String] username User to be deleted
+    # @param [Boolean] delete_license delete the user's license aswell
+    # @param [String] distributor Distributor. Will only be used if allowed by the API (see
     #   +APIAllowSettingDistributor+ in the Teamdrive Register docs).
     # @return [Boolean] success?
     def remove_user(username, delete_license = false, distributor = nil)
       res = send_request :removeuser,
-        username: username,
-        delete_license: delete_license,
-        distributor: distributor
+                         username: username,
+                         delete_license: delete_license,
+                         distributor: distributor
 
       res[:intresult].eql?('0')
     end

data/lib/teamdrive_api/version.rb

@@ -1,3 +1,4 @@
+# :nodoc:
 module TeamdriveApi
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/teamdrive_api.rb

@@ -5,5 +5,6 @@ require 'teamdrive_api/error'
 require 'teamdrive_api/base'
 require 'teamdrive_api/register'
 
+# TeamDrive API Client
 module TeamdriveApi
 end

data/teamdrive_api.gemspec

@@ -4,31 +4,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'teamdrive_api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "teamdrive_api"
+  spec.name          = 'teamdrive_api'
   spec.version       = TeamdriveApi::VERSION
-  spec.authors       = ["Manuel Hutter"]
-  spec.email         = ["git@mhutter.net"]
+  spec.authors       = ['Manuel Hutter']
+  spec.email         = ['git@mhutter.net']
 
   if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+    # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server.'
   end
 
-  spec.summary       = %q{TeamDrive API Client}
-  spec.description   = %q{Client library for the TeamDrive XML API. Currently only supports the RegServer API}
-  spec.homepage      = "https://github.com/mhutter/teamdrive_api"
-  spec.license       = "MIT"
+  spec.summary       = 'TeamDrive API Client'
+  spec.description   = 'Client library for the TeamDrive XML API. Currently only supports the RegServer API'
+  spec.homepage      = 'https://github.com/mhutter/teamdrive_api'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "httparty", "~> 0.13"
+  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"
-  spec.add_development_dependency "webmock", "~> 1.20"
+  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'
+  spec.add_development_dependency 'webmock', '~> 1.20'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamdrive_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Manuel Hutter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -117,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -157,3 +158,4 @@ signing_key:
 specification_version: 4
 summary: TeamDrive API Client
 test_files: []
+has_rdoc: