sunstone 0.1.0

data/lib/sunstone/schema.rb

@@ -0,0 +1,38 @@
+require 'sunstone/type/value'
+require 'sunstone/type/mutable'
+require 'sunstone/type/boolean'
+require 'sunstone/type/date_time'
+require 'sunstone/type/decimal'
+require 'sunstone/type/integer'
+require 'sunstone/type/string'
+
+module Sunstone
+  class Schema
+    
+    attr_accessor :attributes
+    
+    def initialize
+      @attributes = {}
+    end
+    
+    def attribute(name, type, options = {})
+      types = Sunstone::Type::Value.subclasses
+      type = types.find {|sc| sc.name.demodulize.downcase == type.to_s}
+      
+      @attributes[name.to_s] = type.new(options)
+    end
+    
+    def [](name)
+      @attributes[name.to_s]
+    end
+    
+    Sunstone::Type::Value.subclasses.each do |type|
+      class_eval <<-EOV, __FILE__, __LINE__ + 1
+        def #{type.name.demodulize.downcase}(name, options = {})
+          attribute(name, "#{type.name.demodulize.downcase}", options)
+        end
+      EOV
+    end
+    
+  end
+end

data/lib/sunstone/type/boolean.rb

@@ -0,0 +1,19 @@
+module Sunstone
+  module Type
+    class Boolean < Value
+      
+      TRUE_VALUES = [true, 'true', 'TRUE'].to_set
+    
+      private
+    
+      def _cast_value(value)
+        if value == ''
+          nil
+        else
+          TRUE_VALUES.include?(value)
+        end
+      end
+      
+    end
+  end
+end

data/lib/sunstone/type/date_time.rb

@@ -0,0 +1,20 @@
+module Sunstone
+  module Type
+    class DateTime < Value
+      
+      private
+      
+      def _type_cast_for_json(value)
+        value.iso8601(3) if value
+      end
+      
+      def _cast_value(string)
+        return string unless string.is_a?(::String)
+        return if string.empty?
+        
+        ::DateTime.iso8601(string) || ::DateTime.parse(string)
+      end
+      
+    end
+  end
+end

data/lib/sunstone/type/decimal.rb

@@ -0,0 +1,19 @@
+module Sunstone
+  module Type
+    class Decimal < Value
+    
+      private
+    
+      def _cast_value(value)
+        if value == ''
+          nil
+        elsif value.is_a?(BigDecimal)
+          value
+        else
+          BigDecimal.new(value.to_s)
+        end
+      end
+      
+    end
+  end
+end

data/lib/sunstone/type/integer.rb

@@ -0,0 +1,17 @@
+module Sunstone
+  module Type
+    class Integer < Value
+    
+      private
+    
+      def _cast_value(value)
+        case value
+        when true then 1
+        when false then 0
+        else value.to_i
+        end
+      end
+      
+    end
+  end
+end

data/lib/sunstone/type/mutable.rb

@@ -0,0 +1,16 @@
+module Sunstone
+  module Type
+    module Mutable # :nodoc:
+      def type_cast_from_user(value)
+        type_cast_from_json(type_cast_for_json(value))
+      end
+
+      # +raw_old_value+ will be the `_before_type_cast` version of the
+      # value (likely a string). +new_value+ will be the current, type
+      # cast value.
+      def changed_in_place?(raw_old_value, new_value)
+        raw_old_value != type_cast_for_json(new_value)
+      end
+    end
+  end
+end

data/lib/sunstone/type/string.rb

@@ -0,0 +1,18 @@
+module Sunstone
+  module Type
+    class String < Value
+    
+      private
+    
+      def _cast_value(value)
+        case value
+        when true then "1"
+        when false then "0"
+        # Dup the string
+        else ::String.new(value.to_s)
+        end
+      end
+      
+    end
+  end
+end

data/lib/sunstone/type/value.rb

@@ -0,0 +1,97 @@
+module Sunstone
+  module Type
+    class Value
+    
+      attr_accessor :options
+      
+      def initialize(options={})
+        @options = options
+      end
+      
+      def type_cast_from_json(value)
+        if @options[:array]
+          value.nil? ? nil : value.map{ |v| _type_cast_from_json(v) }
+        else
+          _type_cast_from_json(value)
+        end
+      end
+
+      def type_cast_from_user(value)
+        if @options[:array]
+          value.nil? ? nil : value.map{ |v| _type_cast_from_user(v) }
+        else
+          _type_cast_from_user(value)
+        end
+      end
+    
+      def type_cast_for_json(value)
+        if @options[:array]
+          value.nil? ? nil : value.map{ |v| _type_cast_for_json(v) }
+        else
+          _type_cast_for_json(value)
+        end
+      end
+    
+      # Determines whether a value has changed for dirty checking. +old_value+
+      # and +new_value+ will always be type-cast. Types should not need to
+      # override this method.
+      def changed?(old_value, new_value, _new_value_before_type_cast)
+        old_value != new_value
+      end
+    
+      # Determines whether the mutable value has been modified since it was
+      # read. Returns +false+ by default. This method should not need to be
+      # overriden directly. Types which return a mutable value should include
+      # +Type::Mutable+, which will define this method.
+      def changed_in_place?(*)
+        false
+      end
+      
+      def readonly?
+        @options[:readonly]
+      end
+    
+      private
+      
+      # Type casts a value from json into the appropriate ruby type. Classes
+      # which do not need separate type casting behavior for json and user
+      # provided values should override +_cast_value+ instead.
+      def _type_cast_from_json(value)
+        _type_cast(value)
+      end
+
+      # Type casts a value from user input (e.g. from a setter). This value may
+      # be a string from the form builder, or an already type cast value
+      # provided manually to a setter.
+      # 
+      # Classes which do not need separate type casting behavior for json
+      # and user provided values should override +_type_cast+ or +_cast_value+
+      # instead.      
+      def _type_cast_from_user(value)
+        _type_cast(value)
+      end
+
+      # Cast a value from the ruby type to a type that the json knows how
+      # to understand. The returned value from this method should be a
+      # +String+, +Numeric+, +Symbol+, +true+, +false+, or +nil+      
+      def _type_cast_for_json(value)
+        value
+      end
+    
+      def _type_cast(value)
+        _cast_value(value) unless value.nil?
+      end
+
+      # Convenience method for types which do not need separate type casting
+      # behavior for user and database inputs. Called by
+      # `_type_cast_from_json` and `_type_cast_from_user` for all values except
+      # `nil`.
+      #
+      # If you wish to catch the nil case use the `_type_cast` function
+      def _cast_value(value) # :doc:
+        value
+      end
+      
+    end
+  end
+end

data/sunstone.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name        = "sunstone"
+  s.version     = '0.1.0'
+  s.authors     = ["Jon Bracy"]
+  s.email       = ["jonbracy@gmail.com"]
+  s.homepage    = "http://sunstonerb.com"
+  s.summary     = %q{A library for interacting with REST APIs}
+  s.description = %q{A library for interacting with REST APIs. Similar to ActiveResource}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Developoment 
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'sdoc'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'sdoc-templates-42floors'
+
+  # Runtime
+  s.add_runtime_dependency 'wankel'
+  s.add_runtime_dependency 'cookie_store'
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'activemodel'
+  s.add_runtime_dependency 'connection_pool'
+end

data/test/sunstone/model/associations_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class BelongsToModel < Sunstone::Model
+end
+
+
+class Sunstone::Model::AssociationsTest < Minitest::Test
+
+  def setup
+    @klass = Class.new(Sunstone::Model)
+  end
+  
+  test "inherited models get a schema setup with id" do
+    assert_equal({},        @klass.reflect_on_associations)
+  end
+  
+  test "::belongs_to adds association" do
+    @klass.belongs_to :belongs_to_model
+    
+    assert_equal({
+      :name=>:belongs_to_model,
+      :macro=>:belongs_to,
+      :klass=>BelongsToModel,
+      :foreign_key=>:belongs_to_model_id
+    }, @klass.reflect_on_associations[:belongs_to_model])
+  end
+  
+  test "::belongs_to addes foreign_key attribute to class" do
+    @klass.belongs_to :belongs_to_model
+    
+    assert_kind_of Sunstone::Type::Integer, @klass.schema[:belongs_to_model_id]
+  end
+  
+  test "::belongs_to setter and getter" do
+    @klass.belongs_to :belongs_to_model
+    
+    model = @klass.new
+    omodel = BelongsToModel.new(:id => 10)
+    assert_nil model.belongs_to_model
+    model.belongs_to_model = omodel
+    assert_equal omodel, model.belongs_to_model
+    assert_equal 10, model.belongs_to_model_id
+  end
+  
+  test "::has_many adds association" do
+    @klass.has_many :belongs_to_models
+    
+    assert_equal({
+      :name         => :belongs_to_models,
+      :macro        => :has_many,
+      :klass        => BelongsToModel
+    }, @klass.reflect_on_associations[:belongs_to_models])
+  end
+
+end

data/test/sunstone/model/attributes_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class Sunstone::Model::AttributesTest < Minitest::Test
+
+  def setup
+    @klass = Class.new(Sunstone::Model)
+  end
+  
+  test "inherited models get a schema setup with id" do
+    assert_kind_of Sunstone::Schema,        @klass.schema
+    assert_kind_of Sunstone::Type::Integer, @klass.schema[:id]
+  end
+  
+  test "::attribute" do
+    @klass.attribute :name, :string
+    
+    assert_kind_of Sunstone::Type::String, @klass.schema[:name]
+  end
+
+  test "::attribute sets up readers" do
+    @klass.attribute :name, :string
+    model = @klass.new
+    
+    model.attributes[:name] = "my name"
+    assert_equal "my name", model.name
+  end
+  
+  test "::attributes sets up writer" do
+    @klass.attribute :name, :string
+    model = @klass.new
+    
+    model.schema[:name].expects(:type_cast_from_user).with("my name").returns("value")
+    model.name = "my name"
+    
+    assert_equal "value", model.name
+    assert_equal "value", model.attributes[:name]
+  end
+  
+  test "::define_schema" do
+    @klass.define_schema do
+      attribute :name, :string
+      integer   :size
+    end
+    
+    assert_kind_of Sunstone::Type::String,  @klass.schema[:name]
+    assert_kind_of Sunstone::Type::Integer, @klass.schema[:size]
+  end
+  
+  test '#has?' do
+    @klass.define_schema do
+      attribute :name, :string
+      integer   :size
+    end
+    model = @klass.new(:size => 20)
+    
+    assert_equal false, model.has?(:name)
+    assert_equal true,  model.has?(:size)
+  end
+  
+end

data/test/sunstone/model/persistence_test.rb

@@ -0,0 +1,173 @@
+require 'test_helper'
+
+class Sunstone::Model::PersistenceTest < Minitest::Test
+  
+  class TestModel < Sunstone::Model
+    define_schema do
+      attribute :name, :string
+      integer   :size
+      datetime  :timestamp
+      datetime  :updated_at, :readonly => true
+    end
+  end
+
+  def setup
+    Sunstone.site = "http://test_api_key@testhost.com"
+    @klass = Class.new(Sunstone::Model)
+  end
+  
+  test '#serialize' do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    assert_equal '{"id":null,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":null}', model.serialize
+  end
+  
+  test '#serialize(:only => [KEYS])' do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    assert_equal '{"size":20}', model.serialize(:only => ['size'])
+  end
+  
+  
+  
+  
+  test '#save a new record' do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    stub_request(:post, "http://testhost.com/sunstone_model_persistence_test_test_models")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 200,
+      :body => '{"id":20,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+      
+    assert_equal true, model.save
+  end
+  
+  test '#save a new invalid record' do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    stub_request(:post, "http://testhost.com/sunstone_model_persistence_test_test_models")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 400,
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+      
+    assert_equal false, model.save
+  end
+  
+  test "#save a new record updates the model with the response" do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    stub_request(:post, "http://testhost.com/sunstone_model_persistence_test_test_models")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 200,
+      :body => '{"id":20,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+
+    model.save
+    assert_equal 20, model.id
+    assert_equal time.iso8601(3), model.updated_at.iso8601(3)
+  end
+  
+  test "#save on an new record will set new_record? is false" do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    stub_request(:post, "http://testhost.com/sunstone_model_persistence_test_test_models")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 200,
+      :body => '{"id":20,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+
+    model.save
+    assert_equal false, model.new_record?
+  end
+  
+  test '#save on a persisted record' do
+    time = Time.now
+    model = TestModel.new(:id => 13, :size => 20, :timestamp => time)
+    model.instance_variable_set(:@new_record, false)
+    
+    stub_request(:put, "http://testhost.com/sunstone_model_persistence_test_test_models/13")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 200,
+      :body => '{"id":13,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+      
+    assert_equal true, model.save
+  end
+  
+  test '#save on a persisted record updates the model with the response' do
+    time = Time.now
+    model = TestModel.new(:id => 13, :size => 20, :timestamp => time)
+    model.instance_variable_set(:@new_record, false)
+    
+    stub_request(:put, "http://testhost.com/sunstone_model_persistence_test_test_models/13")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 200,
+      :body => '{"id":13,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+      
+    model.save
+    assert_equal 13, model.id
+    assert_equal time.iso8601(3), model.updated_at.iso8601(3)
+  end
+  
+  test '#save! a new record' do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    stub_request(:post, "http://testhost.com/sunstone_model_persistence_test_test_models")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 200,
+      :body => '{"id":20,"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+      
+    assert_equal true, model.save!
+  end
+  
+  test '#save! a new invalid record' do
+    time = Time.now
+    model = TestModel.new(:size => 20, :timestamp => time)
+    
+    stub_request(:post, "http://testhost.com/sunstone_model_persistence_test_test_models")
+    .with(
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '"}')
+    .to_return(
+      :status => 400,
+      :body => '{"name":null,"size":20,"timestamp":"' + time.iso8601(3) + '","updated_at":"' + time.iso8601(3) + '"}')
+      
+    assert_raises Sunstone::RecordInvalid do
+      model.save!
+    end
+  end
+  
+  
+  test '::find(id)' do
+    stub_request(:get, "http://testhost.com/sunstone_model_persistence_test_test_models/324").to_return(:body => '{"size": 40}')
+    
+    model = TestModel.find('324')
+    assert_kind_of TestModel, model
+    assert_equal 40, model.size
+  end
+  
+  test '::find(id) with 404' do
+    stub_request(:get, "http://testhost.com/sunstone_model_persistence_test_test_models/324").to_return(:status => 404)
+    
+    assert_raises Sunstone::Exception::NotFound do
+      TestModel.find('324')
+    end
+  end
+  
+end