sk_api_schema 0.0.1 → 0.0.2

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/json/v1.0/address.json

@@ -68,7 +68,6 @@
       "description": "Geolocation longitude",
       "optional":true,
       "type":"string"
-    },
-    
+    }
   }
 }

data/json/v1.0/attachment.json

@@ -0,0 +1,59 @@
+{ "type":"object",
+  "title": "attachment",
+  "description":"An file attachment",
+  "properties": {
+    "id": {
+      "description": "uuid of the object.",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "filename": {
+      "description": "The filename as set when uploaded",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "disk_filename": {
+      "description": "The filename as set by SK",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "url": {
+      "description": "File download url. Unique and valid for 15 minutes, public accessible.",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "content_type": {
+      "description": "Auto detected on upload. Might not always reflect the real content type",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "size": {
+      "description": "Filesize in kb. Auto detected on upload.",
+      "optional":true,
+      "readonly":true,
+      "type":"integer"
+    },
+    "is_signed": {
+      "description": "True if the file(pdf) has been digitally signed.",
+      "optional":true,
+      "type":"boolean"
+    },
+    "created_at": {
+      "description": "Date the object was created in SK. Never changes aftwerwards",
+      "format":"date-time",
+      "readonly":true, "type":"string"
+    },
+    "updated_at": {
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    }
+    
+  }
+}

data/json/v1.0/invoice.json

@@ -76,6 +76,13 @@
       "type":"object",
       "properties":{"$ref":"./client.json#properties"}
     },
+    "archived_pdf":{
+      "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
+      "optional":true,
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./attachment.json#properties"}
+    },
     "client_id":{
       "description": "The clients uuid, must be set for a new document. New invoices take the clients address field, due days and cash discount if those fields are not set.",
       "type":"string"

data/lib/sk_api_schema.rb

@@ -1 +1,65 @@
-require 'activesupport'
+require 'activesupport'
+
+module SK
+  module Api
+    class Schema
+
+      # Read a schema with a given version and return it as hash
+      # See ../json folder for available schema's and versions
+      # === Parameter
+      # schema<String|Symbol>::name of the schema, available ones are in json directory
+      # version<String>:: version to read, this is the folder name where the schema is in.
+      def self.read(schema, version)
+        file_path = File.join(File.dirname(__FILE__), '../json', version, "#{schema}.json")
+        plain_data = File.open(file_path, 'r'){|f| f.read}
+        ActiveSupport::JSON.decode(plain_data)
+      end
+
+      # Create a Hash with the available (api)object attributes defined in
+      # schema properties.
+      # 
+      # === Example
+      #  obj = Invoice.new(:title =>'hello world', :number=>'4711')
+      #  obj_hash = Sk::Api::Schema.to_hash_from_schema(obj, 'v1.0')
+      #
+      #  obj_hash => { invoice =>{'title'=>'hello world', 'number'=>'4711' } }
+      #
+      # === Parameter
+      # obj<Object>:. An ruby object which is returned as hash
+      # version<String>:. An ruby object which is returned as hash
+      # === Return
+      # <Hash{String=>{String=>Mixed}}>:: The object as hash:
+      # { invoice =>{'title'=>'hello world', 'number'=>''4711 } }
+      def self.to_hash_from_schema(obj, version)
+        # get objects class name without inheritance
+        obj_class_name =  obj.class.name.split('::').last.underscore
+        # init data hash
+        data = {}
+        # get schema
+        schema = self.read(obj_class_name, version)
+        # iterate over the defined schema fields
+        schema['properties'].each do |field, prop|
+          if prop['type'] == 'array'
+            # always set an empty array
+            data[field] = []
+            if rel_objects = obj.send( field )
+              rel_objects.each do |rel_obj|
+                # call related objects to_hash_from_schema method ex: data[:client][:addresses] << SKApi::Models::Address.to_hash_from_schema(object)
+                data[field] << self.to_hash_from_schema(rel_obj, version)
+              end
+            end
+          elsif prop['type'] == 'object'     # a singular related object
+            data[field] = nil
+            if rel_obj = obj.send( field )
+              data[field] = self.to_hash_from_schema(rel_obj, version)
+            end
+          else # a simple field is only added if objects know its
+            data[field] = obj.send(field) if obj.respond_to?(field.to_sym)
+          end
+        end        
+        { obj_class_name => data }
+      end
+
+    end
+  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.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2010-11-08}
+  s.date = %q{2010-11-11}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -21,15 +21,15 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "json/v1.0/address.json",
+     "json/v1.0/attachment.json",
      "json/v1.0/client.json",
      "json/v1.0/credit_note.json",
      "json/v1.0/invoice.json",
      "json/v1.0/line_item.json",
      "lib/sk_api_schema.rb",
-     "lib/utils/serializer.rb",
      "sk_api_schema.gemspec",
-     "spec/spec_helper.rb",
-     "spec/utils/field_map_spec.rb"
+     "spec/sk_api_schema_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/salesking/sk_api_schema}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   s.summary = %q{SalesKing API JSON Schema}
   s.test_files = [
     "spec/spec_helper.rb",
-     "spec/utils/field_map_spec.rb"
+     "spec/sk_api_schema_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/sk_api_schema_spec.rb

@@ -0,0 +1,76 @@
+require 'spec/spec_helper'
+
+describe SK::Api::Schema do
+
+  it "should read json schema file" do
+    schema = SK::Api::Schema.read(:invoice, 'v1.0')
+    schema['title'].should == 'invoice'
+    schema['type'].should == 'object'
+    schema['properties'].should be_a Hash
+    schema['properties']['id']['identity'].should be_true
+  end
+
+  it "should raise error if version folder does not exist" do
+    lambda{
+      SK::Api::Schema.read(:invoice, 'v3.0')
+    }.should raise_error    
+  end
+
+  it "should raise error if schema file does not exist" do
+    lambda{
+      SK::Api::Schema.read(:nope, 'v1.0')
+    }.should raise_error
+  end
+
+end
+
+describe SK::Api::Schema, 'object parsing' do
+
+  before :each do
+    @invoice =  Invoice.new
+    @invoice.id = 'some-uuid'
+    @invoice.title = 'Your Invoice'
+    @invoice.number = '911'
+
+    @client =  Client.new
+    @client.id = 'some-uuid'
+    @client.organisation = 'Dirty Food Inc.'
+    @client.number = '911'
+
+    @item =  LineItem.new
+    @item.id = 'some-uuid'
+    @item.name = 'Pork Chops'
+    @item.description = 'Yummi Pork chopped by mexian emigrants'
+    @item.position = 1
+    @item.price_single = 0.99
+  end
+
+
+  it "should parse object without relations from schema" do
+    obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
+    obj_hash.should == {"invoice"=>{"number"=>"911", "line_items"=>[], "title"=>"Your Invoice", "id"=>"some-uuid", "date"=>nil, "client"=>nil, "due_date"=>nil}}
+    client_obj_hash = SK::Api::Schema.to_hash_from_schema(@client, 'v1.0')
+    client_obj_hash.should == {"client"=>{"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}}
+  end
+
+  it "should parse object with relations from schema" do
+    @invoice.line_items = [@item]
+    @invoice.client = @client
+    obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
+    obj_hash.should == {"invoice"=>{"number"=>"911", "line_items"=>[{"line_item"=>{"position"=>1, "name"=>"Pork Chops", "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}], "title"=>"Your Invoice", "id"=>"some-uuid", "date"=>nil, "client"=>{"client"=>{"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}}, "due_date"=>nil}}
+  end
+
+end
+
+################################################################################
+# virtual classes used in test
+class Invoice
+  attr_accessor :id, :title, :description, :number, :date, :due_date, :line_items, :client
+end
+
+class LineItem
+  attr_accessor :id, :name, :description, :position, :price_single
+end
+class Client
+  attr_accessor :id, :organisation, :last_name, :number, :addresses
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'rubygems'
 require 'spec'
-#require "#{File.dirname(__FILE__)}/../lib/sk_api"
+require "#{File.dirname(__FILE__)}/../lib/sk_api_schema"
 #require File.dirname(__FILE__) + '/../vendor/jsonschema-1.0.0/lib/jsonschema'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 +01:00
+date: 2010-11-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,15 +60,15 @@ files:
 - Rakefile
 - VERSION
 - json/v1.0/address.json
+- json/v1.0/attachment.json
 - json/v1.0/client.json
 - json/v1.0/credit_note.json
 - json/v1.0/invoice.json
 - json/v1.0/line_item.json
 - lib/sk_api_schema.rb
-- lib/utils/serializer.rb
 - sk_api_schema.gemspec
+- spec/sk_api_schema_spec.rb
 - spec/spec_helper.rb
-- spec/utils/field_map_spec.rb
 has_rdoc: true
 homepage: http://github.com/salesking/sk_api_schema
 licenses: []
@@ -105,4 +105,4 @@ specification_version: 3
 summary: SalesKing API JSON Schema
 test_files: 
 - spec/spec_helper.rb
-- spec/utils/field_map_spec.rb
+- spec/sk_api_schema_spec.rb

data/lib/utils/serializer.rb

@@ -1,66 +0,0 @@
-module SKApi
-  module Utils
-    # Mixed into Resources::Base providing to_hash and to_json serialisation for
-    # SKApi Resources.
-    # Inside SalesKing this serialising is used to render the output.
-    # f.ex. in the clients api controller
-    #   => SKApi::Resources::Client.to_json(a_client)
-    # This way you can keep your API client up to date by using the resources and
-    # relying on  SKApi::Resources::Client.schema
-    module Serializer
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
-      module ClassMethods
-        
-        def schema_to_hash
-
-        end
-
-        # Create a Hash with the available (api)object attributes defined in api_fields.
-        #
-        # ==== Parameter
-        # obj<object>:. An ruby object which is returned as hash
-        def to_hash_from_schema(obj)
-          # first set the root node to the objects class name as symbol
-          obj_class_name =  obj.class.name.split('::').last.underscore
-#          obj_class_name = obj.class.to_s.underscore.to_sym
-          data = { obj_class_name => {} }
-          # iterate over the defined api fields hash
-          self.schema_props.each do |field, props| 
-            if props['type'] == 'array'
-              # always set the field, so the user can expect an empty array
-              data[obj_class_name][field] = []    
-              if rel_objects = obj.send( field )
-                rel_objects.each do |rel_obj|
-                  # setup scope for related class
-                  klass = "SKApi::Resources::#{rel_obj.class}".constantize
-                  # call related objects to_hash_from_schema method ex: data[:client][:addresses] << SKApi::Models::Address.to_hash_from_schema(object)
-                  data[obj_class_name][field] << klass.to_hash_from_schema(rel_obj)
-                end
-              end
-            elsif props['type'] == 'object'     # a singular resource TODO should we add an empty object?
-              if rel_obj = obj.send( field )
-                klass = "SKApi::Resources::#{rel_obj.class}".constantize
-                # ex: data['invoice']['client'] = SKApi::Models::Client.to_hash_from_schema(client)
-                data[obj_class_name][field] = klass.to_hash_from_schema(rel_obj)
-              end
-              else # a simple field which can be directly called, only added of objects know its
-              data[obj_class_name][field] = obj.send(field) if obj.respond_to?(field.to_sym)
-            end
-          end
-          data
-        end
-
-        def to_json(obj)
-          data = self.to_hash_from_schema(obj)
-#          data[:links] = self.api_links
-          ActiveSupport::JSON.encode(data)
-        end
-
-      end #ClassMethods
-
-    end #mixin
-  end #utils
-end #SKApi

data/spec/utils/field_map_spec.rb

@@ -1,73 +0,0 @@
-require 'spec/spec_helper'
-
-describe SKApi::Utils::FieldMap do
-
-  before :each do
-    @loc_obj = LocalContact.new
-    @rem_obj = RemoteContact.new()
-    @map = SKApi::Utils::FieldMap.new(@loc_obj, @rem_obj, map_hash)
-  end
-
-  it "should create a mapping" do    
-    @map.outdated?.should be_false # both objects are empty
-  end
-
-  it "should find outdated fields" do      
-    @loc_obj.firstname = 'theo'
-    @map.outdated?.should be_true
-    @map.outdated.first[:loc_key].should == :firstname    
-  end
-
-  it "should update outdated remote fields" do
-    @loc_obj.firstname = 'theo'
-    @map.update_remote_outdated
-    @rem_obj.first_name.should == @loc_obj.firstname
-    # test logging
-   @map.log.should_not be_empty
-  end
-
-  it "should update outdated local fields" do
-    @rem_obj.first_name = 'Heinz'
-    @map.update_local_outdated
-    @rem_obj.first_name.should == @loc_obj.firstname
-    @map.log.length.should == 1
-  end
-#  it "should update outdated local fields" do
-#    @rem_obj.first_name = 'Heinz'
-#    @map.outdated?
-#    @map.update_local_outdated
-#    @rem_obj.first_name.should == @loc_obj.firstname
-#  end
-
-  def map_hash
-    [
-      {:loc_key => :firstname,  :rem_key => :first_name},
-      {:loc_key => :street,     :rem_key => :address1},
-      {:loc_key => :postcode,   :rem_key => :zip},
-      {:loc_key => :city,       :rem_key => :city},
-      {:loc_key => :gender,     :rem_key => :gender, :trans => { :obj=>'TransferFunctions',
-                                                                :loc_trans => 'set_local_gender',
-                                                                :rem_trans => 'set_remote_gender'}
-      }
-    ]
-  end
-
-end
-
-class RemoteContact
-  attr_accessor :first_name, :address1, :zip, :city, :gender
-end
-class LocalContact
-  attr_accessor :firstname, :street, :postcode, :city, :gender
-end
-
-class TransferFunctions
-  def self.set_local_gender(remote_val)
-    return 'male' if remote_val == 'm'
-    return 'female' if remote_val == 'f'
-  end
-  def self.set_remote_gender(local_val)
-    return 'm' if local_val == 'male'
-    return 'f' if local_val == 'female'
-  end
-end