typekit-client 0.0.2 → 0.0.3

data/spec/typekit/record/base_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Record::Base do
+  let(:subject_class) { Typekit::Record::Base }
+
+  describe '#new' do
+    it 'treats each option as an attribute to keep track of' do
+      subject = subject_class.new(name: 'Awesome')
+      expect { subject.name = 'Superb' }.to \
+        change { subject.name }.from('Awesome').to('Superb')
+    end
+
+    it 'handles attribute names given as strings' do
+      subject = subject_class.new('name' => 'Awesome')
+      expect { subject.name = 'Superb' }.to \
+        change { subject.name }.from('Awesome').to('Superb')
+    end
+  end
+
+  describe '#attributes' do
+    it 'returns all attributes' do
+      subject = subject_class.new(id: 1, name: 'Awesome')
+      expect(subject.attributes).to eq(id: 1, name: 'Awesome')
+    end
+
+    it 'reflects attribute assignments' do
+      subject = subject_class.new(id: 1)
+      subject.id = 42
+      expect(subject.attributes).to eq(id: 42)
+    end
+  end
+end

data/spec/typekit/record_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Record do
+  let(:subject_module) { Typekit::Record }
+
+  describe '.collections' do
+    it 'knows the major collections' do
+      expect(subject_module.collections).to \
+        match_array(%i{families kits libraries variations})
+    end
+  end
+
+  describe '.members' do
+    it 'knows the major members' do
+      expect(subject_module.members).to \
+        match_array(%i{family kit library variation})
+    end
+  end
+
+  describe '.collection?' do
+    %w{family kit library variation kitten kittens}.each do |name|
+      it "returns false for #{ name }" do
+        expect(subject_module.collection?(name)).to be_false
+      end
+    end
+
+    %w{families kits libraries variations}.each do |name|
+      it "returns true for #{ name }" do
+        expect(subject_module.collection?(name)).to be_true
+      end
+    end
+  end
+
+  describe '.member?' do
+    %w{family kit library variation}.each do |name|
+      it "returns true for #{ name }" do
+        expect(subject_module.member?(name)).to be_true
+      end
+    end
+
+    %w{families kits libraries variations kitten kittens}.each do |name|
+      it "returns false for #{ name }" do
+        expect(subject_module.member?(name)).to be_false
+      end
+    end
+  end
+end

data/spec/typekit/routing/mapper_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+require 'typekit'
+
+describe Typekit::Routing::Mapper do
+  extend RESTHelper
+
+  def create_request(action)
+    # TODO: mock?
+    Typekit::Connection::Request.new(action: action)
+  end
+
+  describe '#define' do
+    it 'declares new resources' do
+      subject.define { resources(:kits) }
+      request = subject.trace(create_request(:index), [ :kits ])
+      expect(request.address).to eq('kits')
+    end
+
+    it 'declares nested resources' do
+      subject.define { resources(:kits) { resources(:families) } }
+      request = subject.trace(create_request(:show),
+        [ :kits, 'xxx', :families, 'yyy' ])
+      expect(request.address).to eq('kits/xxx/families/yyy')
+    end
+
+    it 'declares scoped resources' do
+      subject.define do
+        scope 'https://typekit.com/api' do
+          scope [ 'v1', :json ] do
+            resources(:kits) { resources(:families) }
+          end
+        end
+      end
+      request = subject.trace(create_request(:show),
+        [ :kits, 'xxx', :families, 'yyy' ])
+      expect(request.address).to eq(
+        'https://typekit.com/api/v1/json/kits/xxx/families/yyy')
+    end
+
+    it 'declares custom operations' do
+      subject.define { resources(:kits) { show(:published, on: :member) } }
+      request = subject.trace(create_request(:show),
+        [ :kits, 'xxx', :published ])
+      expect(request.address).to eq('kits/xxx/published')
+    end
+
+    it 'declares custom operations with variable names' do
+      subject.define do
+        resources :kits do
+          resources :families do
+            show ':variant', on: :member
+          end
+        end
+      end
+      request = subject.trace(create_request(:show),
+        [ :kits, 'xxx', :families, 'yyy', 'zzz' ])
+      expect(request.address).to eq('kits/xxx/families/yyy/zzz')
+    end
+  end
+
+  describe '#trace' do
+    shared_examples 'adequate resource tracer' do
+      restful_member_actions.each do |action|
+        it "assembles addresses of #{ action } Requests" do
+          request = subject.trace(create_request(action),
+            [ *subject_path, 'xxx' ])
+          expect(request.address).to eq("#{ subject_address }/xxx")
+        end
+      end
+
+      restful_collection_actions.each do |action|
+        it "assembles addresses of #{ action } Requests" do
+          request = subject.trace(create_request(action), subject_path)
+          expect(request.address).to eq(subject_address)
+        end
+      end
+
+      restful_member_actions.each do |action|
+        it "raises exceptions for #{ action } actions to collections" do
+          expect do
+            subject.trace(create_request(action), subject_path)
+          end.to raise_error(Typekit::Routing::Error, /Not permitted/i)
+        end
+      end
+
+      restful_collection_actions.each do |action|
+        it "raises exceptions for #{ action } actions to members" do
+          expect do
+            subject.trace(create_request(action), [ *subject_path, 'xxx' ])
+          end.to raise_error(Typekit::Routing::Error, /Not permitted/i)
+        end
+      end
+    end
+
+    context 'when working with plain collections' do
+      before(:each) do
+        subject.define { resources(:kits) }
+      end
+
+      let(:subject_path) { [ :kits ] }
+      let(:subject_address) { 'kits' }
+
+      it_behaves_like 'adequate resource tracer'
+    end
+
+    context 'when working with nested collections' do
+      before(:each) do
+        subject.define do
+          resources :kits do
+            resources :families
+          end
+        end
+      end
+
+      let(:subject_path) { [ :kits, 'yyy', :families ] }
+      let(:subject_address) { 'kits/yyy/families' }
+
+      it_behaves_like 'adequate resource tracer'
+    end
+
+    family_actions = [ :show, :update, :delete ]
+
+    context "when only #{ family_actions.join(', ') } are allowed" do
+      before(:each) do
+        subject.define do
+          resources :kits do
+            resources :families, only: family_actions
+          end
+        end
+      end
+
+      (restful_collection_actions - family_actions).each do |action|
+        it "raises expections for #{ action } actions" do
+          expect do
+            subject.trace(create_request(action),
+              [ :kits, 'xxx', :families ])
+          end.to raise_error(Typekit::Routing::Error, /Not permitted/i)
+        end
+      end
+
+      (restful_member_actions - family_actions).each do |action|
+        it "raises expections for #{ action } actions" do
+          expect do
+            subject.trace(create_request(action),
+              [ :kits, 'xxx', :families, 'yyy' ])
+          end.to raise_error(Typekit::Routing::Error, /Not permitted/i)
+        end
+      end
+    end
+
+    restful_actions.each do |action|
+      it "assembles addresses for custom #{ action } actions" do
+        subject.define do
+          resources :kits do
+            send(action, :havefun, on: :member)
+          end
+        end
+        request = subject.trace(create_request(action),
+          [ :kits, 'xxx', :havefun ])
+        expect(request.address).to eq('kits/xxx/havefun')
+      end
+    end
+
+    it 'does not support reopening of resource declarations' do
+      subject.define do
+        resources :kits
+        resources :kits do
+          resources :families
+        end
+      end
+      expect do
+        subject.trace(create_request(:show),
+          [ :kits, 'xxx', :families, 'yyy' ])
+      end.to raise_error(Typekit::Routing::Error, /Not found/i)
+    end
+  end
+end

data/spec/typekit/routing/node_spec.rb

@@ -4,6 +4,11 @@ require 'typekit'
 describe Typekit::Routing::Node do
   extend RESTHelper
 
+  def create_request(action)
+    # TODO: mock?
+    Typekit::Connection::Request.new(action: action)
+  end
+
   let(:subject_module) { Typekit::Routing::Node }
 
   def create_tree(*path)
@@ -19,21 +24,37 @@ describe Typekit::Routing::Node do
   describe 'Base#assemble' do
     let(:root) { create_tree(:kits, :families) }
 
+    shared_examples 'adequate assembler' do
+      let(:request) { create_request(action) }
+
+      it 'builds up Requests' do
+        expect(request).to receive(:<<).
+          exactly(path.size).times.and_call_original
+        root.assemble(request, path)
+      end
+
+      it 'signs Requests' do
+        expect(request).to receive(:sign).
+          with(satisfy { |n| n.match(:families) })
+        root.assemble(request, path)
+      end
+    end
+
     restful_collection_actions.each do |action|
-      it "builds up #{ action } Requests" do
-        request = double('Request', :<< => nil, :action => action,
-          :path => [ :kits, 'xxx', :families ])
-        root.assemble(request, [ :kits, 'xxx', :families ])
-        expect(request).to have_received(:<<).exactly(3).times
+      context "when tracing #{ action } actions" do
+        let(:action) { action }
+        let(:path) { [ :kits, 'xxx', :families ] }
+
+        it_behaves_like 'adequate assembler'
       end
     end
 
     restful_member_actions.each do |action|
-      it "builds up #{ action } Requests" do
-        request = double('Request', :<< => nil, :action => action,
-          :path => [ :kits, 'xxx', :families, 'yyy' ])
-        root.assemble(request, [ :kits, 'xxx', :families, 'yyy' ])
-        expect(request).to have_received(:<<).exactly(4).times
+      context "when tracing #{ action } actions" do
+        let(:action) { action }
+        let(:path) { [ :kits, 'xxx', :families, 'yyy' ] }
+
+        it_behaves_like 'adequate assembler'
       end
     end
   end

data/typekit-client.gemspec

@@ -26,8 +26,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
   spec.add_development_dependency 'webmock', '~> 1.18'
   spec.add_development_dependency 'vcr', '~> 2.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typekit-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ivan Ukhov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -56,14 +56,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -119,8 +133,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -138,12 +154,26 @@ files:
 - lib/typekit/connection/response.rb
 - lib/typekit/core.rb
 - lib/typekit/helper.rb
-- lib/typekit/parser.rb
-- lib/typekit/parser/json.rb
-- lib/typekit/parser/yaml.rb
-- lib/typekit/processor.rb
+- lib/typekit/processing.rb
+- lib/typekit/processing/converter.rb
+- lib/typekit/processing/converter/boolean.rb
+- lib/typekit/processing/converter/datetime.rb
+- lib/typekit/processing/converter/errors.rb
+- lib/typekit/processing/converter/record.rb
+- lib/typekit/processing/converter/records.rb
+- lib/typekit/processing/converter/unknown.rb
+- lib/typekit/processing/parser.rb
+- lib/typekit/processing/parser/json.rb
+- lib/typekit/processing/parser/yaml.rb
+- lib/typekit/processing/translator.rb
+- lib/typekit/record.rb
+- lib/typekit/record/base.rb
+- lib/typekit/record/family.rb
+- lib/typekit/record/kit.rb
+- lib/typekit/record/library.rb
+- lib/typekit/record/variation.rb
 - lib/typekit/routing.rb
-- lib/typekit/routing/map.rb
+- lib/typekit/routing/mapper.rb
 - lib/typekit/routing/node.rb
 - lib/typekit/routing/node/base.rb
 - lib/typekit/routing/node/collection.rb
@@ -152,6 +182,7 @@ files:
 - lib/typekit/routing/node/scope.rb
 - lib/typekit/routing/proxy.rb
 - lib/typekit/version.rb
+- spec/cassettes/delete_kits_xxx_ok.yml
 - spec/cassettes/index_kits_ok.yml
 - spec/cassettes/index_kits_unauthorized.yml
 - spec/cassettes/show_families_calluna_found.yml
@@ -162,9 +193,13 @@ files:
 - spec/typekit/connection/adaptor_spec.rb
 - spec/typekit/connection/dispatcher_spec.rb
 - spec/typekit/connection/request_spec.rb
+- spec/typekit/connection/response_spec.rb
 - spec/typekit/helper_spec.rb
-- spec/typekit/processor_spec.rb
-- spec/typekit/routing/map_spec.rb
+- spec/typekit/processing/converter_spec.rb
+- spec/typekit/processing/parser_spec.rb
+- spec/typekit/record/base_spec.rb
+- spec/typekit/record_spec.rb
+- spec/typekit/routing/mapper_spec.rb
 - spec/typekit/routing/node_spec.rb
 - typekit-client.gemspec
 homepage: https://github.com/IvanUkhov/typekit-client
@@ -192,6 +227,7 @@ signing_key:
 specification_version: 4
 summary: A Ruby library for accessing the Typekit API
 test_files:
+- spec/cassettes/delete_kits_xxx_ok.yml
 - spec/cassettes/index_kits_ok.yml
 - spec/cassettes/index_kits_unauthorized.yml
 - spec/cassettes/show_families_calluna_found.yml
@@ -202,7 +238,11 @@ test_files:
 - spec/typekit/connection/adaptor_spec.rb
 - spec/typekit/connection/dispatcher_spec.rb
 - spec/typekit/connection/request_spec.rb
+- spec/typekit/connection/response_spec.rb
 - spec/typekit/helper_spec.rb
-- spec/typekit/processor_spec.rb
-- spec/typekit/routing/map_spec.rb
+- spec/typekit/processing/converter_spec.rb
+- spec/typekit/processing/parser_spec.rb
+- spec/typekit/record/base_spec.rb
+- spec/typekit/record_spec.rb
+- spec/typekit/routing/mapper_spec.rb
 - spec/typekit/routing/node_spec.rb

data/lib/typekit/parser/json.rb

@@ -1,13 +0,0 @@
-require 'json'
-
-module Typekit
-  module Parser
-    class JSON
-      def process(data)
-        ::JSON.parse(data)
-      rescue
-        raise Error, 'Unable to parse'
-      end
-    end
-  end
-end

data/lib/typekit/parser/yaml.rb

@@ -1,13 +0,0 @@
-require 'yaml'
-
-module Typekit
-  module Parser
-    class YAML
-      def process(data)
-        ::YAML.load(data)
-      rescue
-        raise Error, 'Unable to parse'
-      end
-    end
-  end
-end

data/lib/typekit/parser.rb

@@ -1,14 +0,0 @@
-require_relative 'parser/json'
-require_relative 'parser/yaml'
-
-module Typekit
-  module Parser
-    Error = Class.new(Typekit::Error)
-
-    def self.build(format)
-      self.const_get(format.to_s.upcase).new
-    rescue NameError
-      raise Error, 'Unknown format'
-    end
-  end
-end

data/lib/typekit/processor.rb

@@ -1,38 +0,0 @@
-module Typekit
-  class Processor
-    ERRORS = {
-      400 => 'There are errors in the data provided by your application',
-      401 => 'Authentication is needed to access the requested endpoint',
-      403 => 'Your application has been rate limited',
-      404 => 'You are requesting a resource that does not exist',
-      500 => 'Typekit’s servers are unable to process the request',
-      503 => 'Typekit’s API is offline for maintenance'
-    }.freeze
-
-    def initialize(format:)
-      @parser = Parser.build(format)
-    end
-
-    def process(response)
-      if response.success?
-        data = @parser.process(response.content)
-        process_success(response, data)
-      else
-        data = @parser.process(response.content) rescue {}
-        process_failure(response, data)
-      end
-    end
-
-    private
-
-    def process_success(request, data)
-      data
-    end
-
-    def process_failure(request, data)
-      return data if request.redirect?
-      message = data['errors'] || ERRORS[request.code] || 'Unknown server error'
-      raise Error, Array(message).join(', ')
-    end
-  end
-end

data/spec/typekit/processor_spec.rb

@@ -1,34 +0,0 @@
-require 'spec_helper'
-require 'typekit'
-
-describe Typekit::Processor do
-  def create(format)
-    Typekit::Processor.new(format: format)
-  end
-
-  it 'supports JSON' do
-    parser = create(:json)
-    response = double(success?: true, content: '{ "a": 1 }')
-    result = parser.process(response)
-    expect(result).to eq("a" => 1)
-  end
-
-  it 'supports YAML' do
-    parser = create(:yaml)
-    response = double(success?: true, content: "---\na: 1")
-    result = parser.process(response)
-    expect(result).to eq("a" => 1)
-  end
-
-  it 'does not support XML' do
-    expect { create(:xml) }.to raise_error
-  end
-
-  it 'raises an appropriate exception when a request fails' do
-    parser = create(:json)
-    response = double(success?: false, redirect?: false, code: 401,
-      content: '{ "errors": [ "Not authorized" ] }')
-    expect { parser.process(response) }.to \
-      raise_error(Typekit::Error, 'Not authorized')
-  end
-end