deals 0.0.1

data/README.md

@@ -0,0 +1,60 @@
+Deals Gem (Engine)
+========
+
+Modular / mountable Deals API. Features:
+
+* RESTful webservice for accessing deals
+
+* Fully defined backend RailsAdmin interface for adding deals on the backend
+
+
+Announcements
+========
+
+* Review the installation process below.
+ 
+
+Installation
+========
+
+* First create a new rails project:
+        rails new sweet_app
+
+* Config your database.yml and create the databases
+		
+* Add to Gemfile:
+    
+        gem "deals"
+ 
+* Next, run bundle install:
+
+        bundle install
+
+* Next, run the deals install command:
+
+        deals install
+
+(NOTE: If you run into an error saying that deals gem is missing, use bundle exec deals install)
+
+* Deals is now installed and ready 
+
+* Deals API is located at /deals
+
+* To view API end points run: rake routes
+
+More Details
+========
+
+Visit the project website [here][project-website].
+
+[project-website]: http://deals.barrettgriffith.com/
+
+TODO
+========
+
+* Add multiple photos for each deal
+
+Copyright
+========
+
+Copyright (c) 2012 Barrett Griffith. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Deals'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/deals/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/deals/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+
+end

data/app/controllers/categories_controller.rb

@@ -0,0 +1,8 @@
+class CategoriesController < ActionController::Base
+  respond_to :json
+
+  def index
+    @categories = Category.all.map { |c| { 'id' => c.id, :name => c.name, :slug => c.slug} }
+    respond_with(@categories)
+  end
+end

data/app/controllers/deals/application_controller.rb

@@ -0,0 +1,4 @@
+module Deals
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/deals_controller.rb

@@ -0,0 +1,30 @@
+class DealsController < ActionController::Base
+  respond_to :json
+
+  def index
+    place = params[:place]
+    category = params[:category]
+
+    if place.present?
+      places = Place.where(:slug => place)
+      place_id = places.first.id if places.any?
+    end
+
+    if category.present?
+      categories = Category.where(:slug => category)
+      category_id = categories.first.id if categories.any?
+    end
+
+    if place_id.present? && category_id.present? 
+      @deals = Deal.where(:place_id => place_id, :category_id => category_id)
+    elsif place_id.present?
+      @deals = Deal.where(:place_id => place_id)
+    elsif category_id.present?
+      @deals = Deal.where(:category_id => category_id)
+    else
+      @deals = Deal.all
+    end
+
+    respond_with(@deals)
+  end
+end

data/app/controllers/home_controller.rb

@@ -0,0 +1,8 @@
+class HomeController < ActionController::Base
+
+  layout 'application'
+
+  def index
+  end
+
+end

data/app/controllers/places_controller.rb

@@ -0,0 +1,8 @@
+class PlacesController < ActionController::Base
+  respond_to :json
+
+  def index
+    @places = Place.all.map { |p| { 'id' => p.id, :name => p.name, :slug => p.slug} }
+    respond_with(@places)
+  end
+end

data/app/helpers/deals/application_helper.rb

@@ -0,0 +1,4 @@
+module Deals
+  module ApplicationHelper
+  end
+end

data/app/models/category.rb

@@ -0,0 +1,4 @@
+class Category < ActiveRecord::Base
+  has_many :deals
+  attr_accessible :name, :slug
+end

data/app/models/deal.rb

@@ -0,0 +1,9 @@
+class Deal < ActiveRecord::Base
+  mount_uploader :photo, PhotoUploader
+  
+  belongs_to :place
+  belongs_to :category
+  attr_accessible :photo, :photo_cache, :remove_photo, :commission, :deleted_at, :place_id, :category_id, :description, :email, :first_line, :phone, :second_line, :website
+  
+
+end

data/app/models/place.rb

@@ -0,0 +1,4 @@
+class Place < ActiveRecord::Base
+  has_many :deals
+  attr_accessible :name, :slug
+end

data/app/uploaders/photo_uploader.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+class PhotoUploader < CarrierWave::Uploader::Base
+
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::MiniMagick
+
+  # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
+  # include Sprockets::Helpers::RailsHelper
+  # include Sprockets::Helpers::IsolatedHelper
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process :scale => [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  # version :thumb do
+  #   process :scale => [50, 50]
+  # end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_white_list
+    %w(jpg jpeg gif png)
+  end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+
+end

data/app/views/layouts/deals/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Deals</title>
+  <%= stylesheet_link_tag    "deals/application", :media => "all" %>
+  <%= javascript_include_tag "deals/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/deals

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+begin
+  require 'deals/cli'
+rescue LoadError => e
+warn 'Could not load "deals/cli"'
+  exit -1
+end
+
+Deals::CLI.start

data/config/routes.rb

@@ -0,0 +1,7 @@
+Deals::Engine.routes.draw do
+  match '/places' => 'places#index', :defaults => { :format => 'json' }
+  match '/categories' => 'categories#index', :defaults => { :format => 'json' }
+  match '/for/:category' => 'deals#index', :defaults => { :format => 'json' }
+  match '/:place' => 'deals#index', :defaults => { :format => 'json' } 
+  match '/:place/:category' => 'deals#index', :defaults => { :format => 'json' }
+end

data/db/migrate/20121212014610_create_deals.rb

@@ -0,0 +1,20 @@
+class CreateDeals < ActiveRecord::Migration
+  def change
+    create_table :deals do |t|
+      t.string :first_line
+      t.string :second_line
+      t.text :description
+      t.string :email
+      t.string :phone
+      t.string :website
+      t.float :commission
+      t.datetime :deleted_at
+      t.references :place
+      t.references :category
+
+      t.timestamps
+    end
+    add_index :deals, :place_id
+    add_index :deals, :category_id
+  end
+end

data/db/migrate/20121212015114_create_categories.rb

@@ -0,0 +1,10 @@
+class CreateCategories < ActiveRecord::Migration
+  def change
+    create_table :categories do |t|
+      t.string :name
+      t.string :slug
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20121212015129_create_places.rb

@@ -0,0 +1,10 @@
+class CreatePlaces < ActiveRecord::Migration
+  def change
+    create_table :places do |t|
+      t.string :name
+      t.string :slug
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20121218023245_add_photo_to_deals.rb

@@ -0,0 +1,5 @@
+class AddPhotoToDeals < ActiveRecord::Migration
+  def change
+    add_column :deals, :photo, :string
+  end
+end

data/lib/deals.rb

@@ -0,0 +1,4 @@
+require "deals/engine"
+
+module Deals
+end

data/lib/deals/cli.rb

@@ -0,0 +1,96 @@
+require 'thor'
+
+module Deals
+  class CLI < Thor
+    include Thor::Actions
+
+    desc "install", "install and configure deals"
+    def install
+      if already_installed?
+        update
+      else        
+        inject_devise
+        inject_rails_admin
+        inject_carrierwave
+        run('bundle install')
+        run('rake deals:install:migrations')
+        run('rake db:migrate')   
+        run('rails generate devise:install')
+        run('rails generate devise User') 
+        run('rake db:migrate')      
+        run('rails g rails_admin:install')
+        run('rake db:migrate')      
+        mount_deals_route
+        welcome
+      end
+    end
+    
+    desc "update", "update deals"
+    def update
+      say "Deals install detected"
+      say "Updating current Deals install"
+      run('rake deals:install:migrations')
+      say_upgraded
+    end
+
+    desc "inject_devise", "add devise"
+    def inject_devise
+      puts 'add reference to devise in GEMFILE'
+      insert_into_file "Gemfile", "gem 'devise'\n", :after => "source 'https://rubygems.org'\n"
+    end
+
+    
+    desc "inject_rails_admin", "add rails_admin"
+    def inject_rails_admin
+      puts 'add reference to rails_admin in GEMFILE'
+      insert_into_file "Gemfile", "gem 'rails_admin'\n", :after => "gem 'devise'\n"
+    end
+
+    desc "inject_carrierwave", "add carrierwave"
+    def inject_carrierwave
+      puts 'add reference to carrierwave in GEMFILE'
+      insert_into_file "Gemfile", "gem 'carrierwave'\n", :after => "gem 'rails_admin'\n"
+      create_file "config/initializers/carrierwave.rb", "require 'carrierwave/orm/activerecord'"
+    end
+  
+    desc "mount_deals_route", "mount deals route"
+    def mount_deals_route
+      insert_into_file "config/routes.rb", "\n  mount Deals::Engine => '/deals', :as => 'deals'\n", :after => "Application.routes.draw do\n"
+    end
+  
+    desc "create user class", "Create a user class"
+    def create_user_class
+      run('rails generate model User')      
+    end
+    
+    desc "welcome", "invite to deals"
+    def welcome
+      say ""
+      say ""
+      say ""
+      say "******************************************************************"
+      say "******************************************************************"
+      say "Deals Successfully Installed!"
+      say "******************************************************************"
+    end
+    
+    desc "say_upgraded", "deals upgraded"
+    def say_upgraded
+      say ""
+      say ""
+      say ""
+      say "******************************************************************"
+      say "******************************************************************"
+      say "Deals Successfully Upgraded!"
+      say "******************************************************************"
+    end
+    
+    private
+    
+    def already_installed?
+      open('config/routes.rb') { |f| f.grep(/Deals\:\:Engine/) }.any?
+    end
+    
+    
+  end
+end