sk_api_schema 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -2,6 +2,9 @@
 
 A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
 
+2011-05
+* new hash_clean method for ruby schema reader class
+
 2011-04
 * added tags
 * added documents

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/sk_api_schema.rb

@@ -149,6 +149,34 @@ module SK
           links.empty? ? nil : links
         end
 
+        # Clean a hash before a new object is created from it. Can be used in
+        # your ruby controllers where new objects are created from a params-hash
+        # Directly operates and CHANGES incoming properties-hash!
+        #
+        # === Parameter
+        # obj_name<String>:: name of the object/schema
+        # props<Hash{String|Symbol=>Mixed}>:: properties of the object as hash
+        # version<String>:: api version
+        # opts<Hash{Symbol=>Mixed}>:: additional options
+        # === Param opts
+        # :keep<Array[String]>:: properties not being kicked even if defined as
+        # readonly
+        def clean_hash!(obj_name, props, version, opts={})
+          # gather allowed properties
+          schema = SK::Api::Schema.read(obj_name, version)
+          setters = []
+          schema['properties'].each{ |k,v| setters << k if !v['readonly'] }
+          setters += opts[:keep] if opts[:keep] && opts[:keep].is_a?(Array)
+          # kick readonly
+          props.delete_if { |k,v| !setters.include?("#{k}")  }
+          #convert to type in schema 
+          props.each do |k,v|
+            if schema['properties']["#{k}"]['type'] == 'string' && !v.is_a?(String)
+             props[k] = "#{v}"
+            end
+          end
+        end
+
       end # class methods
     end
   end

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-04-28}
+  s.date = %q{2011-05-02}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [

data/spec/sk_api_schema_spec.rb

@@ -1,6 +1,6 @@
 require 'spec/spec_helper'
 
-describe SK::Api::Schema do
+describe SK::Api::Schema, 'reading' do
 
   before :each do
     SK::Api::Schema.registry_reset
@@ -111,6 +111,33 @@ describe SK::Api::Schema, 'object parsing' do
   end
 end
 
+describe SK::Api::Schema, 'hash cleaning' do
+
+  it "should kick readonly properties" do
+    props = {'id'=>'some id', 'archived_pdf'=>'some val', 'number'=>'1234' }
+    SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0')
+    props.keys.should == ['number']
+
+    props1 = {:id =>'some id', :archived_pdf =>'some val', :number =>'1234' }
+    SK::Api::Schema.clean_hash!(:invoice, props1, 'v1.0')
+    props1.keys.should == [:number]
+  end
+
+  it "should convert string properties" do
+    props = {'title'=>4711, 'number'=>1234 }
+    SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0')
+    props['title'].should == "4711"
+    props['number'].should == "1234"
+  end
+
+  it "should keep some properties" do
+    props = {'id'=>'some id', 'number'=>1234 }
+    SK::Api::Schema.clean_hash!(:invoice, props, 'v1.0', :keep=>['id'])
+    props['id'].should == "some id"
+  end
+
+end
+
 ################################################################################
 # virtual classes used in test
 class Invoice
@@ -120,6 +147,7 @@ end
 class LineItem
   attr_accessor :id, :name, :description, :position, :price_single
 end
+
 class Client
   attr_accessor :id, :organisation, :last_name, :number, :addresses
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 +02:00
+date: 2011-05-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency