rypple 0.0.5 → 0.0.6

data/README.markdown

@@ -0,0 +1,26 @@
+# Overview
+A tool for integrating some remote file store (e.g. Dropbox) with a static site generator (e.g. jekyll) with some tools to ease remote updating of the site.
+
+# Installation
+The easiest method to install Rypple is to use (RubyGems)[https://rubygems.org/]. To do so, simply install RubyGems, and at the command prompt type:
+    gem install rypple
+
+For some sites, such as (NSFN)[https://www.nearlyfreespeech.net/], this should be modified to:
+    RB_USER_INSTALL=true gem install rypple
+
+## Configuration
+Once installed, Rypple needs to be configured for each site being synced by it. This is done through the rypple command, and can be initiated using the command:
+    rypple -s
+
+Which kicks off the configuration process. This process will guide you through several important configuration options.
+1. Rypple site directory. This is the directory to which files will be saved - by default, this is set to $HOME/ryppleSite, but can be changed to any site you wish. This is not the location which will be publicly accessible, so please do not point this at your web server.
+2. Dropbox API Configuration
+    1. Generate a Dropbox API key/secret pair from their website. IMPORTANT: When creating the key, there is a question about granting the API access to your entire Dropbox folder, or only a sandboxed folder. This option, as far as I can tell, is immutable - Rypple supports either, but be aware of the choice being made.
+    2. Enter the API key and secret.
+    3. Select the API access mode the API key/secret were configured to allow. This option must match what was specified earlier, or else the system won't be able to connect.
+    3. Visit the webpage requested by the setup script to complete the configuration step.
+3. (Optional) Configure the web host to use Ruby Gems.
+4. Select the location for the static site generator to output files. This goes into configuring the sync portal for your site.
+5. (Optional) Enable basic user authentication through a .htaccess file. This allows you to create a user/password combination for the sync portal, so bots don't spam the form to cause your site to update.
+6. Wait for the first update to complete. Everything should sync and be ready to go!
+

data/lib/rypple/base.rb

@@ -15,16 +15,16 @@ module Rypple
     }
   }
 
-  DropboxKeyFile = "dropbox_session.yml"
+  DropboxKeyFile = ".dropbox_session.yml"
   RyppleConfigFile = "rypple.yml"
 
   def Rypple.connectToDropbox(path)
     session = nil
     dropboxKeys = {:access_type => :app_folder}
-    dropConf = File.join(path, DropboxKeyFile)
+    dropConfPath = File.join(path, DropboxKeyFile)
     #Load Dropbox API dropboxKeys from file, if applicable.
-    if File.exists?(dropConf)
-      dropboxKeys = YAML::load(File.read(dropConf))
+    if File.exists?(dropConfPath)
+      dropboxKeys = YAML::load(File.read(dropConfPath))
     end
 
     if dropboxKeys.has_key?(:session)
@@ -60,14 +60,6 @@ module Rypple
       conf.merge!(loadedConf)
     end
 
-    conf[:destinationDir] = File.expand_path(conf[:destinationDir])
-    if !File.directory?(conf[:destinationDir])
-      begin
-        Dir.mkdir(conf[:destinationDir])
-      rescue SystemCallError
-        raise RuntimeError, "Destination doesn't exist and cannot be created."
-      end
-    end
     return conf
   end
 

data/lib/rypple/setup.rb

@@ -77,7 +77,7 @@ def Rypple.Setup()
   end
 
   conf = Rypple.loadConfiguration(configBase)
-  conf[:destinationDir] = directory
+  conf[:destinationDir] = File.expand_path(directory)
   session, client, keys = Rypple.connectToDropbox(configBase)
   
   if !conf.nil? and !keys.nil?

data/lib/rypple/version.rb

@@ -1,3 +1,3 @@
 module Rypple
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rypple
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Jason Ziglar
@@ -58,6 +58,7 @@ extra_rdoc_files: []
 files: 
 - Gemfile
 - README
+- README.markdown
 - Rakefile
 - bin/rypple
 - bin/ryppleInstall