cobot_client 4.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a30b5eca1e0c962124b7b58a2b2028b6844a74c
-  data.tar.gz: d9d307e97fda81cde1e3c857f22e159f9b995d42
+SHA256:
+  metadata.gz: 3d961f35435c958c2cf33b88170ce9f5c327f3ee57c332eb534b6b60098a86f1
+  data.tar.gz: 33c485cd858e729d508bd331897872f8d24345b75d1e4f192089e7bcfafc2793
 SHA512:
-  metadata.gz: 43f4f96b21d31aade0f682f2feb5e65c132663b2de2b3d6449697d9910e55cc789c94169c0305e5afd0a55495813e982799ee9aefea58c74b252572a71ca07d8
-  data.tar.gz: cc89589edc277e10173a2b1ce8a40e91b058de20afcac50ce6f93e759bb55ba7cb5472052430caf86ea221d6732e926055492b38c83ed4e752a5e139062005d5
+  metadata.gz: 101809ca57f22278713eeedd3f3f3f32c21552b2ed6e15189cb866f1d37d2d104c493acda5348e90dd187d3906e89c1290e35ec549f219caabd86d0adf2a9a5b
+  data.tar.gz: 27a001426e07ab13b48724219ae62b58e72a706b9547f4863b97f282c72568dff88657fbd0e380d3c2863e477524291cd8d851cb809c04428166e82199b526bd

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Push gem
+
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+      - name: Release gem
+        uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["4.0", "3.4", "3.3"]
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install RBS type declaration collection
+        run: bundle exec rbs collection install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
+
+/.gem_rbs_collection/
+/rbs_collection.lock.yaml

data/.rubocop.yml

@@ -0,0 +1,31 @@
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,11 +1,23 @@
+# 6.0.0
+
+- Drop support for EOL Rubies (< 3.3)
+- Add support for Ruby v4
+- Add RBS type declarations
+- Replace discontinued `Virtus` with `ActiveModel::Attributes`
+- Replace abandoned `rest-client` with `net/http`
+
+# 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_editable 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/Gemfile

@@ -1,4 +1,14 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cobot_client.gemspec
 gemspec
+
+gem 'rake', '~> 13.4'
+gem 'rbs'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'webmock', require: false

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/Rakefile

@@ -1,7 +1,11 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: :spec
+task default: %i[spec rubocop]

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.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "cobot_client"
-  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  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 'rest-client', '~>2.0.1'
+  gem.required_ruby_version = ['>=3.3', '<5']
+
+  gem.add_dependency 'activemodel', '>=5.2'
   gem.add_dependency 'json', '~>2.0'
-  gem.add_development_dependency 'rspec', '~>3.0'
-  gem.add_development_dependency 'rake', '~>10.0'
+  gem.add_dependency 'oauth2', '~>2.0'
+
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/cobot_client/api_client.rb

@@ -1,5 +1,4 @@
-require 'rest_client'
-require 'json'
+# frozen_string_literal: true
 
 module CobotClient
   class ApiClient
@@ -8,127 +7,69 @@ module CobotClient
     class << self
       attr_accessor :user_agent, :retry_time
     end
+
     self.retry_time = 1
 
     def initialize(access_token)
       @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
+    def post(*)
+      request(:post, *).parsed_body
     end
 
     # args: either a full URL or subdomain, path, plus a body as hash
-    def put(*args)
-      request :put, *args
+    def put(*)
+      request(:put, *).parsed_body
     end
 
-    def patch(*args)
-      request :patch, *args
+    def patch(*)
+      request(:patch, *).parsed_body
     end
 
     # args: either a full URL or subdomain, path, plus an optional params hash
-    def get(*args)
-      url, subdomain, path, params = parse_args(*args)
-      JSON.parse(
-        rewrap_errors do
-          RestClient.get(
-            build_url(url || subdomain, path, params),
-            headers).body
-        end, symbolize_names: true)
+    def get(*)
+      request(:get, *).parsed_body
     end
 
     # args: either a full URL or subdomain, path
-    def delete(*args)
-      url, subdomain, path, _ = parse_args(*args)
-      rewrap_errors do
-        RestClient.delete(build_url(url || subdomain, path), headers)
-      end
+    def delete(*)
+      request(:delete, *)
     end
 
     private
 
-    def request(method, *args)
-      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))
-        JSON.parse response.body, symbolize_names: true unless response.code == 204
+    def request(method, *)
+      request = Request.new(method, *)
+      request.headers = headers
+
+      retry_errors do
+        request.submit
       end
     end
 
-    def rewrap_errors(&block)
-      retry_errors(&block)
-    rescue RestClient::Exception => e
-      fail CobotClient::Exceptions::EXCEPTIONS_MAP[e.class].new(e.response)
+    def rewrap_errors
+      yield.tap do |response|
+        raise response.to_error if response.client_error? || response.server_error?
+      end
+    rescue Net::ProtocolError, SocketError, Timeout::Error => e
+      raise ConnectionError, "#{e.class}: #{e.message}"
     end
 
-    def retry_errors
+    def retry_errors(&)
       retries = 0
       begin
-        yield
-      rescue RestClient::BadGateway, SocketError, RestClient::RequestTimeout, CobotClient::InternalServerError => e
-        if retries < 3
-          sleep self.class.retry_time
-          retries += 1
-          retry
-        else
-          raise e
-        end
-      end
-    end
-
-    def parse_args(*args)
-      if args.size == 3 || (args.size == 2 && args[0].match(%r{https?://}))
-        params = args.pop
-      else
-        params = {}
-      end
-      if args.size == 1
-        url = args[0]
-        path = nil
-        subdomain = nil
-      else
-        subdomain = args[0]
-        path = args[1]
-        url = nil
-      end
-      [url, subdomain, path, params]
-    end
+        rewrap_errors(&)
+      rescue ConnectionError, BadGateway, InternalServerError => e
+        raise e unless retries < 3
 
-    def build_url(subdomain_or_url, path, params = {})
-      if path
-        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.to_s
+        sleep self.class.retry_time
+        retries += 1
+        retry
       end
     end
 
-    def content_type_header
-      {'Content-Type' => 'application/json'}
-    end
-
     def headers
       {
         'Authorization' => "Bearer #{@access_token}",

data/lib/cobot_client/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CobotClient
   class Engine < Rails::Engine
     isolate_namespace CobotClient

data/lib/cobot_client/errors.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module CobotClient
+  class Error < StandardError; end
+
+  class ConnectionError < Error; end
+
+  class ResponseError < Error
+    HTTP_CODE = nil
+
+    attr_reader :response
+
+    def self.build(msg = nil, response:)
+      RESPONSE_CODE_TO_ERROR_CLASS
+        .fetch(response.code, self)
+        .new(msg, response: response)
+    end
+
+    def initialize(msg = nil, response: nil)
+      @response = response
+
+      super(
+        [
+          "HTTP #{http_code}",
+          msg
+        ].compact.join(' - ')
+      )
+    end
+
+    def http_body
+      @response&.body
+    end
+
+    def http_code
+      @response&.code || self.class.const_get(:HTTP_CODE)
+    end
+  end
+
+  RESPONSE_CODE_TO_ERROR_CLASS = ::Net::HTTPResponse::CODE_TO_OBJ.to_h do |code, net_http_class|
+    class_name = net_http_class.name.delete_prefix('Net::HTTP')
+
+    class_object = Class.new(ResponseError)
+    class_object.const_get(:HTTP_CODE, code)
+
+    [code.to_i, const_set(class_name, class_object)]
+  end
+end

data/lib/cobot_client/navigation_link.rb

@@ -1,11 +1,14 @@
-require 'virtus'
+# frozen_string_literal: true
 
-class CobotClient::NavigationLink
-  include Virtus.model
+module CobotClient
+  class NavigationLink
+    include ActiveModel::Model
+    include ActiveModel::Attributes
 
-  attribute :section, String
-  attribute :label, String
-  attribute :iframe_url, String
-  attribute :user_url, String
-  attribute :user_editable, Boolean, default: true
+    attribute :section, :string
+    attribute :label, :string
+    attribute :iframe_url, :string
+    attribute :user_url, :string
+    attribute :user_editable, :boolean, default: true
+  end
 end

data/lib/cobot_client/navigation_link_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'oauth2'
 
 module CobotClient
@@ -5,9 +7,9 @@ module CobotClient
   class NavigationLinkService
     # api_client - an CobotClient::ApiClient
     # access_token - an access token string (owner must be admin of the space to be used)
-    def initialize(api_client, space_sudomain)
+    def initialize(api_client, space_subdomain)
       @api_client = api_client
-      @subdomain = space_sudomain
+      @subdomain = space_subdomain
     end
 
     # Checks if links are already installed and if not installs them.
@@ -16,7 +18,7 @@ module CobotClient
     #
     # Returns the links as `[CobotClient::NavigationLink]`
     def install_links(new_links)
-      existing_links = get_links
+      existing_links = fetch_links
       missing_links = new_links.reject do |new_link|
         existing_links.find do |existing_link|
           existing_link.section == new_link.section && existing_link.iframe_url == new_link.iframe_url
@@ -30,18 +32,21 @@ module CobotClient
 
     private
 
-    def get_links
+    def fetch_links
       @api_client.get(@subdomain, '/navigation_links').map do |attributes|
         NavigationLink.new attributes
       end
     end
 
     def create_link(link)
-      response = @api_client.post(@subdomain, '/navigation_links',
+      response = @api_client.post(
+        @subdomain,
+        '/navigation_links',
         section: link.section,
         label: link.label,
         iframe_url: link.iframe_url,
-        user_editable: link.user_editable)
+        user_editable: link.user_editable
+      )
 
       NavigationLink.new response
     end

data/lib/cobot_client/request.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module CobotClient
+  class Request
+    include UrlHelper
+
+    CONTENT_TYPE_HEADER = {'Content-Type' => 'application/json'}.freeze
+    VERBS = %i[get post put patch delete].freeze
+
+    attr_reader :body, :headers, :uri, :verb
+
+    def initialize(verb, *)
+      raise ArgumentError, "Unsupported verb: #{verb.inspect}" unless VERBS.include?(verb)
+
+      @verb = verb
+      @headers = CONTENT_TYPE_HEADER
+
+      url, subdomain, path, params = parse_args(*)
+      @uri, @body = case @verb
+                    when :get, :delete
+                      [build_uri(url || subdomain, path, **params), nil]
+                    else
+                      [build_uri(url || subdomain, path), params.to_json]
+                    end
+    end
+
+    def headers=(headers)
+      raise ArgumentError, "Expected Hash, got: #{headers.inspect}" unless headers.is_a?(Hash)
+
+      @headers = headers.merge(CONTENT_TYPE_HEADER)
+    end
+
+    def submit
+      Response.new(
+        http.request(net_http_request)
+      )
+    end
+
+    private
+
+    def build_uri(subdomain_or_url, path, **params)
+      if path
+        cobot_uri(subdomain_or_url, "/api#{path}", params: params)
+      else
+        uri = URI.parse(subdomain_or_url)
+        uri.query = URI.encode_www_form(params) unless params.empty?
+        uri
+      end
+    end
+
+    def http
+      @http ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
+        http.use_ssl = (uri.scheme == 'https')
+      end
+    end
+
+    # Do not memoize this because `headers` can change
+    def net_http_request
+      request_class.new(uri).tap do |request|
+        request.body = body if body
+        request.initialize_http_header(headers)
+      end
+    end
+
+    def request_class
+      case @verb
+      when :get then Net::HTTP::Get
+      when :post then Net::HTTP::Post
+      when :put then Net::HTTP::Put
+      when :patch then Net::HTTP::Patch
+      when :delete then Net::HTTP::Delete
+      end
+    end
+
+    def parse_args(*args)
+      params = if args.size == 3 || (args.size == 2 && args[0].match(%r{https?://}))
+                 args.pop
+               else
+                 {}
+               end
+
+      if args.size == 1
+        [args[0], nil, nil, params]
+      else
+        [nil, args[0], args[1], params]
+      end
+    end
+  end
+end