atproto_client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbbb4053b1b25b1d1d3d37a6ae736570dd8d1bd097d69fde6d7868015fa45ac1
-  data.tar.gz: 0a8cd5beac57a16b965aa7d5487a4896887d820ed012e7526091e28054111c1a
+  metadata.gz: 89742c30ed6ad23210c8e5eaecab1cabd26525419fe040bf1ca1f3a70ea29df7
+  data.tar.gz: 3b3854a97f5b74fb32e8e0cf98ad2566ab1ae652e64b543ff764286e0f0a8c8f
 SHA512:
-  metadata.gz: eac347a2e5d30aa247d1ae27c16aa5df76ee581945c0af5c3cb1fe31575332687b662a9105470ed5634c8912b041b83ed36f0fd5ca6248d44fde387918c0ba87
-  data.tar.gz: 1711570172c8f61c617784c886386b6f2afe7b71c4435e1e353bab7314e1ae3651c64a661526f27915bfa9494e52c897e913c2bf804b8d01bb826d06280da006
+  metadata.gz: 88e12f5de1cb3e7075b42f07350ccccc57414e9e1293b76519b3e29a1682e166a1ec6708606de549ed22c6610add5c8176c40e776e08c1b2e64fb56f5861656a
+  data.tar.gz: d0a350fae5b3eded1590da41a072bf5e9b75641339b1a9e15ef8f58c828b974d67c0d88e463df6da2ea3a390340245e7de4f8f12945ecacb896133aa82d13233

data/README.md

@@ -3,6 +3,12 @@
 Ruby client for the AT Protocol, with support for oauth/dpop authentication. It has been built and tested for bluesky but it should be agnostic of PDS. An omniauth strategy using this layer should appear soon.
 The work is in progress but it should allready work and I'd be happy to have feedbacks.
 
+### TODO
+- [ ] Reject response without DPoP-Nonce header (to respect the spec)
+- [ ] Try to reuse nonce better (currently we double each request to refresh it from the server each time)
+- [ ] Give a better API (it changes at a hight rate currently)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -14,22 +20,23 @@ gem 'atproto_client'
 ## Usage
 
 ```ruby
-# Configure the client (optional)
-AtProto.configure do |config|
-  config.base_url = "https://bsky.social"  # default
-end
 
 # Initialize a client
-client = AtProto::Client.new(access_token, refresh_token)
+client = AtProto::Client.new(
+  access_token: access_token, 
+  refresh_token: refresh_token,
+  private_key: private_key_used_for_access_token_creation, 
+  refresh_token_url: "https://the-token-server.com" # optional, defaults do https://bsky.social
+)
 
 # Should be able to fetch collections
-client.make_api_request(
+client.request(
   :get,
   "#{PDS_URL}/xrpc/#{lexicon}",
   params:{ repo: "did:therepodid", collection: "app.bsky.feed.post"}
 )
 
-# Also gives a handful DPOP handler for any request (here an oauth example)
+# Also gives a handful DPOP handler for any request (here an omniauth example)
 dpop_handler = AtProto::DpopHandler.new(options.dpop_private_key)
 response = @dpop_handler.make_request(
   token_url,
@@ -38,6 +45,8 @@ response = @dpop_handler.make_request(
   body: token_params
 )
 
+# you can then use the access_token from the response in conjunction with the same private_key
+
 ```
 
 ## Development

data/lib/atproto_client/client.rb

@@ -1,15 +1,49 @@
 module AtProto
+  # The Client class handles authenticated HTTP requests to the AT Protocol services
+  # with DPoP token support and automatic token refresh capabilities.
+  #
+  # @attr_reader [String] access_token The current access token for authentication
+  # @attr_reader [String] refresh_token The current refresh token for renewing access
+  # @attr_reader [DpopHandler] dpop_handler The handler for DPoP token operations
   class Client
     attr_reader :access_token, :refresh_token, :dpop_handler
 
-    def initialize(access_token, refresh_token, dpop_handler = nil)
+    # Initializes a new AT Protocol client
+    #
+    # @param access_token [String] The initial access token for authentication
+    # @param refresh_token [String] The refresh token for renewing access tokens
+    # @param private_key [OpenSSL::PKey::EC] The EC private key used for DPoP token signing (required)
+    # @param refresh_token_url [String] The base URL for token refresh requests
+    #
+    # @raise [ArgumentError] If private_key is not provided or not an OpenSSL::PKey::EC instance
+    def initialize(access_token:, refresh_token:, private_key:, refresh_token_url: 'https://bsky.social')
       @access_token = access_token
       @refresh_token = refresh_token
-      @dpop_handler = dpop_handler || DpopHandler.new
+      @refresh_token_url = refresh_token_url
+      @dpop_handler = DpopHandler.new(private_key, access_token)
       @token_mutex = Mutex.new
     end
 
-    def make_api_request(method, url, params: {}, body: nil)
+    # Sets a new private key for DPoP token signing
+    #
+    # @param private_key [OpenSSL::PKey::EC] The EC private key to use for signing DPoP tokens (required)
+    # @raise [ArgumentError] If private_key is not an OpenSSL::PKey::EC instance
+    def private_key=(private_key)
+      @dpop_handler = @dpop_handler.new(private_key, @access_token)
+    end
+
+    # Makes an authenticated HTTP request with automatic token refresh
+    #
+    # @param method [Symbol] The HTTP method to use (:get, :post, etc.)
+    # @param url [String] The URL to send the request to
+    # @param params [Hash] Optional query parameters
+    # @param body [Hash, nil] Optional request body
+    #
+    # @return [Net::HTTPResponse] The HTTP response
+    #
+    # @raise [TokenExpiredError] When token refresh fails
+    # @raise [RefreshTokenError] When unable to refresh the access token
+    def request(method, url, params: {}, body: nil)
       retries = 0
       begin
         uri = URI(url)
@@ -31,10 +65,15 @@ module AtProto
 
     private
 
+    # Refreshes the access token using the refresh token
+    #
+    # @private
+    #
+    # @raise [RefreshTokenError] When the token refresh request fails
     def refresh_access_token!
       @token_mutex.synchronize do
         response = @dpop_handler.make_request(
-          "#{base_url}/xrpc/com.atproto.server.refreshSession",
+          "#{@refresh_token_url}/xrpc/com.atproto.server.refreshSession",
           :post,
           headers: {},
           body: { refresh_token: @refresh_token }
@@ -49,9 +88,5 @@ module AtProto
         @refresh_token = data['refresh_token']
       end
     end
-
-    def base_url
-      AtProto.configuration.base_url
-    end
   end
 end

data/lib/atproto_client/dpop_handler.rb

@@ -63,7 +63,6 @@ module AtProto
       OpenSSL::PKey::EC.generate('prime256v1').tap(&:check_key)
     end
 
-    # Creates a DPoP token with the specified parameters, encoded by jwk
     def create_dpop_token(http_method, target_uri, nonce = nil)
       jwk = JWT::JWK.new(@private_key).export
       payload = {
@@ -73,19 +72,15 @@ module AtProto
         iat: Time.now.to_i,
         exp: Time.now.to_i + 120
       }
-
-      # Ajout du hachage du token d'accès si fourni
-      if @access_token
-        token_str = @access_token.to_s
-        sha256 = OpenSSL::Digest.new('SHA256')
-        hash_bytes = sha256.digest(token_str)
-        ath = Base64.urlsafe_encode64(hash_bytes, padding: false)
-        payload[:ath] = ath
-      end
-
+      payload[:ath] = generate_ath if @access_token
       payload[:nonce] = nonce if nonce
 
       JWT.encode(payload, @private_key, 'ES256', { typ: 'dpop+jwt', alg: 'ES256', jwk: jwk })
     end
+
+    def generate_ath
+      hash_bytes = OpenSSL::Digest.new('SHA256').digest(@access_token)
+      Base64.urlsafe_encode64(hash_bytes, padding: false)
+    end
   end
 end

data/lib/atproto_client/version.rb

@@ -1,3 +1,3 @@
 module AtProto
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/atproto_client.rb

@@ -19,7 +19,6 @@ module AtProto
   class APIError < Error; end
 end
 
-require 'atproto_client/configuration'
 require 'atproto_client/client'
 require 'atproto_client/dpop_handler'
 require 'atproto_client/request'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atproto_client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - frabr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-24 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -146,7 +146,6 @@ files:
 - README.md
 - lib/atproto_client.rb
 - lib/atproto_client/client.rb
-- lib/atproto_client/configuration.rb
 - lib/atproto_client/dpop_handler.rb
 - lib/atproto_client/request.rb
 - lib/atproto_client/version.rb

data/lib/atproto_client/configuration.rb

@@ -1,19 +0,0 @@
-module AtProto
-  class Configuration
-    attr_accessor :base_url
-
-    def initialize
-      @base_url = 'https://bsky.social'
-    end
-  end
-
-  class << self
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def configure
-      yield(configuration)
-    end
-  end
-end