active_force 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acf8e175727f61a6fc99099804f1759a8539d11f
-  data.tar.gz: df64cceabf34fba0ff538283ac59b278b91acf98
+  metadata.gz: e99615e3d168755a419d7264acc03d5e8d230301
+  data.tar.gz: a38eec002c02ced5930ba02da66efbdf833a01a1
 SHA512:
-  metadata.gz: 5f32456704f543150f8d8f7ba414adfade927cea8f3abe9ea0d847f43ab1dd3f74644d15e607961759f98538315fd9d7ab72c872c0284eb9012bc0ce97081237
-  data.tar.gz: c410492b5afdf5e9110415ae1abe3f5869df4806e4d77af708573f335e2fda9143b4bae722a544d64da08f4ad58ec786bc30b344caa90994fc3b6216a2c30642
+  metadata.gz: 4bb06e3a6de2e82d2f0aa0f86965a1199ce4be71b66709482954fb0e685ac4765d08bf925d7c0ee5ee015ab5663dc54f584d85a6a15655442b6d230e47e14671
+  data.tar.gz: 6ca95ce88edcaf1568c6e4db643b8acdcaea075020f1fc40f1ae6c3ef5e9d3ae0ad278f800a17a726275dbda9bc65b580b862a5e02421f54d41754a690cbf884

data/.travis.yml

@@ -1,3 +1,11 @@
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+  fast_finish: true
+env:
+  - CODECLIMATE_REPO_TOKEN=1c5ed259429e0bfc5412974d69cfba2780962a87ca8c543d684e33fea37f7e71 

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in active_force.gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil
 gemspec

data/README.md

@@ -1,5 +1,9 @@
 [![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)
+[![Build Status](http://img.shields.io/travis/ionia-corporation/active_force.svg)](https://travis-ci.org/ionia-corporation/active_force)
+[![Code Climate](http://img.shields.io/codeclimate/github/ionia-corporation/active_force.svg)](https://codeclimate.com/github/ionia-corporation/active_force)
+[![Dependency Status](http://img.shields.io/gemnasium/ionia-corporation/active_force.svg)](https://gemnasium.com/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)
+
 
 # ActiveForce
 
@@ -19,6 +23,14 @@ And then execute:
 Or install it yourself as:
 
     $ gem install active_force
+    
+Rails:
+
+```ruby
+#Add this to initializers/restforce.rb
+Restforce.log = true if Rails.env.development?
+::Client = Restforce.new
+```
 
 ## Usage
 

data/active_force.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = "eloyesp@gmail.com"
   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      = ""
+  spec.homepage      = "https://github.com/ionia-corporation/active_force"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,10 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.0'
+
   spec.add_dependency 'active_attr', '~> 0.8'
   spec.add_dependency 'restforce',   '~> 1.4'
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'pry', '~> 0'
 end

data/lib/active_force/association.rb

@@ -1,39 +1,24 @@
-require 'active_force/query'
+require 'active_force/association/association'
+require 'active_force/association/has_many_association'
+require 'active_force/association/belongs_to_association'
 
 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
+      def has_many relation_name, options = {}
+        HasManyAssociation.new(self, relation_name, options)
       end
 
-      def relation_model sym
-        sym.to_s.singularize.camelcase.constantize
+      def belongs_to relation_name, options = {}
+        BelongsToAssociation.new(self, relation_name, options)
       end
 
-      def default_foreing_key relation_model, model
-        relation_model.mappings["#{model.downcase}_id".to_sym]
-      end
+    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
+    def self.included mod
+      mod.extend ClassMethods
     end
+
   end
-end
+end

data/lib/active_force/association/association.rb

@@ -0,0 +1,30 @@
+module ActiveForce
+  module Association
+    class Association
+
+      attr_accessor :options
+
+      def initialize parent, relation_name, options
+        @parent = parent
+        @relation_name = relation_name
+        @options = options
+        build
+      end
+
+      def relation_model
+        @options[:model] || @relation_name.to_s.singularize.camelcase.constantize
+      end
+
+      private
+
+      def build
+        define_relation_method
+      end
+
+      def default_sfdc_foreign_key
+        relation_model.mappings["#{ @parent.name.downcase }_id".to_sym]
+      end
+    end
+
+  end
+end

data/lib/active_force/association/belongs_to_association.rb

@@ -0,0 +1,21 @@
+module ActiveForce
+  module Association
+
+    class BelongsToAssociation < Association
+
+      def foreign_key
+        options[:foreign_key] || "#{ @relation_name }_id".to_sym
+      end
+
+      private
+
+      def define_relation_method
+        association = self
+        @parent.send :define_method, @relation_name do
+          association.relation_model.find(self.send association.foreign_key)
+        end
+      end
+    end
+
+  end
+end

data/lib/active_force/association/has_many_association.rb

@@ -0,0 +1,37 @@
+module ActiveForce
+  module Association
+    class HasManyAssociation < Association
+
+      def foreign_key
+        @options[:foreign_key] || default_sfdc_foreign_key || @parent.table_name
+      end
+
+      private
+
+      def build
+        super
+        define_query_method
+      end
+
+      def define_query_method
+        association = self
+        @parent.send :define_method, query_method_name do
+          query = association.relation_model.query
+          query.options association.options
+          query.where "#{ association.foreign_key } = '#{ self.id }'"
+        end
+      end
+
+      def define_relation_method
+        association = self
+        @parent.send :define_method, @relation_name do
+          association.relation_model.send_query send(association.query_method_name)
+        end
+      end
+
+      def query_method_name
+        "#{ @relation_name }_query"
+      end
+    end
+  end
+end

data/lib/active_force/finders.rb

@@ -0,0 +1,37 @@
+module ActiveForce
+  module Finders
+    module ClassMethods
+      def find_by conditions
+        query = self.query
+        query_conditions(conditions).each do |query_condition|
+          query = query.where query_condition
+        end
+        send_query(query).first
+      end
+
+      private
+
+      #maps a hash key => value to a string 'key = value'
+      def query_conditions conditions
+        conditions.map do |key, value|
+          "#{ mappings[key] } = #{ enclose_value value }"
+        end
+      end
+
+      # encloses the value in quotes if it's a string
+      def enclose_value value
+        if value.is_a? String
+          "'#{value}'"
+        else
+          value.to_s
+        end
+      end
+
+    end
+
+    def self.included mod
+      mod.extend ClassMethods
+    end
+
+  end
+end

data/lib/active_force/query.rb

@@ -2,8 +2,6 @@ module ActiveForce
   class Query
     attr_reader :table
 
-    attr_accessor :table_id
-
     def initialize table
       @table = table
       @conditions = []
@@ -20,7 +18,7 @@ module ActiveForce
     end
 
     def to_s
-      query = <<-SOQL.gsub(/\s+/, " ").strip
+      <<-SOQL.gsub(/\s+/, " ").strip
         SELECT
           #{ @query_fields.uniq.join(', ') }
         FROM
@@ -30,21 +28,20 @@ module ActiveForce
         #{ build_limit }
         #{ build_offset }
       SOQL
-      query
     end
 
     def where condition
-      @conditions << condition
+      @conditions << condition if condition
       self
     end
 
     def order order
-      @order = order
+      @order = order if order
       self
     end
 
     def limit size
-      @size = size
+      @size = size if size
       self
     end
 
@@ -64,7 +61,14 @@ module ActiveForce
     def find id
       where "#{ @table_id } = '#{ id }'"
       limit 1
-      self
+    end
+
+    def first
+      limit 1
+    end
+
+    def last
+      order("Id DESC").limit(1)
     end
 
     def join object_query
@@ -72,11 +76,20 @@ module ActiveForce
       self
     end
 
+    def count
+      @query_fields = ["count(Id)"]
+      self
+    end
+
+    def options args
+      where args[:where]
+      limit args[:limit]
+      order args[:order]
+    end
+
     protected
       def build_where
-        unless @conditions.empty?
-          "WHERE #{ @conditions.join(' AND ') }"
-        end
+        "WHERE #{ @conditions.join(' AND ') }" unless @conditions.empty?
       end
 
       def build_limit
@@ -91,4 +104,4 @@ module ActiveForce
         "OFFSET #{ @offset }" if @offset
       end
   end
-end
+end

data/lib/active_force/sobject.rb

@@ -3,6 +3,7 @@ require 'active_attr'
 require 'active_attr/dirty'
 require 'active_force/query'
 require 'active_force/association'
+require 'active_force/finders'
 require 'yaml'
 
 module ActiveForce
@@ -10,8 +11,7 @@ module ActiveForce
     include ActiveAttr::Model
     include ActiveAttr::Dirty
     include ActiveForce::Association
-
-    extend ClassMethods
+    include ActiveForce::Finders
 
     STANDARD_TYPES = %w[ Account Contact Opportunity Campaign]
 
@@ -27,16 +27,8 @@ 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?
+      return unless sobject
       model = new
       mappings.each do |attr, sf_field|
         model[attr] = sobject[sf_field]
@@ -51,12 +43,24 @@ module ActiveForce
       query
     end
 
+    def self.first
+      send_query(query.first).first
+    end
+
+    def self.last
+      send_query(query.last).first
+    end
+
     def self.all
       send_query query
     end
 
+    def self.count
+      sfdc_client.query(query.count).first.expr0
+    end
+
     def self.send_query query
-      Client.query(query.to_s).to_a.map do |mash|
+      sfdc_client.query(query.to_s).to_a.map do |mash|
         build mash
       end
     end
@@ -72,7 +76,7 @@ module ActiveForce
       changed.each do |field|
         sobject_hash[mappings[field.to_sym]] = read_attribute(field)
       end
-      result = Client.update! table_name, sobject_hash
+      result = sfdc_client.update! table_name, sobject_hash
       changed_attributes.clear
       result
     end
@@ -96,7 +100,7 @@ module ActiveForce
         value = read_value field
         hash[name_in_sfdc] = value if value.present?
       end
-      self.id = Client.create! table_name, hash
+      self.id = sfdc_client.create! table_name, hash
       changed_attributes.clear
     end
 
@@ -145,10 +149,18 @@ module ActiveForce
       end
 
       def self.picklist field
-        picks = Client.picklist_values(table_name, mappings[field])
+        picks = sfdc_client.picklist_values(table_name, mappings[field])
         picks.map do |value|
           [value[:label], value[:value]]
         end
       end
+
+      def self.sfdc_client
+        Client
+      end
+
+      def sfdc_client
+        self.class.sfdc_client
+      end
   end
 end

data/lib/active_force/version.rb

@@ -1,3 +1,3 @@
 module ActiveForce
-  VERSION = "0.1.1"
+  VERSION = "0.3.1"
 end

data/spec/active_force/association_spec.rb

@@ -3,6 +3,23 @@ require 'active_force/association'
 
 describe ActiveForce::SObject do
 
+  let :post do
+    post = Post.new
+    post.stub(:id).and_return "1"
+    post
+  end
+
+  let :comment do
+    comment = Comment.new
+    comment.stub(:id).and_return "1"
+    comment.stub(:post_id).and_return "1"
+    comment
+  end
+
+  let :client do
+    double("sfdc_client")
+  end
+
   before do
     class Post < ActiveForce::SObject
       self.table_name = "Post__c"
@@ -11,6 +28,8 @@ describe ActiveForce::SObject do
     class Comment < ActiveForce::SObject
       self.table_name = "Comment__c"
     end
+
+    ActiveForce::SObject.stub(:sfdc_client).and_return client
   end
 
   describe "has_many_query" do
@@ -19,18 +38,19 @@ describe ActiveForce::SObject do
       class Post < ActiveForce::SObject
         has_many :comments
       end
+    end
 
-      @post = Post.new
-      @post.stub(:id).and_return("1")
+    it "should respond to relation method" do
+      expect(post).to respond_to(:comments)
     end
 
     it "should return a Query object" do
-      @post.comments_query.class.should be ActiveForce::Query
+      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 ==
+       post.comments_query.to_s.should ==
          "SELECT Id FROM Comment__c WHERE Post__c = '1'"
       end
     end
@@ -39,48 +59,48 @@ describe ActiveForce::SObject do
   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'"
+      Post.has_many :ugly_comments, { model: Comment }
+      post.comments_query.to_s.should ==
+        "SELECT Id FROM Comment__c 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 ==
+    it 'should allow to change the foreign key' do
+      Post.has_many :comments, { foreign_key: 'Post' }
+      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 ==
+      Post.has_many :comments, { where: '1 = 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
+    it 'should use a convention name for the foreign key' do
+      Comment.field :post_id, from: 'PostId'
+      Post.has_many :comments
+      post.comments_query.to_s.should ==
+        "SELECT Id FROM Comment__c WHERE PostId = '1'"
+    end
+  end
 
-      class Post < ActiveForce::SObject
-        has_many :comments
-      end
+  describe "belongs_to" do
 
-      @post = Post.new
-      @post.stub(:id).and_return("1")
-      @post.comments_query.to_s.should ==
-        "SELECT Id FROM Comment__c WHERE PostId = '1'"
+    before do
+      Comment.belongs_to :post
+      client.stub(:query).and_return Restforce::Mash.new(id: 1)
+    end
+
+    it "should get the resource it belongs to" do
+      expect(comment.post).to be_instance_of(Post)
     end
+
+    it "should allow to pass a foreign key as options" do
+      Comment.belongs_to :post, foreign_key: :fancy_post_id
+      comment.stub(:fancy_post_id).and_return "1"
+      client.should_receive(:query).with("SELECT Id FROM Post__c WHERE Id = '1' LIMIT 1")
+      comment.post
+    end
+
   end
-end
+end

data/spec/active_force/sobject_spec.rb

@@ -64,4 +64,29 @@ describe ActiveForce::SObject do
 
   end
 
+  describe "#count" do
+    let(:count_response){ [Restforce::Mash.new(expr0: 1)] }
+
+    it "responds to count" do
+      Whizbang.should respond_to(:count)
+    end
+
+    it "sends the query to the client" do
+      Client.should_receive(:query).and_return(count_response)
+      expect(Whizbang.count).to eq(1)
+    end
+
+  end
+
+  describe "#find_by" do
+    it "responds to find_by" do
+      Whizbang.should respond_to(:find_by)
+    end
+
+    it "should query the client, with the SFDC field names and correctly enclosed values" do
+      Client.should_receive(:query).with("SELECT Id FROM Whizbang__c WHERE Id = 123 AND Text_Label = 'foo'")
+      Whizbang.find_by id: 123, text: "foo"
+    end
+  end
+
 end

data/spec/active_query/query_spec.rb

@@ -81,7 +81,7 @@ describe ActiveForce::Query do
     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 == 
+      @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
@@ -93,9 +93,57 @@ describe ActiveForce::Query do
       @join.fields ['name', 'etc']
     end
 
-    it 'sould add another select statment on the current select' do
+    it 'should 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
+
+  describe '.first' do
+    it 'should return the query for the first record' do
+      @query.first.to_s.should ==
+        'SELECT Id, name, etc FROM table_name LIMIT 1'
+    end
+  end
+
+  describe '.last' do
+    it 'should return the query for the last record' do
+      @query.last.to_s.should ==
+        'SELECT Id, name, etc FROM table_name ORDER BY Id DESC LIMIT 1'
+    end
+  end
+
+  describe ".count" do
+    it "should return the query for getting the row count" do
+      @query.count.to_s.should ==
+        'SELECT count(Id) FROM table_name'
+    end
+
+    it "should work with a condition" do
+      @query.where("name = 'cool'").count.to_s.should ==
+        "SELECT count(Id) FROM table_name WHERE name = 'cool'"
+    end
+  end
+
+  describe '.options' do
+    it 'should add a where if the option has a where condition' do
+      @query.options(where: 'var = 1').to_s.should ==
+        "SELECT Id, name, etc FROM table_name WHERE var = 1"
+    end
+
+    it 'should add a limit if the option has a limit condition' do
+      @query.options(limit: 1).to_s.should ==
+        "SELECT Id, name, etc FROM table_name LIMIT 1"
+    end
+
+    it 'should add a order if the option has a order condition' do
+      @query.options(order: 'name desc').to_s.should ==
+        "SELECT Id, name, etc FROM table_name ORDER BY name desc"
+    end
+
+    it 'should work with multiples options' do
+      @query.options(where: 'var = 1', order: 'name desc', limit: 1).to_s.should ==
+        "SELECT Id, name, etc FROM table_name WHERE var = 1 ORDER BY name desc LIMIT 1"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,8 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'restforce'
 require 'active_force'
 Dir["./spec/support/**/*"].sort.each { |f| require f }
 require 'pry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_force
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Eloy Espinaco
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -57,42 +57,42 @@ dependencies:
   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
@@ -113,6 +113,10 @@ files:
 - lib/active_attr/dirty.rb
 - lib/active_force.rb
 - lib/active_force/association.rb
+- lib/active_force/association/association.rb
+- lib/active_force/association/belongs_to_association.rb
+- lib/active_force/association/has_many_association.rb
+- lib/active_force/finders.rb
 - lib/active_force/query.rb
 - lib/active_force/sobject.rb
 - lib/active_force/version.rb
@@ -128,7 +132,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
 - spec/support/whizbang.rb
-homepage: ''
+homepage: https://github.com/ionia-corporation/active_force
 licenses:
 - MIT
 metadata: {}
@@ -138,9 +142,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="