cobot_client 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a30b5eca1e0c962124b7b58a2b2028b6844a74c
-  data.tar.gz: d9d307e97fda81cde1e3c857f22e159f9b995d42
+SHA256:
+  metadata.gz: de6d346613c7908a049ea953b3c5eb0eef38ae647246ad9d1bb41d863f7cc104
+  data.tar.gz: aaa52ccc3005e510d3a63ce9cf736a60ed21ba889c42c7ecaee1e3854a32bb3a
 SHA512:
-  metadata.gz: 43f4f96b21d31aade0f682f2feb5e65c132663b2de2b3d6449697d9910e55cc789c94169c0305e5afd0a55495813e982799ee9aefea58c74b252572a71ca07d8
-  data.tar.gz: cc89589edc277e10173a2b1ce8a40e91b058de20afcac50ce6f93e759bb55ba7cb5472052430caf86ea221d6732e926055492b38c83ed4e752a5e139062005d5
+  metadata.gz: 14c6d70b7fef964d12e23f28745bcf33dd4932c6381d2293475e77783f78338357430cc7e0ca98d70f726f826b941f9e4193b107900677f3bca444f24150321c
+  data.tar.gz: 611a43d02024876126f81d171ec86cc9426ba858767eb2385e435774bab2bbb4fdb5f8328dbc8bd4dace0451054d3f3bc48ad241188b66b31cf2ec584fb74a44

data/CHANGELOG.md

@@ -1,11 +1,15 @@
+# 5.0.0
+
+Bump oauth2 dependency to ~>2.0.
+
 # 4.0.0
 
-*   changed navigation link service to add missing links and return all if there are links already (before it would do nothing if there were any links already)
+- changed navigation link service to add missing links and return all if there are links already (before it would do nothing if there were any links already)
 
 # 3.1.0
 
-*   adds user_edtiable attribute to navigation links
+- adds user_edtiable attribute to navigation links
 
 # 3.0.0
 
-*   bumps rest-client to ~2.0.1, which results in CobotClient::ResourceNotFound to be renamed to CobotClient::NotFound (FrauBienenstich)
+- bumps rest-client to ~2.0.1, which results in CobotClient::ResourceNotFound to be renamed to CobotClient::NotFound (FrauBienenstich)

data/README.md

@@ -24,9 +24,11 @@ Or install it yourself as:
 
 You can install links to your app into the navigation on Cobot. When users click the link an iframe pointing to the given `iframe_url` will be shown.
 
-    client = CobotClient::ApiClient.new <access token>
-    CobotClient::NavigationLinkService.new(client, 'co-up').install_links [
-      CobotClient::NavigationLink.new(section: 'admin/manage', label: 'My App', iframe_url: 'http://example.com')]
+```ruby
+client = CobotClient::ApiClient.new '<access token>'
+CobotClient::NavigationLinkService.new(client, 'co-up').install_links [
+  CobotClient::NavigationLink.new(section: 'admin/manage', label: 'My App', iframe_url: 'http://example.com')]
+```
 
 ### Setting up automatic iframe resizing
 
@@ -48,25 +50,61 @@ When you display layers in the iframe that are positioned relative to the window
 
 There is a module `CobotClient::UrlHelper`. After you include it you can call `cobot_url`. Examples:
 
-    cobot_url('co-up') # => 'https://co-up.cobot.me/'
-    cobot_url('co-up', '/api/user') # => 'https://co-up.cobot.me/api/user'
-    cobot_url('co-up', '/api/user', params: {x: 'y'}) # => 'https://co-up.cobot.me/api/user?x=y'
+```ruby
+cobot_url('co-up') # => 'https://co-up.cobot.me/'
+cobot_url('co-up', '/api/user') # => 'https://co-up.cobot.me/api/user'
+cobot_url('co-up', '/api/user', params: {x: 'y'}) # => 'https://co-up.cobot.me/api/user?x=y'
+```
 
 ### Calling the API
 
 At the moment there are only a few high-level methods. For more details see the specs.
 
-    client = CobotClient::ApiClient.new('<access token>')
-    client.list_resources('<subdomain>')
+```ruby
+client = CobotClient::ApiClient.new('<access token>')
+client.list_resources('<subdomain>')
+```
 
 For everything else you can use the low-level get/post/put/delete metods:
 
-    client.get 'www', '/user'
-    client.post 'my-subdomain', '/users', {"email": "joe@doe.com"}
+```ruby
+client.get 'www', '/user'
+client.post 'my-subdomain', '/users', {"email": "joe@doe.com"}
+```
 
 You can also pass a URL instead of subdomain/path:
 
-    client.get 'https://www/cobot.me/user'
+```ruby
+client.get 'https://www/cobot.me/user'
+```
+
+### Error handling
+
+In case of Cobot returning a 4xx or 5xx status code, the `ApiClient` throws an exception that is a subclass of `CobotClient::Exception`.
+
+The most common exceptions encountered are `CobotClient::NotFound` (404), `CobotClient::Forbidden` (403), `CobotClient::UnprocesseableEntity` (422) and `CobotClient::TooManyRequests` (429).
+
+To access the error message contained in the response, rescue the exception and `http_body` on it:
+
+```ruby
+begin
+  client = CobotClient::ApiClient.new('<access token>')
+  client.get('www', '/user')
+rescue CobotClient::Exception => e
+  puts JSON.parse(e.http_body)
+end
+```
+
+To access response headers, for example the `Retry-After` header of a rate-limited request:
+
+```ruby
+begin
+  client = CobotClient::ApiClient.new('<access token>')
+  client.get('www', '/user')
+rescue CobotClient::TooManyRequests => e
+  puts e.response.headers[:retry_after].to_i
+end
+```
 
 ## Contributing
 

data/cobot_client.gemspec

@@ -1,25 +1,26 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/cobot_client/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/cobot_client/version', __dir__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Alexander Lang"]
-  gem.email         = ["alex@cobot.me"]
-  gem.description   = %q{Client for the Cobot API plus helpers}
-  gem.summary       = %q{Client for the Cobot API plus helpers}
-  gem.homepage      = "http://github.com/cobot/cobot_client"
+  gem.authors       = ['Alexander Lang']
+  gem.email         = ['alex@cobot.me']
+  gem.description   = 'Client for the Cobot API plus helpers'
+  gem.summary       = 'Client for the Cobot API plus helpers'
+  gem.homepage      = 'http://github.com/cobot/cobot_client'
   gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "cobot_client"
-  gem.require_paths = ["lib"]
+  gem.name          = 'cobot_client'
+  gem.require_paths = ['lib']
   gem.version       = CobotClient::VERSION
 
   gem.add_dependency 'virtus', '~>1.0'
-  gem.add_dependency 'oauth2', '~>1.0'
+  gem.add_dependency 'oauth2', '~>2.0'
   gem.add_dependency 'rest-client', '~>2.0.1'
   gem.add_dependency 'json', '~>2.0'
   gem.add_development_dependency 'rspec', '~>3.0'
-  gem.add_development_dependency 'rake', '~>10.0'
+  gem.add_development_dependency 'rake', '~>12.3.3'
 end

data/lib/cobot_client/api_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest_client'
 require 'json'
 
@@ -14,22 +16,6 @@ module CobotClient
       @access_token = access_token
     end
 
-    def get_resources(subdomain)
-      get subdomain, '/resources'
-    end
-
-    def create_booking(subdomain, resource_id, attributes)
-      post subdomain, "/resources/#{resource_id}/bookings", attributes
-    end
-
-    def update_booking(subdomain, id, attributes)
-      put subdomain, "/bookings/#{id}", attributes
-    end
-
-    def delete_booking(subdomain, id)
-      delete subdomain, "/bookings/#{id}"
-    end
-
     # args: either a full URL or subdomain, path, plus a body as hash
     def post(*args)
       request :post, *args
@@ -51,13 +37,15 @@ module CobotClient
         rewrap_errors do
           RestClient.get(
             build_url(url || subdomain, path, params),
-            headers).body
-        end, symbolize_names: true)
+            headers
+          ).body
+        end, symbolize_names: true
+      )
     end
 
     # args: either a full URL or subdomain, path
     def delete(*args)
-      url, subdomain, path, _ = parse_args(*args)
+      url, subdomain, path, = parse_args(*args)
       rewrap_errors do
         RestClient.delete(build_url(url || subdomain, path), headers)
       end
@@ -69,9 +57,9 @@ module CobotClient
       url, subdomain, path, body = parse_args(*args)
       rewrap_errors do
         response = RestClient.public_send(method,
-          build_url(url || subdomain, path),
-          body.to_json,
-          headers.merge(content_type_header))
+                                          build_url(url || subdomain, path),
+                                          body.to_json,
+                                          headers.merge(content_type_header))
         JSON.parse response.body, symbolize_names: true unless response.code == 204
       end
     end
@@ -79,7 +67,7 @@ module CobotClient
     def rewrap_errors(&block)
       retry_errors(&block)
     rescue RestClient::Exception => e
-      fail CobotClient::Exceptions::EXCEPTIONS_MAP[e.class].new(e.response)
+      raise CobotClient::Exceptions::EXCEPTIONS_MAP[e.class], e.response
     end
 
     def retry_errors
@@ -98,11 +86,11 @@ module CobotClient
     end
 
     def parse_args(*args)
-      if args.size == 3 || (args.size == 2 && args[0].match(%r{https?://}))
-        params = args.pop
-      else
-        params = {}
-      end
+      params = if args.size == 3 || (args.size == 2 && args[0].match(%r{https?://}))
+                 args.pop
+               else
+                 {}
+               end
       if args.size == 1
         url = args[0]
         path = nil
@@ -120,13 +108,13 @@ module CobotClient
         cobot_url(subdomain_or_url, "/api#{path}", params: params)
       else
         uri = URI.parse(subdomain_or_url)
-        uri.query = URI.encode_www_form(params) if params && params.any?
+        uri.query = URI.encode_www_form(params) if params&.any?
         uri.to_s
       end
     end
 
     def content_type_header
-      {'Content-Type' => 'application/json'}
+      { 'Content-Type' => 'application/json' }
     end
 
     def headers

data/lib/cobot_client/version.rb

@@ -1,3 +1,3 @@
 module CobotClient
-  VERSION = '4.0.0'
+  VERSION = '5.0.0'
 end

data/lib/cobot_client.rb

@@ -1,4 +1,4 @@
-require "cobot_client/version"
+require 'cobot_client/version'
 require 'cobot_client/engine' if defined?(Rails)
 require 'cobot_client/exceptions'
 
@@ -7,5 +7,4 @@ module CobotClient
   autoload :NavigationLink, 'cobot_client/navigation_link'
   autoload :NavigationLinkService, 'cobot_client/navigation_link_service'
   autoload :UrlHelper, 'cobot_client/url_helper'
-  autoload :XdmHelper, 'cobot_client/xdm_helper'
 end

data/spec/cobot_client/api_client_spec.rb

@@ -9,71 +9,6 @@ describe CobotClient::ApiClient do
     CobotClient::ApiClient.retry_time = 0
   end
 
-  context 'listing resources' do
-    it 'calls rest client' do
-      expect(RestClient).to receive(:get).with('https://co-up.cobot.me/api/resources',
-        hash_including('Authorization' => 'Bearer token-123')) { default_response }
-
-      api_client.get_resources 'co-up'
-    end
-
-    it 'returns the json' do
-      allow(RestClient).to receive(:get) { double(:response, body: [{id: 'resource-1'}].to_json) }
-
-      resources = api_client.get_resources 'co-up'
-
-      expect(resources).to eql([{id: 'resource-1'}])
-    end
-  end
-
-  context 'creating a booking' do
-    it 'calls rest client' do
-      expect(RestClient).to receive(:post).with(
-        'https://co-up.cobot.me/api/resources/res-1/bookings',
-        {title: 'meeting'}.to_json,
-        hash_including('Authorization' => 'Bearer token-123')) { default_response }
-
-      api_client.create_booking 'co-up', 'res-1', title: 'meeting'
-    end
-
-    it 'returns the json' do
-      allow(RestClient).to receive(:post) { double(:response,
-        code: 201, body: {title: 'meeting'}.to_json) }
-
-      booking = api_client.create_booking 'co-up', 'res-1', title: 'meeting'
-
-      expect(booking).to eql({title: 'meeting'})
-    end
-  end
-
-  context 'updating a booking' do
-    it 'calls rest client' do
-      expect(RestClient).to receive(:put).with('https://co-up.cobot.me/api/bookings/booking-1',
-        {title: 'meeting'}.to_json,
-        hash_including('Authorization' => 'Bearer token-123')) { default_response }
-
-      api_client.update_booking 'co-up', 'booking-1', title: 'meeting'
-    end
-
-    it 'returns the json' do
-      allow(RestClient).to receive(:put) { double(:response, code: 200,
-        body: {title: 'meeting'}.to_json) }
-
-      booking = api_client.update_booking 'co-up', 'booking-1', title: 'meeting'
-
-      expect(booking).to eql({title: 'meeting'})
-    end
-  end
-
-  context 'deleting a booking' do
-    it 'calls rest client' do
-      expect(RestClient).to receive(:delete).with('https://co-up.cobot.me/api/bookings/booking-1',
-        hash_including('Authorization' => 'Bearer token-123')) { default_response }
-
-      api_client.delete_booking 'co-up', 'booking-1'
-    end
-  end
-
   context '#put' do
     it 'calls rest client' do
       expect(RestClient).to receive(:put).with(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobot_client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Alexander Lang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 description: Client for the Cobot API plus helpers
 email:
 - alex@cobot.me
@@ -141,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Client for the Cobot API plus helpers