active_force 0.0.7.alfa → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7c95ee692d2b9302abc561d8b75abb46471cb3e
-  data.tar.gz: 57cf7fbe1dabbddcba08399cf23aa7e21ec0d80d
+  metadata.gz: acf8e175727f61a6fc99099804f1759a8539d11f
+  data.tar.gz: df64cceabf34fba0ff538283ac59b278b91acf98
 SHA512:
-  metadata.gz: 04ee4308094ca54cf96a9a9f940a2512598c9bde125ac79ad78ed3168aeb9e3106ad9b4236b02ed8d527102a677897b8fba73e49b349eaa2dd40d961d4a519bf
-  data.tar.gz: fa2590afa762d3c94e8b53197f5168dcd95b4560a364e64425e6280563b174e2d60655404d28c851d95dd529040894bf628e883a6735e76e1970eaf5f7c6c7a0
+  metadata.gz: 5f32456704f543150f8d8f7ba414adfade927cea8f3abe9ea0d847f43ab1dd3f74644d15e607961759f98538315fd9d7ab72c872c0284eb9012bc0ce97081237
+  data.tar.gz: c410492b5afdf5e9110415ae1abe3f5869df4806e4d77af708573f335e2fda9143b4bae722a544d64da08f4ad58ec786bc30b344caa90994fc3b6216a2c30642

data/README.md

@@ -1,5 +1,10 @@
-# ActiveForce [![Code Climate](https://codeclimate.com/github/eloyesp/active_force.png)](https://codeclimate.com/github/eloyesp/active_force)
-TODO: Write a gem description
+[![Gem Version](http://img.shields.io/gem/v/active_force.svg)](http://badge.fury.io/rb/active_force)
+[![Code Climate](http://img.shields.io/codeclimate/github/eloyesp/active_force.svg)](https://codeclimate.com/github/eloyesp/active_force)
+
+# ActiveForce
+
+A ruby gem to interact with SalesForce as if it were Active Record. It
+uses Restforce to interact with the API, so it is fast and stable.
 
 ## Installation
 
@@ -17,7 +22,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Define a class
+
+```ruby
+class Page < ActiveForce::SObject
+  
+end
+```
+
+### Add Attributes
+```ruby
+class Page < ActiveForce::SObject
+  #field, attribute name. from: 'Name in Salesforce database'
+  field :id,                from: 'Id'
+  field :name,              from: 'Medication__c'    
+  self.fields     = mappings.values
+  #set SalesForce table name.
+  self.table_name = 'Patient_Medication__c'
+end
+```
+### Relation ships
+
+#### Has Many
+
+```ruby
+class Account < ActiveForce::SObject
+  has_many :pages
+end
+
+class Page < ActiveForce::SObject
+  field :account_id,           from: 'Account__c'
+end
+```
+
+you could send a option parameter in the declaration.
+
+```ruby
+class Account < ActiveForce::SObject
+  has_many :medications,
+    where: "(Date_Discontinued__c > #{ Date.today.strftime("%Y-%m-%d") } or Date_Discontinued__c = NULL)"
+    
+  has_many :today_log_entrys,
+    model: DailyLogEntry,
+    where: "Date__c = #{ Time.now.in_time_zone.strftime("%Y-%m-%d") }"
+
+  has_many :labs,
+    where: "Category__c = 'EMR' And Date__c <> NULL",
+    order: 'Date__c DESC'
+end
+```
+
+#### Belongs to
+```ruby
+class Account < ActiveForce::SObject
+end
+
+class Page < ActiveForce::SObject
+  field :account_id,           from: 'Account__c'
+  belongs_to :account
+end
+```
 
 ## Contributing
 

data/lib/active_force.rb

@@ -1,5 +1,6 @@
 require 'active_force/version'
 require 'active_force/sobject'
+require 'active_force/query'
 
 module ActiveForce
 end

data/lib/active_force/association.rb

@@ -0,0 +1,39 @@
+require 'active_force/query'
+
+module ActiveForce
+  module Association
+    module ClassMethods
+      def has_many relation_name, options = {}
+        model = options[:model] || relation_model(relation_name)
+        association_name = options[:table] || model.table_name || "#{ model }__c"
+        foreing_key      = options[:foreing_key] || default_foreing_key(model, self.name) || table_name
+
+        define_method "#{ relation_name }_query" do
+          query = ActiveForce::Query.new(association_name)
+          query.fields model.fields
+          query.where(options[:where]) if options[:where]
+          query.order(options[:order]) if options[:order]
+          query.limit(options[:limit]) if options[:limit]
+          query.where("#{ foreing_key } = '#{ id }'")
+          query
+        end
+      end
+
+      def relation_model sym
+        sym.to_s.singularize.camelcase.constantize
+      end
+
+      def default_foreing_key relation_model, model
+        relation_model.mappings["#{model.downcase}_id".to_sym]
+      end
+
+      def belongs_to relation_name, options = {}
+        model = options[:model] || relation_model(relation_name)
+        foreing_key      = options[:foreing_key] || "#{ relation_name }_id".to_sym
+        define_method "#{ relation_name }" do
+          model.find(self.send foreing_key)
+        end
+      end
+    end
+  end
+end

data/lib/active_force/query.rb

@@ -0,0 +1,94 @@
+module ActiveForce
+  class Query
+    attr_reader :table
+
+    attr_accessor :table_id
+
+    def initialize table
+      @table = table
+      @conditions = []
+      @table_id = 'Id'
+      @query_fields = [@table_id]
+    end
+
+    def fields fields_collection = []
+      @query_fields = @query_fields + fields_collection.to_a
+    end
+
+    def all
+      self
+    end
+
+    def to_s
+      query = <<-SOQL.gsub(/\s+/, " ").strip
+        SELECT
+          #{ @query_fields.uniq.join(', ') }
+        FROM
+          #{ @table }
+        #{ build_where }
+        #{ build_order }
+        #{ build_limit }
+        #{ build_offset }
+      SOQL
+      query
+    end
+
+    def where condition
+      @conditions << condition
+      self
+    end
+
+    def order order
+      @order = order
+      self
+    end
+
+    def limit size
+      @size = size
+      self
+    end
+
+    def limit_value
+      @size
+    end
+
+    def offset offset
+      @offset = offset
+      self
+    end
+
+    def offset_value
+      @offset
+    end
+
+    def find id
+      where "#{ @table_id } = '#{ id }'"
+      limit 1
+      self
+    end
+
+    def join object_query
+      fields ["(#{ object_query.to_s })"]
+      self
+    end
+
+    protected
+      def build_where
+        unless @conditions.empty?
+          "WHERE #{ @conditions.join(' AND ') }"
+        end
+      end
+
+      def build_limit
+        "LIMIT #{ @size }" if @size
+      end
+
+      def build_order
+        "ORDER BY #{ @order }" if @order
+      end
+
+      def build_offset
+        "OFFSET #{ @offset }" if @offset
+      end
+  end
+end

data/lib/active_force/sobject.rb

@@ -1,14 +1,19 @@
 require 'active_model'
 require 'active_attr'
 require 'active_attr/dirty'
+require 'active_force/query'
+require 'active_force/association'
+require 'yaml'
 
 module ActiveForce
   class SObject
     include ActiveAttr::Model
     include ActiveAttr::Dirty
+    include ActiveForce::Association
 
-    # Types recognised don't get the added "__c"
-    STANDARD_TYPES = %w[ Account Contact Opportunity ]
+    extend ClassMethods
+
+    STANDARD_TYPES = %w[ Account Contact Opportunity Campaign]
 
     class_attribute :mappings, :fields, :table_name
 
@@ -22,6 +27,14 @@ module ActiveForce
                       end
     end
 
+    def self.has_many relation_name, options = {}
+      super
+      model = options[:model] || relation_model(relation_name)
+      define_method relation_name do
+        model.send_query(self.send "#{ relation_name }_query".to_sym)
+      end
+    end
+
     def self.build sobject
       return nil if sobject.nil?
       model = new
@@ -32,37 +45,51 @@ module ActiveForce
       model
     end
 
+    def self.query
+      query = ActiveForce::Query.new(table_name)
+      query.fields fields
+      query
+    end
+
     def self.all
-      all = Client.query(<<-SOQL.strip_heredoc).to_a
-        SELECT
-          #{ fields.join(', ') }
-        FROM
-          #{ table_name }
-      SOQL
-      all.map do |mash|
+      send_query query
+    end
+
+    def self.send_query query
+      Client.query(query.to_s).to_a.map do |mash|
         build mash
       end
     end
 
     def self.find id
-      build Client.query(<<-SOQL.strip_heredoc).first
-        SELECT #{fields.join(', ')}
-        FROM #{table_name}
-        WHERE Id = '#{id}'
-      SOQL
+      send_query(query.find(id)).first
     end
 
-    def self.create(attributes = nil, &block)
-      if attributes.is_a?(Array)
-        attributes.collect { |attr| create(attr, &block) }
-      else
-        object = new(attributes, &block)
-        object.create
-        object
+    def update_attributes! attributes = {}
+      assign_attributes attributes
+      return false unless valid?
+      sobject_hash = { 'Id' => id }
+      changed.each do |field|
+        sobject_hash[mappings[field.to_sym]] = read_attribute(field)
       end
+      result = Client.update! table_name, sobject_hash
+      changed_attributes.clear
+      result
     end
 
-    def create
+    def update_attributes attributes = {}
+      update_attributes! attributes
+    rescue Faraday::Error::ClientError => error
+      Rails.logger.info do
+        "[SFDC] [#{self.class.model_name}] [#{self.class.table_name}] Error while updating, params: #{hash}, error: #{error.inspect}"
+      end
+      errors[:base] << error.message
+      false
+    end
+
+    alias_method :update, :update_attributes
+
+    def create!
       return false unless valid?
       hash = {}
       mappings.map do |field, name_in_sfdc|
@@ -71,26 +98,23 @@ module ActiveForce
       end
       self.id = Client.create! table_name, hash
       changed_attributes.clear
+    end
+
+    def create
+      create!
     rescue Faraday::Error::ClientError => error
-      Rails.logger.warn do
+      Rails.logger.info do
         "[SFDC] [#{self.class.model_name}] [#{self.class.table_name}] Error while creating, params: #{hash}, error: #{error.inspect}"
       end
       errors[:base] << error.message
       false
     end
 
-    def update_attributes attributes
-      assign_attributes attributes
-      if valid?
-        sobject_hash = { 'Id' => id }
-        changed.each do |field|
-          sobject_hash[mappings[field.to_sym]] = read_attribute(field)
-        end
-        result = Client.update table_name, sobject_hash
-        changed_attributes.clear if result
-        result
+    def save
+      if persisted?
+        update
       else
-        false
+        create
       end
     end
 

data/lib/active_force/version.rb

@@ -1,3 +1,3 @@
 module ActiveForce
-  VERSION = "0.0.7.alfa"
+  VERSION = "0.1.1"
 end

data/spec/active_force/association_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'active_force/association'
+
+describe ActiveForce::SObject do
+
+  before do
+    class Post < ActiveForce::SObject
+      self.table_name = "Post__c"
+    end
+
+    class Comment < ActiveForce::SObject
+      self.table_name = "Comment__c"
+    end
+  end
+
+  describe "has_many_query" do
+
+    before do
+      class Post < ActiveForce::SObject
+        has_many :comments
+      end
+
+      @post = Post.new
+      @post.stub(:id).and_return("1")
+    end
+
+    it "should return a Query object" do
+      @post.comments_query.class.should be ActiveForce::Query
+    end
+
+    describe 'to_s' do
+      it "should retrun a OSQL statment" do
+       @post.comments_query.to_s.should ==
+         "SELECT Id FROM Comment__c WHERE Post__c = '1'"
+      end
+    end
+  end
+
+  describe 'has_many(options)' do
+
+    it 'should allow to send a different query table name' do
+      class Post < ActiveForce::SObject
+        has_many :comments, { table: 'Comment' }
+      end
+      @post = Post.new
+      @post.stub(:id).and_return("1")
+      @post.comments_query.to_s.should ==
+        "SELECT Id FROM Comment WHERE Post__c = '1'"
+    end
+
+    it 'should allow to change the foreing key' do
+      class Post < ActiveForce::SObject
+        has_many :comments, { foreing_key: 'Post' }
+      end
+      @post = Post.new
+      @post.stub(:id).and_return("1")
+      @post.comments_query.to_s.should ==
+        "SELECT Id FROM Comment__c WHERE Post = '1'"
+    end
+
+    it 'should allow to add a where condition' do
+      class Post < ActiveForce::SObject
+        has_many :comments, { where: '1 = 1' }
+      end
+      @post = Post.new
+      @post.stub(:id).and_return("1")
+      @post.comments_query.to_s.should ==
+        "SELECT Id FROM Comment__c WHERE 1 = 1 AND Post__c = '1'"
+    end
+
+    it 'should use a convention name for the foreing key' do
+      class Comment < ActiveForce::SObject
+        field :post_id,         from: 'PostId'
+      end
+
+      class Post < ActiveForce::SObject
+        has_many :comments
+      end
+
+      @post = Post.new
+      @post.stub(:id).and_return("1")
+      @post.comments_query.to_s.should ==
+        "SELECT Id FROM Comment__c WHERE PostId = '1'"
+    end
+  end
+end

data/spec/active_query/query_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+require 'active_force/query'
+
+describe ActiveForce::Query do
+
+  before do
+    @query = ActiveForce::Query.new 'table_name'
+    @query.fields ['name', 'etc']
+  end
+
+  after do
+  end
+
+  describe ".all" do
+    it "table should return table name" do
+      @query.all.table.should be(@query.table)
+    end
+
+    it "fields should return fields" do
+      @query.all.fields.should == @query.fields
+    end
+  end
+
+  describe ".all.to_s" do
+    it "should return a query for all records" do
+      @query.all.to_s.should == "SELECT Id, name, etc FROM table_name"
+    end
+
+    it "should ignore dupicated attributes in select statment" do
+      @query.fields ['Id', 'name', 'etc']
+      @query.all.to_s.should == "SELECT Id, name, etc FROM table_name"
+    end
+  end
+
+  describe ".where" do
+    it "should add a where condition to a query" do
+      @query.where("name like '%a%'").to_s.should == "SELECT Id, name, etc FROM table_name WHERE name like '%a%'"
+    end
+
+    it "should add multiples conditions to a query" do
+      @query.where("condition1 = 1").where("condition2 = 2").to_s.should ==
+        "SELECT Id, name, etc FROM table_name WHERE condition1 = 1 AND condition2 = 2"
+    end
+  end
+
+  describe ".limit" do
+    it "should add a limit to a query" do
+      @query.limit("25").to_s.should == "SELECT Id, name, etc FROM table_name LIMIT 25"
+    end
+  end
+
+  describe ".limit_value" do
+    it "should return the limit value" do
+      @query.limit(4)
+      @query.limit_value.should == 4
+    end
+  end
+
+  describe ".offset" do
+    it "should add an offset to a query" do
+      @query.offset(4).to_s.should == "SELECT Id, name, etc FROM table_name OFFSET 4"
+    end
+  end
+
+  describe ".offset_value" do
+    it "should return the offset value" do
+      @query.offset(4)
+      @query.offset_value.should == 4
+    end
+  end
+
+  describe ".find.to_s" do
+    it "should return a query for 1 record" do
+      @query.find(2).to_s.should == "SELECT Id, name, etc FROM table_name WHERE Id = '2' LIMIT 1"
+    end
+  end
+
+  describe ".order" do
+    it "should add a order condition in the statment" do
+      @query.order("name desc").to_s.should == "SELECT Id, name, etc FROM table_name ORDER BY name desc"
+    end
+
+    it "should add a order condition in the statment with WHERE and LIMIT" do
+      @query.where("condition1 = 1").order("name desc").limit(1).to_s.should == 
+        "SELECT Id, name, etc FROM table_name WHERE condition1 = 1 ORDER BY name desc LIMIT 1"
+    end
+  end
+
+  describe '.join' do
+
+    before do
+      @join = ActiveForce::Query.new 'join_table_name'
+      @join.fields ['name', 'etc']
+    end
+
+    it 'sould add another select statment on the current select' do
+      @query.join(@join).to_s.should ==
+        'SELECT Id, name, etc, (SELECT Id, name, etc FROM join_table_name) FROM table_name'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_force
 version: !ruby/object:Gem::Version
-  version: 0.0.7.alfa
+  version: 0.1.1
 platform: ruby
 authors:
 - Eloy Espinaco
@@ -9,90 +9,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: restforce
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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'
 description: Use SalesForce as an ActiveModel
@@ -101,9 +101,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -112,14 +112,18 @@ files:
 - active_force.gemspec
 - lib/active_attr/dirty.rb
 - lib/active_force.rb
+- lib/active_force/association.rb
+- lib/active_force/query.rb
 - lib/active_force/sobject.rb
 - lib/active_force/version.rb
 - lib/generators/active_force/active_force_model/USAGE
 - lib/generators/active_force/active_force_model/active_force_model_generator.rb
 - lib/generators/active_force/active_force_model/templates/model.rb.erb
+- spec/active_force/association_spec.rb
 - spec/active_force/sobject/table_name_spec.rb
 - spec/active_force/sobject_spec.rb
 - spec/active_force_spec.rb
+- spec/active_query/query_spec.rb
 - spec/fixtures/sobject/single_sobject_hash.yml
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
@@ -134,25 +138,28 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Help you implement models persisting on Sales Force within Rails using RESTForce
 test_files:
+- spec/active_force/association_spec.rb
 - spec/active_force/sobject/table_name_spec.rb
 - spec/active_force/sobject_spec.rb
 - spec/active_force_spec.rb
+- spec/active_query/query_spec.rb
 - spec/fixtures/sobject/single_sobject_hash.yml
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
 - spec/support/whizbang.rb
+has_rdoc: