placid 0.0.4 → 0.0.5

data/.yardopts

@@ -1 +1,6 @@
 --markup markdown
+--readme README.md
+lib/**/*.rb
+-
+History.md
+

data/History.md

@@ -1,6 +1,13 @@
 Placid History
 ==============
 
+0.0.5
+-----
+
+- Raise JSONParseError on bad responses instead of returning {}
+- Add `data` attribute to JSONParseError to see what failed to parse
+
+
 0.0.4
 -----
 

data/lib/placid/exceptions.rb

@@ -1,6 +1,11 @@
 module Placid
   # Error parsing a JSON response
   class JSONParseError < RuntimeError
+    def initialize(message, data='')
+      super(message)
+      @data = data
+    end
+    attr_reader :data
   end
 
   # Error connecting to the REST API

data/lib/placid/helper.rb

@@ -51,7 +51,12 @@ module Placid
     #     Optional parameters to send in the request.
     #
     # @return [Hash]
-    #   Parsed response, or an empty hash if parsing failed
+    #   Parsed response
+    #
+    # @raise [RestConnectionError]
+    #   If there is a problem connecting to the REST API
+    # @raise [JSONParseError]
+    #   If the response from the REST API cannot be parsed as JSON
     #
     def request(method, *path)
       method = method.to_sym
@@ -68,7 +73,13 @@ module Placid
       rescue => e
         raise
       end
-      return JSON.parse(response) rescue {}
+      # Try to parse the response
+      begin
+        return JSON.parse(response)
+      rescue => e
+        raise JSONParseError.new(
+          "Cannot parse response from #{rest_url} as JSON", response)
+      end
     end
 
     # Send a GET to a path that returns a single JSON object, and return the

data/lib/placid/model.rb

@@ -96,7 +96,7 @@ module Placid
       @meta ||= get_mash(model, 'meta')
     end
 
-    # Return a Hashie::Mash with a list of all model instances.
+    # Return an array of Hashie::Mashes for all model instances.
     #
     def self.list
       return get_mashes(model.pluralize).map do |mash|

data/placid.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "placid"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
   s.summary = "Models from REST"
   s.description = <<-EOS
   EOS

data/spec/placid_helper_spec.rb

@@ -59,24 +59,31 @@ describe Placid::Helper do
       end.should raise_error(URI::InvalidURIError)
     end
 
-    it "returns an empty hash if there is no response" do
+    it "raises a JSONParseError if there is no response" do
       RestClient.stub(:get) { nil }
-      json = request('get')
-      json.should == {}
+      lambda do
+        json = request('get')
+      end.should raise_error(Placid::JSONParseError, /Cannot parse/)
     end
 
     it "accepts a params hash as the last argument" do
-      RestClient.should_receive(:post).with('http://localhost/foo', {:bar => 'hi'})
+      RestClient.should_receive(:post).
+        with('http://localhost/foo', {:bar => 'hi'}).
+        and_return('{}')
       json = request('post', 'foo', :bar => 'hi')
     end
 
     it "sends an empty params hash if none is given" do
-      RestClient.should_receive(:post).with('http://localhost/foo', {})
+      RestClient.should_receive(:post).
+        with('http://localhost/foo', {}).
+        and_return('{}')
       json = request('post', 'foo')
     end
 
     it "sends :params => params for get requests" do
-      RestClient.should_receive(:get).with('http://localhost/foo', {:params => {:x => 'y'}})
+      RestClient.should_receive(:get).
+        with('http://localhost/foo', {:params => {:x => 'y'}}).
+        and_return('{}')
       json = request('get', 'foo', :x => 'y')
     end
   end
@@ -89,10 +96,33 @@ describe Placid::Helper do
       }
       RestClient.stub(:get => JSON(data))
       mash = get_mash
+      mash.should be_a(Hashie::Mash)
       mash.first_name.should == 'Nathan'
       mash.last_name.should == 'Stark'
     end
 
+    it "returns nested Hashie::Mashes for nested hash data" do
+      data = {
+        'person' => {
+          'first_name' => 'Jack',
+          'last_name' => 'Carter',
+        },
+        'address' => {
+          'street' => '123 Main Street',
+          'city' => 'Eureka',
+        },
+      }
+      RestClient.stub(:get => JSON(data))
+      mash = get_mash
+      mash.should be_a(Hashie::Mash)
+      mash.person.should be_a(Hashie::Mash)
+      mash.person.first_name.should == 'Jack'
+      mash.person.last_name.should == 'Carter'
+      mash.address.should be_a(Hashie::Mash)
+      mash.address.street.should == '123 Main Street'
+      mash.address.city.should == 'Eureka'
+    end
+
     it "raises an exception when the JSON cannot be parsed" do
       data = ['a', 'b', 'c']
       RestClient.stub(:get => JSON(data))

data/spec/placid_model_spec.rb

@@ -168,7 +168,8 @@ describe Placid::Model do
       it "can call #request on an instance" do
         thing = Thing.new
         RestClient.should_receive(:get).
-          with('http://localhost/thing/foo', {:params => {:x => 'y'}})
+          with('http://localhost/thing/foo', {:params => {:x => 'y'}}).
+          and_return('{}')
         thing.request(:get, 'thing', 'foo', :x => 'y')
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: placid
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Eric Pierce
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-31 00:00:00 Z
+date: 2012-07-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hashie