placid 0.0.5 → 0.0.6

data/History.md

@@ -1,6 +1,12 @@
 Placid History
 ==============
 
+0.0.6
+-----
+
+- Rename #url to #get_url to avoid conflicts with `url` fields
+
+
 0.0.5
 -----
 

data/README.md

@@ -21,7 +21,7 @@ Define a subclass with the name of your REST model:
     class Person < Placid::Model
     end
 
-and you'll get these class methods, and their REST equivalents:
+and you'll get these class methods, and their REST equivalents, automatically:
 
     Person.list              # GET     /people
     Person.create(attrs)     # POST    /person      (attrs)
@@ -43,9 +43,10 @@ different field name, you can specify it like this:
       unique_id :email
     end
 
-The `Placid::Model` base class includes helper methods for basic HTTP requests.
-You can use these from any model instance, or call them from custom methods you
-define on your model. For example:
+The `Placid::Model` base class includes helper methods for basic HTTP requests,
+the most important of which is `request`. You can use these from any model
+instance, or call them from custom methods you define on your model. For
+example:
 
     class Person < Placid::Model
       unique_id :email
@@ -57,8 +58,12 @@ define on your model. For example:
 
     jenny = Person.new(:email => 'jenny@example.com')
 
+Now, calling this:
+
     jenny.add_phone('867-5309')
-    # Same as:
+
+Is the same as:
+
     jenny.request(:put, 'person', 'jenny@example.com', 'add_phone', '867-5309')
 
 
@@ -116,7 +121,8 @@ License
 
 The MIT License
 
-Copyright (c) 2012 Society for Human Resource Management
+Copyright (c) 2012 Eric Pierce, Automation Excellence, Society for Human
+Resource Management
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/placid/helper.rb

@@ -21,15 +21,15 @@ module Placid
     # URI-escaped.
     #
     # @example
-    #   url('people', 'eric') #=> 'http://localhost/people/eric'
-    #   url('a b', 'c:d')     #=> 'http://localhost/a%20b/c%3Ad'
+    #   get_url('people', 'eric') #=> 'http://localhost/people/eric'
+    #   get_url('a b', 'c:d')     #=> 'http://localhost/a%20b/c%3Ad'
     #
     # @param [Array] path
     #   Parts of the path to request. These will be escaped and joined with '/'.
     #
     # @return [String]
     #
-    def url(*path)
+    def get_url(*path)
       url = Placid::Config.rest_url.to_s.gsub(/\/$/, '')
       joined_path = path.map { |p| escape(p) }.join('/')
       return "#{url}/#{joined_path}"
@@ -62,7 +62,7 @@ module Placid
       method = method.to_sym
       params = path.extract_options!
       params = {:params => params} if method == :get
-      rest_url = url(*path)
+      rest_url = get_url(*path)
       begin
         response = RestClient.send(method, rest_url, params)
       rescue RestClient::Exception => e

data/lib/placid/model.rb

@@ -82,6 +82,7 @@ module Placid
 
     # Get or set the field name used for uniquely identifying instances of this
     # model.
+    #
     def self.unique_id(field=nil)
       if field.nil?
         return @unique_id || :id
@@ -104,7 +105,8 @@ module Placid
       end
     end
 
-    # Return a Model instance matching the given id
+    # Return a Model instance matching the given id. Sends a GET request to the
+    # REST API.
     #
     # @param [String] id
     #   Identifier for the model instance to fetch
@@ -116,7 +118,8 @@ module Placid
       return self.new(json)
     end
 
-    # Create a new model instance and return it.
+    # Create a new model instance and return it. Sends a POST request
+    # to the REST API.
     #
     # @param [Hash] attrs
     #   Attribute values for the new instance
@@ -130,7 +133,7 @@ module Placid
       return obj
     end
 
-    # Update an existing model instance.
+    # Update an existing model instance. Sends a PUT request to the REST API.
     #
     # @param [String] id
     #   Identifier of the model instance to update
@@ -146,7 +149,7 @@ module Placid
       return obj
     end
 
-    # Destroy a model instance.
+    # Destroy a model instance. Sends a DELETE request to the REST API.
     #
     # @param [String] id
     #   Identifier for the model instance to delete

data/placid.gemspec

@@ -1,8 +1,11 @@
 Gem::Specification.new do |s|
   s.name = "placid"
-  s.version = "0.0.5"
+  s.version = "0.0.6"
   s.summary = "Models from REST"
   s.description = <<-EOS
+    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.
   EOS
   s.authors = ["Eric Pierce"]
   s.email = "epierce@automation-excellence.com"

data/spec/placid_helper_spec.rb

@@ -7,13 +7,13 @@ describe Placid::Helper do
     end
   end
 
-  describe "#url" do
+  describe "#get_url" do
     it "joins path components with '/'" do
-      url('foo', 'bar', 'baz').should == 'http://localhost/foo/bar/baz'
+      get_url('foo', 'bar', 'baz').should == 'http://localhost/foo/bar/baz'
     end
 
     it "escapes path components to make them URI-safe" do
-      url('a b', 'c:d', 'e/f').should == 'http://localhost/a%20b/c%3Ad/e%2Ff'
+      get_url('a b', 'c:d', 'e/f').should == 'http://localhost/a%20b/c%3Ad/e%2Ff'
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: placid
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Eric Pierce
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-05 00:00:00 Z
+date: 2012-08-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hashie
@@ -129,7 +129,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id008
-description: ""
+description: "    Placid is an ActiveRecord-ish model using a REST API for storage. The REST API\n    can be any backend you choose or create yourself, provided it follows some basic\n    conventions.\n"
 email: epierce@automation-excellence.com
 executables: []