Module: CircleSo

Defined in:

lib/circle_so.rb,
lib/circle_so/token.rb,
lib/circle_so/client.rb,
lib/circle_so/errors.rb,
lib/circle_so/version.rb,
lib/circle_so/resources/base.rb,
lib/circle_so/resources/forms.rb,
lib/circle_so/resources/posts.rb,
lib/circle_so/resources/embeds.rb,
lib/circle_so/resources/events.rb,
lib/circle_so/resources/images.rb,
lib/circle_so/resources/search.rb,
lib/circle_so/resources/spaces.rb,
lib/circle_so/resources/topics.rb,
lib/circle_so/resources/comments.rb,
lib/circle_so/resources/messages.rb,
lib/circle_so/resources/community.rb,
lib/circle_so/resources/member_tags.rb,
lib/circle_so/resources/gamification.rb,
lib/circle_so/resources/space_groups.rb,
lib/circle_so/resources/access_groups.rb,
lib/circle_so/resources/space_members.rb,
lib/circle_so/resources/course_lessons.rb,
lib/circle_so/resources/direct_uploads.rb,
lib/circle_so/resources/profile_fields.rb,
lib/circle_so/resources/tagged_members.rb,
lib/circle_so/resources/course_sections.rb,
lib/circle_so/resources/event_attendees.rb,
lib/circle_so/resources/chat_preferences.rb,
lib/circle_so/resources/flagged_contents.rb,
lib/circle_so/resources/invitation_links.rb,
lib/circle_so/resources/community_members.rb,
lib/circle_so/resources/community_segments.rb,
lib/circle_so/resources/page_profile_fields.rb,
lib/circle_so/resources/space_group_members.rb

Defined Under Namespace

Modules: Resources, Token Classes: APIError, Client, Error, ForbiddenError, NotFoundError, RateLimitedError, ServerError, UnauthorizedError, WrongPathError

Constant Summary

VERSION =

"0.1.0"

Class Method Summary

• .client(**options) ⇒ Object

  Convenience constructor: CircleSo.client(token: "...").

• .detect_token_version(token, **options) ⇒ Object

  Three-state token probe: :v2, :v1, or :invalid.

Class Method Details

.client(**options) ⇒ Object

Convenience constructor: CircleSo.client(token: "...")

# File 'lib/circle_so.rb', line 40

def self.client(**options) = Client.new(**options)

.detect_token_version(token, **options) ⇒ Object

Three-state token probe: :v2, :v1, or :invalid. See CircleSo::Token.

# File 'lib/circle_so.rb', line 43

def self.detect_token_version(token, **options) = Token.detect_version(token, **options)