openstax_salesforce 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eb0facc55a7d6ccdad9f52f85623a0bfcf4235f5
-  data.tar.gz: e87e35a07e7f217b9ac3664777ea44a61ed90402
+SHA256:
+  metadata.gz: 74d422ed32aa0879b27422340bad963cd7ca7cf1a7ae551d33d4deb24877a819
+  data.tar.gz: 5e2c2d2ae2ee4cbb435f4392bd79068bef5154e9ad456a402f12a9b564ad1d38
 SHA512:
-  metadata.gz: 43a784f1ab17065088efe0478c27f2a02c6cf1b10d0d2a4aa8c12358aada2b51f805bad92ab75f62e5892cdf2b1df68f1e3c80d543c9de6d1875efcc5e068236
-  data.tar.gz: 760ed6b79aa13cba5ae18f4d2f723fb5e500b2c3a8a1faacad6e5a82da1ca972e65aade30b960284c336d49f004400c2775aab39ccc1c0cfa99de5d66d69da13
+  metadata.gz: 6a0becf88d28651d0bb0ba0239ce1c0584be4a4d7995a2804db9d2ec5a1e031c0c4d284cde749dc1f29b4840ae0b31f4c7ec887d380570833c128dc05a45a2bb
+  data.tar.gz: e15359158438e0fe020a51747cc9916469f1eb96e40e40aecb8880f839b53557816ad2265aee2b235d0e8168051214db6102717ef04ac213b69dc8cecdd00a35

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

@@ -0,0 +1,49 @@
+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"
+    field :contact_id,                from: "Contact__c"
+    field :course_code,               from: "Course_Code__c"
+    field :course_name,               from: "Course_Name__c"
+    field :course_start_date,         from: "Course_Start_Date__c", as: :date
+    field :created_at,                from: "E_Created_Date__c", as: :datetime
+    field :teacher_email,             from: "Email__c"
+    field :error,                     from: "Error__c"
+    field :estimated_enrollment,      from: "Estimated_Enrollment__c", as: :int
+    field :course_id,                 from: "External_ID__c"
+    field :course_uuid,               from: "External_UUID__c"
+    field :latest_adoption_decision,  from: "Latest_Adoption_Decision__c"
+    field :does_cost,                 from: "Paid_Course__c", as: :boolean
+    field :is_research,               from: "Research_Project__c", as: :boolean
+    field :num_periods,               from: "Sections__c", as: :int
+    field :status,                    from: "Status__c", as: :picklist
+    field :num_students_comped,       from: "Students_Comped__c", as: :int
+    field :num_students_dropped,      from: "Students_Dropped__c", as: :int
+    field :num_students_paid,         from: "Students_Paid__c", as: :int
+    field :num_students_refunded,     from: "Students_Refunded__c", as: :int
+    field :num_students,              from: "Students_Using__c", as: :int
+    field :num_students_with_work,    from: "Students_With_Work__c", as: :int
+    field :period_uuid,               from: "Period_UUID__c"
+    field :term,                      from: "Term__c"
+    field :is_pilot,                  from: "Tutor_Pilot__c", as: :boolean
+
+    self.table_name = 'Tutor_Course__c'
+
+    def reset_stats
+      self.num_periods = 0
+      self.num_students = 0
+      self.num_students_comped = 0
+      self.num_students_dropped = 0
+      self.num_students_paid = 0
+      self.num_students_refunded = 0
+      self.num_students_with_work = 0
+      self.num_teachers = 0
+    end
+
+    STATUS_APPROVED = "Approved"
+    STATUS_ARCHIVED = "ArchivedPeriod"
+
+  end
+end

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

@@ -16,8 +16,7 @@ module OpenStax::Salesforce::SpecHelpers
     end
 
     def new_contact(first_name: nil, last_name: nil, school_name: "JP University",
-                    email: nil, email_alt: nil,
-                    faculty_verified: nil)
+                    email: nil, email_alt: nil, faculty_verified: nil, school_type: nil)
       ensure_schools_exist([school_name])
 
       Contact.new(
@@ -26,7 +25,8 @@ module OpenStax::Salesforce::SpecHelpers
         school_id: school_id(school_name),
         email: email,
         email_alt: email_alt,
-        faculty_verified: faculty_verified
+        faculty_verified: faculty_verified,
+        school_type: school_type
       ).tap do |contact|
         if !contact.save
           raise "Could not save SF contact: #{contact.errors}"
@@ -48,19 +48,6 @@ module OpenStax::Salesforce::SpecHelpers
       end
     end
 
-    def new_tutor_onboarding_a(first_teacher_contact_id: nil, pardot_reported_contact_id: nil)
-      raise "Not enough arguments given" if first_teacher_contact_id.nil? && pardot_reported_contact_id.nil?
-
-      TutorOnboardingA.new(
-        first_teacher_contact_id: first_teacher_contact_id,
-        pardot_reported_contact_id: pardot_reported_contact_id
-      ).tap do |toa|
-        if !toa.save
-          raise "Could not save SF TOA: #{toa.errors}"
-        end
-      end
-    end
-
     def new_campaign(name: SecureRandom.hex(8))
       Campaign.new(
         name: name

data/lib/openstax/salesforce/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Salesforce
-    VERSION = "1.3.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/openstax_salesforce.rb

@@ -12,12 +12,9 @@ require "openstax/salesforce/remote/term_year"
 require "openstax/salesforce/remote/book"
 require "openstax/salesforce/remote/school"
 require "openstax/salesforce/remote/opportunity"
-require "openstax/salesforce/remote/individual_adoption"
-require "openstax/salesforce/remote/class_size"
-require "openstax/salesforce/remote/os_ancillary"
+require "openstax/salesforce/remote/tutor_course_period"
 require "openstax/salesforce/remote/contact"
 require "openstax/salesforce/remote/lead"
-require "openstax/salesforce/remote/tutor_onboarding_a"
 require "openstax/salesforce/remote/campaign"
 require "openstax/salesforce/remote/campaign_member"
 

data/spec/openstax/salesforce/remote/tutor_course_period_spec.rb

@@ -0,0 +1,30 @@
+require 'rails_helper'
+
+RSpec.describe OpenStax::Salesforce::Remote::TutorCoursePeriod do
+
+  subject { described_class.new }
+
+  it 'can reset stats' do
+    subject.num_periods = 1
+    subject.num_students = 8
+    subject.num_students_comped = 7
+    subject.num_students_dropped = 6
+    subject.num_students_paid = 5
+    subject.num_students_refunded = 4
+    subject.num_students_with_work = 3
+    subject.num_teachers = 2
+
+    subject.reset_stats
+
+    expect(subject.num_periods).to eq 0
+    expect(subject.num_students).to eq 0
+    expect(subject.num_students_comped).to eq 0
+    expect(subject.num_students_dropped).to eq 0
+    expect(subject.num_students_paid).to eq 0
+    expect(subject.num_students_refunded).to eq 0
+    expect(subject.num_students_paid).to eq 0
+    expect(subject.num_students_with_work).to eq 0
+    expect(subject.num_teachers).to eq 0
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_salesforce
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -189,15 +189,12 @@ files:
 - lib/openstax/salesforce/remote/book.rb
 - lib/openstax/salesforce/remote/campaign.rb
 - lib/openstax/salesforce/remote/campaign_member.rb
-- lib/openstax/salesforce/remote/class_size.rb
 - lib/openstax/salesforce/remote/contact.rb
-- lib/openstax/salesforce/remote/individual_adoption.rb
 - lib/openstax/salesforce/remote/lead.rb
 - lib/openstax/salesforce/remote/opportunity.rb
-- lib/openstax/salesforce/remote/os_ancillary.rb
 - lib/openstax/salesforce/remote/school.rb
 - lib/openstax/salesforce/remote/term_year.rb
-- lib/openstax/salesforce/remote/tutor_onboarding_a.rb
+- lib/openstax/salesforce/remote/tutor_course_period.rb
 - lib/openstax/salesforce/spec_helpers.rb
 - lib/openstax/salesforce/spec_helpers/salesforce_proxy.rb
 - lib/openstax/salesforce/user_missing.rb
@@ -246,8 +243,8 @@ files:
 - spec/openstax/salesforce/controllers/application_controller_spec.rb
 - spec/openstax/salesforce/controllers/settings_controller_spec.rb
 - spec/openstax/salesforce/remote/opportunity_spec.rb
-- spec/openstax/salesforce/remote/os_ancillary_spec.rb
 - spec/openstax/salesforce/remote/term_year_spec.rb
+- spec/openstax/salesforce/remote/tutor_course_period_spec.rb
 - spec/openstax/salesforce/spec_helpers_spec.rb
 - spec/rails_helper.rb
 - spec/routing_spec.rb
@@ -272,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Interface gem for accessing OpenStax's Salesforce instance
@@ -319,9 +316,9 @@ test_files:
 - spec/openstax/salesforce/spec_helpers_spec.rb
 - spec/openstax/salesforce/controllers/settings_controller_spec.rb
 - spec/openstax/salesforce/controllers/application_controller_spec.rb
-- spec/openstax/salesforce/remote/os_ancillary_spec.rb
 - spec/openstax/salesforce/remote/term_year_spec.rb
 - spec/openstax/salesforce/remote/opportunity_spec.rb
+- spec/openstax/salesforce/remote/tutor_course_period_spec.rb
 - spec/factories/user.rb
 - spec/routing_spec.rb
 - spec/rails_helper.rb

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

@@ -1,57 +0,0 @@
-module OpenStax::Salesforce::Remote
-  class ClassSize < ActiveForce::SObject
-
-    field :concept_coach_approved,    from: "Concept_Coach_Approved__c", as: :boolean
-    field :course_name,               from: "Course_Name__c"
-    field :course_id,                 from: "Tutor_ID__c"
-    field :created_at,                from: "Tutor_Created_Date__c", as: :datetime
-    field :num_students,              from: "Student_using_Tutor__c", as: :int
-    field :num_teachers,              from: "Active_Teachers__c", as: :int
-    field :num_sections,              from: "Number_of_Sections__c", as: :int
-    field :teacher_join_url,          from: "Teacher_Join_URL__c"
-    field :error,                     from: "Tutor_Error__c"
-    field :book_name,                 from: "Book_Name__c"
-    field :school,                    from: "School__c"
-    field :term_year,                 from: "TermYear__c"
-    field :opportunity_id,            from: 'Opportunity__c'
-    field :os_ancillary_id,           from: "OSA__c"
-
-    belongs_to :opportunity, model: OpenStax::Salesforce::Remote::Opportunity
-
-    self.table_name = 'Class_Size__c'
-
-    def term_year_object
-      @term_year_object ||= OpenStax::Salesforce::Remote::TermYear.from_string(self.term_year)
-    end
-
-    def reset_stats
-      self.num_students = 0
-      self.num_teachers = 0
-      self.num_sections = 0
-    end
-
-    # Methods to make this legacy SF object compatible with current OsAncillary interface.
-    # All ClassSize records were used for college CC courses.
-
-    def is_tutor?
-      false
-    end
-
-    def is_concept_coach?
-      true
-    end
-
-    def valid_product?
-      true
-    end
-
-    def is_college?
-      true
-    end
-
-    def product
-      "Concept Coach"
-    end
-
-  end
-end

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

@@ -1,31 +0,0 @@
-module OpenStax::Salesforce::Remote
-  class IndividualAdoption < ActiveForce::SObject
-
-    field :book_name,                    from: "Book_Text__c"
-    field :contact_id,                   from: "Contact__c"
-    field :book_id,                      from: "Book__c"
-    field :school_id,                    from: "Account__c"
-    field :school_year,                  from: "School_Year__c"
-    field :fall_start_date,              from: "Fall_Start_Date__c"
-    field :summer_start_date,            from: "Summer_Start_Date__c"
-    field :winter_start_date,            from: "Winter_Start_Date__c"
-    field :spring_start_date,            from: "Spring_Start_Date__c"
-    field :adoption_level,               from: "Adoption_Level__c"
-    field :description,                  from: "Description__c"
-    field :source,                       from: "Source__c"
-
-    # Deprecated
-    field :term_year,                    from: "TermYear__c"
-    field :class_start_date,             from: "Class_Start_Date__c"
-
-    belongs_to :school, model: OpenStax::Salesforce::Remote::School
-    belongs_to :book, model: OpenStax::Salesforce::Remote::Book
-
-    self.table_name = 'Individual_Adoption__c'
-
-    def term_year_object
-      @term_year_object ||= OpenStax::Salesforce::Remote::TermYear.from_string(term_year)
-    end
-
-  end
-end

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

@@ -1,103 +0,0 @@
-module OpenStax::Salesforce::Remote
-  class OsAncillary < ActiveForce::SObject
-
-    field :status,                    from: "Status__c", as: :picklist
-    field :product,                   from: "Product__c", as: :picklist
-    field :account_type,              from: "Account_Type__c"
-    field :book_name,                 from: "Book_Name__c"
-    field :course_start_date,         from: "Course_Start_Date__c", as: :date
-    field :course_name,               from: "Course_Name__c"
-    field :course_code,               from: "Course_Code__c"
-    field :course_id,                 from: "External_ID__c"
-    field :course_uuid,               from: "External_UUID__c"
-    field :created_at,                from: "E_Created_Date__c", as: :datetime
-    field :error,                     from: "Error__c"
-    field :general_access_url,        from: "General_Access_URL__c"
-    field :teacher_join_url,          from: "Teacher_Join_URL__c"
-    field :school,                    from: "School_Name__c"
-    field :num_teachers,              from: "Active_Teachers__c", as: :int
-    field :num_sections,              from: "Sections__c", as: :int
-    field :num_students,              from: "Students_Using__c", as: :int
-    field :num_students_paid,         from: "Students_Paid__c", as: :int
-    field :num_students_comped,       from: "Students_Comped__c", as: :int
-    field :num_students_refunded,     from: "Students_Refunded__c", as: :int
-    field :num_students_dropped,      from: "Students_Dropped__c", as: :int
-    field :num_students_with_work,    from: "Students_With_Work__c", as: :int
-    field :term_year,                 from: "TermYear__c"
-    field :term,                      from: "Term__c"
-    field :base_year,                 from: "Manual_Base_Year__c", as: :int
-    field :estimated_enrollment,      from: "Estimated_Enrollment__c", as: :int
-    field :does_cost,                 from: "Paid_Course__c", as: :boolean
-    field :opportunity_id,            from: 'Opportunity__c'
-    field :individual_adoption_id,    from: "Individual_Adoption__c"
-    field :contact_id,                from: "Contact__c"
-    field :campaign_member_id,        from: "Campaign_Member_ID__c"
-    field :latest_adoption_decision,  from: "latest_adoption_decision__c"
-
-    belongs_to :opportunity, model: OpenStax::Salesforce::Remote::Opportunity
-
-    self.table_name = 'OS_Ancillary__c'
-
-    def reset_stats
-      self.num_students = 0
-      self.num_students_paid = 0
-      self.num_students_comped = 0
-      self.num_students_refunded = 0
-      self.num_students_dropped = 0
-      self.num_students_with_work = 0
-      self.num_teachers = 0
-      self.num_sections = 0
-    end
-
-    def is_concept_coach?
-      "Concept Coach" == product
-    end
-
-    def is_tutor?
-      "Tutor" == product
-    end
-
-    def valid_product?
-      ["Tutor", "Concept Coach"].include?(product)
-    end
-
-    def term_year_object
-      @term_year_object ||= OpenStax::Salesforce::Remote::TermYear.from_string(self.term_year)
-    end
-
-    def is_college?
-      # Seems like college account types are more likely to be added to
-      # more than high school types, so match non college types and negate
-      !NON_COLLEGE_ACCOUNT_TYPES.include?(account_type)
-    end
-
-    # TODO warn somewhere if come across unknown account type
-    def known_account_type?
-      ACCOUNT_TYPES.include(account_type)
-    end
-
-    NON_COLLEGE_ACCOUNT_TYPES = [
-      "High School",
-      "Elementary School",
-      "Middle/Junior High School",
-      "K-12 School"
-    ]
-
-    # Unused, here for posterity
-    COLLEGE_ACCOUNT_TYPES = [
-      "College/University (4)",
-      "Technical/Community College (2)",
-      "Career School/For-Profit (2)",
-      "For-Profit Tutoring",
-    ]
-
-    ACCOUNT_TYPES = [
-      COLLEGE_ACCOUNT_TYPES,
-      NON_COLLEGE_ACCOUNT_TYPES,
-      "Other"
-    ].flatten
-
-    STATUS_APPROVED = "Approved"
-
-  end
-end

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

@@ -1,33 +0,0 @@
-module OpenStax::Salesforce::Remote
-  class TutorOnboardingA < ActiveForce::SObject
-
-    field :accounts_uuid,                                     from: "accounts_uuid__c"
-
-    field :contact_id,                                        from: "Contact__c"
-
-    field :pardot_reported_contact_id,                        from: "pardot_reported_contact_id__c"
-    field :pardot_reported_piaid,                             from: "pardot_reported_piaid__c"
-    field :pardot_reported_picid,                             from: "pardot_reported_picid__c"
-
-    field :first_teacher_contact_id,                          from: "first_teacher_contact_id__c"
-
-    field :arrived_marketing_page_from_pardot_at,             from: "arrived_marketing_page_from_pardot_at__c",    as: :datetime
-    field :days_since_arrived_marketing_page_from_pardot,     from: "days_since_arrived_marketing_page_from_p__c", as: :double
-    field :arrived_marketing_page_not_from_pardot_at,         from: "arrived_marketing_page_not_from_pardot_a__c", as: :datetime
-    field :days_since_arrived_marketing_page_not_from_pardot, from: "days_since_arrived_marketing_page_from_p__c", as: :double
-    field :preview_created_at,                                from: "preview_created_at__c",                       as: :datetime
-    field :real_course_created_at,                            from: "real_course_created_at__c",                   as: :datetime
-    field :like_preview_ask_later_count,                      from: "like_preview_ask_later_count__c",             as: :int
-    field :like_preview_yes_at,                               from: "like_preview_yes_at__c",                      as: :datetime
-    field :days_since_like_preview_yes,                       from: "days_since_like_preview_yes__c",              as: :double
-    field :latest_adoption_decision,                          from: "latest_adoption_decision__c",                 as: :picklist
-    field :latest_adoption_decision_at,                       from: "latest_adoption_decision_at__c",              as: :datetime
-
-    belongs_to :contact, model: OpenStax::Salesforce::Remote::Contact
-    belongs_to :first_teacher_contact, model: OpenStax::Salesforce::Remote::Contact
-    belongs_to :pardot_reported_contact, model: OpenStax::Salesforce::Remote::Contact
-
-    self.table_name = 'TutorOnboardingA__c'
-
-  end
-end

data/spec/openstax/salesforce/remote/os_ancillary_spec.rb

@@ -1,35 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe OpenStax::Salesforce::Remote::OsAncillary do
-
-  context 'when product is Concept Coach' do
-    subject { described_class.new(product: "Concept Coach") }
-
-    it { is_expected.to be_is_concept_coach }
-    it { is_expected.not_to be_is_tutor }
-    it { is_expected.to be_valid_product }
-  end
-
-  context 'when product is Tutor' do
-    subject { described_class.new(product: "Tutor") }
-
-    it { is_expected.not_to be_is_concept_coach }
-    it { is_expected.to be_is_tutor }
-    it { is_expected.to be_valid_product }
-  end
-
-  context 'when product is nil' do
-    subject { described_class.new }
-
-    it { is_expected.not_to be_is_concept_coach }
-    it { is_expected.not_to be_is_tutor }
-    it { is_expected.not_to be_valid_product }
-  end
-
-  it 'knows which account types are for college' do
-    described_class::COLLEGE_ACCOUNT_TYPES.each do |college_type|
-      expect(described_class.new(account_type: college_type)).to be_is_college
-    end
-  end
-
-end