salesforce-orm 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 303fe6c567cdeb834103e79e613875af01482118
-  data.tar.gz: 4ab2e2a284c173d67999eb1ade3f39bff2921a3b
+  metadata.gz: 5b4adb5f45bbeaa6ea82b0d370e5a4c2d9dff98c
+  data.tar.gz: 0df34f48d1039efbe762b9a4aff5325abaf09932
 SHA512:
-  metadata.gz: 53f212dd26d796b3d3d5c139ac239e74e692cff06f82ee046aab734c4838b1018887cc24b5e3d35ca2f63faabd4bf8d19c47eeccf294d4eb7489c0ee4e870141
-  data.tar.gz: ea1d0e11c91c047f610f1c10aa8ce008278ae616a0eba92c0bba2ce029175f7b4ddd24cfe451f901522cecdf7f25fae5a39f44e52d2e848b1cdcef37b4c3ef25
+  metadata.gz: d7c1d7e2d91dd15152335886830b60e5e448f05a29800f13e86225f7cbce6c68f0c3b38fbb8ca99c8e57c5bfb03eb3aea36a19f166040478ad88f795b1707d0f
+  data.tar.gz: 8716ce9f8ec847188ef628b2dda650737ff805531d2242493ec89187d799bfe4b1c3156c70e0f566d6df1476a64f8913e712d1558d649abc49643093ec7efaf5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    salesforce-orm (1.0.0)
+    salesforce-orm (1.1.0)
       activerecord (~> 3)
       activerecord-nulldb-adapter (~> 0)
       restforce (~> 2.5)
@@ -24,11 +24,7 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.3)
     builder (3.0.4)
-    byebug (0.0.1)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-    columnize (0.9.0)
-    debugger-linecache (1.2.0)
+    byebug (9.0.5)
     diff-lcs (1.3)
     faraday (0.12.1)
       multipart-post (>= 1.2, < 3)
@@ -65,7 +61,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.15)
-  byebug (~> 0)
+  byebug (~> 9)
   rake (~> 10.0)
   rspec (~> 3.0)
   salesforce-orm!

data/README.md

@@ -17,7 +17,7 @@ Or, If you want to install globally
 gem install salesforce-orm
 ```
 
-This Gem internally use [Restforce](https://github.com/ejholmes/restforce), So you have configure it
+This Gem internally use [Restforce](https://github.com/ejholmes/restforce), So you have to configure it
 
 There are 2 options to configure ([Restforce config](https://github.com/ejholmes/restforce#initialization))
 
@@ -109,14 +109,34 @@ Default data type map for `SampleObject`
 If you wanna change the data type of some fields
 
 ```
-  {
-    field_one: :boolean,
+class SampleObject < SalesforceOrm::ObjectBase
+  self.data_type_map = {
+    field_one: :datetime,
     field_two: :integer
   }
+end
 ```
 
 **NOTE: It's mandatory to add data type map for boolean fields**
 
+### record_type
+
+By default there is no record type configured for any object
+
+To specify a record type,
+
+```
+class SampleObject < SalesforceOrm::ObjectBase
+  self.record_type = 'Xyz' # DeveloperName in RecordType object
+end
+```
+
+All the queries and `create!` method will automatically use record type
+
+First time use the object, we make a call to Salesforce and find the record type by it's `DeveloperName`. This will be cached in memory.
+
+With Rails in except in development or test env, we take the advantage of `Rails.cache`
+
 ### Methods
 
 Methods are similar to ActiveRecord::Base
@@ -209,7 +229,6 @@ SampleObject.build({id: 'some id', field_one: 'Some value'})
 
 - Default values
 - Relationships
-- Record type
 - More data types
 - Better aggregate methods
 

data/build.sh

@@ -1,4 +1,4 @@
-gem uninstall -a salesforce-orm-*
+gem uninstall -a salesforce-orm
 rm salesforce-orm-*
 gem build salesforce-orm.gemspec
 gem install salesforce-orm-*

data/lib/salesforce-orm/base.rb

@@ -19,12 +19,19 @@ module SalesforceOrm
       @klass = klass
       @client = RestforceClient.instance
       @builder = QueryBuilder.select(klass.field_map.keys)
+      where(RecordTypeManager::FIELD_NAME => klass.record_type_id) if klass.record_type_id
     end
 
     # create! doesn't return the SalesForce object back
     # It will return only the object id
     def create!(attributes)
-      client.create!(klass.object_name, map_to_keys(attributes))
+      new_attributes = map_to_keys(attributes)
+
+      new_attributes = new_attributes.merge(
+        RecordTypeManager::FIELD_NAME => klass.record_type_id
+      ) if klass.record_type_id
+
+      client.create!(klass.object_name, new_attributes)
     end
 
     # Transaction not guaranteed

data/lib/salesforce-orm/error.rb

@@ -7,5 +7,7 @@ module SalesforceOrm
     class CommonError < Base; end
 
     class ObjectNotFound < Base; end
+
+    class RecordTypeNotFound < Base; end
   end
 end

data/lib/salesforce-orm/object.rb

@@ -0,0 +1,8 @@
+Dir[File.expand_path('object/*.rb', File.dirname(__FILE__))].each do |file|
+  require file
+end
+
+module SalesforceOrm
+  module Object
+  end
+end

data/lib/salesforce-orm/object/record_type.rb

@@ -0,0 +1,15 @@
+require_relative '../object_base'
+
+module SalesforceOrm
+  module Object
+    class RecordType < ObjectBase
+
+      self.field_map = {
+        name: :Name,
+        sobject_type: :SobjectType,
+        developer_name: :DeveloperName,
+      }
+
+    end
+  end
+end

data/lib/salesforce-orm/object_maker.rb

@@ -1,6 +1,10 @@
+require_relative 'record_type_manager'
+
 module SalesforceOrm
   module ObjectMaker
 
+    include RecordTypeManager
+
     DEFAULT_FIELD_MAP = {
       id: :Id,
       created_at: :CreatedDate,

data/lib/salesforce-orm/record_type_manager.rb

@@ -0,0 +1,47 @@
+module SalesforceOrm
+  module RecordTypeManager
+
+    FIELD_NAME = :RecordTypeId
+
+    def record_type=(new_record_type)
+      @record_type = new_record_type
+    end
+
+    def record_type
+      @record_type
+    end
+
+    def record_type_id
+      return nil unless record_type
+      return @record_type_id if @record_type_id
+
+      record_type_sobject = if defined?(Rails)
+        if Rails.env.test?
+          Object::RecordType.build(id: 'fake_record_type')
+        elsif !Rails.env.development?
+          Rails.cache.fetch(record_type_cache_key) do
+            fetch_record_type
+          end
+        else
+          fetch_record_type
+        end
+      else
+        fetch_record_type
+      end
+
+      raise Error::RecordTypeNotFound unless record_type_sobject
+
+      @record_type_id = record_type_sobject.id
+    end
+
+    private
+
+    def fetch_record_type
+      Object::RecordType.where(developer_name: record_type).first
+    end
+
+    def record_type_cache_key
+      ['RecordTypeManager', object_name, record_type].join('/')
+    end
+  end
+end

data/lib/salesforce-orm/version.rb

@@ -1,3 +1,3 @@
 module SalesforceOrm
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/salesforce-orm.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord-nulldb-adapter', '~> 0'
   s.add_dependency 'restforce', '~> 2.5'
 
-  s.add_development_dependency 'byebug', '~> 0'
+  s.add_development_dependency 'byebug', '~> 9'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'bundler', '~> 1.15'
   s.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce-orm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vishal Vijay
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -131,9 +131,12 @@ files:
 - lib/salesforce-orm/base.rb
 - lib/salesforce-orm/configuration.rb
 - lib/salesforce-orm/error.rb
+- lib/salesforce-orm/object.rb
+- lib/salesforce-orm/object/record_type.rb
 - lib/salesforce-orm/object_base.rb
 - lib/salesforce-orm/object_maker.rb
 - lib/salesforce-orm/query_builder.rb
+- lib/salesforce-orm/record_type_manager.rb
 - lib/salesforce-orm/restforce_client.rb
 - lib/salesforce-orm/sql_to_soql.rb
 - lib/salesforce-orm/version.rb