bankster-transaction 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13233f67cf124e55da18ba4f729de47db24fe375
+  data.tar.gz: 3969267143d63497d34c88077db153c5c101339b
+SHA512:
+  metadata.gz: 8cf75dcceee8ca6b8fee59b9d685ee0c333733bc63ca94d68b3f4775a9186edc4c51a198ffb2cba326079a535a22012ee5920e18d18c28625b5d251d47909348
+  data.tar.gz: c7ff5f40bf5368064778f07ac7eb9c77eaec58b776d7fecffff0468994b64f52e8800b11229fc3e9c54df1ad2d7e98e09ac3ef67bd9016ab1f0c6d4e52e79340

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Roman Lehnert
+
+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/README.md

@@ -0,0 +1,123 @@
+# Bankster::Shared
+
+`Bankster::Transaction` provides some resources to transmit a bankster payment transaction.
+
+* `Bankster::Transaction`: A PORO that acts as a model. 
+* `Bankster::Representers::TransactionRepresenter`: A grape representer that converts a `Bankster::Transaction` to json and vice versa.
+* `schemas/transaction_schema`: A json schmema, that can validate a bankster transaction.
+* `factories/transaction_factory`: A factory that provides mocked bankster transactions. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bankster_shared'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bankster_shared
+
+## Usage
+
+### Model
+
+The `Bankster::Transaction` model has the following attributes accessible:
+
+* name
+* iban
+* bic
+* purpose
+* valutation_date
+* booking_date
+* type
+
+### Representers
+
+Given the bankster json api response for a transaction:
+
+```ruby
+api_response = {
+  "name":"Max Mustermann",
+  ...
+  "amount":{"cents":"123","currency":"EUR"}
+}
+```
+
+The representer can fill a `Bankster::Transaction` object from the json:
+```ruby
+# initialize a transaction object
+transaction = Bankster::Transaction.new
+
+# extend it with the representer
+transaction.extend(Bankster::Representers::TransactionRepresenter)
+
+# fill it from the json response
+transaction.from_json(api_response)
+
+transaction.amount # => Money.new(123, "EUR")
+```
+
+In the other direction, the representer works the same. Given a `Bankster::Transaction` object, you can 
+extend it with the representer and call `#to_json` in order to get a json that matches our schema. 
+
+```ruby
+# extend the transaction with its representer
+transaction.extend(Bankster::Representers::TransactionRepresenter)
+
+# dump the json
+puts transaction.to_json
+# => 
+{"purpose"=>"my purpose", "name"=>"Max Mustermann", "iban"=>"DE123", "bic"=>"ASD", "valutation_date"=>"2015-10-26", "booking_date"=>"2015-10-26", "type"=>"credit_tansfer", "amount"=>{"cents"=>"123", "currency"=>"EUR"}}
+```
+
+### Schemas
+
+This gem provides a json schema that can be used somewhere else. E.g. if you want to speciy that some json string matches the transaction schema:
+
+Utilize the [json-schema-matchers gem](https://github.com/sharethrough/json-schema-rspec) to write rspecs.
+
+Add the following to your `spec/spec_helper.rb`:
+ 
+```ruby
+bankster-transaction_dir = Gem::Specification.find_by_name('bankster-transaction').gem_dir
+
+Dir[File.join(bankster-transaction_dir, "/lib/schemas/*.json")].each do |file|
+  config.json_schemas[File.basename(file, ".json").to_sym] = file
+end
+```
+
+And now, you can specify sth. to match one of the schemas that reside at `lib/schemas/`:
+
+```ruby
+it 'matches the transaction schema' do
+  expect(some_json).to match_json_schema(:transaction_schema)
+end
+
+```
+
+### Factories
+
+If you intent to use one of the factories that are provided by this gem, just load them in your `spec/spec_helper`:
+```ruby
+bankster-transaction_dir = Gem::Specification.find_by_name('bankster-transaction').gem_dir
+
+Dir.glob(File.join(bankster-transaction_dir, "spec/factories/*.rb")).each { |f| require f }
+```
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bankster/bankster_shared.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bankster-transaction.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bankster-transaction'
+  spec.version       = '0.1.1'
+  spec.authors       = ['Roman Lehnert']
+  spec.email         = ['roman.lehnert@googlemail.com']
+
+  spec.summary       = 'Bankster::Transaction'
+  spec.description   = 'Shared stuff for bankster servers and clients'
+  spec.homepage      = 'http://bankster.io/'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency "roar"
+  spec.add_runtime_dependency "representable", "~> 2.4"
+  spec.add_runtime_dependency "multi_json"
+  spec.add_runtime_dependency "money"
+
+  spec.add_development_dependency 'json-schema-rspec'
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'byebug'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bankster_shared"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bankster_shared.rb

@@ -0,0 +1,6 @@
+require 'money'
+require 'roar/json'
+
+require 'models/transaction'
+require 'representers/transaction_representer'
+require 'representers/transactions_representer'

data/lib/models/transaction.rb

@@ -0,0 +1,12 @@
+module Bankster
+  class Transaction
+    attr_accessor :purpose
+    attr_accessor :iban
+    attr_accessor :bic
+    attr_accessor :name
+    attr_accessor :amount
+    attr_accessor :type
+    attr_accessor :booking_date
+    attr_accessor :valutation_date
+  end
+end

data/lib/representers/transaction_representer.rb

@@ -0,0 +1,49 @@
+require 'roar/json'
+module Bankster
+  module Representers
+    module TransactionRepresenter
+      include Roar::JSON
+      collection_representer class: Bankster::Transaction
+
+      property :purpose
+      property :name
+      property :iban
+      property :bic
+
+      # valutation_date is
+      # - a Date object in ruby
+      # - a ISO8601 date string in json
+      property :valutation_date,
+        reader: ->(doc:, represented:, **) { represented.valutation_date = Date.parse(doc['valutation_date']) if doc['valutation_date'] },
+        writer: ->(doc:, represented:, **) { doc['valutation_date'] = represented.valutation_date.iso8601 if represented.valutation_date }
+
+      # booking_date is
+      # - a Date object in ruby
+      # - a ISO8601 date string in json
+      property :booking_date,
+        reader: ->(doc:, represented:, **) { represented.booking_date = Date.parse(doc['booking_date']) if doc['booking_date'] },
+        writer: ->(doc:, represented:, **) { doc['booking_date'] = represented.booking_date.iso8601 if represented.booking_date }
+
+      # type is
+      # - a symbol in ruby
+      # - a string in json
+      property :type,
+        reader: ->(doc:, represented:, **) { represented.type = doc['type'].to_sym },
+        writer: ->(doc:, represented:, **) { doc['type'] = represented.type.to_s }
+
+      # amount is
+      # - a Money object in ruby
+      # - a Hash with "cents" and "currency" in json
+      property :amount,
+        reader: ->(doc:, represented:, **) {
+          represented.amount = Money.new(doc['amount']['cents'], doc['amount']['currency'])
+        },
+        writer: ->(doc:, represented:, **) {
+          doc['amount'] = {
+            'cents' => represented.amount.cents.to_s,
+            'currency' => represented.amount.currency
+          }
+        }
+    end
+  end
+end

data/lib/representers/transactions_representer.rb

@@ -0,0 +1,11 @@
+require 'roar/json'
+module Bankster
+  module Representers
+    module TransactionsRepresenter
+      include Roar::JSON
+      include Representable::JSON::Collection
+      include Representable::Hash
+      items extend: TransactionRepresenter, class: Bankster::Transaction
+    end
+  end
+end

data/lib/schemas/transaction_schema.json

@@ -0,0 +1,19 @@
+{
+  "type": "object",
+  "properties": {
+    "purpose": { "type": "string" },
+    "name": { "type": "string" },
+    "iban": { "type": "string" },
+    "bic": { "type": "string" },
+    "booking_date": { "type": "date" },
+    "valutation_date": { "type": "date" },
+    "type": { "type": "string" },
+    "amount": { 
+      "type": "object",
+      "properties": {
+        "cents": { "type": "string" },
+        "currency": { "type": "string" }
+      }
+    }
+  }
+}

data/lib/schemas/transactions_schema.json

@@ -0,0 +1,6 @@
+{
+  "type": "array",
+  "items": {
+    "$ref": "transaction_schema.json"
+  }
+}

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: bankster-transaction
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Roman Lehnert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema-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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: factory_girl
+  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: byebug
+  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: Shared stuff for bankster servers and clients
+email:
+- roman.lehnert@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bankster-transaction.gemspec
+- bin/console
+- bin/setup
+- lib/bankster_shared.rb
+- lib/models/transaction.rb
+- lib/representers/transaction_representer.rb
+- lib/representers/transactions_representer.rb
+- lib/schemas/transaction_schema.json
+- lib/schemas/transactions_schema.json
+homepage: http://bankster.io/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Bankster::Transaction
+test_files: []