lease 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2be63f29aefc7beb86b4646de33e0b298a86988f207813028c2b1d20a707ea05
-  data.tar.gz: b9de86ef8bd2e00212c520fb70ddf00534c86d7706842a20f6ef69218939a6d5
+  metadata.gz: d3f2c2ce536808731ab265d729a99b377450321923bae4358393eb913163ad9d
+  data.tar.gz: d9cccba084b9bc3c00683a46b87551c74895ba325d1c35d9b4befa4446fd8739
 SHA512:
-  metadata.gz: 52d417ed5229121af07e8baf35741eba1965123792df62c515e48b77255b29476c69c72719d33a5fd1f7daea7f0d8aeefc088ccd85e5445d8fa906331f930219
-  data.tar.gz: 4daf8ce6eb9a4bb39dd59e92b720c15e3e90d42cd1d9020f1dea06ab97a2cd24b263b43894ac72d9995354b672bde66bcf310c504ed76ce704269e3afa9c3752
+  metadata.gz: da1539967d5f6ad2d4f389675e9cc34cf52308af15bd5ac248c31c4ea876b99d4132b9bd445e3fed42c204b4fab0602a6d49a1194009ad888154a782fedfb836
+  data.tar.gz: a4571691e8a17c8b3c3fc82339aa424933414d4573087ac58300590fec7cf9305411067f253ae7db866323f455518ea8210185b953cb2e232f673172db84f467

data/README.md

@@ -1,16 +1,48 @@
 # Lease
 
-Trying to simplify the lease pdf/html management
+Simplify the lease pdf/html management. Specially designed for a real estate self-storage project.
 
 ## Usage
+1. `rails g lease:install`
+`rake db:migrate`
 
-On any model you want to treat as a "signer" of an envelope/template, add `leasable` to create an association to both envelopes and templates:
-
+2. On any model you want to treat as a "signer" of an envelope/template, add `lease_signable`:
 ```ruby
 class User < ApplicationRecord
 
-  leasable
+  lease_signable
+
+end
+```
+3. On any model you want treat as a leasing property, add `lease_envelopable`:
+```ruby
+class Occupancy < ApplicationRecord
 
+  lease_envelopable
+
+end
+```
+4. You can now call some methods like:
+```ruby
+user = User.new(full_name:'Jason Smolar') # the signable model
+occupancy = Occupancy.new # the leasable model
+template = Lease::Template.create(state: 'CA', template: File.open('/tmp/ca_lease_template.html'))
+envelope = user.create_envelope(template: template, envelopable: occupancy)
+vars = { # hash of variables to be interpolated into html file. Pass html id to hash key.
+  rental_price: '$12', # there should be a html DOM in the template file with the id 'rental_price'
+  ...
+}
+if user.has_unsigned_lease?
+  envelope = user.envelopes.unsigned.first
+  envelope.unsigned_html(vars) # returns html without tenant sign
+  envelope.with_unsigned_pdf(vars) do |pdf_file|
+    pdf_file.read # pdf_file is temporary use only and will be deleted after this block
+  end
+  envelope.unsigned? # true
+  # Generate and returns the signed pdf. PDF is stored in 
+  envelope.sign(vars)
+  envelope.signed_pdf # Carrierwave::Storage::File
+  envelope.signed? # true
 end
 ```
 ## Development
@@ -25,5 +57,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/mingca
 
 ## License
 
-The gem is available as open source under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html).
+The gem is available as open source under the terms of the [MIT](https://opensource.org/licenses/MIT).
 

data/app/models/lease/envelope.rb

@@ -5,9 +5,9 @@ module Lease
 
     mount_uploader :signed_pdf, ::Lease::DocumentUploader
 
-    belongs_to :template
-    belongs_to :envelopable, polymorphic: true
-    belongs_to :signable, polymorphic: true
+    belongs_to :template, required: true
+    belongs_to :envelopable, polymorphic: true, required: true
+    belongs_to :signable, polymorphic: true, required: true
 
     enum status: [:unsigned, :rejected, :signed]
 
@@ -20,33 +20,40 @@ module Lease
     end
 
     def sign(vars)
-      return false if signed?
+      return nil if signed?
 
       html = interpolate(with_sign(vars))
       with_generate_pdf(html) do |temp_pdf|
-        update(signed_pdf: temp_pdf)
+        update(signed_pdf: temp_pdf, status: :signed)
       end
     end
 
     private
 
-      def with_generate_pdf(html, &block)
+      def with_generate_pdf(html)
         random = SecureRandom.hex(4)
         pdf_string = WickedPdf.new.pdf_from_string(html, extra: '--enable-forms')
         pdf_file_name = Rails.root.join('tmp', 'pdf_lease_documents', "pdf-lease-#{envelopable.id}-#{random}.pdf")
         pdf_file = File.new(pdf_file_name, 'a+:ASCII-8BIT')
         pdf_file.write(pdf_string)
 
-        yield pdf_file
-
+        result = yield pdf_file if block_given?
         File.delete(pdf_file_name)
+        result
       end
 
+      # TODO: check if any field in html has not been interpolated
       def interpolate(vars)
         page = Nokogiri::HTML(template.html_file.read)
-        vars.each do |id, value|
-          span = page.at_css("[id=\"#{id}\"]")
-          span.content = value
+        vars.each do |dom_id, value|
+          spans = page.css("[id=\"#{dom_id}\"]")
+          if spans.present?
+            spans.each do |span|
+              span.content = value
+            end
+          else
+            Rails.logger.info "Lease Envelope #{self.id}: dom id #{dom_id} not found in template"
+          end
         end
         page.to_html
       end
@@ -56,7 +63,7 @@ module Lease
       end
 
       def with_sign(vars)
-        vars.merge(Lease.config.lessee_sign_key => signable.full_name)
+        vars.merge(Lease.config.lessee_sign_key => signable.full_name) if signable&.full_name.present?
       end
 
   end

data/app/models/lease/template.rb

@@ -6,5 +6,7 @@ module Lease
     has_many :envelopes
 
     validates :html_file, presence: true
+    validates :state, presence: true, uniqueness: true
+
   end
-end
+end

data/db/migrate/create_lease_envelopes.rb

@@ -2,11 +2,12 @@ class CreateLeaseEnvelopes < ActiveRecord::Migration[5.1]
   def change
     create_table :lease_envelopes do |t|
       t.integer :template_id
-      t.string :lessee_name
       t.integer :status, default: 0
       t.string :signed_pdf
       t.references :envelopable, polymorphic: true, index: { name: 'index_lease_envelopes_on_envelopable_type_and_id' }
       t.references :signable, polymorphic: true, index: { name: 'index_lease_envelopes_on_signable_type_and_id' }
+
+      t.timestamps
     end
   end
 end

data/db/migrate/create_lease_templates.rb

@@ -3,6 +3,8 @@ class CreateLeaseTemplates < ActiveRecord::Migration[5.1]
     create_table :lease_templates do |t|
       t.string :state
       t.string :html_file
+
+      t.timestamps
     end
   end
 end

data/lease.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ['ninjarailsdev@gmail.com']
 
   spec.summary       = %q{Lease templates and envelopes}
-  spec.homepage      = 'https://www.github.com/lease'
-  spec.license       = 'GPL-3.0'
+  spec.homepage      = 'https://www.github.com/mingca/lease.git'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

data/lib/generators/lease/install_generator.rb

@@ -23,6 +23,7 @@ Lease.setup do |config|
   config.lessee_sign_key = :tenant_full_name
 
 end
+
 FileUtils.mkdir_p "#{Rails.root}/tmp/pdf_lease_documents"
 CONTENT
       end

data/lib/lease/active_record.rb

@@ -1,8 +1,16 @@
 module Lease
   module ActiveRecord
 
-    def leasable
-      has_many :envelopes, as: :envelopable, inverse_of: :envelopable, validate: true, autosave: true, class_name: '::Lease::Envelope'
+    def lease_envelopable
+      has_one :envelope, as: :envelopable, inverse_of: :envelopable, validate: true, autosave: true, class_name: '::Lease::Envelope'
+    end
+
+    def lease_signable
+      has_many :envelopes, as: :signable, inverse_of: :signable, validate: true, autosave: true, class_name: '::Lease::Envelope'
+
+      def has_unsigned_lease?
+        envelopes.unsigned.exists?
+      end
     end
 
   end

data/lib/lease/version.rb

@@ -1,3 +1,3 @@
 module Lease
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lease
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ninja Rails
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -180,9 +180,9 @@ files:
 - lib/lease/config.rb
 - lib/lease/engine.rb
 - lib/lease/version.rb
-homepage: https://www.github.com/lease
+homepage: https://www.github.com/mingca/lease.git
 licenses:
-- GPL-3.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []