fidor_schema 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e968878c07f87c3c30ce72943bf84145be4b286
-  data.tar.gz: 890f5542c24b46ce99759a1de456358006341056
+  metadata.gz: 62915f5be4ab9ef346a2863dd9a9b722023d24c1
+  data.tar.gz: 1bb21c5f020113acb70e9e14e840f540b4f66669
 SHA512:
-  metadata.gz: d9c02c836037338d1120002dcea17b8773fff83fc5de8b591241735cc7f547621b213ddd6948ffa50efb7bbe537e9c4b54c20c43964639f24a7c98c32c260ed0
-  data.tar.gz: a24971b95bb22fdeed55bfce1cd43d85187c4f890c49cd2174ab7f922f7c93901df945d436f78ca35497af9ca254d51dff60b64257b528f7a26c489e723f5b27
+  metadata.gz: 9735c425b487162ca5e0f1c654118003b262d016b45906826511d1b51b44e7e34718aa492a3b7cae7895134f63cbc9b71af0d71d1e1f720478c96611e9f3fcb0
+  data.tar.gz: d690c254b44b85ab6650b62a872a922bcb0acc5271ab20744f4339ac0d32cbb9ca46300503e63278a5eee09e4d866c7ad888d57b04c3c1f7b802bb89e70a5bcf

data/CHANGELOG.md

@@ -4,6 +4,9 @@ A more detailed view of the changes can be found in the [commit messages](https:
 
 ##2014-11
 
+* Lists of any object type are now returned under the generic 'data' key
+* Transaction clarify nested transaction_type_details
+* Transaction amount can be negative
 * add rate_limit endpoint
 
 ##2014-10

data/lib/fidor_schema_version.rb

@@ -1,5 +1,5 @@
 module Fidor
   class Schema
-    VERSION='0.3.5'
+    VERSION='0.4.0'
   end
 end

data/schema/v1.0/account.json

@@ -92,10 +92,7 @@
     },
     {
       "rel"          : "transactions",
-      "href"         : "accounts/{id}/transactions",
-      "targetSchema" : {
-        "$ref" : "./lists/transactions.json#"
-      }
+      "href"         : "accounts/{id}/transactions"
     },
     {
       "rel"          : "internal_transfers",

data/schema/v1.0/base_types/lists.json

@@ -0,0 +1,32 @@
+{
+  "type"        : "object",
+  "title"       : "List",
+  "name"        : "list",
+  "description" : "A paginated list of objects",
+  "properties"  : {
+    "data" : {
+      "description"  : "The requested objects",
+      "type"  : "array"
+    },
+    "collection" : {
+      "type"        : "object",
+      "name"        : "collection",
+      "description" : "Pagination information for a list of returned object (not standalone)",
+      "properties"  : {
+        "current_page" : {
+          "type" : "integer"
+        },
+        "per_page" : {
+          "type" : "integer"
+        },
+        "total_entries" : {
+          "type" : "integer"
+        },
+        "total_pages" : {
+          "type" : "integer"
+        }
+      }
+    }
+  }
+}
+

data/schema/v1.0/sepa_direct_debit.json

@@ -22,6 +22,11 @@
       "type"        : "string",
       "required"    : true
     },
+    "creditor_identifier" : {
+      "description" : "Creditor Identifier",
+      "type"        : "string",
+      "readonly"    : true
+    },
     "amount" : {
       "$ref"     : "./base_types/base_types.json#definitions/amount",
       "required" : true

data/schema/v1.0/transaction.json

@@ -21,16 +21,28 @@
       "type"        : "object",
       "oneOf"       : [
         {
-          "$ref" : "./transaction_type_details/credit_card_details.json#properties"
+          "name"        : "credit_card_details",
+          "properties" : {
+            "$ref" : "./transaction_type_details/credit_card_details.json#properties"
+          }
         },
         {
-          "$ref" : "./transaction_type_details/internal_transfer_details.json#properties"
+          "name"        : "internal_transfer_details",
+          "properties" : {
+            "$ref" : "./transaction_type_details/internal_transfer_details.json#properties"
+          }
         },
         {
-          "$ref" : "./transaction_type_details/sepa_credit_transfer_details.json#properties"
+          "name"        : "sepa_credit_transfer_details",
+          "properties" : {
+            "$ref" : "./transaction_type_details/sepa_credit_transfer_details.json#properties"
+          }
         },
         {
-          "$ref" : "./transaction_type_details/sepa_direct_debit_details.json#properties"
+          "name"        : "sepa_direct_debit_details",
+          "properties" : {
+            "$ref" : "./transaction_type_details/sepa_direct_debit_details.json#properties"
+          }
         }
       ]
     },
@@ -39,7 +51,8 @@
       "readonly" : true
     },
     "amount" : {
-      "$ref"     : "./base_types/base_types.json#definitions/amount",
+      "description"      : "The transferred amount in account currency, in minor units, e.g. 1EUR is represented as 100. Can be negative e.g. if something was withdrawn from an account.",
+      "type"             : "integer",
       "readonly" : true
     },
     "currency" : {

data/spec/fidor_schema_spec.rb

@@ -22,8 +22,8 @@ describe Fidor::Schema do
 
     it 'in single schema' do
       SchemaTools.schema_path = Fidor::Schema.path
-      schema = SchemaTools::Reader.read('accounts').to_h
-      expect(schema['properties']['accounts']['items']['properties']['id']['type']).to eq 'string'
+      schema = SchemaTools::Reader.read('account').to_h
+      expect(schema['properties']['customers']['items']['properties']['id']['type']).to eq 'string'
 
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fidor_schema
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,22 +113,12 @@ files:
 - lib/fidor_schema_version.rb
 - schema/v1.0/account.json
 - schema/v1.0/base_types/base_types.json
+- schema/v1.0/base_types/lists.json
 - schema/v1.0/batch_direct_debit.json
 - schema/v1.0/batch_transfer.json
 - schema/v1.0/customer.json
 - schema/v1.0/error.json
 - schema/v1.0/internal_transfer.json
-- schema/v1.0/lists/accounts.json
-- schema/v1.0/lists/batch_direct_debits.json
-- schema/v1.0/lists/batch_transfers.json
-- schema/v1.0/lists/collection.json
-- schema/v1.0/lists/customers.json
-- schema/v1.0/lists/internal_transfers.json
-- schema/v1.0/lists/sepa_credit_transfers.json
-- schema/v1.0/lists/sepa_direct_debits.json
-- schema/v1.0/lists/sepa_mandates.json
-- schema/v1.0/lists/transactions.json
-- schema/v1.0/lists/users.json
 - schema/v1.0/rate_limit.json
 - schema/v1.0/sepa_credit_transfer.json
 - schema/v1.0/sepa_direct_debit.json

data/schema/v1.0/lists/accounts.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Accounts",
-  "name"        : "accounts",
-  "description" : "A paginated list of Account objects",
-  "properties"  : {
-    "accounts" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../account.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/batch_direct_debits.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Batch_direct_debits",
-  "name"        : "batch_direct_debits",
-  "description" : "A paginated list of Batch_direct_debit objects",
-  "properties"  : {
-    "batch_direct_debits" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../batch_direct_debit.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/batch_transfers.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Batch_transfers",
-  "name"        : "batch_transfers",
-  "description" : "A paginated list of Batch_transfer objects",
-  "properties"  : {
-    "batch_transfers" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../batch_transfer.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/collection.json

@@ -1,20 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Collection",
-  "name"        : "collection",
-  "description" : "Pagination information for a list of returned object (not standalone)",
-  "properties"  : {
-    "current_page" : {
-      "type" : "integer"
-    },
-    "per_page" : {
-      "type" : "integer"
-    },
-    "total_entries" : {
-      "type" : "integer"
-    },
-    "total_pages" : {
-      "type" : "integer"
-    }
-  }
-}

data/schema/v1.0/lists/customers.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Customers",
-  "name"        : "customers",
-  "description" : "A paginated list of Customer objects",
-  "properties"  : {
-    "customers" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../customer.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/internal_transfers.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Internal_transfers",
-  "name"        : "internal_transfers",
-  "description" : "A paginated list of Internal_transfer objects",
-  "properties"  : {
-    "internal_transfers" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../internal_transfer.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/sepa_credit_transfers.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Sepa_credit_transfers",
-  "name"        : "sepa_credit_transfers",
-  "description" : "A paginated list of Sepa_credit_transfer objects",
-  "properties"  : {
-    "sepa_credit_transfers" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../sepa_credit_transfer.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/sepa_direct_debits.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Sepa_direct_debits",
-  "name"        : "sepa_direct_debits",
-  "description" : "A paginated list of Sepa_direct_debit objects",
-  "properties"  : {
-    "sepa_direct_debits" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../sepa_direct_debit.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/sepa_mandates.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Sepa_mandates",
-  "name"        : "sepa_mandates",
-  "description" : "A paginated list of Sepa_mandate objects",
-  "properties"  : {
-    "sepa_mandates" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../sepa_mandate.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/transactions.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Transactions",
-  "name"        : "transactions",
-  "description" : "A paginated list of Transaction objects",
-  "properties"  : {
-    "transactions" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../transaction.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-

data/schema/v1.0/lists/users.json

@@ -1,22 +0,0 @@
-{
-  "type"        : "object",
-  "title"       : "Users",
-  "name"        : "users",
-  "description" : "A paginated list of User objects",
-  "properties"  : {
-    "users" : {
-      "type"  : "array",
-      "items" : {
-        "type"       : "object",
-        "properties" : {
-          "$ref" : "../user.json#properties"
-        }
-      }
-    },
-    "links"      : {},
-    "collection" : {
-      "$ref" : "./collection.json#"
-    }
-  }
-}
-