sk-api 1.0.0

data/lib/utils/serializer.rb

@@ -0,0 +1,62 @@
+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.api_fields
+    module Serializer
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        # Create a Hash with the available (api)object attributes defined in api_fields.
+        #
+        # ==== Parameter
+        # obj<object>:. An 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
+              data[obj_class_name][field] = obj.send(field)
+            end
+          end
+          data
+        end
+
+        def to_json(obj)
+          data = self.to_hash_from_schema(obj)
+#          data[:links] = self.api_links
+          Rufus::Json.encode(data)
+        end
+
+      end #ClassMethods
+
+    end #mixin
+  end #utils
+end #SKApi

data/lib/version.rb

@@ -0,0 +1,9 @@
+module SKApi
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/resources/client_spec.rb

@@ -0,0 +1,111 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe SKApi::Resources::Client, "in general" do
+
+  before :all do
+    #setup test client to work with
+    @client = SKApi::Resources::Client.new(:organisation=>'from testing API2')
+    @client.save
+  end
+
+  after :all do
+    #delete test client
+    @client.destroy
+    lambda {
+      client = SKApi::Resources::Client.find(@client.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  end
+
+  it "should create a client" do
+    @client.number.should_not be_nil
+    @client.new?.should be_false
+  end
+
+  it "should fail create a client" do
+    client = SKApi::Resources::Client.new(:organisation=>'from testing API2')
+    client.bank_iban = 'safasf'
+    client.save.should == false
+    client.errors.count.should == 1
+    client.errors.full_messages.should ==  ["Bank iban is invalid"]
+  end
+
+  it "should find a client" do
+    client = SKApi::Resources::Client.find(@client.id)
+    client.organisation.should == @client.organisation
+  end
+
+  it "should edit a client" do
+    @client.first_name = 'Theodore'
+    @client.gender = 'male'
+    @client.lock_version.should == 0
+    @client.save
+    @client.lock_version.should == 1 # because save returns the data
+  end
+
+  it "should fail edit a client" do
+    @client.last_name = ''
+    @client.organisation = ''
+    @client.save.should == false
+    @client.errors.count.should == 1
+    @client.errors.on_base.should ==  "<p>clients.errors.fill_name_or_organisation</p>"
+  end
+
+  it "should validate raw json object with schema" do
+    client = SKApi::Resources::Client.find(@client.id)
+    # convert to json and read raw without activeresource assigning classes
+    json = client.to_json
+    obj = Rufus::Json.decode(json)
+    lambda {
+      JSON::Schema.validate(obj,  SKApi::Resources::Client.schema)
+    }.should_not raise_error
+  end
+
+  it "should validate raw json object with to_hash_with_schema" do
+    client = SKApi::Resources::Client.find(@client.id)
+    # convert to json and read raw without activeresource assigning classes
+    hash_obj =  SKApi::Resources::Client.to_hash_from_schema(client)
+#    hash_obj.should == ''
+    lambda {
+      JSON::Schema.validate(hash_obj['client'],  SKApi::Resources::Client.schema)
+    }.should_not raise_error
+  end
+
+end
+
+describe SKApi::Resources::Client, "with addresses" do
+
+  before :all do
+    #setup test client to work with
+    @client = SKApi::Resources::Client.new(:organisation=>'Second from testing API2',
+                                            :addresses => [{ :zip => '50374', :city => 'Cologne' }] )
+    @client.save
+  end
+
+  after :all do
+    @client.destroy
+    lambda {
+      client = SKApi::Resources::Client.find(@client.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  end
+
+  it "should create an address" do
+    @client.addresses.length.should == 1
+    @client.addresses.first.zip.should == '50374'
+  end
+
+  it "should edit an address" do
+    @client.addresses[0].zip = '40001'
+    @client.save
+    @client.addresses.length.should == 1
+    @client.addresses.first.zip.should == '40001'
+  end
+
+  it "should add an address" do
+    adr = SKApi::Resources::Address.new( { :zip => '50374', :city => 'Cologne' } )
+    @client.addresses << adr
+    @client.save
+    @client.addresses.length.should == 2
+#    @client.addresses[0].zip = '40001'
+#    @client.addresses.[1].zip.should == '40001'
+  end
+end

data/spec/resources/credit_note_spec.rb

@@ -0,0 +1,116 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe SKApi::Resources::CreditNote, "in general" do
+
+  before :all do
+    #setup test doc to work with
+    # create client
+    @client = SKApi::Resources::Client.new(:organisation=>'Credit Note API-Tester')
+    @client.save.should be_true
+    @doc = SKApi::Resources::CreditNote.new()
+    @doc.title = 'A Document from the API'
+    @doc.client_id = @client.id
+    @doc.save.should be_true
+  end
+
+  after :all do
+    #delete test doc
+    @doc.destroy
+    @client.destroy
+    lambda {
+      doc = SKApi::Resources::CreditNote.find(@doc.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+    lambda {
+      client = SKApi::Resources::Client.find(@client.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  end
+
+  it "should create a doc" do
+    @doc.errors.should be_empty
+    @doc.new?.should be_false
+  end
+
+  it "should fail create a doc" do
+    doc = SKApi::Resources::CreditNote.new()
+    doc.save.should == false
+    doc.errors.count.should == 1
+    doc.errors.on(:client_id).should == "can't be blank"
+  end
+
+  it "should find a doc" do
+    doc = SKApi::Resources::CreditNote.find(@doc.id)
+    doc.title.should == @doc.title
+  end
+
+  it "should validate raw json object with schema" do
+    doc = SKApi::Resources::CreditNote.find(@doc.id)
+#    doc.number.should=='23'
+    # convert to json and read raw without activeresource assigning classes
+    json = doc.to_json    
+    obj = Rufus::Json.decode(json)
+    lambda {
+      JSON::Schema.validate(obj,  SKApi::Resources::CreditNote.schema)
+    }.should_not raise_error
+  end
+
+  it "should edit a doc" do
+#    @doc.lock_version.should == 0 # dont work cause doc is saved twice, for recalc of totals
+    old_lock_version = @doc.lock_version
+    @doc.notes_before = 'You will recieve the amout of:'
+    @doc.notes_before = 'Payment made to you bank Account'
+    @doc.title = 'Changed doc title'
+    
+    @doc.save.should be_true
+    @doc.lock_version.should > old_lock_version # because save returns the data
+  end
+
+  it "should fail edit a doc" do
+    @doc.client_id = ''
+    @doc.save.should == false
+    @doc.errors.count.should == 1
+    @doc.errors.on(:client_id).should == "can't be blank"
+  end
+end
+
+describe SKApi::Resources::CreditNote, "with line items" do
+
+  before :all do
+    @client = SKApi::Resources::Client.new(:organisation=>'Credit Note API-Tester')
+    @client.save.should be_true
+    #setup test doc to work with
+    @doc = SKApi::Resources::CreditNote.new(:client_id => @client.id,
+                                            :line_items => [{ :position=>1, :description => 'Pork Chops', :quantity => 12, :price_single =>'10.00' }] )
+    @doc.save.should be_true
+  end
+
+  after :all do
+    @client.destroy #also destroys all docs
+#    @doc.destroy
+    lambda {
+      doc = SKApi::Resources::CreditNote.find(@doc.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  end
+
+  it "should create a line item" do
+    @doc.line_items.length.should == 1
+    @doc.line_items.first.description.should == 'Pork Chops'
+    @doc.price_total.should == 120.0
+  end
+
+  it "should edit line item" do
+    @doc.line_items[0].description = 'Egg Sandwich'
+    @doc.save
+    @doc.line_items.length.should == 1
+    @doc.line_items.first.description.should == 'Egg Sandwich'
+  end
+
+  it "should add line item" do
+    item = SKApi::Resources::LineItem.new( {  :position=>2, :description => 'Goat-Pie', :price_single => 10, :quantity=>10} )
+    @doc.line_items << item
+    @doc.save
+    @doc.line_items.length.should == 2
+    @doc.price_total.should == 220.0
+#    @doc.line_items[0].zip = '40001'
+#    @doc.line_items.[1].zip.should == '40001'
+  end
+end

data/spec/resources/product_spec.rb

@@ -0,0 +1,77 @@
+require "#{File.dirname(__FILE__)}/../spec_helper"
+
+describe SKApi::Resources::Product, "in general" do
+
+  before :all do
+    #setup test product to work with
+    @product = SKApi::Resources::Product.new(:name=>'Eis am Stiel', :price => 1.50)
+    @product.save.should be_true
+  end
+
+  after :all do
+    #delete test product
+    @product.destroy
+    lambda {
+      product = SKApi::Resources::Product.find(@product.id)
+    }.should raise_error(ActiveResource::ResourceNotFound)
+  end
+
+  it "should create a product" do
+    @product.number.should_not be_nil
+    @product.price.should == 1.50
+    @product.new?.should be_false
+  end
+
+  it "should fail create a product without name" do
+    product = SKApi::Resources::Product.new(:price => 2.50)
+    product.save.should == false
+    product.errors.count.should == 1
+    product.errors.full_messages.should ==  ["Name can't be blank"]
+  end
+  
+  it "should create a product with price 0.0 when price is missing" do
+    product = SKApi::Resources::Product.new(:name => 'No brain')
+    product.save
+#    product.save.should == false
+    product.price.should == 0.0
+  end
+
+  it "should find a product by id" do
+    product = SKApi::Resources::Product.find(@product.id)
+    product.name.should == @product.name
+  end
+
+  it "should edit a product" do
+    @product.name = 'A new product name'
+    @product.lock_version.should == 0
+    @product.save
+    @product.lock_version.should == 1 # because save returns the data
+  end
+
+  it "should fail edit a product" do
+    @product.name = ''
+    @product.save.should == false
+    @product.errors.count.should == 1
+    @product.errors.on(:name).should ==  "can't be blank"
+  end
+
+  it "should validate raw json object with schema" do
+    product = SKApi::Resources::Product.find(@product.id)
+    # convert to json and read raw without activeresource assigning classes
+    json = product.to_json
+    obj = Rufus::Json.decode(json)
+    lambda {
+      JSON::Schema.validate(obj,  SKApi::Resources::Product.schema)
+    }.should_not raise_error
+  end
+
+  it "should validate raw json object with to_hash_with_schema" do
+    product = SKApi::Resources::Product.find(@product.id)
+    # convert to json and read raw without activeresource assigning classes
+    hash_obj =  SKApi::Resources::Product.to_hash_from_schema(product)
+#    hash_obj.should == ''
+    lambda {
+      JSON::Schema.validate(hash_obj['product'],  SKApi::Resources::Product.schema)
+    }.should_not raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'spec'
+require "#{File.dirname(__FILE__)}/../lib/sk_api"
+
+##
+SKApi::CONNECTION = {
+    :site => "http://demo.salesking.local:3000/api/",
+    :user => "demo@salesking.eu",
+    :password => "demo",
+    :format => :json
+  }
+SKApi::Resources::Base.set_connection(SKApi::CONNECTION)

data/spec/utils/field_map_spec.rb

@@ -0,0 +1,73 @@
+require "#{File.dirname(__FILE__)}/../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

data/tasks/sk_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sk_api_base do
+#   # Task goes here
+# end

data/vendor/jsonschema-1.0.0/README.rdoc

@@ -0,0 +1,94 @@
+= Ruby/jsonschema
+
+* http://github.com/Constellation/jsonchema
+
+== DESCRIPTION:
+
+json schema library ruby porting
+from http://code.google.com/p/jsonschema/
+
+== SYNOPSIS:
+ruby code
+  require 'jsonschema'
+  schema = {
+    "type" => "object",
+     "properties" => {
+      "prop01" => {
+        "type" => "number",
+        "maximum" => 10
+      },
+      "prop02" => {
+        "type" => "integer",
+        "maximum" => 20
+      }
+    }
+  }
+  data = {
+    "prop01"=> 5,
+    "prop02"=> 10
+  }
+  JSON::Schema.validate(data, schema)
+
+if you have json library
+  require 'json'
+  require 'jsonschema'
+  schema = File.open("path/to/schema.json", "rb"){|f| JSON.parse(f.read)}
+  data   = File.open("path/to/data.json",   "rb"){|f| JSON.parse(f.read)}
+  JSON::Schema.validate(data, schema)
+
+== INSTALL:
+
+  gem source -a http://gemcutter.org
+  sudo gem install jsonschema
+
+== LICENSE:
+
+Ruby/jsonschema
+(The MIT License)
+
+Copyright (c) 2009 Constellation
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+jsonschema
+http://code.google.com/p/jsonschema/
+(The MIT License)
+
+Copyright (c) 2008 Ian Lewis, Yusuke Muraoka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/vendor/jsonschema-1.0.0/Rakefile

@@ -0,0 +1,94 @@
+# vim: fileencoding=utf-8
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+require 'lib/jsonschema'
+include FileUtils
+
+$version = JSON::Schema::VERSION
+$readme = 'README.rdoc'
+$rdoc_opts = %W(--main #{$readme} --charset utf-8 --line-numbers --inline-source)
+$name = 'jsonschema'
+$github_name = 'ruby-jsonschema'
+$summary = 'json schema library ruby porting from http://code.google.com/p/jsonschema/'
+$author = 'Constellation'
+$email = 'utatane.tea@gmail.com'
+$page = 'http://github.com/Constellation/ruby-jsonchema/tree/master'
+#$exec = %W(jsonschema)
+$rubyforge_project = 'jsonschema'
+
+
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = $name
+  s.version = $version
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = [$readme]
+  s.rdoc_options += $rdoc_opts
+  s.summary = $summary
+  s.description = $summary
+  s.author = $author
+  s.email = $email
+  s.homepage = $page
+  s.executables = $exec
+  s.rubyforge_project = $rubyforge_project
+#  s.bindir = 'bin'
+  s.require_path = 'lib'
+  s.test_files = Dir["test/*_test.rb"]
+#  {
+#  }.each do |dep, ver|
+#    s.add_dependency(dep, ver)
+#  end
+  s.files = %w(README.rdoc Rakefile) + Dir["{bin,test,lib}/**/*"]
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.options += $rdoc_opts
+#  rdoc.template = 'resh'
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb", "ext/**/*.c")
+end
+
+desc "gem spec"
+task :gemspec do
+  File.open("#{$github_name}.gemspec", "wb") do |f|
+    f << spec.to_ruby
+  end
+end
+
+desc "gem build"
+task :build => [:gemspec] do
+  sh "gem build #{$github_name}.gemspec"
+end
+
+desc "gem install"
+task :install => [:build] do
+  sh "sudo gem install #{$name}-#{$version}.gem --local"
+end
+
+desc "gem uninstall"
+task :uninstall do
+  sh "sudo gem uninstall #{$name}"
+end
+# vim: syntax=ruby