joshado / twitter-text-rb Goto Github PK

A gem that provides text processing routines for Twitter Tweets. The major reason for this is to unify the various auto-linking and extraction of usernames, lists, hashtags and URLs.

# Extraction
class MyClass
  include Twitter::Extractor
  usernames = extract_mentioned_screen_names("Mentioning @twitter and @jack")
  # usernames = ["twitter", "jack"]
end

# Extraction with a block argument
class MyClass
  include Twitter::Extractor
  extract_reply_screen_name("@twitter are you hiring?").do |username|
    # username = "twitter"
  end
end

# Auto-link
class MyClass
  include Twitter::Autolink

  html = auto_link("link @user, please #request")
end

Username extraction and linking matches all valid Twitter usernames but does not verify that the username is a valid Twitter account.

Auto-link and extract list names when they are written in @user/list-name format.

Auto-link and extract hashtags, where a hashtag contains any latin letter or number but cannot be solely numbers.

Auto-linking and extraction of URLs differs from the Rails default so that it will work correctly in Tweets written in languages that do not include spaces between words.

Special care has been taken to be sure that auto-linking and extraction work in Tweets of all languages. This means that languages without spaces between words should work equally well.

Use to provide emphasis around the “hits” returned from the Search API, built to work against text that has been auto-linked already.

To run the Conformance suite, you’ll need to add that project as a git submodule. From the root twitter-text-rb directory, run:

git submodule add [email protected]:mzsanford/twitter-text-conformance.git test/twitter-text-conformance/
git submodule init
git submodule update

Thanks to everybody who has filed issues, provided feedback or contibuted patches. Patches coutresy of:

• At Twitter …

  • Raffi Krikorian - github.com/r

  • Ben Cherry - github.com/bcherry

  • Patrick Ewing - github.com/hoverbird

  • Jeff Smick - github.com/sprsquish

• Patches from the community …

  • Jean-Philippe Bougie - github.com/jpbougie

• Anyone who has filed and issue. It helps. Really.