elelem-openai 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9a36ddc50d065fb25f3a8a5d0308010322a2fd716f3c27ca7adb2d5c24adfb3c
4
- data.tar.gz: 486ebb30a04b0b0b46d11d3f7b0732013031cc2ae732518e1fbc42c0c695981e
3
+ metadata.gz: a71f780cc76b197086104f457696d3ae8677513033cc9a2e1b0f67f2f1800c3b
4
+ data.tar.gz: a5197c27bea1826e0ecb44404ceaa78d72969d4b35b2f0570ad73f89d799f206
5
5
  SHA512:
6
- metadata.gz: f32724ce6db9368254e07bdb84bdff5dca38bae1aa0aba6663fce3d300ba13cdaba15c8eea6898fc671f19931a71525bd404b815b5ec6e06c8c454db896af220
7
- data.tar.gz: 1d09a9640327f840d614170e37b789c1bb57b0a633a6efe881098ed409adc3ba6a6c1d319bb72132886ade1439b516b77ef4c7fc54ee98b0646ae6467905041b
6
+ metadata.gz: 3d0c3128338ad5d20e2843754a33f1f9d169dcd76bb962f64addb604429bc28fd5628df1fdd626a5244d78408c8cb26f2ffe9327834aaeb18e8ea05e214c53cc
7
+ data.tar.gz: e95da066e99367d43a5e64daf6f5438c6fa646b32bc69cd5dcbfa0f51a28f675af911d1bbe70c81546a0213f57009b9f80df9a40c582a6f544cd6bf36e1dd75f
@@ -0,0 +1,86 @@
1
+ As a `person who wants to use OpenAI or a compatible server from
2
+ elelem`, I `want a README and clear RubyGems links for elelem-openai`,
3
+ so that `I can point it at my server without reading the code and find
4
+ the docs and backlog from the gem page`.
5
+
6
+ # SYNOPSIS
7
+
8
+ Add a README, and point the gem's RubyGems links at elelem.sh and this
9
+ repository's backlog.
10
+
11
+ # DESCRIPTION
12
+
13
+ Two small changes that both shape what a newcomer sees first.
14
+
15
+ ## README
16
+
17
+ The repository has no README. It should cover:
18
+
19
+ * Install, and selecting the provider: `-p openai` and `--model NAME`.
20
+ * `OPENAI_API_KEY`, `OPENAI_MODEL` (default `gpt-4o`) and
21
+ `OPENAI_BASE_URL` (default `https://api.openai.com/v1`).
22
+ * Compatible servers: with `OPENAI_BASE_URL` set, no key is required,
23
+ so a local Chat Completions server works; an example.
24
+ * That a set but empty variable counts as unset.
25
+ * A link to https://elelem.sh/plugins/openai/ for the full guide.
26
+
27
+ The elelem.sh plugin page can be the source for the text. Show commands
28
+ without a leading `$`, so they can be pasted.
29
+
30
+ ## Gem metadata
31
+
32
+ RubyGems shows `homepage_uri` and the other `metadata` links on every
33
+ gem page. Today `elelem-openai.gemspec` sets `spec.homepage`
34
+ to the site root (https://elelem.sh) and sets only `homepage_uri`,
35
+ `source_code_uri`, `allowed_push_host` and
36
+ `rubygems_mfa_required`.
37
+ There is no documentation, bug tracker or changelog link.
38
+
39
+ Proposed change:
40
+
41
+ ```ruby
42
+ spec.homepage = "https://elelem.sh/plugins/openai/"
43
+ spec.metadata["homepage_uri"] = spec.homepage
44
+ spec.metadata["source_code_uri"] = "https://github.com/elelem-sh/openai"
45
+ spec.metadata["documentation_uri"] = spec.homepage
46
+ spec.metadata["bug_tracker_uri"] = "https://github.com/elelem-sh/openai/tree/main/.agents/backlog"
47
+ spec.metadata["changelog_uri"] = "https://github.com/elelem-sh/openai/blob/main/CHANGELOG.md"
48
+ ```
49
+
50
+ The original proposal pointed `bug_tracker_uri` at GitHub Issues on
51
+ elelem-sh/elelem.sh, filtered by label. That no longer fits: the
52
+ project is moving its backlog out of GitHub Issues and into
53
+ `.agents/backlog` story files in each repository, so the bug tracker
54
+ link points at this repository's backlog directory instead.
55
+
56
+ /man/openai/ redirects to /plugins/openai/ on elelem.sh, so a
57
+ separate documentation_uri adds nothing. Point both at the plugin page.
58
+ CHANGELOG.md exists on main, so the changelog link works today.
59
+
60
+ Keep `allowed_push_host` and `rubygems_mfa_required` as they are.
61
+ RubyGems only shows the new links after the next release.
62
+
63
+ # SEE ALSO
64
+
65
+ * [ ] lib/elelem/openai.rb:11-27 - provider block and environment
66
+ * [ ] exe/elelem-openai
67
+ * [ ] elelem-openai.gemspec:13 - spec.homepage and metadata
68
+ * [ ] https://elelem.sh/plugins/openai/ - source for README text
69
+ * [ ] Formerly elelem-sh/elelem.sh#23
70
+ * [ ] Formerly elelem-sh/elelem.sh#41
71
+
72
+ # Tasks
73
+
74
+ * [ ] TBD (filled in design mode)
75
+
76
+ # Acceptance Criteria
77
+
78
+ * [ ] README.md exists and covers the points above
79
+ * [ ] Defaults in the README match the code
80
+ * [ ] Commands in the README have no leading `$`
81
+ * [ ] `spec.homepage` and `homepage_uri` are https://elelem.sh/plugins/openai/
82
+ * [ ] `bug_tracker_uri` points at this repository's `.agents/backlog`,
83
+ not at GitHub Issues
84
+ * [ ] `changelog_uri` and `source_code_uri` point at this repository
85
+ * [ ] `gem build` succeeds and `gem spec` on the built gem shows every
86
+ link
@@ -59,3 +59,5 @@ jobs:
59
59
  ruby-version: "4.0"
60
60
  bundler-cache: true
61
61
  - uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1
62
+ with:
63
+ await-release: false
@@ -1,3 +1,3 @@
1
1
  {
2
- ".": "0.3.0"
2
+ ".": "0.3.1"
3
3
  }
data/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.3.1](https://github.com/elelem-sh/openai/compare/v0.3.0...v0.3.1) (2026-11-18)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **deps:** accept the json that Ruby 4.0 ships ([3c856d4](https://github.com/elelem-sh/openai/commit/3c856d43e90bdcde09134d512bf60d4ba9db907e))
9
+
3
10
  ## [0.3.0](https://github.com/elelem-sh/openai/compare/v0.2.0...v0.3.0) (2026-11-16)
4
11
 
5
12
 
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Elelem
4
4
  module OpenAI
5
- VERSION = "0.3.0"
5
+ VERSION = "0.3.1"
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: elelem-openai
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.3.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - mo khan
@@ -33,16 +33,16 @@ dependencies:
33
33
  name: json
34
34
  requirement: !ruby/object:Gem::Requirement
35
35
  requirements:
36
- - - "~>"
36
+ - - ">="
37
37
  - !ruby/object:Gem::Version
38
- version: '3.0'
38
+ version: '2.18'
39
39
  type: :runtime
40
40
  prerelease: false
41
41
  version_requirements: !ruby/object:Gem::Requirement
42
42
  requirements:
43
- - - "~>"
43
+ - - ">="
44
44
  - !ruby/object:Gem::Version
45
- version: '3.0'
45
+ version: '2.18'
46
46
  - !ruby/object:Gem::Dependency
47
47
  name: net-http
48
48
  requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,7 @@ executables:
79
79
  extensions: []
80
80
  extra_rdoc_files: []
81
81
  files:
82
+ - ".agents/backlog/001-readme-and-gem-metadata.md"
82
83
  - ".github/workflows/release.yml"
83
84
  - ".release-please-manifest.json"
84
85
  - ".rspec"