A minimal Ruby client of Bluesky/ATProto API
mackuba.eu
Compare changes
Choose any two refs to compare.
+8
-1
.github/workflows/main.yml
+8
-1
.github/workflows/main.yml
+4
.gitignore
+4
.gitignore
+56
-2
CHANGELOG.md
+56
-2
CHANGELOG.md
···
1
+
## Unreleased
2
+
3
+
The "really niche bugfix" edition:
4
+
5
+
* don't stop fetching in `fetch_all` if an empty page is returned but the cursor is not nil; it's technically allowed for the server to return an empty page but still have more data to send
6
+
* in `post_request`, don't set Content-Type to "application/json" if the data sent is a string or nil (it might cause an error in some cases, like when uploading some binary content)
7
+
* handle the (somewhat theoretical but possible) case where an access token is not a JWT but just some opaque blob – in that case, Minisky will now not throw an error trying to parse it, but just treat it as "unknown" and will not try to refresh it
8
+
- note: at the moment Minisky will not catch the "token expired" error and refresh the token automatically in such scenario
9
+
* allow connecting to non-HTTPS servers (e.g. `http://localhost:3000`)
10
+
* allow making unauthenticated clients with custom classes by returning `nil` from `#config`; custom clients with a config that's missing an `id` or `pass` are treated as an error
11
+
* deprecate logging in using an email address in the `id` field – `createSession` accepts such identifier, but unlike with handle or DID, there's no way to use it to look up the DID document and PDS location if we wanted to
12
+
* fixed URL query params in POST requests on Ruby 2.x
13
+
* marked `Minisky#active_repl?` method as private
14
+
15
+
Also added YARD API documentation for most of the code.
16
+
17
+
## [0.5.0] - 2024-12-27 🎄
18
+
19
+
* `host` param in the initializer can be passed with a `https://` prefix (useful if you're passing it directly from a DID document, e.g. using DIDKit)
20
+
* added validation of the `method` parameter in request calls: it needs to be either a proper NSID, or a full URL as a string or a URI object
21
+
* added new optional `params` keyword argument in `post_request`, which lets you append query parameters to the URL if a POST endpoint requires passing them this way (e.g. `uploadVideo`)
22
+
* `default_progress` is set by default to show progress using dots (`.`) if Minisky is loaded inside an IRB or Pry context
23
+
* when experimenting with Minisky in the console, you can now skip the `field:` parameter to `fetch_all` if you don't remember the expected key name in the response, and the method will make a request and return an error which tells you the list of available keys
24
+
* added `access_token_expired?` helper method
25
+
* moved `token_expiration_date` to public methods
26
+
* `check_access` now returns a result symbol: `:logged_in`, `:refreshed` or `:ok`
27
+
* fixed `method_missing` setter on `User`
28
+
29
+
## [0.4.0] - 2024-03-31 🐣
30
+
31
+
* allow passing non-JSON body to requests (e.g. when uploading blobs)
32
+
* allow passing custom headers to requests, including overriding `Content-Type`
33
+
* fixed error when the response is success but not JSON (e.g. an empty body like in deleteRecord)
34
+
* allow passing options to the client in the initializer
35
+
* aliased `default_progress` setting as `progress`
36
+
* added `base64` dependency explicitly to the gemspec – fixes a warning in Ruby 3.3, since it will be extracted as an optional gem in 3.4
37
+
38
+
## [0.3.1] - 2023-10-10
39
+
40
+
* fixed Minisky not working on Ruby 2.x
41
+
42
+
## [0.3.0] - 2023-10-05
43
+
44
+
* authentication improvements & changes:
45
+
- Minisky now automatically manages access tokens, calling `check_access` manually is not necessary (set `auto_manage_tokens` to `false` to disable this)
46
+
- `check_access` now just checks token's expiry time instead of making a request to `getSession`
47
+
- added `send_auth_headers` option – set to `false` to not set auth header automatically, which is the default
48
+
- removed default config file name – explicit file name is now required
49
+
- Minisky can now be used in unauthenticated mode – pass `nil` as the config file name
50
+
- added `reset_tokens` helper method
51
+
* refactored response handling – typed errors are now raised on non-success response status
52
+
* `user` wrapper can also be used for writing fields to the config
53
+
* improved error handling
54
+
1
55
## [0.2.0] - 2023-09-02
2
56
3
57
* more consistent handling of parameters in the main methods:
···
13
67
* renamed `ident` field in the config hash to `id`
14
68
* config is now accessed in `Requests` from the client object as a `config` property instead of `@config` ivar
15
69
* config fields are exposed as a `user` wrapper object, e.g. `user.did` delegates to `@config['did']`
16
-
70
+
17
71
## [0.1.0] - 2023-09-01
18
72
19
73
- extracted most code to a `Requests` module that can be included into a different client class with custom config handling
···
24
78
25
79
## [0.0.1] - 2023-08-30
26
80
27
-
Initial release - extracted from original gist:
81
+
Initial release – extracted from original gist:
28
82
29
83
- logging in and refreshing the token
30
84
- making GET & POST requests
+8
-2
Gemfile
+8
-2
Gemfile
···
5
5
# Specify your gem's dependencies in minisky.gemspec
6
6
gemspec
7
7
8
-
gem 'rake', '~> 13.0'
8
+
gem 'rake'
9
+
gem 'irb'
10
+
11
+
gem 'rdoc'
12
+
gem 'yard'
13
+
9
14
gem 'rspec', '~> 3.12'
10
-
gem 'fakefs', '~> 2.5'
15
+
gem 'fakefs', '~> 1.8'
11
16
gem 'webmock', '~> 3.19'
17
+
gem 'simplecov'
+1
-1
LICENSE.txt
+1
-1
LICENSE.txt
+78
-25
README.md
+78
-25
README.md
···
1
-
# Minisky
1
+
# Minisky 🌤
2
2
3
3
Minisky is a minimal client of the Bluesky (ATProto) API. It provides a simple API client class that you can use to log in to the Bluesky API and make any GET and POST requests there. It's meant to be an easy way to start playing and experimenting with the AT Protocol API.
4
+
5
+
This is designed as a low-level XRPC client library - it purposefully does not include any convenience methods like "get posts" or "get profile" etc., it only provides base components that you could use to build a higher level API.
6
+
7
+
> [!NOTE]
8
+
> Part of ATProto Ruby SDK: [ruby.sdk.blue](https://ruby.sdk.blue)
4
9
5
10
6
11
## Installation
7
12
8
-
To use Minisky, you need a reasonably new version of Ruby (2.6+). Such version should be preinstalled on macOS Big Sur and above and some Linux systems. Otherwise, you can install one using tools such as [RVM](https://rvm.io), [asdf](https://asdf-vm.com), [ruby-install](https://github.com/postmodern/ruby-install) or [ruby-build](https://github.com/rbenv/ruby-build), or `rpm` or `apt-get` on Linux.
13
+
To use Minisky, you need a reasonably new version of Ruby – it should run on Ruby 2.6 and above, although it's recommended to use a version that's still getting maintainance updates, i.e. currently 3.2+. A compatible version should be preinstalled on macOS Big Sur and above and on many Linux systems. Otherwise, you can install one using tools such as [RVM](https://rvm.io), [asdf](https://asdf-vm.com), [ruby-install](https://github.com/postmodern/ruby-install) or [ruby-build](https://github.com/rbenv/ruby-build), or `rpm` or `apt-get` on Linux (see more installation options on [ruby-lang.org](https://www.ruby-lang.org/en/downloads/)).
9
14
10
15
To install the Minisky gem, run the command:
11
16
12
17
[sudo] gem install minisky
13
18
14
-
Or alternatively, add it to the `Gemfile` file for Bundler:
19
+
Or add it to your app's `Gemfile`:
15
20
16
-
gem 'minisky', '~> 0.2'
21
+
gem 'minisky', '~> 0.5'
17
22
18
23
19
24
## Usage
20
25
21
-
First, you need to create a `.yml` config file (by default, `bluesky.yml`) with the authentication data. It should look like this:
26
+
All calls to the XRPC API are made through an instance of the `Minisky` class. There are two ways to use the library: with or without authentication.
27
+
28
+
29
+
### Unauthenticated access
30
+
31
+
You can access parts of the API anonymously without any authentication. This currently includes: read-only `com.atproto.*` routes on the PDS (user's data server) and most read-only `app.bsky.*` routes on the AppView server.
32
+
33
+
This allows you to do things like:
34
+
35
+
- look up specific records or lists of all records of a given type in any account (in their raw form)
36
+
- look up profile information about any account
37
+
- load complete threads or users' profile feeds from the AppView
38
+
39
+
To use Minisky this way, create a `Minisky` instance, passing the API hostname string and `nil` as the configuration in the arguments. Use the hostname `api.bsky.app` or `public.api.bsky.app` for the AppView, or a PDS hostname for the `com.atproto.*` raw data endpoints:
40
+
41
+
```rb
42
+
require 'minisky'
43
+
44
+
bsky = Minisky.new('api.bsky.app', nil)
45
+
```
46
+
47
+
> [!NOTE]
48
+
> To call PDS endpoints like `getRecord` or `listRecords`, you need to connect to the PDS of the user whose data you're loading, not to yours (unless it's the same one). Alternatively, you can use the `bsky.social` "entryway" PDS hostname for any Bluesky-hosted accounts, but this will not work for self-hosted accounts.
49
+
>
50
+
> To look up the PDS hostname of a user given their handle or DID, you can use the [didkit](https://tangled.org/mackuba.eu/didkit) library.
51
+
>
52
+
> For the AppView, `api.bsky.app` connects directly to Bluesky's AppView, and `public.api.bsky.app` to a version with extra caching that will usually be faster.
53
+
54
+
55
+
### Authenticated access
56
+
57
+
To use the complete API including posting or reading your home feed, you need to log in using your account info and get an access token which will be added as an authentication header to all requests.
58
+
59
+
First, you need to create a `.yml` config file with the authentication data, e.g. `bluesky.yml`. It should look like this:
22
60
23
61
```yaml
24
62
id: my.bsky.username
···
27
65
28
66
The `id` can be either your handle, or your DID, or the email you've used to sign up. It's recommended that you use the "app password" that you can create in the settings instead of your main account password.
29
67
68
+
> [!NOTE]
69
+
> Bluesky has recently implemented OAuth, but Minisky doesn't support it yet - it will be added in a future version. App passwords should still be supported for a fairly long time.
70
+
30
71
After you log in, this file will also be used to store your access & request tokens and DID. The data in the config file can be accessed through a `user` wrapper property that exposes them as methods, e.g. the password is available as `user.pass` and the DID as `user.did`.
31
72
32
-
Next, create the Minisky client instance, passing the server name (at the moment there is only one server at `bsky.social`, but there will be more once federation support goes live):
73
+
Next, create the Minisky client instance, passing your PDS hostname (for Bluesky-hosted PDSes, you can use either `bsky.social` or your specific PDS like `amanita.us-east.host.bsky.network`) and the name of the config file:
33
74
34
75
```rb
35
76
require 'minisky'
36
77
37
-
bsky = Minisky.new('bsky.social')
38
-
bsky.check_access
78
+
bsky = Minisky.new('bsky.social', 'bluesky.yml')
39
79
```
40
80
41
-
`check_access` will check if an access token is saved, if not - it will log you in using the login & password, otherwise it will check if the token is still valid and refresh it if needed.
81
+
Minisky automatically manages your access and refresh tokens - it will first log you in using the login & password, and then use the refresh token to update the access token before the request when it expires.
82
+
83
+
84
+
### Making requests
42
85
43
-
Now, you can make requests to the Bluesky API using `get_request` and `post_request`:
86
+
With a `Minisky` client instance, you can make requests to the Bluesky API using `get_request` and `post_request`:
44
87
45
88
```rb
46
-
bsky.get_request('com.atproto.repo.listRecords', {
89
+
json = bsky.get_request('com.atproto.repo.listRecords', {
47
90
repo: bsky.user.did,
48
91
collection: 'app.bsky.feed.like'
49
92
})
50
93
94
+
json['records'].each do |r|
95
+
puts r['value']['subject']['uri']
96
+
end
97
+
51
98
bsky.post_request('com.atproto.repo.createRecord', {
52
99
repo: bsky.user.did,
53
100
collection: 'app.bsky.feed.post',
54
101
record: {
55
102
text: "Hello world!",
56
-
createdAt: Time.now.iso8601
103
+
createdAt: Time.now.iso8601,
104
+
langs: ["en"]
57
105
}
58
106
})
59
107
```
60
108
61
-
The requests use the saved access token for authentication automatically. You can also pass `auth: false` or `auth: nil` to not send any authentication headers, or `auth: sometoken` to use a specific other token.
109
+
In authenticated mode, the requests use the saved access token for auth headers automatically. You can also pass `auth: false` or `auth: nil` to not send any authentication headers for a given request, or `auth: sometoken` to use a specific other token. In unauthenticated mode, sending of auth headers is disabled.
62
110
63
-
The third useful method you can use is `#fetch_all`, which loads multiple paginated responses and collects all returned items on a single list (you need to pass the name of the field that contains the items in the response). Optionally, you can also specify a limit of pages to load as `max_pages: n`, or a break condition `break_when` to stop fetching when any item matches it. You can use it to e.g. to fetch all of your posts from the last 30 days, but not earlier:
111
+
The third useful method you can use is `#fetch_all`, which loads multiple paginated responses and collects all returned items on a single list (you need to pass the name of the field that contains the items in the response). Optionally, you can also specify a limit of pages to load as `max_pages: n`, or a break condition `break_when` to stop fetching when any item matches it. You can use it to e.g. to fetch all of your posts from the last 30 days but not earlier:
64
112
65
113
```rb
66
114
time_limit = Time.now - 86400 * 30
67
115
68
-
bsky.fetch_all('com.atproto.repo.listRecords',
116
+
posts = bsky.fetch_all('com.atproto.repo.listRecords',
69
117
{ repo: bsky.user.did, collection: 'app.bsky.feed.post' },
70
118
field: 'records',
71
119
max_pages: 10,
···
75
123
There is also a `progress` option you can use to print some kind of character for every page load. E.g. pass `progress: '.'` to print dots as the pages are loading:
76
124
77
125
```rb
78
-
bsky.fetch_all('com.atproto.repo.listRecords',
126
+
likes = bsky.fetch_all('com.atproto.repo.listRecords',
79
127
{ repo: bsky.user.did, collection: 'app.bsky.feed.like' },
80
128
field: 'records',
81
129
progress: '.')
···
87
135
.................
88
136
```
89
137
138
+
You can find more examples on the [examples page](https://ruby.sdk.blue/examples/) on [ruby.sdk.blue](https://ruby.sdk.blue).
139
+
140
+
90
141
## Customization
91
142
92
-
The `Minisky` client currently supports one configuration option:
143
+
The `Minisky` client currently supports such configuration options:
144
+
145
+
- `default_progress` - a progress character to automatically use for `#fetch_all` calls (default: `.` when in an interactive console, `nil` otherwise)
146
+
- `send_auth_headers` - whether auth headers should be added by default (default: `true` in authenticated mode)
147
+
- `auto_manage_tokens` - whether access tokens should be generated and refreshed automatically when needed (default: `true` in authenticated mode)
148
+
149
+
In authenticated mode, you can disable the `send_auth_headers` option and then explicitly add `auth: true` to specific requests to include a header there.
93
150
94
-
- `default_progress` - a progress character to automatically use for `#fetch_all` calls (default: `nil`)
151
+
You can also disable the `auto_manage_tokens` option - in this case you will need to call the `#check_access` method before a request to refresh a token if needed, or alternatively, call either `#login` or `#perform_token_refresh`.
95
152
96
-
When creating the `Minisky` instance, you can pass a name of the YAML config file to use instead of the default:
97
153
98
-
```rb
99
-
bsky = Minisky.new('bsky.social', 'config/access.yml')
100
-
```
154
+
### Using your own class
101
155
102
-
Alternatively, instead of using the `Minisky` class, you can make your own class that includes the `Minisky::Requests` module and provides a different way to load & save the config, e.g. from a JSON file:
156
+
Instead of using the `Minisky` class, you can also make your own class that includes the `Minisky::Requests` module and provides a different way to load & save the config, e.g. from a JSON file:
103
157
104
158
```rb
105
159
class BlueskyClient
···
126
180
127
181
```rb
128
182
bsky = BlueskyClient.new('config/access.json')
129
-
bsky.check_access
130
183
bsky.get_request(...)
131
184
```
132
185
···
139
192
140
193
## Credits
141
194
142
-
Copyright © 2023 Kuba Suder ([@mackuba.eu](https://bsky.app/profile/mackuba.eu)).
195
+
Copyright © 2026 Kuba Suder ([@mackuba.eu](https://bsky.app/profile/did:plc:oio4hkxaop4ao4wz2pp3f4cr)).
143
196
144
197
The code is available under the terms of the [zlib license](https://choosealicense.com/licenses/zlib/) (permissive, similar to MIT).
145
198
+20
lib/minisky/compat.rb
+20
lib/minisky/compat.rb
···
1
+
require_relative 'minisky'
2
+
3
+
class Minisky
4
+
5
+
#
6
+
# Versions of {Requests#get_request} & {Requests#post_request} that work on Ruby 2.x.
7
+
#
8
+
9
+
module Ruby2Compat
10
+
def get_request(method, params = nil, auth: default_auth_mode, headers: nil, **kwargs)
11
+
params ||= kwargs unless kwargs.empty?
12
+
super(method, params, auth: auth, headers: headers)
13
+
end
14
+
15
+
def post_request(method, data = nil, auth: default_auth_mode, headers: nil, params: nil, **kwargs)
16
+
data ||= kwargs unless kwargs.empty?
17
+
super(method, data, auth: auth, headers: headers, params: params)
18
+
end
19
+
end
20
+
end
+122
lib/minisky/errors.rb
+122
lib/minisky/errors.rb
···
1
+
require_relative 'minisky'
2
+
3
+
class Minisky
4
+
5
+
#
6
+
# Common base error class for Minisky errors.
7
+
#
8
+
class Error < StandardError
9
+
end
10
+
11
+
#
12
+
# Raised when a required token or credentials are missing or invalid.
13
+
#
14
+
class AuthError < Error
15
+
end
16
+
17
+
#
18
+
# Raised when the API returns an error status code.
19
+
#
20
+
class BadResponse < Error
21
+
22
+
# @return [Integer] HTTP status code
23
+
attr_reader :status
24
+
25
+
# @return [String, Hash] response data (JSON hash or string)
26
+
attr_reader :data
27
+
28
+
# @param status [Integer] HTTP status code
29
+
# @param status_message [String] HTTP status message
30
+
# @param data [Hash, String] response data (JSON hash or string)
31
+
#
32
+
def initialize(status, status_message, data)
33
+
@status = status
34
+
@data = data
35
+
36
+
message = if error_message
37
+
"#{status} #{status_message}: #{error_message}"
38
+
else
39
+
"#{status} #{status_message}"
40
+
end
41
+
42
+
super(message)
43
+
end
44
+
45
+
# @return [String, nil] machine-readable error code from the response data
46
+
def error_type
47
+
@data['error'] if @data.is_a?(Hash)
48
+
end
49
+
50
+
# @return [String, nil] human-readable error message from the response data
51
+
def error_message
52
+
@data['message'] if @data.is_a?(Hash)
53
+
end
54
+
end
55
+
56
+
#
57
+
# Raised when the API returns a client error status code (4xx).
58
+
#
59
+
class ClientErrorResponse < BadResponse
60
+
end
61
+
62
+
#
63
+
# Raised when the API returns a server error status code (5xx).
64
+
#
65
+
class ServerErrorResponse < BadResponse
66
+
end
67
+
68
+
#
69
+
# Raised when the API returns an error indicating that the access or request
70
+
# token that was passed in the header is expired.
71
+
#
72
+
class ExpiredTokenError < ClientErrorResponse
73
+
end
74
+
75
+
#
76
+
# Raised when the API returns a redirect status code (3xx). Minisky doesn't
77
+
# currently follow any redirects.
78
+
#
79
+
class UnexpectedRedirect < BadResponse
80
+
81
+
# @return [String] value of the "Location" header
82
+
attr_reader :location
83
+
84
+
# @param status [Integer] HTTP status code
85
+
# @param status_message [String] HTTP status message
86
+
# @param location [String] value of the "Location" header
87
+
#
88
+
def initialize(status, status_message, location)
89
+
super(status, status_message, { 'message' => "Unexpected redirect: #{location}" })
90
+
@location = location
91
+
end
92
+
end
93
+
94
+
#
95
+
# Raised by {Requests#fetch_all} when the `field` parameter isn't set.
96
+
#
97
+
# The message of the exception lists the fields available in the first fetched page.
98
+
#
99
+
# @example Making a request in the console with empty `field`
100
+
# sky = Minisky.new('public.api.bsky.app', nil)
101
+
# # => #<Minisky:0x0000000120f5f6b0 @host="public.api.bsky.app", ...>
102
+
#
103
+
# sky.fetch_all('app.bsky.graph.getFollowers', { actor: 'sdk.blue' })
104
+
# # ./lib/minisky/requests.rb:270:in 'block in Minisky::Requests#fetch_all':
105
+
# # Field parameter not provided; available fields: ["followers"] (Minisky::FieldNotSetError)
106
+
#
107
+
# sky.fetch_all('app.bsky.graph.getFollowers', { actor: 'sdk.blue' }, field: 'followers')
108
+
# # => .....
109
+
#
110
+
class FieldNotSetError < Error
111
+
112
+
# @return [Array<String>] list of fields in the response data
113
+
attr_reader :fields
114
+
115
+
# @param fields [Array<String>] list of fields in the response data
116
+
#
117
+
def initialize(fields)
118
+
@fields = fields
119
+
super("Field parameter not provided; available fields: #{@fields.inspect}")
120
+
end
121
+
end
122
+
end
+70
-5
lib/minisky/minisky.rb
+70
-5
lib/minisky/minisky.rb
···
1
1
require 'yaml'
2
2
3
+
#
4
+
# The default API client class for making requests to AT Protocol servers. Can be used
5
+
# with authentication – with the credentials stored in a YAML file – or without it, for
6
+
# unauthenticated requests only (by passing `nil` as the config file name).
7
+
#
8
+
# @example Authenticated client
9
+
# # Expects a config.yml file like:
10
+
# #
11
+
# # id: test.example.com
12
+
# # pass: secret7
13
+
# #
14
+
# # "id" can be a handle or a DID.
15
+
#
16
+
# sky = Minisky.new('eurosky.social', 'config.yml')
17
+
#
18
+
# feed = sky.get_request('app.bsky.feed.getTimeline', { limit: 100 })
19
+
#
20
+
# @example Unauthenticated client
21
+
# sky = Minisky.new('public.api.bsky.app', nil, progress: '*')
22
+
#
23
+
# follows = sky.get_request('app.bsky.graph.getFollows',
24
+
# { actor: 'atproto.com', limit: 100 },
25
+
# field: 'follows'
26
+
# )
27
+
#
28
+
3
29
class Minisky
4
-
DEFAULT_CONFIG_FILE = 'bluesky.yml'
30
+
31
+
# @return [String] the hostname (or base URL) of the server
32
+
attr_reader :host
5
33
6
-
attr_reader :host, :config
34
+
# @return [Hash] loaded contents of the config file
35
+
attr_reader :config
7
36
8
-
def initialize(host, config_file = DEFAULT_CONFIG_FILE)
37
+
# Creates a new client instance.
38
+
#
39
+
# @param host [String] the hostname (or base URL) of the server
40
+
# @param config_file [String, nil] path to the YAML config file, or `nil` for unauthenticated client
41
+
# @param options [Hash] option properties to set on the new instance (see {Minisky::Requests} properties)
42
+
#
43
+
# @raise [AuthError] if the config file is missing an ID or password
44
+
#
45
+
def initialize(host, config_file, options = {})
9
46
@host = host
10
47
@config_file = config_file
11
-
@config = YAML.load(File.read(@config_file))
48
+
49
+
if @config_file
50
+
@config = YAML.load(File.read(@config_file))
51
+
52
+
if user.id.nil? || user.pass.nil?
53
+
raise AuthError, "Missing user id or password in the config file #{@config_file}"
54
+
end
55
+
else
56
+
@config = nil
57
+
end
58
+
59
+
if active_repl?
60
+
@default_progress = '.'
61
+
end
62
+
63
+
if options
64
+
options.each do |k, v|
65
+
self.send("#{k}=", v)
66
+
end
67
+
end
12
68
end
13
69
14
70
def save_config
15
-
File.write(@config_file, YAML.dump(@config))
71
+
File.write(@config_file, YAML.dump(@config)) if @config_file
72
+
end
73
+
74
+
75
+
private
76
+
77
+
def active_repl?
78
+
return true if defined?(IRB) && IRB.respond_to?(:CurrentContext) && IRB.CurrentContext
79
+
return true if defined?(Pry) && Pry.respond_to?(:cli) && Pry.cli
80
+
false
16
81
end
17
82
end
18
83
+437
-31
lib/minisky/requests.rb
+437
-31
lib/minisky/requests.rb
···
1
1
require_relative 'minisky'
2
+
require_relative 'errors'
2
3
4
+
require 'base64'
3
5
require 'json'
4
6
require 'net/http'
5
-
require 'open-uri'
7
+
require 'time'
6
8
require 'uri'
7
9
8
10
class Minisky
9
11
class User
10
12
def initialize(config)
11
13
@config = config
14
+
end
15
+
16
+
def has_credentials?
17
+
!!(id && pass)
12
18
end
13
19
14
20
def logged_in?
15
21
!!(access_token && refresh_token)
16
22
end
17
23
18
-
def method_missing(name)
19
-
@config[name.to_s]
24
+
def method_missing(name, *args)
25
+
if name.to_s.end_with?('=')
26
+
@config[name.to_s.chop] = args[0]
27
+
else
28
+
@config[name.to_s]
29
+
end
20
30
end
21
31
end
22
32
33
+
# Regexp for NSID identifiers, used in lexicon names for record collection and API endpoints
34
+
NSID_REGEXP = /^[a-zA-Z]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(\.[a-zA-Z]([a-zA-Z]{0,61}[a-zA-Z])?)$/
35
+
36
+
#
37
+
# This module contains most of the Minisky code for making HTTP requests and managing
38
+
# authentication tokens. The module is included into the {Minisky} API client class and you'll
39
+
# normally use it through that class, but you can also include it into your custom class if you
40
+
# want to implement the data storage differently than using a local YAML file as {Minisky} does.
41
+
#
42
+
23
43
module Requests
44
+
45
+
# A character to print before each request in {#fetch_all} as a progress indicator.
46
+
# Can also be passed explicitly instead or overridden using the `progress:` parameter.
47
+
# Default is `'.'` when running inside IRB, and `nil` otherwise.
48
+
#
49
+
# @return [String, nil]
50
+
#
24
51
attr_accessor :default_progress
25
52
53
+
attr_writer :send_auth_headers
54
+
attr_writer :auto_manage_tokens
55
+
56
+
# Tells whether to set authentication headers automatically (default: true if there
57
+
# is a user config).
58
+
#
59
+
# If false, you will need to pass `auth: 'sometoken'` explicitly to requests that
60
+
# require authentication.
61
+
#
62
+
# @return [Boolean] whether to set authentication headers in requests
63
+
#
64
+
def send_auth_headers
65
+
instance_variable_defined?('@send_auth_headers') ? @send_auth_headers : (config != nil)
66
+
end
67
+
68
+
# Tells whether the library should manage the access & refresh tokens automatically
69
+
# for you (default: true if there is a user config).
70
+
#
71
+
# If true, {#check_access} is called before each request to make sure that there is a
72
+
# fresh access token available; if false, you will need to call {#log_in} and
73
+
# {#perform_token_refresh} manually when needed.
74
+
#
75
+
# @return [Boolean] whether to automatically manage access tokens
76
+
#
77
+
def auto_manage_tokens
78
+
instance_variable_defined?('@auto_manage_tokens') ? @auto_manage_tokens : (config != nil)
79
+
end
80
+
81
+
alias progress default_progress
82
+
alias progress= default_progress=
83
+
26
84
def base_url
27
-
@base_url ||= "https://#{host}/xrpc"
85
+
if host.include?('://')
86
+
host.chomp('/') + '/xrpc'
87
+
else
88
+
"https://#{host}/xrpc"
89
+
end
28
90
end
29
91
30
92
def user
31
-
@user ||= User.new(config)
93
+
@user ||= config && User.new(config)
32
94
end
33
95
34
-
def get_request(method, params = nil, auth: true)
35
-
headers = authentication_header(auth)
36
-
url = URI("#{base_url}/#{method}")
96
+
# Sends a GET request to the service's API.
97
+
#
98
+
# @param method [String, URI] an XRPC endpoint name or a full URL
99
+
# @param params [Hash, nil] query parameters
100
+
#
101
+
# @param auth [Boolean, String]
102
+
# boolean value which tells whether to send an auth header with the access token or not,
103
+
# or an explicit bearer token to use
104
+
# @param headers [Hash, nil]
105
+
# additional headers to include
106
+
#
107
+
# @return [Hash, String] parsed JSON hash for JSON responses, or raw response body otherwise
108
+
#
109
+
# @raise [ArgumentError] if method name is invalid
110
+
# @raise [BadResponse] if the HTTP response has an error status code
111
+
# @raise [AuthError]
112
+
# - if logging in is required, but login or password isn't provided
113
+
# - if token refresh is needed, but refresh token is missing
114
+
# - if a token has invalid format
115
+
# - if required access token is missing, and {#auto_manage_tokens} is disabled
116
+
#
117
+
# @example Unauthenticated call
118
+
# sky = Minisky.new('public.api.bsky.app', nil)
119
+
# profile = sky.get_request('app.bsky.actor.getProfile', { actor: 'ec.europa.eu' })
120
+
#
121
+
# @example Authenticated call
122
+
# sky = Minisky.new('blacksky.app', 'config.yml')
123
+
# feed = sky.get_request('app.bsky.feed.getTimeline', { limit: 100 })
124
+
125
+
def get_request(method, params = nil, auth: default_auth_mode, headers: nil)
126
+
check_access if auto_manage_tokens && auth == true
127
+
128
+
headers = authentication_header(auth).merge(headers || {})
129
+
url = build_request_uri(method)
37
130
38
131
if params && !params.empty?
39
132
url.query = URI.encode_www_form(params)
40
133
end
41
134
42
-
JSON.parse(URI.open(url, headers).read)
135
+
request = Net::HTTP::Get.new(url, headers)
136
+
137
+
response = make_request(request)
138
+
handle_response(response)
43
139
end
44
140
45
-
def post_request(method, params = nil, auth: true)
46
-
headers = authentication_header(auth).merge({ "Content-Type" => "application/json" })
47
-
body = params ? params.to_json : ''
141
+
# Sends a POST request to the service's API.
142
+
#
143
+
# @param method [String, URI] an XRPC endpoint name or a full URL
144
+
# @param data [Hash, String, nil] JSON or string data to send
145
+
#
146
+
# @param auth [Boolean, String]
147
+
# boolean value which tells whether to send an auth header with the access token or not,
148
+
# or an explicit bearer token to use
149
+
# @param headers [Hash, nil]
150
+
# additional headers to include
151
+
# @param params [Hash, nil]
152
+
# query parameters to append to the URL
153
+
#
154
+
# @return [Hash, String] parsed JSON hash for JSON responses, or raw response body otherwise
155
+
#
156
+
# @raise [ArgumentError] if method name is invalid
157
+
# @raise [BadResponse] if the HTTP response has an error status code
158
+
# @raise [AuthError]
159
+
# - if logging in is required, but login or password isn't provided
160
+
# - if token refresh is needed, but refresh token is missing
161
+
# - if a token has invalid format
162
+
# - if required access token is missing, and {#auto_manage_tokens} is disabled
163
+
#
164
+
# @example Making a Bluesky post
165
+
# sky = Minisky.new('lab.martianbase.net', 'config.yml')
166
+
#
167
+
# sky.post_request('com.atproto.repo.createRecord', {
168
+
# repo: sky.user.did,
169
+
# collection: 'app.bsky.feed.post',
170
+
# record: {
171
+
# text: "Hello Bluesky!",
172
+
# createdAt: Time.now.iso8601,
173
+
# langs: ['en']
174
+
# }
175
+
# })
48
176
49
-
response = Net::HTTP.post(URI("#{base_url}/#{method}"), body, headers)
50
-
raise "Invalid response: #{response.code} #{response.body}" if response.code.to_i / 100 != 2
177
+
def post_request(method, data = nil, auth: default_auth_mode, headers: nil, params: nil)
178
+
check_access if auto_manage_tokens && auth == true
179
+
180
+
headers = authentication_header(auth).merge(headers || {})
181
+
182
+
if data.is_a?(String) || data.nil?
183
+
body = data.to_s
184
+
else
185
+
body = data.to_json
186
+
headers["Content-Type"] = "application/json" unless headers.keys.any? { |k| k.to_s.downcase == 'content-type' }
187
+
end
188
+
189
+
url = build_request_uri(method)
51
190
52
-
JSON.parse(response.body)
191
+
if params && !params.empty?
192
+
url.query = URI.encode_www_form(params)
193
+
end
194
+
195
+
response = Net::HTTP.post(url, body, headers)
196
+
handle_response(response)
53
197
end
54
198
55
-
def fetch_all(method, params = nil, field:,
56
-
auth: true, break_when: nil, max_pages: nil, progress: @default_progress)
199
+
# Fetches and merges paginated responses from a service's endpoint in a loop, updating the
200
+
# cursor after each page, until the cursor is nil or a break condition is met. The data is
201
+
# extracted from a designated field of the response (`field`) and added to a single array,
202
+
# which is returned at the end.
203
+
#
204
+
# A condition for when the fetching should stop can be passed as a block in `break_when`, or
205
+
# alternatively, a max number of pages can be passed to `max_pages` (or both together). If
206
+
# neither is set, the fetching continues until the server returns an empty cursor.
207
+
#
208
+
# When experimenting in the Ruby console, you can pass `nil` as `field` (or skip the parameter)
209
+
# to make a single request and raise an exception, which will tell you what fields are available.
210
+
#
211
+
# @param method [String, URI] an XRPC endpoint name or a full URL
212
+
# @param params [Hash, nil] query parameters
213
+
#
214
+
# @param auth [Boolean, String]
215
+
# boolean value which tells whether to send an auth header with the access token or not,
216
+
# or an explicit bearer token to use
217
+
# @param field [String, nil]
218
+
# name of the field in the responses which contains the data array
219
+
# @param break_when [Proc, nil]
220
+
# if passed, the fetching will stop when the block returns true for any of the
221
+
# returned records, and records matching the condition will be deleted from the last page
222
+
# @param max_pages [Integer, nil]
223
+
# maximum number of pages to fetch
224
+
# @param headers [Hash, nil]
225
+
# additional headers to include
226
+
# @param progress [String, nil]
227
+
# a character to print before each request as a progress indicator
228
+
#
229
+
# @return [Array] records or objects collected from all pages
230
+
#
231
+
# @raise [ArgumentError] if method name is invalid
232
+
# @raise [FieldNotSetError] if field parameter wasn't set (the message tells you what fields were in the response)
233
+
# @raise [BadResponse] if the HTTP response has an error status code
234
+
# @raise [AuthError]
235
+
# - if logging in is required, but login or password isn't provided
236
+
# - if token refresh is needed, but refresh token is missing
237
+
# - if a token has invalid format
238
+
# - if required access token is missing, and {#auto_manage_tokens} is disabled
239
+
#
240
+
# @example Fetching with a `break_when` block
241
+
# sky = Minisky.new('public.api.bsky.app', nil)
242
+
# time_limit = Time.now - 86400 * 30
243
+
#
244
+
# sky.fetch_all('app.bsky.feed.getAuthorFeed',
245
+
# { actor: 'pfrazee.com', limit: 100 },
246
+
# field: 'feed',
247
+
# progress: '|',
248
+
# break_when: ->(x) { Time.at(x['post']['record']['createdAt']) < time_limit }
249
+
# )
250
+
#
251
+
# @example Fetching with `max_pages`
252
+
# sky = Minisky.new('tngl.sh', 'config.yml')
253
+
# sky.fetch_all('app.bsky.feed.getTimeline', { limit: 100 }, field: 'feed', max_pages: 10)
254
+
#
255
+
# @example Making a request in the console with empty `field`
256
+
# sky = Minisky.new('public.api.bsky.app', nil)
257
+
# # => #<Minisky:0x0000000120f5f6b0 @host="public.api.bsky.app", ...>
258
+
#
259
+
# sky.fetch_all('app.bsky.graph.getFollowers', { actor: 'sdk.blue' })
260
+
# # ./lib/minisky/requests.rb:270:in 'block in Minisky::Requests#fetch_all':
261
+
# # Field parameter not provided; available fields: ["followers"] (Minisky::FieldNotSetError)
262
+
#
263
+
# sky.fetch_all('app.bsky.graph.getFollowers', { actor: 'sdk.blue' }, field: 'followers')
264
+
# # => .....
265
+
266
+
def fetch_all(method, params = nil, auth: default_auth_mode,
267
+
field: nil, break_when: nil, max_pages: nil, headers: nil, progress: @default_progress)
57
268
data = []
58
269
params = {} if params.nil?
59
270
pages = 0
···
61
272
loop do
62
273
print(progress) if progress
63
274
64
-
response = get_request(method, params, auth: auth)
275
+
response = get_request(method, params, auth: auth, headers: headers)
276
+
277
+
if field.nil?
278
+
raise FieldNotSetError, response.keys.select { |f| response[f].is_a?(Array) }
279
+
end
280
+
65
281
records = response[field]
66
282
cursor = response['cursor']
67
283
···
69
285
params[:cursor] = cursor
70
286
pages += 1
71
287
72
-
break if !cursor || records.empty? || pages == max_pages
288
+
break if !cursor || pages == max_pages
73
289
break if break_when && records.any? { |x| break_when.call(x) }
74
290
end
75
291
···
77
293
data
78
294
end
79
295
296
+
# Ensures that the user has a fresh access token, by checking the access token's expiry date
297
+
# and performing a refresh if needed, or by logging in with a password if no tokens are present.
298
+
#
299
+
# If {#auto_manage_tokens} is enabled (the default setting), this method is automatically called
300
+
# before {#get_request}, {#post_request} and {#fetch_all}, so you generally don't need to call it
301
+
# yourself.
302
+
#
303
+
# @return [Symbol]
304
+
# - `:logged_in` if a login using a password was performed
305
+
# - `:refreshed` if the access token was expired and was refreshed
306
+
# - `:ok` if no refresh was needed
307
+
# - `:unknown` if the token is not a valid JWT (e.g. an opaque blob)
308
+
#
309
+
# @raise [BadResponse] if login or refresh returns an error status code
310
+
# @raise [AuthError]
311
+
# - if the client doesn't include user config at all
312
+
# - if logging in is required, but login or password isn't provided
313
+
# - if token refresh is needed, but refresh token is missing
314
+
80
315
def check_access
81
-
if !user.logged_in?
316
+
if !user
317
+
raise AuthError, "User config is missing"
318
+
elsif !user.has_credentials?
319
+
raise AuthError, "User id or password is missing"
320
+
elsif !user.logged_in?
82
321
log_in
322
+
return :logged_in
323
+
end
324
+
325
+
begin
326
+
expired = access_token_expired?
327
+
rescue AuthError
328
+
return :unknown
329
+
end
330
+
331
+
if expired
332
+
perform_token_refresh
333
+
:refreshed
83
334
else
84
-
begin
85
-
get_request('com.atproto.server.getSession')
86
-
rescue OpenURI::HTTPError
87
-
perform_token_refresh
88
-
end
335
+
:ok
89
336
end
90
337
end
91
338
339
+
# Logs in the user using an ID and password stored in the config by calling the
340
+
# `createSession` endpoint, and stores the received access & refresh tokens.
341
+
#
342
+
# This is generally handled automatically by {#check_access}. Calling this method
343
+
# repeatedly many times in a short period of time may use up your rate limit for this
344
+
# endpoint (which is lower than for others) and make it inaccessible to you for some
345
+
# time.
346
+
#
347
+
# @return [Hash] the response JSON with access tokens
348
+
#
349
+
# @raise [AuthError] if login or password are missing
350
+
# @raise [BadResponse] if the server responds with an error status code
351
+
92
352
def log_in
353
+
if user.nil? || !user.has_credentials?
354
+
raise AuthError, "To log in, please provide a user id and password"
355
+
end
356
+
93
357
data = {
94
358
identifier: user.id,
95
359
password: user.pass
96
360
}
97
361
362
+
if user.id =~ /\A[^@]+@[^@]+\z/
363
+
STDERR.puts "Warning: logging in using an email address is deprecated in Minisky and will be " +
364
+
"removed in a future version. Use either a handle or a DID instead."
365
+
end
366
+
98
367
json = post_request('com.atproto.server.createSession', data, auth: false)
99
368
100
-
config['did'] = json['did']
101
-
config['access_token'] = json['accessJwt']
102
-
config['refresh_token'] = json['refreshJwt']
369
+
user.did = json['did']
370
+
user.access_token = json['accessJwt']
371
+
user.refresh_token = json['refreshJwt']
103
372
104
373
save_config
105
374
json
106
375
end
107
376
377
+
# Refreshes the access token using the stored refresh token. If successful, this
378
+
# invalidates *both* old tokens and replaces them with new ones from the response.
379
+
#
380
+
# If {#auto_manage_tokens} is enabled (the default setting), this method is automatically called
381
+
# before any requests through {#check_access}, so you generally don't need to call it yourself.
382
+
#
383
+
# @return [Hash] the response JSON with access tokens
384
+
#
385
+
# @raise [AuthError] if the refresh token is missing
386
+
# @raise [BadResponse] if the server responds with an error status code
387
+
108
388
def perform_token_refresh
389
+
if user&.refresh_token.nil?
390
+
raise AuthError, "Can't refresh access token - refresh token is missing"
391
+
end
392
+
109
393
json = post_request('com.atproto.server.refreshSession', auth: user.refresh_token)
110
394
111
-
config['access_token'] = json['accessJwt']
112
-
config['refresh_token'] = json['refreshJwt']
395
+
user.access_token = json['accessJwt']
396
+
user.refresh_token = json['refreshJwt']
113
397
114
398
save_config
115
399
json
116
400
end
117
401
402
+
# Attempts to parse a given token as JWT and extract the expiration date from the payload.
403
+
# An access token technically isn't required to be a (valid) JWT, so if the parsing fails
404
+
# for whatever reason, nil is returned.
405
+
#
406
+
# @return [Time, nil] parsed expiration time, or nil if token is not a valid JWT
407
+
408
+
def token_expiration_date(token)
409
+
return nil unless token.valid_encoding?
410
+
411
+
parts = token.split('.')
412
+
return nil unless parts.length == 3
413
+
414
+
begin
415
+
payload = JSON.parse(Base64.decode64(parts[1]))
416
+
rescue JSON::ParserError
417
+
return nil
418
+
end
419
+
420
+
exp = payload['exp']
421
+
return nil unless exp.is_a?(Numeric) && exp > 0
422
+
423
+
time = Time.at(exp)
424
+
return nil if time.year < 2023 || time.year > 2100
425
+
426
+
time
427
+
end
428
+
429
+
# Attempts to parse the user's access token as JWT, extract the expiration date from the
430
+
# payload, and check if the token hasn't expired yet.
431
+
#
432
+
# @return [Boolean] true if the token's expiration time is more than a minute away
433
+
# @raise [AuthError] if the token is not a valid JWT, or user is not logged in
434
+
435
+
def access_token_expired?
436
+
if user&.access_token.nil?
437
+
raise AuthError, "No access token (user is not logged in)"
438
+
end
439
+
440
+
exp_date = token_expiration_date(user.access_token)
441
+
442
+
if exp_date
443
+
exp_date < Time.now + 60
444
+
else
445
+
raise AuthError, "Token expiration date cannot be decoded"
446
+
end
447
+
end
448
+
449
+
#
450
+
# Clear stored access and refresh tokens, effectively logging out the user.
451
+
#
452
+
# @raise [AuthError] if the client doesn't have a user config
453
+
#
454
+
455
+
def reset_tokens
456
+
if !user
457
+
raise AuthError, "User config is missing"
458
+
end
459
+
460
+
user.access_token = nil
461
+
user.refresh_token = nil
462
+
save_config
463
+
nil
464
+
end
465
+
466
+
if RUBY_VERSION.to_i == 2
467
+
require_relative 'compat'
468
+
prepend Ruby2Compat
469
+
end
470
+
471
+
118
472
private
119
473
474
+
def make_request(request)
475
+
# this long form is needed because #get_response only supports a headers param in Ruby 3.x
476
+
response = Net::HTTP.start(request.uri.hostname, request.uri.port, use_ssl: (request.uri.scheme == 'https')) do |http|
477
+
http.request(request)
478
+
end
479
+
end
480
+
481
+
def build_request_uri(method)
482
+
if method.is_a?(URI)
483
+
method
484
+
elsif method.include?('://')
485
+
URI(method)
486
+
elsif method =~ NSID_REGEXP
487
+
URI("#{base_url}/#{method}")
488
+
else
489
+
raise ArgumentError, "Invalid method name #{method.inspect} (should be an NSID, URL or an URI object)"
490
+
end
491
+
end
492
+
493
+
def default_auth_mode
494
+
!!send_auth_headers
495
+
end
496
+
120
497
def authentication_header(auth)
121
498
if auth.is_a?(String)
122
499
{ 'Authorization' => "Bearer #{auth}" }
123
500
elsif auth
124
-
{ 'Authorization' => "Bearer #{user.access_token}" }
501
+
if user&.access_token
502
+
{ 'Authorization' => "Bearer #{user.access_token}" }
503
+
else
504
+
raise AuthError, "Can't send auth headers, access token is missing"
505
+
end
125
506
else
126
507
{}
508
+
end
509
+
end
510
+
511
+
def handle_response(response)
512
+
status = response.code.to_i
513
+
message = response.message
514
+
response_body = (response.content_type == 'application/json') ? JSON.parse(response.body) : response.body
515
+
516
+
case response
517
+
when Net::HTTPSuccess
518
+
response_body
519
+
when Net::HTTPRedirection
520
+
raise UnexpectedRedirect.new(status, message, response['location'])
521
+
else
522
+
error_class = if response_body.is_a?(Hash) && response_body['error'] == 'ExpiredToken'
523
+
ExpiredTokenError
524
+
elsif response.is_a?(Net::HTTPClientError)
525
+
ClientErrorResponse
526
+
elsif response.is_a?(Net::HTTPServerError)
527
+
ServerErrorResponse
528
+
else
529
+
BadResponse
530
+
end
531
+
532
+
raise error_class.new(status, message, response_body)
127
533
end
128
534
end
129
535
end
+1
-1
lib/minisky/version.rb
+1
-1
lib/minisky/version.rb
+9
-7
minisky.gemspec
+9
-7
minisky.gemspec
···
1
1
# frozen_string_literal: true
2
2
3
-
require_relative "lib/minisky/version"
3
+
minisky_version = File.read(File.join(__dir__, 'lib', 'minisky', 'version.rb')).match(/VERSION = "(.*)"/)[1]
4
4
5
5
Gem::Specification.new do |spec|
6
6
spec.name = "minisky"
7
-
spec.version = Minisky::VERSION
7
+
spec.version = minisky_version
8
8
spec.authors = ["Kuba Suder"]
9
9
spec.email = ["jakub.suder@gmail.com"]
10
10
11
-
spec.summary = "A minimal client of Bluesky/AtProto API"
11
+
spec.summary = "A minimal client of Bluesky/ATProto API"
12
12
spec.description = "A very simple client class that lets you log in to the Bluesky API and make any requests there."
13
-
spec.homepage = "https://github.com/mackuba/minisky"
13
+
spec.homepage = "https://ruby.sdk.blue"
14
14
15
15
spec.license = "Zlib"
16
16
spec.required_ruby_version = ">= 2.6.0"
17
17
18
18
spec.metadata = {
19
-
"bug_tracker_uri" => "https://github.com/mackuba/minisky/issues",
20
-
"changelog_uri" => "https://github.com/mackuba/minisky/blob/master/CHANGELOG.md",
21
-
"source_code_uri" => "https://github.com/mackuba/minisky",
19
+
"bug_tracker_uri" => "https://tangled.org/mackuba.eu/minisky/issues",
20
+
"changelog_uri" => "https://tangled.org/mackuba.eu/minisky/blob/master/CHANGELOG.md",
21
+
"source_code_uri" => "https://tangled.org/mackuba.eu/minisky",
22
22
}
23
23
24
24
spec.files = Dir.chdir(__dir__) do
···
26
26
end
27
27
28
28
spec.require_paths = ["lib"]
29
+
30
+
spec.add_dependency 'base64', '~> 0.1'
29
31
end
+83
-12
spec/custom_client_spec.rb
+83
-12
spec/custom_client_spec.rb
···
1
1
require 'json'
2
+
require_relative 'shared/ex_incomplete_auth'
3
+
require_relative 'shared/ex_requests'
4
+
require_relative 'shared/ex_unauthed'
2
5
3
6
class CustomJSONClient
4
7
CONFIG_FILE = 'test.json'
···
7
10
8
11
attr_reader :config
9
12
10
-
def initialize
11
-
@config = JSON.parse(File.read(CONFIG_FILE))
13
+
def initialize(config_file = CONFIG_FILE)
14
+
@config = config_file && JSON.parse(File.read(config_file))
12
15
end
13
16
14
17
def host
···
20
23
end
21
24
end
22
25
23
-
describe "custom client" do
26
+
describe "in custom client" do
24
27
include FakeFS::SpecHelpers
25
28
26
-
before do
27
-
File.write('test.json', %({
28
-
"id": "john.foo",
29
-
"pass": "hunter2",
30
-
"access_token": "aatoken",
31
-
"refresh_token": "rrtoken"
32
-
}))
33
-
end
29
+
let(:data) {{
30
+
'id' => 'john.foo',
31
+
'pass' => 'hunter2',
32
+
'access_token' => 'aatoken',
33
+
'refresh_token' => 'rrtoken'
34
+
}}
34
35
35
36
subject { CustomJSONClient.new }
36
37
37
38
let(:reloaded_config) { JSON.parse(File.read('test.json')) }
38
39
39
-
include_examples "Requests", 'at.x.com'
40
+
context 'with correct config,' do
41
+
before do
42
+
File.write('test.json', JSON.generate(data))
43
+
end
44
+
45
+
it 'should send auth headers by default' do
46
+
subject.send_auth_headers.should == true
47
+
end
48
+
49
+
it 'should manage tokens by default' do
50
+
subject.auto_manage_tokens.should == true
51
+
end
52
+
53
+
it 'should not set default progress' do
54
+
subject.progress.should be_nil
55
+
end
56
+
57
+
describe '(requests)' do
58
+
include_examples "authenticated requests", 'at.x.com'
59
+
end
60
+
end
61
+
62
+
context 'with no user config,' do
63
+
subject { CustomJSONClient.new(nil) }
64
+
65
+
it 'should not send auth headers' do
66
+
subject.send_auth_headers.should == false
67
+
end
68
+
69
+
it 'should not manage tokens' do
70
+
subject.auto_manage_tokens.should == false
71
+
end
72
+
73
+
it 'should not set default progress' do
74
+
subject.progress.should be_nil
75
+
end
76
+
77
+
include_examples "unauthenticated user"
78
+
end
79
+
80
+
context 'if id field is nil,' do
81
+
before do
82
+
File.write('test.json', JSON.generate(id: nil, pass: 'ok'))
83
+
end
84
+
85
+
include_examples "custom client with incomplete auth"
86
+
end
87
+
88
+
context 'if id field is not included' do
89
+
before do
90
+
File.write('test.json', JSON.generate(pass: 'ok'))
91
+
end
92
+
93
+
include_examples "custom client with incomplete auth"
94
+
end
95
+
96
+
context 'if pass field is nil' do
97
+
before do
98
+
File.write('test.json', JSON.generate(id: 'id', pass: nil))
99
+
end
100
+
101
+
include_examples "custom client with incomplete auth"
102
+
end
103
+
104
+
context 'if pass field is not included' do
105
+
before do
106
+
File.write('test.json', JSON.generate(id: 'id'))
107
+
end
108
+
109
+
include_examples "custom client with incomplete auth"
110
+
end
40
111
end
+250
-41
spec/minisky_spec.rb
+250
-41
spec/minisky_spec.rb
···
1
1
require 'yaml'
2
+
require_relative 'shared/ex_requests'
3
+
require_relative 'shared/ex_unauthed'
4
+
5
+
data = {
6
+
'id' => 'john.foo',
7
+
'pass' => 'hunter2',
8
+
'access_token' => 'aatoken',
9
+
'refresh_token' => 'rrtoken'
10
+
}.freeze
11
+
12
+
host = 'bsky.test'
2
13
3
14
describe Minisky do
4
15
include FakeFS::SpecHelpers
5
16
6
-
let(:host) { 'bsky.test' }
17
+
subject { Minisky.new(host, 'myconfig.yml') }
18
+
19
+
it 'should have a version number' do
20
+
Minisky::VERSION.should_not be_nil
21
+
end
22
+
23
+
context 'if id field is nil' do
24
+
before do
25
+
File.write('myconfig.yml', YAML.dump(data.merge('id' => nil)))
26
+
end
27
+
28
+
it 'should raise AuthError' do
29
+
expect { subject }.to raise_error(Minisky::AuthError)
30
+
end
31
+
end
32
+
33
+
context 'if id field is not included' do
34
+
before do
35
+
File.write('myconfig.yml', YAML.dump(data.slice('pass', 'access_token', 'refresh_token')))
36
+
end
37
+
38
+
it 'should raise AuthError' do
39
+
expect { subject }.to raise_error(Minisky::AuthError)
40
+
end
41
+
end
42
+
43
+
context 'if pass field is nil' do
44
+
before do
45
+
File.write('myconfig.yml', YAML.dump(data.merge('pass' => nil)))
46
+
end
7
47
8
-
context 'with a default config file name' do
48
+
it 'should raise AuthError' do
49
+
expect { subject }.to raise_error(Minisky::AuthError)
50
+
end
51
+
end
52
+
53
+
context 'if pass field is not included' do
9
54
before do
10
-
File.write('bluesky.yml', %(
11
-
id: john.foo
12
-
pass: hunter2
13
-
access_token: aatoken
14
-
refresh_token: rrtoken
15
-
))
55
+
File.write('myconfig.yml', YAML.dump(data.slice('id', 'access_token', 'refresh_token')))
56
+
end
57
+
58
+
it 'should raise AuthError' do
59
+
expect { subject }.to raise_error(Minisky::AuthError)
60
+
end
61
+
end
62
+
63
+
context 'with correct config' do
64
+
before do
65
+
File.write('myconfig.yml', YAML.dump(data))
66
+
end
67
+
68
+
it 'should send auth headers by default' do
69
+
subject.send_auth_headers.should == true
70
+
end
71
+
72
+
it 'should manage tokens by default' do
73
+
subject.auto_manage_tokens.should == true
74
+
end
75
+
76
+
it 'should set host and config properties' do
77
+
subject.host.should == host
78
+
subject.config.should be_a(Hash)
79
+
subject.config.should == data
80
+
end
81
+
end
82
+
83
+
context 'without a config' do
84
+
subject { Minisky.new(host, nil) }
85
+
86
+
it 'should not send auth headers' do
87
+
subject.send_auth_headers.should == false
88
+
end
89
+
90
+
it 'should not manage tokens' do
91
+
subject.auto_manage_tokens.should == false
92
+
end
93
+
94
+
it 'should set host property' do
95
+
subject.host.should == host
96
+
end
97
+
98
+
it 'should set config to nil' do
99
+
subject.config.should be_nil
100
+
end
101
+
end
102
+
103
+
context 'if running inside IRB' do
104
+
subject { Minisky.new(host, nil) }
105
+
106
+
before do
107
+
load File.join(__dir__, 'shared', 'fake_irb.rb')
108
+
end
109
+
110
+
it 'should set default_progress to "."' do
111
+
subject.default_progress.should == '.'
112
+
end
113
+
114
+
after do
115
+
Object.send(:remove_const, :IRB)
116
+
end
117
+
end
118
+
119
+
context 'if running inside Pry' do
120
+
subject { Minisky.new(host, nil) }
121
+
122
+
before do
123
+
load File.join(__dir__, 'shared', 'fake_pry.rb')
124
+
end
125
+
126
+
it 'should set default_progress to "."' do
127
+
subject.default_progress.should == '.'
128
+
end
129
+
130
+
after do
131
+
Object.send(:remove_const, :Pry)
132
+
end
133
+
end
134
+
135
+
context 'if not running inside a REPL' do
136
+
subject { Minisky.new(host, nil) }
137
+
138
+
it 'should keep default_progress unset' do
139
+
subject.default_progress.should be_nil
140
+
end
141
+
end
142
+
143
+
it 'should let you pass additional options and set them' do
144
+
File.write('myconfig.yml', YAML.dump(data))
145
+
146
+
minisky = Minisky.new(host, 'myconfig.yml', auto_manage_tokens: false, progress: '*')
147
+
minisky.auto_manage_tokens.should == false
148
+
minisky.default_progress.should == '*'
149
+
end
150
+
151
+
describe '#token_expiration_date' do
152
+
subject { Minisky.new(host, nil) }
153
+
154
+
it 'should return nil for tokens with invalid encoding' do
155
+
token = "bad\xC3".force_encoding('UTF-8')
156
+
subject.token_expiration_date(token).should be_nil
157
+
end
158
+
159
+
it 'should return nil when the token does not have three parts' do
160
+
subject.token_expiration_date('token').should be_nil
161
+
subject.token_expiration_date('one.two').should be_nil
162
+
subject.token_expiration_date('1.2.3.4').should be_nil
163
+
164
+
token = make_token(Time.now + 3600)
165
+
subject.token_expiration_date(token + '.qwe').should be_nil
166
+
end
167
+
168
+
it 'should return nil when the payload is not valid JSON' do
169
+
token = ['header', Base64.strict_encode64('nope'), 'sig'].join('.')
170
+
subject.token_expiration_date(token).should be_nil
16
171
end
17
172
18
-
subject { Minisky.new(host) }
173
+
it 'should return nil when exp field is missing' do
174
+
token = ['header', Base64.strict_encode64(JSON.generate({ 'aud' => 'aaaa' })), 'sig'].join('.')
175
+
subject.token_expiration_date(token).should be_nil
176
+
end
177
+
178
+
it 'should return nil when exp field is not a number' do
179
+
token = ['header', Base64.strict_encode64(JSON.generate({ 'exp' => 'soon' })), 'sig'].join('.')
180
+
subject.token_expiration_date(token).should be_nil
181
+
end
182
+
183
+
it 'should return nil when exp field is not a positive number' do
184
+
token = ['header', Base64.strict_encode64(JSON.generate({ 'exp' => 0 })), 'sig'].join('.')
185
+
subject.token_expiration_date(token).should be_nil
186
+
end
19
187
20
-
let(:reloaded_config) { YAML.load(File.read('bluesky.yml')) }
188
+
it 'should return nil when expiration year is before 2023' do
189
+
token = make_token(Time.utc(2022, 12, 24, 19, 00, 00))
190
+
subject.token_expiration_date(token).should be_nil
191
+
end
21
192
22
-
it 'should have a version number' do
23
-
Minisky::VERSION.should_not be_nil
193
+
it 'should return nil when expiration year is after 2100' do
194
+
token = make_token(Time.utc(2101, 5, 5, 0, 0, 0))
195
+
subject.token_expiration_date(token).should be_nil
24
196
end
25
197
26
-
include_examples "Requests", 'bsky.test'
198
+
it 'should return the expiration time for a valid token' do
199
+
time = Time.at(Time.now.to_i + 7200)
200
+
token = make_token(time)
201
+
subject.token_expiration_date(token).should == time
202
+
end
27
203
end
28
204
29
-
context 'with a custom config file name' do
205
+
describe '#access_token_expired?' do
206
+
let(:config) { data }
207
+
30
208
before do
31
-
File.write('myconfig.yml', %(
32
-
id: john.foo
33
-
pass: hunter2
34
-
access_token: aatoken
35
-
refresh_token: rrtoken
36
-
))
209
+
File.write('myconfig.yml', YAML.dump(config))
210
+
end
211
+
212
+
context 'when there is no user config' do
213
+
subject { Minisky.new(host, nil) }
214
+
215
+
it 'should raise AuthError' do
216
+
expect { subject.access_token_expired? }.to raise_error(Minisky::AuthError)
217
+
end
37
218
end
38
219
39
-
subject { Minisky.new(host, 'myconfig.yml') }
220
+
context 'when access token is missing' do
221
+
let(:config) { data.merge('access_token' => nil) }
40
222
41
-
let(:reloaded_config) { YAML.load(File.read('myconfig.yml')) }
223
+
it 'should raise AuthError' do
224
+
expect { subject.access_token_expired? }.to raise_error(Minisky::AuthError)
225
+
end
226
+
end
42
227
43
-
it 'should load config from a file' do
44
-
subject.user.id.should == 'john.foo'
45
-
subject.user.access_token.should == 'aatoken'
46
-
subject.user.refresh_token.should == 'rrtoken'
228
+
context 'when token expiration cannot be decoded' do
229
+
let(:config) { data.merge('access_token' => 'blob') }
230
+
231
+
it 'should raise AuthError' do
232
+
expect { subject.access_token_expired? }.to raise_error(Minisky::AuthError)
233
+
end
47
234
end
48
235
49
-
describe '#log_in' do
50
-
before do
51
-
stub_request(:post, "https://#{host}/xrpc/com.atproto.server.createSession")
52
-
.to_return(body: %({
53
-
"did": "did:plc:abracadabra",
54
-
"accessJwt": "aaaa1234",
55
-
"refreshJwt": "rrrr1234"
56
-
}))
236
+
context 'when token expiration date is in the past' do
237
+
let(:config) { data.merge('access_token' => make_token(Time.now - 30)) }
238
+
239
+
it 'should return true' do
240
+
subject.access_token_expired?.should == true
57
241
end
242
+
end
58
243
59
-
it "should save user's DID" do
60
-
subject.log_in
244
+
context 'when token expiration date is in less than 60 seconds' do
245
+
let(:config) { data.merge('access_token' => make_token(Time.now + 50)) }
61
246
62
-
reloaded_config['did'].should == "did:plc:abracadabra"
247
+
it 'should return true' do
248
+
subject.access_token_expired?.should == true
63
249
end
250
+
end
64
251
65
-
it "should update the tokens in the config file" do
66
-
subject.log_in
252
+
context 'when token expiration date is in more than 60 seconds' do
253
+
let(:config) { data.merge('access_token' => make_token(Time.now + 180)) }
67
254
68
-
reloaded_config['access_token'].should == 'aaaa1234'
69
-
reloaded_config['refresh_token'].should == 'rrrr1234'
255
+
it 'should return false' do
256
+
subject.access_token_expired?.should == false
70
257
end
71
258
end
72
259
end
73
260
end
261
+
262
+
describe 'in Minisky instance' do
263
+
include FakeFS::SpecHelpers
264
+
265
+
subject { Minisky.new(host, 'myconfig.yml') }
266
+
267
+
let(:reloaded_config) { YAML.load(File.read('myconfig.yml')) }
268
+
269
+
context 'with correct config,' do
270
+
before do
271
+
File.write('myconfig.yml', YAML.dump(data))
272
+
end
273
+
274
+
include_examples "authenticated requests", 'bsky.test'
275
+
end
276
+
277
+
context 'without a config' do
278
+
subject { Minisky.new(host, nil) }
279
+
280
+
include_examples "unauthenticated user"
281
+
end
282
+
end
+39
spec/spec_config.rb
+39
spec/spec_config.rb
···
1
+
require 'simplecov'
2
+
3
+
SimpleCov.start do
4
+
enable_coverage :branch
5
+
add_filter "/spec/"
6
+
end
7
+
8
+
require 'minisky'
9
+
require 'pp' # needs to be included before fakefs
10
+
require 'fakefs/spec_helpers'
11
+
require 'webmock/rspec'
12
+
13
+
RSpec.configure do |config|
14
+
# Enable flags like --only-failures and --next-failure
15
+
config.example_status_persistence_file_path = ".rspec_status"
16
+
17
+
config.expect_with :rspec do |c|
18
+
c.syntax = [:should, :expect]
19
+
end
20
+
end
21
+
22
+
module SimpleCov
23
+
module Formatter
24
+
class HTMLFormatter
25
+
def format(result)
26
+
# silence the stdout summary, just save the html files
27
+
unless @inline_assets
28
+
Dir[File.join(@public_assets_dir, "*")].each do |path|
29
+
FileUtils.cp_r(path, asset_output_path, remove_destination: true)
30
+
end
31
+
end
32
+
33
+
File.open(File.join(output_path, "index.html"), "wb") do |file|
34
+
file.puts template("layout").result(binding)
35
+
end
36
+
end
37
+
end
38
+
end
39
+
end
+42
-10
spec/spec_helper.rb
+42
-10
spec/spec_helper.rb
···
1
-
require 'minisky'
2
-
require 'pp' # needs to be included before fakefs
1
+
require_relative 'spec_config'
2
+
require 'base64'
3
+
require 'json'
3
4
4
-
require 'fakefs/spec_helpers'
5
-
require 'webmock/rspec'
5
+
INVALID_METHOD_NAMES = [
6
+
'getUsers',
7
+
'127.0.0.1',
8
+
'/xrpc/com.atproto.repo.getRecords',
9
+
'app.bsky.feed.under_score'
10
+
]
6
11
7
-
require 'requests_shared'
12
+
def stub_fetch_all(base_url, responses)
13
+
cursor = nil
14
+
urls = []
8
15
9
-
RSpec.configure do |config|
10
-
# Enable flags like --only-failures and --next-failure
11
-
config.example_status_persistence_file_path = ".rspec_status"
16
+
responses.each_with_index do |r, i|
17
+
url = base_url
18
+
body = r
12
19
13
-
config.expect_with :rspec do |c|
14
-
c.syntax = [:should, :expect]
20
+
if cursor
21
+
url += (url.include?('?') ? '&' : '?') + "cursor=#{cursor}"
22
+
end
23
+
24
+
if i < responses.length - 1
25
+
cursor = rand.to_s
26
+
body = body.merge("cursor" => cursor)
27
+
end
28
+
29
+
stub_request(:get, url).to_return_json(body: body)
30
+
urls << url
15
31
end
32
+
33
+
@stubbed_urls = urls
34
+
end
35
+
36
+
def verify_fetch_all
37
+
@stubbed_urls.each do |url|
38
+
WebMock.should have_requested(:get, url).once
39
+
end
40
+
end
41
+
42
+
def make_token(exp_time)
43
+
header = { alg: 'HS256', typ: 'JWT' }
44
+
payload = { exp: exp_time.to_i }
45
+
signature = 'signature'
46
+
47
+
[header, payload, signature].map { |part| Base64.strict_encode64(JSON.generate(part)) }.join('.')
16
48
end
+21
spec/user_spec.rb
+21
spec/user_spec.rb
···
13
13
subject.email.should == 'admin@bsky.app'
14
14
end
15
15
16
+
it 'should pass setters to the config hash' do
17
+
subject.age = 33
18
+
config['age'].should == 33
19
+
end
20
+
16
21
context '#logged_in?' do
17
22
it 'should return false if access token is missing' do
18
23
subject.logged_in?.should be false
···
30
35
subject.instance_variable_get('@config')['refresh_token'] = 'rrrr'
31
36
subject.instance_variable_get('@config')['access_token'] = 'aaaa'
32
37
subject.logged_in?.should be true
38
+
end
39
+
end
40
+
41
+
context '#has_credentials?' do
42
+
it 'should return false if id is missing' do
43
+
subject.instance_variable_get('@config')['id'] = nil
44
+
subject.has_credentials?.should be false
45
+
end
46
+
47
+
it 'should return false if pass is missing' do
48
+
subject.instance_variable_get('@config')['pass'] = nil
49
+
subject.has_credentials?.should be false
50
+
end
51
+
52
+
it 'should return true if both id and pass are set' do
53
+
subject.has_credentials?.should be true
33
54
end
34
55
end
35
56
end