typekit-client 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bc086a0bb50bb480f485bbef88d7bebdcc25356
-  data.tar.gz: f8d01ce2b825b203f8df1ec09607549800987c64
+  metadata.gz: b2d0603ce4ff30ecb04ccf846ba94cf71b0e8d54
+  data.tar.gz: a85ce05a15a5aa3b0cea5b1e0122ccd0b8db6eb8
 SHA512:
-  metadata.gz: 632b2218c382aac4717d5aebbb612ccf670c83f36ca0b12ac7b1d1a83018f4d2714893638d39dc10f6c032b6ec473a06a683e7a70e50227cb9ae512c5f2b9997
-  data.tar.gz: 6a55fc36b622cb55a54512abbe3b8648efcae9b4f207928e40191b094781a50c18d225dedc7db5fdc48e3f7d961ed60c0952528acde0824fdc7d3844babdc736
+  metadata.gz: a661e632bae645066c291a078fdd60ce727d137e3bd5edf4778dbe5dad1554f18e1f88d99c4dbbea0bc92e09d042c7486c64c30fa77e3984ac3b0145e40d6f38
+  data.tar.gz: 60bfc3980c3128be77545fb6be4e8d88edd436b773f30a09cc930868f666b001ea1227e2c6e5bcbb17e7790273fa48f0df0e3c644b8426b8f140ca469e890404

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Typekit Client 0.0.5 (June 10, 2014)
+* New name for the general CLI: `typekit-client` instead of `typekit`.
+* New CLI for the sole purpose of publishing kits: `typekit-publisher`.
+* Relations between resources (a kit has families, a family has variations,
+  a variation belongs to a family, etc.).
+
 ## Typekit Client 0.0.4 (June 1, 2014)
 * Extraction of the RESTful API logic into a separate gem called
   [Apitizer](https://github.com/IvanUkhov/apitizer).

data/Guardfile

@@ -1,7 +1,21 @@
 guard :rspec do
   watch(%r{^spec/.+_spec\.rb$})
-  watch('spec/spec_helper.rb') { 'spec' }
-  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{ m[1] }_spec.rb" }
-  watch(%r{^lib/(.*\.rb)$}) { |m| "spec/#{ File.dirname(m[1]) }" }
+  watch(%r{^spec/.+_helper\.rb$}) { 'spec' }
+  watch(%r{^lib/(.+)\.rb$}) do |match|
+    result = "spec/#{ match[1] }_spec.rb"
+    begin
+      break if File.exist?(result)
+      result = File.dirname(result)
+    end until result.empty?
+    result
+  end
+  watch(%r{^lib/[^/]+/(.+)\.rb$}) do |match|
+    result = "spec/features/#{ match[1] }"
+    begin
+      break if File.exist?(result)
+      result = File.dirname(result)
+    end until result.empty?
+    result
+  end
 end
+# vim: ft=ruby

data/README.md

@@ -2,24 +2,24 @@
 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:
+The minimal supported version of Ruby is `2.1`. The simplest way to install
+Ruby is via [rvm](https://rvm.io/):
 ```bash
-$ ruby -v
-ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin13.0]
+$ curl -sSL https://get.rvm.io | bash -s stable --ruby=2.1
 ```
 
-In case you don’t:
+Now you can install the library itself:
 ```bash
-$ curl -sSL https://get.rvm.io | bash
-$ rvm install 2.1
+$ gem install typekit-client
 ```
 
-Add the gem into your `Gemfile`:
+If you are planning to use the gem as a part of your project, add the
+following line into your `Gemfile`:
 ```ruby
 gem 'typekit-client', require: 'typekit'
 ```
 
-Then run `bundler`:
+Then execute:
 ```bash
 $ bundle
 ```
@@ -39,26 +39,17 @@ 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`;
+`client` has five methods: `index`, `show`, `create`, `update`, and `delete`.
+The signature of each method is `action(*path, parameters = {})`. The
+arguments are as follows:
 * `*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.
+  the endpoint of interest (a plenty of examples are given below);
+* `parameters` is a hash of parameters (optional).
 
-`perform` has an alias for each of the actions: `index(*path, parameters = {})`,
-`show(*path, parameters = {})`, `create(*path, parameters = {})`, and so on.
-Before sending the actual request to the Typekit API, `perform` 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 the [API reference](https://typekit.com/docs/api/).
+Before sending the actual request to the Typekit API, the library checks
+whether the endpoint given by `*path` exists and, if it does, whether
+the desired action (`index`, `show`, _etc._) is permitted. So, if you
+receive an exception, check 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:
@@ -70,7 +61,7 @@ rescue JSON::GeneratorError
 end
 ```
 
-### Show all kits
+### List all kits
 Code:
 ```ruby
 p kits = client.index(:kits)
@@ -107,7 +98,7 @@ Output:
 "/api/v1/json/kits/bas4cfe"
 ```
 
-### Show the description of a variant of a font family
+### Show the description of a variation of a font family
 Code:
 ```ruby
 p client.show(:families, 'vcsm', 'i9')
@@ -299,14 +290,14 @@ Output:
 true
 ```
 
-## Command-line Interface (CLI)
-There is a simple CLI provided in order to demonstrate the usage of the
+## General Command-line Interface
+There is a simple tool 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:
+any code. The tool is called `typekit-client`, and it should get installed
+along with the gem. Try running:
 ```
-$ typekit -h
-Usage: typekit [options] [command]
+$ typekit-client -h
+Usage: typekit-client [options] [command]
 
 Required options:
     -t, --token TOKEN                Set the API token
@@ -315,16 +306,16 @@ Other options:
     -h, --help                       Show this message
 ```
 
-Alternatively, you can install `typekit` in the `bin` directory of your
-project using the following command:
+Alternatively, you can install `typekit-client` in the `bin` directory of
+your project using the following command:
 ```bash
-$ bundle binstubs typekit
+$ bundle binstubs typekit-client
 ```
 
 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
+$ typekit-client -t $tk_token index kits
 [
   {
     "id": "bas4cfe",
@@ -338,7 +329,7 @@ $
 If `command` is not provided, the tool gives a command prompt wherein one
 can enter multiple commands:
 ```
-$ typekit -t $tk_token
+$ typekit-client -t $tk_token
 Type 'help' for help and 'exit' to exit.
 > help
 Usage: <action> <resource> [parameters]
@@ -368,6 +359,38 @@ Bye.
 $
 ```
 
+## Publishing Command-line Interface
+There is another utility with the sole purpose of publishing kits. The tool
+is called `typekit-publisher`:
+
+```
+$ typekit-publisher -h
+Usage: typekit-publisher [options]
+
+Required options:
+    -t, --token TOKEN                Set the API token
+
+Other options:
+    -h, --help                       Show this message
+```
+
+Using `typekit-publisher`, you can publish all your kits at once. Here is
+an example:
+
+```
+$ typekit-publisher -t $tk_token
+Which kit would you like to publish?
+   1. bas4cfe
+   2. sfh6bkj
+   3. kof8zcn
+   4. all
+> 4
+Publishing bas4cfe... Done.
+Publishing sfh6bkj... Done.
+Publishing kof8zcn... Done.
+Bye.
+```
+
 ## Contributing
 1. Fork it ( https://github.com/IvanUkhov/typekit-client/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/{typekit → typekit-client}

@@ -79,7 +79,7 @@ end
 options = {}
 
 parser = OptionParser.new do |o|
-  o.banner = 'Usage: typekit [options] [command]'
+  o.banner = 'Usage: typekit-client [options] [command]'
 
   o.separator ''
   o.separator 'Required options:'
@@ -103,6 +103,19 @@ rescue
   exit
 end
 
+unless options[:token]
+  puts <<-MESSAGE
+You have not specified your API token. Try generating one here:
+
+https://typekit.com/account/tokens
+
+Then run:
+
+$ typekit-client -t YOUR_TOKEN_GOES_HERE
+  MESSAGE
+  exit
+end
+
 begin
   controller = Controller.new(options)
 rescue Exception => e

data/bin/typekit-publisher

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'typekit'
+require 'readline'
+require 'optparse'
+
+options = {}
+
+parser = OptionParser.new do |o|
+  o.banner = 'Usage: typekit-publisher [options]'
+
+  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_tail('-h', '--help', 'Show this message') do
+    raise
+  end
+end
+
+begin
+  parser.parse!
+rescue
+  puts parser
+  exit
+end
+
+unless options[:token]
+  puts <<-MESSAGE
+You have not specified your API token. Try generating one here:
+
+https://typekit.com/account/tokens
+
+Then run:
+
+$ typekit-publisher -t YOUR_TOKEN_GOES_HERE
+  MESSAGE
+  exit
+end
+
+$client = Typekit::Client.new(token: options[:token])
+
+def process(*arguments)
+  $client.process(*arguments)
+rescue Typekit::Error => e
+  puts e
+  exit
+end
+
+kits = process(:index, :kits)
+
+puts 'Which kit would you like to publish?'
+kits.each_with_index do |kit, i|
+  puts "%4d. %s" % [ i + 1, kit.id ]
+end
+puts "%4d. all" % [ kits.length + 1 ]
+
+k = Readline.readline('> ')
+if k.nil? || k.empty?
+  puts 'None? OK.'
+  exit
+end
+
+k = k.to_i
+
+if k < 1 || k > kits.length + 1
+  puts 'Invalid option. Try again.'
+  exit
+end
+
+range = k == kits.length + 1 ? 0...kits.length : [ k - 1 ]
+
+range.each do |i|
+  print "Publishing #{ kits[i].id }..."
+  process(:update, :kits, kits[i].id, :publish)
+  puts ' Done.'
+end
+
+puts 'Bye.'
+
+# vim: set ft=ruby

data/lib/typekit/client.rb

@@ -18,12 +18,12 @@ module Typekit
 
     private
 
-    [ :engine, :translator ].each do |component|
-      class_eval <<-METHOD, __FILE__, __LINE__ + 1
-        def #{ component }
-          @#{ component } ||= build_#{ component }
-        end
-      METHOD
+    def engine
+      @engine ||= build_engine
+    end
+
+    def translator
+      @translator ||= Processing::Translator.new
     end
 
     def build_engine
@@ -37,9 +37,5 @@ module Typekit
         instance_exec(version, format, &Typekit.schema)
       end
     end
-
-    def build_translator
-      Processing::Translator.new
-    end
   end
 end

data/lib/typekit/collection.rb

@@ -0,0 +1,15 @@
+module Typekit
+  class Collection
+    extend Forwardable
+
+    def_delegator :@records, :to_json
+    def_delegators :@records, :each, :map, :[], :size, :length
+
+    def initialize(name, collection_attributes = nil)
+      @klass = Record.classify(name)
+      @records = collection_attributes.map do |attributes|
+        @klass.new(attributes)
+      end
+    end
+  end
+end

data/lib/typekit/core.rb

@@ -1,13 +1,13 @@
 module Typekit
   Error = Class.new(StandardError)
 
-  @defaults = { version: 1, format: :json }.freeze
+  @defaults = { version: 1, format: :json }
 
   @schema = Proc.new do |version, format|
     address "https://typekit.com/api/v#{ version }/#{ format }"
 
     resources :families, only: :show do
-      show ':variant', on: :member
+      show ':variation', on: :member
     end
 
     resources :kits do
@@ -19,7 +19,7 @@ module Typekit
     resources :libraries, only: [ :index, :show ]
   end
 
-  @dictionary = { :update => :post }.freeze # not PUT, Typekit’s exception
+  @dictionary = { :update => :post } # not PUT
 
   @headers = Proc.new do |token|
     { 'X-Typekit-Token' => token }

data/lib/typekit/helper.rb

@@ -21,5 +21,9 @@ module Typekit
         name
       end
     end
+
+    def self.symbolize_keys(hash)
+      Hash[hash.map { |k, v| [ k.to_sym, v ] }]
+    end
   end
 end

data/lib/typekit/processing/converter/boolean.rb

@@ -2,6 +2,9 @@ module Typekit
   module Processing
     module Converter
       class Boolean
+        def initialize(*_)
+        end
+
         def process(response, object)
           object # already boolean
         end

data/lib/typekit/processing/converter/collection.rb

@@ -0,0 +1,18 @@
+module Typekit
+  module Processing
+    module Converter
+      class Collection
+        def initialize(name)
+          @klass = Typekit::Record.classify(name)
+          raise Error, 'Unknown class' unless @klass
+        end
+
+        def process(response, collection_attributes)
+          collection_attributes.map do |attributes|
+            @klass.new(attributes)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/typekit/processing/converter/datetime.rb

@@ -2,6 +2,9 @@ module Typekit
   module Processing
     module Converter
       class DateTime
+        def initialize(*_)
+        end
+
         def process(response, object)
           ::DateTime.parse(object)
         end

data/lib/typekit/processing/converter/errors.rb

@@ -11,7 +11,9 @@ module Typekit
           503 => 'The Typekit API is offline for maintenance'
         }
         ERRORS.default = 'Unknown server error'
-        ERRORS.freeze
+
+        def initialize(*_)
+        end
 
         def process(response, errors)
           raise Error, Array(errors || ERRORS[response.code]).join(', ')

data/lib/typekit/processing/converter/record.rb

@@ -3,7 +3,8 @@ module Typekit
     module Converter
       class Record
         def initialize(name)
-          @klass = Typekit::Record.const_get(name.to_s.capitalize)
+          @klass = Typekit::Record.classify(name)
+          raise Error, 'Unknown class' unless @klass
         end
 
         def process(response, attributes)

data/lib/typekit/processing/converter.rb

@@ -1,5 +1,5 @@
 require_relative 'converter/record'
-require_relative 'converter/records'
+require_relative 'converter/collection'
 require_relative 'converter/boolean'
 require_relative 'converter/datetime'
 require_relative 'converter/errors'
@@ -9,24 +9,19 @@ module Typekit
   module Processing
     module Converter
       MAPPING = {
+        :record => Record,
+        :collection => Collection,
+
         'ok' => Boolean,
         'errors' => Errors,
         'published' => DateTime,
+
         nil => Errors
-      }.freeze
+      }
+      MAPPING.default = Unknown
 
       def self.build(name)
-        if MAPPING.key?(name)
-          MAPPING[name].new
-        elsif Typekit::Record.collection?(name)
-          Records.new(name)
-        elsif Typekit::Record.member?(name)
-          Record.new(name)
-        else
-          Unknown.new(name)
-        end
-      rescue NameError
-        raise Error, 'Unknown converter'
+        MAPPING[Typekit::Record.identify(name) || name].new(name)
       end
     end
   end

data/lib/typekit/record/base.rb

@@ -1,5 +1,3 @@
-require 'forwardable'
-
 module Typekit
   module Record
     class Base
@@ -8,23 +6,47 @@ module Typekit
       attr_reader :attributes
       def_delegator :attributes, :to_json
 
+      def self.has_many(name)
+        possessions << name
+      end
+
+      def self.possessions
+        @possessions ||= []
+      end
+
+      def self.belongs_to(name)
+        owners << name
+      end
+
+      def self.owners
+        @owners ||= []
+      end
+
       def initialize(attributes = {})
-        @attributes = Hash[attributes.map { |k, v| [ k.to_sym, v ] }]
+        attributes = { id: attributes } unless attributes.is_a?(Hash)
+        @attributes = Helper.symbolize_keys(attributes)
+
+        self.class.possessions.each do |name|
+          next unless @attributes.key?(name)
+          @attributes[name] = Collection.new(name, @attributes[name])
+        end
+
+        self.class.owners.each do |name|
+          next unless @attributes.key?(name)
+          @attributes[name] = Record.build(name, @attributes[name])
+        end
       end
 
       def method_missing(name, *arguments)
         if name.to_s =~ /^(?<name>.*)=$/
           name = Regexp.last_match(:name).to_sym
-          return super unless arguments.length == 1
           return super unless @attributes.key?(name)
-          @attributes[name] = arguments.first
+          @attributes.send(:[]=, name, *arguments)
         else
-          return super unless arguments.length.zero?
           return super unless @attributes.key?(name)
-          @attributes[name]
+          @attributes.send(:[], name, *arguments)
         end
       end
     end
   end
 end
-

data/lib/typekit/record/family.rb

@@ -1,7 +1,8 @@
 module Typekit
   module Record
     class Family < Base
-      # has_many :libraries, :variations
+      has_many :libraries
+      has_many :variations
     end
   end
 end

data/lib/typekit/record/kit.rb

@@ -1,7 +1,7 @@
 module Typekit
   module Record
     class Kit < Base
-      # has_many :families
+      has_many :families
     end
   end
 end

data/lib/typekit/record/library.rb

@@ -1,7 +1,7 @@
 module Typekit
   module Record
     class Library < Base
-      # has_many :families
+      has_many :families
     end
   end
 end

data/lib/typekit/record/variation.rb

@@ -1,8 +1,8 @@
 module Typekit
   module Record
     class Variation < Base
-      # belongs_to :family
-      # has_many :libraries
+      has_many :libraries
+      belongs_to :family
     end
   end
 end