bundleup-sdk 0.2.1 โ 0.2.2
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 +4 -4
- data/README.md +17 -7
- data/lib/bundleup/client.rb +6 -6
- data/lib/bundleup/proxy.rb +1 -1
- data/lib/bundleup/resources/base.rb +1 -1
- data/lib/bundleup/resources/connection.rb +1 -1
- data/lib/bundleup/resources/integration.rb +1 -1
- data/lib/bundleup/resources/webhook.rb +1 -1
- data/lib/bundleup/unify/base.rb +1 -1
- data/lib/bundleup/unify/chat.rb +1 -1
- data/lib/bundleup/unify/git.rb +1 -1
- data/lib/bundleup/unify/pm.rb +1 -1
- data/lib/bundleup/unify.rb +4 -4
- data/lib/bundleup/version.rb +2 -2
- data/lib/bundleup.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 979b84801f81102d120f0a9936fda8d851ee68551017d1a7876dbe0530024601
|
|
4
|
+
data.tar.gz: c1c5a77941501aa6d2c49c11f5f1906462bfd6b9d376f080a87b1d22f9131ba9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7d936f5585a32fa86e47e841033cc70e01d7abd314ded883ad6586e248f71744f04de434fa8442b6adcb36fe8d1070e7b500d543c3356452d781ae1e562f048a
|
|
7
|
+
data.tar.gz: d990e1de94e7f89c0cf25ae2c6165c65a2db6d81a6d03017cc107a105dee96680a3cfcb227f3c4e565bf6ab731f861f56fdcb6f1766273412f0d029ac28fd790
|
data/README.md
CHANGED
|
@@ -10,6 +10,7 @@ Official Ruby SDK for the [BundleUp](https://bundleup.io) API. Connect to 100+ i
|
|
|
10
10
|
- [Installation](#installation)
|
|
11
11
|
- [Requirements](#requirements)
|
|
12
12
|
- [Features](#features)
|
|
13
|
+
- [Examples](#examples)
|
|
13
14
|
- [Quick Start](#quick-start)
|
|
14
15
|
- [Authentication](#authentication)
|
|
15
16
|
- [Core Concepts](#core-concepts)
|
|
@@ -77,6 +78,15 @@ The BundleUp SDK is tested and supported on:
|
|
|
77
78
|
- ๐ **Well Documented** - Extensive documentation and examples
|
|
78
79
|
- ๐งช **Tested** - Comprehensive test suite with RSpec
|
|
79
80
|
|
|
81
|
+
## Examples
|
|
82
|
+
|
|
83
|
+
Runnable examples are available in the [`examples/`](./examples) directory:
|
|
84
|
+
|
|
85
|
+
- [`examples/basic_usage.rb`](./examples/basic_usage.rb) - Client setup, connections, integrations, and webhooks
|
|
86
|
+
- [`examples/proxy_api.rb`](./examples/proxy_api.rb) - Proxy API GET request with a connection
|
|
87
|
+
- [`examples/unify_api.rb`](./examples/unify_api.rb) - Unify Chat, Git, and PM endpoint usage
|
|
88
|
+
- [`examples/README.md`](./examples/README.md) - Setup and execution instructions
|
|
89
|
+
|
|
80
90
|
## Quick Start
|
|
81
91
|
|
|
82
92
|
Get started with BundleUp in just a few lines of code:
|
|
@@ -85,7 +95,7 @@ Get started with BundleUp in just a few lines of code:
|
|
|
85
95
|
require 'bundleup'
|
|
86
96
|
|
|
87
97
|
# Initialize the client
|
|
88
|
-
client =
|
|
98
|
+
client = BundleUp::Client.new(ENV['BUNDLEUP_API_KEY'])
|
|
89
99
|
|
|
90
100
|
# List all active connections
|
|
91
101
|
connections = client.connections.list
|
|
@@ -119,10 +129,10 @@ The BundleUp SDK uses API keys for authentication. You can obtain your API key f
|
|
|
119
129
|
require 'bundleup'
|
|
120
130
|
|
|
121
131
|
# Initialize with API key
|
|
122
|
-
client =
|
|
132
|
+
client = BundleUp::Client.new('your_api_key_here')
|
|
123
133
|
|
|
124
134
|
# Or use environment variable (recommended)
|
|
125
|
-
client =
|
|
135
|
+
client = BundleUp::Client.new(ENV['BUNDLEUP_API_KEY'])
|
|
126
136
|
```
|
|
127
137
|
|
|
128
138
|
### Security Best Practices
|
|
@@ -154,14 +164,14 @@ Then in your application:
|
|
|
154
164
|
require 'dotenv/load'
|
|
155
165
|
require 'bundleup'
|
|
156
166
|
|
|
157
|
-
client =
|
|
167
|
+
client = BundleUp::Client.new(ENV['BUNDLEUP_API_KEY'])
|
|
158
168
|
```
|
|
159
169
|
|
|
160
170
|
**For Rails applications:**
|
|
161
171
|
|
|
162
172
|
```ruby
|
|
163
173
|
# config/initializers/bundleup.rb
|
|
164
|
-
BUNDLEUP_CLIENT =
|
|
174
|
+
BUNDLEUP_CLIENT = BundleUp::Client.new(ENV['BUNDLEUP_API_KEY'])
|
|
165
175
|
```
|
|
166
176
|
|
|
167
177
|
## Core Concepts
|
|
@@ -472,7 +482,7 @@ class WebhooksController < ApplicationController
|
|
|
472
482
|
skip_before_action :verify_authenticity_token
|
|
473
483
|
|
|
474
484
|
def create
|
|
475
|
-
signature = request.headers['
|
|
485
|
+
signature = request.headers['BundleUp-Signature']
|
|
476
486
|
payload = request.body.read
|
|
477
487
|
|
|
478
488
|
unless verify_signature(payload, signature)
|
|
@@ -1019,7 +1029,7 @@ We welcome contributions to the BundleUp Ruby SDK! Here's how you can help:
|
|
|
1019
1029
|
This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
1020
1030
|
|
|
1021
1031
|
```
|
|
1022
|
-
Copyright (c)
|
|
1032
|
+
Copyright (c) 2026 BundleUp
|
|
1023
1033
|
|
|
1024
1034
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
1025
1035
|
of this software and associated documentation files (the "Software"), to deal
|
data/lib/bundleup/client.rb
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
module
|
|
3
|
+
module BundleUp
|
|
4
4
|
# Client for core BundleUp API resources.
|
|
5
5
|
class Client
|
|
6
6
|
attr_reader :api_key
|
|
@@ -12,15 +12,15 @@ module Bundleup
|
|
|
12
12
|
end
|
|
13
13
|
|
|
14
14
|
def connections
|
|
15
|
-
@connections ||=
|
|
15
|
+
@connections ||= BundleUp::Resources::Connection.new(@api_key)
|
|
16
16
|
end
|
|
17
17
|
|
|
18
18
|
def integrations
|
|
19
|
-
@integrations ||=
|
|
19
|
+
@integrations ||= BundleUp::Resources::Integration.new(@api_key)
|
|
20
20
|
end
|
|
21
21
|
|
|
22
22
|
def webhooks
|
|
23
|
-
@webhooks ||=
|
|
23
|
+
@webhooks ||= BundleUp::Resources::Webhook.new(@api_key)
|
|
24
24
|
end
|
|
25
25
|
|
|
26
26
|
def proxy(connection_id)
|
|
@@ -28,7 +28,7 @@ module Bundleup
|
|
|
28
28
|
raise ArgumentError, 'Connection ID is required to create a Proxy instance.'
|
|
29
29
|
end
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
BundleUp::Proxy.new(@api_key, connection_id)
|
|
32
32
|
end
|
|
33
33
|
|
|
34
34
|
def unify(connection_id)
|
|
@@ -36,7 +36,7 @@ module Bundleup
|
|
|
36
36
|
raise ArgumentError, 'Connection ID is required to create a Unify instance.'
|
|
37
37
|
end
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
BundleUp::Unify::Client.new(@api_key, connection_id)
|
|
40
40
|
end
|
|
41
41
|
end
|
|
42
42
|
end
|
data/lib/bundleup/proxy.rb
CHANGED
data/lib/bundleup/unify/base.rb
CHANGED
data/lib/bundleup/unify/chat.rb
CHANGED
data/lib/bundleup/unify/git.rb
CHANGED
data/lib/bundleup/unify/pm.rb
CHANGED
data/lib/bundleup/unify.rb
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
module
|
|
3
|
+
module BundleUp
|
|
4
4
|
module Unify
|
|
5
5
|
# Client for Unify API endpoints.
|
|
6
6
|
class Client
|
|
7
7
|
attr_reader :api_key, :connection_id
|
|
8
8
|
|
|
9
9
|
def initialize(api_key, connection_id)
|
|
10
|
-
@pm =
|
|
11
|
-
@chat =
|
|
12
|
-
@git =
|
|
10
|
+
@pm = BundleUp::Unify::PM.new(api_key, connection_id)
|
|
11
|
+
@chat = BundleUp::Unify::Chat.new(api_key, connection_id)
|
|
12
|
+
@git = BundleUp::Unify::Git.new(api_key, connection_id)
|
|
13
13
|
end
|
|
14
14
|
end
|
|
15
15
|
end
|
data/lib/bundleup/version.rb
CHANGED
data/lib/bundleup.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: bundleup-sdk
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- BundleUp
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-02-
|
|
11
|
+
date: 2026-02-28 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: faraday
|