placid 0.0.3 → 0.0.4

data/History.md

@@ -1,6 +1,13 @@
 Placid History
 ==============
 
+0.0.4
+-----
+
+- Remove get/post/put/delete convenience methods
+- Side effect: avoid Hashie::Mash doing unwanted `delete` calls
+
+
 0.0.3
 -----
 

data/README.md

@@ -5,6 +5,9 @@ Placid is an ActiveRecord-ish model using a REST API for storage. The REST API
 can be any backend you choose or create yourself, provided it follows some basic
 conventions.
 
+[Documentation is on rdoc.info.](http://rdoc.info/github/a-e/placid/master/frames)
+
+
 Installation
 ------------
 
@@ -48,7 +51,7 @@ define on your model. For example:
       unique_id :email
 
       def add_phone(phone_number)
-        put(model, id, 'add_phone', phone_number)
+        request(:put, model, id, 'add_phone', phone_number)
       end
     end
 
@@ -56,7 +59,56 @@ define on your model. For example:
 
     jenny.add_phone('867-5309')
     # Same as:
-    jenny.put('person', 'jenny@example.com', 'add_phone', '867-5309')
+    jenny.request(:put, 'person', 'jenny@example.com', 'add_phone', '867-5309')
+
+
+Model names
+-----------
+
+By default, Placid assumes that your REST pathnames use the `snake_case`
+version of your model's name. That is, if you have these models:
+
+    class Person < Placid::Model
+    end
+
+    class HomeAddress < Placid::Model
+    end
+
+then Placid will use these REST paths:
+
+    /person
+    /home_address
+
+To override this behavior for a single model, simply define the `model` class
+method. For instance, if the REST path for `HomeAddress` should be `addr`, do:
+
+    class HomeAddress < Placid::Model
+      def self.model
+        'addr'
+      end
+    end
+
+If you want to override this behavior for all models in your app, create a
+shared base class derived from `Placid::Model`, and override the `model` class
+method there. For example, if your REST paths use the exact `CamelCase` model
+name, you could do:
+
+    class Model < Placid::Model
+      def self.model
+        self.name
+      end
+    end
+
+    class Person < Model
+    end
+
+    class HomeAddress < Model
+    end
+
+This configuration will use REST paths like:
+
+    /Person
+    /HomeAddress
 
 
 License

data/lib/placid/helper.rb

@@ -43,7 +43,8 @@ module Placid
     #
     # @overload request(method, *path, params={})
     #   @param [String, Symbol] method
-    #     Request method to use ('get', 'post', 'put', 'delete', etc.)
+    #     Request method to use, as a string ('get', 'post', 'put', 'delete')
+    #     or symbol (:get, :post, :put, :delete)
     #   @param [Array] path
     #     Path components for the request
     #   @param [Hash] params
@@ -70,68 +71,6 @@ module Placid
       return JSON.parse(response) rescue {}
     end
 
-    # Send a GET request and return the parsed JSON response.
-    #
-    # @example
-    #   get('people', 'eric')
-    #   get('people', {:name => 'eric'})
-    #
-    # @overload get(*path, params={})
-    #   See {#request} for allowed parameters.
-    #
-    # @return [Hash]
-    #   Parsed response, or an empty hash if parsing failed
-    #
-    def get(*path)
-      request('get', *path)
-    end
-
-    # Send a POST request and return the parsed JSON response.
-    #
-    # @example
-    #   post('people', 'new', {:name => 'eric'})
-    #
-    # @overload post(*path, params={})
-    #   See {#request} for allowed parameters.
-    #
-    # @return [Hash]
-    #   Parsed response, or an empty hash if parsing failed
-    #
-    def post(*path)
-      request('post', *path)
-    end
-
-    # Send a PUT request and return the parsed JSON response.
-    #
-    # @example
-    #   put('people', 'eric', {:title => 'Developer'})
-    #
-    # @overload put(*path, params={})
-    #   See {#request} for allowed parameters.
-    #
-    # @return [Hash]
-    #   Parsed response, or an empty hash if parsing failed
-    #
-    def put(*path)
-      request('put', *path)
-    end
-
-    # Send a DELETE request and return the parsed JSON response.
-    #
-    # @example
-    #   delete('people', 'eric')
-    #   delete('people', {:name => 'eric'})
-    #
-    # @overload delete(*path, params={})
-    #   See {#request} for allowed parameters.
-    #
-    # @return [Hash]
-    #   Parsed response, or an empty hash if parsing failed
-    #
-    def delete(*path)
-      request('delete', *path)
-    end
-
     # Send a GET to a path that returns a single JSON object, and return the
     # result as a Hashie::Mash.
     #
@@ -141,7 +80,7 @@ module Placid
     # @return [Hashie::Mash]
     #
     def get_mash(*path)
-      json = get(*path)
+      json = request(:get, *path)
       begin
         return Hashie::Mash.new(json)
       rescue => e
@@ -159,7 +98,7 @@ module Placid
     # @return [Array]
     #
     def get_mashes(*path)
-      json = get(*path)
+      json = request(:get, *path)
       begin
         return json.map {|rec| Hashie::Mash.new(rec)}
       rescue => e

data/lib/placid/model.rb

@@ -112,7 +112,7 @@ module Placid
     # @return [Model]
     #
     def self.find(id)
-      json = get(model, id)
+      json = request(:get, model, id)
       return self.new(json)
     end
 
@@ -125,7 +125,7 @@ module Placid
     #
     def self.create(attrs={})
       obj = self.new(attrs)
-      json = post(model, attrs)
+      json = request(:post, model, attrs)
       obj.merge!(json)
       return obj
     end
@@ -141,7 +141,7 @@ module Placid
     #
     def self.update(id, attrs={})
       obj = self.new(attrs)
-      json = put(model, id, attrs)
+      json = request(:put, model, id, attrs)
       obj.merge!(json)
       return obj
     end
@@ -152,7 +152,7 @@ module Placid
     #   Identifier for the model instance to delete
     #
     def self.destroy(id)
-      delete(model, id)
+      request(:delete, model, id)
     end
 
   end

data/placid.gemspec

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

data/spec/placid_helper_spec.rb

@@ -18,6 +18,18 @@ describe Placid::Helper do
   end
 
   describe "#request" do
+    it "accepts a string for method" do
+      RestClient.stub(:get => '["success"]')
+      json = request('get')
+      json.should == ["success"]
+    end
+
+    it "accepts a symbol for method" do
+      RestClient.stub(:get => '["success"]')
+      json = request(:get)
+      json.should == ["success"]
+    end
+
     it "returns a legitimate response as JSON" do
       RestClient.stub(:get => '["success"]')
       json = request('get')
@@ -69,38 +81,6 @@ describe Placid::Helper do
     end
   end
 
-  describe "#get" do
-    it "sends a GET request to the given path" do
-      RestClient.should_receive(:get).
-        with('http://localhost/foo/bar', {:params => {:baz => 'hi'}})
-      get('foo', 'bar', :baz => 'hi')
-    end
-  end
-
-  describe "#post" do
-    it "sends a POST request to the given path" do
-      RestClient.should_receive(:post).
-        with('http://localhost/foo/bar', {:baz => 'hi'})
-      post('foo', 'bar', :baz => 'hi')
-    end
-  end
-
-  describe "#put" do
-    it "sends a PUT request to the given path" do
-      RestClient.should_receive(:put).
-        with('http://localhost/foo/bar', {:baz => 'hi'})
-      put('foo', 'bar', :baz => 'hi')
-    end
-  end
-
-  describe "#delete" do
-    it "sends a DELETE request to the given path" do
-      RestClient.should_receive(:delete).
-        with('http://localhost/foo/bar', {:baz => 'hi'})
-      delete('foo', 'bar', :baz => 'hi')
-    end
-  end
-
   describe "#get_mash" do
     it "returns a Hashie::Mash for hash data" do
       data = {

data/spec/placid_model_spec.rb

@@ -68,21 +68,21 @@ describe Placid::Model do
       it "returns false if errors were reported" do
         thing = Thing.new
         Thing.stub(:find => nil)
-        Thing.stub(:post => {'errors' => 'Missing id'})
+        Thing.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(:post => {'errors' => []})
+        Thing.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(:post => {})
+        Thing.stub(:request).with(:post, 'thing', {'id' => '123'}) { {} }
         thing.save.should be_true
       end
     end
@@ -165,11 +165,11 @@ describe Placid::Model do
     end
 
     describe "helpers" do
-      it "can call #get on an instance" do
+      it "can call #request on an instance" do
         thing = Thing.new
         RestClient.should_receive(:get).
           with('http://localhost/thing/foo', {:params => {:x => 'y'}})
-        thing.get('thing', 'foo', :x => 'y')
+        thing.request(:get, 'thing', 'foo', :x => 'y')
       end
     end
   end

metadata

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