Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: 0.1.0-alpha.30 #178

Merged
merged 15 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "0.1.0-alpha.29"
".": "0.1.0-alpha.30"
}
10 changes: 10 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ Lint/MissingSuper:
Lint/UnusedMethodArgument:
AutoCorrect: false

# This option is prone to causing accidental bugs.
Lint/UselessAssignment:
AutoCorrect: false
Exclude:
- "examples/**/*.rb"

Metrics/AbcSize:
Enabled: false

Expand Down Expand Up @@ -229,6 +235,10 @@ Style/RegexpLiteral:
Style/SafeNavigation:
Enabled: false

Style/SignalException:
Exclude:
- Rakefile

# We use these sparingly, where we anticipate future branches for the
# inner conditional.
Style/SoleNestedConditional:
Expand Down
4 changes: 3 additions & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
configured_endpoints: 103
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-36a6db97756e8658369c9af3c0ac532ecacb032e5b8f6211094dcb4052943ff3.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-95a3d7780935a38e0cf076d4ad2d68bd1a5641bced8398d972db2e92751d364a.yml
openapi_spec_hash: 9ebe818c4ad4f2d9c4e473b5192d7544
config_hash: ec4f1e02d3528e3a93a73e33bca17c2a
1 change: 1 addition & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
--markup markdown
--markup-provider redcarpet
--exclude /rbi
--exclude /sig
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Changelog

## 0.1.0-alpha.30 (2025-04-01)

Full Changelog: [v0.1.0-alpha.29...v0.1.0-alpha.30](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.29...v0.1.0-alpha.30)

### Bug Fixes

* switch to github compatible markdown engine ([#189](https://github.com/orbcorp/orb-ruby/issues/189)) ([d7fc30d](https://github.com/orbcorp/orb-ruby/commit/d7fc30ddbf8ff3310c14184dea09dd1c54f29f2d))


### Chores

* disable dangerous rubocop auto correct rule ([#180](https://github.com/orbcorp/orb-ruby/issues/180)) ([0fdaa59](https://github.com/orbcorp/orb-ruby/commit/0fdaa59ee48e9a3e5563c209eb1fc1a4535f5897))
* **internal:** codegen related update ([#179](https://github.com/orbcorp/orb-ruby/issues/179)) ([7946e79](https://github.com/orbcorp/orb-ruby/commit/7946e79a28f9451e9c4bd00d43333734e7f5c4a6))
* **internal:** codegen related update ([#184](https://github.com/orbcorp/orb-ruby/issues/184)) ([ecaf100](https://github.com/orbcorp/orb-ruby/commit/ecaf100bea5029971bcf424a48fe5fe241a433b4))
* **internal:** minor refactoring of utils ([#183](https://github.com/orbcorp/orb-ruby/issues/183)) ([3ac6554](https://github.com/orbcorp/orb-ruby/commit/3ac65546773f869f554233156f4c958b1a1d0810))
* **internal:** version bump ([#177](https://github.com/orbcorp/orb-ruby/issues/177)) ([adbaaa7](https://github.com/orbcorp/orb-ruby/commit/adbaaa7ee0d790f72fa67d6f2b7e5b12ff2314c2))
* more accurate type annotations for SDK internals ([#187](https://github.com/orbcorp/orb-ruby/issues/187)) ([76fc06e](https://github.com/orbcorp/orb-ruby/commit/76fc06e5b6566c63b7521db57089112014b507c3))
* more readable output when tests fail ([#181](https://github.com/orbcorp/orb-ruby/issues/181)) ([8310ee4](https://github.com/orbcorp/orb-ruby/commit/8310ee4c764c7edec013d71b07dac2c6025df5a7))
* re-order assignment lines to make unions easier to read ([#182](https://github.com/orbcorp/orb-ruby/issues/182)) ([384e751](https://github.com/orbcorp/orb-ruby/commit/384e751c5f36eec90e1e31b6a6110abe22ed0890))
* relocate internal modules ([#186](https://github.com/orbcorp/orb-ruby/issues/186)) ([b939695](https://github.com/orbcorp/orb-ruby/commit/b9396955c4ae4b18356218fb1742c6518e3ad37e))
* remove unnecessary & confusing module ([#185](https://github.com/orbcorp/orb-ruby/issues/185)) ([aa3588c](https://github.com/orbcorp/orb-ruby/commit/aa3588c525b6f62bda302bd3ad80228035972448))
* update readme ([#188](https://github.com/orbcorp/orb-ruby/issues/188)) ([6a671ec](https://github.com/orbcorp/orb-ruby/commit/6a671ec91b3f11cd3a7a4e1359d795e8d2fdf22c))

## 0.1.0-alpha.29 (2025-03-21)

Full Changelog: [v0.1.0-alpha.28...v0.1.0-alpha.29](https://github.com/orbcorp/orb-ruby/compare/v0.1.0-alpha.28...v0.1.0-alpha.29)
Expand Down
19 changes: 13 additions & 6 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,6 @@ source "https://rubygems.org"
gemspec

group :development do
gem "async"
gem "minitest"
gem "minitest-focus"
gem "minitest-hooks"
gem "minitest-proveit"
gem "minitest-rg"
gem "rake"
gem "rbs"
gem "rubocop"
Expand All @@ -20,6 +14,19 @@ group :development do
# TODO: using a fork for now, the prettier below has a bug
gem "syntax_tree-rbs", github: "stainless-api/syntax_tree-rbs", branch: "main"
gem "tapioca"
end

group :development, :test do
gem "async"
gem "minitest"
gem "minitest-focus"
gem "minitest-hooks"
gem "minitest-proveit"
gem "minitest-rg"
end

group :development, :docs do
gem "redcarpet"
gem "webrick"
gem "yard"
end
74 changes: 41 additions & 33 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ GIT
PATH
remote: .
specs:
orb (0.1.0.pre.alpha.29)
orb (0.1.0.pre.alpha.30)
connection_pool

GEM
Expand All @@ -29,8 +29,8 @@ GEM
minitest (>= 5.1)
securerandom (>= 0.3)
tzinfo (~> 2.0, >= 2.0.5)
ast (2.4.2)
async (2.23.0)
ast (2.4.3)
async (2.23.1)
console (~> 1.29)
fiber-annotation
io-event (~> 1.9)
Expand All @@ -41,11 +41,11 @@ GEM
bigdecimal (3.1.9)
concurrent-ruby (1.3.5)
connection_pool (2.5.0)
console (1.29.3)
console (1.30.2)
fiber-annotation
fiber-local (~> 1.1)
json
csv (3.3.2)
csv (3.3.3)
drb (2.2.1)
erubi (1.13.1)
ffi (1.17.1)
Expand All @@ -56,16 +56,16 @@ GEM
fileutils (1.7.3)
i18n (1.14.7)
concurrent-ruby (~> 1.0)
io-event (1.9.0)
json (2.10.1)
io-event (1.10.0)
json (2.10.2)
language_server-protocol (3.17.0.4)
lint_roller (1.1.0)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
logger (1.6.6)
metrics (0.12.1)
minitest (5.25.4)
logger (1.7.0)
metrics (0.12.2)
minitest (5.25.5)
minitest-focus (1.4.0)
minitest (>= 4, < 6)
minitest-hooks (1.5.2)
Expand All @@ -74,68 +74,73 @@ GEM
minitest (> 5, < 7)
minitest-rg (5.3.0)
minitest (~> 5.0)
mutex_m (0.3.0)
netrc (0.11.0)
parallel (1.26.3)
parser (3.3.7.1)
parser (3.3.7.4)
ast (~> 2.4.1)
racc
prettier_print (1.2.1)
prism (1.3.0)
prism (1.4.0)
racc (1.8.1)
rainbow (3.1.1)
rake (13.2.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rbi (0.2.4)
rbi (0.3.1)
prism (~> 1.0)
rbs (>= 3.4.4)
sorbet-runtime (>= 0.5.9204)
rbs (3.8.1)
rbs (3.9.2)
logger
redcarpet (3.6.1)
regexp_parser (2.10.0)
rubocop (1.73.2)
rubocop (1.75.1)
json (~> 2.3)
language_server-protocol (~> 3.17.0.2)
lint_roller (~> 1.1.0)
parallel (~> 1.10)
parser (>= 3.3.0.2)
rainbow (>= 2.2.2, < 4.0)
regexp_parser (>= 2.9.3, < 3.0)
rubocop-ast (>= 1.38.0, < 2.0)
rubocop-ast (>= 1.43.0, < 2.0)
ruby-progressbar (~> 1.7)
unicode-display_width (>= 2.4.0, < 4.0)
rubocop-ast (1.38.1)
parser (>= 3.3.1.0)
rubocop-ast (1.43.0)
parser (>= 3.3.7.2)
prism (~> 1.4)
ruby-progressbar (1.13.0)
securerandom (0.4.1)
sorbet (0.5.11888)
sorbet-static (= 0.5.11888)
sorbet-runtime (0.5.11888)
sorbet-static (0.5.11888-x86_64-linux)
sorbet-static-and-runtime (0.5.11888)
sorbet (= 0.5.11888)
sorbet-runtime (= 0.5.11888)
spoom (1.5.4)
sorbet (0.5.11966)
sorbet-static (= 0.5.11966)
sorbet-runtime (0.5.11966)
sorbet-static (0.5.11966-x86_64-linux)
sorbet-static-and-runtime (0.5.11966)
sorbet (= 0.5.11966)
sorbet-runtime (= 0.5.11966)
spoom (1.6.1)
erubi (>= 1.10.0)
prism (>= 0.28.0)
rbi (>= 0.2.3)
sorbet-static-and-runtime (>= 0.5.10187)
thor (>= 0.19.2)
steep (1.9.4)
steep (1.10.0)
activesupport (>= 5.1)
concurrent-ruby (>= 1.1.10)
csv (>= 3.0.9)
fileutils (>= 1.1.0)
json (>= 2.1.0)
language_server-protocol (>= 3.15, < 4.0)
language_server-protocol (>= 3.17.0.4, < 4.0)
listen (~> 3.0)
logger (>= 1.3.0)
mutex_m (>= 0.3.0)
parser (>= 3.1)
rainbow (>= 2.2.2, < 4.0)
rbs (~> 3.8)
rbs (~> 3.9)
securerandom (>= 0.1)
strscan (>= 1.0.0)
terminal-table (>= 2, < 4)
terminal-table (>= 2, < 5)
uri (>= 0.12.0)
strscan (3.1.2)
syntax_tree (6.2.0)
Expand All @@ -150,13 +155,15 @@ GEM
spoom (>= 1.2.0)
thor (>= 1.2.0)
yard-sorbet
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
terminal-table (4.0.0)
unicode-display_width (>= 1.1.1, < 4)
thor (1.3.2)
traces (0.15.2)
tzinfo (2.0.6)
concurrent-ruby (~> 1.0)
unicode-display_width (2.6.0)
unicode-display_width (3.1.4)
unicode-emoji (~> 4.0, >= 4.0.4)
unicode-emoji (4.0.4)
uri (1.0.3)
webrick (1.9.1)
yard (0.9.37)
Expand All @@ -177,6 +184,7 @@ DEPENDENCIES
orb!
rake
rbs
redcarpet
rubocop
sorbet
steep
Expand Down
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ The underlying REST API documentation can be found on [docs.withorb.com](https:/

## Installation

To use this gem during the beta, install directly from GitHub with Bundler by adding the following to your application's `Gemfile`:
To use this gem, install via Bundler by adding the following to your application's `Gemfile`:

```ruby
gem "orb", git: "https://github.com/orbcorp/orb-ruby", branch: "main"
gem "orb", "~> 0.1.0.pre.alpha.29"
```

To fetch an initial copy of the gem:
Expand All @@ -22,12 +22,6 @@ To fetch an initial copy of the gem:
bundle install
```

To update the version used by your application when updates are pushed to GitHub:

```sh
bundle update orb
```

## Usage

```ruby
Expand Down
17 changes: 11 additions & 6 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# frozen_string_literal: true

require "securerandom"
require "shellwords"

require "minitest/test_task"
require "rake/clean"
require "rubocop/rake_task"
require "securerandom"
require "shellwords"

CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/])

xargs = %w[xargs --no-run-if-empty --null --max-procs=0 --max-args=300 --]

task(default: [:test, :format])
multitask(default: [:test])

multitask(:test) do
rb =

Check warning on line 17 in Rakefile

View workflow job for this annotation

GitHub Actions / lint

Layout/TrailingWhitespace: Trailing whitespace detected.
FileList[ENV.fetch("TEST", "./test/**/*_test.rb")]
.map { "require_relative(#{_1.dump});" }
.join

Minitest::TestTask.create do |t|
t.libs = %w[.]
t.test_globs = ENV.fetch("TEST", "./test/**/*_test.rb")
ruby(*%w[-w -e], rb, verbose: false) { fail unless _1 }
end

RuboCop::RakeTask.new(:rubocop) do |t|
Expand Down
20 changes: 14 additions & 6 deletions lib/orb.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# We already ship the preferred sorbet manifests in the package itself.
# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
if defined?(:Tapioca) && caller_locations.any? { _1.path.end_with?("tapioca/cli.rb") }
if Object.const_defined?(:Tapioca) && caller.chain([$0]).chain(ARGV).grep(/tapioca/)

Check warning on line 5 in lib/orb.rb

View workflow job for this annotation

GitHub Actions / lint

Style/SpecialGlobalVars: Prefer `$PROGRAM_NAME` over `$0`.
Warning.warn(
<<~WARN
\n
Expand Down Expand Up @@ -36,13 +36,21 @@
# Package files.
require_relative "orb/version"
require_relative "orb/util"
require_relative "orb/extern"
require_relative "orb/base_model"
require_relative "orb/base_page"
require_relative "orb/type/converter"
require_relative "orb/type/unknown"
require_relative "orb/type/boolean_model"
require_relative "orb/type/enum"
require_relative "orb/type/union"
require_relative "orb/type/array_of"
require_relative "orb/type/hash_of"
require_relative "orb/type/base_model"
require_relative "orb/type/base_page"
require_relative "orb/type/request_parameters"
require_relative "orb/type"
require_relative "orb/request_options"
require_relative "orb/errors"
require_relative "orb/base_client"
require_relative "orb/pooled_net_requester"
require_relative "orb/transport/base_client"
require_relative "orb/transport/pooled_net_requester"
require_relative "orb/client"
require_relative "orb/page"
require_relative "orb/models/alert"
Expand Down
Loading
Loading