lucadeal 0.2.18 → 0.2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8159099446dcdae1b4c928d4eac5861cd35fe13f8d37155cdf28dafb30fc21e
-  data.tar.gz: 3c086a2ea6c4c9ec6bc9014fa9500ab9fde0a07c1778a5817fbb64e7409b5670
+  metadata.gz: 0e4fa52c476838906c3ad849ab1bc4a9bf58926a526034553a90d6c6299d7945
+  data.tar.gz: c3e434b8677a0b502cfbef70dc8d936bbc2dd3d7f0be0b6b1e2edea8294baa2c
 SHA512:
-  metadata.gz: 0a26cec96f1a0805044470f8710b36b60aacf344bad53527c2a9fd4ff64557a06836e4eefec21f083e0b51bc48a9854dbe2fdd6fed4d4754aba9fe51fa5890ce
-  data.tar.gz: 8a611e016833673fb1e7fcab747a24d4bfdb4152a60086791a1377d8576feb181255c8b2a0dfeca2f6807a4d11d4d2f579be6353ca62a7996a5f960d8b4f1311
+  metadata.gz: ae66f02ef1861eeb9bf217dc5547b05bdd384a9d25bddd8d12dfd62ab2fea63e3f051c699dc267620488949659c98e772799d027dd27101b2d214b8517b55ba2
+  data.tar.gz: 5ec46b9f38cb9bfda178896e2319d728cd41df86d6fb389342a4e9759351e64608abe33980a7cf35e5a8f25459223521c9a69bf356dc61fad55d8cb83588cdda

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## LucaDeal 0.2.24
+
+* add `luca-deal invoices create --monthly --mail`, send payment list after monthly invoice creation.
+* add 'other_payments' tracking with no invoices.
+* can have limit on fee calculation.
+* initial implment of `luca-deal fee list`
+
+## LucaDeal 0.2.23
+
+* implement `luca-deal invoices list --mail`: payment list via HTML mail
+
+## LucaDeal 0.2.22
+
+* Breaking change: export key 'value' -> 'amount'
+
+## LucaDeal 0.2.21
+
+* Implement `luca-deal fee` subcommands.
+* single invoice creation with contract id fragment.
+
+## LucaDeal 0.2.20
+
+* CLI provides `--nu` option. Add JSON output.
+* `luca-deal invoices list --html`, rendering HTML to stdout.
+
+## LucaDeal 0.2.19
+
+* CLI id completion on Customer delete, Contract create/delete
+* add `describe` to Customer / Contract
+
 ## LucaDeal 0.2.18
 
 * Breaking change: restructure CLI in sub-sub command format.

data/README.md

@@ -61,9 +61,30 @@ Monthly invoices are generated with `invoice create --monthly` sub command. Targ
 $ luca-deal invoice create --monthly [yyyy m]
 ```
 
+Or, any invoice can be created with contract ID. Contract ID is just unique fragment of uuid, listed with `luca-deal invoice create` with no args.
+
+```
+$ luca-deal invoice create 1d3 yyyy m
+```
+
 Invoice conditions are defined by contracts.
 
 
+### Send Invoice
+
+Invoice is implemented with HTML & ERB. Copy [default template](lib/luca_deal/templates/invoice.html.erb) to `templates/` in the data directory, and customize.  
+If you want to send invoices in PDF, you need to install `wkhtmltopdf command separately. Send mail command is as bellows:`
+
+```
+$ luca-deal invoice mail yyyy m
+```
+
+
+### Sales Fee
+
+You can also manage revenue share program with Fee object. Setup proper contract structure.
+
+
 ## Data Structure
 
 Records are stored in YAML format. On historical records, see [LucaRecord](../lucarecord/README.md#historical-field).
@@ -114,7 +135,7 @@ Fields for subscription customers are as bellows:
 | Top level | Second level  |          | historical | Description                                                                                          |
 |-----------|---------------|----------|------------|------------------------------------------------------------------------------------------------------|
 | terms     |               |          |            |                                                                                                      |
-|           | billing_cycle | optional |            | If 'monthly', invoices are generated on each month.                                                  |
+|           | billing_cycle | optional |            | If 'monthly', invoices are generated on each month. If 'other_payments', no_invoices are generated on each month. `no_invoices` are mostly same as invoices, but not sending email. |
 |           | category      | optional |            | Default: 'subscription'                                                                              |
 | products  |               |          |            | Array of products.                                                                                   |
 |           | id            |          |            | reference for Product                                                            |
@@ -133,6 +154,7 @@ Fields for sales fee are as bellows:
 |-----------|--------------|----------|------------|-------------------------------------------------------------------------------------|
 | terms     |              |          |            |                                                                                     |
 |           | category     |          |            | If 'sales_fee', contract is treated as selling commission. |
+|           | limit |          |            | If set, fees are calculated as mas as `limit` months. |
 | rate      |              | optional |            |                                                                                     |
 |           | default      |          |            | sales fee rate.                                                                     |
 |           | initial      |          |            | sales fee rate for items of type=initial.                                           |

data/exe/luca-deal

@@ -5,8 +5,8 @@ require 'date'
 require 'optparse'
 require 'luca_deal'
 
-module LucaCmd
-  class Customer
+class LucaCmd
+  class Customer < LucaCmd
     def self.create(args = nil, params = {})
       if args
         id = LucaDeal::Customer.create(name: args[0])
@@ -18,50 +18,137 @@ module LucaCmd
       end
     end
 
-    def self.delete(args = nil, params = {})
-      if args
-        id = LucaDeal::Customer.delete(args[0])
+    def self.describe(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
+        puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
       else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          render(LucaDeal::Customer.new.describe(list.first), params)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
         puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
         exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Customer.delete(list.first)
+        else
+          puts 'found multiple customer\'s id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
       end
     end
 
     def self.list(args = nil, params = {})
-      LucaDeal::Customer.new.list_name
+      render(LucaDeal::Customer.new.list_name, params)
     end
   end
 
-  class Contract
+  class Contract < LucaCmd
     def self.create(args = nil, params = {})
-      if args
-        id = LucaDeal::Contract.new.generate!(args[0], params['category'])
-        puts "Successfully generated Contract  #{id}" if id
-        puts 'Conditions are tentative. Edit contract detail.' if id
-      else
+      if args.empty?
+        list = LucaDeal::Customer.id_completion('')
         puts 'requires customer\'s id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
         exit 1
+      else
+        list = LucaDeal::Customer.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Contract.new.generate!(list.first, params['category'])
+          puts "Successfully generated Contract  #{id}" if id
+          puts 'Conditions are tentative. Edit contract detail.' if id
+        else
+          puts 'found multiple customer\'s id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
       end
     end
 
-    def self.delete(args = nil, params = {})
-      if args
-        id = LucaDeal::Contract.delete(args[0])
+    def self.describe(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Contract.id_completion('', label: 'customer_name')
+        puts 'requires contract id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+        exit 1
       else
+        list = LucaDeal::Contract.id_completion(args[0])
+        case list.length
+        when 1
+          render(LucaDeal::Contract.new.describe(list.first), params)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args.empty?
+        list = LucaDeal::Contract.id_completion('', label: 'customer_name')
         puts 'requires contract id. exit'
+        list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
         exit 1
+      else
+        list = LucaDeal::Contract.id_completion(args[0])
+        case list.length
+        when 1
+          id = LucaDeal::Contract.delete(list.first)
+        else
+          puts 'found multiple contract id. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        end
       end
     end
   end
 
-  class Invoice
+  class Invoice < LucaCmd
     def self.create(args = nil, params = {})
-      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
       case params['mode']
       when 'monthly'
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
         LucaDeal::Invoice.new(date).monthly_invoice
+        LucaDeal::NoInvoice.new(date).monthly_invoice
+        if params[:mail]
+          LucaDeal::Invoice.new(date).stats_email
+        end
       else
-        puts 'not implemented mode'
+        date = "#{args[1]}-#{args[2]}-#{args[3] || '1'}" if !args.empty?
+        list = LucaDeal::Contract.id_completion(args[0] || '', label: 'customer_name')
+        if args.length != 3
+          puts 'requires contract id & year month. exit'
+          list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+          exit 1
+        else
+          case list.length
+          when 1
+            id = LucaDeal::Invoice.new(date).single_invoice(list.first)
+          else
+            puts 'found multiple contract id. exit'
+            list.each { |item| puts "  #{item[:id]}  #{item[:label]}" }
+            exit 1
+          end
+        end
       end
     end
 
@@ -89,7 +176,13 @@ module LucaCmd
         date = "#{Date.today.year}-#{Date.today.month}-1"
         count = 3
       end
-      LucaDeal::Invoice.new(date).stats(count || 1)
+      if params[:html]
+        LucaDeal::Invoice.new(date).preview_stdout
+      elsif params[:mail]
+        LucaDeal::Invoice.new(date).stats_email
+      else
+        render(LucaDeal::Invoice.new(date).stats(count || 1), params)
+      end
     end
 
     def self.mail(args = nil, params = {})
@@ -102,6 +195,62 @@ module LucaCmd
       end
     end
   end
+
+  class Fee < LucaCmd
+    def self.create(args = nil, params = {})
+      case params['mode']
+      when 'monthly'
+        date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+        LucaDeal::Fee.new(date).monthly_fee
+      else
+        puts "not implemented yet"
+        exit 1
+      end
+    end
+
+    def self.delete(args = nil, params = {})
+      if args
+        id = LucaDeal::Fee.delete(args[0])
+      else
+        puts 'requires contract id. exit'
+        exit 1
+      end
+    end
+
+    def self.list(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      if args.empty?
+        date = "#{Date.today.year}-#{Date.today.month}-1"
+        count = 3
+      end
+      if params[:html]
+        LucaDeal::Fee.new(date).preview_stdout
+      else
+        render(LucaDeal::Fee.new(date).stats(count || 1), params)
+      end
+    end
+
+    def self.mail(args = nil, params = {})
+      date = "#{args[0]}-#{args[1]}-#{args[2] || '1'}" if !args.empty?
+      case params['mode']
+      when 'preview'
+        LucaDeal::Fee.new(date).preview_mail
+      else
+        LucaDeal::Fee.new(date).deliver_mail
+      end
+    end
+  end
+
+  def self.render(dat, params)
+    case params[:output]
+    when 'json'
+      puts JSON.dump(dat)
+    when 'nu'
+      LucaSupport::View.nushell(YAML.dump(dat))
+    else
+      puts YAML.dump(dat)
+    end
+  end
 end
 
 def new_pj(args = nil, params = {})
@@ -116,22 +265,39 @@ case cmd
 when /customers?/
   subcmd = ARGV.shift
   case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal customers create CustomerName'
+      args = opt.parse(ARGV)
+      LucaCmd::Customer.create(args, params)
+    end
   when 'list'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-deal customers list [options]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
       args = opt.parse(ARGV)
       LucaCmd::Customer.list(args, params)
     end
-  when 'create'
+  when 'describe'
     OptionParser.new do |opt|
-      opt.banner = 'Usage: luca-deal customers create CustomerName'
+      opt.banner = 'Usage: luca-deal customers describe [options] customer_id'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
       args = opt.parse(ARGV)
-      LucaCmd::Customer.create(args, params)
+      LucaCmd::Customer.describe(args, params)
     end
   when 'delete'
     LucaCmd::Customer.delete(ARGV)
   else
-    puts 'Usage: luca-deal customers sub-commands'
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal customer[s] subcommands [--help|options]'
+    puts '  create'
+    puts '  list'
+    puts '  describe: show customer with contracts info'
+    puts '  delete'
+    exit 1
   end
 when /contracts?/
   subcmd = ARGV.shift
@@ -145,10 +311,24 @@ when /contracts?/
       args = opt.parse(ARGV)
       LucaCmd::Contract.create(args, params)
     end
+  when 'describe'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal contracts describe [options] customer_id'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      args = opt.parse(ARGV)
+      LucaCmd::Contract.describe(args, params)
+    end
   when 'delete'
     LucaCmd::Contract.delete(ARGV)
   else
-    puts 'Usage: luca-deal contracts Subcommand'
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal contract[s] subcommand [--help|options]'
+    puts '  create'
+    puts '  describe: show contract with puroducts or items info'
+    puts '  delete'
+    exit 1
   end
 when 'export'
   LucaCmd::Invoice.export(ARGV)
@@ -157,8 +337,9 @@ when /invoices?/, 'i'
   case subcmd
   when 'create'
     OptionParser.new do |opt|
-      opt.banner = 'Usage: luca-deal invoices create [options] year month [date]'
-      opt.on('--monthly', 'generate monthly data') { |v| params['mode'] = 'monthly' }
+      opt.banner = 'Usage: luca-deal invoices create [options] --monthly|contract_id year month [date]'
+      opt.on('--monthly', 'generate monthly data') { |_v| params['mode'] = 'monthly' }
+      opt.on('--mail', 'send payment list by email. Only works with --monthly') { |_v| params[:mail] = true }
       args = opt.parse(ARGV)
       LucaCmd::Invoice.create(args, params)
     end
@@ -167,29 +348,83 @@ when /invoices?/, 'i'
   when 'list'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-deal invoices list [options] year month [date]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      opt.on('--html', 'output html invoices') { |_v| params[:html] = 'monthly' }
+      opt.on('--mail', 'send payment list by email') { |_v| params[:mail] = true }
       args = opt.parse(ARGV)
       LucaCmd::Invoice.list(args, params)
     end
   when 'mail'
     OptionParser.new do |opt|
       opt.banner = 'Usage: luca-deal invoices mail [options] year month [date]'
-      opt.on('--preview', 'send to preview user') { |v| params['mode'] = 'preview' }
+      opt.on('--preview', 'send to preview user') { |_v| params['mode'] = 'preview' }
       args = opt.parse(ARGV)
       LucaCmd::Invoice.mail(args, params)
     end
   else
-    puts 'Usage: luca-deal invoices SubCommand'
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal invoices subcommand [--help|options]'
+    puts '  create'
+    puts '  delete'
+    puts '  list'
+    puts '  mail: send mail with invoice'
+    exit 1
   end
 when 'new'
   params = {}
   OptionParser.new do |opt|
+    opt.banner = 'Usage: luca-deal new DIR'
     args = opt.parse(ARGV)
     new_pj(args, params)
   end
+when /fee/
+  subcmd = ARGV.shift
+  case subcmd
+  when 'create'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee create [options] year month [date]'
+      opt.on('--monthly', 'generate monthly data') { |_v| params['mode'] = 'monthly' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.create(args, params)
+    end
+  when 'delete'
+    LucaCmd::Fee.delete(ARGV)
+  when 'list'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee list [options] year month [date]'
+      opt.on('--nu', 'show table in nushell') { |_v| params[:output] = 'nu' }
+      opt.on('-o', '--output VAL', 'output serialized data') { |v| params[:output] = v }
+      opt.on('--html', 'output html invoices') { |_v| params[:html] = 'monthly' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.list(args, params)
+    end
+  when 'mail'
+    OptionParser.new do |opt|
+      opt.banner = 'Usage: luca-deal fee mail [options] year month [date]'
+      opt.on('--preview', 'send to preview user') { |_v| params['mode'] = 'preview' }
+      args = opt.parse(ARGV)
+      LucaCmd::Fee.mail(args, params)
+    end
+  else
+    puts 'Proper subcommand needed.'
+    puts
+    puts 'Usage: luca-deal fee subcommand [--help|options]'
+    puts '  create'
+    puts '  delete'
+    puts '  list'
+    puts '  mail: send mail with report'
+    exit 1
+  end
 else
-  puts 'Usage: luca-deal sub-command [--help|options]'
+  puts 'Proper subcommand needed.'
+  puts
+  puts 'Usage: luca-deal subcommand [options]'
   puts '        customers'
   puts '        contracts'
   puts '        invoices'
-  puts '        export'
+  puts '        new: initialize project dir'
+  puts '        export: puts invoice data for LucaBook import'
+  exit 1
 end