teamdrive_api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4004e15801a70734a32aa812d2a8ab6d28f02998
-  data.tar.gz: 7fbb6b1045159a5dd4e0e94ce5668fd71d834913
+  metadata.gz: 2ba5238b1fa4ed98698e6a63451b942d8bf00b6c
+  data.tar.gz: 8399fc3422dde2957af01fdda909237cbf52ab67
 SHA512:
-  metadata.gz: 418127519db85d91e0956515bf2ddf7f7585f88e5964ad2eb2722ce9fbb7a84531f2b8f055014156cfbd63485191831b1e78bd5c7d487cf0ebc81fd671f71227
-  data.tar.gz: 75896c17dbbb51a0681c777216a406bcf41b3b2d286e4f187100e859aa4e0338026dfc71ba386056c930428a07ea8806f0f7c20cd164c7bcb440c90e7f3ed3d8
+  metadata.gz: 5d00faa1441326182374f7b378afe03f6770f79d3df1f0d7e6e01e729ee45954f42c71d8b5277e916d8c9031f10528b7435c526f0415c9b0833114a0e89c521c
+  data.tar.gz: d8142ecce1f780538cbce731aa19237678a0d269a0cd4281b258c9d9c47cea3edda0838eb93327334cd00db4a957f19a5f22a1f7bdfba3147099a6b4455d3fc0

data/README.md

@@ -1,5 +1,6 @@
 # TeamdriveApi
 
+[![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)
 [![Test Coverage](https://codeclimate.com/github/mhutter/teamdrive_api/badges/coverage.svg)](https://codeclimate.com/github/mhutter/teamdrive_api)
@@ -33,17 +34,51 @@ api = TeamdriveApi::Register.new('example.com', 'd3b07384d113edec49eaa6238ad5ff0
 
 api.remove_user 'foobar'
 #=> true
+
+api.search_user username: '$CODE-*'
+#=> {:apiversion=>"1.0.005",
+#=>  :searchresult=>{:current=>"3", :maximum=>"50", :total=>"3"},
+#=>  :userlist=>
+#=>   {:user=>
+#=>     [{:userid=>"2",
+#=>       :username=>"$CODE-1002",
+#=>       :email=>"user2@example.com",
+#=>       :reference=>nil,
+#=>       :department=>nil,
+#=>       :language=>"en",
+#=>       :distributor=>"CODE",
+#=>       :usercreated=>"07/25/2014 15:06:41.00",
+#=>       :status=>"activated"},
+#=>      {:userid=>"10",
+#=>       :username=>"$CODE-1010",
+#=>       :email=>"user10@example.com",
+#=>       :reference=>nil,
+#=>       :department=>nil,
+#=>       :language=>"en",
+#=>       :distributor=>"CODE",
+#=>       :usercreated=>"10/01/2014 09:31:49.00",
+#=>       :status=>"activated"},
+#=>      {:userid=>"15",
+#=>       :username=>"$CODE-1015",
+#=>       :email=>"user15@example.com",
+#=>       :reference=>nil,
+#=>       :department=>nil,
+#=>       :language=>"en",
+#=>       :distributor=>"CODE",
+#=>       :usercreated=>"03/04/2015 13:39:09.00",
+#=>       :status=>"activated"}]}}
 ```
 
+For more Information see {TeamdriveApi::Register}
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/teamdrive_api/fork )
+1. Fork it ( https://github.com/mhutter/teamdrive_api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/teamdrive_api/core_ext/array.rb

@@ -0,0 +1,15 @@
+class Array
+  # 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 }
+  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
+    end
+  end
+end

data/lib/teamdrive_api/register.rb

@@ -11,16 +11,17 @@ module TeamdriveApi
       @uri = URI.join(@host + '/', 'pbas/td2api/api/api.htm').to_s
     end
 
-    # Assign user to license (added in 1.0.003)
+    # Assign user to license (added in RegServ API v1.0.003)
     #
     # @param [String] username
     # @param [String] number License Number
+    # @return [Boolean] success?
     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)
+    # Create license without user (added in RegServ API v1.0.003)
     #
     # @param [Hash] opts license options
     # @option opts [String] :productname +server+, +client+
@@ -31,6 +32,7 @@ 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?
     def create_license_without_user(opts = {})
       require_all of: [:productname, :type, :featurevalue], in_hash: opts
       res = send_request :createlicensewithoutuser, opts
@@ -40,7 +42,8 @@ module TeamdriveApi
     # Get User Data
     #
     # @param [String] username
-    # @param [String] distributor (optional, added in API release 1.0.003)
+    # @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,
@@ -48,12 +51,13 @@ module TeamdriveApi
       })
     end
 
-    # Remove user (added in +1.0.003+)
+    # 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
     #   +APIAllowSettingDistributor+ in the Teamdrive Register docs).
+    # @return [Boolean] success?
     def remove_user(username, delete_license = false, distributor = nil)
       res = send_request :removeuser,
         username: username,
@@ -71,6 +75,7 @@ module TeamdriveApi
     # @option query [String] :startid (0)
     # @option query [Boolean] :showdevice (false)
     # @option query [Boolean] :onlyownusers (false)
+    # @return [Hash] list of users
     def search_user(query = {})
       require_one of: [:username, :email], in_hash: query
       query = {

data/lib/teamdrive_api/version.rb

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

data/lib/teamdrive_api.rb

@@ -1,20 +1,9 @@
 require 'teamdrive_api/version'
+require 'teamdrive_api/core_ext/array'
 require 'teamdrive_api/core_ext/hash'
 require 'teamdrive_api/error'
 require 'teamdrive_api/base'
 require 'teamdrive_api/register'
 
 module TeamdriveApi
-  # extend self
-  #
-  # # default options
-  # @options = {
-  #   api_version: '1.0.005',
-  #   register_path: 'pbas/td2api/api/api.htm'
-  # }
-  #
-  # # The options hash. See {file:README.md#options the options documentation}.
-  # #
-  # # @return [{Symbol => Object}]
-  # attr_accessor :options
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamdrive_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Manuel Hutter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -126,6 +126,7 @@ files:
 - bin/setup
 - lib/teamdrive_api.rb
 - lib/teamdrive_api/base.rb
+- lib/teamdrive_api/core_ext/array.rb
 - lib/teamdrive_api/core_ext/hash.rb
 - lib/teamdrive_api/error.rb
 - lib/teamdrive_api/register.rb
@@ -156,3 +157,4 @@ signing_key:
 specification_version: 4
 summary: TeamDrive API Client
 test_files: []
+has_rdoc: