sk_api_schema 0.1.2 → 0.2.0

data/CHANGELOG.rdoc

@@ -2,6 +2,14 @@
 
 A more detailed view of the changes can be found in the {commit messages}[https://github.com/salesking/sk_api_schema/commits/]
 
+2011-6
+* added language field to document, client, email-template
+* added filter[languages] for documents and clients, to search by one or more languages
+* added filter[client_ids] to documents, to search by one or multiple clients
+* added filter[ids] for documents, to find multiple specific documents
+* changed _delete property to _destroy for address, line_item
+* removed client_id requirement for documents 
+
 2011-05
 * new hash_clean method for ruby schema reader class
 

data/Gemfile

@@ -0,0 +1,8 @@
+source :gemcutter
+gem "rake"
+gem "rdoc"
+gem "rcov"
+gem "active_support"
+group :test do
+  gem "rspec"
+end

data/README.rdoc

@@ -44,16 +44,21 @@ parameter:
 
 Please try to only request the fields you really need, to save computing power!
 
-== Notice:
+== ToDo:
 
 Those relative urls in the link sections, need some love, so please don't rely on
 them to much right now.
 
-Especially within the next couple of weeks (until beginning of march) you will
-see bugfixes since more resources where made available.
-
 == Install
 
     gem install sk_api_schema
 
+== Test
+
+Before you run the tests use bundler to install all required gems:
+  # git clone
+  # cd into sk_api_schema dir
+  bundle install
+  bundle exec rake spec
+
 Copyright (c) 2010-2011 Georg Leciejewski, released under the MIT license

data/Rakefile

@@ -1,19 +1,21 @@
 require 'rubygems'
 require 'rake'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
 
 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.description = %Q{The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files.}
     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"
+    gem.add_development_dependency "rcov"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -23,22 +25,20 @@ 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"]
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
 end
 
 desc "Generate code coverage"
-Spec::Rake::SpecTask.new(:coverage) do |t|
-  t.spec_files = spec_files
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
   t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,/var/lib/gems']
+  t.rcov_opts = ['--exclude', 'spec']
 end
 
-desc 'Generate sk_api_activeresource documentation.'
+desc 'Generate documentation.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'SalesKing-Api JSON Schema'

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/json/v1.0/client.json

@@ -192,6 +192,11 @@
           "description": "Search by number where the number is matched from the start: %number",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A single or a list of language codes, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/credit_note.json

@@ -79,13 +79,13 @@
       "properties":{"$ref":"./attachment.json#properties"}
     },
     "client":{
-      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "description": "The client for the document. You cannot create a client through this, use client_id field to set it.",
       "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.",
+      "description": "The clients uuid. If a new client is assigned its language, address field, due days and cash discount are used if those fields are not set.",
       "type":"string"
     },
     "team_id":{
@@ -186,6 +186,21 @@
           "description": "All objects with date before the date",
           "type" :"date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/document.json

@@ -140,6 +140,21 @@
           "description": "All objects with date before the date",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/estimate.json

@@ -80,9 +80,8 @@
       "properties":{"$ref":"./client.json#properties"}
     },
     "client_id":{
-      "description": "The clients uuid, must be set for a new document. New estimates take the clients address field, due days and cash discount if those fields are not set.",
-      "type":"string",
-      "required":true
+      "description": "The clients uuid. If a new client is assigned its language, address field are used if those fields are not set.",
+      "type":"string"
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
@@ -172,6 +171,21 @@
           "description": "All objects with date before the date",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/invoice.json

@@ -85,9 +85,8 @@
       "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",
-      "required":true
+      "description": "The clients uuid. If a new client is assigned its language, address field, due days and cash discount are used if those fields are not set.",
+      "type":"string"
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
@@ -187,6 +186,21 @@
           "description": "All objects with date before the date",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/language.json

@@ -0,0 +1,76 @@
+{ "type":"object",
+  "title": "language",
+  "description": "A language in SK can be assigned to documents, contacts and templates. When creating new documents, emails or PDF the language is used to select a specific template or language agnostic defaults. A language has many translations.",
+  "properties":{
+    "id":{
+      "description": "uuid of the language.",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "code":{
+      "description": "Language short-code",
+      "type":"string"
+    },
+    "name":{
+      "description": "The name of the language, shown in the interface",
+      "type":"string",
+      "required":true
+    },   
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes afterwards",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "languages/{id}"
+    },
+    { "rel": "instances",
+      "href": "languages",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "per_page":{
+          "title" : "Per page",
+          "description": "Results per page. Default is 10, max is 100",
+          "type":"number"
+        },      
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => code",
+          "enum":["name","code", "created_at", "updated_at"],
+          "type": "string"
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "languages/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "languages/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "languages",
+      "method": "POST"
+    }
+  ]
+}

data/json/v1.0/order.json

@@ -71,7 +71,7 @@
       "properties":{"$ref":"./client.json#properties"}
     },
     "client_id":{
-      "description": "The clients uuid, must not be set for a new document. New docuents take the clients address field, due days and cash discount if client is present abd those fields are not set.",
+      "description": "The clients uuid. If a new client is assigned its language, address field are used if those fields are not set.",
       "type":"string"
     },
     "team_id":{
@@ -162,6 +162,21 @@
           "description": "All objects with date before the date",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/payment_reminder.json

@@ -70,13 +70,13 @@
       "properties":{"$ref":"./attachment.json#properties"}
     },
     "client":{
-      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "description": "The client for the document. Is assigned throught the related invoice",
       "readonly":true,
       "type":"object",
       "properties":{"$ref":"./client.json#properties"}
     },
     "client_id":{
-      "description": "The clients uuid. New payment_reminders take the clients address field, due days and cash discount if those fields are not set.",
+      "description": "The clients uuid. Is assigned throught the related invoice.",
       "type":"string"
     },
     "team_id":{
@@ -152,6 +152,21 @@
           "description": "All objects with date before the date",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/recurring.json

@@ -82,9 +82,8 @@
       "properties":{"$ref":"./client.json#properties"}
     },
     "client_id":{
-      "description": "The clients uuid, must be set for a new document. New recurrings take the clients address field, due days and cash discount if those fields are not set.",
-      "type":"string",
-      "required":true
+      "description": "The clients uuid. If a new client is assigned its language, address field, due days and cash discount are used if those fields are not set.",
+      "type":"string"
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
@@ -174,6 +173,21 @@
           "description": "All objects with date before the date",
           "type" : "date"
         },
+        "filter[languages]":{
+          "title" : "Languages",
+          "description": "A list of language codes, comma separated",
+          "type" : "string"
+        },
+        "filter[client_ids]":{
+          "title" : "Clients",
+          "description": "A single or a list of client uuids, comma separated",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Documents",
+          "description": "A single or a list of document uuids, comma separated",
+          "type" : "string"
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/lib/sk_api_schema.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'active_support'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/string/inflections'
@@ -180,4 +181,4 @@ module SK
       end # class methods
     end
   end
-end
+end

data/sk_api_schema.gemspec

@@ -5,18 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-06-03}
-  s.description = %q{SalesKing API JSON schema and utility methods}
+  s.date = %q{2011-06-27}
+  s.description = %q{The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files.}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
     "CHANGELOG.rdoc",
+    "Gemfile",
     "README.rdoc",
     "Rakefile",
     "VERSION",
@@ -34,6 +35,7 @@ Gem::Specification.new do |s|
     "json/v1.0/export.json",
     "json/v1.0/export_template.json",
     "json/v1.0/invoice.json",
+    "json/v1.0/language.json",
     "json/v1.0/line_item.json",
     "json/v1.0/order.json",
     "json/v1.0/payment.json",
@@ -58,15 +60,30 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<rdoc>, [">= 0"])
+      s.add_runtime_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<active_support>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

data/spec/sk_api_schema_spec.rb

@@ -1,10 +1,11 @@
-require 'spec/spec_helper'
+require 'spec_helper'
 
 describe SK::Api::Schema, 'reading' do
 
   before :each do
     SK::Api::Schema.registry_reset
   end
+  
   it "should read json schema file" do
     schema = SK::Api::Schema.read(:invoice, 'v1.0')
     schema[:title].should == 'invoice'
@@ -150,4 +151,4 @@ end
 
 class Client
   attr_accessor :id, :organisation, :last_name, :number, :addresses
-end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'rubygems'
-require 'spec'
+require 'rspec'
 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: 31
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,12 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 +02:00
+date: 2011-06-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +29,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  name: rake
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -44,9 +43,80 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  name: rdoc
   version_requirements: *id002
-description: SalesKing API JSON schema and utility methods
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: active_support
+  version_requirements: *id004
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id007
+  prerelease: false
+description: The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects. Besides ruby users can use a smal lib with utility methods to load and test the schema files.
 email: gl@salesking.eu
 executables: []
 
@@ -56,6 +126,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - CHANGELOG.rdoc
+- Gemfile
 - README.rdoc
 - Rakefile
 - VERSION
@@ -73,6 +144,7 @@ files:
 - json/v1.0/export.json
 - json/v1.0/export_template.json
 - json/v1.0/invoice.json
+- json/v1.0/language.json
 - json/v1.0/line_item.json
 - json/v1.0/order.json
 - json/v1.0/payment.json