sk_api_schema 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+nbproject/*
+coverage/*
+rdoc/*
+pkg/*

data/README.rdoc

@@ -0,0 +1,21 @@
+= SalesKing Api Schema
+
+SalesKing API description using JSON Schema(http://json-schema.org/)
+
+For ruby users this project provides a gem with some basic utility functions
+besides the schema. Other languages can take advantage of the raw json files.
+
+To get a fully working ruby client take a look at http://github.com/salesking/sk-api
+which will be replaced soon by a new gem at http://github.com/salesking/sk_api_activeresource
+
+
+Notice: This gem is still evolving and will be used actively by salesking to deliver the api soon. 
+Atm the JSON files are the most interesting stuff in here.
+
+== Install
+
+    gem install sk_api_schema
+
+== Usage
+
+Copyright (c) 2010 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sk_api_schema"
+    gem.summary = %Q{SalesKing API JSON Schema}
+    gem.description = %Q{SalesKing API JSON schema and utility methods}
+    gem.email = "gl@salesking.eu"
+    gem.homepage = "http://github.com/salesking/sk_api_schema"
+    gem.authors = ["Georg Leciejewski"]
+    gem.add_dependency 'activesupport'
+    gem.add_development_dependency "rspec"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Default: run specs.'
+task :default => :spec
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = ["-c"]
+end
+
+desc "Generate code coverage"
+Spec::Rake::SpecTask.new(:coverage) do |t|
+  t.spec_files = spec_files
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
+end
+
+desc 'Generate sk_api_activeresource documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SalesKing-Api JSON Schema'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/json/v1.0/address.json

@@ -0,0 +1,74 @@
+{"type":"object",
+  "title": "address",
+  "description":"An address",
+  "properties": {
+    "id": {
+      "description": "uuid of the adress.",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "city": {
+      "description": "City for the address. Must at least be present for an address.",
+      "type":"string"
+    },
+    "address1": {
+      "description": "Should contain the street or otherwise primary address information.",
+      "optional":true,
+      "type":"string"
+    },
+    "address2": {
+      "description": "Additional address information, like floor number",
+      "optional":true,
+      "type":"string"
+    },
+    "pobox": {
+      "description": "Post office box number",
+      "optional":true,
+      "type":"string"
+    },
+    "zip": {
+      "description": "Zip number of the city. Length must be between 4..10",
+      "optional":true,
+      "type":"string"
+    },
+    "state": {
+      "description": "Country state of address",
+      "optional":true,
+      "type":"string"
+    },
+    "country": {
+      "description": "Country of the address.",
+      "optional":true,
+      "type":"string"
+    },
+    "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"
+    },   
+    "address_type": {
+      "description": "Type of the address, as seen by vCard definition.",
+      "enum":["work","home"],
+      "optional":true,
+      "type":"string"
+    },
+    "lat": {
+      "description": "Geolocation latitude",
+      "optional":true,
+      "type":"string"
+    },
+    "long": {
+      "description": "Geolocation longitude",
+      "optional":true,
+      "type":"string"
+    },
+    
+  }
+}

data/json/v1.0/client.json

@@ -0,0 +1,169 @@
+{"type":"object",
+  "title": "client",
+  "description": "A client as seen by SalesKing",
+  "properties": {
+    "id": {
+      "identity":true,
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "number": {
+      "description": "Unique number, assigned from SK numbering scheme.",
+      "optional":true,
+      "type":"string"
+    },
+    "organisation": {
+      "description": "Name of a company. At least this or the lastname field must be filled for new records",
+      "type":"string"
+    },
+    "last_name": {
+      "description": "Last name of a person. At least this or the organisation field must be filled for new records",
+      "optional":true,
+      "type":"string"
+    },
+    "first_name": {
+       "description": "First name of a person.",
+      "optional":true,
+      "type":"string"
+    },
+    "gender": {
+      "description": "Can be empty for a company. Is used in salutation",
+      "optional":true,
+      "enum":["male", "female"],
+      "type":"string"
+    },
+    "position": {
+      "description": "Position of a person in a company.",
+      "optional":true,
+      "type":"string"
+    },
+    "title": {
+      "description": "Academical title of a person e.g. Dr., Prof",
+      "optional":true,
+      "type":"string"
+    },
+    "tax_number": {
+      "description": "Tax number, normaly applies to a private person",
+      "optional":true,
+      "type":"string"
+    },
+    "vat_number": {
+      "description": "VAT number, for a company or person paying value added taxes.",
+      "optional":true,
+      "type":"string"
+    },   
+    "email": {
+      "description": "Email address of the contact.",
+      "optional":true,
+      "type":"string"
+    },
+    "url": {
+      "description": "An url associated with the person, e.g its company website.",
+      "optional":true,
+      "type":"string"
+    },
+    "birthday": {
+      "format":"date",
+      "optional":true,
+      "type":"string"
+    },
+    "tag_list": {
+      "description": "Space seperated list of tags.",
+      "optional":true,
+      "type":"string"
+    },   
+    "created_at": {
+      "description": "Date the record was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at": {
+      "description": "Last date when the record was edited.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },    
+    "bank_number": {
+      "description": "Number of the bank",
+      "optional":true,
+      "type":"string"
+    },
+    "bank_name": {
+      "description": "Name of the bank.",
+      "optional":true,
+      "type":"string"
+    },
+    "bank_account_number": {
+      "description": "Number of the bank account.",
+      "optional":true,
+      "type":"string"
+    },
+    "bank_iban": {
+      "description": "IBAN Number of the bank account. Is validated",
+      "optional":true,
+      "type":"string"
+    },
+    "bank_swift": {
+      "description": "SWIFT BIC-  Bank Identifier Code",
+      "optional":true,
+      "type":"string"
+    },
+    "bank_owner": {
+      "description": "Owner of the bank account.",
+      "optional":true,
+      "type":"string"
+    },
+    "phone_fax": {
+      "description": "Fax number",
+      "optional":true,
+      "type":"string"
+    },
+    "phone_office": {
+      "description": "Office phone number",
+      "optional":true,
+      "type":"string"
+    },
+    "phone_home": {
+      "description": "Private phone number.",
+      "optional":true,
+      "type":"string"
+    },
+    "phone_mobile": {
+      "description": "Mobile phone number",
+      "optional":true,
+      "type":"string"
+    },
+    "lock_version": {
+      "description": "Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.",
+      "optional":true,
+      "readonly":true,
+      "type":"integer"
+    },
+    "cash_discount": {
+      "description": "Default cash discount for new invoices.",
+      "optional":true,
+      "type":"number"
+    },
+    "due_days": {
+      "description": "Default due days for new invoices.",
+      "optional":true,
+      "type":"integer"
+    },
+    "address_field": {
+      "description": "Returns the address field used on new docs. Consist of Organisation name and default(first) address",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "addresses": {
+      "description": "A client can have many addresses, sorted by date descending(new first). Default address is the most recent one.",
+      "optional":true,
+      "type":"array",
+      "properties" : {"$ref":"./addresses.json#properties"}
+    }
+  }
+}

data/json/v1.0/credit_note.json

@@ -0,0 +1,122 @@
+{ "type":"object",
+  "title": "credit note",
+  "description": "A credit note",
+  "properties":{
+    "id":{
+      "description": "UUID assigned by SK",
+      "identity":true,
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "number":{
+      "description": "Unique number assigned by SK credit note number schema. Auto-assigned when document is opened. Required unless doc status is draft.",
+      "optional":true,
+      "type":"string"
+    },
+    "address_field":{
+      "description": "Address field with the receiver. Shown in envelope window.",
+      "optional":true,
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the credit note is issued. Automatically set when document is opened. Required unless doc status is draft.",
+      "format":"date",
+      "optional":true,
+      "type":"string"
+    },
+    "due_days":{
+      "description": "Used to calculate the due date of the credit note. Useless if date and due date are present.",
+      "optional":true,
+      "type":"integer"
+    },
+    "due_date":{
+      "description": "Auto-calculated from date + due days if empty and the document is opened.",
+      "format":"date",
+      "optional":true,
+      "type":"string"
+    },
+    "status":{
+      "description": "A new document is always a draft unless otherwise stated. Only draft documents can be deleted. When a doc is opened it's number, date and due date are auto-set",
+      "optional":true,
+      "default":"draft",
+      "enum":["draft","open","closed"],
+      "type":"string"
+    },
+    "payment_method":{
+      "description": "How the document is beeing payed. Used in new payments.",
+      "optional":true,
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "type":"string"
+    },
+    "title":{
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your credit note [number]'",
+      "optional":true,
+      "type":"string"
+    },
+    "notes_before":{
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "optional":true,
+      "type":"string"
+    },
+    "notes_after":{
+      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
+      "optional":true,
+      "type":"string"
+    },
+    "tag_list": {
+      "description": "Space seperated list of tags.",
+      "optional":true,
+      "type":"string"
+    },
+    "client":{
+      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "optional":true,
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.json#properties"}
+    },
+    "client_id":{
+      "description": "The clients uuid, must be set for a new document. New documents take the clients address field, due days and cash discount if those fields are not set.",
+      "type":"string"
+    },
+    "line_items":{
+      "description": "Line items for the document",
+      "optional":true,
+      "type":"array",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes aftwerwards.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "lock_version":{
+      "description": "Auto-incremented by SK to prevent concurrent updateing. First save wins.",
+      "optional":true,
+      "readonly":true,
+      "type":"integer"
+    },
+    "price_total":{
+      "description": "Net total sum of all line items, 6 decimals places",
+      "optional":true,
+      "readonly":true,
+      "type":"number"
+    },
+    "price_tax":{
+      "description": "Summed up tax total of all line items, 2 decimals places",
+      "optional":true,
+      "readonly":true,
+      "type":"number"
+    }
+  }
+}

data/json/v1.0/invoice.json

@@ -0,0 +1,122 @@
+{ "type":"object",
+  "title": "invoice",
+  "description": "An invoice",
+  "properties":{
+    "id":{
+      "description": "UUID assigned by SK",
+      "identity":true,
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "number":{
+      "description": "Unique number assigned by SK invoice number schema. Auto-assigned when invoice is opened. Required unless doc status is draft.",
+      "optional":true,
+      "type":"string"
+    },
+    "address_field":{
+      "description": "Address field with the receiver. Shown in envelope window.",
+      "optional":true,
+      "type":"string"
+    },
+    "date":{
+      "description": "Date the invoice is issued. Automatically set when invoice is opened. Required unless doc status is draft.",
+      "format":"date",
+      "optional":true,
+      "type":"string"
+    },
+    "due_days":{
+      "description": "Used to calculate the due date of the invoice. Useless if date and due date are present.",
+      "optional":true,
+      "type":"integer"
+    },
+    "due_date":{
+      "description": "Auto-calculated from date + due days if empty and the invoice is opened.",
+      "format":"date",
+      "optional":true,
+      "type":"string"
+    },
+    "status":{
+      "description": "A new document is always a draft unless otherwise stated. Only draft invoices can be deleted. When a doc is opened it's number, date and due date are auto-set",
+      "optional":true,
+      "default":"draft",
+      "enum":["draft","open","closed"],
+      "type":"string"
+    },
+    "payment_method":{
+      "description": "How the invoce is beeing payed. Used in new payments.",
+      "optional":true,
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "type":"string"
+    },
+    "title":{
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your invoice [number]'",
+      "optional":true,
+      "type":"string"
+    },
+    "notes_before":{
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "optional":true,
+      "type":"string"
+    },
+    "notes_after":{
+      "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
+      "optional":true,
+      "type":"string"
+    },
+    "tag_list": {
+      "description": "Space seperated list of tags.",
+      "optional":true,
+      "type":"string"
+    },
+    "client":{
+      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "optional":true,
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.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"
+    },
+    "line_items":{
+      "description": "Line items for the document",
+      "optional":true,
+      "type":"array",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes aftwerwards.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "lock_version":{
+      "description": "Auto-incremented by SK to prevent concurrent updateing. First save wins.",
+      "optional":true,
+      "readonly":true,
+      "type":"integer"
+    },
+    "price_total":{
+      "description": "Net total sum of all line items, 6 decimals places",
+      "optional":true,
+      "readonly":true,
+      "type":"number"
+    },
+    "price_tax":{
+      "description": "Summed up tax total of all line items, 2 decimals places",
+      "optional":true,
+      "readonly":true,
+      "type":"number"
+    }
+  }
+}

data/json/v1.0/line_item.json

@@ -0,0 +1,73 @@
+{ "type":"object",
+  "title": "line item",
+  "description": "A line item for a document",
+  "properties":{
+    "id":{
+      "description": "uuid of the item.",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "position":{
+      "description": "Required since items are sorted by position.",
+      "type":"integer"
+    },
+    "name":{
+      "description": "The name of an item",
+      "optional":true,
+      "type":"string"
+    },
+    "description":{
+      "description": "Item description",
+      "optional":true,
+      "type":"string"
+    },
+    "price_single":{
+      "description": "Net price of a single item",
+      "type":"number"
+    },
+    "tax":{
+      "description": "Tax percent for a single item.",
+      "optional":true,
+      "type":"number"
+    },
+    "discount":{
+      "description": "Discount in percent applied to the items net total",
+      "optional":true,
+      "type":"number"
+    },
+    "quantity_unit":{
+      "description": "Unit like kg, days, month.",
+      "optional":true,
+      "type":"string"
+    },
+    "quantity":{
+      "description": "Quantity of the item.",
+      "type":"number"
+    },
+    "product_id":{
+      "description": "An item can reference a product by its uuid. See use_product",
+      "optional":true,
+      "type":"string"
+    },
+    "use_product":{
+      "description": "If set and product_id is present, the products name, description, quantity, unit, price are copied if the according item fields are missing.",
+      "optional":true,
+      "type":"integer"
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes aftwerwards",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "optional":true,
+      "readonly":true,
+      "type":"string"
+    }
+  }
+}

data/lib/sk_api_schema.rb

@@ -0,0 +1 @@
+require 'activesupport'

data/lib/utils/serializer.rb

@@ -0,0 +1,66 @@
+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/sk_api_schema.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sk_api_schema}
+  s.version = "0.0.1"
+
+  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.description = %q{SalesKing API JSON schema and utility methods}
+  s.email = %q{gl@salesking.eu}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "json/v1.0/address.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"
+  ]
+  s.homepage = %q{http://github.com/salesking/sk_api_schema}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{SalesKing API JSON Schema}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/utils/field_map_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/spec/spec_helper.rb

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

data/spec/utils/field_map_spec.rb

@@ -0,0 +1,73 @@
+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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: sk_api_schema
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: SalesKing API JSON schema and utility methods
+email: gl@salesking.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- json/v1.0/address.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
+has_rdoc: true
+homepage: http://github.com/salesking/sk_api_schema
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: SalesKing API JSON Schema
+test_files: 
+- spec/spec_helper.rb
+- spec/utils/field_map_spec.rb