openstax_active_force 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c62816549592114aa2162d2a9de73c80fe873d947fefe47da1d41e2dfcd4a8ea
+  data.tar.gz: 4054c4a6ec4d7a29635ec83c7b1b52e360d6ad107e6a1852227bf560002f789d
+SHA512:
+  metadata.gz: cf067372afe347c1548d39dbfbf62f7f9788e7c8085239e98d9ed85b95ff3b0ec582f46bfb081cf17a79ebb1046ed0963b7074a1aa00513ebe20ef38444fa776
+  data.tar.gz: 64b71c9c2218426c1bde27eb04721482a1aeb7233e10d9e0deca9db5c3424f02acf615ecd5d548f5ee08d2ab3a943be74476ac209d8c460042ad8eb301c84541

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.mailmap

@@ -0,0 +1,3 @@
+Armando Andini <armando.andini@hotmail.com>
+Jose Piccioni <josepiccioni@gmail.com> <jackson@jackPc.(none)>
+Pablo Oldani <oldani.pablo@gmail.com>

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.6.1

data/CHANGELOG.md

@@ -0,0 +1,98 @@
+# Changelog
+
+## Not released
+
+## 0.7.1
+
+* Allow sfdc_client to be set. ([#92][])
+
+## 0.7.0
+
+* Rails4-style conditional has_many associations  ([Dan Olson][])
+* Add `#includes` query method to eager load has_many association.  ([Dan Olson][])
+* Add `#includes` query method to eager load belongs_to association. ([#65][])
+* SObject#destroy method.
+
+## 0.6.1
+
+* Fix missing require of 'restforce'. Now clients don't need to add an initializer.
+
+## 0.6.0
+
+* Add select statement functionality. ([Pablo Oldani][], [#33][])
+* Add callback functionality ([Pablo Oldani][], [#20][])
+* Support bind parameters. ([Dan Olson][], [#29][])
+* Fix when passing nil value in a :where condition. ([Armando Andini][])
+* Model generator complete ([Armando Andini][], [#19][])
+
+## 0.5.0
+
+* Provide a default id field for all SObject subclassees ([Dan Olson][], [#30][])
+* Fix Ruby 2.0 compatibility issue ([Dan Olson][], [Pablo Oldani][], [#28][])
+* Normalize rspec syntax to remove deprecation warnings ([Dan Olson][], [#26][])
+* Remove namespace when inferring default SObject.table_name ([Dan Olson][], [#24][])
+* Add create! and save! methods. ([Pablo Oldani][], [#21][])
+* Refactor update and create methods. ([Pablo Oldani][], [#21][])
+* Add a generator. ([José Piccioni][], [#19][])
+* ActiveQuery now provides :each, :map and :inspect. ([Armando Andini][])
+* Add SObject.create class mehtod. ([Pablo Oldani][], [#10][])
+* SObject.field default mapping value follows SFDC API naming convention.
+  ([Dan Olson][], [#14][] [#15][])
+
+## 0.4.2
+
+* Use ActiveQuery instead of Query. ([Armando Andini][])
+* Add instructions to use validations ([José Piccioni][])
+* Lots of refactoring.
+
+## 0.3.2
+
+* Fixed gemspec.
+
+## 0.3.1
+
+* Create different classes for associations. ([#4][])
+* Big refactor on has_many association. ([Armando Andini][])
+* Add a lot of specs and refactors. ([Armando Andini][])
+* Add a Finders module. ([Armando Andini][])
+* Add fist and last method to SObject.
+
+## 0.2.0
+
+* Add belogns_to and has_many associations.
+* Changed when the SOQL query is sent to the client.
+* Add join method to query to use associtations.
+
+## 0.1.0
+
+* Add query builder object to chain conditions.
+* Update update and create methods.
+* Add Campaing standard table name.
+
+## 0.0.6.alfa
+
+* ActiveForce::SObject#table_name is auto populated using the class
+  name. It adds "__c" to all non standard types.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+
+[#4]: https://github.com/ionia-corporation/active_force/issues/4
+[#9]: https://github.com/ionia-corporation/active_force/issues/9
+[#10]: https://github.com/ionia-corporation/active_force/issues/10
+[#14]: https://github.com/ionia-corporation/active_force/issues/14
+[#15]: https://github.com/ionia-corporation/active_force/issues/15
+[#19]: https://github.com/ionia-corporation/active_force/issues/19
+[#20]: https://github.com/ionia-corporation/active_force/issues/20
+[#21]: https://github.com/ionia-corporation/active_force/issues/21
+[#24]: https://github.com/ionia-corporation/active_force/issues/24
+[#26]: https://github.com/ionia-corporation/active_force/issues/26
+[#28]: https://github.com/ionia-corporation/active_force/issues/28
+[#29]: https://github.com/ionia-corporation/active_force/issues/29
+[#30]: https://github.com/ionia-corporation/active_force/issues/30
+[#33]: https://github.com/ionia-corporation/active_force/issues/33
+[#65]: https://github.com/ionia-corporation/active_force/issues/65
+[#92]: https://github.com/ionia-corporation/active_force/issues/92
+[Pablo Oldani]: https://github.com/olvap
+[Armando Andini]: https://github.com/antico5
+[José Piccioni]: https://github.com/lmhsjackson
+[Dan Olson]: https://github.com/DanOlson

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_force.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eloy Espinaco
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,174 @@
+[![Gem Version](http://img.shields.io/gem/v/active_force.svg)](http://badge.fury.io/rb/active_force)
+[![Build Status](http://img.shields.io/travis/ionia-corporation/active_force.svg)](https://travis-ci.org/ionia-corporation/active_force)
+[![Test Coverage](https://codeclimate.com/github/ionia-corporation/active_force/badges/coverage.svg)](https://codeclimate.com/github/ionia-corporation/active_force)
+[![Inline docs](http://inch-ci.org/github/ionia-corporation/active_force.png?branch=master)](http://inch-ci.org/github/ionia-corporation/active_force)
+[![Chat](http://img.shields.io/badge/chat-gitter-brightgreen.svg)](https://gitter.im/ionia-corporation/active_force)
+
+# ActiveForce
+
+A ruby gem to interact with [SalesForce][1] as if it were Active Record. It
+uses [Restforce][2] to interact with the API, so it is fast and stable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_force'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_force
+
+## Setup credentials
+
+[Restforce][2] is used to interact with the API, so you will need to setup
+environment variables to set up credentials.
+
+    SALESFORCE_USERNAME       = your-email@gmail.com
+    SALESFORCE_PASSWORD       = your-sfdc-password
+    SALESFORCE_SECURITY_TOKEN = security-token
+    SALESFORCE_CLIENT_ID      = your-client-id
+    SALESFORCE_CLIENT_SECRET  = your-client-secret
+
+You might be interested in [dotenv-rails][3] to set up those in development.
+
+Also, you may specify which client to use as a configuration option, which is useful
+when having to reauthenticate utilizing oauth.
+
+```ruby
+ActiveForce.sfdc_client = Restforce.new(
+  oauth_token:         current_user.oauth_token,
+  refresh_token:       current_user.refresh_token,
+  instance_url:        current_user.instance_url,
+  client_id:           SALESFORCE_CLIENT_ID,
+  client_secret:       SALESFORCE_CLIENT_SECRET
+)
+```
+
+## Usage
+
+```ruby
+class Medication < ActiveForce::SObject
+
+  field :name,             from: 'Name'
+
+  field :max_dossage  # defaults to "Max_Dossage__c"
+  field :updated_from
+
+  ##
+  # You can cast field value using `as`
+  # field :address_primary_active, from: 's360a__AddressPrimaryActive__c', as: :boolean
+  #
+  # Available options are :boolean, :int, :double, :percent, :date, :datetime, :string, :base64,
+  # :byte, :ID, :reference, :currency, :textarea, :phone, :url, :email, :combobox, :picklist,
+  # :multipicklist, :anyType, :location, :compound
+
+  ##
+  # Table name is inferred from class name.
+  #
+  # self.table_name = 'Medication__c' # default one.
+
+  ##
+  # Validations
+  #
+  validates :name, :login, :email, presence: true
+
+  # Use any validation from active record.
+  # validates :text, length: { minimum: 2 }
+  # validates :text, format: { with: /\A[a-zA-Z]+\z/, message: "only allows letters" }
+  # validates :size, inclusion: { in: %w(small medium large),
+  #   message: "%{value} is not a valid size" }
+
+  ##
+  # Callbacks
+  #
+  before_save :set_as_updated_from_rails
+
+  private
+
+  def set_as_updated_from_rails
+    self.updated_from = 'Rails'
+  end
+
+end
+```
+
+Altenative you can try the generator. (requires setting up the connection)
+
+    rails generate active_force_model Medication__c
+
+### Associations
+
+#### Has Many
+
+```ruby
+class Account < ActiveForce::SObject
+  has_many :pages
+
+  # Use optional parameters in the declaration.
+
+  has_many :medications,
+    scoped_as: ->{ where("Discontinued__c > ? OR Discontinued__c = ?", Date.today.strftime("%Y-%m-%d"), nil) }
+
+  has_many :today_log_entries,
+    model: DailyLogEntry,
+    scoped_as: ->{ where(date: Time.now.in_time_zone.strftime("%Y-%m-%d")) }
+
+  has_many :labs,
+    scoped_as: ->{ where("Category__c = 'EMR' AND Date__c <> NULL").order('Date__c DESC') }
+
+end
+```
+
+#### Belongs to
+
+```ruby
+class Page < ActiveForce::SObject
+  field :account_id,           from: 'Account__c'
+
+  belongs_to :account
+end
+```
+
+### Querying
+
+You can retrieve SObject from the database using chained conditions to build
+the query.
+
+```ruby
+Account.where(web_enable: 1, contact_by: ['web', 'email']).limit(2)
+#=> this will query "SELECT Id, Name, WebEnable__c
+#                    FROM Account
+#                    WHERE WebEnable__C = 1 AND ContactBy__c IN ('web','email')
+#                    LIMIT 2
+```
+
+It is also possible to eager load associations:
+
+```ruby
+Comment.includes(:post)
+```
+
+### Model generator
+
+When using rails, you can generate a model with all the fields you have on your SFDC table by running:
+
+    rails g active_force:model <table name>
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new pull request so we can talk about it.
+6. Once accepted, please add an entry in the CHANGELOG and rebase your changes
+   to squash typos or corrections.
+
+ [1]: https://www.salesforce.com
+ [2]: https://github.com/ejholmes/restforce
+ [3]: https://github.com/bkeepers/dotenv

data/Rakefile

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

data/active_force.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_force/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openstax_active_force"
+  spec.version       = ActiveForce::VERSION
+  spec.authors       = ["Eloy Espinaco", "Pablo Oldani", "Armando Andini", "José Piccioni", "JP Slavinsky", "Dante Soares"]
+  spec.email         = "dante.m.soares@rice.edu"
+  spec.description   = %q{Use SalesForce as an ActiveModel}
+  spec.summary       = %q{Help you implement models persisting on Sales Force within Rails using RESTForce}
+  spec.homepage      = "https://github.com/openstax/active_force"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency 'rails', '< 6.0'
+  spec.add_dependency 'active_attr'
+  spec.add_dependency 'restforce'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

data/lib/active_attr/dirty.rb

@@ -0,0 +1,33 @@
+require 'active_support'
+require 'active_model/dirty'
+require "active_model/attribute_mutation_tracker"
+require 'active_attr'
+
+module ActiveAttr
+  module Dirty
+    extend ActiveSupport::Concern
+    include ActiveModel::Dirty
+
+    module ClassMethods
+      def attribute!(name, options={})
+        super(name, options)
+        define_method("#{name}=") do |value|
+          send("#{name}_will_change!") unless value == read_attribute(name)
+          super(value)
+        end
+      end
+    end
+
+    def attributes_and_changes
+      attributes.select { |attr, key| changed.include? attr }
+    end
+
+    def mutations_from_database
+      @mutations_from_database ||= ActiveModel::NullMutationTracker.instance
+    end
+
+    def forget_attribute_assignments
+      @attributes if defined?(@attributes)
+    end
+  end
+end

data/lib/active_force/active_query.rb

@@ -0,0 +1,155 @@
+require 'active_force/query'
+require 'forwardable'
+
+module ActiveForce
+  class PreparedStatementInvalid < ArgumentError; end
+  class ActiveQuery < Query
+    extend Forwardable
+
+    attr_reader :sobject
+
+    def_delegators :sobject, :sfdc_client, :build, :table_name, :mappings
+    def_delegators :to_a, :each, :map, :inspect
+
+    def initialize sobject
+      @sobject = sobject
+      super table_name
+      fields sobject.fields
+    end
+
+    def to_a
+      @records ||= result.to_a.map { |mash| build mash }
+    end
+
+    alias_method :all, :to_a
+
+    def count
+      super
+      sfdc_client.query(to_s).first.expr0
+    end
+
+    def limit limit
+      super
+      limit == 1 ? to_a.first : self
+    end
+
+    def where args=nil, *rest
+      return self if args.nil?
+      super build_condition args, rest
+      self
+    end
+
+    def select *fields
+      fields.map! { |field| mappings[field] }
+      super *fields
+    end
+
+    def find_by conditions
+      where(conditions).limit 1
+    end
+
+    def includes(*relations)
+      relations.each do |relation|
+        association = sobject.associations[relation]
+        fields Association::EagerLoadProjectionBuilder.build association
+      end
+      self
+    end
+
+    def none
+      @records = []
+      where(id: '1'*18).where(id: '0'*18)
+    end
+
+    private
+
+    def build_condition(args, other=[])
+      case args
+      when String, Array
+        build_condition_from_array other.empty? ? args : ([args] + other)
+      when Hash
+        build_conditions_from_hash args
+      else
+        args
+      end
+    end
+
+    def build_condition_from_array(ary)
+      statement, *bind_parameters = ary
+      return statement if bind_parameters.empty?
+      if bind_parameters.first.is_a? Hash
+        replace_named_bind_parameters statement, bind_parameters.first
+      else
+        replace_bind_parameters statement, bind_parameters
+      end
+    end
+
+    def replace_named_bind_parameters(statement, bind_parameters)
+      statement.gsub(/(:?):([a-zA-Z]\w*)/) do
+        key = $2.to_sym
+        if bind_parameters.has_key? key
+          enclose_value bind_parameters[key]
+        else
+          raise PreparedStatementInvalid, "missing value for :#{key} in #{statement}"
+        end
+      end
+    end
+
+    def replace_bind_parameters(statement, values)
+      raise_if_bind_arity_mismatch statement.count('?'), values.size
+      bound = values.dup
+      statement.gsub('?') do
+        enclose_value bound.shift
+      end
+    end
+
+    def raise_if_bind_arity_mismatch(expected_var_count, actual_var_count)
+      if expected_var_count != actual_var_count
+        raise PreparedStatementInvalid, "wrong number of bind variables (#{actual_var_count} for #{expected_var_count})"
+      end
+    end
+
+    def build_conditions_from_hash(hash)
+      hash.map do |key, value|
+        applicable_predicate mappings[key], value
+      end
+    end
+
+    def applicable_predicate(attribute, value)
+      if value.is_a? Array
+        in_predicate attribute, value
+      else
+        eq_predicate attribute, value
+      end
+    end
+
+    def in_predicate(attribute, values)
+      escaped_values = values.map &method(:enclose_value)
+      "#{attribute} IN (#{escaped_values.join(',')})"
+    end
+
+    def eq_predicate(attribute, value)
+      "#{attribute} = #{enclose_value value}"
+    end
+
+    def enclose_value value
+      case value
+      when String
+        "'#{quote_string(value)}'"
+      when NilClass
+        'NULL'
+      else
+        value.to_s
+      end
+    end
+
+    def quote_string(s)
+      # From activerecord/lib/active_record/connection_adapters/abstract/quoting.rb, version 4.1.5, line 82
+      s.gsub(/\\/, '\&\&').gsub(/'/, "''")
+    end
+
+    def result
+      sfdc_client.query(self.to_s)
+    end
+  end
+end

data/lib/active_force/association/association.rb

@@ -0,0 +1,50 @@
+module ActiveForce
+  module Association
+    class Association
+      extend Forwardable
+      def_delegators :relation_model, :build
+
+      attr_accessor :options, :relation_name
+
+      def initialize parent, relation_name, options = {}
+        @parent        = parent
+        @relation_name = relation_name
+        @options       = options
+        define_relation_method
+      end
+
+      def relation_model
+        options[:model] || relation_name.to_s.singularize.camelcase.constantize
+      end
+
+      def foreign_key
+        options[:foreign_key] || default_foreign_key
+      end
+
+      def relationship_name
+        options[:relationship_name] || relation_model.table_name
+      end
+
+      ###
+      # Does this association's relation_model represent
+      # +sfdc_table_name+? Examples of +sfdc_table_name+
+      # could be 'Quota__r' or 'Account'.
+      def represents_sfdc_table?(sfdc_table_name)
+        name = sfdc_table_name.sub(/__r\z/, '').singularize
+        relationship_name.sub(/__c\z|__r\z/, '') == name
+      end
+
+      def sfdc_association_field
+        relationship_name.gsub /__c\z/, '__r'
+      end
+
+      private
+
+      def infer_foreign_key_from_model(model)
+        name = model.custom_table? ? model.name : model.table_name
+        name.foreign_key.to_sym
+      end
+    end
+
+  end
+end

data/lib/active_force/association/belongs_to_association.rb

@@ -0,0 +1,26 @@
+module ActiveForce
+  module Association
+    class BelongsToAssociation < Association
+      private
+
+      def default_foreign_key
+        infer_foreign_key_from_model relation_model
+      end
+
+      def define_relation_method
+        association = self
+        _method = @relation_name
+        @parent.send :define_method, _method do
+          association_cache.fetch(_method) do
+            association_cache[_method] = association.relation_model.find(send association.foreign_key)
+          end
+        end
+
+        @parent.send :define_method, "#{_method}=" do |other|
+          send "#{ association.foreign_key }=", other.nil? ? nil : other.id
+          association_cache[_method] = other
+        end
+      end
+    end
+  end
+end