typekit-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c787138c7a90aa58f94a0f9cfd0080aeac67440d
-  data.tar.gz: 24df2e9aa560fb343e385198510af8c235afa72e
+  metadata.gz: 88f79a82bec7c431919822610e0b780faaa7c5aa
+  data.tar.gz: 13dff8c0ffb2cd4df92f76cb89574e11ef8644e4
 SHA512:
-  metadata.gz: 6adc44648829ecd93949689f00765376f61a9d8f7b6b3cd5e5976220dabb229c7a359ed26c12e8c9f46b7095fa928010d1732a32b88744131701cbebb688b2f9
-  data.tar.gz: 5adb42620a3c05627243b0e834ab12249a56cc62f48c0afe9ed5c87135f9ddc2a4fa03a206b3bc0d2106819027e701b75b0470d15194eea72eef06cf617d4235
+  metadata.gz: 568ade996d80ad36f2af3d374f4ef71cc0cebf6d56b7c2be718277967def5b82fd65fded286d5d21fde117f7251439809c809a05b25db6441ec092a7fca55b91
+  data.tar.gz: f0644585301a5fe1b8ee6384f6076c603c4265747e0dc390330c201d5d3d0c003a4d7f5c53da2a4c78f01bfb807a4f66b109df6674084890ac1b33bdf3d66a34

data/.gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 Gemfile.lock
 *.gem
+*.swo

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -1,7 +1,11 @@
-## 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 Client (master)
+* Object-restful mapping (families, kits, etc. got proper classes).
+* Command history and tab completion in the CLI.
+
+## Typekit Client 0.0.2 (May 28, 2014)
+* New name for the gem (still `require 'typekit'`).
+* Basic DSL for describing RESTful resources.
+* Client-side verification of user requests.
+* Refactoring, preparing for new features.
 
 ## Typekit 0.0.1 (May 16, 2014)

data/Guardfile

@@ -0,0 +1,7 @@
+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]) }" }
+end

data/README.md

@@ -1,4 +1,4 @@
-# Typekit Client
+# Typekit Client [![Gem Version](https://badge.fury.io/rb/typekit-client.svg)](http://badge.fury.io/rb/typekit-client) [![Build Status](https://travis-ci.org/IvanUkhov/typekit-client.svg?branch=master)](https://travis-ci.org/IvanUkhov/typekit-client)
 A Ruby library for accessing the [Typekit API](https://typekit.com/docs/api).
 
 ## Installation
@@ -55,41 +55,56 @@ The arguments are as follows:
 
 `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
+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 out the [API reference](https://typekit.com/docs/api/).
+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:
 ```ruby
 def p(data)
   puts JSON.pretty_generate(data)
+rescue JSON::GeneratorError
+  puts data.inspect
 end
 ```
 
 ### Show all kits
 Code:
 ```ruby
-p client.index(:kits)
+p kits = client.index(:kits)
+p kits.map(&:class)
+p kits.first.attributes
+p kits.first.link
 ```
 
 Output:
 ```json
+[
+  {
+    "id": "bas4cfe",
+    "link": "/api/v1/json/kits/bas4cfe"
+  },
+  {
+    "id": "sfh6bkj",
+    "link": "/api/v1/json/kits/sfh6bkj"
+  },
+  {
+    "id": "kof8zcn",
+    "link": "/api/v1/json/kits/kof8zcn"
+  }
+]
+[
+  "Typekit::Record::Kit",
+  "Typekit::Record::Kit",
+  "Typekit::Record::Kit"
+]
 {
-  "kits": [
-    {
-      "id": "bas4cfe",
-      "link": "/api/v1/json/kits/bas4cfe"
-    },
-    ...
-  ]
+  "id": "bas4cfe",
+  "link": "/api/v1/json/kits/bas4cfe"
 }
+"/api/v1/json/kits/bas4cfe"
 ```
 
 ### Show the description of a variant of a font family
@@ -101,19 +116,17 @@ 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",
-    ...
-  }
+  "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",
+  ...
 }
 ```
 
@@ -126,30 +139,28 @@ 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
-    }
+  "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
   }
 }
 ```
@@ -157,115 +168,137 @@ Output:
 ### Create a new kit
 Code:
 ```ruby
-p result = client.create(:kits, name: 'Megakit', domains: 'localhost')
-kit_id = result['kit']['id']
+p kit = client.create(:kits, name: 'Megakit', domains: 'localhost')
 ```
 
 Output:
 ```json
 {
-  "kit": {
-    "id": "izw0qiq",
-    "name": "Megakit",
-    "analytics": false,
-    "badge": true,
-    "domains": [
-      "localhost"
-    ],
-    "families": [
-
-    ]
-  }
+  "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)
+p client.update(:kits, kit.id, badge: false)
 ```
 
 Output:
 ```json
 {
-  "kit": {
-    "id": "izw0qiq",
-    "name": "Megakit",
-    "analytics": false,
-    "badge": false,
-    "domains": [
-      "localhost"
-    ],
-    "families": [
-
-    ]
-  }
+  "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']
+p family = client.show(:families, 'proxima-nova')
 ```
 
 Output:
 ```json
 {
-  "family": {
-    "id": "vcsm",
-    "link": "/api/v1/json/families/vcsm"
-  }
+  "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 } })
+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"
-        ],
-        ...
-      }
-    ]
-  }
+  "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:
+### Publish a kit
+Code:
 ```ruby
-p client.delete(:kits, kit_id)
+p client.update(:kits, kit.id, :publish)
 ```
 
 Output:
-```json
+```
+#<DateTime: 2014-05-31T06:45:29+00:00 ((2456809j,24329s,0n),+0s,2299161j)>
+```
+
+### Show the description of a published kit
+Code:
+```ruby
+p client.show(:kits, kit.id, :published)
+```
+
+Output:
+```
 {
-  "ok": true
+  "id": "vzt4lrg",
+  "name": "Megakit",
+  "analytics": false,
+  "badge": false,
+  "domains": [
+    "localhost"
+  ],
+  "families": [
+    ...
+  ],
+  "published": "2014-05-31T06:45:29Z"
 }
 ```
 
+### Delete a kit
+Command:
+```ruby
+p client.delete(:kits, kit.id)
+```
+
+Output:
+```
+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
@@ -294,15 +327,13 @@ 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"
-    },
-    ...
-  ]
-}
+[
+  {
+    "id": "bas4cfe",
+    "link": "/api/v1/json/kits/bas4cfe"
+  },
+  ...
+]
 $
 ```
 
@@ -327,15 +358,13 @@ Examples:
     update kits bas4cfe { "name": "Ultrakit" }
     delete kits bas4cfe
 > index kits
-{
-  "kits": [
-    {
-      "id": "bas4cfe",
-      "link": "/api/v1/json/kits/bas4cfe"
-    },
-    ...
-  ]
-}
+[
+  {
+    "id": "bas4cfe",
+    "link": "/api/v1/json/kits/bas4cfe"
+  },
+  ...
+]
 > exit
 Bye.
 $

data/bin/typekit

@@ -3,10 +3,14 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 require 'typekit'
+require 'readline'
 require 'optparse'
 require 'json'
 
 class Controller
+  ACTIONS = %w{index show create update delete}
+  KEYWORDS = %w{families kits libraries published publish}
+
   def initialize(**options)
     @client = Typekit::Client.new(**options)
   end
@@ -22,7 +26,7 @@ class Controller
     puts <<-HELP
 Usage: <action> <resource> [parameters]
 
-    <action>        show, create, update, or delete
+    <action>        index, show, create, update, or delete
     <resource>      a list separated by whitespaces
     [parameters]    a JSON-encoded hash (optional)
 
@@ -41,6 +45,8 @@ HELP
 
   def print(output)
     puts JSON.pretty_generate(output)
+  rescue JSON::GeneratorError
+    puts output.to_s # neither hash nor array
   end
 
   def parse(command)
@@ -50,12 +56,8 @@ HELP
     action, path = chunks[0], chunks[1..-1]
 
     raise 'Missing action name' if action.nil?
-    raise 'Invalid action name' unless action =~ /^\w+$/
-
+    raise 'Invalid action name' unless ACTIONS.include?(action)
     raise 'Missing resource name' if path.empty?
-    unless path.all?{ |chunk| chunk =~ /^[-\w\d]+$/ }
-      raise 'Invalid resource name'
-    end
 
     [ action, path, parameters ]
   end
@@ -123,11 +125,22 @@ end
 
 puts %{Type 'help' for help and 'exit' to exit.}
 
+COMMANDS = Controller::ACTIONS + Controller::KEYWORDS + %w{help exit}
+Readline.completion_proc = proc do |input|
+  COMMANDS.grep(/^#{ Regexp.escape(input) }/)
+end
+
 loop do
   begin
-    print '> '
-    command = $stdin.gets.strip
+    command = Readline.readline('> ', true)
+    if command.nil? # ^D
+      puts
+      next
+    end
+
+    command.strip!
     next if command.empty?
+
     case command
     when 'exit'
       break

data/lib/typekit/client.rb

@@ -4,16 +4,16 @@ module Typekit
   class Client
     extend Forwardable
 
-    def_delegators :@config, :map, :dispatcher, :processor
-    private def_delegator :dispatcher, :deliver
-    private def_delegator :processor, :process
+    def_delegators :@config, :mapper, :dispatcher, :translator
+    private def_delegator :dispatcher, :process, :dispatch
+    private def_delegator :translator, :process, :translate
 
     def initialize(config: :default, **options)
       @config = Configuration.build(config, **options)
     end
 
     def perform(*arguments)
-      process(deliver(trace(*arguments)))
+      translate(dispatch(trace(*arguments)))
     end
 
     Typekit.actions.each do |action|
@@ -32,7 +32,7 @@ module Typekit
     def trace(*arguments)
       action, path, parameters = prepare(*arguments)
       request = Connection::Request.new(action: action, parameters: parameters)
-      map.trace(request, path)
+      mapper.trace(request, path)
     end
   end
 end

data/lib/typekit/configuration/base.rb

@@ -9,7 +9,7 @@ module Typekit
         @token = token
       end
 
-      [ :map, :dispatcher, :processor ].each do |component|
+      [ :mapper, :dispatcher, :translator ].each do |component|
         class_eval <<-METHOD, __FILE__, __LINE__ + 1
           def #{ component }
             @#{ component } ||= build_#{ component }

data/lib/typekit/configuration/default.rb

@@ -3,9 +3,9 @@ module Typekit
     class Default < Base
       private
 
-      def build_map
-        context = [ Typekit.address, "v#{ version }", format ]
-        Routing::Map.new do
+      def build_mapper
+        context = build_context
+        Routing::Mapper.new do
           scope context do
             resources :families, only: :show do
               show ':variant', on: :member
@@ -26,8 +26,12 @@ module Typekit
         Connection::Dispatcher.new(adaptor: :standard, token: token)
       end
 
-      def build_processor
-        Processor.new(format: format)
+      def build_translator
+        Processing::Translator.new(format: format)
+      end
+
+      def build_context
+        [ Typekit.address, "v#{ version }", format ]
       end
     end
   end

data/lib/typekit/connection/dispatcher.rb

@@ -6,11 +6,11 @@ module Typekit
         @adaptor = Adaptor.build(adaptor)
       end
 
-      def deliver(request)
+      def process(request)
         method = Helper.translate_action(request.action)
         code, _, body = @adaptor.process(method, request.address,
           request.parameters, 'X-Typekit-Token' => @token)
-        Response.new(code: code.to_i, content: body)
+        Response.new(code: code.to_i, body: body)
       end
     end
   end

data/lib/typekit/connection/request.rb

@@ -5,7 +5,7 @@ module Typekit
     class Request
       extend Forwardable
 
-      attr_reader :action, :parameters, :path
+      attr_reader :action, :parameters, :path, :node
       def_delegators :@path, :<<
 
       def initialize(action:, parameters: {})
@@ -15,9 +15,12 @@ module Typekit
       end
 
       def address
-        # TODO: cache?
         @path.map(&:to_s).join('/')
       end
+
+      def sign(node)
+        @node = node
+      end
     end
   end
 end

data/lib/typekit/connection/response.rb

@@ -1,19 +1,15 @@
 module Typekit
   module Connection
     class Response
-      attr_reader :code, :content
+      attr_reader :code, :body
 
-      def initialize(code:, content:)
+      def initialize(code:, body:)
         @code = code
-        @content = content
+        @body = body
       end
 
       def success?
-        @code == 200
-      end
-
-      def redirect?
-        @code == 302
+        [ 200, 302 ].include?(@code)
       end
     end
   end