typekit-client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88f79a82bec7c431919822610e0b780faaa7c5aa
-  data.tar.gz: 13dff8c0ffb2cd4df92f76cb89574e11ef8644e4
+  metadata.gz: 2bc086a0bb50bb480f485bbef88d7bebdcc25356
+  data.tar.gz: f8d01ce2b825b203f8df1ec09607549800987c64
 SHA512:
-  metadata.gz: 568ade996d80ad36f2af3d374f4ef71cc0cebf6d56b7c2be718277967def5b82fd65fded286d5d21fde117f7251439809c809a05b25db6441ec092a7fca55b91
-  data.tar.gz: f0644585301a5fe1b8ee6384f6076c603c4265747e0dc390330c201d5d3d0c003a4d7f5c53da2a4c78f01bfb807a4f66b109df6674084890ac1b33bdf3d66a34
+  metadata.gz: 632b2218c382aac4717d5aebbb612ccf670c83f36ca0b12ac7b1d1a83018f4d2714893638d39dc10f6c032b6ec473a06a683e7a70e50227cb9ae512c5f2b9997
+  data.tar.gz: 6a55fc36b622cb55a54512abbe3b8648efcae9b4f207928e40191b094781a50c18d225dedc7db5fdc48e3f7d961ed60c0952528acde0824fdc7d3844babdc736

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## Typekit Client (master)
+## 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).
+* Elimination of the `--version` and `--format` options of the CLI.
+
+## Typekit Client 0.0.3 (May 31, 2014)
 * Object-restful mapping (families, kits, etc. got proper classes).
 * Command history and tab completion in the CLI.
 

data/README.md

@@ -272,7 +272,7 @@ p client.show(:kits, kit.id, :published)
 ```
 
 Output:
-```
+```json
 {
   "id": "vzt4lrg",
   "name": "Megakit",
@@ -312,8 +312,6 @@ 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
 ```
 
@@ -371,7 +369,6 @@ $
 ```
 
 ## 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'`)

data/bin/typekit

@@ -91,14 +91,6 @@ parser = OptionParser.new do |o|
   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

data/lib/typekit.rb

@@ -1,13 +1,11 @@
-require_relative 'typekit/version'
+require 'apitizer'
 
 require_relative 'typekit/core'
 require_relative 'typekit/helper'
-require_relative 'typekit/configuration'
 
-require_relative 'typekit/routing'
-require_relative 'typekit/connection'
 require_relative 'typekit/processing'
 
 require_relative 'typekit/record'
-
 require_relative 'typekit/client'
+
+require_relative 'typekit/version'

data/lib/typekit/client.rb

@@ -1,38 +1,45 @@
-require 'forwardable'
-
 module Typekit
   class Client
     extend Forwardable
 
-    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_delegator :translator, :process, :translate
 
-    def perform(*arguments)
-      translate(dispatch(trace(*arguments)))
+    def initialize(**options)
+      @options = Typekit.defaults.merge(options)
+      raise Error, 'Token is missing' unless @options.key?(:token)
     end
 
-    Typekit.actions.each do |action|
-      define_method(action) do |*arguments|
-        perform(action, *arguments)
+    [ :process, :index, :show, :create, :update, :delete ].each do |method|
+      define_method(method) do |*arguments|
+        translate(engine.send(method, *arguments))
       end
     end
+    alias_method :perform, :process
 
     private
 
-    def prepare(action, *path)
-      parameters = path.last.is_a?(Hash) ? path.pop : {}
-      [ action.to_sym, path.flatten.map(&:to_sym), parameters ]
+    [ :engine, :translator ].each do |component|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{ component }
+          @#{ component } ||= build_#{ component }
+        end
+      METHOD
+    end
+
+    def build_engine
+      version = @options[:version]
+      format = @options[:format]
+
+      options = @options.merge(dictionary: Typekit.dictionary,
+        headers: Typekit.headers.call(@options[:token]))
+
+      Apitizer::Base.new(**options) do
+        instance_exec(version, format, &Typekit.schema)
+      end
     end
 
-    def trace(*arguments)
-      action, path, parameters = prepare(*arguments)
-      request = Connection::Request.new(action: action, parameters: parameters)
-      mapper.trace(request, path)
+    def build_translator
+      Processing::Translator.new
     end
   end
 end

data/lib/typekit/core.rb

@@ -1,16 +1,31 @@
 module Typekit
   Error = Class.new(StandardError)
 
-  @address = 'https://typekit.com/api'.freeze
+  @defaults = { version: 1, format: :json }.freeze
 
-  @actions = [ :index, :show, :create, :update, :delete ].freeze
-  @collection_actions = [ :index, :create ].freeze
-  @member_actions = [ :show, :update, :delete ].freeze
-  @action_dictionary = { :index => :get, :show => :get,
-    :create => :post, :update => :post, :delete => :delete }.freeze
+  @schema = Proc.new do |version, format|
+    address "https://typekit.com/api/v#{ version }/#{ format }"
+
+    resources :families, only: :show do
+      show ':variant', on: :member
+    end
+
+    resources :kits do
+      resources :families, only: [ :show, :update, :delete ]
+      show :published, on: :member
+      update :publish, on: :member
+    end
+
+    resources :libraries, only: [ :index, :show ]
+  end
+
+  @dictionary = { :update => :post }.freeze # not PUT, Typekit’s exception
+
+  @headers = Proc.new do |token|
+    { 'X-Typekit-Token' => token }
+  end
 
   singleton_class.class_eval do
-    attr_reader :address, :actions, :collection_actions,
-      :member_actions, :action_dictionary
+    attr_reader :defaults, :schema, :dictionary, :headers
   end
 end

data/lib/typekit/helper.rb

@@ -1,27 +1,5 @@
-require 'rack/utils'
-
 module Typekit
   module Helper
-    Error = Class.new(Typekit::Error)
-
-    def self.member_action?(action)
-      if Typekit.member_actions.include?(action)
-        true
-      elsif Typekit.collection_actions.include?(action)
-        false
-      else
-        raise Error, 'Unknown action'
-      end
-    end
-
-    def self.translate_action(action)
-      Typekit.action_dictionary[action] or raise Error, 'Unknown action'
-    end
-
-    def self.build_query(parameters)
-      Rack::Utils.build_nested_query(prepare_parameters(parameters))
-    end
-
     def self.pluralize(name)
       case name
       when /^.*s$/
@@ -43,23 +21,5 @@ module Typekit
         name
       end
     end
-
-    private
-
-    def self.prepare_parameters(parameters)
-      # PATCH: https://github.com/rack/rack/issues/557
-      Hash[
-        parameters.map do |key, value|
-          case value
-          when Integer, TrueClass, FalseClass
-            [ key, value.to_s ]
-          when Hash
-            [ key, prepare_parameters(value) ]
-          else
-            [ key, value ]
-          end
-        end
-      ]
-    end
   end
 end

data/lib/typekit/processing.rb

@@ -1,4 +1,3 @@
-require_relative 'processing/parser'
 require_relative 'processing/converter'
 require_relative 'processing/translator'
 

data/lib/typekit/processing/converter.rb

@@ -11,7 +11,8 @@ module Typekit
       MAPPING = {
         'ok' => Boolean,
         'errors' => Errors,
-        'published' => DateTime
+        'published' => DateTime,
+        nil => Errors
       }.freeze
 
       def self.build(name)

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

@@ -3,10 +3,11 @@ module Typekit
     module Converter
       class Unknown
         def initialize(name)
+          @name = name
         end
 
         def process(response, object)
-          object
+          { @name => object }
         end
       end
     end

data/lib/typekit/processing/translator.rb

@@ -1,15 +1,12 @@
 module Typekit
   module Processing
     class Translator
-      def initialize(format:)
-        @parser = Parser.build(format)
-      end
-
-      def process(response)
-        data = @parser.process(response.body) rescue nil
-        data = { nil => nil } unless data.is_a?(Hash) && data.length == 1
-        name, object = *data.first
-        Converter.build(name).process(response, object)
+      def process(result)
+        unless result.is_a?(Hash) && result.length == 1
+          raise Error, 'Unknown server response'
+        end
+        name, object = *result.first
+        Converter.build(name).process(result, object)
       end
     end
   end

data/lib/typekit/record.rb

@@ -25,11 +25,11 @@ module Typekit
     end
 
     def self.collection?(name)
-      collections.include?(name.to_sym)
+      collections.include?(name.to_s.to_sym)
     end
 
     def self.member?(name)
-      members.include?(name.to_sym)
+      members.include?(name.to_s.to_sym)
     end
   end
 end

data/lib/typekit/version.rb

@@ -1,3 +1,3 @@
 module Typekit
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require_relative 'support/rest_helper'
 require 'webmock/rspec'
 require 'vcr'
+require 'typekit'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/typekit/client_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'typekit'
 
 describe Typekit::Client do
   let(:token) { 'arbitrary' }
@@ -28,8 +27,7 @@ describe Typekit::Client do
       options = { vcr: { cassette_name: 'show_families_calluna_found' } }
 
       it 'returns the Response as is', options do
-        expect { subject.show(:families, 'calluna') }.not_to \
-          raise_error
+        expect { subject.show(:families, 'calluna') }.not_to raise_error
       end
     end
   end

data/spec/typekit/helper_spec.rb

@@ -1,43 +1,8 @@
 require 'spec_helper'
-require 'typekit'
 
 describe Typekit::Helper do
-  extend RESTHelper
-
   let(:subject_module) { Typekit::Helper }
 
-  describe '.member_action?' do
-    restful_member_actions.each do |action|
-      it "returns true for the #{ action } member action" do
-        expect(subject_module.member_action?(action)).to be_true
-      end
-    end
-
-    restful_collection_actions.each do |action|
-      it "returns false for the #{ action } collection action" do
-        expect(subject_module.member_action?(action)).to be_false
-      end
-    end
-
-    it 'raises exceptions when encounters unknown actions' do
-      expect { subject_module.member_action?(:rock) }.to \
-        raise_error(Typekit::Helper::Error, /Unknown action/i)
-    end
-  end
-
-  describe '.translate_action' do
-    rest_http_dictionary.each do |action, method|
-      it "returns the #{ method } verb for the #{ action } action" do
-        expect(subject_module.translate_action(action)).to eq(method)
-      end
-    end
-
-    it 'raises exceptions when encounters unknown actions' do
-      expect { subject_module.translate_action(:rock) }.to \
-        raise_error(Typekit::Helper::Error, /Unknown action/i)
-    end
-  end
-
   describe '.pluralize' do
     {
       'kit' => 'kits',
@@ -71,57 +36,4 @@ describe Typekit::Helper do
       end
     end
   end
-
-  describe '.build_query' do
-    it 'handels ordinary parameters' do
-      queries = [
-        'name=Megakit&domains=localhost',
-        'domains=localhost&name=Megakit'
-      ]
-      query = subject_module.build_query(
-        name: 'Megakit', domains: 'localhost')
-      expect(queries).to include(query)
-    end
-
-    it 'handles parameters whose values are ordinary lists' do
-      query = subject_module.build_query(
-        domains: [ 'example.com', 'example.net' ])
-      expect(query).to eq('domains[]=example.com&domains[]=example.net')
-    end
-
-    it 'handles parameters whose values are object lists' do
-      queries = [
-        'families[0][id]=gkmg&families[1][id]=asdf',
-        'families[1][id]=asdf&families[0][id]=gkmg'
-      ]
-      query = subject_module.build_query(
-        families: { 0 => { id: 'gkmg' }, 1 => { id: 'asdf' } })
-      expect(queries).to include(query)
-    end
-
-    it 'converts integers to decimal strings' do
-      query = subject_module.build_query(page: 42)
-      expect(query).to eq('page=42')
-    end
-
-    it 'converts integers in object lists to decimal strings' do
-      queries = [
-        'primes[0][value]=2&primes[1][value]=3',
-        'primes[1][value]=3&primes[0][value]=2'
-      ]
-      query = subject_module.build_query(
-        primes: { 0 => { value: 2 }, 1 => { value: 3 } })
-      expect(queries).to include(query)
-    end
-
-    it 'converts the logical true to the string true' do
-      query = subject_module.build_query(badge: true)
-      expect(query).to eq('badge=true')
-    end
-
-    it 'converts the logical false to the string false' do
-      query = subject_module.build_query(badge: false)
-      expect(query).to eq('badge=false')
-    end
-  end
 end