transcriber 0.0.1 → 0.0.2

data/spec/{resource → unit}/parser_spec.rb

@@ -1,28 +1,23 @@
 require 'spec_helper'
 
-describe Transcriber::Resource::Parser do
-  class Example < Transcriber::Resource
-  end
-
-  before { Example.keys.clear }
-
+describe Resource::Parser do
   describe '.parse' do
     it 'parses simple properties' do
-      class Example < Transcriber::Resource
+      class Example < Resource
         property :login
       end
 
-      models = Example.parse({'LOGIN' => 'jackiechan2010'})
+      models = Example.parse({'login' => 'jackiechan2010'})
       models.should be_an(Array)
       models.first.login.should == 'jackiechan2010'
     end
 
     it 'uses different field name if defined' do
-      class Example < Transcriber::Resource
+      class Example < Resource
         property :login, field: :customer_login
       end
 
-      models = Example.parse({'CUSTOMER_LOGIN' => 'jackiechan2010'})
+      models = Example.parse({'customer_login' => 'jackiechan2010'})
       models.should be_an(Array)
       models.first.login.should == 'jackiechan2010'
     end
@@ -30,40 +25,40 @@ describe Transcriber::Resource::Parser do
     context "uses type defined" do
       context 'boolean' do
         before do
-          class Example < Transcriber::Resource
+          class Example < Resource
             property :can_merge, type: Boolean
           end
         end
 
         it "returns true when value is 'X'" do
-          models = Example.parse({'CAN_MERGE' => 'X'})
+          models = Example.parse({'can_merge' => 'X'})
           models.first.can_merge.should be_true
         end
 
         it "returns false when value isn't 'X'" do
-          models = Example.parse({'CAN_MERGE' => ''})
+          models = Example.parse({'can_merge' => ''})
           models.first.can_merge.should be_false
         end
       end
 
       context "date" do
         it "parse" do
-          class Example < Transcriber::Resource
+          class Example < Resource
             property :issue_date, type: Date
           end
 
-          models = Example.parse({'ISSUE_DATE' => '2011-01-01'})
+          models = Example.parse({'issue_date' => '2011-01-01'})
           models.first.issue_date.should == Date.parse('2011-01-01')
         end
       end
 
       context "float" do
         it "parse" do
-          class Example < Transcriber::Resource
+          class Example < Resource
             property :amount, type: Float
           end
 
-          models = Example.parse({'AMOUNT' => '1234.5'})
+          models = Example.parse({'amount' => '1234.5'})
           models.first.amount.should == 1234.5
         end
       end
@@ -71,20 +66,20 @@ describe Transcriber::Resource::Parser do
 
     context "maps values if defined" do
       before do
-        class Example < Transcriber::Resource
+        class Example < Resource
           property :status, values: {paid: '01', unpaid: '02'}
         end
       end
 
       it "returns key when value was mapped" do
-        models = Example.parse({'STATUS' => '02'})
+        models = Example.parse({'status' => '02'})
         models.first.status.should == :unpaid
       end
 
       it "returns nil when value wasn't mapped" do
-        models = Example.parse({'STATUS' => '03'})
+        models = Example.parse({'status' => '03'})
         models.first.status.should be_nil
       end
     end
   end
-end
+end

data/spec/unit/resource/builder/embeddables_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'unit/resource/builder/shared_example_for_association'
+
+describe Resource::Builder::Embeddables do
+  before do
+    class Example < Transcriber::Resource
+      embeds_one  :contract,      some_option: 'contract options'
+      embeds_many :invoice_items, some_option: 'invoice options'
+    end
+  end
+
+  describe ".embeds_one" do
+    let(:field)   {:contract}
+    let(:many)    {false}
+    let(:options) {{some_option: 'contract options', many: many}}
+
+    it_behaves_like "an association"
+  end
+
+  describe ".embeds_many" do
+    let(:field)   {:invoice_items}
+    let(:many)    {true}
+    let(:options) {{some_option: 'invoice options', many: many}}
+
+    it_behaves_like "an association"
+  end
+end

data/spec/unit/resource/builder/properties_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe Resource::Builder::Properties do
+  shared_examples_for "a property" do
+    it "defines an attr_accessor with property name" do
+      Example.new.tap do |example|
+        example.respond_to?("#{field}").should be_true
+        example.respond_to?("#{field}=").should be_true
+      end
+    end
+
+    it "puts a new property in keys list" do
+      Example.keys.find {|key| key.name == field}.name.should == field
+    end
+
+    it "supports option definition" do
+      Example.keys.find {|key| key.name == field}.options.should == options
+    end
+  end
+
+  shared_examples_for "a key" do
+    it "is referenced as the resource id" do
+      Example.id_key.name.should == field
+    end
+  end
+
+  describe ".id" do
+    context "when it's just 'id'" do
+      before do
+        class Example < Transcriber::Resource
+          id
+        end
+      end
+
+      let(:field)   {:id}
+      let(:options) {{id: true}}
+
+      it_behaves_like "a property"
+      it_behaves_like "a key"
+    end
+
+    context "when it has a different name" do
+      before do
+        class Example < Transcriber::Resource
+          id :different_name
+        end
+      end
+
+      let(:field)   {:different_name}
+      let(:options) {{id: true}}
+
+      it_behaves_like "a property"
+      it_behaves_like "a key"
+    end
+
+    context "when it has options" do
+      before do
+        class Example < Transcriber::Resource
+          id some_option: 'some option value'
+        end
+      end
+
+      let(:field)   {:id}
+      let(:options) {{some_option: 'some option value', id: true}}
+
+      it_behaves_like "a property"
+      it_behaves_like "a key"
+    end
+
+    context "when it has both different name and options" do
+      before do
+        class Example < Transcriber::Resource
+          id :different_name, some_option: 'some option value'
+        end
+      end
+
+      let(:field)   {:different_name}
+      let(:options) {{some_option: 'some option value', id: true}}
+
+      it_behaves_like "a property"
+      it_behaves_like "a key"
+    end
+
+    context "when it defines somehow the option id: false" do
+      before do
+        class Example < Transcriber::Resource
+          id id: false
+        end
+      end
+
+      let(:field)   {:id}
+      let(:options) {{id: true}}
+
+      it_behaves_like "a property"
+      it_behaves_like "a key"
+    end
+  end
+
+  describe ".property" do
+    context "when it is a normal property" do
+      before do
+        class Example < Transcriber::Resource
+          property :document_number, some_option: 'this is an option'
+        end
+      end
+
+      let(:field)   {:document_number}
+      let(:options) {{some_option: 'this is an option'}}
+
+      it_behaves_like "a property"
+    end
+
+    context "when it has the option :id set to true" do
+      before do
+        class Example < Transcriber::Resource
+          property :document_number, id: true
+        end
+      end
+
+      let(:field)   {:document_number}
+      let(:options) {{id: true}}
+
+      it_behaves_like "a property"
+      it_behaves_like "a key"
+    end
+  end
+
+  describe ".properties" do
+    before do
+      class Example < Transcriber::Resource
+        properties :id, :description
+        properties :price, :quantity, firstoption: 'this is the first option', secondoption: 'this is the second option'
+      end
+    end
+
+    [:id, :description].each do |item|
+      context "for #{item}" do
+        let(:field)   {item}
+        let(:options) {{}}
+
+        it_behaves_like "a property"
+      end
+    end
+
+    [:price, :quantity].each do |item|
+      context "for #{item}" do
+        let(:field)   {item}
+        let(:options) {{firstoption: 'this is the first option', secondoption: 'this is the second option'}}
+
+        it_behaves_like "a property"
+      end
+    end
+  end
+end

data/spec/unit/resource/builder/relations_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require 'unit/resource/builder/shared_example_for_association'
+
+describe Resource::Builder::Relations do
+  describe ".has_one" do
+    before do
+      class Example < Transcriber::Resource
+        has_one :item, some_option: 'option'
+      end
+    end
+
+    let(:field)   {:item}
+    let(:many)    {false}
+    let(:options) {{some_option: 'option', many: many, has: true}}
+
+    it_behaves_like "an association"
+
+    it "puts a new relation in relation list" do
+      Example.relations.find {|relation| relation.name == field}.name.should == field
+    end
+  end
+
+  describe ".has_many" do
+    before do
+      class Example < Transcriber::Resource
+        has_many :items, some_option: 'option'
+      end
+    end
+
+    let(:field)   {:items}
+    let(:many)    {true}
+    let(:options) {{some_option: 'option', many: many, has: true}}
+
+    it_behaves_like "an association"
+
+    it "puts a new relation in relation list" do
+      Example.relations.find {|relation| relation.name == field}.name.should == field
+    end
+  end
+
+  describe ".belongs_to" do
+    before do
+      class Example < Transcriber::Resource
+        belongs_to :item, some_option: 'option'
+      end
+    end
+
+    let(:field)   {:item}
+    let(:many)    {false}
+    let(:options) {{some_option: 'option', many: many, has: false}}
+
+    it_behaves_like "an association"
+  end
+end

data/spec/unit/resource/builder/shared_example_for_association.rb

@@ -0,0 +1,20 @@
+shared_examples_for "an association" do
+  it "defines an attr_accessor with association name" do
+    Example.new.tap do |example|
+      example.respond_to?("#{field}").should be_true
+      example.respond_to?("#{field}=").should be_true
+    end
+  end
+
+  it "puts a new association in keys list" do
+    Example.keys.find {|key| key.name == field}.name.should == field
+  end
+
+  it "supports option definition" do
+    Example.keys.find {|key| key.name == field}.options.should == options
+  end
+
+  it "many? responds appropriately" do
+    Example.keys.find {|key| key.name == field}.many?.should == many
+  end
+end

data/spec/unit/resource/key/association_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Resource::Association do
+  describe "#initialize" do
+    context "class_name" do
+      context "when class_name option is passed" do
+        subject do
+          Resource::Association.new(:login, class_name: :some_class)
+        end
+
+        it "sets passed class_name" do
+          subject.instance_variable_get("@class_name").should == "SomeClass"
+        end
+      end
+
+      context "when class_name option is not passed" do
+        subject {Resource::Association.new(:login)}
+
+        it "sets default class_name" do
+          subject.instance_variable_get("@class_name").should == "Login"
+        end
+      end
+    end
+
+    context "many" do
+      context "when many option is passed with true" do
+        subject do
+          Resource::Association.new(:login, many: true)
+        end
+
+        it "returns false to one?" do
+          subject.one?.should be_false
+        end
+
+        it "returns true to many?" do
+          subject.many?.should be_true
+        end
+      end
+
+      context "when many option is passed with false" do
+        subject do
+          Resource::Association.new(:login, many: false)
+        end
+
+        it "returns true to one?" do
+          subject.one?.should be_true
+        end
+
+        it "returns false to many?" do
+          subject.many?.should be_false
+        end
+      end
+
+      context "when many option is not passed" do
+        subject do
+          Resource::Association.new(:login)
+        end
+
+        it "returns true to one?" do
+          subject.one?.should be_true
+        end
+
+        it "returns false to many?" do
+          subject.many?.should be_false
+        end
+      end
+    end
+  end
+end

data/spec/unit/resource/key/embeddable_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Resource::Embeddable do
+  it "is a relation" do
+    Resource::Embeddable.superclass.should == Resource::Association
+  end
+end

data/spec/unit/resource/key/property_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Resource::Property do
+  describe "#initialize" do
+    context "serializer" do
+      context "when custom is provided" do
+        subject do
+          options = {type: Resource::Serialization::Boolean}
+          Resource::Property.new(:haz_bool?, options)
+        end
+
+        it "configures custom" do
+          subject.serializer.should == Resource::Serialization::Boolean
+        end
+      end
+
+      context "when it isn't provided" do
+        subject {Resource::Property.new(:login)}
+
+        it "uses String serializer" do
+          subject.serializer.should == Resource::Serialization::String
+        end
+      end
+    end
+
+    context "when values map is provided" do
+      let(:values) {{paid: '01', unpaid: '02'}}
+
+      subject do
+        options = {values: values}
+        Resource::Property.new(:payment_status, options)
+      end
+
+      it "configures values" do
+        subject.translations.should == values.invert
+      end
+    end
+  end
+end

data/spec/unit/resource/key/relation_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Resource::Relation do
+  it "is a relation" do
+    Resource::Relation.superclass.should == Resource::Association
+  end
+
+  describe "#has?" do
+    context "when it has one resource" do
+      subject do
+        Resource::Relation.new(:service, many: false, has: true)
+      end
+
+      it "returns true" do
+        subject.has?.should be_true
+      end
+    end
+
+    context "when it has many resources" do
+      subject do
+        Resource::Relation.new(:service, many: true, has: true)
+      end
+
+      it "returns true" do
+        subject.has?.should be_true
+      end
+    end
+
+    context "when it belongs to a resource" do
+      subject do
+        Resource::Relation.new(:service, many: false, has: false)
+      end
+
+      it "returns true" do
+        subject.has?.should be_false
+      end
+    end
+  end
+
+  describe "#belongs?" do
+    context "when it belongs to a resource" do
+      subject do
+        Resource::Relation.new(:service, many: false, has: false)
+      end
+
+      it "returns true" do
+        subject.belongs?.should be_true
+      end
+    end
+
+    context "when it has one resource" do
+      subject do
+        Resource::Relation.new(:service, many: false, has: true)
+      end
+
+      it "returns true" do
+        subject.belongs?.should be_false
+      end
+    end
+
+    context "when it has many resources" do
+      subject do
+        Resource::Relation.new(:service, many: true, has: true)
+      end
+
+      it "returns true" do
+        subject.belongs?.should be_false
+      end
+    end
+  end
+end

data/spec/unit/resource/parser/embeddable_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Resource::Parser::Embeddable do
+  context "when it embeds one" do
+    before do
+      class ExampleChild < Resource
+        property :id
+      end
+    end
+
+    let(:value) {{"id" => "7000"}}
+
+    subject {Resource::Embeddable.new(:example_child, many: false)}
+
+    it "parses child" do
+      child = subject.parse(value)
+      child.id.should == "7000"
+    end
+  end
+
+  context "when it embeds many" do
+    before do
+      class ExampleChild < Resource
+        property :id
+      end
+    end
+
+    let(:value) {[{"id" => "7000"}, {"id" => "7001"}]}
+
+    subject {Resource::Embeddable.new(:example_children, many: true)}
+
+    it "parses children" do
+      children = subject.parse(value)
+      children[0].id.should == "7000"
+      children[1].id.should == "7001"
+    end
+  end
+end

data/spec/unit/resource/parser/property_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Resource::Parser::Property do
+  subject {Resource::Property.new(:login)}
+
+  let(:value)           {"jackiechan2010"}
+  let(:serializer_mock) {mock :serializer}
+
+  before do
+    subject.stub!(:serializer).and_return serializer_mock
+  end
+
+  it "tries to serialize value" do
+    serializer_mock.should_receive(:serialize).with(value).and_return(value)
+    subject.parse(value)
+  end
+
+  context "when there is a values map" do
+    let(:values) {{paid: '01', unpaid: '02'}}
+
+    subject do
+      options = {values: values}
+      Resource::Property.new(:payment_status, options)
+    end
+
+    it "maps value" do
+      serializer_mock.should_receive(:serialize).with(value).and_return "02"
+      subject.parse(value).should == :unpaid
+    end
+  end
+end

data/spec/unit/resource/response/embeddable_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Resource::Response::Embeddable do
+  before do
+    class ExampleChild < Resource
+      property :id
+    end
+
+    class Example < Resource
+      embeds_one  :example_child
+      embeds_many :example_children
+    end
+  end
+
+  shared_examples_for "an embeddable" do
+    it "returns a pair with property name and value" do
+      subject.to_resource(example).should == result
+    end
+
+    context "when this key shouldn't be present on resource" do
+      it "returns an empty hash" do
+        subject.should_receive(:present?).and_return false
+        subject.to_resource(example).should == {}
+      end
+    end
+  end
+
+  context "when embeds one" do
+    subject {Example.keys[0]}
+
+    let :example do
+      Example.new.tap do |example|
+        example.example_child = ExampleChild.new(id: "200")
+      end
+    end
+
+    let(:result) {{example_child: {id: "200"}}}
+
+    it_behaves_like "an embeddable"
+  end
+
+  context "when embeds many" do
+    subject {Example.keys[1]}
+
+    let :example do
+      Example.new.tap do |example|
+        example.example_children = [ExampleChild.new(id: "300")]
+      end
+    end
+
+    let(:result) {{example_children: [{id: "300"}]}}
+
+    it_behaves_like "an embeddable"
+  end
+end