dropdown 0.8.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTJjYTZhZWE1ODY2YzkyOTlmOWNmZmYzNGRlM2Q0MmU5YzY3MmVlYQ==
+  data.tar.gz: !binary |-
+    MTg4MDI4ZmE3ZDE4NWEwNjA3MGEzZTFhOWJiNDJiNzIwOWM2MDMzMQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZThiZWJiOGU5MzUwNDk1YWE5NTY1OWZjMTQ4MGRkZTJkMzc5ODExNTg4ZDY2
+    OWE0YzVhNGEzYjk0ZTI0ODBkMDMyZTQ3YmMwYWI4ZmM1Zjc5MWRlNjRiMWJh
+    Y2ZjY2JiNDU2MDY1YTA1MTlkMDYxYjY5NWU1MmM3ZTYyOGJiNjE=
+  data.tar.gz: !binary |-
+    MzUyODY0NjE5MTcwMDA4N2M4NTUyMTgzOGNhY2M4NTE5YTZkMGJkNTM0Zjll
+    ZTEwNjM2M2RjNzU3ODY3ODQ3ODNjODRjNTcyOTYzMWNkMjI0NjU5MGNkNzE1
+    ODhkZGEwODNhMWNkMWM1YjM2MWMzY2RlOGYzNjYyYWI3MWEzYjA=

data/.gitignore

@@ -0,0 +1,23 @@
+Gemfile.lock
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# local environment details
+.env

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brilliant Fantastic
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,194 @@
+Dropdown
+========
+
+[![Code Climate](https://codeclimate.com/github/brilliantfantastic/dropdown.png)](https://codeclimate.com/github/brilliantfantastic/dropdown)
+[![Build Status](https://travis-ci.org/brilliantfantastic/dropdown.png?branch=master)](https://travis-ci.org/brilliantfantastic/dropdown)
+[![Coverage Status](https://coveralls.io/repos/brilliantfantastic/dropdown/badge.png?branch=master)](https://coveralls.io/r/brilliantfantastic/dropdown?branch=master)
+
+Blog engine that parses Markdown files stored in Dropbox for a static blog engine.
+
+Installation
+=============
+
+Add this line to your application's Gemfile:
+
+```sh
+gem 'dropdown'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install dropdown
+```
+
+Getting Started with Dropbox storage
+====================================
+
+1. **Create an application on Dropbox**
+
+    1. Sign into Dropbox
+    1. Visit `https://www.dropbox.com/developers/apps/create`
+    1. Choose 'Dropbox API app' for 'What type of app do you want to create?'
+    1. Choose 'Files and datastores' for 'What type of data does your app need to store on Dropbox?'
+    1. Choose 'No -- My app needs access to files already on Dropbox' for 'Can your app be limited to its own, private folder?'
+    1. Choose 'All file types -- My app needs access to a user's full Dropbox' for 'What type of files does your app need access to?'
+    1. Name your application. We suggest something like '<blog name> Dropdown blog'
+
+    Here is a screenshot of an example of a Dropbox app creation page filled out:
+
+    ![](https://dl.dropboxusercontent.com/u/987517/oss/Dropdown/README/dropbox-create-app.png)
+
+1. **Enter your Dropbox APP KEY and APP SECRET in environment variables**
+
+    Once your create a Dropbox application, you will be assigned an App key and an App secret. You will want to put these values in 
+    environment variables so you can use these in your Dropdown configuration settings. We highly suggest you do not put these values 
+    straight into your configuration because you do not want them checked into your source control.
+
+    For development, we recommend using [dotenv](https://github.com/bkeepers/dotenv).
+
+    1. For Rails, add this line to your application's `Gemfile`
+
+        ```ruby
+        gem 'dotenv-rails', :groups => [:development, :test]
+        ```
+
+    1. Create a `.env` file to the root of your project
+    1. Add the `.env` file to your `.gitignore`
+    1. Add the following content to your `.env` file
+
+        ```
+        DROPBOX_APP_KEY=<your app key>
+        DROPBOX_APP_SECRET=<your app secret>
+        DROPBOX_ACCESS_TOKEN=<your access token>
+        ```
+
+    For production, if you application lives on Heroku, you can run the following:
+
+    ```sh
+    heroku config:set DROPBOX_APP_KEY=<your app key>
+    heroku config:set DROPBOX_APP_SECRET=<your app secret>
+    heroku config:set DROPBOX_ACCESS_TOKEN=<your access token>
+    ```
+
+1. **Update your Dropdown configuration**
+
+    For Rails, create `config/initializers/dropdown.rb` with the following content:
+
+    ```ruby
+    Dropdown.configure do |c|
+      c.dropbox_app_key: ENV['DROPBOX_APP_KEY']
+      c.dropdown_app_secret: ENV['DROPBOX_APP_SECRET']
+      c.dropdown_access_token: ENV['DROPBOX_ACCESS_TOKEN']
+    end
+    ```
+
+    We will be retrieving the `DROPBOX_ACCESS_TOKEN` with the next step.
+
+1. **Run `rake setup:dropbox:access_token`**
+
+    This will instruct you to go to a Dropbox url to authorize your Dropbox application.
+
+    Copy the authorization code and enter it the console.
+
+    Your access token will be displayed and you can copy it to an environment variable: `DROPBOX_ACCESS_TOKEN`.
+
+Potential Implementation
+========================
+
+## Dropbox directory structure
+
+<pre>
+  - blog-posts
+  |-- markdown
+      |-- random-post-1.md
+      |-- random-post-2.md
+  |-- html
+      |-- random-post-1.html
+      |-- random-post-2.html
+  |-- templates
+      |-- honeysuckle.handlebars
+  |-- .index
+</pre>
+
+## Parsing
+
+A rake task will be used to process a directory with Markdown files. The process will read each Markdown file and create an accompanying static file in HTML. This process will use [RedCarpet](https://github.com/vmg/redcarpet) to parse the markdown files and generate HTML files.
+
+```ruby
+  # task to process the Markdown directory
+  require 'dropdown/processor'
+
+  task :process [:source, :destination] do |t, args|
+    DropDown::Processor.new(args.source, args.destination).process
+  end
+```
+
+Additional functionality
+
+```ruby
+  DropDown::Processor.new.process(:all)   # same as calling DropDown::Processor.new.process
+  DropDown::Processor.new.process         # uses the source and destination directories specified in the configuration
+```
+
+### Format of the generated output
+
+Each file will have meta data stored as comments in the MarkDown:
+
+```
+Title: Deep Throat Exposed!
+Author: Bob Woodward
+Post: 4/4/1974
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut volutpat molestie condimentum. Vestibulum malesuada, 
+lorem sit amet euismod pellentesque, tellus felis varius enim, id tincidunt leo odio aliquet ante. Maecenas metus 
+lorem, pretium vitae auctor sed, blandit id quam.
+```
+
+This will generate the following html:
+
+```html
+<!-- Title: Deep Throat Exposed! -->
+<!-- Author: Bob Woodward -->
+<!-- Post: 4/4/1974 -->
+<div class='post'>
+  <div class='title'>Deep Throat Exposed!</div>
+  <div class='author'>Bob Woodward</div>
+  <div class='post'>19740404T....</div>
+  <div class='content'>
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut volutpat molestie condimentum. Vestibulum malesuada, 
+    lorem sit amet euismod pellentesque, tellus felis varius enim, id tincidunt leo odio aliquet ante. Maecenas metus 
+    lorem, pretium vitae auctor sed, blandit id quam.
+  </div>
+</div>
+```
+
+This will also create the following row in the .index file:
+
+```
+title: Deep Throat Exposed! author: Bob Woodward post: 19740404T.... slug: deep-throat-exposed checksum: 384749403
+```
+
+## Retreiving
+
+## Displaying
+
+## Configuration
+
+```ruby
+  DropDown.configure do |c|
+    c.base_path: 'blog_posts'
+    c.source_directory: 'markdown'
+    c.destination_directory: 'html'
+    c.template: 'honeysuckle'
+    c.dropbox_app_key: '<insert dropbox app key>'
+    c.dropbox_app_secret: '<insert dropbox app secret key>'
+  end
+```
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'bundler/gem_tasks'
+require 'dotenv/tasks'
+
+task :default => [:test]
+
+desc 'Run tests for project'
+task :test do
+  sh 'bundle exec rspec'
+end
+
+desc 'Process the markdown files in a directory'
+task :process, :source_directory do |t, args|
+  require_relative 'lib/dropdown'
+  processor = Dropdown::Processor.new
+  processor.source = args[:source_directory]
+  processor.destination = File.join(processor.source, 'html')
+  processor.storage = args[:storage] || :dropbox
+  processor.renderer = :markdown_renderer
+  processor.process
+end
+
+namespace :setup do
+  namespace :dropbox do
+    desc 'Store a new access token from Dropbox'
+    task :access_token => :dotenv do |t, args|
+      require 'launchy'
+      require_relative 'lib/dropdown'
+
+      key = args[:key] || ENV['DROPBOX_APP_KEY']
+      secret = args[:secret] || ENV['DROPBOX_APP_SECRET']
+      session = Dropdown::Dropbox::Session.new key, secret
+      url = session.authorize_url
+      puts "Opening the following url in your browser: #{url} ..."
+      Launchy.open url
+      puts "Paste the authorization code below and hit return: "
+      code = STDIN.gets.strip
+      token = session.access_token(code)
+      puts "Your access token is: #{token}"
+    end
+  end
+end

data/dropdown.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dropdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dropdown"
+  spec.version       = Dropdown::VERSION
+
+  spec.authors       = ["Jamie Wright", "Keith Thompson"]
+  spec.email         = ["jamie@brilliantfantastic.com", "keith@brilliantfantastic.com"]
+
+  spec.summary       = "Markdown blog engine in Dropbox"
+  spec.description   = %q{
+                        A simple blog engine that reads blog posts from a Dropbox source.
+                        Rake tasks will convert any blog post from Markdown to HTML and 
+                        store them back into Dropbox for the Blog objects to read.
+                       }
+
+  spec.homepage      = "http://github.com/brilliantfantastic/dropdown"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", "~> 1.3"
+  spec.add_dependency "rake"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "launchy"
+  spec.add_dependency "redcarpet"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "dropbox-sdk"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakeweb"
+end

data/lib/dropdown.rb

@@ -0,0 +1,23 @@
+require_relative 'dropdown/version'
+require_relative 'dropdown/dropbox'
+require_relative 'dropdown/processor'
+require_relative 'dropdown/configuration'
+require_relative 'dropdown/output_stores'
+require_relative 'dropdown/readers'
+require_relative 'dropdown/iterators'
+require_relative 'dropdown/parsers/parser'
+require_relative 'dropdown/parsers/metadata_parser'
+require_relative 'dropdown/parsers/excerpt_extractor'
+require_relative 'dropdown/markdown_renderer'
+require_relative 'dropdown/blog'
+require_relative 'dropdown/post'
+
+module Dropdown
+  def self.configuration
+    @configuration ||= Dropdown::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end

data/lib/dropdown/blog.rb

@@ -0,0 +1,23 @@
+module Dropdown
+  class Blog
+    attr_accessor :name, :source
+    attr_reader :reader, :posts
+
+    def initialize(source=nil, reader=Dropdown::Readers::FileReader.new)
+      @source = source
+      @reader = reader
+      @posts = []
+      collect
+    end
+
+    private
+
+    def collect
+      unless @source.nil?
+        @reader.find_html_files(@source).each do |html_file|
+          @posts << Post.new(html_file, reader)
+        end
+      end
+    end
+  end
+end

data/lib/dropdown/configuration.rb

@@ -0,0 +1,12 @@
+module Dropdown
+  class Configuration
+    attr_accessor :renderer,
+                  :dropbox_app_key,
+                  :dropbox_app_secret,
+                  :dropbox_access_token
+
+    def initialize
+      @renderer = :markdown_renderer
+    end
+  end
+end

data/lib/dropdown/constants.rb

@@ -0,0 +1,4 @@
+module Dropdown
+  MARKDOWN_EXTENSIONS = %w(.md .markdown)
+  HTML_EXTENSIONS = %w(.html)
+end

data/lib/dropdown/dropbox.rb

@@ -0,0 +1 @@
+require_relative 'dropbox/session'

data/lib/dropdown/dropbox/session.rb

@@ -0,0 +1,18 @@
+require 'dropbox_sdk'
+
+module Dropdown
+  module Dropbox
+    class Session
+      attr_reader :authorize_url
+
+      def initialize(app_key, app_secret)
+        @flow = DropboxOAuth2FlowNoRedirect.new app_key, app_secret
+        @authorize_url = @flow.start
+      end
+
+      def access_token(authorization_code)
+        @flow.finish(authorization_code)[0]
+      end
+    end
+  end
+end

data/lib/dropdown/errors.rb

@@ -0,0 +1,4 @@
+module Dropdown
+  class FileTypeError < ArgumentError
+  end
+end