openstax_salesforce 3.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 495928f3786d517d310b02425a165feb2793a1ce5d779926e9fabba7720a169c
-  data.tar.gz: 880717a2884911133d5e80ab64b93b62a707a31bd37e804a4affb132ea9f75c9
+  metadata.gz: c3e95723e60a5ef4c192f0fdd72a60adcb297ecd74898b66b9d5da7717ff0da2
+  data.tar.gz: ae495414e4c8aeb283987f40d9877d5805274ffad92ca396caffa5fc57ff9ed2
 SHA512:
-  metadata.gz: '091355843b386c1a6277ceeeeca6da42fbb057026055ddac97fe9a987346e925523c4425c1435b1e00e2dd70e16b257a6134277394103f0cb051f5ffc206468e'
-  data.tar.gz: d394a7a63310def542a9d64edb6129522f47bfc38d6d5f73d222da22e6eaf870f4870fa1234d09103c5f6d8175c044d0095285f1c02cf69fdcf4055b59ba55cd
+  metadata.gz: d25955fc494e054d17b94738f5a495f9681082a496577d90171d205583f58c8353526ca7dfdf63d9b31b0d5772ba48eb511effdd22343f05afa9ec4e4a25984e
+  data.tar.gz: 38fe1cfa437ee9de0f7ebd148b5d5e9fb8b94543f2a2b5900283fe81c28cfd93bda313ccee8cdc536c5d2363efb3022e9dfdf2f632abbc1e00f35e37dbbe3f8c

data/README.md

@@ -4,17 +4,15 @@
 [![Build Status](https://travis-ci.org/openstax/openstax_salesforce.svg?branch=master)](https://travis-ci.org/openstax/openstax_salesforce)
 [![Code Climate](https://codeclimate.com/github/openstax/openstax_salesforce/badges/gpa.svg)](https://codeclimate.com/github/openstax/openstax_salesforce)
 
-OpenStax::Salesforce is a Rails engine used by OpenStax projects to communicate with the OpenStax Salesforce instance.
+OpenStax::Salesforce is a Rails engine used by OpenStax projects to communicate
+with the OpenStax Salesforce instance.
 
 ## Installation
 
-Add these line to your application's Gemfile:
+Add this line to your application's Gemfile:
 
 ```rb
 gem 'openstax_salesforce'
-
-# ActiveForce fork that supports Ruby >= 2.1 and stubbable stdout
-gem 'active_force', git: 'https://github.com/openstax/active_force', ref: '7caac17'
 ```
 
 And then execute:
@@ -29,65 +27,38 @@ Or install it yourself:
 $ gem install openstax_salesforce
 ```
 
-Then execute the following command to copy the necessary migration and the initializer to your application:
+Then execute the following command to copy the necessary initializer to your application:
 
 ```sh
 $ rake openstax_salesforce:install
 ```
 
-And then migrate your database:
-
-```sh
-$ rake db:migrate
-```
-
-Also add OpenStax::Salesforce to your application's routes:
-
-```rb
-mount OpenStax::Salesforce::Engine, at: "/salesforce"
-OpenStax::Salesforce.set_top_level_routes(self)
-```
-
-The `set_top_level_routes` should be called at the top level inside `routes.rb`.  It adds oauth callback
-routes at the top level.
-
-And provide a link on your site for administrators to access the engine.
-
-```erb
-<%= link_to 'Salesforce Setup', openstax_salesforce_path %>
-```
-
 ## Configuration
 
 After installation, the initializer for OpenStax::Salesforce will be located under
-`config/initializers/openstax_salesforce.rb`. Make sure to configure it to suit
-your needs. Pay particular attention to `authenticate_admin_proc`,
-as you will be unable to access the setup pages until this proc is setup to return
-`true` for your admins.
+`config/initializers/openstax_salesforce.rb`. Make sure to configure it to suit your needs.
+
+You will need the following information from Salesforce:
+  - Your username (append .sandboxname if using a sandbox)
+  - Your password
+  - Your security token
+  - Connected App's client key
+  - Connected App's client secret
+Enter all the above information in the initializer, secrets.yml or environment variables.
 
 ## Testing
 
-From the gem's main folder, run `bundle install`,
-`bundle exec rake db:migrate` and then
-`bundle exec rake` to run all the specs.
+From the gem's main folder, run `bundle install` and then `bundle exec rake` to run all the specs.
 
-## Specs in Parent App
+### Specs in Parent App
 
-There's a helper you can include in your parent app's salesforce specs.  It isn't automatically
-required by this engine, so you have to do it manually in your spec:
+There's a helper you can include in your parent app's salesforce specs.
+It isn't automatically required by this engine, so you have to do it manually in your spec:
 
 ```ruby
 require 'openstax/salesforce/spec_helper'
 ```
 
-If the oauth token in `OpenStax::Salesforce::User.first` expires, you can update it with
-
-```ruby
-OpenStax::Salesforce::User.first.refresh_oauth_token!
-```
-
-and then copy that token into your spec setup.
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -14,9 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
 load 'rails/tasks/statistics.rake'
 
 Bundler::GemHelper.install_tasks
@@ -25,6 +22,6 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 
 desc 'Run all specs in spec directory (excluding plugin specs)'
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+RSpec::Core::RakeTask.new :spec
 
-task :default => :spec
+task default: :spec

data/config/initializers/openstax_salesforce.rb

@@ -2,45 +2,20 @@
 # also be copied to the application's initializers by running the install
 # task. Because this code can get run multiple times, make sure to only put
 # code here that is amenable to that.
-
 OpenStax::Salesforce.configure do |config|
-  # Layout to be used for OpenStax::Salesforce's controllers
-  config.layout = 'application'
-
-  # Proc called with an argument of the controller where this is called.
-  # This proc is called when a user tries to access the engine's controllers.
-  # Should raise an exception, render or redirect unless the user is a manager
-  # or admin. The default renders 403 Forbidden for all users.
-  config.authenticate_admin_proc = ->(controller) {
-    controller.head(:forbidden)
-  }
-
-  # Consumer key and secret for connecting to the Salesforce app
-  config.salesforce_client_key = 'put_real_key_value_here'
-  config.salesforce_client_secret = 'put_real_secret_value_here'
-
-  # Uncomment this to override the login site for sandbox instances; ok to be nil
-  # config.salesforce_login_site = 'https://test.salesforce.com'
+  salesforce_secrets = Rails.application.secrets.salesforce
 
-  # The following sandbox tokens are used for specs to connect to a sandbox Salesforce
-  # instance.
-  if Rails.env.test?
-    config.sandbox_oauth_token = 'put_real_value_here'
-    config.sandbox_refresh_token = 'put_real_value_here'
-    config.sandbox_instance_url = 'put_real_value_here'
+  if salesforce_secrets.nil?
+    raise "Add a `salesforce` section to your Rails secrets!"
   end
 
-  # Change this to true if you want to call the omniauth setup on your own
-  config.skip_automatic_omniauth_setup = false
+  # Username, client id, instance url and private key for connecting to the Salesforce app
+  config.username        = salesforce_secrets[:username]
+  config.password        = salesforce_secrets[:password]
+  config.security_token  = salesforce_secrets[:security_token]
+  config.consumer_key    = salesforce_secrets[:consumer_key]
+  config.consumer_secret = salesforce_secrets[:consumer_secret]
 
-  # If `check_sandbox_instance_url` is true (default), the spec helper that
-  # uses the instance URL will checks that the URL starts with "cs", which
-  # indicates that the instance is a sandbox.
-  config.check_sandbox_instance_url = true
-
-  # A way to customize page headings.  Sometimes apps fold the page heading
-  # into the layout in different ways.
-  config.page_heading_proc = ->(view, text) { "<h2>#{text}</h2>".html_safe }
+  config.api_version  = salesforce_secrets.fetch :api_version, '37.0'
+  config.login_domain = salesforce_secrets.fetch :login_domain, 'test.salesforce.com'
 end
-
-

data/db/migrate/0_install_openstax_salesforce.rb

@@ -1,3 +1,4 @@
+# TODO: Remove after all servers have been migrated
 class InstallOpenStaxSalesforce < ActiveRecord::Migration[4.2]
   def change
     create_table :openstax_salesforce_users do |t|

data/db/migrate/1_drop_openstax_salesforce_users.rb

@@ -0,0 +1,14 @@
+# TODO: Remove after all servers have been migrated
+class DropOpenStaxSalesforceUsers < ActiveRecord::Migration[4.2]
+  def change
+    drop_table :openstax_salesforce_users do |t|
+      t.string :name
+      t.string :uid, null: false
+      t.string :oauth_token, null: false
+      t.string :refresh_token, null: false
+      t.string :instance_url, null: false
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/openstax/salesforce/active_force.rb

@@ -1,9 +1,7 @@
 # Monkey patching
 
 module ActiveForce
-
   class << self
-
     # Use a lazy setting of the client so that migrations etc are in place
     # to allow the Client to be successfully instantiated.
     alias_method :original_sfdc_client, :sfdc_client
@@ -17,7 +15,6 @@ module ActiveForce
     def clear_sfdc_client!
       self.sfdc_client = nil
     end
-
   end
 
   class SObject
@@ -34,5 +31,4 @@ module ActiveForce
     # access to the original implementation
     singleton_class.send(:alias_method, :original_query, :query)
   end
-
 end

data/lib/openstax/salesforce/client.rb

@@ -1,25 +1,19 @@
 module OpenStax::Salesforce
   class Client < ::Restforce::Data::Client
-
     def initialize
-      user = OpenStax::Salesforce::User.first
-
-      raise(UserMissing, "The Salesforce client was requested but no user is available.") if user.nil?
+      configuration = OpenStax::Salesforce.configuration
 
-      client_key = OpenStax::Salesforce.configuration.salesforce_client_key
-      client_secret = OpenStax::Salesforce.configuration.salesforce_client_secret
+      configuration.validate!
 
-      raise(IllegalState, "The Salesforce key is missing") if client_key.nil?
-      raise(IllegalState, "The Salesforce secret is missing") if client_secret.nil?
-
-      super(host: OpenStax::Salesforce.configuration.salesforce_login_domain,
-            oauth_token: user.oauth_token,
-            refresh_token: user.refresh_token,
-            instance_url: user.instance_url,
-            client_id: client_key,
-            client_secret: client_secret,
-            api_version: '37.0')
+      super(
+        username:       configuration.username,
+        password:       configuration.password,
+        security_token: configuration.security_token,
+        client_id:      configuration.consumer_key,
+        client_secret:  configuration.consumer_secret,
+        api_version:    configuration.api_version,
+        host:           configuration.login_domain
+      )
     end
-
   end
 end

data/lib/openstax/salesforce/engine.rb

@@ -2,8 +2,10 @@ ActiveSupport::Inflector.inflections do |inflect|
   inflect.acronym 'OpenStax'
 end
 
-module OpenStax::Salesforce
-  class Engine < ::Rails::Engine
-    isolate_namespace OpenStax::Salesforce
+module OpenStax
+  module Salesforce
+    class Engine < ::Rails::Engine
+      isolate_namespace OpenStax::Salesforce
+    end
   end
 end

data/lib/openstax/salesforce/remote/campaign.rb

@@ -1,10 +1,8 @@
 module OpenStax::Salesforce::Remote
   class Campaign < ActiveForce::SObject
-
     field :is_active,                   from: "IsActive",              as: :boolean
     field :name,                        from: "Name"
 
     self.table_name = 'Campaign'
-
   end
 end

data/lib/openstax/salesforce/remote/campaign_member.rb

@@ -1,6 +1,5 @@
 module OpenStax::Salesforce::Remote
   class CampaignMember < ActiveForce::SObject
-
     field :campaign_id,                                       from: "CampaignId"
     field :contact_id,                                        from: "ContactId"
     field :accounts_uuid,                                     from: "accounts_uuid__c"

data/lib/openstax/salesforce/remote/contact.rb

@@ -16,6 +16,7 @@ module OpenStax::Salesforce::Remote
     field :send_faculty_verification_to, from: "SendFacultyVerificationTo__c"
     field :all_emails,                   from: "All_Emails__c"
     field :confirmed_emails,             from: "Confirmed_Emails__c"
+    field :adoption_status,              from: "Adoption_Status__c"
 
     self.table_name = 'Contact'
   end

data/lib/openstax/salesforce/remote/opportunity.rb

@@ -1,6 +1,5 @@
 module OpenStax::Salesforce::Remote
   class Opportunity < ActiveForce::SObject
-
     field :term_year,                    from: "TermYear__c"
     field :book_name,                    from: "Book_Text__c"
     field :contact_id,                   from: "Contact__c"
@@ -11,6 +10,5 @@ module OpenStax::Salesforce::Remote
     def term_year_object
       @term_year_object ||= OpenStax::Salesforce::Remote::TermYear.from_string(term_year)
     end
-
   end
 end

data/lib/openstax/salesforce/remote/school.rb

@@ -1,6 +1,10 @@
 module OpenStax::Salesforce::Remote
   class School < ActiveForce::SObject
-    field :name,                      from: "Name"
+    field :name,            from: 'Name'
+    field :type,            from: 'Type'
+    field :school_location, from: 'School_Location__c'
+    field :is_kip,          from: 'K_I_P__c',        as: :boolean
+    field :is_child_of_kip, from: 'child_of_kip__c', as: :boolean
 
     self.table_name = 'Account'
   end

data/lib/openstax/salesforce/remote/term_year.rb

@@ -1,6 +1,5 @@
 module OpenStax::Salesforce::Remote
   class TermYear
-
     # TermYear strings in Salesforce look like:
     #   2015 - 16 Fall
     #   2015 - 16 Spring
@@ -75,6 +74,5 @@ module OpenStax::Salesforce::Remote
     end
 
     class ParseError < StandardError; end
-
   end
 end

data/lib/openstax/salesforce/remote/tutor_course_period.rb

@@ -1,6 +1,5 @@
 module OpenStax::Salesforce::Remote
   class TutorCoursePeriod < ActiveForce::SObject
-
     field :num_teachers,              from: "Active_Teachers__c", as: :int
     field :base_year,                 from: "Base_Year__c", as: :int
     field :book_name,                 from: "Book_Name__c"
@@ -44,6 +43,5 @@ module OpenStax::Salesforce::Remote
 
     STATUS_APPROVED = "Approved"
     STATUS_ARCHIVED = "ArchivedPeriod"
-
   end
 end

data/lib/openstax/salesforce/spec_helpers.rb

@@ -1,30 +1,4 @@
-require 'openstax/salesforce/spec_helpers/salesforce_proxy'
-
 module OpenStax::Salesforce::SpecHelpers
-
-  def load_salesforce_user
-    clear_salesforce_user
-
-    config = OpenStax::Salesforce.configuration
-    sf_user = OpenStax::Salesforce::User.new
-
-    sf_user.name = "some name"
-    sf_user.uid = "whatever"
-    sf_user.oauth_token =   config.sandbox_oauth_token
-    sf_user.refresh_token = config.sandbox_refresh_token
-    sf_user.instance_url =  config.sandbox_instance_url.tap do |url|
-      if config.check_sandbox_instance_url && !url.match(/\/\/cs/)
-        raise "Salesforce sandbox instance URL (#{url}) does not have the expected form!"
-      end
-    end
-
-    sf_user.save!
-  end
-
-  def clear_salesforce_user
-    OpenStax::Salesforce::User.destroy_all
-  end
-
   # Uses knowledge of how `SalesforceProxy` methods create new SF records using its
   # `unique_token` to create the conditions you'd otherwise have to manually set
   # when calling `limit_salesforce_queries`.
@@ -81,4 +55,146 @@ module OpenStax::Salesforce::SpecHelpers
     end
   end
 
+  class SalesforceProxy
+    include OpenStax::Salesforce::Remote
+
+    def initialize
+      # For cassette consistency, to ensure specs always get new tokens
+      ActiveForce.clear_sfdc_client!
+    end
+
+    # Used to filter records to the scope of one spec
+    def reset_unique_token(token = SecureRandom.hex(10))
+      @unique_token = token
+    end
+
+    def clear_unique_token
+      @unique_token = nil
+    end
+
+    def new_contact(first_name: nil, last_name: nil, school_name: "JP University",
+                    email: nil, email_alt: nil, faculty_verified: nil, school_type: nil)
+      ensure_schools_exist([school_name])
+
+      Contact.new(
+        first_name: first_name || Faker::Name.first_name,
+        last_name: last_name!(last_name),
+        school_id: school_id(school_name),
+        email: email,
+        email_alt: email_alt,
+        faculty_verified: faculty_verified,
+        school_type: school_type
+      ).tap do |contact|
+        if !contact.save
+          raise "Could not save SF contact: #{contact.errors}"
+        end
+      end
+    end
+
+    def new_lead(email:, status: nil, last_name: nil, source: nil, school_name: "JP University")
+      Lead.new(
+        email: email,
+        status: status,
+        last_name: last_name!(last_name),
+        school: school_name,
+        source: source
+      ).tap do |lead|
+        if !lead.save
+          raise "Could not save SF lead: #{lead.errors}"
+        end
+      end
+    end
+
+    def new_campaign(name: SecureRandom.hex(8))
+      Campaign.new(
+        name: name
+      ).tap do |campaign|
+        if !campaign.save
+          raise "Could not save SF Campaign: #{campaign.errors}"
+        end
+      end
+    end
+
+    def new_campaign_member(contact_id:, campaign_id:)
+      CampaignMember.new(
+        contact_id: contact_id,
+        campaign_id: campaign_id
+      ).tap do |campaign_member|
+        if !campaign_member.save
+          raise "Could not save SF Campaign Member: #{campaign_member.errors}"
+        end
+      end
+    end
+
+    def last_name!(input)
+      "#{input || Faker::Name.last_name}#{@unique_token if @unique_token.present?}"
+    end
+
+    def ensure_books_exist(book_names)
+      @books = OpenStax::Salesforce::Remote::Book.where(name: book_names).to_a
+
+      (book_names - books.map(&:name)).each do |book_name|
+        OpenStax::Salesforce::Remote::Book.new(name: book_name).save!
+      end
+    end
+
+    def ensure_schools_exist(school_names)
+      @schools = OpenStax::Salesforce::Remote::School.where(name: school_names).to_a
+
+      (school_names - schools.map(&:name)).each do |school_name|
+        OpenStax::Salesforce::Remote::School.new(name: school_name).save!
+      end
+    end
+
+    def books
+      @books ||= OpenStax::Salesforce::Remote::Book.all
+    end
+
+    def book(name)
+      books.find { |bb| bb.name == name }
+    end
+
+    def book_id(name)
+      book(name).id
+    end
+
+    def schools
+      @schools ||= OpenStax::Salesforce::Remote::School.all
+    end
+
+    def school_id(name)
+      school(name).try(:id)
+    end
+
+    def school(name)
+      schools.find { |ss| ss.name == name }
+    end
+
+    def setup_cassette
+      VCR.configure do |config|
+        config.define_cassette_placeholder('<salesforce_instance_url>') do
+          'https://example.salesforce.com'
+        end
+        config.define_cassette_placeholder('<salesforce_instance_url_lower>') do
+          'https://example.salesforce.com'
+        end
+        authentication = ActiveForce.sfdc_client.authenticate!
+        config.define_cassette_placeholder('<salesforce_instance_url>') do
+          authentication.instance_url
+        end
+        config.define_cassette_placeholder('<salesforce_instance_url_lower>') do
+          authentication.instance_url.downcase
+        end
+        config.define_cassette_placeholder('<salesforce_id>') do
+          authentication.id
+        end
+        config.define_cassette_placeholder('<salesforce_access_token>') do
+          authentication.access_token
+        end
+        config.define_cassette_placeholder('<salesforce_signature>') do
+          authentication.signature
+        end
+      end
+    end
+  end
 end