salesforce-orm 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 303fe6c567cdeb834103e79e613875af01482118
+  data.tar.gz: 4ab2e2a284c173d67999eb1ade3f39bff2921a3b
+SHA512:
+  metadata.gz: 53f212dd26d796b3d3d5c139ac239e74e692cff06f82ee046aab734c4838b1018887cc24b5e3d35ca2f63faabd4bf8d19c47eeccf294d4eb7489c0ee4e870141
+  data.tar.gz: ea1d0e11c91c047f610f1c10aa8ce008278ae616a0eba92c0bba2ce029175f7b4ddd24cfe451f901522cecdf7f25fae5a39f44e52d2e848b1cdcef37b4c3ef25

data/.editorconfig

@@ -0,0 +1,37 @@
+# http://editorconfig.org
+
+# A special property that should be specified at the top of the file outside of
+# any sections. Set to true to stop .editor config file search on current file
+root = true
+
+[*]
+# Indentation style
+# Possible values - tab, space
+indent_style = space
+
+# Indentation size in single-spaced characters
+# Possible values - an integer, tab
+indent_size = 2
+
+# Line ending file format
+# Possible values - lf, crlf, cr
+end_of_line = lf
+
+# File character encoding
+# Possible values - latin1, utf-8, utf-16be, utf-16le
+charset = utf-8
+
+# Denotes whether to trim whitespace at the end of lines
+# Possible values - true, false
+trim_trailing_whitespace = true
+
+# Denotes whether file should end with a newline
+# Possible values - true, false
+insert_final_newline = true
+
+#Not supported by all the editor.
+#More details: https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties#max_line_length
+max_line_length = 80
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store
+.byebug_history
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    salesforce-orm (1.0.0)
+      activerecord (~> 3)
+      activerecord-nulldb-adapter (~> 0)
+      restforce (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
+      builder (~> 3.0.0)
+    activerecord (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activerecord-nulldb-adapter (0.3.7)
+      activerecord (>= 2.0.0)
+    activesupport (3.2.22.5)
+      i18n (~> 0.6, >= 0.6.4)
+      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)
+    diff-lcs (1.3)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.11.0.1)
+      faraday (>= 0.7.4, < 1.0)
+    hashie (3.5.5)
+    i18n (0.8.4)
+    json (2.1.0)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+    restforce (2.5.3)
+      faraday (>= 0.9.0, <= 1.0)
+      faraday_middleware (>= 0.8.8, <= 1.0)
+      hashie (>= 1.2.0, < 4.0)
+      json (>= 1.7.5)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    tzinfo (0.3.53)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  byebug (~> 0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  salesforce-orm!
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,228 @@
+# salesforce-orm
+Active record like ORM for Salesforce
+
+[![Build Status](https://travis-ci.org/NestAway/salesforce-orm.svg?branch=master)](https://travis-ci.org/NestAway/salesforce-orm)
+
+## Setup
+
+Add gem to your Gemfile
+
+```
+gem 'salesforce-orm'
+```
+
+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
+
+There are 2 options to configure ([Restforce config](https://github.com/ejholmes/restforce#initialization))
+
+**Option 1**
+
+Set ENV variable as per Restforce doc
+
+**Option 2**
+
+In rails, write below code in application.rb or environment specific file
+
+Other projects, run it before you use SaleforceOrm
+
+```
+  SaleforceOrm::Configuration.restforce_config = {
+    ... # Restforce configuration
+  }
+```
+
+## Usage
+
+Create object class
+
+```
+class SampleObject < SalesforceOrm::ObjectBase
+end
+```
+
+### object_name
+
+Default object name is `class.name`
+
+```
+SampleObject
+```
+
+If you have a custom object name,
+
+```
+class SampleObject < SalesforceOrm::ObjectBase
+  self.object_name = 'SampleObject__c'
+end
+```
+
+### field_map
+
+Field map is used for create, update actions. This can be used for aliasing the field names
+
+Default field map for `SampleObject`
+
+```
+  {
+    id: :Id,
+    created_at: :CreatedAt,
+    updated_at: :UpdatedAt
+  }
+```
+
+If you wanna map more fields for an object
+
+```
+class SampleObject < SalesforceOrm::ObjectBase
+  self.field_map = {
+    field_one: :FieldOne,
+    field_two: :FieldTwo__c,
+  }
+end
+```
+
+### data_type_map
+
+Allowed data types are,
+
+- `:integer`
+- `:date_time`
+- `:array`
+
+Default is same data type of given value
+
+Default data type map for `SampleObject`
+
+```
+  {
+    created_at: :datetime,
+    updated_at: :datetime
+  }
+```
+
+If you wanna change the data type of some fields
+
+```
+  {
+    field_one: :boolean,
+    field_two: :integer
+  }
+```
+
+**NOTE: It's mandatory to add data type map for boolean fields**
+
+### Methods
+
+Methods are similar to ActiveRecord::Base
+
+Class methods
+
+```
+SampleObject.[
+  :create!,
+  :update_all!,
+  :destroy_all!,
+  :where,
+  :select,
+  :except,
+  :group,
+  :order,
+  :reorder,
+  :limit,
+  :offset,
+  :first,
+  :last,
+  :each,
+  :scoped,
+  :all,
+  :find_by_*
+]
+```
+
+eg:
+```
+SampleObject.where(id: 'qd')
+
+SampleObject.where(id: ['eqd', 'qqwd'])
+
+SampleObject.where(id: ['eqd', 'qqwd'], field_one: 'KJbn').where('a = b').all
+
+SampleObject.where(id: 'qd').group(:a, :b).each do |sobj|
+  puts sobj.id
+end
+
+SampleObject.find('qwd')
+
+SampleObject.find_by_id('qwd')
+
+SampleObject.find_by_field_one_and_field_two_and_field_three(1, 2, 3)
+
+SampleObject.select('count(id)').all
+```
+
+Instance methods
+
+```
+SampleObject.[
+  :update_attributes,
+  :destroy
+]
+```
+
+Other class methods (Specific to SalesforceOrm)
+
+#### update_by_id!
+
+To update an object by id
+
+```
+SampleObject.update_by_id!('some_id', {feild_one: 'some_value', field_two: 'some_other_value'})
+```
+
+#### destroy_by_id!
+
+To destroy an object by id
+
+```
+SampleObject.destroy_by_id!('some_id')
+```
+
+#### to_soql
+
+To generate, SOQL query (Equavalent to `to_sql`)
+
+#### build
+
+To create a new instance of SampleObject
+
+```
+SampleObject.build({id: 'some id', field_one: 'Some value'})
+```
+
+## Pending
+
+- Default values
+- Relationships
+- Record type
+- More data types
+- Better aggregate methods
+
+## Contributing
+
+If you'd like to contribute a feature or bugfix: Thanks! To make sure your
+fix/feature has a high chance of being included, please read the following
+guidelines:
+
+1. Post a [pull request](https://github.com/NestAway/salesforce-orm/compare).
+2. Make sure there are tests! We will not accept any patch that is not tested.
+   It's a rare time when explicit tests aren't needed. If you have questions
+   about writing tests for salesforce-orm, please open a
+   [GitHub issue](https://github.com/NestAway/salesforce-orm/issues/new).
+
+Thank you to all [the contributors](https://github.com/NestAway/salesforce-orm/graphs/contributors)!

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/build.sh

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

data/lib/salesforce-orm.rb

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

data/lib/salesforce-orm/base.rb

@@ -0,0 +1,175 @@
+require 'forwardable'
+require_relative 'sql_to_soql'
+
+module SalesforceOrm
+  class Base
+
+    include Enumerable, SqlToSoql
+    extend Forwardable
+
+    def_delegators :make_query, *([:each] + Enumerable.instance_methods)
+
+    attr_reader :builder, :client, :klass
+
+    def initialize(klass)
+      unless klass.singleton_class.included_modules.include?(ObjectMaker)
+        raise Error::CommonError, "Salesforce object has to be extended from #{ObjectMaker.name}"
+      end
+
+      @klass = klass
+      @client = RestforceClient.instance
+      @builder = QueryBuilder.select(klass.field_map.keys)
+    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))
+    end
+
+    # Transaction not guaranteed
+    def destroy_all!(*args)
+      each do |object|
+        object.destroy!(*args)
+      end
+    end
+
+    def destroy_by_id!(id)
+      client.destroy(klass.object_name, id)
+    end
+
+    def destroy!(object)
+      destroy_by_id!(object.id)
+    end
+
+    # Transaction not guaranteed
+    def update_all!(attributes)
+      each do |object|
+        object.update_attributes!(attributes)
+      end
+    end
+
+    def update_by_id!(id, attributes)
+      client.update!(
+        klass.object_name,
+        map_to_keys(attributes.merge({id: id}))
+      )
+    end
+
+    def update_attributes!(object, attributes)
+      update_by_id!(object.id, attributes)
+    end
+
+    # Handling select differently because we select all the fields by default
+    def select(*args)
+      except(:select)
+      @builder = builder.select(*args)
+      self
+    end
+
+    [
+      :scoped,
+      :except,
+      :where,
+      :group,
+      :limit,
+      :offset,
+      :order,
+      :reorder
+    ].each do |method_name|
+      define_method(method_name) do |*args|
+        @builder = builder.send(method_name, *args)
+        self
+      end
+    end
+
+    def all(*args)
+      make_query
+    end
+
+    def first
+      limit(1).make_query.first
+    end
+
+    def last
+      order('created_at DESC').first
+    end
+
+    def to_soql
+      sql_to_soql(builder.to_sql)
+    end
+
+    def make_query
+      begin
+        soql = to_soql
+        client.query(to_soql).find_all.map do |object|
+          build(object)
+        end
+      rescue => e
+        # On passing a invalid object id, salesforce throughs an exception
+        # with message starting with INVALID_QUERY_FILTER_OPERATOR, we'll be
+        # considering this as an ObjectNotFound exception
+        if e.message =~ /^INVALID_QUERY_FILTER_OPERATOR/
+          raise Error::ObjectNotFound
+        else
+          raise
+        end
+      end
+    end
+
+    def build(object)
+      result = klass.new(map_from_keys(object))
+      result.original_object = object
+      result
+    end
+
+    private
+
+    def map_to_keys(attributes)
+      map = klass.field_map
+      new_attributes = {}
+      attributes.keys.each do |key|
+        key_sym = key.to_sym
+        new_attributes[map[key_sym]] = attributes[key] if map[key_sym]
+      end
+      new_attributes
+    end
+
+    def map_from_keys(attributes)
+      map = klass.field_map
+      data_type_map = klass.data_type_map
+      new_attributes = {}
+      attributes.keys.each do |key|
+        key_sym = key.to_sym
+        new_key = map.key(key_sym)
+        if new_key
+          new_attributes[new_key] = cast_to(
+            value: attributes[key],
+            data_type: data_type_map[new_key]
+          )
+        else
+          # The feilds which is not in field_map also will get added
+          # to the ObjectBase, to support aggregate queries
+          new_attributes[key] = attributes[key]
+        end
+      end
+      new_attributes
+    end
+
+    def cast_to(value:, data_type:)
+      case data_type
+      when :integer
+        value.to_i
+      when :date_time
+        return nil if value.blank?
+        Time.zone.parse(value)
+      when :array
+        return [] if value.blank?
+        value.split(';')
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/salesforce-orm/configuration.rb

@@ -0,0 +1,16 @@
+module SalesforceOrm
+  class Configuration
+
+    class << self
+
+      def restforce_config=(config)
+        @restforce_config = config
+      end
+
+      def restforce_config
+        @restforce_config
+      end
+
+    end
+  end
+end

data/lib/salesforce-orm/error.rb

@@ -0,0 +1,11 @@
+module SalesforceOrm
+  module Error
+
+    # A general exception
+    class Base < StandardError; end
+
+    class CommonError < Base; end
+
+    class ObjectNotFound < Base; end
+  end
+end

data/lib/salesforce-orm/object_base.rb

@@ -0,0 +1,68 @@
+require 'ostruct'
+require_relative 'object_maker'
+
+module SalesforceOrm
+  class ObjectBase < OpenStruct
+
+    extend ObjectMaker
+
+    class << self
+
+      [
+        :create!,
+        :update_all!,
+        :update_by_id!,
+        :destroy_all!,
+        :destroy_by_id!,
+        :where,
+        :select,
+        :except,
+        :group,
+        :order,
+        :reorder,
+        :limit,
+        :offset,
+        :first,
+        :last,
+        :each,
+        :scoped,
+        :all,
+        :to_soql,
+        :build
+      ].each do |method_name|
+        define_method(method_name) do |*args|
+          orm.send(method_name, *args)
+        end
+      end
+
+      def find(*args)
+        find_by_id(*args)
+      end
+
+      def method_missing(method, *args, &block)
+        regex = /^find_by_(.+)$/
+        if method =~ regex
+          fields = method.to_s.match(regex).captures[0].split('_and_')
+          condition = {}
+          fields.each_with_index do |field, index|
+            condition[field.to_sym] = args[index]
+          end
+          where(condition).first
+        end
+      end
+
+      def orm
+        Base.new(self)
+      end
+    end
+
+    [
+      :update_attributes!,
+      :destroy!
+    ].each do |method_name|
+      define_method(method_name) do |*args|
+        self.class.orm.send(method_name, *([self] + args))
+      end
+    end
+  end
+end

data/lib/salesforce-orm/object_maker.rb

@@ -0,0 +1,39 @@
+module SalesforceOrm
+  module ObjectMaker
+
+    DEFAULT_FIELD_MAP = {
+      id: :Id,
+      created_at: :CreatedDate,
+      updated_at: :LastModifiedDate
+    }
+
+    DEFAULT_DATA_TYPE_MAP = {
+      created_at: :date_time,
+      updated_at: :date_time
+    }
+
+    def field_map=(field_map)
+      @field_map = DEFAULT_FIELD_MAP.merge(field_map)
+    end
+
+    def field_map
+      @field_map || DEFAULT_FIELD_MAP
+    end
+
+    def data_type_map=(data_type_map)
+      @data_type_map = DEFAULT_DATA_TYPE_MAP.merge(data_type_map)
+    end
+
+    def data_type_map
+      @data_type_map || DEFAULT_DATA_TYPE_MAP
+    end
+
+    def object_name=(new_name)
+      @object_name = new_name
+    end
+
+    def object_name
+      @object_name || name.demodulize
+    end
+  end
+end

data/lib/salesforce-orm/query_builder.rb

@@ -0,0 +1,14 @@
+require 'active_record'
+
+module SalesforceOrm
+  class QueryBuilder < ActiveRecord::Base
+
+    DUMMY_TABLE_NAME = 'table_name'
+
+    self.table_name = DUMMY_TABLE_NAME
+
+    establish_connection(
+      adapter: :nulldb
+    )
+  end
+end

data/lib/salesforce-orm/restforce_client.rb

@@ -0,0 +1,24 @@
+require 'restforce'
+
+module SalesforceOrm
+  module RestforceClient
+
+    module_function
+
+    def instance
+      # TODO need to verify with Sidekiq
+
+      # Making Restforce object a thread local variable to avoid making
+      # authentication request for each query we make to SalesForce.
+      # With this, only one authentication request will be made to SalesForce
+      # per request.
+      #
+      # Thread local variable will guarantee us a new Restforce object for each request.
+      #
+      # If this was a singleton object for process, then we'll have to
+      # manually refresh authentication token for each request
+      Thread.current[:salesforce_orm_restforce_client] ||= Restforce.new(Configuration.restforce_config || {})
+    end
+
+  end
+end

data/lib/salesforce-orm/sql_to_soql.rb

@@ -0,0 +1,71 @@
+module SalesforceOrm
+  module SqlToSoql
+    def aggregate_function?(keyword)
+      keyword =~ /^(AVG|COUNT|COUNT|COUNT_DISTINCT|MIN|MAX|SUM)\(/i
+    end
+
+    def convert_aliased_fields(sql_str, split_by = Regexp.new('\s+'), join_by = ' ')
+      spcial_char_regex = /[=<>!,]+/
+      sql_str.split(split_by, -1).map do |keyword|
+        if aggregate_function?(keyword)
+          aggregate_data = keyword.match(/^(.*)\((.*)(\).*)/i).captures
+          raise Error::CommonError, 'Invalid aggregate function' unless aggregate_data[1]
+          "#{aggregate_data[0]}(#{convert_aliased_fields(aggregate_data[1])}#{aggregate_data[2]}"
+        elsif keyword =~ spcial_char_regex
+          convert_aliased_fields(keyword, spcial_char_regex, keyword.gsub(spcial_char_regex).first)
+        else
+          klass.field_map[keyword.to_sym] || keyword
+        end
+      end.join(join_by)
+    end
+
+    def boolean_data_type_conversion(sql)
+      klass.data_type_map.each do |keyword, data_type|
+        if data_type == :boolean
+          [0, 1].each do |value|
+            regex = Regexp.new("\s+#{keyword}\s*\=\s*#{value}(\s+|$)")
+            sql.gsub!(regex, " #{keyword} = #{value == 1}\\1")
+          end
+          ['t', 'f'].each do |value|
+            regex = Regexp.new("\s+#{keyword}\s*\=\s*'#{value}'(\s+|$)")
+            sql.gsub!(regex, " #{keyword} = #{value == 't'}\\1")
+          end
+        end
+      end
+      sql
+    end
+
+    # TODO: optimize this method
+    def sql_to_soql(sql)
+      # Unescape column and table names
+      sql.gsub!('`', '')
+
+      # Remove table namespace from fields
+      sql.gsub!("#{QueryBuilder::DUMMY_TABLE_NAME}.", '')
+
+      # Add table name
+      sql.gsub!(QueryBuilder::DUMMY_TABLE_NAME, klass.object_name)
+
+      # Convert 1=0 to id IS NULL (id never be NULL, so it a false case)
+      sql.gsub!(/\s+1=0(\s*)/i, ' id IS NULL\1')
+
+      # Convert IS NOT to !=
+      sql.gsub!(/\s+IS\s+NOT\s+/i, ' != ')
+
+      # Convert IS to =
+      sql.gsub!(/\s+IS\s+/i, ' = ')
+
+      # Convert datatime to salesforce format
+      sql.gsub!(/'(\d{4}-\d{2}-\d{2}) (\d{2}:\d{2}:\d{2})'/, '\1T\2Z')
+
+      # Convert date to salesforce format
+      sql.gsub!(/'(\d{4}-\d{2}-\d{2})'/, '\1')
+
+      # Convert boolean_field = (1|0) to boolean_field = (true|false)
+      sql = boolean_data_type_conversion(sql)
+
+      # Convert aliased fields
+      convert_aliased_fields(sql).strip
+    end
+  end
+end

data/lib/salesforce-orm/version.rb

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

data/salesforce-orm.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce-orm/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'salesforce-orm'
+  s.version     = SalesforceOrm::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.date        = '2017-06-07'
+  s.summary     = 'Ruby ORM for Salesforce'
+  s.description = 'Active record like ORM for Salesforce'
+  s.authors     = ['Vishal Vijay', 'Shivansh Gaur']
+  s.email       = ['tech_team@nestaway.com', '0vishalvijay0@gmail.com']
+  s.files       = `git ls-files`.split("\n").reject do |f|
+    f.match(%r{^(spec)/})
+  end
+  s.homepage    = 'https://github.com/NestAway/salesforce-orm'
+  s.license     = 'Apache License 2.0'
+
+  s.required_ruby_version = '>= 1.9.8'
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', '~> 3'
+  s.add_dependency 'activerecord-nulldb-adapter', '~> 0'
+  s.add_dependency 'restforce', '~> 2.5'
+
+  s.add_development_dependency 'byebug', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'bundler', '~> 1.15'
+  s.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: salesforce-orm
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vishal Vijay
+- Shivansh Gaur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Active record like ORM for Salesforce
+email:
+- tech_team@nestaway.com
+- 0vishalvijay0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- build.sh
+- lib/salesforce-orm.rb
+- lib/salesforce-orm/base.rb
+- lib/salesforce-orm/configuration.rb
+- lib/salesforce-orm/error.rb
+- lib/salesforce-orm/object_base.rb
+- lib/salesforce-orm/object_maker.rb
+- lib/salesforce-orm/query_builder.rb
+- lib/salesforce-orm/restforce_client.rb
+- lib/salesforce-orm/sql_to_soql.rb
+- lib/salesforce-orm/version.rb
+- salesforce-orm.gemspec
+homepage: https://github.com/NestAway/salesforce-orm
+licenses:
+- Apache License 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby ORM for Salesforce
+test_files: []