ruby-client/docs/ruby-api/index.html at main · eryph-org/ruby-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  File: README

    &mdash; Eryph Ruby Client API

</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" />

  <link rel="stylesheet" href="css/common.css" type="text/css" />

<script type="text/javascript">
  pathId = "README";
  relpath = '';
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">

    <a href="_index.html">Index</a> &raquo;
    <span class="title">File: README</span>

</div>

        <div id="search">

    <a class="full_list_link" id="class_list_link"
        href="class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>

</div>
        <div class="clear"></div>
      </div>

      <div id="content"><div id='filecontents'><h1 id="eryph-ruby-client-libraries">Eryph Ruby Client Libraries</h1>

<p><a href="https://badge.fury.io/rb/eryph-compute"><img src="https://badge.fury.io/rb/eryph-compute.svg" alt="Gem Version" /></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT" /></a></p>

<p>Official Ruby client libraries for Eryph APIs with seamless OAuth2 authentication, automatic configuration discovery, and cross-platform support.</p>

<h2 id="quick-start">🚀 Quick Start</h2>

<p>```ruby
require ‘eryph’</p>

<h1 id="automatic-credential-discovery---tries-multiple-configs-in-priority-order">Automatic credential discovery - tries multiple configs in priority order</h1>
<p>client = Eryph.compute_client  # Auto-discovers: default → zero → local</p>

<h1 id="or-specify-configurationclient-explicitly">Or specify configuration/client explicitly</h1>
<p># client = Eryph.compute_client(‘production’)           # Specific config
# client = Eryph.compute_client(client_id: ‘my-app’)    # Find client across all configs
# client = Eryph.compute_client(‘zero’, client_id: ‘admin’)  # Specific client in config</p>

<h1 id="list-your-catlets">List your catlets</h1>
<p>catlets = client.catlets.catlets_list
puts “Found #catletscatlets.valuecatlets.value.length catlets”</p>

<h1 id="validate-a-configuration">Validate a configuration</h1>
<p>config = { name: ‘my-app’, parent: ‘dbosoft/ubuntu-22.04/starter’ }
result = client.validate_catlet_config(config)
puts result.is_valid ? ‘✅ Valid’ : ‘❌ Invalid’
```</p>

<h2 id="installation">📦 Installation</h2>

<p>Add to your Gemfile:
<code>ruby
gem 'eryph-compute'
</code></p>

<p>Or install directly:
<code>bash
gem install eryph-compute
</code></p>

<h2 id="features">✨ Features</h2>

<ul>
  <li><strong>🔐 Zero-Config Authentication</strong> - Automatic credential discovery from multiple sources</li>
  <li><strong>🎯 eryph-zero Integration</strong> - Auto-detects local development environments</li>
  <li><strong>🌍 Cross-Platform</strong> - Windows, Linux, and macOS support</li>
  <li><strong>🔄 Operation Tracking</strong> - Real-time monitoring of long-running operations</li>
</ul>

<h2 id="architecture">🏗️ Architecture</h2>

<p>This is a <strong>monorepo</strong> containing multiple Ruby client libraries:</p>

<table>
  <thead>
    <tr>
      <th>Gem</th>
      <th>Description</th>
      <th>Use Case</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><strong><code>eryph-compute</code></strong></td>
      <td>Compute API client</td>
      <td>Managing catlets, projects, resources</td>
    </tr>
    <tr>
      <td><strong><code>eryph-clientruntime</code></strong></td>
      <td>Shared authentication runtime</td>
      <td>Used by all Eryph clients</td>
    </tr>
    <tr>
      <td><strong><code>eryph-identity</code></strong></td>
      <td><em>Coming Soon</em></td>
      <td>User and role management</td>
    </tr>
  </tbody>
</table>

<h2 id="documentation">📚 Documentation</h2>

<h3 id="getting-started">Getting Started</h3>
<ul>
  <li><strong><a href="docs/guides/getting-started.md">Installation &amp; Setup</a></strong> - Complete installation guide</li>
  <li><strong><a href="docs/guides/authentication.md">Authentication</a></strong> - OAuth2 setup and configuration</li>
  <li><strong><a href="docs/guides/configuration.md">Configuration</a></strong> - Managing multiple environments</li>
</ul>

<h3 id="api-reference">API Reference</h3>
<ul>
  <li><strong><a href="docs/ruby-api/">Ruby API Reference</a></strong> - High-level Ruby client documentation</li>
  <li><strong><a href="docs/api/">REST API Reference</a></strong> - Complete OpenAPI specification</li>
  <li><strong><a href="docs/examples/">Code Examples</a></strong> - Common usage patterns</li>
</ul>

<p>For detailed API endpoint documentation, see <strong><a href="docs/api/">API Reference</a></strong> - complete REST API documentation with all endpoints, models, and examples.</p>

<h2 id="configuration">🔧 Configuration</h2>

<p>The client uses a hierarchical configuration system with automatic discovery:</p>

<p><code>bash
# Priority order (highest to lowest):
1. ./.eryph/{config}.config          # Project directory
2. ~/.config/.eryph/{config}.config  # User directory (Unix)
   %APPDATA%\.eryph\{config}.config  # User directory (Windows)
3. /etc/.eryph/{config}.config       # System directory (Unix)
   %PROGRAMDATA%\.eryph\{config}.config # System directory (Windows)
</code></p>

<p><strong>Configuration file example</strong> (<code>.eryph/default.config</code>):
<code>json
{
  "endpoints": {
    "identity": "https://identity.mycompany.com",
    "compute": "https://compute.mycompany.com"
  },
  "clients": [{
    "id": "my-app-client",
    "name": "My Application"
  }],
  "defaultClient": "my-app-client"
}
</code></p>

<h2 id="multiple-environments--discovery">🎯 Multiple Environments &amp; Discovery</h2>

<p>```ruby
# Automatic discovery (recommended - tries multiple configs)
client = Eryph.compute_client  # Auto-discovers best available credentials</p>

<h1 id="specific-configurations">Specific configurations</h1>
<p>prod_client = Eryph.compute_client(‘production’)  # Production environment
dev_client = Eryph.compute_client(‘zero’)         # Local eryph-zero instance</p>

<h1 id="client-id-based-discovery-searches-across-all-configurations">Client ID-based discovery (searches across all configurations)</h1>
<p>admin_client = Eryph.compute_client(client_id: ‘admin-client’)
app_client = Eryph.compute_client(client_id: ‘my-app-client’)</p>

<h1 id="combined---specific-client-in-specific-config">Combined - specific client in specific config</h1>
<p>specific_client = Eryph.compute_client(‘production’, client_id: ‘backup-service’)
```</p>

<h2 id="contributing">🤝 Contributing</h2>

<p>We welcome contributions! Please see our <a href="CONTRIBUTING.md">Contributing Guide</a> for details on:</p>

<ul>
  <li>Development setup with changeset management</li>
  <li>Code style and testing requirements</li>
  <li>Pull request process</li>
  <li>Release workflow</li>
</ul>

<h2 id="license">📄 License</h2>

<p>This project is licensed under the MIT License - see the <a href="LICENSE">LICENSE</a> file for details.</p>

<h2 id="support--community">🆘 Support &amp; Community</h2>

<ul>
  <li><strong><a href="https://https://www.eryph.io/docs">📖 Documentation</a></strong> - Complete guides and API reference</li>
  <li><strong><a href="https://github.com/eryph-org/ruby-client/issues">🐛 Issue Tracker</a></strong> - Bug reports and feature requests</li>
  <li><strong><a href="https://github.com/eryph-org/eryph/discussions">💬 Discussions</a></strong> - Community support and questions</li>
  <li><strong><a href="https://eryph.io">🌐 Website</a></strong> - Learn more about Eryph</li>
</ul>

<hr />

<div align="center">
  <strong>Built with ❤️ by the Eryph Team</strong>
</div>
</div></div>

      <div id="footer">
  Generated on Sun Aug 31 15:42:17 2025 by
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.37 (ruby-3.4.4).
</div>

    </div>
  </body>
</html>