openstax_active_force 1.0.0

data/lib/active_force/standard_types.rb

@@ -0,0 +1,357 @@
+module StandardTypes
+  STANDARD_TYPES = %w[ 
+    Account
+    Asset
+    AssetFeed
+    AssetTag
+    AssignmentRule
+    AsyncApexJob
+    AttachedContentDocument
+    Attachment
+    AuthSession
+    Bookmark
+    BrandTemplate
+    BusinessHours
+    BusinessProcess
+    CallCenter
+    Campaign
+    CampaignFeed
+    CampaignMember
+    CampaignMemberStatus
+    CampaignOwnerSharingRule
+    Campaign
+    CampaignShare
+    CampaignTag
+    Case
+    CaseArticle
+    CaseComment
+    CaseContactRole
+    CaseFeed
+    CaseHistory
+    CaseMilestone
+    CaseOwnerSharingRule
+    CaseShare
+    CaseSolution
+    Solution
+    CaseStatus
+    CaseTag
+    CaseTeamMember
+    CaseTeamRole
+    CaseTeamTemplate
+    CaseTeamTemplateMember
+    CaseTeamTemplateRecord
+    CategoryData
+    CategoryNode
+    CategoryNodeLocalization
+    ChatterActivity
+    ChatterAnswersActivity
+    ChatterAnswersReputationLevel
+    ChatterAnswersReputationLevel
+    ChatterConversation
+    ChatterConversationMember
+    ChatterMessage
+    CollaborationGroup
+    CollaborationGroupFeed
+    CollaborationGroupMember
+    CollaborationGroupMemberRequest
+    CollaborationInvitation
+    CombinedAttachment
+    Community
+    Contact
+    ContactFeed
+    ContactHistory
+    ContactOwnerSharingRule
+    ContactShare
+    ContactTag
+    ContentDocument
+    ContentDocumentFeed
+    ContentDocumentHistory
+    ContentDocumentLink
+    ContentVersion
+    ContentVersionHistory
+    ContentWorkspace
+    ContentWorkspaceDoc
+    Contract
+    ContractContactRole
+    ContractFeed
+    ContractHistory
+    ContractLineItem
+    ContractLineItemHistory
+    ContractStatus
+    ContractTag
+    CronTrigger
+    CronJobDetail
+    CurrencyType
+    CustomBrand
+    CustomBrandAsset
+    CustomPermission
+    DandBCompany
+    Dashboard
+    DashboardComponent
+    DashboardComponentFeed
+    DashboardFeed
+    DashboardTag
+    DatacloudCompany
+    DatacloudContact
+    DatacloudDandBCompany
+    DatacloudOwnedEntity
+    DatacloudPurchaseUsage
+    DatacloudSocialHandle
+    DatedConversionRate
+    DeclinedEventRelation
+    Division
+    DivisionLocalization
+    Document
+    DocumentAttachmentMap
+    DocumentTag
+    EmailMessage
+    EmailServicesAddress
+    EmailServicesFunction
+    EmailStatus
+    EmailTemplate
+    Entitlement
+    EntitlementContact
+    EntitlementFeed
+    EntitlementHistory
+    EntitlementTemplate
+    EntityHistory
+    EntitySubscription
+    EnvironmentHubMember
+    Event
+    EventFeed
+    EventRelation
+    EventTag
+    EventWhoRelation
+    EventRelation
+    ExternalDataSource
+    ExternalDataUserAuth
+    FeedComment
+    FeedItem
+    FeedLike
+    FeedPollChoice
+    FeedPollVote
+    FeedPost
+    FeedTrackedChange
+    FieldPermissions
+    FiscalYearSettings
+    Folder
+    ForecastingAdjustment
+    ForecastingFact
+    ForecastingItem
+    ForecastingQuota
+    ForecastShare
+    Group
+    GroupMember
+    HashtagDefinition
+    Holiday
+    Idea
+    IdeaComment
+    IdeaTheme
+    KnowledgeableUser
+    KnowledgeArticle
+    KnowledgeArticleVersion
+    KnowledgeArticleVersionHistory
+    KnowledgeArticleViewStat
+    KnowledgeArticleVoteStat
+    Lead
+    LeadFeed
+    LeadHistory
+    LeadOwnerSharingRule
+    LeadShare
+    LeadStatus
+    LeadTag
+    LimitAllocationPerApp
+    LineitemOverride
+    LoginHistory
+    MailmergeTemplate
+    MilestoneType
+    Name
+    Network
+    NetworkActivityAudit
+    NetworkMember
+    NetworkMemberGroup
+    NetworkModeration
+    NewsFeed
+    Note
+    NoteAndAttachment
+    NoteTag
+    ObjectPermissions
+    ObjectTerritory2AssignmentRule
+    ObjectTerritory2AssignmentRuleItem
+    ObjectTerritory2Association
+    OpenActivity
+    Opportunity
+    OpportunityCompetitor
+    OpportunityContactRole
+    OpportunityFeed
+    OpportunityFieldHistory
+    OpportunityHistory
+    OpportunityLineItem
+    OpportunityLineItemSchedule
+    OpportunityOverride
+    OpportunityOwnerSharingRule
+    OpportunityPartner
+    OpportunityShare
+    OpportunitySplit
+    OpportunitySplitType
+    OpportunityStage
+    OpportunityTag
+    OpportunityTeamMember
+    Organization
+    OrgWideEmailAddress
+    OwnedContentDocument
+    PackageLicense
+    Partner
+    PartnerNetworkConnection
+    PartnerNetworkRecordConnection
+    PartnerRole
+    Period
+    PermissionSet
+    PermissionSetAssignment
+    Pricebook2
+    Pricebook2History
+    PricebookEntry
+    ProcessDefinition
+    ProcessInstance
+    ProcessInstanceHistory
+    ProcessInstanceNode
+    ProcessInstanceStep
+    ProcessInstanceWorkitem
+    ProcessNode
+    Product2
+    Product2Feed
+    ProductEntitlementTemplate
+    Profile
+    ProfileSkill
+    ProfileSkillEndorsement
+    ProfileSkillEndorsementHistory
+    ProfileSkillFeed
+    ProfileSkillHistory
+    ProfileSkillShare
+    ProfileSkillUser
+    ProfileSkillUserHistory
+    PushTopic
+    QuantityForecast
+    QuantityForecastHistory
+    Question
+    QuestionDataCategorySelection
+    QuestionReportAbuse
+    QuestionSubscription
+    QueueSobject
+    Quote
+    QuoteDocument
+    QuoteLineItem
+    RecentlyViewed
+    RecordType
+    RecordTypeLocalization
+    Reply
+    ReplyReportAbuse
+    Report
+    ReportFeed
+    ReportTag
+    RevenueForecast
+    RevenueForecastHistory
+    RuleTerritory2Association
+    Scontrol
+    ScontrolLocalization
+    SelfServiceUser
+    ServiceContract
+    ServiceContractFeed
+    ServiceContractHistory
+    ServiceContractOwnerSharingRule
+    ServiceContractShare
+    SetupEntityAccess
+    SignupRequest
+    Site
+    SiteHistory
+    SlaProcess
+    Solution
+    SolutionFeed
+    SolutionHistory
+    SolutionStatus
+    SolutionTag
+    StaticResource
+    StreamingChannel
+    TagDefinition
+    Task
+    TaskFeed
+    TaskPriority
+    TaskRelation
+    TaskStatus
+    TaskTag
+    TaskWhoRelation
+    TaskRelation
+    Territory
+    Territory2
+    Territory2Model
+    Territory2ModelHistory
+    Territory2Type
+    Topic
+    TopicAssignment
+    TopicFeed
+    UndecidedEventRelation
+    User
+    UserAccountTeamMember
+    UserConfigTransferButton
+    UserConfigTransferSkill
+    UserFeed
+    UserLicense
+    UserLogin
+    UserMembershipSharingRule
+    UserPackageLicense
+    UserPreference
+    UserProfile
+    UserProfileFeed
+    UserRecordAccess
+    UserRole
+    UserShare
+    UserTeamMember
+    UserTerritory
+    UserTerritory2Association
+    Vote
+    WebLink
+    WebLinkLocalization
+    WorkAccess
+    WorkAccessShare
+    WorkBadge
+    WorkBadgeDefinition
+    WorkBadgeDefinitionHistory
+    WorkBadgeDefinitionShare
+    WorkCoaching
+    WorkCoachingFeed
+    WorkCoachingHistory
+    WorkCoachingShare
+    WorkFeedback
+    WorkFeedbackQuestion
+    WorkFeedbackQuestionHistory
+    WorkFeedbackQuestionSet
+    WorkFeedbackQuestionSetShare
+    WorkFeedbackQuestionShare
+    WorkFeedbackRequest
+    WorkFeedbackRequestHistory
+    WorkFeedbackRequestShare
+    WorkFeedbackShare
+    WorkGoal
+    WorkGoalCollaborator
+    WorkGoalCollaboratorHistory
+    WorkGoalFeed
+    WorkGoalHistory
+    WorkGoalLink
+    WorkGoalShare
+    WorkPerformanceCycle
+    WorkPerformanceCycleFeed
+    WorkPerformanceCycleHistory
+    WorkPerformanceCycleShare
+    WorkReward
+    WorkRewardFund
+    WorkRewardFundHistory
+    WorkRewardFundShare
+    WorkRewardFundType
+    WorkRewardFundTypeHistory
+    WorkRewardFundTypeShare
+    WorkRewardHistory
+    WorkRewardShare
+    WorkThanks
+    WorkThanksShare 
+  ]
+end

data/lib/active_force/table.rb

@@ -0,0 +1,37 @@
+require 'active_force/standard_types'
+
+module ActiveForce
+  class Table
+
+    def initialize klass
+      @klass = klass.to_s
+    end
+
+    def table_name name = nil
+      @name = name || @name || pick_table_name
+    end
+
+    def name
+      @name ||= pick_table_name
+    end
+
+    def custom_table?
+      !StandardTypes::STANDARD_TYPES.include?(name_without_namespace)
+    end
+
+    private
+
+    def pick_table_name
+      if custom_table?
+        "#{ name_without_namespace }__c"
+      else
+        name_without_namespace
+      end
+    end
+
+    def name_without_namespace
+       @klass.split('::').last
+    end
+
+  end
+end

data/lib/active_force/version.rb

@@ -0,0 +1,3 @@
+module ActiveForce
+  VERSION = "1.0.0"
+end

data/lib/active_force.rb

@@ -0,0 +1,13 @@
+require 'active_force/version'
+require 'active_force/sobject'
+require 'active_force/query'
+
+module ActiveForce
+
+  class << self
+    attr_accessor :sfdc_client
+  end
+
+  self.sfdc_client = Restforce.new
+
+end

data/lib/generators/active_force/model/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate a model to interact with Sales Force.
+
+Example:
+    rails generate active_force_model Account
+
+    This will create:
+        app/models/account.rb

data/lib/generators/active_force/model/model_generator.rb

@@ -0,0 +1,62 @@
+module ActiveForce
+  class ModelGenerator < Rails::Generators::NamedBase
+    desc 'This generator loads the table fields from SFDC and generates the fields for the SObject with a more ruby names'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_model_file
+      @table_name = file_name.capitalize
+      @class_name = @table_name.gsub '__c', ''
+      template "model.rb.erb", "app/models/#{@class_name.downcase}.rb" if table_exists?
+    end
+
+    protected
+
+    Attribute = Struct.new :field, :column
+
+    def attributes 
+      @attributes ||= sfdc_columns.map do |column|
+        Attribute.new column_to_field(column), column
+      end
+      @attributes - [:id]
+    end
+
+    def sfdc_columns
+      @columns ||= ActiveForce::SObject.sfdc_client.describe(@table_name).fields.map do |field|
+        field.name
+      end
+    end
+
+    def table_exists?
+      !! sfdc_columns
+      rescue Faraday::Error::ResourceNotFound
+        puts "The specified table name is not found. Be sure to append __c if it's custom"
+    end
+
+    def column_to_field column
+      column.underscore.gsub("__c", "").to_sym
+    end
+
+    def attribute_line attribute
+      "field :#{ attribute.field },#{ space_justify attribute.field }  from: '#{ attribute.column }'"
+    end
+
+    def space_justify field_name
+      longest_field = attributes.map { |attr| attr.field.length } .max
+      justify_count = longest_field - field_name.length
+      " " * justify_count
+    end
+
+
+    class String
+      def underscore
+        self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+    end
+
+  end
+end

data/lib/generators/active_force/model/templates/model.rb.erb

@@ -0,0 +1,5 @@
+class <%= @class_name %> < ActiveForce::SObject
+<% attributes.each do |attribute| -%>
+  <%= attribute_line attribute %>
+<% end -%>
+end

data/spec/active_force/active_query_spec.rb

@@ -0,0 +1,178 @@
+require 'spec_helper'
+
+describe ActiveForce::ActiveQuery do
+  let(:sobject) do
+    double("sobject", {
+      table_name: "table_name",
+      fields: [],
+      mappings: mappings
+    })
+  end
+  let(:mappings){ { id: "Id", field: "Field__c", other_field: "Other_Field" } }
+  let(:client){ double("client") }
+  let(:active_query){ ActiveForce::ActiveQuery.new(sobject) }
+
+  before do
+    allow(active_query).to receive(:sfdc_client).and_return client
+    allow(active_query).to receive(:build).and_return Object.new
+  end
+
+  describe "to_a" do
+    before do
+      expect(client).to receive(:query)
+    end
+
+    it "should return an array of objects" do
+      result = active_query.where("Text_Label = 'foo'").to_a
+      expect(result).to be_a Array
+    end
+
+    it "should allow to chain query methods" do
+      result = active_query.where("Text_Label = 'foo'").where("Checkbox_Label = true").to_a
+      expect(result).to be_a Array
+    end
+  end
+
+  describe "select only some field using mappings" do
+    it "should return a query only with selected field" do
+      active_query.select(:field)
+      expect(active_query.to_s).to eq("SELECT Field__c FROM table_name")
+    end
+  end
+
+  describe "condition mapping" do
+    it "maps conditions for a .where" do
+      active_query.where(field: 123)
+      expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = 123)")
+    end
+
+    it 'transforms an array to a WHERE/IN clause' do
+      active_query.where(field: ['foo', 'bar'])
+      expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c IN ('foo','bar'))")
+    end
+
+    it "encloses the value in quotes if it's a string" do
+      active_query.where field: "hello"
+      expect(active_query.to_s).to end_with("(Field__c = 'hello')")
+    end
+
+    it "puts NULL when a field is set as nil" do
+      active_query.where field: nil
+      expect(active_query.to_s).to end_with("(Field__c = NULL)")
+    end
+
+    describe 'bind parameters' do
+      let(:mappings) do
+        super().merge({
+          other_field: 'Other_Field__c',
+          name: 'Name'
+        })
+      end
+
+      it 'accepts bind parameters' do
+        active_query.where('Field__c = ?', 123)
+        expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = 123)")
+      end
+
+      it 'accepts nil bind parameters' do
+        active_query.where('Field__c = ?', nil)
+        expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = NULL)")
+      end
+
+      it 'accepts multiple bind parameters' do
+        active_query.where('Field__c = ? AND Other_Field__c = ? AND Name = ?', 123, 321, 'Bob')
+        expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = 123 AND Other_Field__c = 321 AND Name = 'Bob')")
+      end
+
+      it 'complains when there given an incorrect number of bind parameters' do
+        expect{
+          active_query.where('Field__c = ? AND Other_Field__c = ? AND Name = ?', 123, 321)
+        }.to raise_error(ActiveForce::PreparedStatementInvalid, 'wrong number of bind variables (2 for 3)')
+      end
+
+      context 'named bind parameters' do
+        it 'accepts bind parameters' do
+          active_query.where('Field__c = :field', field: 123)
+          expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = 123)")
+        end
+
+        it 'accepts nil bind parameters' do
+          active_query.where('Field__c = :field', field: nil)
+          expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = NULL)")
+        end
+
+        it 'accepts multiple bind parameters' do
+          active_query.where('Field__c = :field AND Other_Field__c = :other_field AND Name = :name', field: 123, other_field: 321, name: 'Bob')
+          expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = 123 AND Other_Field__c = 321 AND Name = 'Bob')")
+        end
+
+        it 'accepts multiple bind parameters orderless' do
+          active_query.where('Field__c = :field AND Other_Field__c = :other_field AND Name = :name', name: 'Bob', other_field: 321, field: 123)
+          expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Field__c = 123 AND Other_Field__c = 321 AND Name = 'Bob')")
+        end
+
+        it 'complains when there given an incorrect number of bind parameters' do
+          expect{
+            active_query.where('Field__c = :field AND Other_Field__c = :other_field AND Name = :name', field: 123, other_field: 321)
+          }.to raise_error(ActiveForce::PreparedStatementInvalid, 'missing value for :name in Field__c = :field AND Other_Field__c = :other_field AND Name = :name')
+        end
+      end
+    end
+  end
+
+  describe "#find_by" do
+    it "should query the client, with the SFDC field names and correctly enclosed values" do
+      expect(client).to receive :query
+      active_query.find_by field: 123
+      expect(active_query.to_s).to eq "SELECT Id FROM table_name WHERE (Field__c = 123) LIMIT 1"
+    end
+  end
+
+  describe "responding as an enumerable" do
+    before do
+      expect(active_query).to receive(:to_a).and_return([])
+    end
+
+    it "should call to_a when receiving each" do
+      active_query.each {}
+    end
+
+    it "should call to_a when receiving map" do
+      active_query.map {}
+    end
+  end
+
+  describe "prevent SOQL injection attacks" do
+    let(:mappings){ { quote_field: "QuoteField", backslash_field: "Backslash_Field__c", number_field: "NumberField" } }
+    let(:quote_input){ "' OR Id!=NULL OR Id='" }
+    let(:backslash_input){ "\\" }
+    let(:number_input){ 123 }
+    let(:expected_query){ "SELECT Id FROM table_name WHERE (Backslash_Field__c = '\\\\' AND NumberField = 123 AND QuoteField = ''' OR Id!=NULL OR Id=''')" }
+
+    it 'escapes quotes and backslashes in bind parameters' do
+      active_query.where('Backslash_Field__c = :backslash_field AND NumberField = :number_field AND QuoteField = :quote_field', number_field: number_input, backslash_field: backslash_input, quote_field: quote_input)
+      expect(active_query.to_s).to eq(expected_query)
+    end
+
+    it 'escapes quotes and backslashes in named bind parameters' do
+      active_query.where('Backslash_Field__c = ? AND NumberField = ? AND QuoteField = ?', backslash_input, number_input, quote_input)
+      expect(active_query.to_s).to eq(expected_query)
+    end
+
+    it 'escapes quotes and backslashes in hash conditions' do
+      active_query.where(backslash_field: backslash_input, number_field: number_input, quote_field: quote_input)
+      expect(active_query.to_s).to eq("SELECT Id FROM table_name WHERE (Backslash_Field__c = '\\\\') AND (NumberField = 123) AND (QuoteField = ''' OR Id!=NULL OR Id=''')")
+    end
+  end
+
+  describe '#none' do
+    it 'returns a query with a where clause that is impossible to satisfy' do
+      expect(active_query.none.to_s).to eq "SELECT Id FROM table_name WHERE (Id = '111111111111111111') AND (Id = '000000000000000000')"
+    end
+
+    it 'does not query the API' do
+      expect(client).to_not receive :query
+      active_query.none.to_a
+    end
+  end
+end