x 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4970075e9256b31a7f53ca6a3a06df7559631b9104c2069372b3797845cd77
-  data.tar.gz: a0e25d20e521f8a3408b9e04b8826d7f8959257ecf6748687a0d1b0292719f38
+  metadata.gz: e7f8185b86c61142faad23edbd1563f5a10263d7f47114d5f31a83e93af805dd
+  data.tar.gz: 8df083a42c16683e27d4face3445e3a835663f11600751024a519c3a658ed0ed
 SHA512:
-  metadata.gz: 7be87f0b82af146429afa88288f60d53d07185d2ed47f57d534c729758a3bfc426c4a57e11703665eedd19b9d994ce4e51bd4f08e3de84cdc49ca7a2de28eae6
-  data.tar.gz: 3e28cfc6ee5d244eff7671e0f724c0a07071d1872792d9fb742ee44bcf2fc2f1a797053dc0d2a415a51a625d85629115f71ad003bb3b9fcaf75049cde6b5d0d1
+  metadata.gz: 17dda35c335587d569dc1d41c8fe3ca2221e8e1d3b1742a443559c7d558b149e92229d7d767e64bf4a12982f4a3b4d2afb002d9d34db819216e1934eaf48391f
+  data.tar.gz: 990d9afb8e30cb0c998765525b47c4bf44779f96f4fbd006903fc9b3fe655d0f50df8aa197c77d9ad05250ded0fc086bb768d4662d539490ab81804d2e86b5f0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.14.0] - 2023-12-08
+* Allow passing custom objects per-request (768889f)
+
 ## [0.13.0] - 2023-12-04
 * Introduce X::RateLimit, which is returned with X::TooManyRequests errors (196caec)
 

data/README.md

@@ -1,5 +1,5 @@
 [![Tests](https://github.com/sferik/x-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/sferik/x-ruby/actions/workflows/test.yml)
-[![RuboCop](https://github.com/sferik/x-ruby/actions/workflows/rubocop.yml/badge.svg)](https://github.com/sferik/x-ruby/actions/workflows/rubocop.yml)
+[![Linter](https://github.com/sferik/x-ruby/actions/workflows/lint.yml/badge.svg)](https://github.com/sferik/x-ruby/actions/workflows/lint.yml)
 [![Mutant](https://github.com/sferik/x-ruby/actions/workflows/mutant.yml/badge.svg)](https://github.com/sferik/x-ruby/actions/workflows/mutant.yml)
 [![Typer Checker](https://github.com/sferik/x-ruby/actions/workflows/steep.yml/badge.svg)](https://github.com/sferik/x-ruby/actions/workflows/steep.yml)
 [![Gem Version](https://badge.fury.io/rb/x.svg)](https://rubygems.org/gems/x)
@@ -52,8 +52,15 @@ x_client.delete("tweets/#{post["data"]["id"]}")
 # Initialize an API v1.1 client
 v1_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_credentials)
 
-# Get your account settings
-v1_client.get("account/settings.json")
+# Define a custom response object
+Language = Struct.new(:code, :name, :local_name, :status, :debug)
+
+# Parse a response with custom array and object classes
+languages = v1_client.get("help/languages.json", object_class: Language, array_class: Set)
+# #<Set: {#<struct Language code="ur", name="Urdu", local_name="اردو", status="beta", debug=false>, …
+
+# Access data with dots instead of brackets
+languages.first.local_name
 
 # Initialize an Ads API client
 ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_credentials)
@@ -149,20 +156,23 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sferik
 
 Pull requests will only be accepted if they meet all the following criteria:
 
-1. Code must conform to [RuboCop rules](https://github.com/rubocop/rubocop). This can be verified with:
+1. Code must conform to [Standard Ruby](https://github.com/standardrb/standard#readme). This can be verified with:
+
+       bundle exec rake standard
+
+2. Code must conform to the [RuboCop rules](https://github.com/rubocop/rubocop#readme). This can be verified with:
 
-       bundle exec rubocop
+       bundle exec rake rubocop
 
-2. 100% C0 code coverage. This can be verified with:
+3. 100% C0 code coverage. This can be verified with:
 
        bundle exec rake test
 
-3. 100% mutation coverage. This can be verified with:
+4. 100% mutation coverage. This can be verified with:
 
-       git remote add upstream https://github.com/sferik/x-ruby
        bundle exec rake mutant
 
-4. RBS type signatures (in `sig/x.rbs`). This can be verified with:
+5. RBS type signatures (in `sig/x.rbs`). This can be verified with:
 
        bundle exec rake steep
 

data/lib/x/client.rb

@@ -11,16 +11,16 @@ module X
     extend Forwardable
 
     DEFAULT_BASE_URL = "https://api.twitter.com/2/".freeze
+    DEFAULT_ARRAY_CLASS = Array
+    DEFAULT_OBJECT_CLASS = Hash
 
-    attr_accessor :base_url
+    attr_accessor :base_url, :default_array_class, :default_object_class
     attr_reader :api_key, :api_key_secret, :access_token, :access_token_secret, :bearer_token
 
     def_delegators :@connection, :open_timeout, :read_timeout, :write_timeout, :proxy_url, :debug_output
     def_delegators :@connection, :open_timeout=, :read_timeout=, :write_timeout=, :proxy_url=, :debug_output=
     def_delegators :@redirect_handler, :max_redirects
     def_delegators :@redirect_handler, :max_redirects=
-    def_delegators :@response_parser, :array_class, :object_class
-    def_delegators :@response_parser, :array_class=, :object_class=
 
     def initialize(api_key: nil, api_key_secret: nil, access_token: nil, access_token_secret: nil,
       bearer_token: nil,
@@ -30,36 +30,38 @@ module X
       write_timeout: Connection::DEFAULT_WRITE_TIMEOUT,
       debug_output: Connection::DEFAULT_DEBUG_OUTPUT,
       proxy_url: nil,
-      array_class: nil,
-      object_class: nil,
+      default_array_class: DEFAULT_ARRAY_CLASS,
+      default_object_class: DEFAULT_OBJECT_CLASS,
       max_redirects: RedirectHandler::DEFAULT_MAX_REDIRECTS)
 
-      initialize_oauth(api_key, api_key_secret, access_token, access_token_secret)
-      @bearer_token = bearer_token
+      initialize_oauth(api_key, api_key_secret, access_token, access_token_secret, bearer_token)
       initialize_authenticator
       @base_url = base_url
+      initialize_default_classes(default_array_class, default_object_class)
       @connection = Connection.new(open_timeout: open_timeout, read_timeout: read_timeout,
         write_timeout: write_timeout, debug_output: debug_output, proxy_url: proxy_url)
       @request_builder = RequestBuilder.new
       @redirect_handler = RedirectHandler.new(connection: @connection, request_builder: @request_builder,
         max_redirects: max_redirects)
-      @response_parser = ResponseParser.new(array_class: array_class, object_class: object_class)
+      @response_parser = ResponseParser.new
     end
 
-    def get(endpoint, headers: {})
-      execute_request(:get, endpoint, headers: headers)
+    def get(endpoint, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:get, endpoint, headers: headers, array_class: array_class, object_class: object_class)
     end
 
-    def post(endpoint, body = nil, headers: {})
-      execute_request(:post, endpoint, body: body, headers: headers)
+    def post(endpoint, body = nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:post, endpoint, body: body, headers: headers, array_class: array_class,
+        object_class: object_class)
     end
 
-    def put(endpoint, body = nil, headers: {})
-      execute_request(:put, endpoint, body: body, headers: headers)
+    def put(endpoint, body = nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:put, endpoint, body: body, headers: headers, array_class: array_class,
+        object_class: object_class)
     end
 
-    def delete(endpoint, headers: {})
-      execute_request(:delete, endpoint, headers: headers)
+    def delete(endpoint, headers: {}, array_class: default_array_class, object_class: default_object_class)
+      execute_request(:delete, endpoint, headers: headers, array_class: array_class, object_class: object_class)
     end
 
     def api_key=(api_key)
@@ -89,11 +91,17 @@ module X
 
     private
 
-    def initialize_oauth(api_key, api_key_secret, access_token, access_token_secret)
+    def initialize_oauth(api_key, api_key_secret, access_token, access_token_secret, bearer_token)
       @api_key = api_key
       @api_key_secret = api_key_secret
       @access_token = access_token
       @access_token_secret = access_token_secret
+      @bearer_token = bearer_token
+    end
+
+    def initialize_default_classes(default_array_class, default_object_class)
+      @default_array_class = default_array_class
+      @default_object_class = default_object_class
     end
 
     def initialize_authenticator
@@ -109,14 +117,14 @@ module X
       end
     end
 
-    def execute_request(http_method, endpoint, headers:, body: nil)
+    def execute_request(http_method, endpoint, body: nil, headers: {}, array_class: default_array_class, object_class: default_object_class)
       uri = URI.join(base_url, endpoint)
       request = @request_builder.build(http_method: http_method, uri: uri, body: body, headers: headers,
         authenticator: @authenticator)
       response = @connection.perform(request: request)
       response = @redirect_handler.handle(response: response, request: request, base_url: base_url,
         authenticator: @authenticator)
-      @response_parser.parse(response: response)
+      @response_parser.parse(response: response, array_class: array_class, object_class: object_class)
     end
   end
 end

data/lib/x/response_parser.rb

@@ -36,14 +36,7 @@ module X
     }.freeze
     JSON_CONTENT_TYPE_REGEXP = %r{application/json}
 
-    attr_accessor :array_class, :object_class
-
-    def initialize(array_class: nil, object_class: nil)
-      @array_class = array_class
-      @object_class = object_class
-    end
-
-    def parse(response:)
+    def parse(response:, array_class: nil, object_class: nil)
       raise error(response) unless response.is_a?(Net::HTTPSuccess)
 
       return unless json?(response)

data/lib/x/version.rb

@@ -1,5 +1,5 @@
 require "rubygems/version"
 
 module X
-  VERSION = Gem::Version.create("0.13.0")
+  VERSION = Gem::Version.create("0.14.0")
 end

data/sig/x.rbs

@@ -193,15 +193,10 @@ module X
   end
 
   class ResponseParser
-    DEFAULT_ARRAY_CLASS: Class
-    DEFAULT_OBJECT_CLASS: Class
     ERROR_MAP: Hash[Integer, singleton(Unauthorized) | singleton(BadRequest) | singleton(Forbidden) | singleton(InternalServerError) | singleton(NotFound) | singleton(PayloadTooLarge) | singleton(ServiceUnavailable) | singleton(TooManyRequests)]
     JSON_CONTENT_TYPE_REGEXP: Regexp
 
-    attr_accessor array_class: Class
-    attr_accessor object_class: Class
-    def initialize: (?array_class: Class, ?object_class: Class) -> void
-    def parse: (response: Net::HTTPResponse) -> untyped
+    def parse: (response: Net::HTTPResponse, ?array_class: Class?, ?object_class: Class?) -> untyped
 
     private
     def error: (Net::HTTPResponse response) -> (Unauthorized | BadRequest | Forbidden | InternalServerError | NotFound | PayloadTooLarge | ServiceUnavailable | TooManyRequests)
@@ -211,6 +206,8 @@ module X
 
   class Client
     DEFAULT_BASE_URL: String
+    DEFAULT_ARRAY_CLASS: Class
+    DEFAULT_OBJECT_CLASS: Class
 
     extend Forwardable
     @authenticator: Authenticator
@@ -230,8 +227,8 @@ module X
     attr_accessor write_timeout: Float | Integer
     attr_accessor proxy_url: String
     attr_accessor debug_output: IO
-    attr_accessor array_class: Class
-    attr_accessor object_class: Class
+    attr_accessor default_array_class: Class
+    attr_accessor default_object_class: Class
     attr_accessor max_redirects: Integer
     attr_accessor authenticator: Authenticator
     attr_accessor connection: Connection
@@ -239,16 +236,17 @@ module X
     attr_accessor redirect_handler: RedirectHandler
     attr_accessor response_parser: ResponseParser
 
-    def initialize: (?api_key: String?, ?api_key_secret: String?, ?access_token: String?, ?access_token_secret: String?, ?bearer_token: String?, ?base_url: String, ?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?proxy_url: URI::Generic? | String?, ?debug_output: IO, ?array_class: Class, ?object_class: Class, ?max_redirects: Integer) -> void
-    def get: (String endpoint, ?headers: Hash[String, String]) -> untyped
-    def post: (String endpoint, ?String? body, ?headers: Hash[String, String]) -> untyped
-    def put: (String endpoint, ?String? body, ?headers: Hash[String, String]) -> untyped
-    def delete: (String endpoint, ?headers: Hash[String, String]) -> untyped
+    def initialize: (?api_key: String?, ?api_key_secret: String?, ?access_token: String?, ?access_token_secret: String?, ?bearer_token: String?, ?base_url: String, ?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?proxy_url: URI::Generic? | String?, ?debug_output: IO, ?default_array_class: Class, ?default_object_class: Class, ?max_redirects: Integer) -> void
+    def get: (String endpoint, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> untyped
+    def post: (String endpoint, ?String? body, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> untyped
+    def put: (String endpoint, ?String? body, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> untyped
+    def delete: (String endpoint, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> untyped
 
     private
-    def initialize_oauth: (String? api_key, String? api_key_secret, String? access_token, String? access_token_secret) -> void
+    def initialize_oauth: (String? api_key, String? api_key_secret, String? access_token, String? access_token_secret, String? bearer_token) -> void
+    def initialize_default_classes: (Class? default_array_class, Class? default_object_class) -> void
     def initialize_authenticator: -> Authenticator
-    def execute_request: (Symbol http_method, String endpoint, headers: Hash[String, String], ?body: String?) -> untyped
+    def execute_request: (Symbol http_method, String endpoint, ?body: String?, ?headers: Hash[String, String], ?array_class: Class?, ?object_class: Class?) -> untyped
   end
 
   module MediaUploader

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Erik Berlin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies: []
 description:
 email: