teamleader 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598bd68872411fa4a73c8120d62b317f59eb532f
-  data.tar.gz: c771f8ab3a78f57f5882d324e099dde187b0b31a
+  metadata.gz: 713b06675edb4fb8523c85d37d7a82458ed9ceeb
+  data.tar.gz: b9f28cfbe6608987d4ab1185b7ab68df148404d8
 SHA512:
-  metadata.gz: 1f843a39ca3335a788dc8c0ce89c3d03cef9341fb29ca8b2fb3f91a8b3248b798a3fa59a4426b3721de9f702f91fe395b0f9b602a1329015e11570983f4df172
-  data.tar.gz: 70684260d36e75af820c111ac667611ca3a07ace03787ecb33e5a940c7af0421cf2b1a7286b0b16e681890d21eac367bc6916337e3679dc400288f47ca2dc520
+  metadata.gz: 32ec36b96ca6e6b8c937c2ebbf7efce59a75e6df201dbfbdf3d9cf60e2edbf1810b7ac671bb613221dd5535fd07e7b19f5fa9ce0b08e598d97e9dab25a624b0c
+  data.tar.gz: c7897fb48ef323c28770018e4942e617a625aa4e8b118d6b27c3b325e047e046365e21863ace31412eb80f4d9790381b608065cdf53db91e302c86b0f616dbb5

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.13.0] - 2018-05-14
+### Added
+- Allow configuration block
+- Add 5 methods for `File` endpoint
+- Add 5 methods for `Project` endpoint
+
+### Fixed
+- invalid param for `getDeals`
+
 ## [0.12.0] - 2018-03-28
 ### Added
 - New methods related to subscriptions: `get_subscriptions`, `get_all_subscriptions`

data/README.md

@@ -30,6 +30,16 @@ 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.
 
+### Configuration
+For Rails application create a configuration file `config/initializers/teamleader.rb`. You can do this anywhere in your application before you make API calls using the gem.
+
+```ruby
+Teamleader.configure do |config|
+  config.api_group = '45678'
+  config.api_secret = '31e56cf3b3c259f56666ba4a6089ee91c3150683611834f7eb2f5a7a4f039a17910f1fa2d65d282e9c344abcf895dad80a89b13af8fe917dfed1e0798c83350c'
+end
+```
+
 ## 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/).
 
@@ -102,6 +112,36 @@ teamleader.get_product({:product_id => 123})
 teamleader.delete_product({:product_id => 123})
 teamleader.get_products({:amount => 100, :pageno => 0}) # Pagination starts at 0
 ```
+
+### Projects
+
+```ruby
+teamleader.get_project({ :project_id => 123 })
+teamleader.get_projects_by_client({
+  contact_or_company: 'contact',
+  contact_or_company_id: '123',
+  deep_search: 1
+})
+
+teamleader.add_project({
+  :project_name => 123,
+  :project_budget => 300,
+  :project_responsible_user_id => 123,
+  :project_start_date => '12/01/2017',
+  :milestone_title => 'milestone title',
+  :milestone_budget => 200,
+  :milestone_invoiceable => 0,
+  :milestone_due_date => '12/03/2017',
+  :milestone_responsible_user_id => 123
+})
+teamleader.update_project({
+  :project_id => 123,
+  :track_changes => 0,
+  :title => "New Project Title"
+})
+teamleader.get_projects({ :amount => 50, pageno: 0 })
+# Pagination starts at 0
+```
 ### Tickets
 
 Supported methods are: `add_ticket`, `update_ticket`, `add_ticket_message`, `get_tickets`, `get_ticket`, `get_ticket_messages`, `get_ticket_message`, `get_ticket_cloud_url`.
@@ -110,6 +150,30 @@ Supported methods are: `add_ticket`, `update_ticket`, `add_ticket_message`, `get
 
 Supported methods are: `add_note`, `get_notes`
 
+### Files
+
+```ruby
+teamleader.get_file_info({ :file_id => '1236412' })
+
+teamleader.download_file({ :file_id => '1236412' })
+
+teamleader.upload_file({
+  :object_type => 'company',
+  :object_id => '1236412',
+  :file_content => 'Base64 encoded version the file',
+  :file_name => 'file.rb'
+})
+
+teamleader.delete_file({ :file_id => '1236412' })
+
+teamleader.get_files({
+  :amount => 100,
+  :pageno => 0,
+  :object_type => 'contact',
+  :object_id => '1234567')
+# Pagination starts at 0
+```
+
 ## License
 The Teamleader GEM is released under the MIT License.
 

data/lib/teamleader/api/files.rb

@@ -0,0 +1,28 @@
+module Teamleader
+  module Files
+    def get_files(params={})
+      required_params(%i[amount pageno object_type object_id], params)
+      request '/getFiles.php', params
+    end
+
+    def get_file_info(params={})
+      required_params(%i[file_id], params)
+      request '/getFileInfo.php', params
+    end
+
+    def download_file(params={})
+      required_params(%i[file_id], params)
+      request '/downloadFile.php', params
+    end
+
+    def upload_file(params={})
+      required_params(%i[object_type object_id file_content file_name], params)
+      request '/uploadFile.php', params
+    end
+
+    def delete_file(params={})
+      required_params(%i[file_id], params)
+      request '/deleteFile.php', params
+    end
+  end
+end

data/lib/teamleader/api/projects.rb

@@ -0,0 +1,30 @@
+module Teamleader
+  module Projects
+    def get_project(params={})
+      required_params(%i[project_id], params)
+      request '/getProject.php', params
+    end
+
+    def get_projects(params={})
+      required_params(%i[amount pageno], params)
+      request '/getProjects.php', params
+    end
+
+    def get_projects_by_client(params={})
+      required_params(%i[contact_or_company contact_or_company_id deep_search], params)
+      request '/getProjectsByClient.php', params
+    end
+
+    def add_project(params={})
+      required_params(%i[project_name project_budget project_responsible_user_id project_start_date
+         milestone_title milestone_budget milestone_invoiceable milestone_due_date
+         milestone_responsible_user_id], params)
+      request '/addProject.php', params
+    end
+
+    def update_project(params={})
+      required_params(%i[project_id track_changes title], params)
+      request '/updateProject.php', params
+    end
+  end
+end

data/lib/teamleader/api.rb

@@ -7,6 +7,9 @@ module Teamleader
   API_BASE_URL = "https://app.teamleader.eu/api"
 
   class Api
+    include Teamleader::Files
+    include Teamleader::Projects
+
     def initialize(group, secret)
       @api_group = group
       @api_secret = secret
@@ -98,7 +101,7 @@ module Teamleader
     end
 
     def get_deals(params={})
-      raise "mount is required" if params[:mount].nil?
+      raise "amount is required" if params[:amount].nil?
       raise "pageno is required" if params[:pageno].nil?
       request "/getDeals.php", params
     end
@@ -372,6 +375,7 @@ module Teamleader
     end
 
     private
+
     def request(path, data={})
       headers = {
         "Content-Type" => "application/x-www-form-urlencoded"
@@ -399,5 +403,9 @@ module Teamleader
         raise "HTTP Error #{code}: " + err
       end
     end
+
+    def required_params(attributes, params)
+      attributes.each { |attr| raise "#{attr} is required" if params[attr].nil? }
+    end
   end
 end

data/lib/teamleader/configuration.rb

@@ -0,0 +1,8 @@
+class Configuration
+  attr_accessor :api_group, :api_secret
+
+  def initialize
+    @api_group = 'Your API group'
+    @api_secret = 'Your API secret'
+  end
+end

data/lib/teamleader/version.rb

@@ -1,3 +1,3 @@
 module Teamleader
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
 end

data/lib/teamleader.rb

@@ -1,11 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/api/files'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/api/projects'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/api'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/extended_api'))
 require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/version'))
+require File.expand_path(File.join(File.dirname(__FILE__), 'teamleader/configuration'))
 
 module Teamleader
   extend self
+  attr_accessor :configuration
 
-  def new(group, secret)
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  def configure
+    yield(configuration)
+  end
+
+  def new(group = Teamleader.configuration.api_group, secret = Teamleader.configuration.api_secret)
     ExtendedApi.new(group, secret)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamleader
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Pierre-Yves Orban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,9 @@ files:
 - bin/setup
 - lib/teamleader.rb
 - lib/teamleader/api.rb
+- lib/teamleader/api/files.rb
+- lib/teamleader/api/projects.rb
+- lib/teamleader/configuration.rb
 - lib/teamleader/extended_api.rb
 - lib/teamleader/version.rb
 - teamleader.gemspec