daylight 0.9.0.rc1

data/spec/lib/daylight/mock_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+require 'daylight/mock'
+
+describe Daylight::Mock do
+  class MiniTest::Spec ; end
+  class MiniTest::Test ; end
+
+  class TestClient < Daylight::API
+    has_many :test_client_children, through: :associated, class_name: 'TestClientChild'
+  end
+
+  class TestClientChild < Daylight::API ; end
+
+  # All clients will do this in their spec_helper.rb/test_helper.rb
+  Daylight::Mock.setup
+
+  describe 'return values' do
+    describe 'show' do
+      it "returns a single object of the correct type" do
+        TestClient.find(1).should be_instance_of(TestClient)
+      end
+
+      it "has the correct ID" do
+        TestClient.find(1).id.should == 1
+      end
+    end
+
+    describe 'index' do
+      it "returns a list of objects of the correct type" do
+        results = TestClient.find(:all)
+        results.should respond_to(:size)
+        results.first.should be_instance_of(TestClient)
+      end
+
+      it "seeds the objects with ids" do
+        TestClient.find(:all).all? {|z| z.id.present? }.should be_true
+      end
+
+      it "seeds the objects with any filters" do
+        TestClient.where(foo: 'bar').all? {|z| z.foo == 'bar' }.should be_true
+      end
+    end
+
+    describe 'associated' do
+      it "returns a list of objects of the associated type" do
+        results = TestClient.find(1).test_client_children
+        results.should respond_to(:size)
+        results.first.should be_instance_of(TestClientChild)
+      end
+
+      it "seeds the responses with ids" do
+        TestClient.find(1).test_client_children.all? {|z| z.id.present? }.should be_true
+      end
+
+      it "seeds the objects with any filters" do
+        TestClient.find(1).test_client_children.where(foo: 'bar').all? {|z| z.foo == 'bar' }.should be_true
+      end
+    end
+
+    describe 'update' do
+      it "returns a new object with the updated attributes" do
+        object = TestClient.find(1)
+        object.update_attributes(name: 'wibble').should be_true
+      end
+    end
+
+    describe 'create' do
+      it "returns the created object" do
+        object = TestClient.new(name: 'foo')
+        object.name = 'foo'
+        object.save.should be_true
+        object.id.should_not be_nil
+      end
+    end
+
+    describe 'destroy' do
+      it "returns a new object with the updated attributes" do
+        object = TestClient.find(1)
+        object.destroy.should be_true
+      end
+    end
+  end
+
+  describe 'recorder' do
+    it "keeps track of call counts across actions" do
+      TestClient.find(123)
+      TestClient.find(456)
+
+      daylight_mock.shown(:test_clients).count.should == 2
+    end
+
+    it "keeps track of the requests" do
+      TestClient.find(:all)
+
+      daylight_mock.indexed(:test_client).first.request.method.should == :get
+    end
+
+    it "keeps track of the responses" do
+      object = TestClient.find(1)
+      object.update_attributes(name: 'wibble')
+
+      daylight_mock.updated(:test_client).first.status.should == 201
+    end
+
+    it "returns the last response" do
+      TestClient.find(123)
+      TestClient.find(456)
+
+      daylight_mock.last_shown(:test_clients).response.id.should == 456
+    end
+
+    describe :target_object do
+      it "sets the target_object value for examination on update" do
+        object = TestClient.find(1)
+        object.update_attributes(code: 'wibble')
+
+        daylight_mock.last_updated(:test_clients).target_object.code.should == 'wibble'
+      end
+
+      it "sets the target_object value for examination on create" do
+        object = TestClient.new(code: 'foo')
+        object.name = 'foo'
+        object.save.should be_true
+
+        daylight_mock.last_created(:test_clients).target_object.code.should == 'foo'
+      end
+    end
+
+  end
+
+  describe 'minitest setup' do
+    let(:minitest) { Minitest::Test.new }
+
+    it "adds our mock methods to Minitest::Test" do
+      minitest.should respond_to(:daylight_mock)
+    end
+
+    it "captures API requests" do
+      minitest.should_receive(:stub_request).and_return stub_request(:any, /.*/)
+      minitest.before_setup
+    end
+  end
+
+end

data/spec/lib/daylight/read_only_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+class TestReadOnly < Daylight::API
+  self.password = nil
+
+  has_one :child, class_name: 'TestReadOnly'
+end
+
+describe Daylight::ReadOnly do
+  def parse_xml(xml)
+    data = Hash.from_xml(xml)
+
+    if data.is_a?(Hash) && data.keys.size == 1
+      data.values.first
+    else
+      data
+    end
+  end
+
+  describe "read only attributes" do
+    before do
+      data = {
+        test_read_only: { name: "foo", immutable: "readme"},
+        meta: { test_read_only: { read_only: ["immutable"], nested_resources: ["test_resource"] } }
+      }
+
+      stub_request(:any, %r{#{TestReadOnly.site}}).to_return(body: data.to_json)
+    end
+
+    it "is defined" do
+      test = TestReadOnly.find(1)
+
+      test.read_only.should == ["immutable"]
+    end
+
+    it "is accessible" do
+      test = TestReadOnly.find(1)
+
+      test.immutable.should == 'readme'
+    end
+
+    it "cannot be set" do
+      test = TestReadOnly.find(1)
+
+      lambda { test.immutable = 'foo' }.should raise_error(NoMethodError)
+    end
+
+    it "does not respond to setter" do
+      test = TestReadOnly.find(1)
+
+      test.should_not respond_to(:immutable=)
+    end
+
+    it "is excluded when generating json" do
+      json = TestReadOnly.find(1).to_json
+
+      JSON.parse(json).keys.should_not include('immutable')
+    end
+
+    it "is excluded when generating json with child resource" do
+      test1 = TestReadOnly.find(1)
+      test2 = TestReadOnly.find(1)
+      test1.attributes['child'] = test2
+
+      json = JSON.parse(test1.to_json)
+      json.keys.should_not include('immutable')
+
+      json['child'].keys.should_not include('immutable')
+    end
+
+    it "is excluded when generating json with children collection" do
+      test1 = TestReadOnly.find(1)
+      test2 = TestReadOnly.find(1)
+      test1.attributes['children'] = [test2]
+
+      json = JSON.parse(test1.to_json)
+      json.keys.should_not include('immutable')
+
+      json['children'].map(&:keys).flatten.should_not include('immutable')
+    end
+
+    it "is excluded xml" do
+      xml = TestReadOnly.find(1).to_xml
+
+      parse_xml(xml).keys.should_not include('immutable')
+    end
+
+    it "is excluded when generating json with child resource" do
+      test1 = TestReadOnly.find(1)
+      test2 = TestReadOnly.find(1)
+      test1.attributes['child'] = test2
+
+      xml = parse_xml(test1.to_xml)
+      xml.keys.should_not include('immutable')
+
+      xml['child'].keys.should_not include('immutable')
+    end
+
+    it "is excluded when generating json with children collection" do
+      test1 = TestReadOnly.find(1)
+      test2 = TestReadOnly.find(1)
+      test1.attributes['children'] = [test2]
+
+      xml = parse_xml(test1.to_xml)
+      xml.keys.should_not include('immutable')
+
+      xml['children'].map(&:keys).flatten.should_not include('immutable')
+    end
+
+    it "always loads read_only attributes from the server" do
+      test = TestReadOnly.new
+      test.read_only.should == []
+
+      test.save
+      test.read_only.should == ['immutable']
+    end
+  end
+end

data/spec/lib/daylight/refinements_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Daylight do
+
+  class RefinementTestClass < Daylight::API
+    self.password = nil
+
+    scopes :foo, :bar
+  end
+
+  before do
+    data = [{name: 'one'}, {name: 'two'}]
+    stub_request(:get, %r{#{RefinementTestClass.site}}).to_return(body: data.to_json)
+  end
+
+  describe Daylight::Refinements do
+
+    it 'allows developers to define which scopes their models support' do
+      RefinementTestClass.should respond_to(:foo)
+      RefinementTestClass.should respond_to(:bar)
+
+      RefinementTestClass.scopes :baz
+
+      RefinementTestClass.should respond_to(:baz)
+    end
+
+    it 'keeps track of scopes' do
+      RefinementTestClass.scope_names.should include(:foo)
+      RefinementTestClass.scope_names.should include(:bar)
+    end
+
+    it 'allows addition of scopes' do
+      names = RefinementTestClass.scope_names
+      names.should include(:foo)
+      names.should include(:bar)
+
+      RefinementTestClass.scopes :baz
+
+      names = RefinementTestClass.scope_names
+      names.should include(:foo)
+      names.should include(:bar)
+      names.should include(:baz)
+    end
+
+    it 'supports first' do
+      resource = RefinementTestClass.first
+
+      resource.should be_kind_of(ActiveResource::Base)
+      resource.name.should == 'one'
+    end
+
+    it 'supports first with arguments' do
+      resource = RefinementTestClass.first(params: {order: 'name'})
+
+      resource.should be_kind_of(ActiveResource::Base)
+      resource.name.should == 'one'
+    end
+
+    [:where, :find_by, :order, :limit, :offset].each do |method|
+      it "delegates '#{method}' to ResourceProxy" do
+        RefinementTestClass.should respond_to(method)
+      end
+    end
+
+    describe "ResourceProxy class" do
+      it "added to subclasses" do
+        RefinementTestClass.should be_const_defined(:ResourceProxy)
+      end
+
+      it "accessible from subclass" do
+        RefinementTestClass.send(:resource_proxy_class).should == RefinementTestClass::ResourceProxy
+      end
+
+      it "produce a new instance" do
+        RefinementTestClass.send(:resource_proxy).class.should == RefinementTestClass::ResourceProxy
+      end
+    end
+
+  end
+end

data/spec/lib/daylight/reflection_ext_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Daylight::ReflectionExt do
+
+  module TestAPI
+    module V1; end
+  end
+
+  class TestFallback < Daylight::API; end
+
+  class TestAPI::V1::Comment < Daylight::API; end
+
+  class TestAPI::V1::Post < Daylight::API
+    has_many :comments
+    has_many :top_comments, class_name: 'test_api/v1/comment'
+
+    belongs_to :test_fallback
+  end
+
+  before do
+    post_data     = {id: 1, title: 'Test Post', test_fallback_id: 3}
+    comments_data = [{body: 'comment 1'}, {body: 'comment 2'}]
+    fallback_data = {id: 3, name: 'Fallback'}
+
+    stub_request(:get, %r{#{TestAPI::V1::Post.element_path(1)}}).to_return(body:    post_data.to_json)
+    stub_request(:get, %r{#{TestAPI::V1::Comment.collection_path}}).to_return(body: comments_data.to_json)
+    stub_request(:get, %r{#{TestFallback.element_path(3)}}).to_return(body:         fallback_data.to_json)
+  end
+
+  it 'expands class name with namespace and version' do
+    comments = TestAPI::V1::Post.find(1).comments
+
+    comments.size.should == 2
+    comments.first.should be_kind_of(TestAPI::V1::Comment)
+  end
+
+
+  it 'still overrides classname' do
+    comments = TestAPI::V1::Post.find(1).top_comments
+
+    comments.size.should == 2
+    comments.first.should be_kind_of(TestAPI::V1::Comment)
+  end
+
+  it 'falls back to old behavior when class with expanded_name cannot be determined' do
+    fallback = TestAPI::V1::Post.find(1).test_fallback
+
+    fallback.should be_kind_of(TestFallback)
+  end
+end