minisky 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a753ae5a6f7d2dd3089ee9b6a637e578051261c615fedd28a44f63ac1774b4d
-  data.tar.gz: 479240c065cb3ba705aa4a9d07efa8c4904ec2aca2e6ed0e847d391ab8cd62fe
+  metadata.gz: b22e3b707a428f0381e5c194ce6b5bd4118f6b6dfb7f2d249140c8025e3b1dd7
+  data.tar.gz: 2a6370ea6cb538c680252836295c411ff4c6df93b8c5aab9d8b73b843753febb
 SHA512:
-  metadata.gz: f87814325757d1b19cee4e403d6e13afbf84b1353b932eedbce23faa6cb1abfe772d0cf2c459b21bb45ea08fa34173457dea3fdb266f32f1f4334e2e90d22692
-  data.tar.gz: c4bea17a09982db0462e15e092fdf43c454fd94163d04099b119104fde555387621c5c1b8d51e1a1247ad2cece0b5fd9258b1c98555b0ffb7eca4b96107dd83a
+  metadata.gz: 3f86def9480e86d2989a52f143eacee8e5b78fede45bd6ba49ea7ad54f1da88a55555421d3fdfdddad025bed21a708c830e5e9b2c351ba57e016234e200b9f74
+  data.tar.gz: f8f7faa8d7e5df7807d6e9bb7ee1b87d1d5ab5503c0193fd031190be6e6346004618c66efdba96970fc93117d4f587c53ff5f17585a2ffa3ddafb503abc5a3cc

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.4.0] - 2024-03-31 🐣
+
+* allow passing non-JSON body to requests (e.g. when uploading blobs)
+* allow passing custom headers to requests, including overriding `Content-Type`
+* fixed error when the response is success but not JSON (e.g. an empty body like in deleteRecord)
+* allow passing options to the client in the initializer
+* aliased `default_progress` setting as `progress`
+* 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
+
 ## [0.3.1] - 2023-10-10
 
 * fixed Minisky not working on Ruby 2.x

data/example/ask_password.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/env ruby
+
+# Example: print 10 latest posts from the user's home feed.
+# 
+# Instead of using a config file to read & store authentication info, this example uses a customized client class
+# which reads the password from the console and creates a throwaway access token.
+#
+# This approach makes sense for one-off scripts, but it shouldn't be used for things that need to be done repeatedly
+# and often (the authentication-related endpoints have lower rate limits than others).
+
+# load minisky from a local folder - you normally won't need this
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'io/console'
+require 'minisky'
+
+class TransientClient
+  include Minisky::Requests
+
+  attr_reader :config, :host
+
+  def initialize(host, user)
+    @host = host
+    @config = { 'id' => user.gsub(/^@/, '') }
+  end
+
+  def ask_for_password
+    print "Enter password for @#{config['id']}: "
+    @config['pass'] = STDIN.noecho(&:gets).chomp
+    puts
+  end
+
+  def save_config
+    # ignore
+  end
+end
+
+host, handle = ARGV
+
+unless host && handle
+  puts "Usage: #{$PROGRAM_NAME} <pds_hostname> <handle>"
+  exit 1
+end
+
+# create a client instance & read password
+bsky = TransientClient.new(host, handle)
+bsky.ask_for_password
+
+# fetch 10 posts from the user's home feed
+result = bsky.get_request('app.bsky.feed.getTimeline', { limit: 10 })
+
+result['feed'].each do |r|
+  reason = r['reason']
+  reply = r['reply']
+  post = r['post']
+
+  if reason && reason['$type'] == 'app.bsky.feed.defs#reasonRepost'
+    puts "[Reposted by @#{reason['by']['handle']}]"
+  end
+
+  handle = post['author']['handle']
+  timestamp = Time.parse(post['record']['createdAt']).getlocal
+
+  puts "@#{handle} • #{timestamp}"
+  puts
+
+  if reply
+    puts "[in reply to @#{reply['parent']['author']['handle']}]"
+    puts
+  end
+
+  puts post['record']['text']
+  puts
+  puts "=" * 120
+  puts
+end

data/lib/minisky/minisky.rb

@@ -3,7 +3,7 @@ require 'yaml'
 class Minisky
   attr_reader :host, :config
 
-  def initialize(host, config_file)
+  def initialize(host, config_file, options = {})
     @host = host
     @config_file = config_file
 
@@ -18,6 +18,12 @@ class Minisky
       @send_auth_headers = false
       @auto_manage_tokens = false
     end
+
+    if options
+      options.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
   end
 
   def save_config

data/lib/minisky/requests.rb

@@ -39,6 +39,9 @@ class Minisky
       instance_variable_defined?('@auto_manage_tokens') ? @auto_manage_tokens : true
     end
 
+    alias progress default_progress
+    alias progress= default_progress=
+
     def base_url
       @base_url ||= "https://#{host}/xrpc"
     end
@@ -47,10 +50,10 @@ class Minisky
       @user ||= User.new(config)
     end
 
-    def get_request(method, params = nil, auth: default_auth_mode)
+    def get_request(method, params = nil, auth: default_auth_mode, headers: nil)
       check_access if auto_manage_tokens && auth == true
 
-      headers = authentication_header(auth)
+      headers = authentication_header(auth).merge(headers || {})
       url = URI("#{base_url}/#{method}")
 
       if params && !params.empty?
@@ -63,18 +66,24 @@ class Minisky
       handle_response(response)
     end
 
-    def post_request(method, params = nil, auth: default_auth_mode)
+    def post_request(method, params = nil, auth: default_auth_mode, headers: nil)
       check_access if auto_manage_tokens && auth == true
 
-      headers = authentication_header(auth).merge({ "Content-Type" => "application/json" })
-      body = params ? params.to_json : ''
+      headers = authentication_header(auth).merge(headers || {})
+      headers["Content-Type"] = "application/json" unless headers.keys.any? { |k| k.to_s.downcase == 'content-type' }
+
+      body = if params.is_a?(String) || params.nil?
+        params.to_s
+      else
+        params.to_json
+      end
 
       response = Net::HTTP.post(URI("#{base_url}/#{method}"), body, headers)
       handle_response(response)
     end
 
     def fetch_all(method, params = nil, field:,
-                  auth: default_auth_mode, break_when: nil, max_pages: nil, progress: @default_progress)
+                  auth: default_auth_mode, break_when: nil, max_pages: nil, headers: nil, progress: @default_progress)
       data = []
       params = {} if params.nil?
       pages = 0
@@ -82,7 +91,7 @@ class Minisky
       loop do
         print(progress) if progress
 
-        response = get_request(method, params, auth: auth)
+        response = get_request(method, params, auth: auth, headers: headers)
         records = response[field]
         cursor = response['cursor']
 
@@ -152,14 +161,14 @@ class Minisky
       alias_method :do_post_request, :post_request
       private :do_get_request, :do_post_request
 
-      def get_request(method, params = nil, auth: default_auth_mode, **kwargs)
+      def get_request(method, params = nil, auth: default_auth_mode, headers: nil, **kwargs)
         params ||= kwargs unless kwargs.empty?
-        do_get_request(method, params, auth: auth)
+        do_get_request(method, params, auth: auth, headers: headers)
       end
 
-      def post_request(method, params = nil, auth: default_auth_mode, **kwargs)
+      def post_request(method, params = nil, auth: default_auth_mode, headers: nil, **kwargs)
         params ||= kwargs unless kwargs.empty?
-        do_post_request(method, params, auth: auth)
+        do_post_request(method, params, auth: auth, headers: headers)
       end
     end
 
@@ -210,16 +219,15 @@ class Minisky
     def handle_response(response)
       status = response.code.to_i
       message = response.message
+      response_body = (response.content_type == 'application/json') ? JSON.parse(response.body) : response.body
 
       case response
       when Net::HTTPSuccess
-        JSON.parse(response.body)
+        response_body
       when Net::HTTPRedirection
         raise UnexpectedRedirect.new(status, message, response['location'])
       else
-        data = (response.content_type == 'application/json') ? JSON.parse(response.body) : response.body
-
-        error_class = if data.is_a?(Hash) && data['error'] == 'ExpiredToken'
+        error_class = if response_body.is_a?(Hash) && response_body['error'] == 'ExpiredToken'
           ExpiredTokenError
         elsif response.is_a?(Net::HTTPClientError)
           ClientErrorResponse
@@ -229,7 +237,7 @@ class Minisky
           BadResponse
         end
 
-        raise error_class.new(status, message, data)
+        raise error_class.new(status, message, response_body)
       end
     end
   end

data/lib/minisky/version.rb

@@ -1,5 +1,5 @@
 require_relative 'minisky'
 
 class Minisky
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: minisky
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kuba Suder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
-dependencies: []
+date: 2024-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: A very simple client class that lets you log in to the Bluesky API and
   make any requests there.
 email:
@@ -21,6 +35,7 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- example/ask_password.rb
 - example/fetch_my_posts.rb
 - example/fetch_profile.rb
 - example/post_skeet.rb