cobot_client 4.0.0 → 6.0.0

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 = '4.0.0'
+  VERSION = '6.0.0'
 end

data/lib/cobot_client.rb

@@ -1,11 +1,20 @@
-require "cobot_client/version"
+# 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'
-  autoload :XdmHelper, 'cobot_client/xdm_helper'
 end

data/rbs_collection.yaml

@@ -0,0 +1,20 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: auth-sanitizer
+    ignore: true # See: https://github.com/ruby-oauth/auth-sanitizer/pull/5
+  - name: snaky_hash
+    ignore: true # See: https://github.com/ruby-oauth/snaky_hash/pull/11

data/sig/cobot_client/api_client.rbs

@@ -0,0 +1,51 @@
+module CobotClient
+  class ApiClient
+    type headers = Hash[String, String]
+    type path = String
+    type request_params = parsed_json_object
+    type request_payload = (request_params | Array[request_params])
+    type parsed_json_object = Hash[Symbol, untyped]
+    type parsed_response_body = (parsed_json_object | Array[parsed_json_object])?
+    type subdomain = String
+    type url = String
+
+    @access_token: String
+
+    attr_accessor self.retry_time: Integer
+    attr_accessor self.user_agent: String
+
+    def initialize: (String) -> void
+
+    def delete:
+      (subdomain, path) -> Response |
+      (url) -> Response
+
+    def get:
+      (subdomain, path, ?request_payload) -> parsed_response_body |
+      (url, ?request_payload) -> parsed_response_body
+
+    def patch:
+      (subdomain, path, ?request_payload) -> parsed_response_body |
+      (url, ?request_payload) -> parsed_response_body
+
+    def post:
+      (subdomain, path, ?request_payload) -> parsed_response_body |
+      (url, ?request_payload) -> parsed_response_body
+
+    def put:
+      (subdomain, path, ?request_payload) -> parsed_response_body |
+      (url, ?request_payload) -> parsed_response_body
+
+    private
+
+    def headers: -> headers
+
+    def request:
+      (Request::verb, subdomain, path, ?request_payload) -> Response |
+      (Request::verb, url, ?request_payload) -> Response
+
+    def retry_errors: [R] () { () -> R } -> R
+
+    def rewrap_errors: () { () -> Response } -> Response
+  end
+end

data/sig/cobot_client/errors.rbs

@@ -0,0 +1,23 @@
+module CobotClient
+  class Error < StandardError
+  end
+
+  class ConnectionError < StandardError
+  end
+
+  class ResponseError < Error
+    HTTP_CODE: Integer?
+
+    def self.build: (String?, response: Response) -> ResponseError
+
+    attr_reader response: Response?
+
+    def initialize: (String?, ?response: Response?) -> void
+
+    def http_body: -> String?
+
+    def http_code: -> Integer?
+  end
+
+  RESPONSE_CODE_TO_ERROR_CLASS: Hash[Integer, singleton(ResponseError)]
+end

data/sig/cobot_client/navigation_link.rbs

@@ -0,0 +1,11 @@
+module CobotClient
+  class NavigationLink
+    attr_accessor section: String
+    attr_accessor label: String
+    attr_accessor iframe_url: String
+    attr_accessor user_url: String
+    attr_accessor user_editable: bool
+
+    def initialize: (Hash[Symbol, untyped]) -> void
+  end
+end

data/sig/cobot_client/navigation_link_service.rbs

@@ -0,0 +1,17 @@
+module CobotClient
+  class NavigationLinkService
+    @api_client: ApiClient
+
+    @subdomain: String
+
+    def initialize: (ApiClient, String) -> void
+
+    def install_links: (Array[NavigationLink]) -> Array[NavigationLink]
+
+    private
+
+    def create_link: (NavigationLink) -> NavigationLink
+
+    def fetch_links: -> Array[NavigationLink]
+  end
+end

data/sig/cobot_client/request.rbs

@@ -0,0 +1,39 @@
+module CobotClient
+  class Request
+    type verb = Symbol
+
+    CONTENT_TYPE_HEADER: ApiClient::headers
+    VERBS: Array[verb]
+
+    @http: Net::HTTP
+
+    attr_reader body: String?
+    attr_reader headers: ApiClient::headers
+    attr_reader uri: URI::Generic
+    attr_reader verb: verb
+
+    def initialize:
+      (verb, ApiClient::subdomain, ApiClient::path, ?ApiClient::request_payload) -> void |
+      (verb, ApiClient::url, ?ApiClient::request_payload) -> void
+
+    def headers=: (ApiClient::headers) -> ApiClient::headers
+
+    def submit: -> Response
+
+    private
+
+    def build_uri: (ApiClient::subdomain | ApiClient::url, ApiClient::path?, **untyped) -> URI::Generic
+
+    def http: -> Net::HTTP
+
+    def net_http_request: -> Net::HTTPRequest
+
+    def parse_args:
+      (ApiClient::url) -> [ApiClient::url, nil, nil, ApiClient::request_payload] |
+      (ApiClient::url, ApiClient::request_payload) -> [ApiClient::url, nil, nil, ApiClient::request_payload] |
+      (ApiClient::subdomain, ApiClient::path) -> [nil, ApiClient::subdomain, ApiClient::path, ApiClient::request_payload] |
+      (ApiClient::subdomain, ApiClient::path, ApiClient::request_payload) -> [nil, ApiClient::subdomain, ApiClient::path, ApiClient::request_payload]
+
+    def request_class: -> singleton(Net::HTTPRequest)
+  end
+end

data/sig/cobot_client/response.rbs

@@ -0,0 +1,23 @@
+module CobotClient
+  class Response
+    @net_http_response: Net::HTTPResponse
+
+    def initialize: (Net::HTTPResponse) -> void
+
+    def body: -> String
+
+    def client_error?: -> bool
+
+    def code: -> Integer
+
+    def headers: -> ApiClient::headers
+
+    def parsed_body: -> ApiClient::parsed_response_body
+
+    def server_error?: -> bool
+
+    def success?: -> bool
+
+    def to_error: -> ResponseError?
+  end
+end

data/sig/cobot_client/url_helper.rbs

@@ -0,0 +1,25 @@
+module CobotClient
+  module UrlHelper
+    DEFAULT_SITE: String
+
+    self.@site: String
+
+    def self.site: -> String
+
+    def self.site=: (String) -> String
+
+    def cobot_uri:
+      () -> URI::Generic |
+      (ApiClient::subdomain) -> URI::Generic |
+      (ApiClient::subdomain, params: ApiClient::request_payload) -> URI::Generic |
+      (ApiClient::subdomain, ApiClient::path) -> URI::Generic |
+      (ApiClient::subdomain, ApiClient::path, params: ApiClient::request_payload) -> URI::Generic
+
+    def cobot_url:
+      () -> String |
+      (ApiClient::subdomain) -> String |
+      (ApiClient::subdomain, params: ApiClient::request_payload) -> String |
+      (ApiClient::subdomain, ApiClient::path) -> String |
+      (ApiClient::subdomain, ApiClient::path, params: ApiClient::request_payload) -> String
+  end
+end

data/sig/cobot_client/version.rbs

@@ -0,0 +1,3 @@
+module CobotClient
+  VERSION: String
+end

data/sig/manifests.yaml

@@ -0,0 +1,4 @@
+dependencies:
+  - name: json
+  - name: net/http
+  - name: uri