placid 0.0.6 → 0.0.7

data/.gitignore

@@ -6,3 +6,5 @@ coverage/*
 doc/*
 *~
 pkg/*
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

data/History.md

@@ -1,6 +1,14 @@
 Placid History
 ==============
 
+0.0.7
+-----
+
+- Some support for coercion (requires Hashie >= 2.0.4)
+- Allow '/' in request URL paths to pass through unescaped
+- Add PlacidError base exception class
+
+
 0.0.6
 -----
 

data/Rakefile

@@ -4,9 +4,12 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/**/*.rb'
   t.rspec_opts = ['--color', '--format doc']
-  t.rcov = true
-  t.rcov_opts = [
-    '--exclude /.gem/,/gems/,spec',
-  ]
+  if RUBY_VERSION < "1.9"
+    t.rcov = true
+    t.rcov_opts = [
+      '--exclude /.gem/,/gems/,spec',
+    ]
+  end
 end
 
+task :default => :spec

data/lib/placid/exceptions.rb

@@ -1,6 +1,10 @@
 module Placid
+  # Generic Placid exception
+  class PlacidError < RuntimeError
+  end
+
   # Error parsing a JSON response
-  class JSONParseError < RuntimeError
+  class JSONParseError < PlacidError
     def initialize(message, data='')
       super(message)
       @data = data
@@ -9,6 +13,10 @@ module Placid
   end
 
   # Error connecting to the REST API
-  class RestConnectionError < RuntimeError
+  class RestConnectionError < PlacidError
+  end
+
+  # Error with request path
+  class PathError < PlacidError
   end
 end

data/lib/placid/helper.rb

@@ -7,13 +7,14 @@ require 'placid/exceptions'
 
 module Placid
   module Helper
-    # Escape any special URI characters in `text` and return the escaped string.
-    # `nil` is treated as an empty string.
+    # Escape any special URI characters in `text` (except for '/') and return
+    # the escaped string. `nil` is treated as an empty string.
     #
     # @return [String]
     #
     def escape(text)
-      URI.escape(text.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      # Treat '/' as unreserved
+      URI.escape(text.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}/]"))
     end
 
     # Return a full URL for a REST API request to the given path, relative to
@@ -57,8 +58,13 @@ module Placid
     #   If there is a problem connecting to the REST API
     # @raise [JSONParseError]
     #   If the response from the REST API cannot be parsed as JSON
+    # @raise [PathError]
+    #   If any part of the path is nil
     #
     def request(method, *path)
+      if path.any? {|p| p.nil?}
+        raise PathError, "Cannot use nil as a path component"
+      end
       method = method.to_sym
       params = path.extract_options!
       params = {:params => params} if method == :get

data/lib/placid/model.rb

@@ -5,7 +5,7 @@ require 'active_support/inflector' # for `pluralize` and `underscore`
 module Placid
   # Base class for RESTful models
   class Model < Hashie::Mash
-
+    include Hashie::Extensions::Coercion
     include Placid::Helper
     extend Placid::Helper
 

data/placid.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "placid"
-  s.version = "0.0.6"
+  s.version = "0.0.7"
   s.summary = "Models from REST"
   s.description = <<-EOS
     Placid is an ActiveRecord-ish model using a REST API for storage. The REST API
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/a-e/placid"
   s.platform = Gem::Platform::RUBY
 
-  s.add_dependency 'hashie'
+  s.add_dependency 'hashie', '>= 2.0.4'
   s.add_dependency 'json'
   s.add_dependency 'rest-client'
   s.add_dependency 'activesupport'
@@ -20,7 +20,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard' # For documentation
   s.add_development_dependency 'redcarpet' # For YARD / Markdown
-  s.add_development_dependency 'rcov'
+
+  if RUBY_VERSION < "1.9"
+    s.add_development_dependency 'rcov'
+  else
+    s.add_development_dependency 'simplecov'
+  end
 
   s.files = `git ls-files`.split("\n")
 

data/spec/{placid_helper_spec.rb → placid/helper_spec.rb}

@@ -3,7 +3,11 @@ require 'spec_helper'
 describe Placid::Helper do
   describe "#escape" do
     it "escapes all URI reserved characters" do
-      escape(";/?:@&=+$,[]").should == "%3B%2F%3F%3A%40%26%3D%2B%24%2C%5B%5D"
+      escape(";?:@&=+$,[]").should == "%3B%3F%3A%40%26%3D%2B%24%2C%5B%5D"
+    end
+
+    it "does not escape '/'" do
+      escape("foo/bar/baz").should == "foo/bar/baz"
     end
   end
 
@@ -13,7 +17,11 @@ describe Placid::Helper do
     end
 
     it "escapes path components to make them URI-safe" do
-      get_url('a b', 'c:d', 'e/f').should == 'http://localhost/a%20b/c%3Ad/e%2Ff'
+      get_url('a b', 'c:d').should == 'http://localhost/a%20b/c%3Ad'
+    end
+
+    it "does not escape '/'" do
+      get_url('a/b', 'c/d').should == 'http://localhost/a/b/c/d'
     end
   end
 
@@ -45,18 +53,24 @@ describe Placid::Helper do
       json.should == ["fail"]
     end
 
-    it "returns a RestConnectionError when connection is refused" do
-      RestClient.stub(:get).and_raise(Errno::ECONNREFUSED)
+    it "preserves '/' in path components" do
+      RestClient.should_receive(:post).
+        with('http://localhost/foo/bar/baz', {:x => '5'}).
+        and_return('{}')
+      request('post', 'foo/bar', 'baz', :x => '5')
+    end
+
+    it "raises a PathError if there's a nil in the path array" do
       lambda do
-        json = request('get')
-      end.should raise_error(Placid::RestConnectionError, /Could not connect/)
+        request('get', 'foo', nil, 'bar')
+      end.should raise_error(Placid::PathError, /Cannot use nil as a path component/)
     end
 
-    it "passes other exceptions through" do
-      RestClient.stub(:get).and_raise(URI::InvalidURIError)
+    it "raises a RestConnectionError when connection is refused" do
+      RestClient.stub(:get).and_raise(Errno::ECONNREFUSED)
       lambda do
         json = request('get')
-      end.should raise_error(URI::InvalidURIError)
+      end.should raise_error(Placid::RestConnectionError, /Could not connect/)
     end
 
     it "raises a JSONParseError if there is no response" do
@@ -66,6 +80,13 @@ describe Placid::Helper do
       end.should raise_error(Placid::JSONParseError, /Cannot parse/)
     end
 
+    it "passes other exceptions through" do
+      RestClient.stub(:get).and_raise(URI::InvalidURIError)
+      lambda do
+        json = request('get')
+      end.should raise_error(URI::InvalidURIError)
+    end
+
     it "accepts a params hash as the last argument" do
       RestClient.should_receive(:post).
         with('http://localhost/foo', {:bar => 'hi'}).

data/spec/{placid_model_spec.rb → placid/model_spec.rb}

@@ -4,6 +4,8 @@ describe Placid::Model do
   class Thing < Placid::Model
   end
 
+  subject { Thing }
+
   context "Instance methods" do
     describe "#id" do
       it "returns the value in the custom unique ID field" do
@@ -17,8 +19,8 @@ describe Placid::Model do
       end
 
       it "returns the value in the :id field if no custom field was set" do
-        thing_1 = Thing.new(:id => '111')
-        thing_2 = Thing.new(:id => '222')
+        thing_1 = subject.new(:id => '111')
+        thing_2 = subject.new(:id => '222')
         thing_1.id.should == '111'
         thing_2.id.should == '222'
       end
@@ -26,90 +28,90 @@ describe Placid::Model do
 
     describe "#save" do
       it "creates a new instance if one doesn't exist" do
-        thing = Thing.new(:id => '123')
-        Thing.stub(:find => nil)
-        Thing.should_receive(:create).
+        thing = subject.new(:id => '123')
+        subject.stub(:find => nil)
+        subject.should_receive(:create).
           with({'id' => '123'}).
-          and_return(Thing.new)
+          and_return(subject.new)
         thing.save
       end
 
       it "updates an existing instance" do
-        thing = Thing.new(:id => '123')
-        Thing.stub(:find => {:id => '123'})
-        Thing.should_receive(:update).
+        thing = subject.new(:id => '123')
+        subject.stub(:find => {:id => '123'})
+        subject.should_receive(:update).
           with('123', {'id' => '123'}).
-          and_return(Thing.new)
+          and_return(subject.new)
         thing.save
       end
 
       it "merges saved attributes on create" do
-        thing = Thing.new(:id => '123')
+        thing = subject.new(:id => '123')
         saved_attribs = {'id' => '123', 'name' => 'foo'}
-        Thing.stub(:find => nil)
-        Thing.should_receive(:create).
+        subject.stub(:find => nil)
+        subject.should_receive(:create).
           with({'id' => '123'}).
-          and_return(Thing.new(saved_attribs))
+          and_return(subject.new(saved_attribs))
         thing.save
         thing.should == saved_attribs
       end
 
       it "merges saved attributes on update" do
-        thing = Thing.new(:id => '123')
+        thing = subject.new(:id => '123')
         saved_attribs = {'id' => '123', 'name' => 'foo'}
-        Thing.stub(:find => {:id => '123'})
-        Thing.should_receive(:update).
+        subject.stub(:find => {:id => '123'})
+        subject.should_receive(:update).
           with('123', {'id' => '123'}).
-          and_return(Thing.new(saved_attribs))
+          and_return(subject.new(saved_attribs))
         thing.save
         thing.should == saved_attribs
       end
 
       it "returns false if errors were reported" do
-        thing = Thing.new
-        Thing.stub(:find => nil)
-        Thing.stub(:request).with(:post, 'thing', {}) { {'errors' => 'Missing id'} }
+        thing = subject.new
+        subject.stub(:find => nil)
+        subject.stub(:request).with(:post, 'thing', {}) { {'errors' => 'Missing id'} }
         thing.save.should be_false
       end
 
       it "returns true if errors is an empty list" do
-        thing = Thing.new(:id => '123')
-        Thing.stub(:find => nil)
-        Thing.stub(:request).with(:post, 'thing', {'id' => '123'}) { {'errors' => []} }
+        thing = subject.new(:id => '123')
+        subject.stub(:find => nil)
+        subject.stub(:request).with(:post, 'thing', {'id' => '123'}) { {'errors' => []} }
         thing.save.should be_true
       end
 
       it "returns true if no errors were reported" do
-        thing = Thing.new(:id => '123')
-        Thing.stub(:find => nil)
-        Thing.stub(:request).with(:post, 'thing', {'id' => '123'}) { {} }
+        thing = subject.new(:id => '123')
+        subject.stub(:find => nil)
+        subject.stub(:request).with(:post, 'thing', {'id' => '123'}) { {} }
         thing.save.should be_true
       end
     end
 
     describe "#required?" do
       it "true if the given field is implicitly required" do
-        Thing.stub(:meta => {:id => {:required => true}})
-        thing = Thing.new
+        subject.stub(:meta => {:id => {:required => true}})
+        thing = subject.new
         thing.required?(:id).should == true
       end
 
       it "false if the given field is explicitly optional" do
-        Thing.stub(:meta => {:id => {:required => false}})
-        thing = Thing.new
+        subject.stub(:meta => {:id => {:required => false}})
+        thing = subject.new
         thing.required?(:id).should == false
       end
 
       it "false if the given field is implicitly optional" do
-        Thing.stub(:meta => {:id => {}})
-        thing = Thing.new
+        subject.stub(:meta => {:id => {}})
+        thing = subject.new
         thing.required?(:id).should == false
       end
     end
 
     describe "#errors=" do
       it "sets the list of errors on the instance" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors = ['missing id']
         thing['errors'].should == ['missing id']
       end
@@ -117,24 +119,24 @@ describe Placid::Model do
 
     describe "#errors" do
       it "returns errors set on initialization" do
-        thing = Thing.new(:errors => ['missing id'])
+        thing = subject.new(:errors => ['missing id'])
         thing.errors = ['missing id']
         thing.errors.should == ['missing id']
       end
 
       it "returns errors set after initialization" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors = ['missing id']
         thing.errors.should == ['missing id']
       end
 
       it "returns [] if errors are not set" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors.should == []
       end
 
       it "returns [] if errors is set to nil" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors = nil
         thing.errors.should == []
       end
@@ -142,23 +144,23 @@ describe Placid::Model do
 
     describe "#errors?" do
       it "returns true if errors is set to a nonempty value" do
-        thing = Thing.new(:errors => ['missing id'])
+        thing = subject.new(:errors => ['missing id'])
         thing.errors?.should be_true
       end
 
       it "returns false if errors it not set" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors?.should be_false
       end
 
       it "returns false if errors is set to nil" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors = nil
         thing.errors?.should be_false
       end
 
       it "returns false if errors is set to an empty list" do
-        thing = Thing.new
+        thing = subject.new
         thing.errors = []
         thing.errors?.should be_false
       end
@@ -166,7 +168,7 @@ describe Placid::Model do
 
     describe "helpers" do
       it "can call #request on an instance" do
-        thing = Thing.new
+        thing = subject.new
         RestClient.should_receive(:get).
           with('http://localhost/thing/foo', {:params => {:x => 'y'}}).
           and_return('{}')
@@ -207,7 +209,7 @@ describe Placid::Model do
         RestClient.should_receive(:get).
           with('http://localhost/thing/meta', {:params => {}}).
           and_return(JSON(thing_meta))
-        Thing.meta.should == thing_meta
+        subject.meta.should == thing_meta
       end
 
       it "only sends a GET meta request once for the class" do
@@ -216,30 +218,30 @@ describe Placid::Model do
         }
         RestClient.stub(:get => JSON(thing_meta))
         RestClient.should_receive(:get).at_most(:once)
-        Thing.meta.should == thing_meta
-        Thing.meta.should == thing_meta
-        Thing.meta.should == thing_meta
+        subject.meta.should == thing_meta
+        subject.meta.should == thing_meta
+        subject.meta.should == thing_meta
       end
 
       it "stores meta-data separately for each derived class" do
         class ThingOne < Placid::Model; end
         class ThingTwo < Placid::Model; end
-
         thing_one_meta = {
           'one' => {'type' => 'String', 'required' => true}
         }
-        RestClient.should_receive(:get).
-          with('http://localhost/thing_one/meta', {:params => {}}).
-          and_return(JSON(thing_one_meta))
-        ThingOne.meta.should == thing_one_meta
-
         thing_two_meta = {
           'two' => {'type' => 'String', 'required' => false}
         }
-        RestClient.should_receive(:get).
+        RestClient.stub(:get).
+          with('http://localhost/thing_one/meta', {:params => {}}).
+          and_return(JSON(thing_one_meta))
+        RestClient.stub(:get).
           with('http://localhost/thing_two/meta', {:params => {}}).
           and_return(JSON(thing_two_meta))
+
+        ThingOne.meta.should == thing_one_meta
         ThingTwo.meta.should == thing_two_meta
+        ThingOne.meta.should_not == ThingTwo.meta
       end
     end
 
@@ -250,10 +252,10 @@ describe Placid::Model do
           {'name' => 'Bar'},
         ]
         RestClient.stub(:get => JSON(data))
-        things = Thing.list
+        things = subject.list
         things.should == data
         things.each do |thing|
-          thing.should be_a(Thing)
+          thing.should be_a(subject)
         end
       end
     end
@@ -262,8 +264,8 @@ describe Placid::Model do
       it "returns a Model instance matching the given id" do
         data = {'name' => 'Foo'}
         RestClient.stub(:get => JSON(data))
-        thing = Thing.find(1)
-        thing.should be_a(Thing)
+        thing = subject.find(1)
+        thing.should be_a(subject)
         thing.should == data
       end
     end
@@ -273,24 +275,24 @@ describe Placid::Model do
         it "posted attributes if no attributes were returned" do
           RestClient.stub(:post => '{}')
           attrs = {'name' => 'Foo'}
-          thing = Thing.create(attrs)
-          thing.should be_a(Thing)
+          thing = subject.create(attrs)
+          thing.should be_a(subject)
           thing.should == {'name' => 'Foo'}
         end
 
         it "returned attributes if no attributes were posted" do
           RestClient.stub(:post => '{"uri": "foo"}')
           attrs = {}
-          thing = Thing.create(attrs)
-          thing.should be_a(Thing)
+          thing = subject.create(attrs)
+          thing.should be_a(subject)
           thing.should == {'uri' => 'foo'}
         end
 
         it "original attributes merged with returned attributes" do
           RestClient.stub(:post => '{"uri": "foo"}')
           attrs = {'name' => 'Foo'}
-          thing = Thing.create(attrs)
-          thing.should be_a(Thing)
+          thing = subject.create(attrs)
+          thing.should be_a(subject)
           thing.should == {'name' => 'Foo', 'uri' => 'foo'}
         end
       end
@@ -298,8 +300,8 @@ describe Placid::Model do
       it "sets errors on the Model instance" do
         data = {'errors' => ['name is required']}
         RestClient.stub(:post => JSON(data))
-        thing = Thing.create()
-        thing.should be_a(Thing)
+        thing = subject.create()
+        thing.should be_a(subject)
         thing.errors.should == ['name is required']
       end
     end
@@ -309,25 +311,25 @@ describe Placid::Model do
         it "posted attributes if no attributes were returned" do
           RestClient.stub(:put => '{}')
           attrs = {'name' => 'Foo'}
-          result = Thing.update(1, attrs)
-          thing = Thing.update(1, attrs)
-          thing.should be_a(Thing)
+          result = subject.update(1, attrs)
+          thing = subject.update(1, attrs)
+          thing.should be_a(subject)
           thing.should == {'name' => 'Foo'}
         end
 
         it "returned attributes if no attributes were posted" do
           RestClient.stub(:put => '{"uri": "foo"}')
           attrs = {}
-          thing = Thing.update(1, attrs)
-          thing.should be_a(Thing)
+          thing = subject.update(1, attrs)
+          thing.should be_a(subject)
           thing.should == {'uri' => 'foo'}
         end
 
         it "original attributes merged with returned attributes" do
           RestClient.stub(:put => '{"uri": "foo"}')
           attrs = {'name' => 'Foo'}
-          thing = Thing.update(1, attrs)
-          thing.should be_a(Thing)
+          thing = subject.update(1, attrs)
+          thing.should be_a(subject)
           thing.should == {'name' => 'Foo', 'uri' => 'foo'}
         end
       end
@@ -335,8 +337,8 @@ describe Placid::Model do
       it "sets errors on the Model instance" do
         data = {'errors' => ['name is required']}
         RestClient.stub(:put => JSON(data))
-        thing = Thing.update(1, {})
-        thing.should be_a(Thing)
+        thing = subject.update(1, {})
+        thing.should be_a(subject)
         thing.errors.should == ['name is required']
       end
     end
@@ -345,7 +347,43 @@ describe Placid::Model do
       it "returns the parsed JSON response" do
         data = {'status' => 'ok'}
         RestClient.stub(:delete => JSON(data))
-        Thing.destroy(1).should == data
+        subject.destroy(1).should == data
+      end
+    end
+
+    describe "#coerce" do
+      before(:each) do
+        class User < Placid::Model
+        end
+        class Tweet < Placid::Model
+          coerce_key :user, 'user', User
+        end
+        @user_hash = {:email => 'foo@bar.com'}
+      end
+
+      it "coerces during initialization" do
+        pending("Awaiting release of https://github.com/intridea/hashie/issues/95")
+        tweet = Tweet.new({:message => "Hello", :user => @user_hash})
+        #tweet = Tweet.new('user' => @user_hash)
+        tweet.user.should be_a(User)
+      end
+
+      it "coerces using attribute reference" do
+        tweet = Tweet.new
+        tweet.user = @user_hash
+        tweet.user.should be_a(User)
+      end
+
+      it "coerces using string key" do
+        tweet = Tweet.new
+        tweet['user'] = @user_hash
+        tweet.user.should be_a(User)
+      end
+
+      it "coerces using symbolic key" do
+        tweet = Tweet.new
+        tweet[:user] = @user_hash
+        tweet.user.should be_a(User)
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: placid
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Eric Pierce
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-27 00:00:00 Z
+date: 2013-06-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hashie
@@ -25,10 +25,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7
         segments: 
+        - 2
         - 0
-        version: "0"
+        - 4
+        version: 2.0.4
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -151,9 +153,9 @@ files:
 - lib/placid/helper.rb
 - lib/placid/model.rb
 - placid.gemspec
-- spec/placid_config_spec.rb
-- spec/placid_helper_spec.rb
-- spec/placid_model_spec.rb
+- spec/placid/config_spec.rb
+- spec/placid/helper_spec.rb
+- spec/placid/model_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/a-e/placid
 licenses: []
@@ -184,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Models from REST