teamleader 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmYwNDNjYWFjNTc3MTJkYTg2YWIyNzEyNWE2YzI1MzFlMTQ3NGZlNw==
+  data.tar.gz: !binary |-
+    MWNiODM1NjJiYjRhNmE4YzIzYzFjYmRmZjE5YWZhOTc0Y2MzMTFjOQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmI2OGE4ZmIxMjZkMzRmMGI2YWY1MGNmM2VhZDk4ZGRlMjIxYWNmM2Y3ZmNl
+    ZjVlYjhmZDYyNTIwODk1YTA5OTk0ZGQ4ZjQ0MTY5Y2I4OTlkMTQ3MTZiMTU5
+    ZDc1MWUzMWRmNWUwNjFlMzRjMWFkYWJhNzYzMzgwOTFhMzUyNjY=
+  data.tar.gz: !binary |-
+    MGZjNTY1ZGI2NTAyMjUwZTI4ZTI5MTg2NmU1NjdlYzk0NmNmZTE5ZmU0NDhh
+    MzU2OTE4MGU0ZWMwYjRiZTQ4ZjAzZDkwYjNiMTViNDE3ZDA1OTFlZTE3ZWFl
+    ZDIzYzQ0MjNkNGNkNmQ3NzYyMWIyYTkyMjkxYjM4MWE3ZGU1ZWY=

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+teamleader-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2017-05-11
+### Added
+- Initial commit

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Javry.com
+
+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,72 @@
+# Teamleader
+
+A ruby wrapper around Teamleader.eu API.
+
+**This Teamleader client is still in development, only a few endpoints are supported (see below).**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'teamleader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teamleader
+
+## Usage
+
+```ruby
+require 'teamleader'
+teamleader = Teamleader.new('Your API group', 'Your API secret')
+
+```
+You can find your API key in your Teamleader account, under Settings > API & Webhooks. API access is available for every Teamleader account.
+Note that you need to be admin to access this page.
+
+## Available methods
+When a method expects a hash as argument, the hash keys have the same name as described in [Teamleader API documentation](http://apidocs.teamleader.be/).
+
+If a required parameter is missing or if the API returns an error, the method will throw an exception.
+
+### Users
+
+```ruby
+teamleader.get_users
+```
+### Companies
+
+```ruby
+teamleader.add_company({:name => "Hello World"})
+teamleader.get_company(12345)
+teamleader.get_companies({:amount => 100, :pageno => 0, :searchby => "hello"}) # pagination starts at 0
+```
+
+### Invoices
+
+```ruby
+teamleader.get_invoice(12345)
+teamleader.get_invoices({:date_from => "01/01/2017", :date_to => "01/05/2017"})
+```
+
+## License
+The Teamleader GEM is released under the MIT License.
+
+## Contributing
+
+1. Fork it
+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
+
+## Credits
+This gem is inspired by the [hunterio gem](https://github.com/prospectio/hunterio/) made by Vincenzo Ruggiero
+
+Made with ️❤️️️ by [Javry](https://javry.com) in Belgium.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "teamleader"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.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/teamleader/api.rb

@@ -0,0 +1,100 @@
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module Teamleader
+  API_BASE_URL = "https://app.teamleader.eu/api"
+
+  class Api
+    def initialize(group, secret)
+      @api_group = group
+      @api_secret = secret
+      uri = URI.parse(API_BASE_URL)
+      @http = Net::HTTP.new(uri.host, uri.port)
+      @http.use_ssl = true
+    end
+
+    def get_users(params={})
+      request "/getUsers.php", params
+    end
+
+    def get_departments
+      request "/getDepartments.php"
+    end
+
+    def get_tags
+      request "/getTags.php"
+    end
+
+    # Returns the ID of the contact
+    def add_contact(params={})
+      raise "forename is required" if params[:forename].nil?
+      raise "surname is required" if params[:surname].nil?
+      raise "email is required" if params[:email].nil?
+      request "/addContact.php", params
+    end
+
+    # Returns the ID of the company
+    def add_company(params={})
+      raise "name is required" if params[:name].nil?
+      request "/addCompany.php", params
+    end
+
+    def get_company(id)
+      request "/getCompany.php", {:company_id => id}
+    end
+
+    def get_companies(params={})
+      raise "amount is required" if params[:amount].nil?
+      raise "pageno is required" if params[:pageno].nil?
+      request "/getCompanies.php", params
+    end
+
+    def add_invoice(params={})
+      raise "contact_or_company" if params[:contact_or_company].nil?
+      raise "contact_or_company_id" if params[:contact_or_company_id].nil?
+      raise "sys_department_id" if params[:sys_department_id].nil?
+      request "/addInvoice.php", params    
+    end
+
+    def get_invoice(id)
+      request "/getInvoice.php", {:invoice_id => id}
+    end
+
+    def get_invoices(params={})
+      raise "date_from is required" if params[:date_from].nil?
+      raise "date_to is required" if params[:date_to].nil?
+      request "/getInvoices.php", params
+    end
+
+    private
+    def request(path, data={})
+      headers = {
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }
+      data[:api_group] = @api_group
+      data[:api_secret] = @api_secret
+      data = URI.encode_www_form data
+      response = @http.post "/api" + path, data, headers
+      code = Integer(response.code)
+      if code >= 200 && code < 300
+        begin
+          JSON.parse response.body, :symbolize_names => true
+        rescue
+          response.body
+        end
+      elsif code == 505
+        raise "Error: API rate limit reached"
+      else
+        err = "unknown error"
+        begin
+          err = JSON.parse(response.body)["reason"]
+        rescue
+          err = "#{response.body}"
+        end
+        raise "HTTP Error #{code}: " + err
+      end
+    end
+  end
+end

data/lib/teamleader/version.rb

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

data/lib/teamleader.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/api'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/version'))
+
+module Teamleader
+  extend self
+
+  def new(group, secret)
+    Api.new(group, secret)
+  end
+end

data/teamleader.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.expand_path('../lib/teamleader/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "teamleader"
+  spec.version       = Teamleader::VERSION
+  spec.authors       = ["Pierre-Yves Orban"]
+  spec.email         = ["pyo@javry.com"]
+  spec.homepage      = 'https://github.com/Pyo25/teamleader-ruby'
+
+  spec.summary       = %q{A Ruby wrapper around Teamleader.eu API}
+  spec.description   = %q{A ruby wrapper around Teamleader.eu 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_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.6"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "typhoeus", "~> 1.1"
+
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "json", "~> 2.1"
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: teamleader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre-Yves Orban
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A ruby wrapper around Teamleader.eu API.
+email:
+- pyo@javry.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/teamleader.rb
+- lib/teamleader/api.rb
+- lib/teamleader/version.rb
+- teamleader.gemspec
+homepage: https://github.com/Pyo25/teamleader-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper around Teamleader.eu API
+test_files: []