Skip to content

Latest commit

 

History

History
119 lines (71 loc) · 2.85 KB

README.md

File metadata and controls

119 lines (71 loc) · 2.85 KB
Raw

A Crystal interface to the X API

Follow

For updates and announcements about this library, follow its creator on X.

Installation

Add the dependency to your shard.yml:

dependencies:
  x:
    github: sferik/x-crystal

Then run:

shards install

Usage

First, obtain X credentails from https://developer.x.com.

require "x"

x_credentials = {
  api_key:             "INSERT YOUR X API KEY HERE",
  api_key_secret:      "INSERT YOUR X API KEY SECRET HERE",
  access_token:        "INSERT YOUR X ACCESS TOKEN HERE",
  access_token_secret: "INSERT YOUR X ACCESS TOKEN SECRET HERE",
}

# Initialize an X API client with your OAuth credentials
x_client = X::Client.new(**x_credentials)

# Get data about yourself
x_client.get("users/me")
# {"data"=>{"id"=>"7505382", "name"=>"Erik Berlin", "username"=>"sferik"}}

# Post a tweet
tweet = x_client.post("tweets", '{"text":"Hello, World! (from @gem)"}')
# {"data"=>{"edit_history_tweet_ids"=>["1234567890123456789"], "id"=>"1234567890123456789", "text"=>"Hello, World! (from @gem)"}}

# Delete the tweet you just posted
x_client.delete("tweets/#{tweet["data"]["id"]}")
# {"data"=>{"deleted"=>true}}

# Initialize an API v1.1 client
v1_client = X::Client.new(base_url: "https://api.twitter.com/1.1/", **x_credentials)

# Request your account settings
v1_client.get("account/settings.json")

# Initialize an X Ads API client
ads_client = X::Client.new(base_url: "https://ads-api.twitter.com/12/", **x_credentials)

# Request your ad accounts
ads_client.get("accounts")

History and Philosophy

This library is a port of the X Ruby library, which is a rewrite of the Twitter Ruby library. The Ruby and Crystal version have the same basic interface and design philosophy, but this is not a strict guarantee.

Development

  1. Checkout and repo:

    git checkout [email protected]:sferik/x-crystal.git

  2. Enter the repo’s directory:

    cd x-crystal

  3. Install dependencies via Shards:

    shards install

  4. Ensure all tests pass:

    crystal spec

  5. Create a new branch for your feature or bug fix:

    git checkout -b my-new-feature

  6. Write your feature or bug fix

  7. Ensure the code is formatted properly:

    crystal tool format

  8. Ensure the tests still pass:

    crystal spec

  9. Write tests to cover your new feature and ensure they pass:

    crystal spec

  10. Commit your changes:

    git commit -am "Add some feature"

  11. Push to the branch:

    git push origin my-new-feature

  12. Open a Pull Request on GitHub

Contributors

License

The code is available as open source under the terms of the MIT License.