aq_banking 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37e0c9634716c12e46c6d08dbc994d31b6937883
-  data.tar.gz: b971e91d93635c789d92dde7b83074e0a73dc4a7
+  metadata.gz: cef0811dfdb94ed0b563fdda4d5ab651b13e4839
+  data.tar.gz: 6f19b1ecbf90f90a5c34d6281c57e9c88b7df487
 SHA512:
-  metadata.gz: b6528e939651d57a2aae7ca9bb2f7f4131085b4deab5dbec1ae9db4956ee907bfd07bed3534642b6c057722b436590b66b0d7a4c9e5fc6074ff9a50a3e619981
-  data.tar.gz: 3478fd205987fc55e7e5ca1b714f5b655ab111dd3dc66e0ac8fdc28087a0587dcbbc38db8f2d762d6079e14540bc6cd69f814008da5b42ffc66e81003118deb9
+  metadata.gz: f7e9465feccb2285121a5c60818d609c6d80af4fade8cd611d176378015970c1a530eae35b2a91416011ff45efa587d8a01a8b6df66d398e56633037c5303b68
+  data.tar.gz: 57ceacef7efcb7573538f23281fcd5d5f80ad0331e6bf77dfb873a89945149aaea45419e0157d9b36ec085aa477320964ff087652fa082f1ad537279a3cd8a1e

data/.dockerignore

@@ -0,0 +1,6 @@
+README.md
+.dockerignore
+.travis.yml
+coverage/
+Dockerfile
+.idea/

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+bin/

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.2.2
+FROM ruby:2.3.0
 MAINTAINER Robin Wenglewski, robin@wenglewski.de
 
 RUN apt-get update -qq && apt-get install -y \
@@ -6,10 +6,6 @@ RUN apt-get update -qq && apt-get install -y \
     aqbanking-tools \
     ktoblzcheck
 
-RUN mkdir /gem
-WORKDIR /gem
+RUN gem install aq_banking
 
-COPY . /gem
-RUN bundle install
-
-CMD bundle exec rspec
+ENTRYPOINT ["aq_banking"]

data/README.md

@@ -3,8 +3,52 @@
 [![Travis Status](https://travis-ci.org/rweng/aq_banking.svg)](https://travis-ci.org/rweng/aq_banking)
 [![codecov.io](http://codecov.io/github/rweng/aq_banking/coverage.svg?branch=master)](http://codecov.io/github/rweng/aq_banking?branch=master)
 
+
+This is a ruby library and command line tool to wrap around the more complex aqbanking cli tools.
+
+Sample:
+
+```bash
+$ aq_banking request --bank=diba BLZ ACCCOUNT_NUMBER LOGIN_ID PASSWORD --from=2016-04-18
+{
+  "iban": "...",
+  "bic": "...",
+  "owner": "WENGLEWSKI, ROBIN",
+  "currency": "EUR",
+  "bank_code": "...",
+  "bank_name": "ING-DiBa",
+  "booked_balance": 123.45,
+  "noted_balance": 123.45,
+  "number": "...",
+  "name": "Girokonto",
+  "transactions": [
+    {
+      "amount": -22.0,
+      "currency": "EUR",
+      "date": "2016-04-18 12:00:00 UTC",
+      "valuta_date": "2016-04-18 12:00:00 UTC"
+      ...
+    },
+    ...
+  ],
+  ...
+}
+```
+
+It still requires the aq_banking command line tools to be present.
+To avoid errors with versions etc, I recommend using the docker image:
+
+    docker run -it --rm rweng/aq_banking --help    
+    docker run -it --rm rweng/aq_banking request --bank=diba BLZ ACCCOUNT_NUMBER LOGIN_ID PASSWORD --from=2016-04-18
+
 ## Installation
 
+### CLI
+
+    gem install aq_banking
+
+### Ruby
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -15,15 +59,28 @@ And then execute:
 
     $ bundle
 
-## Tests
+## Usage
 
-### Docker
+    aq_banking --help
+    aq_banking request BLZ ACCCOUNT USER_ID PASSWORD --bank=diba
 
-    docker build -t rweng/aq_banking .
-    docker run -t --rm -v $(pwd):/gem rweng/aq_banking
+## Development
+
+    # log into container
+    docker-compose run dev
+    
+    # run tests
+    rspec
+    
+### Release
+
+    # publish gem
+    rake release
+    
+    # publish docker container
+    docker-compose build release
+    docker push rweng/aq_banking
     
-    # or to login and run tests manually
-    docker run -it --rm -v $(pwd):/gem rweng/aq_banking bash
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,26 @@
+version: '2'
+
+services:
+  release:
+    build: .
+    image: rweng/aq_banking
+
+  dev:
+    image: rweng/aq_banking
+    depends_on:
+      - release
+    volumes:
+      - .:/gem
+    volumes_from:
+      - cache
+    working_dir: /gem
+    entrypoint: []
+    command: "/bin/bash -c 'bundle install --binstubs bin; /bin/bash'"
+    environment:
+      PATH: "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:./bin"
+
+  cache:
+    image: busybox
+    volumes:
+      - /usr/local/bundle/cache
+

data/lib/aq_banking/cli.rb

@@ -5,20 +5,26 @@ module AqBanking
     class_option :dry, :type => :boolean, default: false, aliases: '-d'
     class_option :verbose, :type => :boolean, default: false, aliases: '-v'
 
-    option :bank
+    option :bank, aliases: '-b', banner: "NAME - one of: #{BANKS.keys.map(&:to_s).join(', ')}"
     option :server_url
     option :hbci_version
+    option :from, banner: 'FROM - e.g. 2016-01-01'
+    option :to, banner: 'TO - e.g. 2016-01-01'
     desc 'request BANK_CODE ACCOUNT_NUMBER USER_ID PASSWORD', 'requests balance and transactions for an account. you must either specify --bank= or (--server-url and maybe --hbci-version)'
     def request(bank_code, account_number, user_id, password)
-      response = commander.send_request!({
-                                             server_url: server_url,
-                                             hbci_version: hbci_version,
-                                             bank_code: bank_code,
-                                             account_number: account_number,
-                                             user_id: user_id,
-                                             password: password
-                                         })
-
+      request_options = {
+          server_url: server_url,
+          bank_code: bank_code,
+          account_number: account_number,
+          user_id: user_id,
+          password: password
+      }
+
+      request_options[:hbci_version] = hbci_version if hbci_version
+      request_options[:from] = options[:from] if options[:from]
+      request_options[:to] = options[:to] if options[:to]
+
+      response = commander.send_request!(request_options)
       account = parser.parse_account_list(response).first
 
       puts account.to_json
@@ -26,7 +32,7 @@ module AqBanking
 
     desc 'list_banks', 'shows valid values for the --bank flag'
     def list_banks
-      puts BANKS.keys.map(&:to_s).join('\n')
+      BANKS.keys.map(&:to_s).each { |key| puts key }
     end
 
     private

data/lib/aq_banking/commander.rb

@@ -13,12 +13,15 @@ module AqBanking
     # @param [String] bank_code
     # @param [String] account_number
     # @param [String] pin_file path to pin
-    # @param [Date] from
-    # @param [Date] to
+    # @param [Date,String] from
+    # @param [Date,String] to
     #
     # @return [String]
     # @raise [SystemCmdError]
     def send_request(bank_code, account_number, pin_file, from: nil, to: nil)
+      from = Date.parse(from) if from.is_a? String
+      to = Date.parse(to) if to.is_a? String
+
       cmd = "#{aq_cli} -P #{pin_file} request -b #{bank_code} -a #{account_number}"
       cmd << " --fromdate=#{from.strftime("%Y%m%d")}" if from
       cmd << " --todate=#{to.strftime("%Y%m%d")}" if to
@@ -94,7 +97,7 @@ module AqBanking
     # @return [AqBanking::Commander::Result]
     # @raise [Timeout::Error]
     def run(cmd, timeout: DEFAULT_TIMEOUT)
-      logger.debug "run: #{cmd}"
+      logger.info "run: #{cmd}"
       result = nil
 
       Timeout::timeout(timeout) do

data/lib/aq_banking/version.rb

@@ -1,3 +1,3 @@
 module AqBanking
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/aq_banking.rb

@@ -24,7 +24,9 @@ module AqBanking
     attr_writer :logger
 
     def logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Logger.new(STDOUT).tap do |logger|
+        logger.level = Logger::WARN
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aq_banking
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Robin Wenglewski
@@ -158,6 +158,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -167,6 +168,7 @@ files:
 - README.md
 - Rakefile
 - aq_banking.gemspec
+- docker-compose.yml
 - exe/aq_banking
 - lib/aq_banking.rb
 - lib/aq_banking/account_info_list.tt