basecrm 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92229089fcba5bc483cd535b0051c1b8152bcb7e
-  data.tar.gz: dfcf4b3aff75892ab61169edf258d6ff8a1c7b7e
+  metadata.gz: 4e8513fed187fd425dfc03d14f6edc9e0312d5b8
+  data.tar.gz: fe357512fa2b8b38d7bd690b74d8dcf8a3aa2278
 SHA512:
-  metadata.gz: 3e350b8c9775825b4d5e5ba4e71d8314ad5cad01277ff9382ed693824e79eeedee83286f319cf1c834432c0e74bd91b206472ab7d097fb154ab6a89745f78cba
-  data.tar.gz: 9e31e4502b094a224624ea90451d19ed392aa3b9bce518f7a6b42dbe42714f7d6bc088ef4128a3746d33422f5352611ba09732e3c10cd4df4d429dcd906446f3
+  metadata.gz: 07aefda4c009ce86458520ca4e581d05d5deeea651194c8a8f025a046a0a3edd33f41358ae00a4b59d8a30a76b460d49bcc6beec816946b811fa33de7f9b5819
+  data.tar.gz: b24f5704e1bc9c043cb7b59facef478fcbc3088febf54775449a09ab39d56e4ce80498815213e4723b93620a884889e7bc53066abf651e2c083037ca594223cf

data/README.md

@@ -93,7 +93,7 @@ client = BaseCRM::Client.new(access_token: "<YOUR_PERSONAL_ACCESS_TOKEN>")
 coffeeshop = client.contacts.where(name: "Coffee Shop")
 
 deal = client.deals.create(name: "Website redesign", contact_id: coffeeshop.id)
-deal.value = 1000
+deal.value = BigDecimal("1000.99")
 deal.currency = "USD"
 
 client.deals.update(deal) # => BaseCRM::Deal
@@ -202,6 +202,20 @@ Actions:
 * Update a deal - `client.deals.update`
 * Delete a deal - `client.deals.destroy`
 
+**A note about deal value**
+
+It is prefered to use a BigDecimal when creating or modyfing a deal value. This guarantees correct precision
+
+```
+deal.value = BigDecimal("1000.98")
+```
+
+You should not be using floats as it may result in precision loss.
+
+```
+deal.value = 1000.98
+```
+
 ### Lead
 
 ```ruby

data/lib/basecrm.rb

@@ -7,6 +7,8 @@ require 'basecrm/envelope'
 require 'basecrm/configuration'
 require 'basecrm/http_client'
 
+require 'basecrm/utils/coercion.rb'
+
 require 'basecrm/model'
 require 'basecrm/models/meta'
 require 'basecrm/models/account'

data/lib/basecrm/models/deal.rb

@@ -52,7 +52,12 @@ module BaseCRM
     #   @return [Array<String>] An array of tags for a deal. See more at [Tags](/docs/rest/articles/requests#tags).
     # attr_accessor :tags
     # @!attribute [rw] value
-    #   @return [Integer] Value of the deal in a currency specified in the `currency` field.
+    #   @return [BigDecimal] Value of the deal in a currency specified in the `currency` field.
     # attr_accessor :value
+
+    def initialize(*args)
+      super
+      @table[:value] = BaseCRM::Coercion.to_decimal_value(@table[:value] || 0)
+    end
   end
 end

data/lib/basecrm/services/deals_service.rb

@@ -131,6 +131,7 @@ module BaseCRM
     end
        
     def sanitize(deal)
+      deal.value = Coercion.to_string(deal.value)
       deal.to_h.select { |k, _| OPTS_KEYS_TO_PERSIST.include?(k) }
     end
   end

data/lib/basecrm/utils/coercion.rb

@@ -0,0 +1,16 @@
+require "bigdecimal"
+
+module BaseCRM
+  class Coercion
+    def self.to_decimal_value(value)
+      BigDecimal.new((value || 0), 15)
+    end
+
+    def self.to_string(value)
+      case value
+      when BigDecimal then value.to_s('F')
+      else value.to_s
+      end
+    end
+  end
+end

data/lib/basecrm/version.rb

@@ -1,3 +1,3 @@
 module BaseCRM
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/spec/support/client_helpers.rb

@@ -1,12 +1,16 @@
 module ClientHelpers
   def client
-    @client ||= BaseCRM::Client.new(access_token: access_token)
+    @client ||= BaseCRM::Client.new(access_token: access_token, base_url: base_url)
   end
 
   def access_token
     @access_token ||= ENV.fetch("BASECRM_ACCESS_TOKEN") { raise '"BASECRM_ACCESS_TOKEN" has not been found.'  }
   end
 
+ def base_url
+    @basecrm_url ||= ENV.fetch("BASECRM_BASE_URL") { "https://api.getbase.com" }
+ end
+
   def contact
     @contact ||= FactoryGirl.create(:contact)
   end

data/spec/utils/coercion.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe BaseCRM::Coercion do
+  describe "to_decimal" do
+    it { expect(BaseCRM::Coercion.to_decimal_value(0)).to eql(0) }
+    it { expect(BaseCRM::Coercion.to_decimal_value("0")).to eql(0) }
+    it { expect(BaseCRM::Coercion.to_decimal_value(nil)).to eql(0) }
+    it { expect(BaseCRM::Coercion.to_decimal_value(1.1)).to eql(BigDecimal.new("1.1", 15)) }
+    it { expect(BaseCRM::Coercion.to_decimal_value("1.11")).to eql(BigDecimal.new("1.11", 15)) }
+  end
+end

data/spec/utils/coercion_spec.rb

@@ -0,0 +1,21 @@
+require "bigdecimal"
+require "spec_helper"
+
+describe BaseCRM::Coercion do
+  describe "to_decimal" do
+    it { expect(BaseCRM::Coercion.to_decimal_value(0)).to eql(0) }
+    it { expect(BaseCRM::Coercion.to_decimal_value("0")).to eql(0) }
+    it { expect(BaseCRM::Coercion.to_decimal_value(nil)).to eql(0) }
+    it { expect(BaseCRM::Coercion.to_decimal_value(1.1)).to eql(BigDecimal.new("1.1", 15)) }
+    it { expect(BaseCRM::Coercion.to_decimal_value("1.11")).to eql(BigDecimal.new("1.11", 15)) }
+  end
+
+  describe "to_string" do
+    it { expect(BaseCRM::Coercion.to_string(1)).to eql("1") }
+    it { expect(BaseCRM::Coercion.to_string("1")).to eql("1") }
+    it { expect(BaseCRM::Coercion.to_string(1.11)).to eql("1.11") }
+    it { expect(BaseCRM::Coercion.to_string("1.11")).to eql("1.11") }
+    it { expect(BaseCRM::Coercion.to_string(BigDecimal("1.11"))).to eql("1.11") }
+    it { expect(BaseCRM::Coercion.to_string(BigDecimal(1.11, 15))).to eql("1.11") }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basecrm
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - BaseCRM developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -171,6 +171,7 @@ files:
 - lib/basecrm/services/tasks_service.rb
 - lib/basecrm/services/users_service.rb
 - lib/basecrm/sync.rb
+- lib/basecrm/utils/coercion.rb
 - lib/basecrm/version.rb
 - spec/basecrm/sync_spec.rb
 - spec/factories/associated_contact.rb
@@ -199,6 +200,8 @@ files:
 - spec/services/users_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/client_helpers.rb
+- spec/utils/coercion.rb
+- spec/utils/coercion_spec.rb
 homepage: https://github.com/basecrm/basecrm-ruby
 licenses:
 - MIT
@@ -219,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: BaseCRM Official API V2 library client for ruby
@@ -251,4 +254,6 @@ test_files:
 - spec/services/users_service_spec.rb
 - spec/spec_helper.rb
 - spec/support/client_helpers.rb
+- spec/utils/coercion.rb
+- spec/utils/coercion_spec.rb
 has_rdoc: