cobot_client 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6d346613c7908a049ea953b3c5eb0eef38ae647246ad9d1bb41d863f7cc104
-  data.tar.gz: aaa52ccc3005e510d3a63ce9cf736a60ed21ba889c42c7ecaee1e3854a32bb3a
+  metadata.gz: 3d961f35435c958c2cf33b88170ce9f5c327f3ee57c332eb534b6b60098a86f1
+  data.tar.gz: 33c485cd858e729d508bd331897872f8d24345b75d1e4f192089e7bcfafc2793
 SHA512:
-  metadata.gz: 14c6d70b7fef964d12e23f28745bcf33dd4932c6381d2293475e77783f78338357430cc7e0ca98d70f726f826b941f9e4193b107900677f3bca444f24150321c
-  data.tar.gz: 611a43d02024876126f81d171ec86cc9426ba858767eb2385e435774bab2bbb4fdb5f8328dbc8bd4dace0451054d3f3bc48ad241188b66b31cf2ec584fb74a44
+  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,3 +1,11 @@
+# 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.
@@ -8,7 +16,7 @@ Bump oauth2 dependency to ~>2.0.
 
 # 3.1.0
 
-- adds user_edtiable attribute to navigation links
+- adds user_editable attribute to navigation links
 
 # 3.0.0
 

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

@@ -12,15 +12,15 @@ Gem::Specification.new do |gem|
 
   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.version       = CobotClient::VERSION
 
-  gem.add_dependency 'virtus', '~>1.0'
-  gem.add_dependency 'oauth2', '~>2.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', '~>12.3.3'
+  gem.add_dependency 'oauth2', '~>2.0'
+
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/cobot_client/api_client.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'rest_client'
-require 'json'
-
 module CobotClient
   class ApiClient
     include UrlHelper
@@ -10,6 +7,7 @@ module CobotClient
     class << self
       attr_accessor :user_agent, :retry_time
     end
+
     self.retry_time = 1
 
     def initialize(access_token)
@@ -17,106 +15,61 @@ module CobotClient
     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
-      raise CobotClient::Exceptions::EXCEPTIONS_MAP[e.class], 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)
-      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
-        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&.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

data/lib/cobot_client/response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CobotClient
+  class Response
+    def initialize(net_http_response)
+      @net_http_response = net_http_response
+    end
+
+    def body
+      @net_http_response.body
+    end
+
+    def headers
+      @net_http_response.to_hash
+    end
+
+    def code
+      Integer(@net_http_response.code)
+    end
+
+    def parsed_body
+      return if !success? || code == 204
+
+      JSON.parse(@net_http_response.body, symbolize_names: true)
+    end
+
+    def client_error?
+      (400..499).cover?(code)
+    end
+
+    def server_error?
+      (500..599).cover?(code)
+    end
+
+    def success?
+      (200..299).cover?(code)
+    end
+
+    def to_error
+      return if success?
+
+      ResponseError.build(@net_http_response.message, response: self)
+    end
+  end
+end

data/lib/cobot_client/url_helper.rb

@@ -1,28 +1,31 @@
-require 'uri'
+# frozen_string_literal: true
 
-module CobotClient::UrlHelper
-  # set this to override the site for accessing the cobot api
+module CobotClient
+  module UrlHelper
+    DEFAULT_SITE = 'https://www.cobot.me'
 
-  @@site = 'https://www.cobot.me'
-  def self.site
-    @@site
-  end
+    # set this to override the site for accessing the cobot api
+    def self.site
+      @site || DEFAULT_SITE
+    end
 
-  def self.site=(site)
-    @@site = site
-  end
+    def self.site=(site)
+      @site = site
+    end
 
-  # generates a url to access the cobot api
-  # see the spec for usage examples
-  def cobot_url(subdomain = 'www', *path_options)
-    path = path_options.first.is_a?(String) ? path_options.first : '/'
-    options = path_options.find{|p| p.is_a?(Hash)} || {}
+    # generates a uri to access the cobot api
+    # see the spec for usage examples
+    def cobot_uri(subdomain = 'www', path = '/', params: {}, **)
+      uri = URI.parse(CobotClient::UrlHelper.site)
+      uri.host = uri.host.split('.').tap { |parts| parts[0] = subdomain }.join('.')
+      uri.path = path
+      uri.query = URI.encode_www_form(params) unless params.empty?
 
-    url = URI.parse(CobotClient::UrlHelper.site)
-    url.host = url.host.split('.').tap{|parts| parts[0] = subdomain}.join('.')
-    url.path = path
-    url.query = URI.encode_www_form(options[:params]) if options[:params] && options[:params].any?
+      uri
+    end
 
-    url.to_s
+    def cobot_url(subdomain = 'www', path = '/', params: {}, **)
+      cobot_uri(subdomain, path, params: params, **).to_s
+    end
   end
 end

data/lib/cobot_client/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CobotClient
-  VERSION = '5.0.0'
+  VERSION = '6.0.0'
 end

data/lib/cobot_client.rb

@@ -1,10 +1,20 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+require 'active_model'
+
 require 'cobot_client/version'
 require 'cobot_client/engine' if defined?(Rails)
-require 'cobot_client/exceptions'
+require 'cobot_client/errors'
 
 module CobotClient
   autoload :ApiClient, 'cobot_client/api_client'
   autoload :NavigationLink, 'cobot_client/navigation_link'
   autoload :NavigationLinkService, 'cobot_client/navigation_link_service'
+  autoload :Response, 'cobot_client/response'
+  autoload :Request, 'cobot_client/request'
   autoload :UrlHelper, 'cobot_client/url_helper'
 end