SFDO-API 0.1.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c852c0ed4fb33d2702921867b16bfd991e8eaf28
-  data.tar.gz: ee15a382213300a9d96f78c91987048e208644bb
+  metadata.gz: ad083f17c296ab1f98d9ccefeea3b04b594daa98
+  data.tar.gz: 465ec5467fcb682148573f07d531b2f57800d8d3
 SHA512:
-  metadata.gz: bbae2077803087383d951e693b252da0196c4a62d1624266c466812a067bdc77da025419a2d9fae2857b3f8c899e9ad5dccbfa8f99f667b711d9efe8484e8ded
-  data.tar.gz: e4cef1d73bf90664b90106687008a824ad3225332d993431d3237c25a8eb70dc32e6e6cde5997142ceb4863910de6b8dacb1abdf71b34851ecfc4194816255a4
+  metadata.gz: d81c512b1ee4c35ec0b146da5cd1b565d3edbcb253cb47ac92c302036979346de9116f65e00f8157e1842943d7e8b1bc0259d6f12abf9719ad9223d1e8db08f8
+  data.tar.gz: 30225adca39ab25f808db5e74f6605025997aef2ca8ad341bf71d63df0bbdd1ea3fb0068188c45cf02f39cd28ec35e3f50f7fa96bd2e6bfbd09bde9673016729

data/README.md

@@ -1,6 +1,6 @@
 # SFDO::API
 
-SFDO-API is a convenient way to use the Salesforce API to manipulate objects in a target org. SFDO-API was intended orginally to
+SFDO-API is a convenient way to use the Salesforce API to manipulate objects and fields on objects in a target org. SFDO-API was intended orginally to
 facilitate the sharing of common API calls across multiple source repositories, but the project is evolving to provide powerful
 tools for handiling SF objects, like support for managed and unmanaged namespaces, multiple namespaces in an org, etc. 
 
@@ -58,6 +58,13 @@ addressing "npsp__General_Accounting_Unit__c" use plain "General_Accounting_Unit
       gaus = select_api 'select Id from General_Accounting_Unit'
 ```      
 
+Likewise, when addressing custom fields, leave off any namespace values for the fields involved
+
+```ruby
+      #@relationshiop_id = create 'Relationship', npe4__Contact__c: contact, npe4__RelatedContact__c: related_contact
+      @relationshiop_id = create 'Relationship', Contact: contact, RelatedContact: related_contact
+``` 
+
 To delete a single instance of an object for which you have the Id value
 
 ```ruby
@@ -111,7 +118,17 @@ puts gaus.inspect
   end
 ```
 
-### SELECT and UPDATE actions with custom objects
+Likewise when using custom fields on any object, do not use any namespace value at the front of the object name, and leave off any 
+custom trailer values like "__c" or "__r, SFDO-API handles that for you. Instead of addressing 
+"npsp__General_Accounting_Unit__c" use plain "General_Accounting_Unit" instead, and instead of the field 
+"npe01__Account_Processor__c" use just "Account_Processor"
+
+```ruby
+    #@contact_id = create 'Contact', LastName: contact_name, MailingCity: 'hhmailingcity', npo02__Household__c: @hh_obj_id
+    @contact_id = create 'Contact', LastName: contact_name, MailingCity: 'hhmailingcity', Household: @hh_obj_id
+```
+
+### SELECT and UPDATE actions with custom objects and custom fields
 
 Use the select_api() and update_api() methods without namespaces or trailing characters.
 
@@ -123,15 +140,13 @@ to change, then call update_api() with the altered version of the restforce obje
     api_client do
       acc_id = select_api 'select Id from Contacts_And_Orgs_Settings'
       acc = acc_id.first
-      acc.npe01__Account_Processor__c = to_value
+      #acc.npe01__Account_Processor__c = to_value
+      acc.Account_Processor = to_value
       update_api(acc)
     end
   end
 ```
 
-Note that at this time, *fields* on objects with custom namespaces are not discovered automatically at runtime. 
-See TODO section below:
-
 ### Using objects where local override changes required fields
 
 Note that ISVs may override required fields on standard Salesforce objects, and these may be needed for SFDO-API to work properly
@@ -146,9 +161,9 @@ Note that ISVs may override required fields on standard Salesforce objects, and
 
 ### TODO
 
-Fields on namespaced object may be namespaced themselves. SFDO-API does not handle this case yet. 
-
-Custom fields on standard Salesforce objects may have namespaces. SFDO-API does not handle such fields yet. 
+At this time SFDO-API does not accept custom fields that are properly named. For example if a field is in fact named
+"npe01__Account_Processor__c" that field must be addressed as "Account_Processor" and will not function properly if the 
+calling code uses the properly namespaced value of the field.
 
 ## Development
 

data/SFDO-API.gemspec

@@ -3,7 +3,6 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'SFDO/API/version'
 
-
 Gem::Specification.new do |spec|
   spec.name          = "SFDO-API"
   spec.version       = SFDO::API::VERSION

data/lib/SFDO/API.rb

@@ -2,20 +2,32 @@ require 'SFDO/API/version'
 require 'pry'
 
 module SfdoAPI
-
   def api_client
-    @api_client ||= Restforce.new api_version: '32.0',
-                                  refresh_token: ENV['SF_REFRESH_TOKEN'],
-                                  client_id: ENV['SF_CLIENT_KEY'],
-                                  client_secret: ENV['SF_CLIENT_SECRET']
-    yield
+    if ENV['SF_ACCESS_TOKEN'] && ENV['SF_INSTANCE_URL']
+      @api_client ||= Restforce.new(oauth_token: ENV['SF_ACCESS_TOKEN'],
+                                    instance_url: ENV['SF_INSTANCE_URL'],
+                                    api_version: '32.0')
+      yield
+    else
+      @api_client ||= Restforce.new api_version: '32.0',
+                                    refresh_token: ENV['SF_REFRESH_TOKEN'],
+                                    client_id: ENV['SF_CLIENT_KEY'],
+                                    client_secret: ENV['SF_CLIENT_SECRET']
+      yield
+    end
   end
 
   def create(type, obj_hash)
+    true_fields = {}
+
     type = true_object_name(type)
+    obj_mash = Hashie::Mash.new obj_hash
+
+    obj_mash.map { |x, y| true_fields.store(true_field_name(x, type), y) }
+
     if is_valid_obj_hash?(type, obj_hash, @fields_acceptibly_nil)
       obj_id = api_client do
-        @api_client.create! type, obj_hash
+        @api_client.create! type, true_fields
       end
     end
     obj_id
@@ -28,26 +40,41 @@ module SfdoAPI
       obj_name = query[/(?<=from )(.*)$/i]
     end
 
+    # GET TRUE OBJECT NAME BEFORE GETTING TRUE FIELD NAMES
     real_obj_name = true_object_name(obj_name)
 
-    query = query.gsub(obj_name, real_obj_name)
+    # REMOVE NEWLINES IF ANY
+    query = query.gsub(/\n/, ' ')
+    # REMOVE EXTRA SPACES
+    query = query.gsub(/\s{2,}/, ' ')
+    # GET FIELDS ONLY
+    fields_array = query.split(' from ').first.scan /\w*\s*\s([a-zA-Z0-9_]*)/
 
-   results = api_client do
-     @api_client.query query
-   end
+    fields_array.each do |field|
+      real_field = true_field_name(field[0], real_obj_name)
+
+      if obj_name != real_obj_name
+        query = query.gsub(/\b#{obj_name}\b/, real_obj_name)
+      end
+
+      if field[0] != real_field
+        query = query.gsub(field[0], real_field)
+      end
+    end
+
+    results = api_client do
+      @api_client.query query
+    end
     results
   end
 
   def is_valid_obj_hash?(object_name, obj_hash, fields_acceptibly_nil)
-    #TODO Take incoming field names;parse out namespace/__c values; get true namespace for fields also
-    #TODO We do it from here because this is the only place we know about fields on objects
-    required_fields = get_object_describe(object_name).map(&:fieldName)
+    required_fields = get_required_fields_on_object(object_name).map(&:fieldName)
     valid = true
     required_fields.each do |f|
-
       valid = false if (!obj_hash.key? f.to_sym) && (begin
         !fields_acceptibly_nil[object_name].contains? f
-        puts 'This field must be populated in order to create this object in this environment: ' +  f.inspect
+        puts 'This field must be populated in order to create this object in this environment: ' + f.inspect
       rescue
         false
       end)
@@ -55,13 +82,13 @@ module SfdoAPI
     valid
   end
 
-  def org_describe()
+  def org_describe
     if @org_description.nil? || !@org_description.respond_to?(:contains)
       @org_description = api_client do
         @api_client.describe
       end
     end
-    return @org_description
+    @org_description
   end
 
   def prefix_to_name
@@ -71,33 +98,61 @@ module SfdoAPI
         @prefix_to_name.store(z.keyPrefix, z.name)
       end
     end
-    return @prefix_to_name
+    @prefix_to_name
   end
 
-  def true_object_name(handle) #either an ID or a string name
-    handle = (handle.end_with?("__c") || handle.end_with?("__r")) ? handle[0...-3] : handle
+  def true_field_name(field, obj)
+    # See if we've done an object describe on the object
+    # If so, return the fields for the object
+    # Otherwise do an object describe, save the object description and return the fields with their real names
+    @full_describe = {} if @full_describe.nil?
+
+    if @full_describe[obj].nil?
+      object_description = get_object_describe(obj)
+      fields = object_description.map do |f|
+
+        # MANAGED CODE
+        if f.fieldName.match /.*__.*__.*/
+          substituted = f.fieldName.gsub(/\A.*?__/, '').gsub(/__c\z/, '')
+        else
+          # UNMANAGED CODE
+          substituted = f.fieldName.gsub(/__c\z/, '')
+        end
+
+        { substituted => f.fieldName }
+      end
+      @full_describe[obj] = fields.reduce({}, :merge)
+    end
+
+    # RETURN THE REAL NAME FROM OUR HASH OF INPUT TO REAL NAMES
+    @full_describe[obj][field]
+  end
+
+  def true_object_name(handle) # either an ID or a string name
+    # handle = (handle.end_with?("__c") || handle.end_with?("__r")) ? handle[0...-3] : handle
+    handle.end_with?('__c', '__r') ? handle[0...-3] : handle
     from_id = prefix_to_name[handle[0..2]]
     from_name = obj_names_without_custom_additions[handle]
     if !from_name.nil? || !from_id.nil?
       return from_name if from_id.nil?
       return from_id if from_name.nil?
     end
-    return 'Unable to find object. Be sure to call SFDO-API without preceding namespace or following __c or __r'
+    'Unable to find object. Be sure to call SFDO-API without preceding namespace or following __c or __r'
   end
 
   def obj_names_without_custom_additions
     if @obj_names_without_custom_additions.nil? || !@obj_names_without_custom_additions.respond_to?(:contains)
       @obj_names_without_custom_additions = {}
       org_describe.each do |z|
-        tmp_var = z.name.split "__"
-        save = ""
+        tmp_var = z.name.split '__'
+        save = ''
         case tmp_var.size
-          when 2
-            save = tmp_var.first
-          when 3
-            save = tmp_var[1]
-          else
-            save = tmp_var.last
+        when 2
+          save = tmp_var.first
+        when 3
+          save = tmp_var[1]
+        else
+          save = tmp_var.last
         end
         @obj_names_without_custom_additions.store(save, z.name)
       end
@@ -105,23 +160,33 @@ module SfdoAPI
     @obj_names_without_custom_additions
   end
 
+  def get_required_fields_on_object(obj_name)
+    @object_fields = {} if @object_fields.nil?
+
+    if @object_fields[obj_name].nil?
+      @object_fields[obj_name] = get_object_describe(obj_name)
+    end
+
+    @object_fields[obj_name].select(&:required)
+  end
+
   def get_object_describe(object_name)
     api_client do
       @description = @api_client.get("/services/data/v35.0/sobjects/#{object_name}/describe")
-
       describeobject = Hashie::Mash.new(@description.body)
 
       required = describeobject.fields.map do |x|
         Hashie::Mash.new(
-            fieldName: x.name,
-            required: (!x.nillable && !x.defaultedOnCreate),
-            default: x.defaultValue)
+          fieldName: x.name,
+          required: (!x.nillable && !x.defaultedOnCreate),
+          default: x.defaultValue
+        )
       end
-      required.select(&:required)
+      return required
     end
   end
 
-  def delete(type, obj_id)
+  def delete(obj_id)
     delete_by_id(obj_id)
   end
 
@@ -148,19 +213,18 @@ module SfdoAPI
     obj_type = breakdown.last.capitalize
 
     case method_called.to_s
-      when /^delete_all_/
-        delete_all *args
-      when /^delete_one/
-        delete obj_type, *args
-      when /^create_/
-        create obj_type, *args
-      when /^select_api/
-        select_api *args
-      else
-        super.method_missing
+    when /^delete_all_/
+      delete_all *args
+    when /^delete_one/
+      delete obj_type, *args
+    when /^create_/
+      create obj_type, *args
+    when /^select_api/
+      select_api *args
+    else
+      super.method_missing
     end
   end
-
 end
 # INCLUDE HERE RATHER THAN IN THE PRODUCT-SPECIFIC CODE USING THIS GEM
 include SfdoAPI

data/lib/SFDO/API/version.rb

@@ -1,5 +1,5 @@
 module SFDO
   module API
-    VERSION = "0.1.9"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SFDO-API
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris McMahon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler