lease 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f2c2ce536808731ab265d729a99b377450321923bae4358393eb913163ad9d
-  data.tar.gz: d9cccba084b9bc3c00683a46b87551c74895ba325d1c35d9b4befa4446fd8739
+  metadata.gz: a86858ad2b1be09213786c6cc31a387d9fd221f235c94a4764ab985928c1c63a
+  data.tar.gz: bc95fa3227d60b838810a8454a2e6c83607e7b73061ccc9d7b33beb75059b309
 SHA512:
-  metadata.gz: da1539967d5f6ad2d4f389675e9cc34cf52308af15bd5ac248c31c4ea876b99d4132b9bd445e3fed42c204b4fab0602a6d49a1194009ad888154a782fedfb836
-  data.tar.gz: a4571691e8a17c8b3c3fc82339aa424933414d4573087ac58300590fec7cf9305411067f253ae7db866323f455518ea8210185b953cb2e232f673172db84f467
+  metadata.gz: eb7f44f7dbc8ad2e79ad09ecb4a1e17b441cf7aac24918bb77e99f47f1e1a92d0ae78d241b3f79134b8e9c13f4d4353d79d63ba19d17a051936d457ce393f9e0
+  data.tar.gz: 667cf07b65a1f501d956227c2cab3bd99f653a29298377dc253f925629612de583fe430dd959baeba721bb79c57254c7d181695a0fa635ea2753674df74dc213

data/README.md

@@ -3,10 +3,11 @@
 Simplify the lease pdf/html management. Specially designed for a real estate self-storage project.
 
 ## Usage
-1. `rails g lease:install`
+1. Add the gem to your gemfile.
+`gem lease, '>= 0.1.1'`
+2. `rails g lease:install`
 `rake db:migrate`
-
-2. On any model you want to treat as a "signer" of an envelope/template, add `lease_signable`:
+3. On any model you want to treat as a "signer" of an envelope/template, add `lease_signable`:
 ```ruby
 class User < ApplicationRecord
 
@@ -14,7 +15,7 @@ class User < ApplicationRecord
 
 end
 ```
-3. On any model you want treat as a leasing property, add `lease_envelopable`:
+4. On any model you want treat as a leasing property, add `lease_envelopable`:
 ```ruby
 class Occupancy < ApplicationRecord
 
@@ -22,27 +23,29 @@ class Occupancy < ApplicationRecord
 
 end
 ```
-4. You can now call some methods like:
+5. You can now call some methods like:
 ```ruby
-user = User.new(full_name:'Jason Smolar') # the signable model
-occupancy = Occupancy.new # the leasable model
+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'
+
+# hash of variables to be interpolated into html file. Pass html id to hash key.
+vars = {
+  rental_price: '$12',                            # there's an html DOM in the template 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.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
+    pdf_file.read                                 # pdf_file will be closed 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
+  envelope.unsigned?                              # true
+   
+  envelope.sign(vars)                             # Generate and returns the signed pdf. PDF is stored in
+  envelope.signed_pdf                             # Carrierwave::Storage::File
+  envelope.signed?                                # true
 end
 ```
 ## Development

data/app/uploaders/lease/document_uploader.rb

@@ -1,13 +1,16 @@
 module Lease
-  class DocumentUploader < ::CarrierWave::Uploader::Base
+  class DocumentUploader < CarrierWave::Uploader::Base
 
     # Include RMagick or MiniMagick support:
     # include CarrierWave::RMagick
     # include CarrierWave::MiniMagick
 
     # Choose what kind of storage to use for this uploader:
-    storage :file
-    # storage :fog
+    if Rails.application.config.enable_s3
+      storage :fog
+    else
+      storage :file
+    end
 
     # Override the directory where uploaded files will be stored.
     # This is a sensible default for uploaders that are meant to be mounted:
@@ -15,37 +18,15 @@ module Lease
       "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
 
-    # Provide a default URL as a default if there hasn't been a file uploaded:
-    # def default_url(*args)
-    #   # For Rails 3.1+ asset pipeline compatibility:
-    #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
-    #
-    #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
-    # end
-
-    # Process files as they are uploaded:
-    # process scale: [200, 300]
-    #
-    # def scale(width, height)
-    #   # do something
-    # end
-
-    # Create different versions of your uploaded files:
-    # version :thumb do
-    #   process resize_to_fit: [50, 50]
-    # end
-
     # Add a white list of extensions which are allowed to be uploaded.
     # For images you might use something like this:
-    def extension_whitelist
-      %w(pdf html)
+    def extension_white_list
+      %w[html htm pdf]
     end
 
-    # Override the filename of the uploaded files:
-    # Avoid using model.id or version_name here, see uploader/store.rb for details.
-    # def filename
-    #   "something.jpg" if original_filename
-    # end
-
+    def self.mime_type_white_list
+      types = ['text/html', 'application/pdf']
+      types.join(', ')
+    end
   end
 end

data/lib/lease/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lease
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ninja Rails