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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 738e70d5c25abac9d2886a2b26a67fbd583d12b248ead60ca7d6036a8c8253f5
4
- data.tar.gz: 6dfa44efa033571dfb22bc82e56f42a7433409046ce4af54f3318971aa029dab
3
+ metadata.gz: 979b84801f81102d120f0a9936fda8d851ee68551017d1a7876dbe0530024601
4
+ data.tar.gz: c1c5a77941501aa6d2c49c11f5f1906462bfd6b9d376f080a87b1d22f9131ba9
5
5
  SHA512:
6
- metadata.gz: 8a2ce9989f29d744bf039c8607f8ffa5b71a8bf4ae50805c72bfe0411d86652800d2d43acea32cafbe1d72b93114ae3946a3a28c54c4e0d9365c9c7603482312
7
- data.tar.gz: c257583cb4b1006dc260bd7711b4064670ea97723a92adfd4e6e269f19f41dfef20fbc8ccf3366dd4716b5b13c7e43f0ae5795e046ddb6f27c8c6f035eb5b6c8
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 = Bundleup::Client.new(ENV['BUNDLEUP_API_KEY'])
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 = Bundleup::Client.new('your_api_key_here')
132
+ client = BundleUp::Client.new('your_api_key_here')
123
133
 
124
134
  # Or use environment variable (recommended)
125
- client = Bundleup::Client.new(ENV['BUNDLEUP_API_KEY'])
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 = Bundleup::Client.new(ENV['BUNDLEUP_API_KEY'])
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 = Bundleup::Client.new(ENV['BUNDLEUP_API_KEY'])
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['X-Bundleup-Signature']
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) 2024 BundleUp
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
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
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 ||= Bundleup::Resources::Connection.new(@api_key)
15
+ @connections ||= BundleUp::Resources::Connection.new(@api_key)
16
16
  end
17
17
 
18
18
  def integrations
19
- @integrations ||= Bundleup::Resources::Integration.new(@api_key)
19
+ @integrations ||= BundleUp::Resources::Integration.new(@api_key)
20
20
  end
21
21
 
22
22
  def webhooks
23
- @webhooks ||= Bundleup::Resources::Webhook.new(@api_key)
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
- Bundleup::Proxy.new(@api_key, connection_id)
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
- Bundleup::Unify::Client.new(@api_key, connection_id)
39
+ BundleUp::Unify::Client.new(@api_key, connection_id)
40
40
  end
41
41
  end
42
42
  end
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  # Client for proxy API requests.
5
5
  class Proxy
6
6
  BASE_URL = 'https://proxy.bundleup.io'
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Resources
5
5
  # Base class for API resources.
6
6
  class Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Resources
5
5
  # Client for connection API endpoints.
6
6
  class Connection < Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Resources
5
5
  # Client for integration API endpoints.
6
6
  class Integration < Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Resources
5
5
  # Client for webhook API endpoints.
6
6
  class Webhook < Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Unify
5
5
  # Base class for Unify API clients.
6
6
  class Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Unify
5
5
  # Client for chat-related Unify endpoints.
6
6
  class Chat < Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Unify
5
5
  # Client for Git Unify endpoints.
6
6
  class Git < Base
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
3
+ module BundleUp
4
4
  module Unify
5
5
  # Client for project management Unify endpoints.
6
6
  class PM < Base
@@ -1,15 +1,15 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
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 = 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)
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
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Bundleup
4
- VERSION = '0.2.1'
3
+ module BundleUp
4
+ VERSION = '0.2.2'
5
5
  end
data/lib/bundleup.rb CHANGED
@@ -20,5 +20,5 @@ require_relative 'bundleup/unify/git'
20
20
  require_relative 'bundleup/unify/pm'
21
21
 
22
22
  # Main module for the BundleUp SDK.
23
- module Bundleup
23
+ module BundleUp
24
24
  end
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.1
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-27 00:00:00.000000000 Z
11
+ date: 2026-02-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday