northpass 0.0.2

data/lib/schoolkeep/template_names.rb

@@ -0,0 +1,24 @@
+module Schoolkeep
+  TEMPLATE_NAMES = %w(
+    _course.html
+    _filters.html
+    _footer.html
+    _head.html
+    _header.html
+    _my_content_header.html
+    _search_form.html
+    _virtual_event_session.html
+    course_cover.html
+    course_details.html
+    course_index.html
+    custom_page.html
+    custom_javascript.html
+    custom_javascript_v1.html
+    custom_javascript_v2.html
+    homepage.html
+    my_content.html
+    not_found.html
+    server_error.html
+    styles.css
+  )
+end

data/lib/schoolkeep/version.rb

@@ -0,0 +1,3 @@
+module Schoolkeep
+  VERSION = "0.0.2"
+end

data/lib/schoolkeep/views/asset_cache.rb

@@ -0,0 +1,34 @@
+require "net/http"
+require "uri"
+
+module Schoolkeep
+  module Views
+    class AssetCache
+      attr_reader :host
+
+      def initialize(host)
+        @host = host
+      end
+
+      def [](path)
+        cached_get(path) || path
+      end
+
+      private
+
+      def get(path)
+        url = File.join(host, path)
+        res = Net::HTTP.get_response(URI(url))
+        res["location"]
+      end
+
+      def cached_get(path)
+        cache[path] ||= get(path)
+      end
+
+      def cache
+        @cache ||= {}
+      end
+    end
+  end
+end

data/lib/schoolkeep/views/color_scheme.rb

@@ -0,0 +1,19 @@
+require "schoolkeep"
+require "erb"
+require "schoolkeep/fixture"
+
+module Schoolkeep
+  module Views
+    class ColorScheme
+      def initialize(name)
+        @_name = name
+        @color_scheme = Fixture.for("styles.css.sktl")[:color_palette]
+      end
+
+      def render
+        css_path = File.join(GEM_ROOT, "config/#{@_name}.css.erb")
+        ERB.new(File.read(css_path), nil, "-").result(binding)
+      end
+    end
+  end
+end

data/lib/schoolkeep/views/layout.rb

@@ -0,0 +1,72 @@
+require "erb"
+require "schoolkeep"
+require "schoolkeep/template"
+require "schoolkeep/fixture"
+require "schoolkeep/views/asset_cache"
+
+module Schoolkeep
+  module Views
+    class Layout
+      class << self
+        attr_accessor :asset_host
+
+        def asset_cache
+          @asset_cache ||= AssetCache.new(asset_host)
+        end
+      end
+
+      BODY_CLASSES = {
+        "course_details.html.sktl" => "school_website-courses school_website-courses-show",
+        "course_index.html.sktl" => "school_website-courses school_website-courses-index",
+        "custom_page.html.sktl" => "school_website-custom_pages school_website-custom_pages-show",
+        "homepage.html.sktl" => "school_website-homepages school_website-homepages-show",
+        "my_content.html.sktl" => "school_website-my_content school_website-my_content-index"
+      }
+
+      LAYOUTS = Hash.new("school_website")
+      LAYOUTS["course_cover.html.sktl"] = "learning"
+
+      attr_reader :body
+      def initialize(template)
+        @template = template
+        @school = Fixture.globals[:current_school]
+        @preview_banner = Fixture.globals[:preview_banner]
+      end
+
+      def body_classes
+        BODY_CLASSES[@template.name]
+      end
+
+      def asset_url(path)
+        self.class.asset_cache[path]
+      end
+
+      def current_school
+        @school
+      end
+
+      def preview_banner
+        @preview_banner
+      end
+
+      def render_skt(partial_name, variables: {})
+        name = "#{partial_name}.html.sktl"
+        Template.new(name).render(variables: variables)
+      end
+
+      def render(variables: {})
+        @body = @template.render(variables: variables)
+        layout_path = File.join(GEM_ROOT, "config/#{LAYOUTS[@template.name]}.html.erb")
+        layout= File.read(layout_path)
+        set_context_variables_for_layout
+        ERB.new(layout).result(binding)
+      end
+
+      private
+
+      def set_context_variables_for_layout
+        @display_search_form = @template.name == "my_content.html.sktl"
+      end
+    end
+  end
+end

data/schoolkeep.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schoolkeep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "northpass"
+  spec.version       = Schoolkeep::VERSION
+  spec.authors       = ["Ryan Ong", "SchoolKeep Developers"]
+  spec.email         = ["ryan@northpass.com", "dev@northpass.com"]
+  spec.summary       = %q{A cli to develop custom templates for and upload to SchoolKeep.}
+  spec.homepage      = "https://github.com/SchoolKeep/schoolkeep-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.19.0"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "scribble"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "activesupport"
+end

data/spec/cli_spec.rb

@@ -0,0 +1,70 @@
+require "schoolkeep/cli"
+require "tmpdir"
+require "yaml"
+require "open3"
+
+module Schoolkeep
+  RSpec.describe CLI do
+    describe "#reset" do
+      it "returns an error when there is an invalid template name" do
+        _, error, process = Open3.capture3 "SK_API_KEY=test #{bin_path} reset non_existetnt_file.sktl"
+
+        expect(process).not_to be_success
+        expect(error).to include "invalid template name"
+      end
+    end
+
+    describe "#generate-fixtures" do
+      it "copies the fixture file" do
+        Dir.mktmpdir do |dir|
+          output, _, process = Open3.capture3 "#{bin_path} generate-fixtures --dir #{dir}"
+          expect(process).to be_success
+          expect(output).to include "fixtures.yml has been generated"
+          expect(File.exist?(File.join(dir, "config/fixtures.yml"))).to be true
+        end
+      end
+    end
+
+    describe "#server" do
+      it "serves directory" do
+        Dir.mktmpdir do |dir|
+          Dir.mkdir "#{dir}/templates"
+          File.write "#{dir}/templates/custom_page.html.sktl", ""
+
+          port = find_available_port
+          @pid = spawn("#{bin_path} server --dir #{dir} --port #{port} --quiet")
+
+          Timeout.timeout(60) { sleep 0.1 until responsive?(port) }
+
+          response = Faraday.get("http://localhost:#{port}/")
+          expect(response.body).to include "custom_page.html.sktl"
+        end
+      end
+
+      after do
+        Process.kill("INT", @pid) if @pid
+      end
+
+      def responsive?(port)
+        res = Faraday.get("http://localhost:#{port}/")
+
+        if res.success?
+          return res.body.include?("custom_page.html.sktl")
+        end
+      rescue Faraday::ConnectionFailed
+        return false
+      end
+
+      def find_available_port
+        server = TCPServer.new('127.0.0.1', 0)
+        server.addr[1]
+      ensure
+        server.close if server
+      end
+    end
+
+    def bin_path
+      @bin_path ||= File.expand_path("../../bin/sk", __FILE__)
+    end
+  end
+end

data/spec/features/cli_spec.rb

@@ -0,0 +1,51 @@
+require "schoolkeep/cli"
+require "schoolkeep/client"
+require "tmpdir"
+require "yaml"
+
+module Schoolkeep
+  RSpec.describe CLI, :schoolkeep_client, type: :feature do
+    describe "#upload and #reset" do
+      it "uploads the all templates and then deletes it" do
+        Dir.mktmpdir do |template_dir|
+          test_string = rand(36**100).to_s(36)
+          TEMPLATE_NAMES.each do |name|
+            File.write "#{template_dir}/#{name}.sktl", test_string
+          end
+
+          expect(system("#{bin_path} upload --dir #{template_dir} --quiet --all")).to be true
+
+          response = Faraday.get(ENV["SK_CUSTOM_PAGE_URL"])
+          expect(response.body).to include test_string
+
+          expect(system("#{bin_path} reset --all --quiet")).to be true
+
+          response = Faraday.get(ENV["SK_CUSTOM_PAGE_URL"])
+          expect(response.body).not_to include test_string
+        end
+      end
+
+      it "uploads the all templates and then deletes it" do
+        Dir.mktmpdir do |template_dir|
+          test_string = rand(36**100).to_s(36)
+          custom_page_path = File.join(template_dir, "custom_page.html.sktl")
+          File.write custom_page_path, test_string
+
+          expect(system("#{bin_path} upload #{custom_page_path} --quiet")).to be true
+
+          response = Faraday.get(ENV["SK_CUSTOM_PAGE_URL"])
+          expect(response.body).to include test_string
+
+          expect(system("#{bin_path} reset custom_page.html.sktl --quiet")).to be true
+
+          response = Faraday.get(ENV["SK_CUSTOM_PAGE_URL"])
+          expect(response.body).not_to include test_string
+        end
+      end
+    end
+
+    def bin_path
+      @bin_path ||= File.expand_path("../../../bin/sk", __FILE__)
+    end
+  end
+end

data/spec/features/client_spec.rb

@@ -0,0 +1,48 @@
+require "schoolkeep/client"
+require "tempfile"
+
+module Schoolkeep
+  RSpec.describe Client, :schoolkeep_client, type: :feature do
+    describe "#upload and #delete" do
+      it "deletes the custom_page template" do
+        expect(client.upload("custom_page.html", temp_file, "sktl")).to be_success
+        response = Faraday.get(ENV["SK_CUSTOM_PAGE_URL"])
+
+        expect(response.body).to include test_string
+
+        expect(client.delete("custom_page.html")).to be_success
+        response = Faraday.get(ENV["SK_CUSTOM_PAGE_URL"])
+
+        expect(response.body).not_to include test_string
+      end
+
+      after do
+        temp_file.unlink
+      end
+
+      def test_string
+        @test_string ||= rand(36**100).to_s(36)
+      end
+
+      def temp_file
+        @temp_file ||= Tempfile.new("any_file.sktl").tap do |file|
+          file.write(test_string)
+          file.rewind
+        end
+      end
+    end
+
+    describe "#get_fixtures" do
+      it "downloads fixtures" do
+        response = client.get_fixtures
+
+        expect(response).to be_success
+        expect(YAML.load(response.body)).to have_key "globals"
+      end
+    end
+
+    def client
+      @client ||= Client.new(ENV["SK_API_KEY"])
+    end
+  end
+end

data/spec/fixture_spec.rb

@@ -0,0 +1,68 @@
+require "schoolkeep/fixture"
+
+module Schoolkeep
+  RSpec.describe Fixture do
+    describe "#globals" do
+      it "reads global file and needs no dev file" do
+        globals = Fixture.new(nil).globals
+
+        expect(globals[:current_learner].name).to eq "Test Learner"
+      end
+
+      it "reads global file and uses dev overwrites" do
+        file = Tempfile.new(%w(fixture yml))
+
+        begin
+          file.write(dev_fixtures.to_yaml)
+          file.rewind
+          globals = Fixture.new(file.path).globals
+          expect(globals[:current_learner].name).to eq "Fixture Test"
+        ensure
+          file.close
+          file.unlink   # deletes the temp file
+        end
+      end
+
+      def dev_fixtures
+        {"globals" => { "current_learner" => {"name" => "Fixture Test"}}}
+      end
+    end
+
+    describe "#for" do
+      it "reads global file and needs no dev file" do
+        fixtures = Fixture.new(nil).for("custom_page.html.sktl")
+        expect(fixtures[:custom_page].headline).to eq "Sample Custom Page"
+      end
+
+      it "renders all templates without errors" do
+        Schoolkeep::TEMPLATE_NAMES.each do |name|
+          Fixture.new(nil).for("#{name}.sktl")
+        end
+      end
+
+      it "reads global file and uses dev overwrites" do
+        file = Tempfile.new(%w(fixture yml))
+
+        begin
+          file.write(dev_fixtures.to_yaml)
+          file.rewind
+          fixtures = Fixture.new(file.path).for("custom_page.html.sktl")
+          expect(fixtures[:custom_page].headline).to eq "Fixture Test"
+        ensure
+          file.close
+          file.unlink   # deletes the temp file
+        end
+      end
+
+      it "properly references courses" do
+        fixtures = Fixture.new(nil).for("course_details.html.sktl")
+
+        expect(fixtures[:course].name).to eq "photography course"
+      end
+
+      def dev_fixtures
+        { "templates" => { "custom_page.html.sktl" => { "custom_page" => {"headline" => "Fixture Test"}}}}
+      end
+    end
+  end
+end

data/spec/methods/filter_parameter_value_spec.rb

@@ -0,0 +1,28 @@
+require "scribble"
+require "schoolkeep/scribble/methods/query_parameter_value"
+
+module Scribble::Methods
+  RSpec.describe FilterParameterValue do
+    describe "#query_parameter_value" do
+      it "escapes HTML" do
+        rendered = render("<input value='{{ filter_parameter_value }}>'", "test_template")
+
+        expect(rendered).to eq \
+          "<input value='&#39;&gt;&lt;script&gt;alert(&#39;HAXXX&#39;)&lt;/script&gt;>'"
+      end
+    end
+
+    def render(source, template_name, locale = :en)
+      Scribble::Template.new(source).render(
+        variables: {
+          template_name: template_name,
+          params: {
+            filter: {
+              category_name: "'><script>alert('HAXXX')</script>"
+            }
+          }
+        }
+      )
+    end
+  end
+end