typekit-client 0.0.2

data/lib/typekit/routing/node.rb

@@ -0,0 +1,5 @@
+require_relative 'node/base'
+require_relative 'node/root'
+require_relative 'node/scope'
+require_relative 'node/collection'
+require_relative 'node/operation'

data/lib/typekit/routing/node/base.rb

@@ -0,0 +1,45 @@
+module Typekit
+  module Routing
+    module Node
+      class Base
+        def append(child)
+          children << child
+        end
+
+        def assemble(request, path)
+          process(request, path)
+          return authorize(request) if path.empty?
+          lookup!(path.first).assemble(request, path)
+        end
+
+        def match(name)
+        end
+
+        def process(request, path)
+        end
+
+        def permitted?(request)
+        end
+
+        protected
+
+        def children
+          @children ||= []
+        end
+
+        def lookup(name)
+          children.find { |c| c.match(name) }
+        end
+
+        def lookup!(name)
+          lookup(name) or raise Error, 'Not found'
+        end
+
+        def authorize(request)
+          raise Error, 'Not permitted' unless permitted?(request)
+          request
+        end
+      end
+    end
+  end
+end

data/lib/typekit/routing/node/collection.rb

@@ -0,0 +1,34 @@
+module Typekit
+  module Routing
+    module Node
+      class Collection < Base
+        def initialize(name, only: nil)
+          @name = name
+          @actions = only && Array(only) || Typekit.actions
+          unless (@actions - Typekit.actions).empty?
+            raise Error, 'Not supported'
+          end
+        end
+
+        def match(name)
+          @name == name
+        end
+
+        def process(request, path)
+          request << path.shift # @name
+          return request if path.empty?
+          request << path.shift # id
+        end
+
+        def permitted?(request)
+          return false unless @actions.include?(request.action)
+
+          id_present = request.path.last != @name
+          member_action = Helper.member_action?(request.action)
+
+          id_present == member_action
+        end
+      end
+    end
+  end
+end

data/lib/typekit/routing/node/operation.rb

@@ -0,0 +1,32 @@
+module Typekit
+  module Routing
+    module Node
+      class Operation < Base
+        def initialize(name, action:, on:, **options)
+          # TODO: how about on == :collection?
+          unless Typekit.actions.include?(action) && on == :member
+            raise Error, 'Not supported'
+          end
+          @name = name
+          @action = action
+        end
+
+        def match(name)
+          if @name.is_a?(String) && @name =~ /^:/
+            true
+          else
+            @name == name
+          end
+        end
+
+        def process(request, path)
+          request << path.shift # @name
+        end
+
+        def permitted?(request)
+          @action == request.action
+        end
+      end
+    end
+  end
+end

data/lib/typekit/routing/node/root.rb

@@ -0,0 +1,8 @@
+module Typekit
+  module Routing
+    module Node
+      class Root < Base
+      end
+    end
+  end
+end

data/lib/typekit/routing/node/scope.rb

@@ -0,0 +1,19 @@
+module Typekit
+  module Routing
+    module Node
+      class Scope < Base
+        def initialize(path)
+          @path = Array(path)
+        end
+
+        def match(name)
+          !lookup(name).nil?
+        end
+
+        def process(request, path)
+          @path.each { |chunk| request << chunk }
+        end
+      end
+    end
+  end
+end

data/lib/typekit/routing/proxy.rb

@@ -0,0 +1,17 @@
+module Typekit
+  module Routing
+    class Proxy
+      def initialize(owner, **options)
+        @owner = owner
+        @options = options
+      end
+
+      def method_missing(name, *arguments, **options, &block)
+        name = :"define_#{ name }"
+        return super unless @owner.respond_to?(name)
+        # NOTE: https://bugs.ruby-lang.org/issues/9776
+        @owner.send(name, *arguments, **options, **@options, &block)
+      end
+    end
+  end
+end

data/lib/typekit/version.rb

@@ -0,0 +1,3 @@
+module Typekit
+  VERSION = '0.0.2'
+end

data/spec/cassettes/index_kits_ok.yml

@@ -0,0 +1,16 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://typekit.com/api/v1/json/kits
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Status:
+      - 200 OK
+    body:
+      encoding: UTF-8
+      string: '{"kits":[{"id":"bas4cfe","link":"/api/v1/json/kits/bas4cfe"},{"id":"sfh6bkj","link":"/api/v1/json/kits/sfh6bkj"},{"id":"kof8zcn","link":"/api/v1/json/kits/kof8zcn"},{"id":"muq6mxx","link":"/api/v1/json/kits/muq6mxx"}]}'
+  recorded_at: Fri, 23 May 2014 00:00:00 GMT

data/spec/cassettes/index_kits_unauthorized.yml

@@ -0,0 +1,16 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://typekit.com/api/v1/json/kits
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Status:
+      - 401 Unauthorized
+    body:
+      encoding: UTF-8
+      string: '{"errors":["Not authorized"]}'
+  recorded_at: Fri, 23 May 2014 00:00:00 GMT

data/spec/cassettes/show_families_calluna_found.yml

@@ -0,0 +1,16 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://typekit.com/api/v1/json/families/calluna
+  response:
+    status:
+      code: 302
+      message: Found
+    headers:
+      Status:
+      - 302 Found
+    body:
+      encoding: UTF-8
+      string: '{"family":{"id":"vybr","link":"/api/v1/json/families/vybr"}}'
+  recorded_at: Tue, 27 May 2014 00:00:00 GMT

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require_relative 'support/rest_helper'
+require 'webmock/rspec'
+require 'vcr'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/cassettes'
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+  config.default_cassette_options = {
+    allow_unused_http_interactions: false
+  }
+  config.allow_http_connections_when_no_cassette = false
+end

data/spec/support/rest_helper.rb

@@ -0,0 +1,22 @@
+module RESTHelper
+  def restful_actions
+    # TODO: keep in sync with Typekit.actions?
+    [ :index, :show, :create, :update, :delete ]
+  end
+
+  def restful_collection_actions
+    # TODO: keep in sync with Typekit.collection_actions?
+    [ :index, :create ]
+  end
+
+  def restful_member_actions
+    # TODO: keep in sync with Typekit.member_actions?
+    [ :show, :update, :delete ]
+  end
+
+  def rest_http_dictionary
+    # TODO: keep in sync with Typekit.action_dictionary?
+    { :index => :get, :show => :get, :create => :post,
+      :update => :post, :delete => :delete }
+  end
+end

data/spec/typekit/client_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Client do
+  let(:token) { 'arbitrary' }
+  let(:subject) { Typekit::Client.new(token: token) }
+
+  describe '#index' do
+    context 'when successful' do
+      options = { vcr: { cassette_name: 'index_kits_ok' } }
+
+      it 'returns hashes', options do
+        result = subject.index(:kits)
+        expect(result).to be_kind_of(Hash)
+      end
+    end
+
+    context 'when unauthorized' do
+      options = { vcr: { cassette_name: 'index_kits_unauthorized' } }
+
+      it 'raises exceptions', options do
+        expect { subject.index(:kits) }.to \
+          raise_error(Typekit::Error, /(authentication|authorized)/i)
+      end
+    end
+
+    context 'when found' 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
+      end
+    end
+  end
+end

data/spec/typekit/configuration_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Configuration do
+  let(:subject_module) { Typekit::Configuration }
+
+  def build(name, **options)
+    subject_module.build(name, **options)
+  end
+
+  describe '.build' do
+    it 'requies an API token to be given' do
+      expect { build(:default) }.to \
+        raise_error(subject_module::Error, /Not enough arguments/i)
+    end
+
+    it 'returns registeries of settings' do
+      expect(build(:default, token: 'nekot')).to \
+        be_kind_of(subject_module::Base)
+    end
+
+    it 'raises exceptions when encouters unknown registeries' do
+      expect { build(:awesome, token: 'nekot') }.to \
+        raise_error(subject_module::Error, /Unknown configuration/i)
+    end
+  end
+
+  describe 'Base#map' do
+    it 'returns a Map' do
+      expect(build(:default, token: 'nekot').map).to \
+        be_kind_of(Typekit::Routing::Map)
+    end
+  end
+end

data/spec/typekit/connection/adaptor_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Connection::Adaptor do
+  let(:address) { 'https://typekit.com/api/v1/json/kits' }
+
+  [ 'Standard' ].each do |adaptor|
+    subject { Typekit::Connection::Adaptor.const_get(adaptor).new }
+
+    describe "#{ adaptor }.process" do
+      it 'returns the code, headers, and body of the response' do
+        stub_http_request(:get, address).to_return(
+          code: '200', body: 'Hej!', headers: { 'a' => 'b' } )
+        response = subject.process(:get, address)
+        expect(response).to eq([ '200', { 'a' => [ 'b' ] }, 'Hej!' ])
+      end
+
+      it 'raises exceptions when encounters unknown methods' do
+        expect { subject.process(:smile, address) }.to \
+          raise_error(Typekit::Connection::Error, /Invalid method/i)
+      end
+    end
+  end
+end

data/spec/typekit/connection/dispatcher_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Connection::Dispatcher do
+  extend RESTHelper
+
+  let(:token) { 'arbitrary' }
+  let(:address) { 'https://typekit.com/api/v1/json/kits' }
+  let(:subject) { Typekit::Connection::Dispatcher.new(token: token) }
+
+  def create_request(action)
+    double('Request', action: action, address: address, parameters: {})
+  end
+
+  describe '#deliver' do
+    restful_actions.each do |action|
+      method = rest_http_dictionary[action]
+
+      context "when sending #{ action } Requests" do
+        it 'sets the token header' do
+          stub = stub_http_request(method, address)
+          response = subject.deliver(create_request(action))
+          expect(stub).to have_requested(method, address).
+            with(:headers => { 'X-Typekit-Token' => token })
+        end
+
+        it 'returns Responses' do
+          stub_http_request(method, address).
+            to_return(code: '200', body: 'Hej!')
+          response = subject.deliver(create_request(action))
+          expect([ response.code, response.content ]).to eq([ 200, 'Hej!' ])
+        end
+      end
+    end
+  end
+end

data/spec/typekit/connection/request_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Connection::Request do
+  subject { Typekit::Connection::Request.new(action: :show) }
+
+  describe '#address' do
+    it 'assembles the address' do
+      [ :kits, 'xxx', :families, 'yyy' ].each { |chunk| subject << chunk }
+      expect(subject.address).to eq('kits/xxx/families/yyy')
+    end
+  end
+end

data/spec/typekit/helper_spec.rb

@@ -0,0 +1,93 @@
+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 '.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