kwbock/clipster

# Clipster

[<img src="https://secure.travis-ci.org/kwbock/clipster.png" alt="Build Status" />](http://travis-ci.org/kwbock/clipster)
[![Dependency Status](https://gemnasium.com/kwbock/clipster.png)](https://gemnasium.com/kwbock/clipster)
[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kwbock/clipster)

Code snippets before they were cool.

An OpenSource Rails engine to add clipboard code sharing to your existing Ruby on Rails applications. Great for internal code sharing. Try it out at http://www.developerdan.com/clipster
* Features
    * Syntax highlighting
    * Expiring clips
    * Public and private clips
    * Atom Feed for public clips
    * Optional user integration

## Production

Add clipster to your Gemfile and then bundle install

    gem 'clipster'
    bundle install

or if you aren't using Bundler, run

    gem install 'clipster'

Mount the Clipster Engine in your applcations routes.rb like follows.

    mount Clipster::Engine, :at => '/clipster'

cd to your apps root and run

    rails g clipster:install
    rake db:migrate

Restart your application and you should be able to access the engine at http://domain.tld/clipster

## Development

cd into your test application directory's lib folder and run the following

    git clone https://github.com/kwbock/clipster.git

Add the following to your app's Gemfile

    gem 'clipster', :path => './lib/clipster'

Add the following to your app's routes.rb

    mount Clipster::Engine, :at => '/clipster'

cd to your apps root and run

    rake clipster:install:migrations
    rake db:migrate

Launch your server and navigate to https://localhost:3000/clipster to confirm the engine was mounted correctly

## Enabling User Intgration


* Edit the `clipster.rb` initializer to enable user integration with Clipster.
    * set `config.associates_clip_with_user = true`
    * set `config.user_class = "YourUserClass"` if your users class is something other than `User`.    NOTE: user_class must be a string.
    * set `config.user_display_attribute = "display field"` if your display field is something other than `email`.
    * NOTE: Clipster's user integration default settings are set up for [Devise](https://github.com/plataformatec/devise). Following the standard Devise install and enabling `config.associates_clip_with_user = true` is the minimum necessary to enable user integration.

Restart your application and you should be able to access the engine at http://domain.tld/clipster

## API

Clipster has both XML and JSON API support. Using the API you can create, view, search, and browse clips. Visit the [wiki page](https://github.com/kwbock/clipster/wiki/API) for examples.

### Contributing

Please see the [contribution guidelines](https://github.com/kwbock/clipster/blob/master/CONTRIBUTION_GUIDELINES.md).

### Upgrade Notes

* v0.4.1 may break backwards compatibility due to some changes to the Clip model. It may be best to start with a fresh clips table with 0.4.1. 

### Created Using
* [Alertify](https://github.com/fabien-d/alertify.js/)
* [Bootstrap](http://twitter.github.com/bootstrap/)
* [CodeRay](http://coderay.rubychan.de/)
* [Database Cleaner](https://github.com/bmabey/database_cleaner)
* [DynamicForm](https://github.com/joelmoss/dynamic_form)
* [Factory Girl](https://github.com/thoughtbot/factory_girl)
* [jQuery for Rails](https://github.com/indirect/jquery-rails)
* [Kaminari](https://github.com/amatsuda/kaminari)
* [RSpec for Rails](https://github.com/rspec/rspec-rails)
* [Ruby on Rails](http://rubyonrails.org/)
* [Sqlite](https://www.sqlite.org/)
* [Whenever](https://github.com/javan/whenever)
* [Zero Clipboard](https://github.com/jonrohan/ZeroClipboard)