fidor_schema 0.1.18

data/schema/v1.0/sepa_mandate.json

@@ -0,0 +1,158 @@
+{
+  "type"        : "object",
+  "title"       : "Sepa Mandate",
+  "name"        : "sepa_mandate",
+  "description" : "A mandate object authorizing debits from an account.",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "external_uid" : {
+      "$ref"     : "./base_types/base_types.json#definitions/external_uid",
+      "required" : true
+    },
+    "customer_id" : {
+      "description" : "Customer for which this mandate is valid.",
+      "type"        : "integer",
+      "required"    : true
+    },
+    "user_id" : {
+      "$ref" : "./base_types/base_types.json#definitions/user_id"
+    },
+    "mandate_reference" : {
+      "description" : "Unique reference of the mandate.",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 35
+    },
+    "sequence" : {
+      "description" : "Recurring or One-Time",
+      "type"        : "string",
+      "default"     : "RCUR",
+      "enum"        : [
+        "RCUR",
+        "OOFF"
+      ]
+    },
+    "cor1_option" : {
+      "description" : "COR-1 option",
+      "type"        : "string",
+      "default"     : "1",
+      "enum"        : [
+        "0",
+        "1"
+      ]
+    },
+    "remote_title" : {
+      "description" : "Title of the debtor e.g Dr. Prof.",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 35
+    },
+    "remote_name" : {
+      "description" : "Full name of debtor",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 70
+    },
+    "remote_email" : {
+      "description" : "Debtor's email",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 70
+    },
+    "remote_address_line1" : {
+      "description" : "Address street.",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 35
+    },
+    "remote_address_line2" : {
+      "description" : "ZIP and City",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 70
+    },
+    "remote_country" : {
+      "description" : "2 digit country code, ISO 3166",
+      "type"        : "string",
+      "required"    : true,
+      "maxLength"   : 2
+    },
+    "remote_iban" : {
+      "$ref"     : "./base_types/base_types.json#definitions/iban",
+      "required" : true
+    },
+    "remote_bic" : {
+      "$ref"     : "./base_types/base_types.json#definitions/bic",
+      "required" : true
+    },
+    "remote_ultimate_name" : {
+      "description" : "Ultimate name",
+      "type"        : "string",
+      "maxLength"   : 70
+    },
+    "remote_signature_location" : {
+      "description" : "Location where debtor signed the mandate.",
+      "type"        : "string",
+      "maxLength"   : 70
+    },
+    "signature_date" : {
+      "description" : "Date the mandate was signed of by the debtor.",
+      "format"      : "date",
+      "required"    : true,
+      "type"        : "string"
+    },
+    "valid_from_date" : {
+      "description" : "Date the mandate started to be valid.",
+      "format"      : "date",
+      "type"        : "string"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "sepa_mandates/{id}"
+    },
+    {
+      "rel"        : "instances",
+      "href"       : "sepa_mandates",
+      "properties" : {
+        "filter[mandate_reference]" : {
+          "title"       : "Search",
+          "description" : "Search by mandate reference",
+          "type"        : "string"
+        },
+        "filter[remote_iban]" : {
+          "title"       : "Search",
+          "description" : "Search by remote iban",
+          "type"        : "string"
+        },
+        "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" : {
+          "title" : "Sort",
+          "enum"  : [
+            "ASC",
+            "DESC"
+          ],
+          "description" : "Sort the results in ASC or DESC",
+          "type"        : "string"
+        }
+      }
+    },
+    {
+      "rel"    : "create",
+      "href"   : "sepa_mandates",
+      "method" : "POST"
+    }
+  ]
+}

data/schema/v1.0/transaction.json

@@ -0,0 +1,134 @@
+{
+  "type"        : "object",
+  "title"       : "Transaction",
+  "name"        : "transaction",
+  "description" : "A transaction is the result of a successful transfer or debit.",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "account_id" : {
+      "$ref"     : "./base_types/base_types.json#definitions/account_id",
+      "readonly" : true
+    },
+    "transaction_type" : {
+      "$ref"     : "./base_types/base_types.json#definitions/transaction_type",
+      "readonly" : true
+    },
+    "transaction_type_details" : {
+      "description" : "Details specific to this transaction type are collected here.",
+      "readonly"    : true,
+      "type"        : "object",
+      "oneOf"       : [
+        {
+          "$ref" : "./transaction_type_details/credit_card_details.json#properties"
+        },
+        {
+          "$ref" : "./transaction_type_details/internal_transfer_details.json#properties"
+        },
+        {
+          "$ref" : "./transaction_type_details/sepa_credit_transfer_details.json#properties"
+        },
+        {
+          "$ref" : "./transaction_type_details/sepa_direct_debit_details.json#properties"
+        }
+      ]
+    },
+    "subject" : {
+      "$ref"     : "./base_types/base_types.json#definitions/subject",
+      "readonly" : true
+    },
+    "amount" : {
+      "$ref"     : "./base_types/base_types.json#definitions/amount",
+      "readonly" : true
+    },
+    "booking_date" : {
+      "description" : "Date the transaction was booked.",
+      "format"      : "date-time",
+      "readonly"    : true,
+      "type"        : "string"
+    },
+    "value_date" : {
+      "description" : "Date the amount was credited to the account (Wertstellung).",
+      "format"      : "date",
+      "readonly"    : true,
+      "type"        : "string"
+    },
+    "booking_code" : {
+      "description" : "Accounting transaction code in the central banking system",
+      "readonly"    : true,
+      "type"        : "string"
+    },
+    "return_transaction_id" : {
+      "description" : "If the transaction was marked for return, this references the new return transaction.",
+      "readonly"    : true,
+      "type"        : "integer"
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "transactions/{id}"
+    },
+    {
+      "rel"        : "instances",
+      "href"       : "transactions",
+      "properties" : {
+        "filter[account_ids]" : {
+          "title"  : "Find transactions belonging to the given account ids. Single id or multiple ids comma-separated.",
+          "format" : "date",
+          "type"   : "string"
+        },
+        "filter[id_from]" : {
+          "title"  : "Find transactions with an id greater than given one.",
+          "format" : "integer",
+          "type"   : "string"
+        },
+        "filter[id_to]" : {
+          "title"  : "Find transactions with an id smaller than given one.",
+          "format" : "integer",
+          "type"   : "string"
+        },
+        "filter[booking_date_from]" : {
+          "title"  : "Date filter from >= date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[booking_date_to]" : {
+          "title"  : "Date filter to <= date",
+          "format" : "date-time",
+          "type"   : "string"
+        },
+        "filter[kinds]" : {
+          "$ref"  : "./base_types/base_types.json#definitions/transaction_type",
+          "title" : "By transaction types"
+        },
+        "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" : {
+          "title" : "Sort",
+          "enum"  : [
+            "ASC",
+            "DESC"
+          ],
+          "description" : "Sort the results in ASC or DESC",
+          "type"        : "string"
+        }
+      }
+    }
+  ]
+}

data/schema/v1.0/transaction_type_details/credit_card_details.json

@@ -0,0 +1,32 @@
+{
+  "type"        : "object",
+  "title"       : "Credit Card Details",
+  "name"        : "credit_card_details",
+  "description" : "Credit card information available in a CreditCard transaction",
+  "properties"  : {
+    "cc_merchant_name" : {
+      "description" : "CreditCard merchant initiating the transaction",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readonly"    : true
+    },
+    "cc_merchant_category" : {
+      "description" : "Category given by the merchant",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readonly"    : true
+    },
+    "cc_type" : {
+      "description" : "CreditCard type",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readonly"    : true
+    },
+    "cc_category" : {
+      "description" : "CreditCard category",
+      "type"        : "string",
+      "maxLength"   : 255,
+      "readonly"    : true
+    }
+  }
+}

data/schema/v1.0/transaction_type_details/internal_transfer_details.json

@@ -0,0 +1,17 @@
+{
+  "type"        : "object",
+  "title"       : "Internal Transfer Details",
+  "name"        : "internal_transfer_details",
+  "description" : "Remote account for a Fidor internal transfer",
+  "properties"  : {
+    "remote_account_id" : {
+      "$ref"     : "./base_types/base_types.json#definitions/account_id",
+      "readonly" : true
+    },
+    "internal_transfer_id" : {
+      "description" : "Id of transfer if transaction was created by a transfer. Refunded transactions have no id",
+      "readonly"    : true,
+      "type"        : "integer"
+    }
+  }
+}

data/schema/v1.0/transaction_type_details/sepa_credit_transfer_details.json

@@ -0,0 +1,27 @@
+{
+  "type"        : "object",
+  "title"       : "Sepa Credit Transfer Details",
+  "name"        : "sepa_credit_transfer_details",
+  "description" : "Remote account information available in a SEPA credit transfer",
+  "properties"  : {
+    "sepa_credit_transfer_id" : {
+      "description" : "Id of transfer if transaction was created by a transfer. Refunded transactions have no id",
+      "readonly"    : true,
+      "type"        : "integer"
+    },
+    "remote_name" : {
+      "description" : "Receiving/Sending account holder name",
+      "type"        : "string",
+      "readonly"    : true,
+      "maxLength"   : 70
+    },
+    "remote_iban" : {
+      "$ref"     : "./base_types/base_types.json#definitions/iban",
+      "readonly" : true
+    },
+    "remote_bic" : {
+      "$ref"     : "./base_types/base_types.json#definitions/bic",
+      "readonly" : true
+    }
+  }
+}

data/schema/v1.0/transaction_type_details/sepa_direct_debit_details.json

@@ -0,0 +1,25 @@
+{
+  "type"        : "object",
+  "title"       : "Sepa Direct Debit Details",
+  "name"        : "sepa_direct_debit_details",
+  "description" : "Remote account information for a SEPA direct debit",
+  "properties"  : {
+    "remote_iban" : {
+      "$ref"     : "./base_types/base_types.json#definitions/iban",
+      "readonly" : true
+    },
+    "remote_bic" : {
+      "$ref"     : "./base_types/base_types.json#definitions/bic",
+      "readonly" : true
+    },
+    "mandate_id" : {
+      "description" : "The sepa mandate used by the debit",
+      "type"        : "number",
+      "readonly"    : true
+    },
+    "eref" : {
+      "$ref"     : "./base_types/base_types.json#definitions/eref",
+      "readonly" : true
+    }
+  }
+}

data/schema/v1.0/user.json

@@ -0,0 +1,34 @@
+{
+  "type"        : "object",
+  "title"       : "User",
+  "name"        : "user",
+  "description" : "",
+  "properties"  : {
+    "id" : {
+      "$ref" : "./base_types/base_types.json#definitions/id"
+    },
+    "email" : {
+      "$ref"     : "./base_types/base_types.json#definitions/email",
+      "required" : true,
+      "readonly" : true
+    },
+    "last_sign_in_at" : {
+      "description" : "Last time the user accessed fidor.",
+      "format"      : "date-time",
+      "readonly"    : true,
+      "type"        : "string"
+    },
+    "created_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/created_at"
+    },
+    "updated_at" : {
+      "$ref" : "./base_types/base_types.json#definitions/updated_at"
+    }
+  },
+  "links" : [
+    {
+      "rel"  : "self",
+      "href" : "users/current"
+    }
+  ]
+}

data/spec/fidor_schema_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Fidor::Schema do
+
+  context 'path' do
+    it 'should provide path to schema files' do
+      expect(Fidor::Schema.path).to eq(File.expand_path( File.join('../schema/v1.0'), File.dirname(__FILE__)))
+    end
+  end
+
+  context 'read schemata' do
+
+    it 'should read all json files' do
+      SchemaTools.schema_path = Fidor::Schema.path
+      SchemaTools::Reader.read_all
+      expect(SchemaTools::Reader.registry).to_not be_empty
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'json_schema_tools'
+require 'fidor_schema'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fidor_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.18
+platform: ruby
+authors:
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_schema_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fidor API description. Using JSON Schema to describe the available objects,
+  their fields and resource links.
+email: dev@fidor.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- fidor_schema.gemspec
+- lib/fidor/schema.rb
+- lib/fidor_schema.rb
+- lib/fidor_schema_version.rb
+- schema/v1.0/account.json
+- schema/v1.0/base_types/base_types.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/sepa_credit_transfer.json
+- schema/v1.0/sepa_direct_debit.json
+- schema/v1.0/sepa_mandate.json
+- schema/v1.0/transaction.json
+- schema/v1.0/transaction_type_details/credit_card_details.json
+- schema/v1.0/transaction_type_details/internal_transfer_details.json
+- schema/v1.0/transaction_type_details/sepa_credit_transfer_details.json
+- schema/v1.0/transaction_type_details/sepa_direct_debit_details.json
+- schema/v1.0/user.json
+- spec/fidor_schema_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.fidor.de
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fidor API - JSON Schema
+test_files:
+- spec/fidor_schema_spec.rb
+- spec/spec_helper.rb