typekit-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c787138c7a90aa58f94a0f9cfd0080aeac67440d
+  data.tar.gz: 24df2e9aa560fb343e385198510af8c235afa72e
+SHA512:
+  metadata.gz: 6adc44648829ecd93949689f00765376f61a9d8f7b6b3cd5e5976220dabb229c7a359ed26c12e8c9f46b7095fa928010d1732a32b88744131701cbebb688b2f9
+  data.tar.gz: 5adb42620a3c05627243b0e834ab12249a56cc62f48c0afe9ed5c87135f9ddc2a4fa03a206b3bc0d2106819027e701b75b0470d15194eea72eef06cf617d4235

data/.gitignore

@@ -0,0 +1,4 @@
+*.swp
+.DS_Store
+Gemfile.lock
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Typekit 0.0.2 (May 28, 2014)
+* Renamed the gem into `typekit-client` (still `require 'typekit'`).
+* Rewrote the whole library (refactoring, preparing for new features).
+* Implemented a DSL for describing the resources provided by Typekit.
+* Introduced a client-side verification of user requests.
+
+## Typekit 0.0.1 (May 16, 2014)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright 2014 Ivan Ukhov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,350 @@
+# Typekit Client
+A Ruby library for accessing the [Typekit API](https://typekit.com/docs/api).
+
+## Installation
+`Ruby >= 2.1` is required. Make sure you have it installed:
+```bash
+$ ruby -v
+ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]
+```
+
+In case you don’t:
+```bash
+$ curl -sSL https://get.rvm.io | bash
+$ rvm install 2.1
+```
+
+Add the gem into your `Gemfile`:
+```ruby
+gem 'typekit-client', require: 'typekit'
+```
+
+Then run `bundler`:
+```bash
+$ bundle
+```
+
+In order to interact with the Typekit API, one should have a valid API token.
+You can generate such a token [here](https://typekit.com/account/tokens).
+For convenience, let us create a shortcut for it:
+```bash
+$ export tk_token=YOUR_TOKEN_GOES_HERE
+```
+
+## Usage
+Here is the basic setup in a Ruby script:
+```ruby
+require 'typekit'
+
+client = Typekit::Client.new(token: ENV['tk_token'])
+```
+
+And here is how to run it, assuming you name your script `app.rb`:
+```bash
+$ bundle exec ruby app.rb
+```
+
+The main method of `client` is `perform(action, *path, parameters = {})`.
+The arguments are as follows:
+* `action` is the action that you would like to perform on a resource, and
+  it can be one of `:index`, `:show`, `:create`, `:update`, or `:delete`;
+* `*path` refers to an arbitrary number of arguments needed to identify
+  the desired resource (a plenty of examples are given below), and it
+  always begins with one of `:families`, `:kits`, or `:libraries`;
+* `parameters` is a hash of parameters needed to perform the action.
+
+`perform` has an alias for each of the actions: `index(*path, parameters = {})`,
+`show(*path, parameters = {})`, `create(*path, parameters = {})`, and so on.
+The result of a method call is returned as a hash, and its content is exactly
+what the Typekit API sends back to `client`. The only exception is when
+the API returns an error, in which case an appropriate exception is being
+raised.
+
+Before sending the actual request to the Typekit API, the library checks
+whether the resource given by `*path` makes sense and, if it does, whether
+`action` can be performed on that resource. So, if you receive an exception,
+check out the [API reference](https://typekit.com/docs/api/).
+
+Now, let us have a look at some typical use cases. For clarity, the code
+below makes use of the following auxiliary function:
+```ruby
+def p(data)
+  puts JSON.pretty_generate(data)
+end
+```
+
+### Show all kits
+Code:
+```ruby
+p client.index(:kits)
+```
+
+Output:
+```json
+{
+  "kits": [
+    {
+      "id": "bas4cfe",
+      "link": "/api/v1/json/kits/bas4cfe"
+    },
+    ...
+  ]
+}
+```
+
+### Show the description of a variant of a font family
+Code:
+```ruby
+p client.show(:families, 'vcsm', 'i9')
+```
+
+Output:
+```json
+{
+  "variation": {
+    "id": "vcsm:i9",
+    "name": "Proxima Nova Black Italic",
+    "family": {
+      "id": "vcsm",
+      "link": "/api/v1/json/families/vcsm",
+      "name": "Proxima Nova"
+    },
+    "font_style": "italic",
+    "font_variant": "normal",
+    "font_weight": "900",
+    ...
+  }
+}
+```
+
+### Show the font families in the trial library with pagination
+Code:
+```ruby
+p client.show(:libraries, 'trial', page: 10, per_page: 5)
+```
+
+Output:
+```json
+{
+  "library": {
+    "id": "trial",
+    "link": "/api/v1/json/libraries/trial",
+    "name": "Trial Library",
+    "families": [
+      {
+        "id": "qnhl",
+        "link": "/api/v1/json/families/qnhl",
+        "name": "Caliban Std"
+      },
+      {
+        "id": "vybr",
+        "link": "/api/v1/json/families/vybr",
+        "name": "Calluna"
+      },
+      ...
+    ],
+    "pagination": {
+      "count": 261,
+      "on": "families",
+      "page": 10,
+      "page_count": 53,
+      "per_page": 5
+    }
+  }
+}
+```
+
+### Create a new kit
+Code:
+```ruby
+p result = client.create(:kits, name: 'Megakit', domains: 'localhost')
+kit_id = result['kit']['id']
+```
+
+Output:
+```json
+{
+  "kit": {
+    "id": "izw0qiq",
+    "name": "Megakit",
+    "analytics": false,
+    "badge": true,
+    "domains": [
+      "localhost"
+    ],
+    "families": [
+
+    ]
+  }
+}
+```
+
+### Disable the badge of a kit
+Code:
+```ruby
+p client.update(:kits, kit_id, badge: false)
+```
+
+Output:
+```json
+{
+  "kit": {
+    "id": "izw0qiq",
+    "name": "Megakit",
+    "analytics": false,
+    "badge": false,
+    "domains": [
+      "localhost"
+    ],
+    "families": [
+
+    ]
+  }
+}
+```
+
+### Look up the id of a font family by its slug
+Code:
+```ruby
+p result = client.show(:families, 'proxima-nova')
+family_id = result['family']['id']
+```
+
+Output:
+```json
+{
+  "family": {
+    "id": "vcsm",
+    "link": "/api/v1/json/families/vcsm"
+  }
+}
+```
+
+### Add a font family into a kit
+Code:
+```ruby
+p client.update(:kits, kit_id, families: { "0" => { id: family_id } })
+```
+
+Output:
+```json
+{
+  "kit": {
+    "id": "nys8sny",
+    "name": "Megakit",
+    "analytics": false,
+    "badge": false,
+    "domains": [
+      "localhost"
+    ],
+    "families": [
+      {
+        "id": "vcsm",
+        "name": "Proxima Nova",
+        "slug": "proxima-nova",
+        "css_names": [
+          "proxima-nova-1",
+          "proxima-nova-2"
+        ],
+        ...
+      }
+    ]
+  }
+}
+```
+
+### Delete a kit
+Command:
+```ruby
+p client.delete(:kits, kit_id)
+```
+
+Output:
+```json
+{
+  "ok": true
+}
+```
+
+## Command-line Interface (CLI)
+There is a simple CLI provided in order to demonstrate the usage of the
+library and to give the ability to perform basic operations without writing
+any code. The tool is called `typekit`, and it should get installed along
+with the gem. Try running:
+```
+$ typekit -h
+Usage: typekit [options] [command]
+
+Required options:
+    -t, --token TOKEN                Set the API token
+
+Other options:
+    -v, --version VERSION            Set the API version
+    -f, --format FORMAT              Set the data format
+    -h, --help                       Show this message
+```
+
+Alternatively, you can install `typekit` in the `bin` directory of your
+project using the following command:
+```bash
+$ bundle binstubs typekit
+```
+
+The tool has two modes: normal and interactive. If `command` is provided,
+the tool executes only that particular command and terminates:
+```
+$ typekit -t $tk_token index kits
+{
+  "kits": [
+    {
+      "id": "bas4cfe",
+      "link": "/api/v1/json/kits/bas4cfe"
+    },
+    ...
+  ]
+}
+$
+```
+
+If `command` is not provided, the tool gives a command prompt wherein one
+can enter multiple commands:
+```
+$ typekit -t $tk_token
+Type 'help' for help and 'exit' to exit.
+> help
+Usage: <action> <resource> [parameters]
+
+    <action>        index, show, create, update, or delete
+    <resource>      a list separated by whitespaces
+    [parameters]    a JSON-encoded hash (optional)
+
+Examples:
+    index kits
+    show kits bas4cfe families vcsm
+    show families vcsm i9
+    show libraries trial { "page": 10, "per_page": 5 }
+    create kits { "name": "Megakit", "domains": "localhost" }
+    update kits bas4cfe { "name": "Ultrakit" }
+    delete kits bas4cfe
+> index kits
+{
+  "kits": [
+    {
+      "id": "bas4cfe",
+      "link": "/api/v1/json/kits/bas4cfe"
+    },
+    ...
+  ]
+}
+> exit
+Bye.
+$
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/IvanUkhov/typekit-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/typekit

@@ -0,0 +1,146 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'typekit'
+require 'optparse'
+require 'json'
+
+class Controller
+  def initialize(**options)
+    @client = Typekit::Client.new(**options)
+  end
+
+  def process(command)
+    action, path, parameters = parse(command)
+    print @client.perform(action, path, parameters)
+  rescue Exception => e
+    puts e
+  end
+
+  def help
+    puts <<-HELP
+Usage: <action> <resource> [parameters]
+
+    <action>        show, create, update, or delete
+    <resource>      a list separated by whitespaces
+    [parameters]    a JSON-encoded hash (optional)
+
+Examples:
+    index kits
+    show kits bas4cfe families vcsm
+    show families vcsm i9
+    show libraries trial { "page": 10, "per_page": 5 }
+    create kits { "name": "Megakit", "domains": "localhost" }
+    update kits bas4cfe { "name": "Ultrakit" }
+    delete kits bas4cfe
+HELP
+  end
+
+  protected
+
+  def print(output)
+    puts JSON.pretty_generate(output)
+  end
+
+  def parse(command)
+    parameters = extract_parameters!(command)
+
+    chunks = command.split(/\s+/).compact.reject(&:empty?)
+    action, path = chunks[0], chunks[1..-1]
+
+    raise 'Missing action name' if action.nil?
+    raise 'Invalid action name' unless action =~ /^\w+$/
+
+    raise 'Missing resource name' if path.empty?
+    unless path.all?{ |chunk| chunk =~ /^[-\w\d]+$/ }
+      raise 'Invalid resource name'
+    end
+
+    [ action, path, parameters ]
+  end
+
+  def extract_parameters!(command)
+    if command =~ /(?<parameters>{.*})\s*$/
+      parameters = JSON.parse(Regexp.last_match(:parameters))
+      raise unless parameters.is_a?(Hash)
+      command.gsub!(/{.*}/, '')
+      parameters
+    else
+      {}
+    end
+  rescue
+    raise 'Invalid parameters'
+  end
+end
+
+options = {}
+
+parser = OptionParser.new do |o|
+  o.banner = 'Usage: typekit [options] [command]'
+
+  o.separator ''
+  o.separator 'Required options:'
+
+  o.on('-t', '--token TOKEN', 'Set the API token') do |value|
+    options[:token] = value
+  end
+
+  o.separator ''
+  o.separator 'Other options:'
+
+  o.on('-v', '--version VERSION', 'Set the API version') do |value|
+    options[:version] = value
+  end
+
+  o.on('-f', '--format FORMAT', 'Set the data format') do |value|
+    options[:format] = value
+  end
+
+  o.on_tail('-h', '--help', 'Show this message') do
+    raise
+  end
+end
+
+begin
+  parser.parse!
+rescue
+  puts parser
+  exit
+end
+
+begin
+  controller = Controller.new(options)
+rescue Exception => e
+  puts e
+  exit
+end
+
+unless ARGV.empty?
+  controller.process(ARGV.join(' '))
+  exit
+end
+
+puts %{Type 'help' for help and 'exit' to exit.}
+
+loop do
+  begin
+    print '> '
+    command = $stdin.gets.strip
+    next if command.empty?
+    case command
+    when 'exit'
+      break
+    when 'help'
+      controller.help
+    else
+      controller.process(command)
+    end
+  rescue Interrupt
+    break
+  end
+end
+
+puts 'Bye.'
+
+# vim: set ft=ruby