bollettino-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76525e02435e2e3f7194173f7a11cc9c3c91ae14
+  data.tar.gz: 7b1025e967bed4bd3644148f4ed386924360d5c8
+SHA512:
+  metadata.gz: 76a04da1c5df32ed234d687443bd7f8ff643aa3304866c330c06b258f16bf4bc8594e9ae44e07d584b5f23d86cfd583ed9d3d799a038e23203a4e71d6eb346e7
+  data.tar.gz: 3739bfb1a5fbffe2bd4fc483b9c2c67863ff851bd9c9712ba5f90e7bb615ccb12fba3cc983bbadbbd11a933a56593d67658995458472c93395416c12b22f25a8

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/*
+!/tmp/.keep
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.0.0
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.1.0 (November 23rd, 2014)
+===========================
+- First working version

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    bollettino-cli (0.1.0)
+      bollettino (~> 0.1)
+      gli (~> 2.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bollettino (0.1.0)
+      mini_magick (~> 4.0)
+      virtus (~> 1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    equalizer (0.0.9)
+    gli (2.12.2)
+    ice_nine (0.11.0)
+    metaclass (0.0.4)
+    mini_magick (4.0.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thread_safe (0.3.4)
+    virtus (1.0.3)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bollettino-cli!
+  bundler (~> 1.7)
+  mocha (~> 1.1)
+  rake (~> 10.3)
+  rspec (~> 3.1)

data/README.md

@@ -0,0 +1,54 @@
+# bollettino-cli
+
+[![Build Status](https://travis-ci.org/interconn-isp/bollettino-cli.svg?branch=master)](https://travis-ci.org/interconn-isp/bollettino-cli)
+[![Dependency Status](https://gemnasium.com/interconn-isp/bollettino-cli.svg)](https://gemnasium.com/interconn-isp/bollettino-cli)
+[![Code Climate](https://codeclimate.com/github/interconn-isp/bollettino-cli/badges/gpa.svg)](https://codeclimate.com/github/interconn-isp/bollettino-cli)
+
+bollettino-cli is a command line interface for [Bollettino](https://github.com/interconn-isp/bollettino-cli).
+
+It supports generation of postal payment slips from the command line as well as
+from CSV files.
+
+## Installation
+
+Install the gem as:
+
+```console
+$ gem install bollettino-cli
+```
+
+## Usage
+
+```console
+$ bollettino-cli generate --payee-account=[PAYEE_ACCOUNT] --payee-name=[PAYEE_NAME] --payer-name=[PAYER_NAME] --payer-street=[PAYER_STREET] --payer-zip=[PAYER_ZIP] --payer-location=[PAYER_LOCATION] --order-numamount=[ORDER_NUMAMOUNT] --order-textamount=[ORDER_TEXTAMOUNT] --order-reason=[ORDER_REASON] [OUTPUT_PATH]
+```
+
+Or, to generate slips from a CSV file:
+
+```console
+$ bollettino-cli csv-generate --source=[CSV_PATH] [OUTPUT_DIR]
+```
+
+For the documentation run:
+
+```console
+$ bollettino-cli help
+```
+
+## Contributing
+
+1. Fork it (https://github.com/interconn-isp/bollettino-cli/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Maintainers
+
+bollettino-cli is developed and maintained by [Alessandro Desantis](https://github.com/alessandro1997).
+
+## License
+
+bollettino-cli is released under the MIT license.
+
+[![InterConn](http://www.gravatar.com/avatar/b3f5893b97323096977545477e0066c5.jpg?s=100)](http://www.interconn.it)

data/Rakefile

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

data/bin/bollettino-cli

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'bollettino/cli'
+
+include GLI::App
+
+program_desc 'A CLI for the Bollettino library'
+
+version Bollettino::CLI::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Generates a new slip'
+arg_name '[PATH]'
+command :generate do |c|
+  c.desc "The payee's account number"
+  c.flag 'payee-account', required: true
+
+  c.desc "The payee's name"
+  c.flag 'payee-name', required: true
+
+  c.desc "The payer's name"
+  c.flag 'payer-name', required: true
+
+  c.desc "The payer's address' street"
+  c.flag 'payer-street', required: true
+
+  c.desc "The payer's address' ZIP"
+  c.flag 'payer-zip', required: true
+
+  c.desc "The payer's address' location"
+  c.flag 'payer-location', required: true
+
+  c.desc "The payment order's numeric amount"
+  c.flag 'order-numamount', required: true
+
+  c.desc "The payment order's text amount"
+  c.flag 'order-textamount', required: true
+
+  c.desc "The payment order's reason"
+  c.flag 'order-reason', required: true
+
+  c.action do |global_options, options, args|
+    raise 'You must specify a path for the slip!' if args.length < 1
+
+    payee = Bollettino::Payee.new(
+      account_number: options['payee-account'],
+      name: options['payee-name']
+    )
+
+    payer = Bollettino::Payer.new(
+      name: options['payer-name'],
+      address: Bollettino::Address.new(
+        street: options['payer-street'],
+        zip: options['payer-zip'],
+        location: options['payer-location']
+      )
+    )
+
+    payment_order = Bollettino::PaymentOrder.new(
+      numeric_amount: options['order-numamount'],
+      text_amount:  options['order-textamount'],
+      reason:  options['order-reason']
+    )
+
+    slip = Bollettino::Slip.new(
+      payee: payee,
+      payer: payer,
+      payment_order: payment_order
+    )
+
+    Bollettino::Generator.new.generate!(slip, args[0])
+  end
+end
+
+desc 'Generates slips from a CSV file'
+arg_name '[DIR]'
+command 'csv-generate' do |c|
+  c.desc "The CSV file's path"
+  c.flag 'source', required: true
+
+  c.action do |global_options, options, args|
+    raise 'You must specify a directory for the slips!' if args.length < 1
+
+    generator = Bollettino::Generator.new
+
+    CSV.new(open(options[:source]), headers: :first_row).each_with_index do |line, index|
+      %w(payee-account payee-name payer-name payer-street payer-zip payer-location order-numamount order-textamount order-reason).each do |header|
+        raise "#{header} header is required on line #{index + 1}" unless line.header?(header)
+      end
+
+      payee = Bollettino::Payee.new(
+        account_number: line['payee-account'],
+        name: line['payee-name']
+      )
+
+      payer = Bollettino::Payer.new(
+        name: line['payer-name'],
+        address: Bollettino::Address.new(
+          street: line['payer-street'],
+          zip: line['payer-zip'],
+          location: line['payer-location']
+        )
+      )
+
+      payment_order = Bollettino::PaymentOrder.new(
+        numeric_amount: line['order-numamount'],
+        text_amount:  line['order-textamount'],
+        reason:  line['order-reason']
+      )
+
+      slip = Bollettino::Slip.new(
+        payee: payee,
+        payer: payer,
+        payment_order: payment_order
+      )
+
+      generator.generate!(slip, "#{args[0]}/#{index + 1}.png")
+    end
+  end
+end
+
+exit run(ARGV)

data/bollettino-cli.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bollettino/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bollettino-cli'
+  spec.version       = Bollettino::CLI::VERSION
+  spec.authors       = ['Alessandro Desantis']
+  spec.email         = ['desa.alessandro@gmail.com']
+  spec.summary       = 'A CLI for the Bollettino library.'
+  spec.description   = 'bollettino-cli is a CLI for the Bollettino library. It supports generation from CSV files as well.'
+  spec.homepage      = 'https://github.com/interconn-isp/bollettino-cli'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.bindir        = 'bin'
+  spec.executables   << 'bollettino-cli'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'mocha', '~> 1.1'
+
+  spec.add_runtime_dependency 'bollettino', '~> 0.1'
+  spec.add_runtime_dependency 'gli', '~> 2.12'
+end

data/lib/bollettino/cli/version.rb

@@ -0,0 +1,5 @@
+module Bollettino
+  module CLI
+    VERSION = '0.1.0'
+  end
+end

data/lib/bollettino/cli.rb

@@ -0,0 +1,9 @@
+require 'bollettino'
+require 'csv'
+
+require 'bollettino/cli/version'
+
+module Bollettino
+  module CLI
+  end
+end

data/spec/fixtures/slips.csv

@@ -0,0 +1,2 @@
+"payee-account","payee-name","payer-name","payer-street","payer-zip","payer-location","order-numamount","order-textamount","order-reason"
+"0123456789","Acme Inc.","John Doe","1600 Pennsylvania Ave","2500","Washington,D.C.","12.54","Dodidici/54","Invoice INV-123"

data/spec/integration/csv_generate_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe 'The csv-generate command' do
+  let(:options) do
+    options = ''
+    options += "--source='#{source_path}'"
+    options
+  end
+
+  let(:source_path) { File.expand_path('../../fixtures/slips.csv', __FILE__) }
+  let(:slips_path) { File.expand_path('../../../tmp', __FILE__) }
+  let(:slip_path) { "#{slips_path}/1.png" }
+  let(:bin_path) { File.expand_path('../../../bin/bollettino-cli', __FILE__) }
+
+  before(:each) do
+    FileUtils.rm(slip_path) if File.exist?(slip_path)
+  end
+
+  it 'generates the slip' do
+    expect {
+      `#{bin_path} csv-generate #{options} #{slips_path}`
+    }.to change{ File.exist?(slip_path) }.from(false).to(true)
+  end
+end

data/spec/integration/generate_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe 'The generate command' do
+  let(:options) do
+    options = ''
+
+    options += "--payee-account='0123456789'"
+    options += " --payee-name='Acme Inc.'"
+    options += " --payer-name='John Doe'"
+    options += " --payer-street='1600 Pennsylvania Ave'"
+    options += " --payer-zip='20500'"
+    options += " --payer-location='Washington D.C.'"
+    options += " --order-numamount='12.35'"
+    options += " --order-textamount='Dodici/35'"
+    options += " --order-reason='Invoice INV-123'"
+
+    options
+  end
+
+  let(:slip_path) { File.expand_path('../../../tmp/slip.png', __FILE__) }
+  let(:bin_path) { File.expand_path('../../../bin/bollettino-cli', __FILE__) }
+
+  before(:each) do
+    FileUtils.rm(slip_path) if File.exist?(slip_path)
+  end
+
+  it 'generates the slip' do
+    expect {
+      `#{bin_path} generate #{options} #{slip_path}`
+    }.to change{ File.exist?(slip_path) }.from(false).to(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+require 'bollettino/cli'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :mocha
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/unit/bollettino/cli.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+RSpec.describe Bollettino::CLI do
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: bollettino-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bollettino
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: bollettino-cli is a CLI for the Bollettino library. It supports generation
+  from CSV files as well.
+email:
+- desa.alessandro@gmail.com
+executables:
+- bollettino-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/bollettino-cli
+- bollettino-cli.gemspec
+- lib/bollettino/cli.rb
+- lib/bollettino/cli/version.rb
+- spec/fixtures/slips.csv
+- spec/integration/csv_generate_spec.rb
+- spec/integration/generate_spec.rb
+- spec/spec_helper.rb
+- spec/unit/bollettino/cli.rb
+- tmp/.keep
+homepage: https://github.com/interconn-isp/bollettino-cli
+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.4.3
+signing_key: 
+specification_version: 4
+summary: A CLI for the Bollettino library.
+test_files:
+- spec/fixtures/slips.csv
+- spec/integration/csv_generate_spec.rb
+- spec/integration/generate_spec.rb
+- spec/spec_helper.rb
+- spec/unit/bollettino/cli.rb