sk_api_schema 0.0.16 → 0.0.17

data/VERSION

@@ -1 +1 @@
-0.0.16
+0.0.17

data/json/v1.0/company.json

@@ -1,6 +1,6 @@
-{"type":"object",
+{ "type":"object",
   "title": "company",
-  "description": "A company is the main entity. Any data is retrieved scoped to the current company, identified by the subdomain.",
+  "description": "A company is the main entity, so any data belongs to a company, identified by the current subdomain.",
   "properties": {
     "id": {
       "identity":true,
@@ -101,8 +101,8 @@
   },
   
   "links":[
-    { "rel": "self",
-      "href": "companies"
+    { "rel": "current",
+      "href": "companies/current"
     }
   ]
 }

data/json/v1.0/sub.json

@@ -0,0 +1,59 @@
+{"type":"object",
+  "title": "sub",
+  "description": "Subscribe to push notifications(webhooks) about object livecycle events like new, update or delete. Only returns subscription for the current app, so you MUST be using oAuth. When a user removes your app its subs are also deleted. <br/>To register you must supply <br/>- callback_url: receives the object in it's latest state, the user_id & subdomain, company_id, hmac-signed with your app secret.<br/>- channel: defining the event, made up of the SINGULAR object name and the action: invoice.delete, payment.new<br/> - register auth_permissions: An app MUST request non-api permissions f.ex.: clients:create. Perms(on company,app,user,team) are checked before any publishing, so if a user cannot create clients in the interface, his apps will not receive any callbacks.",
+  "properties": {
+    "id": {
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "channel": {
+      "description": "The channel to which to subscribe. See available at subs/channels.",
+      "required":true,
+      "type":"string"
+    },
+    "callback_url": {
+      "description": "An url receiving the notification. The url MUST be within the url of the current app",
+      "type":"string",
+      "required":true
+    },   
+    "method": {
+      "description": "HTTP method used for the request, defaults to POST",
+      "type":"string",
+      "default":"POST",
+      "enum":["POST","GET", "DELETE", "PUT"]
+    },
+    "created_at": {
+      "description": "Date the record was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at": {
+      "description": "Last date when the record was edited.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    }
+  },
+  
+  "links":[
+    { "rel": "self",
+      "href": "{id}"
+    },
+    { "rel": "instances",
+      "href": "subs/"
+    },
+    { "rel": "destroy",
+      "href": "subs/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "subs/{id}",
+      "method": "PUT"
+    },
+    { "rel": "subs/channels",
+      "href": "subs/channels"
+    }
+  ]
+}

data/lib/sk_api_schema.rb

@@ -5,6 +5,19 @@ module SK
     class Schema
 
       class << self
+
+        # class var remembering already read-in schema's
+        # {
+        #   'v1.0'=>{
+        #     'invoice'=>{schema}
+        #     'credit_note'=>{schema}
+        #   }
+        # }
+        # === Return
+        #<Hash>::
+        def registry
+          @registry ||={}
+        end
         # Read a schema with a given version and return it as hash
         # See ../json folder for available schema's and versions
         # === Parameter
@@ -13,11 +26,15 @@ module SK
         # === Return
         # <HashWithIndifferentAccess>:: schema as hash
         def read(schema, version)
+          return registry[version][schema] if registry[version] && registry[version][schema]
           # prefix version with v1.0 of v is not present
           v = (version =~ /^v/) ? version : "v#{version}"
+          registry[v] = {} unless registry[v]
+          # read schema from file
           file_path = File.join(File.dirname(__FILE__), '../json', v, "#{schema}.json")
           plain_data = File.open(file_path, 'r'){|f| f.read}
-          ActiveSupport::JSON.decode(plain_data).with_indifferent_access
+          # remember
+          registry[v][schema] = ActiveSupport::JSON.decode(plain_data).with_indifferent_access
         end
 
         # Read all available schemas from a given version(folder) and return
@@ -83,21 +100,26 @@ module SK
               data[field] = obj.send(field) if obj.respond_to?(field.to_sym)
             end
           end
-          #add links
-          { obj_class_name => data,
-            'links' =>  parse_links(obj, schema)
-          }
+          hsh = { obj_class_name => data }
+          #add links if present
+          links = parse_links(obj, schema)
+          links && hsh['links'] = links
+          # return hash
+          hsh
         end
 
         # Parse the link section of the schema by replacing {id} in urls
         # === Returns
         # <Array[Hash{String=>String}]>::
+        # <nil>:: no links present
         def parse_links(obj, schema)
           links = []
           schema['links'] && schema['links'].each do |link|
             links << { 'rel' => link['rel'], 'href' => link['href'].gsub(/\{id\}/, obj.id) }
           end
           links.uniq
+          # return links only if not empty
+          links.empty? ? nil : links
         end
 
       end # class methods

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.16"
+  s.version = "0.0.17"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-02-14}
+  s.date = %q{2011-03-10}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "json/v1.0/payment_reminder.json",
     "json/v1.0/product.json",
     "json/v1.0/recurring.json",
+    "json/v1.0/sub.json",
     "json/v1.0/text_template.json",
     "json/v1.0/user.json",
     "lib/sk_api_schema.rb",

data/spec/sk_api_schema_spec.rb

@@ -38,6 +38,12 @@ describe SK::Api::Schema do
     }.should raise_error
   end
 
+  it "should add schema to registry" do
+    SK::Api::Schema.read(:credit_note, 'v1.0')
+    File.should_not_receive(:open)
+    SK::Api::Schema.read(:credit_note, 'v1.0')
+  end
+
 end
 
 describe SK::Api::Schema, 'object parsing' do
@@ -76,8 +82,8 @@ describe SK::Api::Schema, 'object parsing' do
     @invoice.client = @client
     obj_hash = SK::Api::Schema.to_hash_from_schema(@invoice, 'v1.0')
     obj_hash["invoice"]['client']['client'].should == {"number"=>"911", "addresses"=>[], "id"=>"some-uuid", "organisation"=>"Dirty Food Inc.", "last_name"=>nil}
-    obj_hash["invoice"]["client"]['links'].should == []
-    obj_hash["invoice"]["line_items"].should == [ {'links'=>[], "line_item"=>{"name"=>"Pork Chops", "position"=>1, \
+    obj_hash["invoice"]["client"]['links'].should_not be_nil
+    obj_hash["invoice"]["line_items"].should == [ {"line_item"=>{"name"=>"Pork Chops", "position"=>1, \
                                        "id"=>"some-uuid", "description"=>"Yummi Pork chopped by mexian emigrants", "price_single"=>0.99}}]
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: 
   segments: 
   - 0
   - 0
-  - 16
-  version: 0.0.16
+  - 17
+  version: 0.0.17
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 +01:00
+date: 2011-03-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - json/v1.0/payment_reminder.json
 - json/v1.0/product.json
 - json/v1.0/recurring.json
+- json/v1.0/sub.json
 - json/v1.0/text_template.json
 - json/v1.0/user.json
 - lib/sk_api_schema.rb