typekit-client 0.0.5 → 0.0.6

data/lib/typekit/record/kit.rb

@@ -1,7 +1,35 @@
 module Typekit
   module Record
-    class Kit < Base
+    class Kit < Element::Base
+      include Element::Association
+      include Element::Persistence
+      include Element::Query
+      include Element::Serialization
+
       has_many :families
+
+      def complete?
+        !persistent? || attribute?(:families)
+      end
+
+      def load!
+        become(process(:show, id))
+        true
+      end
+
+      def publish!
+        process(:update, id, :publish)
+      end
+
+      [:load, :publish].each do |method|
+        class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{method}(*arguments)
+            #{method}!(*arguments)
+          rescue ServerError
+            false
+          end
+        CODE
+      end
     end
   end
 end

data/lib/typekit/record/library.rb

@@ -1,6 +1,9 @@
 module Typekit
   module Record
-    class Library < Base
+    class Library < Element::Base
+      include Element::Association
+      include Element::Query
+
       has_many :families
     end
   end

data/lib/typekit/record/variation.rb

@@ -1,8 +1,20 @@
 module Typekit
   module Record
-    class Variation < Base
+    class Variation < Element::Base
+      include Element::Association
+      include Element::Serialization
+
       has_many :libraries
       belongs_to :family
+
+      def initialize(*arguments)
+        arguments[-1] = { id: arguments[-1] } if arguments[-1].is_a?(String)
+        super(*arguments)
+      end
+
+      def serialize
+        id.to_s.split(':').last
+      end
     end
   end
 end

data/lib/typekit/version.rb

@@ -1,3 +1,3 @@
 module Typekit
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/feature/create_kit_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Creating a new kit' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  context 'Successful' do
+    options = { vcr: { cassette_name: 'create_kits_ok' } }
+
+    scenario 'Using #save', options do
+      kit = client::Kit.new(name: 'Megakit', domains: 'localhost')
+      kit.save
+
+      expect(kit).to be_persistent
+      expect(kit.name).to eq('Megakit')
+    end
+
+    scenario 'Using #create', options do
+      kit = client::Kit.create(name: 'Megakit', domains: 'localhost')
+
+      expect(kit).to be_persistent
+      expect(kit.name).to eq('Megakit')
+    end
+  end
+
+  context 'Failure' do
+    options = { vcr: { cassette_name: 'create_kits_bad' } }
+
+    scenario 'Using #save', options do
+      kit = client::Kit.new(name: 'Megakit')
+
+      expect(kit.save).to be false
+      expect(kit).not_to be_persistent
+    end
+
+    scenario 'Using #save!', options do
+      kit = client::Kit.new(name: 'Megakit')
+
+      expect { kit.save! }.to raise_error(Typekit::ServerError)
+
+      expect(kit).to be_new
+      expect(kit).not_to be_persistent
+    end
+
+    scenario 'Using #create', options do
+      kit = client::Kit.create(name: 'Megakit')
+
+      expect(kit).to be_new
+      expect(kit).not_to be_persistent
+    end
+  end
+end

data/spec/feature/delete_kit_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Deleting a kit' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  shared_scenarios 'Adequate behavior' do
+    options = { vcr: { cassette_name: 'delete_kits_xxx_ok' } }
+
+    scenario 'Success', options do
+      expect(result).to be true
+    end
+
+    options = { vcr: { cassette_name: 'delete_kits_xxx_not_found' } }
+
+    scenario 'Failure', options do
+      expect { result }.to raise_error(Typekit::ServerError, /Not found/i)
+    end
+  end
+
+  context 'Using Client' do
+    given(:result) { client.delete(:kits, 'xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+
+  context 'Using Record' do
+    given(:kit) { client::Kit.new(id: 'xxx') }
+    given(:result) { kit.delete! }
+
+    include_scenarios 'Adequate behavior'
+  end
+end

data/spec/feature/index_kits_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Listing kits' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  shared_scenarios 'Adequate behavior' do
+    options = { vcr: { cassette_name: 'index_kits_show_kit_xxx_ok' } }
+
+    scenario 'Success', options do
+      kits = client::Kit.all
+
+      expect(kits).to be_kind_of(Typekit::Collection::Base)
+      expect(kits).not_to be_empty
+
+      kits.each do |kit|
+        expect(kit).to be_kind_of(Typekit::Record::Kit)
+
+        expect(kit).to be_persistent
+        expect(kit).not_to be_new
+        expect(kit).not_to be_complete
+
+        expect(kit.attributes.keys).to contain_exactly(:id, :link)
+      end
+
+      kit = kits.first
+
+      expect(kit.load!).to be true
+
+      expect(kit).to be_persistent
+      expect(kit).not_to be_new
+      expect(kit).to be_complete
+
+      expect(kit.families).to be_kind_of(Typekit::Collection::Base)
+    end
+
+    options = { vcr: { cassette_name: 'index_kits_unauthorized' } }
+
+    scenario 'Failure', options do
+      expect { kits }.to raise_error(Typekit::ServerError, /Not authorized/i)
+    end
+  end
+
+  context 'Using Client' do
+    given(:kits) { client.index(:kits) }
+
+    include_scenarios 'Adequate behavior'
+  end
+
+  context 'Using Record' do
+    given(:kits) { client::Kit.all }
+
+    include_scenarios 'Adequate behavior'
+  end
+end

data/spec/feature/publish_kit_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Publishing a kit' do
+  given(:client) { Typekit::Client.new(token: token) }
+  given(:kit) { client::Kit.new(:kits, id: 'xxx') }
+
+  options = { vcr: { cassette_name: 'update_kits_xxx_publish_ok' } }
+
+  scenario 'Success', options do
+    date = kit.publish!
+
+    expect(date).to be_kind_of(DateTime)
+  end
+end

data/spec/feature/show_family_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Reading a family' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  shared_scenarios 'Adequate behavior' do
+    options = { vcr: { cassette_name: 'show_families_xxx_ok' } }
+
+    scenario 'Success using the id parameter', options do
+      expect(family).to be_kind_of(Typekit::Record::Family)
+
+      variations = family.variations
+      expect(variations).to be_kind_of(Typekit::Collection::Base)
+
+      variations.each do |variation|
+        expect(variation).to be_kind_of(Typekit::Record::Variation)
+      end
+
+      libraries = family.libraries
+      expect(libraries).to be_kind_of(Typekit::Collection::Base)
+
+      libraries.each do |library|
+        expect(library).to be_kind_of(Typekit::Record::Library)
+      end
+    end
+
+    options = { vcr: { cassette_name: 'show_families_xxx_found' } }
+
+    scenario 'Success using the slug parameter', options do
+      expect(family).to be_kind_of(Typekit::Record::Family)
+    end
+  end
+
+  context 'Searching directly using Client' do
+    given(:family) { client.show(:families, 'xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+
+  context 'Searching directly using Record' do
+    given(:family) { client::Family.find('xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+
+  context 'Searching in a Kit using Client' do
+    given(:family) { client.show(:kits, 'xxx', :families, 'yyy') }
+
+    options = { vcr: { cassette_name:
+      'show_kits_xxx_families_yyy_show_family_yyy_ok' } }
+
+    scenario 'Success', options do
+      expect(family).to be_kind_of(Typekit::Record::Family)
+
+      variations = family.variations
+      expect(variations).to be_kind_of(Typekit::Collection::Base)
+
+      variations.each do |variation|
+        expect(variation).to be_kind_of(Typekit::Record::Variation)
+      end
+
+      expect(family).not_to be_complete
+
+      libraries = family.libraries
+      expect(variations).to be_kind_of(Typekit::Collection::Base)
+
+      expect(family).to be_complete
+
+      libraries.each do |library|
+        expect(library).to be_kind_of(Typekit::Record::Library)
+      end
+    end
+  end
+end

data/spec/feature/show_kit_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Reading a kit' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  shared_scenarios 'Adequate behavior' do
+    options = { vcr: { cassette_name: 'show_kits_xxx_show_family_yyy_ok' } }
+
+    scenario 'Success', options do
+      expect(kit).to be_kind_of(Typekit::Record::Kit)
+      expect(kit).to be_complete
+
+      families = kit.families
+
+      expect(families).to be_kind_of(Typekit::Collection::Base)
+      expect(families).not_to be_empty
+
+      families.each do |family|
+        expect(family).to be_kind_of(Typekit::Record::Family)
+        expect(family).not_to be_complete
+      end
+
+      family = families.first
+      expect(family.load!).to be true
+      expect(family).to be_complete
+
+      variations = family.variations
+
+      expect(variations).to be_kind_of(Typekit::Collection::Base)
+      expect(variations).not_to be_empty
+
+      variations.each do |variation|
+        expect(variation).to be_kind_of(Typekit::Record::Variation)
+      end
+    end
+
+    options = { vcr: { cassette_name: 'show_kits_xxx_not_found' } }
+
+    scenario 'Failure', options do
+      expect { kit }.to raise_error(Typekit::ServerError, /Not found/i)
+    end
+  end
+
+  context 'Using Client' do
+    given(:kit) { client.show(:kits, 'xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+
+  context 'Using Record' do
+    given(:kit) { client::Kit.find!('xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+end

data/spec/feature/show_library_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Reading a library' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  shared_scenarios 'Adequate behavior' do
+    options = { vcr: { cassette_name: 'show_libraries_xxx_ok' } }
+
+    scenario 'Success', options do
+      expect(library).to be_kind_of(Typekit::Record::Library)
+
+      expect(library.families.map(&:class).uniq).to \
+        contain_exactly(Typekit::Record::Family)
+    end
+  end
+
+  context 'Using Client' do
+    given(:library) { client.show(:libraries, 'xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+
+  context 'Using Record' do
+    given(:library) { client::Library.find('xxx') }
+
+    include_scenarios 'Adequate behavior'
+  end
+end

data/spec/feature/show_variation_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Reading a variation' do
+  given(:client) { Typekit::Client.new(token: token) }
+  given(:variation) { client.show(:families, 'xxx', 'yyy') }
+
+  options = { vcr: { cassette_name: 'show_families_xxx_yyy_ok' } }
+
+  scenario 'Success', options do
+    expect(variation).to be_kind_of(Typekit::Record::Variation)
+
+    expect(variation.libraries.map(&:class).uniq).to \
+      contain_exactly(Typekit::Record::Library)
+
+    expect(variation.family).to be_kind_of(Typekit::Record::Family)
+  end
+end

data/spec/feature/update_kit_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'rspec/bdd'
+
+RSpec.feature 'Updating a kit' do
+  given(:client) { Typekit::Client.new(token: token) }
+
+  given(:kit) do
+    client::Kit.new(:kits, id: 'xxx', name: 'Megakit',
+      analytics: false, badge: true, domains: ['localhost'],
+      families: [{ id: 'vqgt', subset: 'all', variations: ['n4'] }])
+  end
+
+  options = { vcr: { cassette_name: 'update_kits_xxx_name_ok' } }
+
+  scenario 'Changing the name attribute via #save', options do
+    kit.name = 'Ultrakit'
+    kit.save!
+
+    expect(kit.name).to eq('Ultrakit')
+  end
+
+  scenario 'Changing the name attribute via #update', options do
+    kit.update!(name: 'Ultrakit')
+
+    expect(kit.name).to eq('Ultrakit')
+  end
+
+  options = { vcr: { cassette_name: 'update_kits_xxx_families_ok' } }
+
+  scenario 'Adding a new family', options do
+    kit.families << Typekit::Record::Family.new(id: 'gkmg')
+    kit.save!
+
+    expect(kit.families.length).to be 2
+    expect(kit.families.map(&:id)).to contain_exactly('gkmg', 'vqgt')
+  end
+
+  options = { vcr: {
+    cassette_name: 'show_families_yyy_update_kits_xxx_families_ok' } }
+
+  scenario 'Adding a family fetched earlier', options do
+    family = client::Family.find('gkmg')
+
+    expect(family).to be_complete
+    expect(family.libraries).not_to be_empty
+    expect(family.variations).not_to be_empty
+
+    kit.families << family
+    kit.save!
+
+    expect(kit.families.length).to be 2
+    expect(kit.families.map(&:id)).to contain_exactly('gkmg', 'vqgt')
+  end
+
+  options = { vcr: {
+    cassette_name: 'update_kits_xxx_families_variations_ok' } }
+
+  scenario 'Adding a new family with variations', options do
+    family = Typekit::Record::Family.new(id: 'gkmg')
+
+    expect { family.variations }.to raise_error(/Client is not specified/i)
+    family.variations = [Typekit::Record::Variation.new(id: 'n4')]
+
+    expect(kit.families).not_to be nil
+
+    kit.families << family
+    kit.save!
+
+    expect(kit.families.length).to be 2
+    expect(kit.families.map(&:id)).to contain_exactly('gkmg', 'vqgt')
+
+    i = kit.families[0].id == 'gkmg' ? 0 : 1
+    expect(kit.families[i].variations.map(&:id)).to eq(['n4'])
+  end
+
+  options = { vcr: {
+    cassette_name: 'update_kits_xxx_empty_families_ok' } }
+
+  scenario 'Deleting all families', options do
+    expect(kit.families.length).to be 1
+
+    family = kit.families.first
+    kit.families.delete(family)
+    kit.save!
+
+    expect(kit.families).to be_empty
+  end
+end