restforce_mock 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06ea14355b2b044432f0907fea9f7d1d420c227a
-  data.tar.gz: 19cfc9b489c3c0bebac453c369e37d5fe8fd6a64
+  metadata.gz: d3ed3598ad940401022ec1701ec1c91b09ca5d09
+  data.tar.gz: c2a68ab7ce505b65bac4e2e2078b302b0a2fa902
 SHA512:
-  metadata.gz: 998c8b961fc63decbc4818c0222c741448fe1ebda41143311172ef8130d78d813bd7801e157fb1ee63b48897a473b0b72a7397e8eb7e594088d724dbf4e161fa
-  data.tar.gz: 432526d5f7cb41a78a3ccb5e1aa4981e62548ac1d80c4776996a76820215a5e019fdac62ca6d455be765c055d1fd984696ec529865974beb09e628a532ab6c8f
+  metadata.gz: 7f77758d6bfb940b068b0d0287a7a03846d250ac11fac45dbbe8c08ba6876c5b561f7a484ae1382bf2e5722ad6de3c474c2109e7515060df4bcfa3f39f396c2e
+  data.tar.gz: cc87ac19af54021bdae4298d6669b69d45e7ba884b016f9c760ed7a073f4e28e99b7fcba1a504981f41e21e07d35637e74bef25778bdc232d3d71f2c418ae09f

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env
+restforce_mock-*.gem

data/.ruby-style.yml

@@ -31,7 +31,7 @@ Style/AccessModifierIndentation:
   - indent
 Style/AlignHash:
   Description: Align the elements of a hash literal if they span more than one line.
-  Enabled: true
+  Enabled: false
   EnforcedHashRocketStyle: key
   EnforcedColonStyle: key
   EnforcedLastArgumentHashStyle: always_inspect
@@ -51,7 +51,7 @@ Style/AlignParameters:
 Style/AndOr:
   Description: Use &&/|| instead of and/or.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-and-or-or
-  Enabled: true
+  Enabled: false
   EnforcedStyle: always
   SupportedStyles:
   - always
@@ -66,7 +66,7 @@ Style/BarePercentLiterals:
   - bare_percent
 Style/BracesAroundHashParameters:
   Description: Enforce braces style around hash parameters.
-  Enabled: false
+  Enabled: true
   EnforcedStyle: no_braces
   SupportedStyles:
   - braces
@@ -98,7 +98,7 @@ Style/ClassCheck:
 Style/CollectionMethods:
   Description: Preferred collection methods.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
-  Enabled: true
+  Enabled: false
   PreferredMethods:
     collect: map
     collect!: map!
@@ -138,7 +138,7 @@ Style/EmptyLinesAroundBlockBody:
   - no_empty_lines
 Style/EmptyLinesAroundClassBody:
   Description: Keeps track of empty lines around class bodies.
-  Enabled: true
+  Enabled: false
   EnforcedStyle: no_empty_lines
   SupportedStyles:
   - empty_lines
@@ -211,7 +211,7 @@ Style/IfUnlessModifier:
   Description: Favor modifier if/unless usage when you have a single-line body.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
   Enabled: false
-  MaxLineLength: 100
+  MaxLineLength: 80
 Style/IndentationWidth:
   Description: Use 2 spaces for indentation.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation
@@ -365,7 +365,7 @@ Style/SingleLineMethods:
 Style/StringLiterals:
   Description: Checks if uses of quotes match the configured preference.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
-  Enabled: true
+  Enabled: false
   EnforcedStyle: double_quotes
   SupportedStyles:
   - single_quotes
@@ -373,14 +373,14 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Description: Checks if uses of quotes inside expressions in interpolated strings
     match the configured preference.
-  Enabled: true
+  Enabled: false
   EnforcedStyle: single_quotes
   SupportedStyles:
   - single_quotes
   - double_quotes
 Style/SpaceAroundBlockParameters:
   Description: Checks the spacing inside and after block parameters pipes.
-  Enabled: true
+  Enabled: false
   EnforcedStyleInsidePipes: no_space
   SupportedStyles:
   - space
@@ -405,7 +405,7 @@ Style/SpaceInsideBlockBraces:
   Description: Checks that block braces have or don't have surrounding space. For
     blocks taking parameters, checks that the left brace has or doesn't have trailing
     space.
-  Enabled: true
+  Enabled: false
   EnforcedStyle: space
   SupportedStyles:
   - space
@@ -415,7 +415,7 @@ Style/SpaceInsideBlockBraces:
 Style/SpaceInsideHashLiteralBraces:
   Description: Use spaces inside hash literal braces - or don't.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
-  Enabled: true
+  Enabled: false
   EnforcedStyle: space
   EnforcedStyleForEmptyBraces: no_space
   SupportedStyles:
@@ -599,7 +599,7 @@ Style/InlineComment:
 Style/MethodCalledOnDoEndBlock:
   Description: Avoid chaining a method call on a do...end block.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
-  Enabled: false
+  Enabled: true
 Style/SymbolArray:
   Description: Use %i or %I for arrays of symbols.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-i
@@ -649,7 +649,7 @@ Style/Blocks:
   Description: Avoid using {...} for multi-line blocks (multiline chaining is always
     ugly). Prefer {...} over do...end for single-line blocks.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
-  Enabled: true
+  Enabled: false
 Style/CaseEquality:
   Description: Avoid explicit use of the case equality operator(===).
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-case-equality
@@ -782,7 +782,7 @@ Style/MultilineIfThen:
 Style/MultilineTernaryOperator:
   Description: 'Avoid multi-line ?: (the ternary operator); use if/unless instead.'
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-ternary
-  Enabled: true
+  Enabled: false
 Style/NegatedIf:
   Description: Favor unless over if for negative conditions (or control flow or).
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#unless-for-negatives
@@ -843,7 +843,7 @@ Style/SelfAssignment:
 Style/SingleSpaceBeforeFirstArg:
   Description: Checks that exactly one space is used between a method name and the
     first argument for method calls without parentheses.
-  Enabled: true
+  Enabled: false
 Style/SpaceAfterColon:
   Description: Use spaces after colons.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
@@ -873,7 +873,7 @@ Style/SpaceBeforeComma:
   Enabled: true
 Style/SpaceBeforeComment:
   Description: Checks for missing space between code and a comment on the same line.
-  Enabled: true
+  Enabled: false
 Style/SpaceBeforeSemicolon:
   Description: No spaces before semicolons.
   Enabled: true
@@ -887,11 +887,11 @@ Style/SpaceBeforeModifierKeyword:
 Style/SpaceInsideBrackets:
   Description: No spaces after [ or before ].
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces
-  Enabled: true
+  Enabled: false
 Style/SpaceInsideParens:
   Description: No spaces after ( or before ).
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces
-  Enabled: true
+  Enabled: false
 Style/SpaceInsideRangeLiteral:
   Description: No spaces inside range literals.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-inside-range-literals

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.4.0
+
+* Added ability to dump schema from Salesforce
+* Use schema to determine which fields are required
+* Removed `RestforceMock::Sandbox.add_required` method

data/README.md

@@ -34,6 +34,16 @@ Restforce::Client = RestforceMock::Client
 
 This will direct all calls to `Restforce` to `RestforceMock`. Test as usual.
 
+### Configuration
+
+```ruby
+RestforceMock.configure do |config|
+  config.schema_file = "spec/fixtures/schema.yml"
+  config.error_on_required = true  # raise error if required field is not set
+  config.required_exclusions = [:LastModifiedById ...] # fields that should not be considered required
+end
+```
+
 ### Mimicking Salesforce data
 
 To mimic Salesforce database, add some data to the `RestfoceMock` sandbox
@@ -55,13 +65,6 @@ after completion of tests make sure to clean up if necessary
   RestforceMock::Sandbox.reset!
 ```
 
-#### Required fields
-
-```ruby
-   RestforceMock::Sandbox.add_required(
-    "Object__c", [:Section_Name__c, :Program__c ])
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/restforce_mock.rb

@@ -1,56 +1,23 @@
 require "restforce_mock/version"
+require "restforce_mock/configuration"
+require "restforce_mock/client"
 require "restforce_mock/sandbox"
-require "restforce"
+require "restforce_mock/schema_manager"
 
 module RestforceMock
-  class Client
-
-    include ::Restforce::Concerns::API
-    include RestforceMock::Sandbox
-
-    def api_patch(url, attrs)
-      url=~/sobjects\/(.+)\/(.+)/
-      object=$1
-      id=$2
-      validate_presence!(object, id)
-      update_object(object, id, attrs)
-    end
-
-    def api_post(url, attrs)
-      url=~/sobjects\/(.+)/
-      sobject = $1
-      id = SecureRandom.urlsafe_base64(13) #duplicates possible
-      validate_requires!(sobject, attrs)
-      add_object(sobject, id, attrs)
-      return Body.new(id)
-    end
-
-    def validate_requires!(sobject, attrs)
-      return unless RestforceMock::Sandbox.storage[:required][sobject]
-
-      missing = RestforceMock::Sandbox.storage[:required][sobject] - attrs.keys
-      if missing.length > 0
-        raise Faraday::Error::ResourceNotFound.new(
-          "REQUIRED_FIELD_MISSING: Required fields are missing: #{missing}")
-      end
-    end
-
-    def validate_presence!(object, id)
-      unless RestforceMock::Sandbox.storage[object][id]
-        raise Faraday::Error::ResourceNotFound.new("Provided external ID field does not exist or is not accessible: #{id}")
-      end
-    end
+  class << self
+    attr_writer :configuration
+  end
 
-    private
+  def self.configuration
+    @configuration ||= RestforceMock::Configuration.new
+  end
 
-    class Body
-      def initialize(id)
-        @body = {'id' => id}
-      end
+  def self.reset
+    @configuration = RestforceMock::Configuration.new
+  end
 
-      def body
-        @body
-      end
-    end
+  def self.configure
+    yield(configuration)
   end
 end

data/lib/restforce_mock/client.rb

@@ -0,0 +1,67 @@
+require "restforce"
+require "restforce_mock/sandbox"
+
+module RestforceMock
+  class Client
+
+    include ::Restforce::Concerns::API
+    include RestforceMock::Sandbox
+
+    def api_patch(url, attrs)
+      url=~/sobjects\/(.+)\/(.+)/
+      object=$1
+      id=$2
+      validate_presence!(object, id)
+      update_object(object, id, attrs)
+    end
+
+    def api_post(url, attrs)
+      url=~/sobjects\/(.+)/
+      sobject = $1
+      id = SecureRandom.urlsafe_base64(13) #duplicates possible
+      validate_requires!(sobject, attrs)
+      add_object(sobject, id, attrs)
+      return Body.new(id)
+    end
+
+    def validate_requires!(sobject, attrs)
+      return unless RestforceMock.configuration.schema_file
+      return unless RestforceMock.configuration.error_on_required
+
+      object_schema = schema[sobject]
+      required = object_schema.
+        select{|k,v|v[:required]}.
+        collect{|k,v|k}.
+        collect(&:to_sym)
+
+      missing = required - attrs.keys - RestforceMock.configuration.required_exclusions
+      if missing.length > 0
+        raise Faraday::Error::ResourceNotFound.new(
+          "REQUIRED_FIELD_MISSING: Required fields are missing: #{missing}")
+      end
+    end
+
+    def validate_presence!(object, id)
+      unless RestforceMock::Sandbox.storage[object][id]
+        msg = "Provided external ID field does not exist or is not accessible: #{id}"
+        raise Faraday::Error::ResourceNotFound.new(msg)
+      end
+    end
+
+    private
+
+    def schema
+      RestforceMock::SchemaManager.new.load_schema(RestforceMock.configuration.schema_file)
+    end
+
+    class Body
+      def initialize(id)
+        @body = {'id' => id}
+      end
+
+      def body
+        @body
+      end
+    end
+  end
+end

data/lib/restforce_mock/configuration.rb

@@ -0,0 +1,24 @@
+module RestforceMock
+  class Configuration
+    attr_accessor :schema_file
+    attr_writer :error_on_required
+    attr_writer :required_exclusions
+
+    def error_on_required
+      @error_on_required.nil? ?  true : @error_on_required
+    end
+
+    def required_exclusions
+      @required_exclusions || default_exclusions
+    end
+
+    private
+
+    def default_exclusions
+      [
+        :Id, :IsDeleted, :Name, :CreatedDate, :CreatedById,
+        :LastModifiedDate, :LastModifiedById, :SystemModstamp
+      ]
+    end
+  end
+end

data/lib/restforce_mock/sandbox.rb

@@ -8,12 +8,6 @@ module RestforceMock
       storage[name].merge!({ id  => values })
     end
 
-    def self.add_required(name, keys)
-      if keys
-        storage[:required][name] = keys
-      end
-    end
-
     def add_object(name, id, values)
       RestforceMock::Sandbox.add_object(name, id, values)
     end
@@ -42,14 +36,8 @@ module RestforceMock
 
     #Private
     def self.update_schema(object_name)
-      s = client.describe(object_name)
-      object_schema = {}
-      s["fields"].each do |field|
-        object_schema[field["name"]]= {
-          type: field["type"]
-        }
-      end
-      storage[:schema][object_name] = object_schema
+      s = RestforceMock::SchemaManager.new
+      storage[:schema][object_name] = s.get_schema(object_name)
     end
 
     def self.client
@@ -60,9 +48,6 @@ module RestforceMock
       storage = Hash.new do |hash, object|
         hash[object]={}
       end
-      storage[:required] = Hash.new do |hash, object|
-        hash[object]={}
-      end
       storage[:schema] = Hash.new do |hash, object|
         hash[object]={}
       end

data/lib/restforce_mock/schema_manager.rb

@@ -0,0 +1,57 @@
+begin
+  require "yaml"
+rescue LoadError
+end
+
+module RestforceMock
+  class SchemaManager
+
+    def initialize(client = default_client  )
+      @client = client
+    end
+
+    def default_client
+      ::Restforce.new
+    end
+
+    # Get schema for Salesforce Object
+    #
+    # object_name - String
+    #
+    # Returns
+    #
+    # Hash
+    def get_schema(object_name)
+      s = @client.describe(object_name)
+      object_schema = {}
+      s["fields"].each do |field|
+        object_schema[field["name"]]= {
+          type: field["type"],
+          # http://salesforce.stackexchange.com/questions/25233/is-there-a-way-to-find-required-fields-on-an-objects
+          required: field["createable"] && !field["nillable"] && !field["defaultedOnCreate"]
+        }
+      end
+      object_schema
+    end
+
+    # Dump schema into file
+    #
+    # object_names - Array[String] array of name of objects in SF
+    # file - String yml file
+    def dump_schema(object_names, file)
+      schema = {}
+      object_names.each do |o|
+        schema[o] = get_schema(o)
+      end
+      File.open(file, 'w') {|f| f.write schema.to_yaml }
+    end
+
+    def load_schema(file)
+      if file.nil?
+        raise "Schema file is not defined"
+      end
+      thing = YAML.load_file(file)
+    end
+
+  end
+end

data/lib/restforce_mock/version.rb

@@ -1,3 +1,3 @@
 module RestforceMock
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/restforce_mock.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce_mock
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ilya Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: restforce
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Mock for Restforce gem
 email:
 - ilyakatz@gmail.com
@@ -78,6 +106,7 @@ files:
 - ".rspec"
 - ".ruby-style.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -86,7 +115,10 @@ files:
 - bin/console
 - bin/setup
 - lib/restforce_mock.rb
+- lib/restforce_mock/client.rb
+- lib/restforce_mock/configuration.rb
 - lib/restforce_mock/sandbox.rb
+- lib/restforce_mock/schema_manager.rb
 - lib/restforce_mock/version.rb
 - restforce_mock.gemspec
 homepage: https://github.com/ilyakatz
@@ -109,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Mock for Restforce gem