skypager 0.0.2

data/examples/gallery-site/source/tutorial.md

@@ -0,0 +1,151 @@
+# Using the skypager gem to build dynamic, data driven sites with middleman
+
+Skypager takes an already powerful website creation tool 'Middleman' and adds a few key integrations
+with services like Dropbox and Google Drive / Google Documents, as well as Amazon S3, Cloudfront, and DNSimple.
+
+This automates a ton of boring setup chores and allows designers and developers to crank out dynamic, data driven websites
+without having to worry too much about servers.  And since these websites are all technically 'static', and backed by a global CDN, 
+Skypager websites will be fast as hell. 
+
+The skypager gem is open source.  If you want to automate your builds and releases every time files change on Dropbox or any time data changes in a Google Spreadsheet, you
+can either run the skypager build server on your own server or you can sign up on skypager.io and we will set all of that up for you as well.
+
+## Using the skypager gem in your own projecs
+
+In this tutorial, we are going to use the skypager gem and the skypager middleman extension to build a photo gallery website.
+
+The information about our photo galleries is going to be stored in a google spreadsheet.  The photo galleries themselves, are going to be stored on Dropbox.
+
+- 1) create a new middleman project
+
+  ```bash
+  middleman init
+  ```
+
+- 2) add the skypager gem, and activate it in your config.rb
+
+  ```ruby
+  # Gemfile
+
+  gem 'skypager', github: "architects/skypager", branch: "master"
+
+  # config.rb
+
+  activate :skypager
+  ```
+
+- 3) setup the google drive and dropbox integrations.  this requires you
+  to create applications in the respective developer consoles for google
+  and dropbox
+
+  ```bash
+  alias be='bundle exec'
+  be skypager setup
+  ```
+
+- 4) once your applications are setup, you can create a google
+  spreadsheet datasource.  the spreadsheet data source will be used to
+  generate dynamic pages and content to be displayed with our html
+  templates
+
+  ```bash
+  be skypager create datasource galleries
+  ```
+
+  follow the prompts, selecting 'google spreadsheet' and enter in
+  some fields for this data source.
+
+  for this example we will use:
+
+  `title description cover_image status release_date`
+
+  this will end up creating the following line in our `config.rb`
+
+  ```ruby
+  # config.rb
+
+  data_source :galleries, :type => "google", :key => "..."
+  ```
+
+- 5) in order to get pretty urls from our data source, we are going to 
+    configure the data source to make 'slugs' out of the title column.
+
+    edit the config.rb file:
+
+  ```ruby
+  # config.rb
+
+  data_source :galleries, :type => "google", :key => "...", :slug_column => 'title'
+  ```
+
+- 6) with this done, we will now have access to the galleries data
+  source from within any template, or from within the `config.rb` file
+  itself which means we can use the data source to generate dynamic
+  urls such as: `/galleries/my-gallery-title` which will display the
+  info in the spreasheet.
+
+- 7) let's open up the actual spreadsheet and add some rows to it.
+
+  ```bash
+  be skypager edit datasource galleries
+  ```
+
+  this will open up the spreadsheet in your browser for you.
+
+- 8) with some actual data in our spreadsheet, lets get a couple of
+  pages rendered with it. open up the `source/index.html.erb` file and
+  put in the following content.
+
+  ```erb
+  <h1>Galleries</h1>
+
+  <ul>
+    <% data.galleries.each do |gallery| %>
+      <li>
+        <p><%= gallery.title %></p>
+      </li>
+    <% end %>
+  </ul>
+  ```
+
+  here we are accessing the data from the galleries spreadsheet in our template
+  by iterating over `data.galleries` and listing each one.  If we edit the spreadsheet,
+  and add a new row, and then refresh the page, you will see the new data show up. 
+
+  **note:** if you don't see data showing up, you can restart your development server. in development,
+  skypager attempts to keep up to date, but in order not to keep nagging the server we do 
+  some checking and sometimes this might make data stale.  
+
+- 9) we can create separate pages for each row in the spreadsheet. 
+
+  ```ruby
+  # config.rb
+  map_data_source(:galleries, :url => "/galleries/:slug", :to => "gallery.html.erb", :as => :gallery)
+  ```
+
+  this will dynamically add routes for every row in the galleries data source, and display that individual
+  row using the `gallery.html.erb` template
+
+  since we added the `slug_column` option and set it to title, then it will turn our title column data
+  into a friendly url.  for example: `My Awesome Gallery` becomes available at `/galleries/my-awesome-gallery`
+  
+  editing the `source/gallery.html.erb` template file:
+ 
+  ```erb
+  <h1><%= gallery.title %></h1>
+  <%= image_tag(gallery.cover_image) %>
+  <p><%= gallery.description %></p> 
+  ``` 
+
+  and now editing the `source/index.html.erb` template file we can link to our galleries.
+
+  ```erb
+  <a href="/galleries/<%= gallery.slug %>">
+    <%= gallery.title %>
+  </a>
+  ```
+
+### Using dropbox as a media store for your website content
+
+- 10) a gallery isn't much without some images. in this tutorial, we are going to integrate with Dropbox to store our 
+      image files. 

data/lib/skypager.rb

@@ -0,0 +1,92 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'hashie'
+require 'pathname'
+require 'google_drive'
+require 'google/api_client'
+require 'google_drive/session'
+require 'dropbox-api'
+require 'cgi'
+require 'launchy'
+require 'active_support/core_ext'
+require 'uri_template'
+
+require 'skypager/version'
+require 'skypager/configuration'
+
+module Skypager
+  def self.app(environment="build", &block)
+    @app ||= ::Middleman::Application.server.inst do
+      set :environment, environment
+      instance_eval(&block) unless block.nil?
+    end
+  end
+
+  def self.config
+    Skypager::Configuration.instance
+  end
+
+  def self.sites
+    Skypager::Site.directory
+  end
+
+  def self.amazon
+    Skypager::Sync::Amazon.client
+  end
+
+  def self.google
+    Skypager::Sync::Google.client
+  end
+
+  def self.dropbox
+    Skypager::Sync::Dropbox.client
+  end
+
+  def self.dns
+    require 'dnsimple'
+    require 'skypager/dns'
+    Skypager::DNS::Manager.client
+  end
+
+  def self.root
+    Skypager::Configuration.skypager_root
+  end
+
+  def self.lib
+    Pathname(File.dirname(__FILE__))
+  end
+
+  def self.load_commands
+    Dir["#{lib.join('skypager','cli', 'commands')}/**/*.rb"].each {|f| require(f) }
+  end
+
+  def self.append_config line, options={}
+    file = Pathname(app.root).join('config.rb')
+
+    if file.exist?
+      file.open("a+") do |fh|
+        unless options[:silent]
+          puts "Appending\n\t#{line}"
+        end
+
+        fh.write("\n#{line}")
+      end
+    end
+  end
+end
+
+require 'skypager/site'
+require 'skypager/data'
+require 'skypager/data/source'
+require 'skypager/data/request'
+require 'skypager/data/google_spreadsheet'
+require 'skypager/data/excel_spreadsheet'
+require 'skypager/data/source_routes_proxy'
+require 'skypager/sync'
+require 'skypager/sync/dropbox'
+require 'skypager/sync/dropbox/delta'
+require 'skypager/sync/google'
+require 'skypager/sync/folder'
+require 'skypager/sync/amazon'
+require 'skypager/dns'
+require 'skypager/extension'

data/lib/skypager/build_server.rb

@@ -0,0 +1,17 @@
+# The Skypager Build server provides REST endpoints which can be hit by
+# external services, such as the Dropbox Webhooks system, Google Drive webhooks system,
+# or the Github Webhook system, etc.
+#
+# Given a parameter from the Webhook request,
+# the Build server will find the appropriate site,
+# build and deploy it
+
+require 'sinatra'
+
+class Skypager::BuildServer < Sinatra::Base
+  post "/webhooks/:provider" do
+  end
+
+  post "/webhooks/:provider/:site_name" do
+  end
+end

data/lib/skypager/cli/commands/config.rb

@@ -0,0 +1,58 @@
+command 'config localize' do |c|
+  c.syntax = "skypager config localize"
+  c.description = "sets up a local skypager config file for this project"
+
+  c.action do |args, options|
+    path = Skypager.config.cwd_config_path
+
+    unless path.exist?
+      path.open("w+") do |fh|
+        fh.write(Skypager.config.home_config.to_json)
+      end
+    end
+  end
+end
+
+command 'config' do |c|
+  c.syntax = 'skypager config [options]'
+  c.description = 'list skypager configuration settings'
+
+  c.action do |_args, _options|
+    Skypager::Configuration.initialize!
+
+    Skypager.config.show
+  end
+end
+
+command 'config get' do |c|
+  c.syntax = 'skypager config:get [options]'
+  c.description = 'manipulate skypager configuration settings'
+
+  c.action do |args, _options|
+    Skypager::Configuration.initialize!
+
+    puts Skypager.config.get(args.first)
+  end
+end
+
+command 'config set' do |c|
+  c.syntax = 'skypager config:set KEY=VALUE KEY=VALUE [options]'
+  c.description = 'manipulate skypager configuration settings'
+
+  c.option '--global', nil, 'Set the configuration globally'
+
+  c.action do |args, _options|
+    Skypager::Configuration.initialize!
+
+    args.select { |pair| pair.match(/=/) }
+      .map { |pair| pair.split('=') }
+      .each do |group|
+        key, value = group
+        Skypager.config.set(key, value, false, global: !!(_options.global))
+      end
+
+    Skypager.config.save!
+
+    Skypager.config.show
+  end
+end

data/lib/skypager/cli/commands/create.rb

@@ -0,0 +1,98 @@
+create_command = lambda do |c|
+  c.syntax = 'skypager create data source NAME [options]'
+  c.description = "Create a data source"
+
+  c.option "--type", nil, "What type of data source? google-spreadsheet, dropbox-excel, rest-endpoint"
+  c.option "--spreadsheet-name", nil, "What is the spreadsheet name? will be used to find the key"
+  c.option "--dropbox-path", nil, "What is the path to the excel?"
+  c.option "--fields", "", "comma separated list of fields"
+  c.option "--collaborators", "", "comma separated list of email address to share this data source with"
+
+  c.action do |args, options|
+    name = args.first
+
+    options.default :fields => "",
+                    :collaborators => ""
+
+    name ||= ask("What should the name of this data source be?", String)
+
+    type = options.type
+    type ||= choose("Where will this data be stored?", "Google Spreadsheet", "Excel on Dropbox")
+
+    types = {
+      "Google Spreadsheet" => "google",
+      "Excel on Dropbox" => "dropbox-excel",
+      "REST API Endpoint" => "rest-endpoint"
+    }
+
+    type            = types.fetch(type) { type }
+    fields          = options.fields.split(",").map(&:strip)
+    collaborators   = options.collaborators.split(",").map(&:strip)
+
+    if fields.empty?
+      fields = ask("Enter the names of the columns. Make sure to use underscore_instead_of_space:", Array)
+    end
+
+    case type
+
+    when "google"
+      spreadsheet = Skypager::Data::GoogleSpreadsheet.create_from_data([], title: name, headers: fields, skypager_config_info: true)
+
+      if !collaborators.empty?
+        spreadsheet.share_write_access_with(*collaborators)
+      end
+
+    when "dropbox-excel"
+
+    end
+  end
+end
+
+command 'create datasource' do |c|
+  create_command.call(c)
+end
+
+command 'create data source' do |c|
+  create_command.call(c)
+end
+
+command 'create syncable' do |c|
+  c.syntax      = 'skypager create synced folder NAME [options]'
+  c.description = "Create a synced folder"
+
+  c.option "--type", nil, "What service is holding the folder? dropbox, google-drive"
+  c.option "--skip-config", nil, 'Skip modifying the config'
+
+  c.action do |args, options|
+    type = options.type
+    type ||= choose("What service is holding the folder?", "Google Drive", "Dropbox")
+
+    types = {
+      "Google Drive" => "google-drive",
+      "Dropbox" => "dropbox"
+    }
+
+    if defined?(::Middleman)
+      app = ::Middleman::Application.server.inst do
+        set :environment, 'development'
+      end
+    end
+
+    type    = types.fetch(type) { type }
+
+    if type == "dropbox"
+      Skypager::Sync::Dropbox.create_site_folder(app.site_name)
+
+      puts "\n\n"
+      local_path = ask("Enter a relative path to the folder in this project that you would like to sync with Dropbox. e.g. source/images or source", String)
+      puts "\n\n"
+      remote_path = ask("Enter the remote path. leave blank to use the same", String)
+      remote_path = local_path if remote_path.to_s.length == 0
+
+      Skypager.dropbox.sync_folders(local_path, remote_path, app: app, append_config: !!!options.skip_config)
+
+    elsif type == "google-drive"
+      Skypager::Sync::Google.create_site_folder(app.site_name)
+    end
+  end
+end

data/lib/skypager/cli/commands/deploy.rb

@@ -0,0 +1,30 @@
+command 'deploy' do |c|
+  c.syntax = 'skypager deploy [options]'
+  c.description = 'deploy this site'
+
+  c.option '--verbose', nil, 'Display verbose status information'
+
+  c.action do |args, options|
+    app = Skypager.app
+    site = app.site
+
+    site.deploy(app.build_path)
+
+    if site.use_cdn?
+      cdn = site.cdn
+
+      paths = app.sitemap.resources.map do |resource|
+        "/#{ resource.request_path }"
+      end
+
+      begin
+        service = cdn.service
+        puts "Posting CDN Invalidations"
+        puts paths.inspect
+        service.post_invalidation cdn, paths
+      rescue => e
+        puts "Error invalidating the CDN: #{ e.message }"
+      end
+    end
+  end
+end