RubyGems - northpass - Versions diffs - 0.0.2 - Mend

northpass 0.0.2

Files changed (65) hide show

checksums.yaml +7 -0
data/.gitignore +20 -0
data/.pairs +16 -0
data/.rspec +2 -0
data/Gemfile +6 -0
data/Gemfile.ocra +7 -0
data/LICENSE.txt +22 -0
data/README.md +100 -0
data/Rakefile +36 -0
data/bin/sk +10 -0
data/bin/sk_gui +8 -0
data/circle.yml +8 -0
data/config/ca-bundle.crt +3894 -0
data/config/color_scheme.css.erb +91 -0
data/config/fixtures.yml +255 -0
data/config/learning.html.erb +43 -0
data/config/learning_color_scheme.css.erb +70 -0
data/config/locale.yml +110 -0
data/config/school_website.html.erb +37 -0
data/lib/schoolkeep.rb +16 -0
data/lib/schoolkeep/cli.rb +135 -0
data/lib/schoolkeep/client.rb +54 -0
data/lib/schoolkeep/fixture.rb +130 -0
data/lib/schoolkeep/fixture/stubs.rb +106 -0
data/lib/schoolkeep/gui_client.rb +99 -0
data/lib/schoolkeep/scribble.rb +480 -0
data/lib/schoolkeep/scribble/methods/app.rb +17 -0
data/lib/schoolkeep/scribble/methods/collection_each.rb +3 -0
data/lib/schoolkeep/scribble/methods/display_search_form.rb +28 -0
data/lib/schoolkeep/scribble/methods/filter_parameter_value.rb +11 -0
data/lib/schoolkeep/scribble/methods/hide_search_box.rb +17 -0
data/lib/schoolkeep/scribble/methods/l.rb +13 -0
data/lib/schoolkeep/scribble/methods/limit.rb +11 -0
data/lib/schoolkeep/scribble/methods/no_filter_selected_class.rb +19 -0
data/lib/schoolkeep/scribble/methods/pluralize.rb +32 -0
data/lib/schoolkeep/scribble/methods/query_parameter_value.rb +11 -0
data/lib/schoolkeep/scribble/methods/script.rb +45 -0
data/lib/schoolkeep/scribble/methods/t.rb +25 -0
data/lib/schoolkeep/server.rb +132 -0
data/lib/schoolkeep/template.rb +67 -0
data/lib/schoolkeep/template_names.rb +24 -0
data/lib/schoolkeep/version.rb +3 -0
data/lib/schoolkeep/views/asset_cache.rb +34 -0
data/lib/schoolkeep/views/color_scheme.rb +19 -0
data/lib/schoolkeep/views/layout.rb +72 -0
data/media/schoolkeep.ico +0 -0
data/media/sk-144.gif +0 -0
data/media/sk-16.gif +0 -0
data/media/sk-57.gif +0 -0
data/media/sk-72.gif +0 -0
data/schoolkeep.gemspec +28 -0
data/spec/cli_spec.rb +70 -0
data/spec/features/cli_spec.rb +51 -0
data/spec/features/client_spec.rb +48 -0
data/spec/fixture_spec.rb +68 -0
data/spec/methods/filter_parameter_value_spec.rb +28 -0
data/spec/methods/pluralize_spec.rb +41 -0
data/spec/methods/query_parameter_value_spec.rb +26 -0
data/spec/methods/script_spec.rb +52 -0
data/spec/methods/t_spec.rb +33 -0
data/spec/server_spec.rb +81 -0
data/spec/spec_helper.rb +48 -0
data/spec/views/asset_cache_spec.rb +24 -0
data/spec/views/color_scheme_spec.rb +15 -0
metadata +223 -0

@@ -0,0 +1,110 @@
+en:
+  custom_templates:
+    _footer:
+      connect: Connect
+      contact: Contact
+      email: Email
+      need_help: Need help?
+      overview: Overview
+      powered_by_html: This school is powered by <a href="https://northpass.com">SchoolKeep</a>
+    _header:
+      all_toolkits: All toolkits
+      cancel: Cancel
+      courses: All Courses
+      home: Home
+      log_in: Log In
+      log_out: Log Out
+      my_content:
+        all: All
+        course: My Courses
+        filter_by_category: Filter by category
+        learning_experience: My Learning Experiences
+        module: My Modules
+        resource: My Resources
+        toolkit: My Toolkits
+        workshop: My Workshops
+      my_courses: My Courses
+      my_profile: My Profile
+      results:
+        one: result
+        many: results
+      search_placeholder: Search by keyword
+      search_title: A search requires a min. 3 characters
+    course_cover:
+      scheduled_info: Will be available on
+      exit: Exit
+    course_details:
+      buy_course: Buy Course
+      buy:
+        course: Buy Course
+        learning_experience: Buy Learning Experience
+        module: Buy Module
+        resource: Buy Resource
+        toolkit: Buy Toolkit
+        workshop: Buy Workshop
+      coupon_apply_label: Apply coupon to course
+      coupon_submit: Apply
+      enroll: Enroll
+      go_to:
+        course: Go to Course
+        learning_experience: Go to Learning Experience
+        module: Go to Module
+        resource: Go to Resource
+        toolkit: Go to Toolkit
+        workshop: Go to Workshop
+      # DEPRECATE go_to_course on the new school website templates
+      go_to_course: Go to Course
+      instructor:
+        one: Instructor
+        many: Instructors
+      instructor_bio_title:
+        one: About the Instructor
+        many: About the Instructors
+      start: Start Course
+      tabs:
+        # DEPRECATE about on the new templates
+        about: About the Course
+        about_label:
+          course: About the Course
+          learning_experience: About the Learning Experience
+          module: About the Module
+          resource: About the Resource
+          toolkit: About the Toolkit
+          workshop: About the Workshop
+        # DEPRECATE syllabus on the new templates
+        syllabus: Course Syllabus
+        outline_label:
+          course: Course Syllabus
+          learning_experience: Learning Experience Syllabus
+          module: Module Syllabus
+          resource: Resource Syllabus
+          toolkit: Toolkit Syllabus
+          workshop: Workshop Syllabus
+    course_index:
+      quick_start: Start
+      # DEPRECATE view_course on the new templates
+      view_course: View Course
+      view:
+        course: View Course
+        learning_experience: View Learning Experience
+        module: View Module
+        resource: View Resource
+        toolkit: View Toolkit
+        workshop: View Workshop
+    homepage:
+      discover_catalog: Discover Catalog
+      quick_start: Start
+      view_course: View Course
+    my_content:
+      all: All
+      filter_by_category: Filter by category
+    not_found:
+      headline: Whoops, sorry about that.
+      home: Back to home
+      subheadline: It looks like the page you're looking for no longer exists. Please check the URL and notify us of any inconsistencies.
+      title: Page not found
+    server_error:
+      title: Sorry, something went wrong
+      headline: Whoops, sorry about that.
+      subheadline: An error occurred in the application and this page could not be displayed. Our team has been notified. Sorry for the inconvenience.
+      home: Back to home

data/config/school_website.html.erb ADDED

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title><%= @school.name %></title>
+    <% if @school.favicon_url.nil? || @school.favicon_url == ""   %>
+      <link href="<%= asset_url("/assets/sw-favicon.ico") %>" rel="shortcut icon" type="image/vnd.microsoft.icon" />
+    <% else %>
+      <link href="<%= @school.favicon_url %>" rel="shortcut icon" type="image/vnd.microsoft.icon" />
+    <% end %>
+    <%= render_skt "_head" %>
+    <script src="<%= asset_url("/assets/external_apis.js") %>"></script>
+    <script src="<%= asset_url("/assets/apis/apis.js") %>"></script>
+  </head>
+  <body class="<%= body_classes %>">
+    <%= render_skt "_header", variables: { display_search_form: @display_search_form } %>
+    <div class="main-content">
+      <%= body %>
+    </div>
+    <%= render_skt "_footer" %>
+    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
+    <script src="<%= asset_url("/assets/school_website/application.js") %>"></script>
+    <script type="text/javascript">
+        // Fixes a bug where font's don't load on Chrome
+      // https://github.com/SchoolKeep/schoolkeep/pull/511
+      $(function() { $("body").hide().show(); });
+    </script>
+  </body>
+</html>

data/lib/schoolkeep.rb ADDED

@@ -0,0 +1,16 @@
+require "schoolkeep/version"
+require "schoolkeep/template_names"
+module Schoolkeep
+  GEM_ROOT = File.expand_path("../../", __FILE__)
+  API_URL = "https://api.northpass.com"
+  ASSET_HOST = "https://app.northpass.com"
+  class << self
+    attr_writer :api_url
+    def api_url
+      @api_url ||= ENV["SK_API_URL"] || API_URL
+    end
+  end
+end

data/lib/schoolkeep/cli.rb ADDED

@@ -0,0 +1,135 @@
+require "thor"
+require "schoolkeep/client"
+module Schoolkeep
+  class CLI < Thor
+    desc "upload [TEMPLATE_PATH]", "upload a specific template"
+    option :dir, desc: "specify location of templates"
+    option :engine, desc: "specify what handlienegner: sktl or liquid", default: "sktl"
+    option :quiet, type: :boolean, default: false, desc: "silence all output"
+    option :all, type: :boolean, default: false, desc: "upload all templates"
+    def upload(path = nil)
+      unless ENV["SK_API_KEY"]
+        abort set_color("Set the env variable SK_API_KEY in order to upload files", :red)
+      end
+      unless %w(sktl liquid).include?(options[:engine])
+        abort set_color("Invalid engine flag. Allowed values: sktl, liquid", :red)
+      end
+      client = Client.new(ENV["SK_API_KEY"])
+      engine = options[:engine]
+      if options[:all] || options[:dir]
+        templates = Dir.glob(File.join(options[:dir] || "templates", "*.#{engine}"))
+      elsif path
+        templates = Dir.glob(path)
+      else
+        abort set_color("missing template path as argument", :red)
+      end
+      if templates.count == 0
+        abort set_color("No sktl templates found, no files will be uploaded", :yellow)
+      end
+      template_names = templates.map { |t| File.basename(t, ".#{engine}") }
+      invalid_templates = template_names - TEMPLATE_NAMES
+      if invalid_templates.size > 0
+        abort set_color("invalid templates: #{invalid_templates.join(", ")}", :yellow)
+      end
+      templates.each do |template_path|
+        name = File.basename(template_path, ".#{engine}")
+        response = client.upload(name, template_path, engine)
+        if response.success?
+          say("uploaded #{name}", :green) unless options[:quiet]
+        else
+          abort set_color("upload failed: Server responded with #{response.status} #{response.body}", :red)
+        end
+      end
+    end
+    desc "reset [CUSTOM_TEMPLATE]", "reset specified custom_template"
+    option :all, type: :boolean, default: false, desc: "reset all templates"
+    option :quiet, type: :boolean, default: false, desc: "silence all output"
+    def reset(template_path = nil)
+      unless ENV["SK_API_KEY"]
+        abort set_color("Set the env variable SK_API_KEY in order to upload files", :red)
+      end
+      client = Client.new(ENV["SK_API_KEY"])
+      if options[:all]
+        template_names = TEMPLATE_NAMES
+      else
+        template_names = [File.basename(template_path, ".sktl")]
+      end
+      invalid_templates = template_names - TEMPLATE_NAMES
+      if invalid_templates.size > 0
+        abort set_color("invalid template names: #{invalid_templates.join(", ")}", :yellow)
+      end
+      template_names.each do |name|
+        client.delete(name)
+        say("reset #{name}", :green) unless options[:quiet]
+      end
+    end
+    desc "server", "serve local templates"
+    option :dir, type: :string, default: "."
+    option :port, type: :numeric, default: 4000
+    option :quiet, type: :boolean, default: false
+    option :asset_host, type: :string, default: ASSET_HOST
+    def server
+      require "schoolkeep/server"
+      server = Server.new(
+        dir: options[:dir],
+        port: options[:port],
+        quiet: options[:quiet],
+        asset_host: options[:asset_host]
+      )
+      trap "INT" do server.shutdown end
+      server.start
+    end
+    desc "generate-fixtures", "create fixture file"
+    option :dir, type: :string, default: "."
+    def generate_fixtures
+      require "schoolkeep/fixture"
+      FileUtils.mkdir_p(File.join(options[:dir], "config"))
+      fixture_path = File.join(options[:dir], "/config/fixtures.yml")
+      if File.exists?(fixture_path)
+        unless yes? set_color("#{fixture_path} already exists, are you sure you want to overwrite? [y/n]", :yellow)
+          abort set_color("aborting fixture generation", :red)
+        end
+      end
+      FileUtils.copy_file(Fixture::GEM_FIXTURE_PATH, fixture_path)
+      say "#{fixture_path} has been generated", :green
+    end
+    desc "download-fixtures", "download your fixtures"
+    option :dir, type: :string, default: "."
+    def download_fixtures
+      unless ENV["SK_API_KEY"]
+        abort set_color("Set the env variable SK_API_KEY in order to download the fixtures", :red)
+      end
+      client = Client.new(ENV["SK_API_KEY"])
+      response = client.get_fixtures
+      if response.success?
+        FileUtils.mkdir_p(File.join(options[:dir], "config"))
+        File.write(File.join(options[:dir], "config/fixtures.yml"), response.body)
+        true
+      else
+        abort set_color("download failed: Server responded with #{response.status} #{response.body}", :red)
+      end
+    end
+    desc "gui", "launch the gui"
+    def gui
+      require "schoolkeep/gui_client"
+      Schoolkeep::GuiClient.new
+    end
+  end
+end

data/lib/schoolkeep/client.rb ADDED

@@ -0,0 +1,54 @@
+require "schoolkeep"
+require "faraday"
+module Schoolkeep
+  class Client
+    attr_reader :api_key
+    class InvalidTemplateName < StandardError; end
+    def initialize(api_key)
+      @api_key = api_key
+    end
+    def upload(name, path, engine)
+      unless TEMPLATE_NAMES.include? name
+        raise InvalidTemplateName.new("#{name} is an invalid template")
+      end
+      connection.post "/v1/custom_templates.json", {
+        custom_template: {
+          name: name,
+          body: Faraday::UploadIO.new(path, 'text/plain; charset=utf-8'),
+          engine: engine
+        }
+      }
+    end
+    def delete(name)
+      unless TEMPLATE_NAMES.include? name
+        raise InvalidTemplateName.new("#{name} is an invalid template")
+      end
+      connection.delete "/v1/custom_templates.json", {
+        id: name
+      }
+    end
+    def get_fixtures
+      connection.get "/v1/fixtures.yaml"
+    end
+    private
+    def connection
+      @conenction ||= Faraday.new(
+        url: Schoolkeep.api_url,
+        ssl: { ca_file: File.join(GEM_ROOT, "config/ca-bundle.crt") }
+      ) do |faraday|
+        faraday.headers["X-Api-Key"] = api_key
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/schoolkeep/fixture.rb ADDED

@@ -0,0 +1,130 @@
+require "schoolkeep"
+require "yaml"
+require "schoolkeep/fixture/stubs"
+module Schoolkeep
+  class Fixture
+    MAPPING = {
+      activities: LearnerSyllabuses::Activity,
+      apps: OpenStruct,
+      color_palette: ColorScheme,
+      commerce: BaseApp,
+      course: SchoolWebsite::CourseDecorator,
+      course_catalog: SchoolWebsite::CourseCatalogDecorator,
+      courses: SchoolWebsite::CourseDecorator,
+      current_learner: Learner,
+      current_person: Person,
+      current_school: School,
+      current_student: Learner,
+      custom_page: CustomPage,
+      filterable_categories: CategoryDecorator,
+      footer_navigations: WebsiteNavigation,
+      header_navigations: WebsiteNavigation,
+      homepage: Homepage,
+      instructors: Partnerships::Educator,
+      learner_syllabus: LearnerSyllabuses::Syllabus,
+      multiple_languages: BaseApp,
+      my_content: SchoolWebsite::MyContentDecorator,
+      params: ActionController::Parameters,
+      preview_banner: String,
+      published_featured_courses: SchoolWebsite::CourseDecorator,
+      published_sections: Section,
+      routes: Schools::Routes,
+      search_result: Search::CatalogResult,
+      sections: LearnerSyllabuses::Section,
+      social_media_links: SocialMediaLink,
+      syllabus_activities: LearnerSyllabuses::Activity,
+      website_footer: WebsiteFooter
+    }
+    KEY_MAPPING = {
+      syllabus_activities: :activities
+    }
+    GEM_FIXTURE_PATH = File.join(GEM_ROOT, "config/fixtures.yml")
+    attr_accessor :fixture_path
+    def initialize(fixture_path)
+      @fixture_path = fixture_path
+    end
+    def for(name, overrides: {})
+      fixtures = uncasted_globals.merge(gem_fixtures["templates"][name] || {})
+      if dev_fixtures["templates"]
+        fixtures.merge!(dev_fixtures["templates"][name] || {})
+      end
+      fixtures.merge!(overrides)
+      cast(fixtures).merge(template_name: File.basename(name, ".html.sktl"))
+    end
+    def globals
+      cast(uncasted_globals)
+    end
+    private
+    def uncasted_globals
+      gem_fixtures["globals"].merge(dev_fixtures["globals"] || {})
+    end
+    def uncasted_models
+      gem_fixtures["models"].merge(dev_fixtures["models"] || {})
+    end
+    def dev_fixtures
+      @dev_fixtures ||= if File.exist?(fixture_path.to_s)
+                          YAML.load_file(fixture_path.to_s)
+                        else
+                          {}
+                        end
+    end
+    def gem_fixtures
+      @gem_fixtures ||= YAML.load_file(GEM_FIXTURE_PATH)
+    end
+    def cast(values, key = nil)
+      key &&= key.to_sym
+      if values.is_a?(Symbol)
+        values = uncasted_models[values.to_s]
+      end
+      if values.is_a? Array
+        values = values.map do |value|
+          cast(value, key)
+        end
+      else
+        if values.is_a? Hash
+          values = values.each_with_object({}) do |(child_key, value), hash|
+            child_key &&= child_key.to_sym
+            hash[KEY_MAPPING[child_key] || child_key] = cast(value, child_key)
+          end
+        end
+        if MAPPING[key]
+          values = MAPPING[key].new(values)
+        end
+      end
+      values
+    end
+    class << self
+      attr_accessor :default_path
+      def for(name, overrides: {})
+        new(default_path).for(name, overrides: overrides)
+      end
+      def globals
+        new(default_path).globals
+      end
+    end
+  end
+end