reggora 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9c7dd2adb2d6a516476d29998b4290c449bae3c885e7724d4da29080143f4bc3
-  data.tar.gz: ec86b3618fa690d53075716f48a7fed9486df20a28a423246ddecade29df0c4f
+SHA1:
+  metadata.gz: 4af8144ca6859604ed393635da6af5f40e16922d
+  data.tar.gz: 9f99e965e6e5393c2e92f289e7b7d48a6afe46cd
 SHA512:
-  metadata.gz: c397f9253aeb3d27b5a2a071c4cf2a4ed2be4658b7c7fb2f4b9c447c48c04696dc76df1e78fc5c9d2d2fbbd53c43c5e6d913ab7fe7ad4b6450c57add71ed7b9b
-  data.tar.gz: 9c09028dbfe4c0b6db97c6db3b9bfd6586a7419587c93e8e5a6542612d9c1eef8aa1791e37e73c3c3766ec8d2107928cec19b39fbce4e8cb04f892a769716d00
+  metadata.gz: 564dc35b635466a6293d786f214d4fa4a6172afee38070946de665f8728b16d63afd7019252c39d6d4dfd63b5dc4e50f1ec4c3b51933ac2e1ffd81ac53d4287e
+  data.tar.gz: e9d90f4f7df264119e685b14eeeb6f82826585481713940cc2a4c8c63e05ad4268831b0877d6bc8f3e32fd45f9d06af108ed2013006d9e1ac2ccf500e4cf8183

data/lib/reggora.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 require_relative 'reggora/Entity/Lender/loan'
 require_relative 'reggora/Entity/Lender/order'
+require_relative 'reggora/Entity/Lender/evault'
+require_relative 'reggora/Entity/Lender/product'
+require_relative 'reggora/Entity/Lender/submission'
+require_relative 'reggora/Entity/Lender/user'
+require_relative 'reggora/Entity/Lender/vendor'
+require_relative 'reggora/Entity/Lender/schedule_payment_app'
 require_relative 'reggora/Adapters/lender_api_client'
+
+# init api client
+
 module Reggora
   # class Error < StandardError; end
 

data/lib/reggora/Adapters/api_client.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'net/http'
 require 'json'
+require 'mime/types'
 class ApiClient
   $base_api_uri = 'https://sandbox.reggora.io/'
 
@@ -12,7 +13,7 @@ class ApiClient
     when Net::HTTPSuccess then
       JSON.parse(response.read_body)
     else
-      response.value
+      response
     end
   end
 end

data/lib/reggora/Adapters/lender_api_client.rb

@@ -21,16 +21,20 @@ class LenderApiClient
     @api_client.get(url, params)
   end
 
-  def post(url, params = {})
-    @api_client.post(url, params)
+  def post(url, params = {}, query_params = {})
+    @api_client.post(url, params, query_params)
+  end
+
+  def post_file(url, params = {})
+    @api_client.post_file(url, params)
   end
 
   def put(url, params = {})
     @api_client.put(url, params)
   end
 
-  def delete(url)
-    @api_client.delete(url)
+  def delete(url, params =  {})
+    @api_client.delete(url, params)
   end
 
 end

data/lib/reggora/Adapters/requests.rb

@@ -16,13 +16,38 @@ class Requests
     send_request Net::HTTP::Get.new(api_endpoint.request_uri, @header)
   end
 
-  def post(url, params = {})
+  def post(url, params = {}, query_params = {})
     api_endpoint = full_uri url
+    api_endpoint.query = URI.encode_www_form(query_params) unless query_params.empty?
     request = Net::HTTP::Post.new(api_endpoint, @header)
     request.body = params.to_json
     send_request request
   end
 
+  def post_file(url, params)
+    api_endpoint = full_uri url
+    boundary = "AaB03x"
+    header = {"Content-Type" => "multipart/form-data, boundary=#{boundary}", "Authorization" => "Bearer #{@header['Authorization']}", "integration" => @header['integration']}
+    # We're going to compile all the parts of the body into an array, then join them into one single string
+    # This method reads the given file into memory all at once, thus it might not work well for large files
+    post_body = []
+    file = params[:file]
+    # Add the file Data
+    post_body << "--#{boundary}\r\n"
+    post_body << "Content-Disposition: form-data; name=\"file\"; filename=\"#{ params[:file_name] || File.basename(file)}\"\r\n"
+    post_body << "Content-Type: #{MIME::Types.type_for(file)}\r\n\r\n"
+    post_body << File.open(file, 'rb') { |io| io.read }
+
+    # Add the JSON
+    post_body << "--#{boundary}\r\n"
+    post_body << "Content-Disposition: form-data; name=\"id\"\r\n\r\n"
+    post_body << params[:id]
+    post_body << "\r\n\r\n--#{boundary}--\r\n"
+    request = Net::HTTP::Post.new(api_endpoint, header)
+    request.body = post_body.to_json
+    send_request request
+  end
+
   def put(url, params = {})
     api_endpoint = full_uri url
     request = Net::HTTP::Put.new(api_endpoint, @header)
@@ -30,9 +55,11 @@ class Requests
     send_request request
   end
 
-  def delete(url)
+  def delete(url, params = {})
     api_endpoint = full_uri url
-    send_request Net::HTTP::Delete.new(api_endpoint, @header)
+    request = Net::HTTP::Delete.new(api_endpoint, @header)
+    request.body = params.to_json
+    send_request request
   end
 
   def send_request(request)
@@ -47,11 +74,23 @@ class Requests
   def handle_response(response)
     case response
     when Net::HTTPSuccess then
-      JSON.parse(response.read_body)
+      json_parse(response.read_body)
     when Net::HTTPBadRequest then
-      raise JSON.parse(response.read_body).inspect
+      res = json_parse(response.read_body)
+      raise res.inspect if res["error"].nil?
+      res
+    when Net::HTTPInternalServerError then
+      raise "Internal server error"
     else
-      raise JSON.parse(response.read_body).inspect
+      raise "Unknown error #{response}: #{response.inspect}"
+    end
+  end
+
+  def json_parse(res)
+    begin
+      JSON.parse(res)
+    rescue JSON::ParserError
+      res
     end
   end
 end

data/lib/reggora/Entity/Lender/evault.rb

@@ -0,0 +1,27 @@
+class Evault
+
+  # returns an eVault object
+  def find(id)
+    $lender_api_client.get("/evault/#{id}")
+  end
+
+  # returns a file object specified by the evault ID and the document ID
+  def document(evault_id, document_id)
+    $lender_api_client.get("/evault/#{evault_id}/#{document_id}")
+  end
+
+  # upload a document to an evault and returns the ID of the document
+  def upload_document(upload_params)
+    $lender_api_client.post_file("/evault", upload_params)
+  end
+
+  # upload a P&S to an order and returns the ID of the P&S document
+  def upload_p_s(upload_params)
+    $lender_api_client.post_file("/order/p_and_s", upload_params)
+  end
+
+  # delete a document from the evault
+  def delete_document(params)
+    $lender_api_client.delete("/evault", params)
+  end
+end

data/lib/reggora/Entity/Lender/loan.rb

@@ -1,21 +1,45 @@
 class Loan
-  def all(params = {})
-    $lender_api_client.get('/loans', params)
+  def initialize
+    @model = 'loan'
+  end
+  # retrieves all loans, and can take a number of query parameters
+  def all(offset = 0, limit = 0, ordering = '-created', loan_officer = [])
+    $lender_api_client.get("/#{@model}s", {offset: offset, limit: limit, ordering: ordering, loan_officer: loan_officer})
   end
 
+  # retrieves a specific loan by id
   def find(id)
-    $lender_api_client.get("/loan/#{id}")
+    $lender_api_client.get("/#{@model}/#{id}")
   end
 
+  # creates a loan and returns the ID of the created loan
   def create(loan_params)
-    $lender_api_client.post('/loan', loan_params)
+    $lender_api_client.post("/#{@model}", loan_params)
   end
 
+  # edits a loan and returns the ID of the edited loan. Only the provided fields will be updated
   def edit(id, loan_params)
-    $lender_api_client.put("/loan/#{id}", loan_params)
+    $lender_api_client.put("/#{@model}/#{id}", loan_params)
   end
-
+  # deletes a specific loan
   def delete(id)
-    $lender_api_client.delete("/loan/#{id}")
+    $lender_api_client.delete("/#{@model}/#{id}")
+  end
+
+  def sample_data
+    n = rand(10...100)
+    s = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+    {
+      "loan_number": "#{3 * n}#{s[1...5]}#{n}",
+      "loan_officer": "",
+      "appraisal_type": "Refinance",
+      "due_date": (Time.now + 60*60*24*30).strftime("%Y-%m-%dT%H:%M:%SZ"),
+      "subject_property_address": "100 Mass Ave",
+      "subject_property_city": "Boston",
+      "subject_property_state": "MA",
+      "subject_property_zip": "02192",
+      "case_number": "10029MA",
+      "loan_type": "FHA"
+    }
   end
 end

data/lib/reggora/Entity/Lender/order.rb

@@ -1,21 +1,78 @@
 class Order
-  def all(params = {})
-    $lender_api_client.get('/orders', params)
+
+  def initialize
+    @model = 'order'
+  end
+
+  # retrieves all orders (limit 10 at a time). Can be filtered with query parameters
+  def all(offset = 0, limit = 0, ordering = '-created', search = '', due_in = nil, loan_officer = [], filter = '')
+    $lender_api_client.get("/#{@model}s", {offset: offset, limit: limit, ordering: ordering, search: search, due_in: due_in, loan_officer: loan_officer, filter: filter})
   end
 
+  # retrieves a specific order by id
   def find(id)
-    $lender_api_client.get("/order/#{id}")
+    $lender_api_client.get("/#{@model}/#{id}")
   end
 
+  # creates an order and returns the ID of the created Order
   def create(loan_params)
-    $lender_api_client.post('/order', loan_params)
+    $lender_api_client.post("/#{@model}", loan_params)
   end
 
+  # edits a order and returns the ID of the edited order
   def edit(id, loan_params)
-    $lender_api_client.put("/order/#{id}", loan_params)
+    $lender_api_client.put("/#{@model}/#{id}", loan_params)
   end
 
+  # cancels a specific order
   def cancel(id)
-    $lender_api_client.delete("/order/#{id}")
+    $lender_api_client.delete("/#{@model}/#{id}/cancel")
+  end
+
+  # place an active order on hold, which will disable editing and other functionality while on hold.
+  def place_on_hold(order_id, reason = '')
+    $lender_api_client.put("/order/#{order_id}/hold", {reason: reason})
+  end
+
+  def remove_from_hold(order_id)
+    $lender_api_client.put("/order/#{order_id}/unhold")
+  end
+
+  def sample_data(loan_id, product_id)
+    order_params_manually = {
+        'allocation_type': 'manually',
+        'loan': loan_id,
+        'priority': 'Rush',
+        'products': [product_id],
+        'due_date': (Time.now + 60*60*24*30).strftime("%Y-%m-%d %H:%M:%S"),
+        'additional_fees': [
+            {
+                'description': 'Large yard',
+                'amount': '50'
+            },
+            {
+                'description': 'Outside regular locations',
+                'amount': '20'
+            }
+        ]
+    }
+    order_params_automatically = {
+        'allocation_type': 'automatically',
+        'loan': loan_id,
+        'priority': 'Rush',
+        'products': [product_id],
+        'due_date': (Time.now + 60*60*24*30).strftime("%Y-%m-%d %H:%M:%S"),
+        'additional_fees': [
+            {
+                'description': 'Large yard',
+                'amount': '50'
+            },
+            {
+                'description': 'Outside regular locations',
+                'amount': '20'
+            }
+        ]
+    }
+    {:manual_allocation_type => order_params_manually, :auto_allocation_type => order_params_automatically}
   end
 end

data/lib/reggora/Entity/Lender/product.rb

@@ -0,0 +1,38 @@
+class Product
+  def initialize
+    @model = 'product'
+  end
+  # retrieves all products.
+  def all(params = {})
+    $lender_api_client.get("/#{@model}s", params)
+  end
+
+  # retrieves a specific product by id.
+  def find(id)
+    $lender_api_client.get("/#{@model}/#{id}")
+  end
+
+  # creates a product and returns the ID of the created product.
+  def create(product_params)
+    $lender_api_client.post("/#{@model}", product_params)
+  end
+
+  # edits a product and returns the ID of the edited product.
+  def edit(id, product_params)
+    $lender_api_client.put("/#{@model}/#{id}", product_params)
+  end
+  # deletes a specific product. If an order or a loan is associated with this product the reference will not be broken.
+  def delete(id)
+    $lender_api_client.delete("/#{@model}/#{id}")
+  end
+
+  def sample_data
+    s = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+    {
+      'product_name': "Product_#{s[1...5]}",
+      'amount': '100.00',
+      'inspection_type': 'interior',
+      'requested_forms': '1004MC, BPO'
+    }
+  end
+end

data/lib/reggora/Entity/Lender/schedule_payment_app.rb

@@ -0,0 +1,32 @@
+class SchedulePaymentApp
+
+  def send_payment_app(consumer_email, order_id, user_type, payment_type, amount, firstname = '', lastname = '')
+    payment_params = payment_attributes(consumer_email, order_id, user_type, payment_type, amount, firstname, lastname)
+    $lender_api_client.post('/consumer/payment', payment_params)
+  end
+
+  def send_scheduling_app(consumer_emails, order_id)
+    $lender_api_client.post("/consumer/scheduling", {consumer_emails: consumer_emails, order_id: order_id})
+  end
+
+  # @param [String] order_id
+  # @param [String] link_type : payment/schedule/both
+  # @param [String] consumer_id
+  def consumer_app_link(order_id, consumer_id, link_type)
+    $lender_api_client.get("/#{order_id}/#{consumer_id}/#{link_type}")
+  end
+
+  def payment_attributes(consumer_email, order_id, user_type, payment_type, amount, firstname = '', lastname = '')
+
+    attributes = {
+        consumer_email: consumer_email,
+        order_id: order_id,
+        user_type: user_type,
+        payment_type: payment_type,
+        amount: amount
+    }
+
+    attributes.merge!({firstname: firstname, lastname: lastname, paid: false}) if user_type == 'manual'
+    attributes
+  end
+end

data/lib/reggora/Entity/Lender/submission.rb

@@ -0,0 +1,14 @@
+class Submission
+  def initialize
+    @model = 'submission'
+  end
+  # retrieves all submissions associated with an order.
+  def all(order_id)
+    $lender_api_client.get("/order-submissions/#{order_id}")
+  end
+
+  # retrieves one of the three forms that are associated with an order submission.
+  def download_submission_doc(order_id, version, report_type)
+    $lender_api_client.get("/order-submission/#{order_id}/#{version}/#{report_type}")
+  end
+end

data/lib/reggora/Entity/Lender/user.rb

@@ -0,0 +1,82 @@
+class User
+  def initialize
+    @model = 'user'
+  end
+
+  # returns a list of all the users in the requesting lender.
+  def all(params = {})
+    $lender_api_client.get("/#{@model}s", params)
+  end
+
+  # takes a user ID as a URL parameter and returns a user object.
+  def find(user_id)
+    $lender_api_client.get("/#{@model}s/#{user_id}")
+  end
+
+  # invites a user to the reggora platform
+  def invite(email, role, firstname, lastname, phone_number)
+    invite_params = invite_params(email, role, firstname, lastname, phone_number)
+    $lender_api_client.post("/#{@model}s/invite", invite_params)
+  end
+
+  # creates a user to the reggora platform.
+  def create(user_params)
+    $lender_api_client.post("/#{@model}s", user_params)
+  end
+
+  # updates a user's information.
+  # No fields are required and only the supplied fields will be updated on the user.
+  def edit(user_id, user_params)
+    $lender_api_client.put("/#{@model}s/#{user_id}", user_params)
+  end
+
+  def delete(user_id)
+    $lender_api_client.delete("/#{@model}s/#{user_id}")
+  end
+
+  def user_attributes(email, role, firstname, lastname, phone_number, branch_id = '', nmls_id = '', matched_users = [])
+    {
+        email: email,
+        role: role,
+        firstname: firstname,
+        lastname: lastname,
+        phone_number: phone_number,
+        branch_id: branch_id,
+        nmls_id: nmls_id,
+        matched_users: matched_users
+    }
+  end
+
+  def invite_params(email, role, firstname, lastname, phone_number)
+    {
+        email: email,
+        role: role,
+        firstname: firstname,
+        lastname: lastname,
+        phone_number: phone_number
+    }
+  end
+
+  def query_params(ordering = '-created', offset = 0, limit = 0, search = '')
+    {
+        ordering: ordering,
+        offset: offset,
+        limit: limit,
+        search: search
+    }
+  end
+
+  def sample_data
+    s = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+    {
+        email: "fake#{s[1...4]}@reggora.com",
+        role: "Admin",
+        firstname: "Fake",
+        lastname: "Person#{s[1...4]}",
+        phone_number: "#{rand(100000...99999)}",
+        branch_id: '',
+        nmls_id: '',
+        matched_users: []
+    }
+  end
+end

data/lib/reggora/Entity/Lender/vendor.rb

@@ -0,0 +1,50 @@
+class Vendor
+  def initialize
+    @model = 'vendor'
+  end
+
+  # returns all the vendors associated with the requesting lender.
+  def all(offset = 0, limit = 0)
+    $lender_api_client.get("/#{@model}s", {offset: offset, limit: limit})
+  end
+
+  # takes a vendor ID as a URL parameter and returns the corresponding vendor.
+  def find(vendor_id)
+    $lender_api_client.get("/#{@model}/#{vendor_id}")
+  end
+
+  # returns the vendors associated with the requesting lender filtered by zip code.
+  def find_by_zone(zones, offset = 0, limit = 0)
+    $lender_api_client.post("/#{@model}s/by_zone", {zones: zones}, {offset: offset, limit: limit})
+  end
+
+  # returns the vendors associated with the requesting lender filtered by branch.
+  def find_by_branch(branch_id)
+    $lender_api_client.get("/#{@model}s/branch", {branch_id: branch_id})
+  end
+
+  # adds a vendor to your lender.
+  def invite(firm_name, firstname, lastname, email, phone)
+    invite_params = vendor_params(firm_name, firstname, lastname, email, phone)
+    $lender_api_client.post("/#{@model}", {}, invite_params)
+  end
+
+  # edits a vendor. Only the fields that are in the request body will be updated.
+  def edit(vendor_id, edit_vendor_params)
+    $lender_api_client.put("/#{@model}/#{vendor_id}", edit_vendor_params)
+  end
+
+  # removes a vendor from your lender panel.
+  def delete(vendor_id)
+    $lender_api_client.delete("/#{@model}/#{vendor_id}")
+  end
+
+  def vendor_params(firm_name = "", firstname = "", lastname = "", phone = "")
+    {
+        firm_name: firm_name,
+        firstname: firstname,
+        lastname: lastname,
+        phone: phone
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reggora
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
-- fatpig
+- reggora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2019-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,9 +52,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: This library makes request to https://sandbox.reggora.io/
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  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'
+description: https://sandbox.reggora.io/
 email:
-- fatpig0416@gmail.com
+- development@reggora.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -63,16 +77,22 @@ files:
 - lib/reggora/Adapters/api_client.rb
 - lib/reggora/Adapters/lender_api_client.rb
 - lib/reggora/Adapters/requests.rb
+- lib/reggora/Entity/Lender/evault.rb
 - lib/reggora/Entity/Lender/loan.rb
 - lib/reggora/Entity/Lender/order.rb
-homepage: https://rubygems.org/gems/raggora
+- lib/reggora/Entity/Lender/product.rb
+- lib/reggora/Entity/Lender/schedule_payment_app.rb
+- lib/reggora/Entity/Lender/submission.rb
+- lib/reggora/Entity/Lender/user.rb
+- lib/reggora/Entity/Lender/vendor.rb
+homepage: https://rubygems.org/gems/reggora
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/gems/
-  homepage_uri: https://rubygems.org/gems/raggora
-  source_code_uri: https://github.com/0x15f/reggora-ruby
-  changelog_uri: https://github.com/0x15f/reggora-ruby/blob/master/CHANGELOG.md
+  homepage_uri: https://rubygems.org/gems/reggora
+  source_code_uri: https://github.com/Reggora/reggora-ruby
+  changelog_uri: https://github.com/Reggora/reggora-ruby/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -88,8 +108,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
-summary: Library for Reggora Lender/Vendor API
+summary: Ruby Client for Reggora Lender/Vendor API
 test_files: []