Project

typekitty

0.0
No commit activity in last 3 years
No release in over 3 years
typekittyrazic/typekittyHomepageDocumentationSource CodeBug TrackerWiki
Ruby client for the Adobe Typekit API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
13,002
Stars
0
Forks
1
Watchers
0
 Releases
Current version
0.3.0
Total releases
5
First release
2014-05-15
Latest release
2014-05-16
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
5
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-05-17
Reverse Dependencies
0

 Dependencies

Development

rake
= 10.1.0
rspec
= 2.14.1
vcr
= 2.9.0
webmock
= 1.18.0

Runtime

hashie
= 2.1.1
httparty
= 0.13.1
thor
= 0.19.1
 Project Readme

typekitty

Ruby client for the Adobe Typekit API

Installation

$ gem install typekitty

Usage

You can access the Typekit API directly within Ruby or from your terminal.

To access the API within Ruby, continue reading; otherwise read the CLI section.

Ruby

The API requires Ruby 1.9.3 or greater.

Common Tasks

  • Listing Kits
  • Getting Information About the Draft Version of a Kit
  • Listing Font Libraries

Require the Gem

require 'typekitty'

Authenticating Requests

The ENV['TYPEKIT_TOKEN'] variable represents a Typekit API Token, which you may obtain on the tokens page.

The variable is used to authenticate requests. It must be set in order for your requests to authenticate properly.

An example could be:

ENV['TYPEKIT_TOKEN'] = 'my_secret_token'

Kits

Listing Kits
Typekitty::Kit.all
=> [#<Typekitty::Kit analytics=false badge=true domains=["viralkitty.com"] families=[{"id"=>"llxb", "name"=>"Museo Slab", "slug"=>"museo-slab", "css_names"=>["museo-slab"], "css_stack"=>"\"museo-slab\",serif", "subset"=>"default", "variations"=>["n3", "i3", "n7", "i7"]}] id="gec4ttz" name="viralkitty">]
Getting Information About The Draft Version of a Kit
Typekitty::Kit.find 'gec4ttz'
=> #<Typekitty::Kit analytics=false badge=true domains=["viralkitty.com"] families=[{"id"=>"llxb", "name"=>"Museo Slab", "slug"=>"museo-slab", "css_names"=>["museo-slab"], "css_stack"=>"\"museo-slab\",serif", "subset"=>"default", "variations"=>["n3", "i3", "n7", "i7"]}] id="gec4ttz" name="viralkitty">

Libraries

Listing Font Libraries
Typekitty::Library.all
=> [#<Typekitty::Library id="trial" link="/api/v1/json/libraries/trial" name="Trial Library">, #<Typekitty::Library id="personal" link="/api/v1/json/libraries/personal" name="Personal Library">, #<Typekitty::Library id="full" link="/api/v1/json/libraries/full" name="Full Library">]

CLI

The typekitty gem includes a command-line interface for accessing the Typekit API.

For usage and help:

$ typekitty
Commands:
  typekitty help [COMMAND]            # Describe available commands or one specific command
  typekitty kit KIT_ID --token=TOKEN  # Get information about the draft version of a kit
  typekitty kits --token=TOKEN        # Lists kits
  typekitty libraries                 # Lists font libraries

Development

Install the Dependencies

Use Bundler to install the dependencies:

$ bundle install

Running the Tests

$ rspec spec

Versioning

We use Semantic Versioning; please read before cutting new releases.

Fixtures

The specs use VCR cassettes to record and replay actual HTTP requests from the Typekit API.

License

MIT