openstax_salesforce 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66066f14c2a63bbba0e2e92314c1841447a8bb58
+  data.tar.gz: 0188ff2c949728a8c47f4305b14ea57bc4324f71
+SHA512:
+  metadata.gz: 31776fad63147b4f3d8931930679c5665c2141cd61b78e5b21a0d91403fdcb7df3207e8237c49594501fc6cb6b96cb1acbb60519f21e384f1fd888376c92d6b7
+  data.tar.gz: ef1ffb3e25b322aabf3fa2d3972baa9e5589f09c9f2721e888eb935bc3fca601c89d15c23b4b88f43a88338b52138d29aaacbcae23539b86ba77327b27523437

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 JP Slavinsky
+
+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,91 @@
+# OpenStax::Salesforce
+
+[![Gem Version](https://badge.fury.io/rb/openstax_salesforce.svg)](http://badge.fury.io/rb/fine_print)
+[![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.
+
+## Installation
+
+Add these 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:
+
+```sh
+$ bundle
+```
+
+Or install it yourself:
+
+```sh
+$ gem install openstax_salesforce
+```
+
+Then execute the following command to copy the necessary migration and the 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.
+
+## 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.
+
+## 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:
+
+```ruby
+require 'openstax/salesforce/spec_helper'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Create specs for your feature
+4. Ensure that all specs pass
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new pull request

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OpenStax::Salesforce'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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
+
+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')
+
+task :default => :spec

data/app/controllers/openstax/salesforce/application_controller.rb

@@ -0,0 +1,5 @@
+module OpenStax::Salesforce
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/openstax/salesforce/settings_controller.rb

@@ -0,0 +1,20 @@
+module OpenStax::Salesforce
+  class SettingsController < OpenStax::Salesforce::ApplicationController
+    layout OpenStax::Salesforce.configuration.layout
+
+    def show
+    end
+
+    def callback
+      OpenStax::Salesforce::User.save_from_omniauth!(env["omniauth.auth"])
+      redirect_to root_path
+    end
+
+    def destroy_user
+      OpenStax::Salesforce::User.destroy_all
+      ActiveForce.clear_sfdc_client! # since user is now gone, any client invalid
+      redirect_to root_path
+    end
+
+  end
+end

data/app/helpers/openstax/salesforce/application_helper.rb

@@ -0,0 +1,11 @@
+module OpenStax::Salesforce
+  module ApplicationHelper
+    def config
+      OpenStax::Salesforce.configuration
+    end
+
+    def page_heading(context, text)
+      config.page_heading_proc.call(context, text)
+    end
+  end
+end

data/app/models/openstax/salesforce/user.rb

@@ -0,0 +1,25 @@
+module OpenStax::Salesforce
+  class User < ActiveRecord::Base
+    validates :uid, presence: true
+    validates :oauth_token, presence: true
+    validates :refresh_token, presence: true
+    validates :instance_url, presence: true
+
+    after_save :ensure_only_one_record
+
+    def self.save_from_omniauth!(auth)
+      where(auth.slice(:uid).permit!).first_or_initialize.tap do |user|
+        user.uid = auth.uid
+        user.name = auth.info.name
+        user.oauth_token = auth.credentials.token
+        user.refresh_token = auth.credentials.refresh_token
+        user.instance_url = auth.credentials.instance_url
+        user.save!
+      end
+    end
+
+    def ensure_only_one_record
+      self.class.where{id != self.id}.destroy_all
+    end
+  end
+end

data/app/models/user.rb

@@ -0,0 +1,25 @@
+module OpenStax::Salesforce
+  class User < ActiveRecord::Base
+    validates :uid, presence: true
+    validates :oauth_token, presence: true
+    validates :refresh_token, presence: true
+    validates :instance_url, presence: true
+
+    after_save :ensure_only_one_record
+
+    def self.save_from_omniauth!(auth)
+      where(auth.slice(:uid).permit!).first_or_initialize.tap do |user|
+        user.uid = auth.uid
+        user.name = auth.info.name
+        user.oauth_token = auth.credentials.token
+        user.refresh_token = auth.credentials.refresh_token
+        user.instance_url = auth.credentials.instance_url
+        user.save!
+      end
+    end
+
+    def ensure_only_one_record
+      self.class.where{id != self.id}.destroy_all
+    end
+  end
+end

data/app/views/openstax/salesforce/settings/show.html.erb

@@ -0,0 +1,33 @@
+<div class="salesforce-settings">
+
+  <%= page_heading(self, "Salesforce Setup") %>
+
+  <p>When Accounts makes calls to Salesforce's API, it must do so on behalf of a
+    specific Salesforce user.  At any one time, Accounts has information for either
+    zero or one such user.  Use the link below to set the current user that Accounts
+    acts as when calling the Salesforce API.</p>
+
+  <% @user = OpenStax::Salesforce::User.first %>
+
+  <div style="margin: 30px 0px">
+    <p>
+    <% if @user.present? %>
+      The current Salesforce user is <b><%= @user.name || "[Unknown Name]" %></b>.
+    <% else %>
+      There <b>is no</b> Salesforce user currently set.
+    <% end %>
+    </p>
+  </div>
+
+  <%= link_to "Set Salesforce User",
+              "/auth/salesforce?redirect_uri=#{main_app.auth_salesforce_callback_url}",
+              id: "sign_in", class: 'btn btn-primary' %>
+
+  <%= link_to "Clear Salesforce User",
+              destroy_user_settings_path,
+              class: 'btn btn-danger pull-right',
+              method: :delete %>
+
+  <hr/>
+
+</div>

data/config/initializers/omniauth.rb

@@ -0,0 +1,8 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  unless OpenStax::Salesforce.configuration.skip_automatic_omniauth_setup
+    provider :salesforce,
+             OpenStax::Salesforce.configuration.salesforce_client_key,
+             OpenStax::Salesforce.configuration.salesforce_client_secret,
+             client_options: OpenStax::Salesforce.configuration.salesforce_client_options
+  end
+end

data/config/initializers/openstax_salesforce.rb

@@ -0,0 +1,48 @@
+# This initializer always runs before the engine is loaded, but it can
+# 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 a controller as self. Returns the current user.
+  config.current_user_proc = -> { nil }
+
+  # Proc called with a user as argument and a controller as self.
+  # 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.
+  # Note: Proc must account for nil users, if current_user_proc returns nil.
+  config.authenticate_admin_proc = ->(user) { 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'
+
+  # 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'
+  end
+
+  # Change this to true if you want to call the omniauth setup on your own
+  config.skip_automatic_omniauth_setup = false
+
+  # 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 }
+end
+
+

data/config/routes.rb

@@ -0,0 +1,11 @@
+OpenStax::Salesforce::Engine.routes.draw do
+  root to: 'settings#show'
+
+  resource :settings, only: [:show] do
+    collection do
+      delete :destroy_user
+    end
+  end
+
+
+end

data/db/migrate/0_install_openstax_salesforce.rb

@@ -0,0 +1,12 @@
+class InstallOpenStaxSalesforce < ActiveRecord::Migration
+  def change
+    create_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
+    end
+  end
+end

data/lib/openstax/salesforce/active_force.rb

@@ -0,0 +1,34 @@
+# 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
+    def sfdc_client
+      if !original_sfdc_client.is_a?(OpenStax::Salesforce::Client)
+        self.sfdc_client = OpenStax::Salesforce::Client.new
+      end
+      original_sfdc_client
+    end
+
+    def clear_sfdc_client!
+      self.sfdc_client = nil
+    end
+
+  end
+
+  class SObject
+    # Save that precious SF API call count!
+    def save_if_changed
+      save if changed?
+    end
+
+    # We sometimes mock `query` in specs, and it is helpful to have
+    # access to the original implementation
+    singleton_class.send(:alias_method, :original_query, :query)
+  end
+
+end

data/lib/openstax/salesforce/client.rb

@@ -0,0 +1,24 @@
+module OpenStax::Salesforce
+  class Client < ::Restforce::Data::Client
+
+    def initialize
+      user = User.first
+
+      raise(UserMissing, "The Salesforce client was requested but no user is available.") if user.nil?
+
+      client_key = OpenStax::Salesforce.configuration.salesforce_client_key
+      client_secret = OpenStax::Salesforce.configuration.salesforce_client_secret
+
+      raise(IllegalState, "The Salesforce key is missing") if client_key.nil?
+      raise(IllegalState, "The Salesforce secret is missing") if client_secret.nil?
+
+      super(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')
+    end
+
+  end
+end

data/lib/openstax/salesforce/engine.rb

@@ -0,0 +1,9 @@
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.acronym 'OpenStax'
+end
+
+module OpenStax::Salesforce
+  class Engine < ::Rails::Engine
+    isolate_namespace OpenStax::Salesforce
+  end
+end

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

@@ -0,0 +1,7 @@
+module OpenStax::Salesforce::Remote
+  class Book < ActiveForce::SObject
+    field :name,                      from: "Name"
+
+    self.table_name = 'Book__c'
+  end
+end

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

@@ -0,0 +1,18 @@
+module OpenStax::Salesforce::Remote
+  class Contact < ActiveForce::SObject
+    belongs_to :school, foreign_key: :school_id,
+                        model: OpenStax::Salesforce::Remote::School
+
+    field :name,                    from: "Name"
+    field :first_name,              from: "FirstName"
+    field :last_name,               from: "LastName"
+    field :email,                   from: "Email"
+    field :email_alt,               from: "Email_alt__c"
+    field :faculty_confirmed_date,  from: "Faculty_Confirmed_Date__c", as: :datetime
+    field :faculty_verified,        from: "Faculty_Verified__c"
+    field :last_modified_at,        from: "LastModifiedDate"
+    field :school_id,               from: "AccountId"
+
+    self.table_name = 'Contact'
+  end
+end

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

@@ -0,0 +1,22 @@
+module OpenStax::Salesforce::Remote
+  class Lead < ActiveForce::SObject
+    field :name,                from: "Name"
+    field :first_name,          from: "FirstName"
+    field :last_name,           from: "LastName"
+    field :salutation,          from: "Salutation"
+    field :subject,             from: "Subject__c"
+    field :school,              from: "Company"
+    field :phone,               from: "Phone"
+    field :website,             from: "Website"
+    field :status,              from: "Status"
+    field :email,               from: "Email"
+    field :source,              from: "LeadSource"
+    field :newsletter,          from: "Newsletter__c"
+    field :newsletter_opt_in,   from: "Newsletter_Opt_In__c"
+    field :adoption_status,     from: "Adoption_Status__c"
+    field :num_students,        from: "Number_of_Students__c"
+    field :os_accounts_id,      from: "OS_Accounts_ID__c"
+
+    self.table_name = 'Lead'
+  end
+end

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

@@ -0,0 +1,7 @@
+module OpenStax::Salesforce::Remote
+  class School < ActiveForce::SObject
+    field :name,                      from: "Name"
+
+    self.table_name = 'Account'
+  end
+end

data/lib/openstax/salesforce/spec_helpers/salesforce_proxy.rb

@@ -0,0 +1,99 @@
+module OpenStax::Salesforce::SpecHelpers
+  class SalesforceProxy
+
+    include OpenStax::Salesforce::Remote
+
+    def initialize
+    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)
+      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
+      ).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, school_name: "JP University")
+      Lead.new(
+        email: email,
+        status: status,
+        last_name: last_name!(last_name),
+        school: school_name
+      ).tap do |lead|
+        if !lead.save
+          raise "Could not save SF lead: #{lead.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)
+      book_names.each do |book_name|
+        if books.none?{|bb| bb.name == book_name}
+          book = Book.new(name: book_name)
+          book.save!
+          books.push(book)
+        end
+      end
+    end
+
+    def ensure_schools_exist(school_names)
+      school_names.compact.each do |school_name|
+        if schools.none?{|ss| ss.name == school_name}
+          school = School.new(name: school_name)
+          school.save!
+          schools.push(school)
+        end
+      end
+    end
+
+    def books
+      @books ||= Book.all
+    end
+
+    def book(name)
+      books.select{|bb| bb.name == name}.first
+    end
+
+    def book_id(name)
+      book(name).id
+    end
+
+    def schools
+      @schools ||= School.all
+    end
+
+    def school_id(name)
+      school(name).try(:id)
+    end
+
+    def school(name)
+      schools.select{|ss| ss.name == name}.first
+    end
+
+  end
+end

data/lib/openstax/salesforce/spec_helpers.rb

@@ -0,0 +1,58 @@
+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
+
+  def limit_salesforce_queries(remote_class, **conditions)
+    allow(remote_class).to receive(:query) do
+      like_conditions = {}
+      other_conditions = {}
+
+      conditions.each_pair do |key, value|
+        if value.is_a?(String) && value.include?("%")
+          like_conditions[key] = value
+        else
+          other_conditions[key] = value
+        end
+      end
+
+      like_queries = like_conditions.map do |key, value|
+        attribute = remote_class.mapping.mappings[key]
+        quoted_value = "'#{value.gsub(/\\/, '\&\&').gsub(/'/, "''")}'"
+        "#{attribute} LIKE #{quoted_value}"
+      end
+
+      result = remote_class.original_query
+
+      like_queries.each do |like_query|
+        result = result.where(like_query)
+      end
+
+      result = result.where(other_conditions) if other_conditions.any?
+      result
+    end
+  end
+
+end

data/lib/openstax/salesforce/user_missing.rb

@@ -0,0 +1,3 @@
+module OpenStax::Salesforce
+  class UserMissing < StandardError; end
+end

data/lib/openstax/salesforce/version.rb

@@ -0,0 +1,5 @@
+module OpenStax
+  module Salesforce
+    VERSION = "0.9.0"
+  end
+end