docusign_dtr 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5da087fda3a230a4db8737e07c5dea37eb6f43350b74242366384857e1b69f03
-  data.tar.gz: 77fd8fd7cf0f4fd3f42087ccbdb122199d93fdb26200dd1a78df24e1d9ebe031
+  metadata.gz: 13d3250540c09372453765cfcdf03f65c96f6086669281bc5533c9796372c0e0
+  data.tar.gz: ad80189d0f717a1026c8c5fb285db5aca8ab3b38f886009667957aa2640b4ef2
 SHA512:
-  metadata.gz: 4d5440a1d3be5c02df50b1abf58920d01b635814d94bd50b9f1e6e3e1144f98ccb25453aae24cd1ced9bf2d624b8ee4cbea1c08c5cdea62e1ac7ec76fc73896a
-  data.tar.gz: 701e93da058fee1dbd86727da015e819726f6f1c33b89bd21ea48a92db1b9a6214db5199aee4128a6960a96abcbafcbc9d26f93cc3844b2c039bba3415763697
+  metadata.gz: 3dcc6ecd775e27f5a1b6923a7fd7d18612a6908a230f1bbd9b265b9ef31ef48dab765938a7aa1e3294b2986713eef40524a61bb48d84dba74691099d670968eb
+  data.tar.gz: 92061dcb875c9980a5d1787ea25fd03c7bf0a42fdb1ae1f4047f280cec06f4c4bbde5cbe7de6858d798ab3a86dc230e442ff26df3b39283f8fa42701d75a2a66

data/docusign_dtr.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.5'
 
   raise 'RubyGems 2.5 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/docusign_dtr.rb

@@ -30,6 +30,7 @@ require 'docusign_dtr/meta_timezone'
 require 'docusign_dtr/meta_transaction_side'
 require 'docusign_dtr/office'
 require 'docusign_dtr/office'
+require 'docusign_dtr/query_param_helper'
 require 'docusign_dtr/room'
 require 'docusign_dtr/task_list'
 require 'docusign_dtr/title'

data/lib/docusign_dtr/auth/base.rb

@@ -73,11 +73,14 @@ module DocusignDtr
         when 400
           # {"error":"invalid_grant"}
           return DocusignDtr::InvalidGrant if response.parsed_response['error'].match?(/grant/)
+
           DocusignDtr::ConsentRequired # {"error":"consent_required"}
         when 401
           DocusignDtr::Unauthorized
         when 403
           DocusignDtr::Forbidden
+        when 204
+          DocusignDtr::NoContent
         else
           StandardError
         end

data/lib/docusign_dtr/auth/code.rb

@@ -19,6 +19,7 @@ module DocusignDtr
 
       def request_token(code:, state: nil)
         raise 'State does ont match. Possible CSRF!' if state && state != @config.state
+
         params = { grant_type: :authorization_code, code: code }
         response = self.class.post(auth_uri, query: params, headers: headers, timeout: 60)
         handle_error(response.code) if response.code != 200
@@ -27,6 +28,7 @@ module DocusignDtr
 
       def refresh_token
         raise 'No token to refresh' unless @token_response&.access_token
+
         params = { grant_type: :refresh_token, refresh_token: @token_response.access_token }
         response = self.class.post("#{base_uri}oauth/token", query: params, headers: headers, timeout: 60)
         handle_error(response.code) if response.code != 200

data/lib/docusign_dtr/client.rb

@@ -18,12 +18,12 @@ module DocusignDtr
     def raw(page, params = {})
       full_path = [base_uri, page].join
       response = self.class.get(full_path, query: params, headers: headers, timeout: 60)
-      handle_error(response.code) if response.code != 200
+      handle_error(response) if response.code != 200
       response.parsed_response
     end
 
-    def handle_error(response_code)
-      raise error_type(response_code), "Error communicating: Response code #{response_code}"
+    def handle_error(response)
+      raise error_type(response), "Error communicating: Response code #{response.code}"
     end
 
     def Document # rubocop:disable  Naming/MethodName
@@ -180,12 +180,19 @@ module DocusignDtr
       end
     end
 
-    def error_type(response_code)
-      case response_code
+    def error_type(response)
+      case response.code
+      when 400
+        # {"error":"invalid_grant"}
+        return DocusignDtr::InvalidGrant if response.parsed_response['error'].match?(/grant/)
+
+        DocusignDtr::ConsentRequired # {"error":"consent_required"}
       when 401
         DocusignDtr::Unauthorized
       when 403
         DocusignDtr::Forbidden
+      when 204
+        DocusignDtr::NoContent
       else
         StandardError
       end

data/lib/docusign_dtr/exceptions.rb

@@ -1,6 +1,8 @@
 module DocusignDtr
   class ConsentRequired < StandardError; end
   class InvalidGrant < StandardError; end
+  class InvalidParameter < StandardError; end
   class Forbidden < StandardError; end
+  class NoContent < StandardError; end
   class Unauthorized < StandardError; end
 end

data/lib/docusign_dtr/models/room.rb

@@ -4,6 +4,8 @@ module DocusignDtr
       include Virtus.model
       attribute :address, DocusignDtr::Models::Address
       attribute :auction_details, DocusignDtr::Models::AuctionDetail
+      attribute :buyer1, DocusignDtr::Models::Contact
+      attribute :buyer2, DocusignDtr::Models::Contact
       attribute :closed_status_id
       attribute :company_room_status_id
       attribute :contract_amount
@@ -22,22 +24,58 @@ module DocusignDtr
       attribute :room_id
       attribute :room_image_url
       attribute :room_name
+      attribute :rooms
       attribute :status
       attribute :view_link
       attr_accessor :client
 
+      ACCEPTABLE_VALUES = {
+        room_status: %w[
+          Active
+          Pending
+          Closed
+          Open
+        ],
+        transaction_side: %w[
+          buy
+          sell
+          listbuy
+          refi
+        ],
+        sort: [
+          'RoomName',
+          'RoomName desc',
+          'CreatedDate',
+          'CreatedDate desc',
+          'ExpectedClosingDate',
+          'ExpectedClosingDate desc',
+          'LastUpdatedDate',
+          'LastUpdatedDate desc',
+          'ClosedDate',
+          'ClosedDate desc'
+        ],
+        date_range_type: %w[
+          Created
+          LastUpdated
+          Closed
+        ]
+      }.freeze
+
       def documents
         return [] unless room_id
+
         ::DocusignDtr::Document.new(client: client).all_by_room_id(room_id)
       end
 
       def task_lists
         return [] unless room_id
+
         ::DocusignDtr::TaskList.new(client: client).all_by_room_id(room_id)
       end
 
       def users
         return [] unless room_id
+
         ::DocusignDtr::User.new(client: client).all_by_room_id(room_id)
       end
     end

data/lib/docusign_dtr/models/task.rb

@@ -49,6 +49,7 @@ module DocusignDtr
 
       def activities
         return [] unless task_id
+
         ::DocusignDtr::Activity.new(client: client).all_by_task_id(task_id)
       end
     end

data/lib/docusign_dtr/query_param_helper.rb

@@ -0,0 +1,135 @@
+module DocusignDtr
+  # rubocop:disable Metrics/ClassLength
+  class QueryParamHelper
+    # rubocop:disable Naming/PredicateName
+    QUERY_PARAMS = {
+      search: :search,
+      count: :count,
+      end_date: :endDate,
+      start_position: :startPosition,
+      room_status: :roomStatus,
+      owned_only: :ownedOnly,
+      transaction_side: :transactionSide,
+      is_under_contract: :isUnderContract,
+      region_id: :regionId,
+      office_id: :officeId,
+      has_submitted_task_list: :hasSubmittedTaskList,
+      has_contract_amount: :hasContractAmount,
+      sort: :sort,
+      date_range_type: :dateRangeType,
+      start_date: :startDate
+    }.freeze
+
+    class << self
+      def call(options)
+        @options = options
+        QUERY_PARAMS.each_with_object({}) do |(key, value), memo|
+          memo[value] = send(key) if @options.key? key
+        end
+      end
+
+      def search
+        @options[:search].to_s
+      end
+
+      def count
+        @options[:count].to_i
+      end
+
+      def start_position
+        @options[:start_position].to_i
+      end
+
+      def room_status
+        unless acceptable_value?(:room_status, @options[:room_status])
+          raise DocusignDtr::InvalidParameter.new("value #{@options[:room_status]} is not valid for #{__method__}")
+        end
+
+        @options[:room_status].to_s
+      end
+
+      def owned_only
+        to_boolean(@options[:owned_only], __method__)
+      end
+
+      def transaction_side
+        unless acceptable_value?(:transaction_side, @options[:transaction_side])
+          raise DocusignDtr::InvalidParameter.new("value #{@options[:transaction_side]} is not valid for #{__method__}")
+        end
+
+        @options[:transaction_side].to_s
+      end
+
+      def is_under_contract
+        to_boolean(@options[:is_under_contract], __method__)
+      end
+
+      def region_id
+        @options[:region_id].to_i
+      end
+
+      def office_id
+        @options[:office_id].to_i
+      end
+
+      def has_submitted_task_list
+        to_boolean(@options[:has_submitted_task_list], __method__)
+      end
+
+      def has_contract_amount
+        to_boolean(@options[:has_contract_amount], __method__)
+      end
+
+      def sort
+        unless acceptable_value?(:sort, @options[:sort].to_s)
+          raise DocusignDtr::InvalidParameter.new("value #{@options[:sort]} is not valid for #{__method__}")
+        end
+
+        @options[:sort].to_s
+      end
+
+      def date_range_type
+        unless acceptable_value?(:date_range_type, @options[:date_range_type])
+          raise DocusignDtr::InvalidParameter.new(
+            "value #{@options[:date_range_type]} is not valid for #{__method__}"
+          )
+        end
+
+        @options[:date_range_type].to_s
+      end
+
+      def start_date
+        to_date(@options[:start_date].to_s, __method__)
+      end
+
+      def end_date
+        to_date(@options[:end_date].to_s, __method__)
+      end
+
+      def to_boolean(value, key)
+        unless value.is_a?(FalseClass) || value.is_a?(TrueClass)
+          raise DocusignDtr::InvalidParameter.new("value #{value} is not valid for #{key}")
+        end
+
+        value
+      end
+
+      def to_date(value, key)
+        DateTime.parse(value)
+        value
+      rescue ArgumentError
+        raise DocusignDtr::InvalidParameter.new("#{value} is not a valid #{key}")
+      end
+
+      def acceptable_value?(key, value)
+        query_acceptable_values[key].include?(value)
+      end
+
+      def query_acceptable_values
+        DocusignDtr::Models::Room::ACCEPTABLE_VALUES
+      end
+    end
+  end
+  # rubocop:enable Naming/PredicateName
+  # rubocop:enable Metrics/ClassLength
+end

data/lib/docusign_dtr/room.rb

@@ -2,16 +2,36 @@ module DocusignDtr
   class Room
     attr_accessor :client
 
+    MAX_ROOMS = 100
+    MAX_BATCHES = 10_000
+
     def initialize(client:)
       @client = client
     end
 
-    def all
-      @client.get('/rooms')['rooms'].map do |room_attrs|
+    def all(options = {})
+      options[:count] ||= MAX_ROOMS
+      rooms = []
+      (1..MAX_BATCHES).each do
+        current_batch = batch(options)
+        rooms += current_batch
+        break if current_batch.size < options[:count]
+      end
+      rooms
+    end
+
+    def batch(options = {})
+      @client.get('/rooms', query_params(options))['rooms'].map do |room_attrs|
         room = DocusignDtr::Models::Room.new(room_attrs)
         room.client = client
         room
       end
+    rescue DocusignDtr::NoContent
+      []
+    end
+
+    def query_params(options)
+      DocusignDtr::QueryParamHelper.call(options)
     end
 
     def find(id)

data/lib/docusign_dtr/version.rb

@@ -1,3 +1,3 @@
 module DocusignDtr
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docusign_dtr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Loft47
@@ -34,7 +34,7 @@ cert_chain:
   WPTyTwBv5qAL48mT3OBIV99mY13XurTi2s2OCJAgkQZIQlGsFzmT/4IDYivCoABO
   QVWtuf6LfMkXYW5shBsTlpiGbXeVlm0QW2Av3w==
   -----END CERTIFICATE-----
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -303,6 +303,7 @@ files:
 - lib/docusign_dtr/models/user.rb
 - lib/docusign_dtr/office.rb
 - lib/docusign_dtr/profile.rb
+- lib/docusign_dtr/query_param_helper.rb
 - lib/docusign_dtr/region.rb
 - lib/docusign_dtr/room.rb
 - lib/docusign_dtr/task_list.rb