Module: X

Defined in:
x-core/lib/x/core/authenticator.rb,
lib/x.rb,
lib/x/version.rb,
x-core/lib/x/core/client.rb,
x-core/lib/x/core/origin.rb,
x-core/lib/x/core/problem.rb,
x-core/lib/x/core/version.rb,
x-core/lib/x/core/response.rb,
x-core/lib/x/core/connection.rb,
x-core/lib/x/core/rate_limit.rb,
x-core/lib/x/core/client_memo.rb,
x-core/lib/x/core/errors/gone.rb,
x-core/lib/x/core/stream_body.rb,
x-core/lib/x/core/errors/error.rb,
x-core/lib/x/core/oauth2_tokens.rb,
x-core/lib/x/core/proxy_setting.rb,
x-core/lib/x/core/retry_handler.rb,
x-core/lib/x/core/built_response.rb,
x-core/lib/x/core/oauth2_refresh.rb,
x-core/lib/x/core/token_endpoint.rb,
x-core/lib/x/core/client_app_only.rb,
x-core/lib/x/core/client_settings.rb,
x-core/lib/x/core/connection_pool.rb,
x-core/lib/x/core/errors/conflict.rb,
x-core/lib/x/core/request_builder.rb,
x-core/lib/x/core/request_context.rb,
x-core/lib/x/core/response_parser.rb,
x-core/lib/x/core/client_internals.rb,
x-core/lib/x/core/connection_proxy.rb,
x-core/lib/x/core/errors/forbidden.rb,
x-core/lib/x/core/errors/not_found.rb,
x-core/lib/x/core/redirect_handler.rb,
x-core/lib/x/core/refresh_reporter.rb,
x-core/lib/x/core/request_encoding.rb,
x-core/lib/x/core/response_headers.rb,
x-core/lib/x/core/credential_holder.rb,
x-core/lib/x/core/errors/http_error.rb,
x-core/lib/x/core/setting_validator.rb,
x-core/lib/x/core/client_credentials.rb,
x-core/lib/x/core/connection_request.rb,
x-core/lib/x/core/errors/bad_gateway.rb,
x-core/lib/x/core/errors/bad_request.rb,
x-core/lib/x/core/rate_limit_handler.rb,
x-core/lib/x/core/errors/client_error.rb,
x-core/lib/x/core/errors/server_error.rb,
x-core/lib/x/core/errors/unauthorized.rb,
x-core/lib/x/core/client_token_refresh.rb,
x-core/lib/x/core/credential_validator.rb,
x-core/lib/x/core/errors/network_error.rb,
x-core/lib/x/core/oauth1_authenticator.rb,
x-core/lib/x/core/oauth2_authenticator.rb,
x-core/lib/x/core/oauth2_authorization.rb,
x-core/lib/x/core/authenticator_request.rb,
x-core/lib/x/core/errors/callback_error.rb,
x-core/lib/x/core/errors/not_acceptable.rb,
x-core/lib/x/core/app_only_authenticator.rb,
x-core/lib/x/core/errors/gateway_timeout.rb,
x-core/lib/x/core/errors/request_timeout.rb,
x-core/lib/x/core/errors/invalid_response.rb,
x-core/lib/x/core/errors/payment_required.rb,
x-core/lib/x/core/errors/payload_too_large.rb,
x-core/lib/x/core/errors/too_many_requests.rb,
x-core/lib/x/core/errors/method_not_allowed.rb,
x-core/lib/x/core/errors/too_many_redirects.rb,
x-core/lib/x/core/bearer_token_authenticator.rb,
x-core/lib/x/core/errors/authorization_error.rb,
x-core/lib/x/core/errors/service_unavailable.rb,
x-core/lib/x/core/errors/token_report_failed.rb,
x-core/lib/x/core/errors/authorization_denied.rb,
x-core/lib/x/core/errors/unprocessable_entity.rb,
x-core/lib/x/core/errors/internal_server_error.rb,
x-core/lib/x/core/errors/unsupported_operation.rb,
x-core/lib/x/core/errors/unsupported_media_type.rb,
x-core/lib/x/core/errors/unsupported_marshal_format.rb,
x-core/lib/x/core/errors/unavailable_for_legal_reasons.rb,
x-uploader/lib/x/uploader/api.rb,
x-uploader/lib/x/uploader/gif.rb,
x-uploader/lib/x/uploader/error.rb,
x-uploader/lib/x/uploader/utils.rb,
x-uploader/lib/x/uploader/chunks.rb,
x-uploader/lib/x/uploader/source.rb,
x-uploader/lib/x/uploader/account.rb,
x-uploader/lib/x/uploader/version.rb,
x-uploader/lib/x/uploader/metadata.rb,
x-uploader/lib/x/uploader/multipart.rb,
x-uploader/lib/x/uploader/signature.rb,
x-uploader/lib/x/uploader/validator.rb,
x-uploader/lib/x/uploader/json_classes.rb,
x-uploader/lib/x/uploader/media_upload.rb,
x-uploader/lib/x/uploader/invalid_media.rb,
x-uploader/lib/x/uploader/uploaded_media.rb,
x-uploader/lib/x/uploader/alt_text_failed.rb,
x-uploader/lib/x/uploader/invalid_media_type.rb,
x-uploader/lib/x/uploader/missing_media_data.rb,
x-uploader/lib/x/uploader/chunked_upload_failed.rb,
x-uploader/lib/x/uploader/media_processing_failed.rb,
x-uploader/lib/x/uploader/media_processing_timeout.rb,
x-uploader/lib/x/uploader/media_processing_check_failed.rb,
x-streaming/lib/x/streaming/api.rb,
x-streaming/lib/x/streaming/error.rb,
x-streaming/lib/x/streaming/stopper.rb,
x-streaming/lib/x/streaming/version.rb,
x-streaming/lib/x/streaming/validator.rb,
x-streaming/lib/x/streaming/stream_rule.rb,
x-streaming/lib/x/streaming/stream_error.rb,
x-streaming/lib/x/streaming/stream_rules.rb,
x-streaming/lib/x/streaming/stream_parser.rb,
x-streaming/lib/x/streaming/callback_error.rb,
x-streaming/lib/x/streaming/rules_rejected.rb,
x-streaming/lib/x/streaming/streaming_client.rb,
x-streaming/lib/x/streaming/reconnect_handler.rb,
x-objects/lib/x/objects/api.rb,
x-objects/lib/x/objects/list.rb,
x-objects/lib/x/objects/memo.rb,
x-objects/lib/x/objects/page.rb,
x-objects/lib/x/objects/poll.rb,
x-objects/lib/x/objects/post.rb,
x-objects/lib/x/objects/user.rb,
x-objects/lib/x/objects/batch.rb,
x-objects/lib/x/objects/media.rb,
x-objects/lib/x/objects/pages.rb,
x-objects/lib/x/objects/place.rb,
x-objects/lib/x/objects/shape.rb,
x-objects/lib/x/objects/space.rb,
x-objects/lib/x/objects/topic.rb,
x-objects/lib/x/objects/trend.rb,
x-objects/lib/x/objects/utils.rb,
x-objects/lib/x/objects/cursor.rb,
x-objects/lib/x/objects/errors.rb,
x-objects/lib/x/objects/actions.rb,
x-objects/lib/x/objects/finders.rb,
x-objects/lib/x/objects/lookups.rb,
x-objects/lib/x/objects/version.rb,
x-objects/lib/x/objects/identity.rb,
x-objects/lib/x/objects/includes.rb,
x-objects/lib/x/objects/parallel.rb,
x-objects/lib/x/objects/resource.rb,
x-objects/lib/x/objects/community.rb,
x-objects/lib/x/objects/media_ids.rb,
x-objects/lib/x/objects/attributes.rb,
x-objects/lib/x/objects/page_limit.rb,
x-objects/lib/x/objects/post_usage.rb,
x-objects/lib/x/objects/references.rb,
x-objects/lib/x/objects/marshalling.rb,
x-objects/lib/x/objects/post_counts.rb,
x-objects/lib/x/objects/post_search.rb,
x-objects/lib/x/objects/post_writes.rb,
x-objects/lib/x/objects/user_finders.rb,
x-objects/lib/x/objects/actions/lists.rb,
x-objects/lib/x/objects/actions/posts.rb,
x-objects/lib/x/objects/batch_finders.rb,
x-objects/lib/x/objects/lookups/lists.rb,
x-objects/lib/x/objects/lookups/media.rb,
x-objects/lib/x/objects/lookups/posts.rb,
x-objects/lib/x/objects/lookups/users.rb,
x-objects/lib/x/objects/matching_rule.rb,
x-objects/lib/x/objects/relationships.rb,
x-objects/lib/x/objects/serialization.rb,
x-objects/lib/x/objects/abstract_class.rb,
x-objects/lib/x/objects/direct_message.rb,
x-objects/lib/x/objects/lookups/spaces.rb,
x-objects/lib/x/objects/lookups/trends.rb,
x-objects/lib/x/objects/value_equality.rb,
x-objects/lib/x/objects/bookmark_folder.rb,
x-objects/lib/x/objects/published_count.rb,
x-objects/lib/x/objects/post_collections.rb,
x-objects/lib/x/objects/user_collections.rb,
x-objects/lib/x/objects/value_marshalling.rb,
x-objects/lib/x/objects/actions/engagement.rb,
x-objects/lib/x/objects/personalized_trend.rb,
x-objects/lib/x/objects/lookups/communities.rb,
x-objects/lib/x/objects/actions/relationships.rb,
x-objects/lib/x/objects/actions/direct_messages.rb,
x-objects/lib/x/objects/lookups/direct_messages.rb,
x-objects/lib/x/objects/direct_message_conversations.rb

Overview

A Ruby client for the X API

Defined Under Namespace

Modules: Core, Objects, Streaming, Uploader Classes: AltTextFailed, AppOnlyAuthenticator, Authenticator, AuthorizationDenied, AuthorizationError, BadGateway, BadRequest, BearerTokenAuthenticator, BookmarkFolder, ChunkedUploadFailed, Client, ClientError, Community, Conflict, Cursor, DirectMessage, Error, Forbidden, GatewayTimeout, Gone, HTTPError, InternalServerError, InvalidAttribute, InvalidMedia, InvalidMediaType, InvalidResponse, List, MatchingRule, Media, MediaProcessingCheckFailed, MediaProcessingFailed, MediaProcessingTimeout, MethodNotAllowed, MissingClient, MissingMediaData, MissingResource, NetworkError, NotAcceptable, NotFound, OAuth1Authenticator, OAuth2Authenticator, OAuth2Authorization, OAuth2Tokens, Page, PageLimitReached, PayloadTooLarge, PaymentRequired, PersonalizedTrend, Place, Poll, Post, PostUsage, Problem, RateLimit, RequestTimeout, Resource, Response, RulesRejected, ServerError, ServiceUnavailable, Space, StreamError, StreamRule, StreamingClient, TokenReportFailed, TooManyRedirects, TooManyRequests, Topic, Trend, Unauthorized, UnavailableForLegalReasons, UnprocessableEntity, UnreadableResponse, UnsupportedMarshalFormat, UnsupportedMediaType, UnsupportedOperation, UploadedMedia, User

Constant Summary collapse

VERSION =

The current version of the X gem

"1.0.0"
Tweet =

Alias for Post, the name the API gave a post before it named it a post

Post

Class Method Summary collapse

Class Method Details

.gem_version ⇒ Gem::Version

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.

Examples:

Take a path that a later release opened

X.gem_version >= Gem::Version.new("1.1")

Returns:

  • (Gem::Version) —

    the version



20
 
# File 'lib/x/version.rb', line 20

def self.gem_version = Gem::Version.new(VERSION)