x 0.18.0 → 1.0.0

data/lib/x/version.rb

@@ -1,6 +1,21 @@
+# frozen_string_literal: true
+
 require "rubygems/version"
 
 module X
   # The current version of the X gem
-  VERSION = Gem::Version.create("0.18.0")
+  # @api public
+  VERSION = "1.0.0"
+
+  # The version as a Gem::Version, which compares one release with another
+  #
+  # VERSION is a String, as a version constant is throughout Ruby, so that what reads it can split it, match it, or
+  # send it wherever a String belongs, such as the release a crash reporter is told. This builds the Gem::Version
+  # that compares it with another version, which a String compares by character rather than by segment.
+  #
+  # @api public
+  # @return [Gem::Version] the version
+  # @example Take a path that a later release opened
+  #   X.gem_version >= Gem::Version.new("1.1")
+  def self.gem_version = Gem::Version.new(VERSION)
 end

data/lib/x.rb

@@ -1 +1,13 @@
-require_relative "x/client"
+# frozen_string_literal: true
+
+require "x/core"
+require "x/uploads"
+require "x/streams"
+require "x/resources"
+require_relative "x/version"
+
+module X
+  Client.include(Resources::API)
+  Client.include(Uploads::API)
+  Client.include(Streams::API)
+end

data/sig/manifest.yaml

@@ -0,0 +1,5 @@
+# The standard libraries the signatures of x refer to, which rbs collection loads for code that depends on it
+#
+# rbs collection reads every library named here as a standard library, so the gems x depends on are left to their
+# gemspecs, from which it installs their signatures.
+dependencies: []

data/sig/x.rbs

@@ -1,352 +1,11 @@
 module X
-  VERSION: Gem::Version
+  VERSION: String
 
-  class Authenticator
-    AUTHENTICATION_HEADER: String
-
-    def header: (Net::HTTPRequest? request) -> Hash[String, String]
-  end
-
-  class BearerTokenAuthenticator < Authenticator
-    attr_accessor bearer_token: String
-    def initialize: (bearer_token: String) -> void
-    def header: (Net::HTTPRequest? request) -> Hash[String, String]
-  end
-
-  class OAuthAuthenticator < Authenticator
-    OAUTH_VERSION: String
-    OAUTH_SIGNATURE_METHOD: String
-    OAUTH_SIGNATURE_ALGORITHM: String
-
-    attr_accessor api_key: String
-    attr_accessor api_key_secret: String
-    attr_accessor access_token: String
-    attr_accessor access_token_secret: String
-    def initialize: (api_key: String, api_key_secret: String, access_token: String, access_token_secret: String) -> void
-    def header: (Net::HTTPRequest request) -> Hash[String, String]
-
-    private
-    def parse_request: (Net::HTTPRequest request) -> [String, String, Hash[String, String]]
-    def parse_query_params: (String query_string) -> Hash[String, String]
-    def uri_without_query: (URI::Generic uri) -> String
-    def build_oauth_header: (String method, String url, Hash[String, String] query_params) -> String
-    def default_oauth_params: -> Hash[String, String]
-    def generate_signature: (String method, String url, Hash[String, String] params) -> String
-    def hmac_signature: (String base_string) -> String
-    def signature_base_string: (String method, String url, Hash[String, String] params) -> String
-    def signing_key: -> String
-    def format_oauth_header: (Hash[String, String] params) -> String
-    def escape: (String value) -> String
-  end
-
-  class Error < StandardError
-  end
-
-  class ClientError < HTTPError
-  end
-
-  class BadGateway < ClientError
-  end
-
-  class BadRequest < ClientError
-  end
-
-  class ConnectionException < ClientError
-  end
-
-  class HTTPError < Error
-    JSON_CONTENT_TYPE_REGEXP: Regexp
-
-    attr_reader response : Net::HTTPResponse
-    attr_reader code : String
-
-    def initialize: (response: Net::HTTPResponse) -> void
-
-    private
-    def error_message: (Net::HTTPResponse response) -> String
-    def message_from_json_response:  (Net::HTTPResponse response) -> String
-    def json?: (Net::HTTPResponse response) -> bool
-  end
-
-  class Forbidden < ClientError
-  end
-
-  class GatewayTimeout < ClientError
-  end
-
-  class Gone < ClientError
-  end
-
-  class InternalServerError < ServerError
-  end
-
-  class NetworkError < Error
-  end
-
-  class NotAcceptable < ClientError
-  end
-
-  class NotFound < ClientError
-  end
-
-  class PayloadTooLarge < ClientError
-  end
-
-  class ServerError < HTTPError
-  end
-
-  class ServiceUnavailable < ServerError
-  end
-
-  class TooManyRedirects < Error
-  end
-
-  class InvalidMediaType < Error
-  end
-
-  class TooManyRequests < ClientError
-    @rate_limits: Array[RateLimit]
-
-    def rate_limit: -> RateLimit?
-    def rate_limits: -> Array[RateLimit]
-    def reset_at: -> Time
-    def reset_in: -> Integer?
-  end
-
-  class Unauthorized < ClientError
-  end
-
-  class UnprocessableEntity < ClientError
-  end
-
-  class Connection
-    DEFAULT_HOST: String
-    DEFAULT_PORT: Integer
-    DEFAULT_OPEN_TIMEOUT: Integer
-    DEFAULT_READ_TIMEOUT: Integer
-    DEFAULT_WRITE_TIMEOUT: Integer
-    DEFAULT_DEBUG_OUTPUT: IO
-    NETWORK_ERRORS: Array[(singleton(Errno::ECONNREFUSED) | singleton(Errno::ECONNRESET) | singleton(Net::OpenTimeout) | singleton(Net::ReadTimeout) | singleton(OpenSSL::SSL::SSLError))]
-
-    @proxy_url: URI::Generic | String
-
-    extend Forwardable
-
-    attr_accessor open_timeout : Float | Integer
-    attr_accessor read_timeout : Float | Integer
-    attr_accessor write_timeout : Float | Integer
-    attr_accessor debug_output : IO
-
-    attr_reader proxy_uri: URI::Generic?
-    attr_reader proxy_host : String?
-    attr_reader proxy_port : Integer?
-    attr_reader proxy_user : String?
-    attr_reader proxy_pass : String?
-
-    def initialize: (?open_timeout: Float | Integer, ?read_timeout: Float | Integer, ?write_timeout: Float | Integer, ?proxy_url: URI::Generic? | String?, ?debug_output: IO) -> void
-    def proxy_url=: (URI::Generic | String proxy_url) -> void
-    def perform: (request: Net::HTTPRequest) -> Net::HTTPResponse
-
-    private
-    def build_http_client: (?String host, ?Integer port) -> Net::HTTP
-    def configure_http_client: (Net::HTTP http_client) -> Net::HTTP
-  end
-
-  class RateLimit
-    RATE_LIMIT_TYPE: String
-    APP_LIMIT_TYPE: String
-    USER_LIMIT_TYPE: String
-    TYPES: Array[String]
-
-    attr_accessor type: String
-    attr_accessor response: Net::HTTPResponse
-    def initialize: (type: String, response: Net::HTTPResponse) -> void
-    def limit: -> Integer
-    def remaining: -> Integer
-    def reset_at: -> Time
-    def reset_in: -> Integer?
-  end
-
-  class RequestBuilder
-    HTTP_METHODS: Hash[Symbol, (singleton(Net::HTTP::Get) | singleton(Net::HTTP::Post) | singleton(Net::HTTP::Put) | singleton(Net::HTTP::Delete))]
-    DEFAULT_HEADERS: Hash[String, String]
-
-    def initialize: (?content_type: String, ?user_agent: String) -> void
-    def build: (http_method: Symbol, uri: URI::Generic, ?body: String?, ?headers: Hash[String, String], ?authenticator: Authenticator) -> (Net::HTTPRequest)
-
-    private
-    def create_request: (http_method: Symbol, uri: URI::Generic, body: String?) -> (Net::HTTPRequest)
-    def add_authentication: (request: Net::HTTPRequest, authenticator: Authenticator) -> void
-    def add_headers: (request: Net::HTTPRequest, headers: Hash[String, String]) -> void
-    def escape_query_params: (URI::Generic uri) -> URI::Generic
-  end
-
-  class RedirectHandler
-    DEFAULT_MAX_REDIRECTS: Integer
-
-    attr_reader authenticator: Authenticator
-    attr_reader connection: Connection
-    attr_reader request_builder: RequestBuilder
-    attr_reader max_redirects: Integer
-    def initialize: (?connection: Connection, ?request_builder: RequestBuilder, ?max_redirects: Integer) -> void
-    def handle: (response: Net::HTTPResponse, request: Net::HTTPRequest, base_url: String, ?authenticator: Authenticator, ?redirect_count: Integer) -> Net::HTTPResponse
-
-    private
-    def build_new_uri: (Net::HTTPResponse response, String base_url) -> URI::Generic
-    def build_request: (Net::HTTPRequest request, URI::Generic new_uri, Integer response_code, Authenticator authenticator) -> Net::HTTPRequest
-    def send_new_request: (URI::Generic new_uri, Net::HTTPRequest new_request) -> Net::HTTPResponse
-  end
-
-  class ResponseParser
-    ERROR_MAP: Hash[Integer, singleton(BadGateway) | singleton(BadRequest) | singleton(ConnectionException) | singleton(Forbidden) | singleton(GatewayTimeout) | singleton(Gone) | singleton(InternalServerError) | singleton(NotAcceptable) | singleton(NotFound) | singleton(PayloadTooLarge) | singleton(ServiceUnavailable) | singleton(TooManyRequests) | singleton(Unauthorized) | singleton(UnprocessableEntity)]
-
-    def parse: (response: Net::HTTPResponse, ?array_class: Class?, ?object_class: Class?) -> untyped
-
-    private
-    def error: (Net::HTTPResponse response) -> HTTPError
-    def error_class: (Net::HTTPResponse response) -> (singleton(BadGateway) | singleton(BadRequest) | singleton(ConnectionException) | singleton(Forbidden) | singleton(GatewayTimeout) | singleton(Gone) | singleton(InternalServerError) | singleton(NotAcceptable) | singleton(NotFound) | singleton(PayloadTooLarge) | singleton(ServiceUnavailable) | singleton(TooManyRequests) | singleton(Unauthorized) | singleton(UnprocessableEntity))
-    def json?: (Net::HTTPResponse response) -> bool
-  end
-
-  class OAuth2Authenticator < Authenticator
-    TOKEN_PATH: String
-    TOKEN_HOST: String
-    REFRESH_GRANT_TYPE: String
-    EXPIRATION_BUFFER: Integer
-
-    attr_accessor client_id: String
-    attr_accessor client_secret: String
-    attr_accessor access_token: String
-    attr_accessor refresh_token: String
-    attr_accessor expires_at: Time?
-    attr_accessor connection: Connection
-    def initialize: (client_id: String, client_secret: String, access_token: String, refresh_token: String, ?expires_at: Time?, ?connection: Connection) -> void
-    def header: (Net::HTTPRequest? request) -> Hash[String, String]
-    def token_expired?: -> bool
-    def refresh_token!: -> Hash[String, untyped]
-
-    private
-    def send_token_request: -> Net::HTTPResponse
-    def build_token_request: -> Net::HTTP::Post
-    def handle_token_response: (Net::HTTPResponse response) -> Hash[String, untyped]
-    def update_tokens: (Hash[String, untyped] token_response) -> void
-  end
-
-  module ClientCredentials
-    attr_reader api_key: String?
-    attr_reader api_key_secret: String?
-    attr_reader access_token: String?
-    attr_reader access_token_secret: String?
-    attr_reader bearer_token: String?
-    attr_reader client_id: String?
-    attr_reader client_secret: String?
-    attr_reader refresh_token: String?
-    def api_key=: (String api_key) -> void
-    def api_key_secret=: (String api_key_secret) -> void
-    def access_token=: (String access_token) -> void
-    def access_token_secret=: (String access_token_secret) -> void
-    def bearer_token=: (String bearer_token) -> void
-    def client_id=: (String client_id) -> void
-    def client_secret=: (String client_secret) -> void
-    def refresh_token=: (String refresh_token) -> void
-
-    private
-    def initialize_credentials: (api_key: String?, api_key_secret: String?, access_token: String?, access_token_secret: String?, bearer_token: String?, client_id: String?, client_secret: String?, refresh_token: String?) -> void
-    def initialize_authenticator: -> (Authenticator | BearerTokenAuthenticator | OAuthAuthenticator | OAuth2Authenticator)
-    def oauth_authenticator: -> OAuthAuthenticator?
-    def oauth2_authenticator: -> OAuth2Authenticator?
-    def bearer_authenticator: -> BearerTokenAuthenticator?
-  end
+  def self.gem_version: () -> Gem::Version
 
   class Client
-    include ClientCredentials
-
-    DEFAULT_BASE_URL: String
-    DEFAULT_ARRAY_CLASS: singleton(Array)
-    DEFAULT_OBJECT_CLASS: singleton(Hash)
-    extend Forwardable
-    @authenticator: Authenticator | BearerTokenAuthenticator | OAuthAuthenticator | OAuth2Authenticator
-    @connection: Connection
-    @request_builder: RequestBuilder
-    @redirect_handler: RedirectHandler
-    @response_parser: ResponseParser
-
-    attr_accessor base_url: String
-    attr_accessor default_array_class: singleton(Array)
-    attr_accessor default_object_class: singleton(Hash)
-    attr_reader authenticator: Authenticator | BearerTokenAuthenticator | OAuthAuthenticator | OAuth2Authenticator
-    def initialize: (?api_key: String?, ?api_key_secret: String?, ?access_token: String?, ?access_token_secret: String?, ?bearer_token: String?, ?client_id: String?, ?client_secret: String?, ?refresh_token: String?, ?base_url: String, ?open_timeout: Integer, ?read_timeout: Integer, ?write_timeout: Integer, ?debug_output: untyped, ?proxy_url: String?, ?default_array_class: singleton(Array), ?default_object_class: singleton(Hash), ?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 execute_request: (:delete | :get | :post | :put http_method, String endpoint, ?body: String?, ?headers: Hash[String, String], ?array_class: Class, ?object_class: Class) -> nil
-  end
-
-  module MediaUploader
-    MAX_RETRIES: Integer
-    BYTES_PER_MB: Integer
-    DM_GIF: String
-    DM_IMAGE: String
-    DM_VIDEO: String
-    SUBTITLES: String
-    TWEET_GIF: String
-    TWEET_IMAGE: String
-    TWEET_VIDEO: String
-    MIME_TYPES: Array[String]
-    GIF_MIME_TYPE: String
-    JPEG_MIME_TYPE: String
-    MP4_MIME_TYPE: String
-    PNG_MIME_TYPE: String
-    SUBRIP_MIME_TYPE: String
-    WEBP_MIME_TYPE: String
-    MIME_TYPE_MAP: Hash[String, String]
-    PROCESSING_INFO_STATES: Array[String]
-    extend MediaUploader
-
-    def upload: (client: Client, file_path: String, media_category: String, ?boundary: String) -> untyped
-    def upload_binary: (client: Client, content: String, media_category: String, ?boundary: String) -> untyped
-    def chunked_upload: (client: Client, file_path: String, media_category: String, ?media_type: String, ?boundary: String, ?chunk_size_mb: Integer) -> untyped
-    def await_processing: (client: Client, media: untyped) -> untyped
-    def await_processing!: (client: Client, media: untyped) -> untyped
-    def infer_media_type: (String file_path, String media_category) -> String
-
-    private
-    def split: (String file_path, Integer chunk_size) -> Array[String]
-    def init: (client: Client, file_path: String, media_type: String, media_category: String) -> untyped
-    def append: (client: Client, file_paths: Array[String], media: untyped, ?boundary: String) -> Array[String]
-    def upload_chunk: (client: Client, media_id: String, upload_body: String, file_path: String, ?headers: Hash[String, String]) -> Integer?
-    def cleanup_file: (String file_path) -> Integer?
-    def finalize: (client: Client, media: untyped) -> untyped
-    def construct_upload_body: (content: String, ?media_category: String, ?segment_index: Integer, ?boundary: String) -> String
-  end
-
-  module MediaUploadValidator
-    MEDIA_CATEGORIES: Array[String]
-    extend MediaUploadValidator
-
-    def validate_file_path!: (file_path: String) -> nil
-    def validate_media_category!: (media_category: String) -> nil
-  end
-
-  module AccountUploader
-    V1_BASE_URL: String
-    SUPPORTED_EXTENSIONS: Array[String]
-    MIME_TYPE_MAP: Hash[String, String]
-    extend AccountUploader
-
-    def update_profile_image: (client: Client, file_path: String, ?boundary: String) -> untyped
-    def upload_profile_image_binary: (client: Client, content: String, ?boundary: String) -> untyped
-    def update_profile_banner: (client: Client, file_path: String, ?width: Integer?, ?height: Integer?, ?offset_left: Integer?, ?offset_top: Integer?, ?boundary: String) -> untyped
-    def upload_profile_banner_binary: (client: Client, content: String, ?width: Integer?, ?height: Integer?, ?offset_left: Integer?, ?offset_top: Integer?, ?boundary: String) -> untyped
-
-    private
-    def v1_client: (Client client) -> Client
-    def validate_file!: (String file_path) -> nil
-    def construct_multipart_body: (field_name: String, content: String, boundary: String) -> String
-    def construct_banner_body: (content: String, width: Integer?, height: Integer?, offset_left: Integer?, offset_top: Integer?, boundary: String) -> String
-    def multipart_field: (String name, untyped value, String boundary) -> String
+    include Resources::API
+    include Uploads::API
+    include Streams::API
   end
 end

metadata

@@ -1,76 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: x
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Erik Berlin
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: base64
+  name: x-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: x-uploads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: x-streams
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: x-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 email:
 - sferik@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- bin/console
-- bin/setup
+- SECURITY.md
+- UPGRADING.md
 - lib/x.rb
-- lib/x/account_uploader.rb
-- lib/x/authenticator.rb
-- lib/x/bearer_token_authenticator.rb
-- lib/x/client.rb
-- lib/x/client_credentials.rb
-- lib/x/connection.rb
-- lib/x/errors/bad_gateway.rb
-- lib/x/errors/bad_request.rb
-- lib/x/errors/client_error.rb
-- lib/x/errors/connection_exception.rb
-- lib/x/errors/error.rb
-- lib/x/errors/forbidden.rb
-- lib/x/errors/gateway_timeout.rb
-- lib/x/errors/gone.rb
-- lib/x/errors/http_error.rb
-- lib/x/errors/internal_server_error.rb
-- lib/x/errors/invalid_media_type.rb
-- lib/x/errors/network_error.rb
-- lib/x/errors/not_acceptable.rb
-- lib/x/errors/not_found.rb
-- lib/x/errors/payload_too_large.rb
-- lib/x/errors/server_error.rb
-- lib/x/errors/service_unavailable.rb
-- lib/x/errors/too_many_redirects.rb
-- lib/x/errors/too_many_requests.rb
-- lib/x/errors/unauthorized.rb
-- lib/x/errors/unprocessable_entity.rb
-- lib/x/media_upload_validator.rb
-- lib/x/media_uploader.rb
-- lib/x/oauth2_authenticator.rb
-- lib/x/oauth_authenticator.rb
-- lib/x/rate_limit.rb
-- lib/x/redirect_handler.rb
-- lib/x/request_builder.rb
-- lib/x/response_parser.rb
 - lib/x/version.rb
+- sig/manifest.yaml
 - sig/x.rbs
 homepage: https://sferik.github.io/x-ruby
 licenses:
@@ -78,8 +87,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/sferik/x-ruby/issues
-  changelog_uri: https://github.com/sferik/x-ruby/blob/master/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/x/
+  changelog_uri: https://github.com/sferik/x-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://sferik.github.io/x-ruby/api/
   funding_uri: https://github.com/sponsors/sferik/
   homepage_uri: https://sferik.github.io/x-ruby
   rubygems_mfa_required: 'true'
@@ -91,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.21
 specification_version: 4
 summary: A Ruby interface to the X API.
 test_files: []

data/bin/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "x"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install