rest_model 0.1.0

data/spec/integration/property_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+def it_parses_property
+  it 'parses property' do
+    root.login.should == 'jackiechan2010'
+  end
+end
+
+describe_example 'properties/simple' do
+  it_parses_property
+end
+
+describe_example 'properties/with_field' do
+  context 'when input has a different name for the property' do
+    it_parses_property
+  end
+end
+
+describe_example 'properties/with_field_path' do
+  context 'when input has a different path for the property' do
+    it_parses_property
+  end
+end
+
+describe_example 'properties/with_id' do
+  context 'when property is an id' do
+    it 'parses id' do
+      root.id.should == "2000"
+    end
+  end
+end
+
+describe_example 'properties/with_if' do
+  context 'when a property has a conditional proc (:if)' do
+    context 'and it evaluates to true' do
+      it 'parses property' do
+        root_with_description.description.should == "description"
+      end
+    end
+
+    context 'and it evaluates to false' do
+      it "doesn't parse property" do
+        root_without_description.description.should_not be
+      end
+    end
+  end
+end
+
+describe_example 'properties/with_key_converter' do
+  after do
+    RestModel::Configuration.configure do |c|
+      c.convert_input_keys = nil
+    end
+  end
+
+  context 'when a diferent key converter is configured on rest model' do
+    it_parses_property
+  end
+end
+
+describe_example 'properties/with_two_key_converters' do
+  context 'when key converters are configured for each class' do
+    it_parses_property
+
+    it 'parses other property with different key converter' do
+      root.product.unit_price.should == 29.9
+    end
+  end
+end

data/spec/integration/summarization_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe_example 'summarization/simple' do
+  subject {root[:entries].first}
+
+  it 'summarizes resources' do
+    subject.keys.count.should == 3
+    subject[:id].should    == '138911938'
+    subject[:login].should == 'jackiechan2010'
+    subject[:href].should  == 'http://example.com/customers/138911938'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+$:.push '../lib'
+
+require 'rest_model'
+require 'ostruct'
+require 'json'
+require 'stringio'
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'support/shared_examples'
+require 'support/examples'
+require 'support/out'
+
+RSpec.configure do |config|
+  config.before do
+    [:Example, :ExampleChild].each do |klass|
+      Object.send(:remove_const, klass) if Object.const_defined? klass
+    end
+  end
+end
+
+include Output
+include Examples
+
+RestModel::Configuration.configure do |c|
+  c.host = 'http://example.com'
+end

data/spec/support/examples.rb

@@ -0,0 +1,29 @@
+module Examples
+  def describe_example(file, &block)
+    describe "example #{file}" do
+      [:Root, :Item, :Customer, :Entry].each do |klass|
+        Examples.send(:remove_const, klass) if Examples.const_defined?(klass)
+      end
+
+      # silently {
+
+        eval File.read("examples/#{file}.rb")
+
+        # }
+
+      variables = instance_variables.reject {|var| var.to_s =~ /metadata$/}
+
+      values = variables.inject({}) do |buffer, name|
+        method_name = name.to_s.gsub(/@/, "")
+        let(method_name)           {instance_variable_get(name)}
+        buffer.merge method_name => instance_variable_get(name)
+      end
+
+      before :all do
+        values.each {|name, value| instance_variable_set "@#{name}", value}
+      end
+
+      instance_eval &block if block
+    end
+  end
+end

data/spec/support/out.rb

@@ -0,0 +1,17 @@
+module Output
+  def out
+    output  = StringIO.new
+    begin
+      $stdout = output
+      yield
+    ensure
+      $stdout = STDOUT
+    end
+    output.string
+  end
+
+  def silently
+    out {yield}
+    nil
+  end
+end

data/spec/support/shared_examples.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/configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe RestModel::Configuration do
+  after(:all) do
+    RestModel::Configuration.convert_input_keys = nil
+  end
+
+  context "when no custom input keys converter is set" do
+    it "returns default key converter" do
+      default_handler = RestModel::Configuration::DefaultHandler
+      RestModel::Configuration.convert_input_keys.should == default_handler
+    end
+  end
+
+  context "when a custom input keys converter is set" do
+    let(:custom_convert_input_keys) {lambda {|keys| keys}}
+
+    before {RestModel::Configuration.convert_input_keys = custom_convert_input_keys}
+
+    it "returns custom key converter" do
+      RestModel::Configuration.convert_input_keys.should == custom_convert_input_keys
+    end
+  end
+end

data/spec/unit/key/association_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe RestModel::Association do
+  describe "#initialize" do
+    context "class_name" do
+      context "when class_name option is passed" do
+        subject do
+          RestModel::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 {RestModel::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
+          RestModel::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
+          RestModel::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
+          RestModel::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/key/embeddable/builder_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe RestModel::Embeddable::Builder do
+  before do
+    class Example < RestModel
+      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/key/embeddable/response_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe RestModel::Embeddable::Response do
+  before do
+    class ExampleChild < RestModel
+      property :id
+    end
+
+    class Example < RestModel
+      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 visible on resource" do
+      it "returns an empty hash" do
+        subject.should_receive(:visible?).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

data/spec/unit/key/embeddable/retriever_spec.rb

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

data/spec/unit/key/embeddable_spec.rb

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

data/spec/unit/key/property/builder_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe RestModel::Property::Builder 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 < RestModel
+          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 < RestModel
+          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 < RestModel
+          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 < RestModel
+          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 < RestModel
+          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 < RestModel
+          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 < RestModel
+          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 < RestModel
+        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/key/property/response_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe RestModel::Property::Response do
+  class Customer
+    attr_accessor :login
+  end
+
+  subject {RestModel::Property.new(:login)}
+
+  it "returns a pair with property name and value" do
+    customer = Customer.new.tap {|c| c.login = "jackiechan2010"}
+    subject.to_resource(customer).should == {login: "jackiechan2010"}
+  end
+
+  context "when this key shouldn't be visible on resource" do
+    it "returns an empty hash" do
+      subject.should_receive(:visible?).and_return false
+      customer = Customer.new.tap {|c| c.login = "jackiechan2010"}
+      subject.to_resource(customer).should == {}
+    end
+  end
+end

data/spec/unit/key/property/retriever_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe RestModel::Property::Retriever do
+  subject {RestModel::Property.new(:login)}
+
+  let(:item)            {{login: "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(item[:login]).and_return(item[:login])
+    subject.from_source(item)
+  end
+
+  context "when there is a values map" do
+    let(:values) {{paid: '01', unpaid: '02'}}
+
+    subject do
+      options = {values: values}
+      RestModel::Property.new(:payment_status, options)
+    end
+
+    it "maps value" do
+      serializer_mock.should_receive(:serialize).with("02").and_return "02"
+      subject.from_source({payment_status: "02"}).should == :unpaid
+    end
+  end
+end

data/spec/unit/key/property_spec.rb

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