simple_params 0.0.2.pre8 → 0.0.2.pre9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjQ1MzU1MGIxNmU3ZTA4MGZhZGY5YTg4YjZmZTY0ZjI1NmE3MTU0OQ==
+    NDY4OWUwYTdkOTc5NmYwYjZlZjdjMmY3YzU4MWRkYWQ5ZGZlZWRhNQ==
   data.tar.gz: !binary |-
-    ZmRiNWQ0ZjEwYjVmOWEzM2IzNGVhNTc1NTM1ODRjN2VlNDMwYTMwMA==
+    MDI5OGEzYjEzODU3ODJmNDMxMmExYzc1NGZlOGEwZmYyODUxNjg2Mw==
 SHA512:
   metadata.gz: !binary |-
-    YmU0MzFlNTYwNDdkYTY2Y2YyOGFhYmJiZWJmZmQ1OTUyYWVjNDE5MjA2OWRl
-    ZmQzZjhlMDcxZTYxYzgxYzdkZjQwNzY0ZTJkNmIwNDE5NDdjMTRmYjYyMjMx
-    M2Y2NDJmZTIzYzczNDY2OTFkMzNjZjZjMmM2MzA3Yjk2MGNlOWI=
+    YTY3YTQzMTY2YzRlYTE0ZGRlM2FkNDJmNDdlYzI2Zjc5Mjg0NzQ5OWRlODE0
+    NTAzM2NlYWE0NDFiZWYyY2M5NGUyNmYxOWI4ZDhhN2VmOTAxNzdkNTQ0MTYw
+    NjNlNzE3YmFlNmM3NDkwMTQ1ZmFhZDQxMGRmM2ZjOTgxMTBhMTc=
   data.tar.gz: !binary |-
-    ZTg5MWUxNGFjY2VlMWNhMWNjN2EyNjRiZWI2MTEzMDgyOGIwODNjYTViNjI5
-    MzRjODdhNTYwMTc4ZThiY2Q4NmY3Njk3NWI5NDYwNjg4MmZlMmUyYzI2ODAw
-    ZjNjZWQ4NzQwZmIyZTlmYjEyOTJiNWQ1YjRiNjEzNzU2ODI4YTI=
+    MTBlZTQ0YTQ4NjNhODg1ZTE3NjJkY2E2ODAyOTRjZjQ5ZDE5NWI3ZjIxM2Nh
+    Mjg0MjdkNzI1MzRmZGRhNzhmYjZiNTk3YTZiOWUwNzg0N2NhMDQ2OWMxMjdi
+    NjU5NDg0YTU4NDQ3OGE1YjYxNGJmMGExYjkyNTdmNmUxMjAwYzA=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_params (0.0.2.pre7)
+    simple_params (0.0.2.pre8)
       activemodel (>= 3.0, < 5.0)
       virtus (>= 1.0.0)
 

data/README.md

@@ -88,12 +88,12 @@ params = MyParams.new(
 )
 
 params.valid? #=> false
-params.errors[:name] #=> ["can't be blank"] 
-params.errors[:address][:street] #=> ["can't be blank"] 
-params.address.errors[:street] #=> ["can't be blank"] 
+params.errors[:name] #=> ["can't be blank"]
+params.errors[:address][:street] #=> ["can't be blank"]
+params.address.errors[:street] #=> ["can't be blank"]
 
-params.errors.as_json #=> {:name=>["can't be blank"], :address=>{:street=>["can't be blank"]}} 
-params.address.errors.as_json #=> {:street=>["can't be blank"]}  
+params.errors.as_json #=> {:name=>["can't be blank"], :address=>{:street=>["can't be blank"]}}
+params.address.errors.as_json #=> {:street=>["can't be blank"]}
 ```
 
 ## Defaults
@@ -138,7 +138,7 @@ params = CoercionParams.new(name: "Bob", age: "21", date_of_birth: "June 1st, 19
 params.name #=> "Bob"
 params.age #=> 21
 params.date_of_birth #=> #<Date: 1980-06-01>
-params.pocket_change #=> #<BigDecimal:89ed240,'0.235E1',18(18)> 
+params.pocket_change #=> #<BigDecimal:89ed240,'0.235E1',18(18)>
 ```
 
 SimpleParams also provide helper methods for implicitly specifying the type, if you prefer that syntax.  Here is the same class as above, but redefined with these helper methods.
@@ -192,6 +192,40 @@ params.dog.name #=> "Bailey"
 params.dog.breed #=> "Shiba Inu"
 ```
 
+# ApiPie Documentation
+
+If your project is using [apipie-rails](http://example.com/ "apipie-rails"),
+then SimpleParams is able to automatically generate the documentation markup
+for apipie.
+
+```ruby
+api :POST, '/objects', "Create a object"
+eval(CreateObjectParams.api_pie_documentation)
+```
+
+Note that in your SimpleParams class you can specify a few options on how the markup will be
+created.
+
+They include:
+```ruby
+document: false # Will not document this parameter. Default is true
+optional: true # This parameter is not required. Default is false
+desc: 'description of parameter' # Default is blank
+```
+
+Example:
+
+```ruby
+class CreateObjectParams < SimpleParams::Params
+  param :user, type: User, document: false
+  param :name, type: :string, desc: 'Name of object', validations: { presence: true }
+
+  nested_hash :other_object do
+    param :color, optional: true, validations: { presence: true }
+    param :size, desc: 'Size of object', 'validations: { presence: true }
+  end
+end
+```
 
 ## Contributing
 
@@ -199,4 +233,4 @@ params.dog.breed #=> "Shiba Inu"
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/lib/simple_params/params.rb

@@ -132,6 +132,12 @@ module SimpleParams
       (defined_attributes.keys + nested_hashes.keys).flatten
     end
 
+    def original_params
+      @original_params ||= {}
+    end
+    alias_method :original_hash, :original_params
+    alias_method :raw_params, :original_params
+
     # Overriding this method to allow for non-strict enforcement!
     def method_missing(method_name, *arguments, &block)
       if strict_enforcement?
@@ -171,7 +177,18 @@ module SimpleParams
     end
 
     def hash_to_symbolized_hash(hash)
-      hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      hash.inject({}){|result, (key, value)|
+        new_key = case key
+                  when String then key.to_sym
+                  else key
+                  end
+        new_value = case value
+                    when Hash then hash_to_symbolized_hash(value)
+                    else value
+                    end
+        result[new_key] = new_value
+        result
+      }
     end
 
     def defined_attributes

data/lib/simple_params/version.rb

@@ -1,3 +1,3 @@
 module SimpleParams
-  VERSION = "0.0.2.pre8"
+  VERSION = "0.0.2.pre9"
 end

data/spec/acceptance_spec.rb

@@ -15,10 +15,29 @@ class AcceptanceParams < SimpleParams::Params
 end
 
 describe SimpleParams::Params do
+  describe "original_params", original_params: true do
+    it "returns symbolized params hash" do
+      params = AcceptanceParams.new(name: "Tom", address: { "street" => "1 Main St."} )
+      params.original_params.should eq({
+        name: "Tom", 
+        address: { 
+          street: "1 Main St."
+        }
+      })
+    end
+
+    it "returns symbolized params for nested_hash" do
+      params = AcceptanceParams.new(name: "Tom", address: { "street" => "1 Main St."} )
+      params.address.original_params.should eq({
+        street: "1 Main St."
+      })
+    end
+  end
+
   describe "accessors", accessors: true do
     let(:params) { AcceptanceParams.new }
 
-    it "has getter and setter methods for object param", failing: true do
+    it "has getter and setter methods for object param" do
       params.should respond_to(:reference)
       params.reference.should be_nil
       new_object = OpenStruct.new(count: 4)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre8
+  version: 0.0.2.pre9
 platform: ruby
 authors:
 - brycesenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel