teamdrive_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b52d696a6b145a267406dc5855d29db39b55d54
+  data.tar.gz: 7bb13316c5320564084708ded4def7f4b8d9b0fb
+SHA512:
+  metadata.gz: d82dcdf0eaa231103b7c9c4a0d2f85cc423c0c9b656ac3e05818c19405362c9916d3f37f2938eb10d341187c6f6da00408a665ef1bb2c62c998c73c556e4230c
+  data.tar.gz: 7625087e1f50d7b585f6f109dd7080bd58797c98126fb2c495a93dcf0769dac8f0f3aef19610d03d859c90794b81da56497db987476a2b195b1b97aeccc20add

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+/.ruby-gemset

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in teamdrive_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Manuel Hutter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# TeamdriveApi
+
+Client library for the TeamDrive XML API.
+
+## Project State
+
+Currently only supports the RegServer API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teamdrive_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teamdrive_api
+
+## Usage
+
+```ruby
+api = TeamdriveApi::Register.new('example.com', 'd3b07384d113edec49eaa6238ad5ff00', '1.0.005')
+
+api.remove_user 'foobar'
+#=> true
+```
+
+## 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 )
+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`)
+5. Create a new Pull Request
+
+## Trademarks
+
+All trademarks named within this project are, without limitation, subject to the regulations of the trademark laws in each case, and as appropriate to ownership rights of the respective registered owners.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+  t.libs << 'test'
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+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"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/teamdrive_api/base.rb

@@ -0,0 +1,54 @@
+require 'digest'
+require 'httparty'
+require 'uri'
+
+module TeamdriveApi
+  class Base # :nodoc:
+    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
+      @host = host.start_with?('http') ? host : 'https://' + host
+    end
+
+    # Generates the XML payload for the RPC
+    def payload_for(command, query = {})
+      out = ''
+      out << %q{<?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|
+        next if v.nil?
+        v = v.to_s
+        v = %w{true false}.include?(v) ? '$' + v : v
+        out << "<#{k}>#{v}</#{k}>"
+      end
+      out << '</teamdrive>'
+    end
+
+    private
+
+    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)
+        }
+
+      res = res['teamdrive'].symbolize_keys
+      unless res[:exception].nil?
+        fail TeamdriveApi::Error.new(
+          res[:exception][:primarycode],
+          res[:exception][:message]
+        )
+      end
+      res
+    end
+  end
+end

data/lib/teamdrive_api/core_ext/hash.rb

@@ -0,0 +1,34 @@
+class Hash
+  # Returns a new hash with all keys converted to symbols, as long as
+  # they respond to +to_sym+.
+  #
+  #   hash = { 'name' => 'Rob', 'age' => '28' }
+  #
+  #   hash.symbolize_keys
+  #   # => {:name=>"Rob", :age=>"28"}
+  #
+  # 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]
+      result[new_key] = new_value
+    end
+    result
+  end
+
+  # Destructively converts all keys to symbols, as long as they respond
+  # to +to_sym+. Same as +symbolize_keys+, but modifies +self+.
+  #
+  # Borrowed from ActiveSupport.
+  def symbolize_keys!
+    keys.each do |key|
+      new_key = key.to_sym rescue key
+      old_value = delete(key)
+      new_value = old_value.symbolize_keys! rescue old_value
+      self[new_key] = new_value
+    end
+    self
+  end
+end

data/lib/teamdrive_api/error.rb

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

data/lib/teamdrive_api/register.rb

@@ -0,0 +1,28 @@
+module TeamdriveApi
+  # 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_version optionally overwrite the api_version
+    def initialize(host, api_checksum_salt, api_version = '1.0.005')
+      super
+      @uri = URI.join(@host + '/', 'pbas/td2api/api/api.htm').to_s
+    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).
+    def remove_user(username, delete_license = false, distributor = nil)
+      res = send_request :removeuser, {
+        username: username,
+        delete_license: delete_license,
+        distributor: distributor
+      }
+      return res[:intresult].eql?('0')
+    end
+  end
+end

data/lib/teamdrive_api/version.rb

@@ -0,0 +1,3 @@
+module TeamdriveApi
+  VERSION = "0.1.0"
+end

data/lib/teamdrive_api.rb

@@ -0,0 +1,20 @@
+require 'teamdrive_api/version'
+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

data/teamdrive_api.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teamdrive_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "teamdrive_api"
+  spec.version       = TeamdriveApi::VERSION
+  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."
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  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

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: teamdrive_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manuel Hutter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Client library for the TeamDrive XML API. Currently only supports the
+  RegServer API
+email:
+- git@mhutter.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/teamdrive_api.rb
+- lib/teamdrive_api/base.rb
+- lib/teamdrive_api/core_ext/hash.rb
+- lib/teamdrive_api/error.rb
+- lib/teamdrive_api/register.rb
+- lib/teamdrive_api/version.rb
+- teamdrive_api.gemspec
+homepage: https://github.com/mhutter/teamdrive_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: TeamDrive API Client
+test_files: []