koudoku 0.0.3 → 0.0.4

data/app/helpers/koudoku/application_helper.rb

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

data/app/views/koudoku/subscriptions/_pricing_table.html.erb

@@ -0,0 +1,53 @@
+<ul class="thumbnails koudoku-pricing-table">
+  <% @plans.each do |plan| %>
+    <li class="span3 plan <%= 'plan-primary' if plan.id == 2 %>">
+      <div class="thumbnail">
+        <div class="caption">
+          <h2><%= plan.name %></h2>
+          <h3><%= number_to_currency(plan.price) %>/month</h3>
+          <div class="call-to-action">
+            <% if @subscription.persisted? %>
+              <% if @subscription.plan == plan %>
+                <%= form_for @subscription, url: owner_subscription_path(@owner, @subscription) do |f| %>
+                  <%= f.submit 'Selected', class: "btn btn-large", disabled: 'disabled' %>
+                <% end %>
+              <% else %>
+                <%= form_for @subscription, url: owner_subscription_path(@owner, @subscription) do |f| %>
+                  <%= f.hidden_field :plan_id, value: plan.id %>
+                  <%= f.submit @subscription.describe_difference(plan), class: "btn btn-success btn-large" %>
+                <% end %>
+              <% end %>
+            <% else %>
+              <%= link_to Koudoku.free_trial? ? 'Start Trial' : 'Upgrade', new_owner_subscription_path(@owner, plan: plan.id), class: "btn btn-success btn-large" %>
+            <% end %>
+          </div>
+          <ul class="features">
+            <% if Koudoku.free_trial? %>
+            <li class='muted'><%= Koudoku.free_trial_length %>-day Free Trial</li>
+            <% end %>
+            <li>Testing.</li>
+            <li>Testing.</li>
+            <li>Testing.</li>
+            <li>Testing.</li>
+          </ul>
+        </div>
+      </div>
+    </li>
+  <% end %>
+
+  <li class="span3 social-proof">
+    
+    <blockquote>
+    <h3>"Some Great Quote"</h3> &mdash; Person at Place
+    </blockquote>
+
+    <blockquote>
+    <h4>"This is a great service and you've been the best ever! Thanks!"</h4> &mdash; Person at Place
+    </blockquote>
+    
+    <blockquote>
+    <h4>"I love you guys and you're the best! You're the best!"</h4> &mdash; Person at Place
+    </blockquote>
+    
+  </li>
+</ul>

data/app/views/koudoku/subscriptions/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>What Plan Is Best For You?</h1>
+<%= render 'pricing_table' %>
+<p>You can also <%= link_to 'cancel your subscription', cancel_owner_subscription_path(@owner, @subscription), method: :post %>.</p>

data/app/views/koudoku/subscriptions/index.html.erb

@@ -0,0 +1,2 @@
+<h1>What Plan Is Best For You?</h1>
+<%= render 'pricing_table' %>

data/app/views/koudoku/subscriptions/new.html.erb

@@ -0,0 +1,99 @@
+<script type="text/javascript" src="https://js.stripe.com/v1/"></script>
+
+<%= form_for @subscription, url: @subscription.persisted? ? owner_subscription_path(@owner, @subscription) : owner_subscriptions_path(@owner), html: {id: 'payment-form', class: 'form-horizontal'} do |f| %>
+  <% if Koudoku.free_trial? %>
+    <h1>Start Your Free Trial</h1>
+  <% else %>
+    <h1>Upgrade Your Account</h1>
+  <% end %>
+
+  <fieldset>
+    
+    <div class="alert alert-error payment-errors"></div>
+
+    <%= f.hidden_field :plan_id %>
+
+    <div class="control-group">
+      <label class="control-label">Card Number</label>
+      <div class="controls">
+        <input type="text" size="20" autocomplete="off" class="card-number"/>
+      </div>
+    </div>
+
+    <div class="control-group">
+      <label class="control-label">Expiration (MM/YYYY)</label>
+      <div class="controls">
+        <input type="text" size="2" class="card-expiry-month input-mini"/>
+        <span> / </span>
+        <input type="text" size="4" class="card-expiry-year input-mini"/>
+      </div>
+    </div>
+
+    <div class="control-group">
+      <label class="control-label">CVC</label>
+      <div class="controls">
+        <input type="text" size="4" autocomplete="off" class="card-cvc input-small"/>
+      </div>
+    </div>
+    
+  </fieldset>
+    
+  <div class="form-actions">
+    <% if Koudoku.free_trial? %>
+      <button type="submit" class="btn btn-primary submit-button">Save Billing Information</button>
+    <% else %>
+      <button type="submit" class="btn btn-primary submit-button">Upgrade Your Account</button>
+    <% end %>
+    <%= link_to "Cancel", owner_subscriptions_path(@owner), class: 'btn' %>
+  </div>
+
+<% end %>
+
+<script type="text/javascript">
+
+  // All this code taken from Stripe's own examples at:
+  // https://stripe.com/docs/tutorials/forms .
+  
+  Stripe.setPublishableKey("<%= Koudoku.stripe_publishable_key %>");
+
+  function stripeResponseHandler(status, response) {
+
+      if (response.error) {
+          // show the errors on the form
+          $(".payment-errors").text(response.error.message).show();
+          $(".submit-button").removeAttr("disabled");
+      } else {
+          var form$ = $("#payment-form");
+          // token contains id, last4, and card type
+          // insert the token into the form so it gets submitted to the server
+          form$.append("<input type='hidden' name='subscription[credit_card_token]' value='" + response['id'] + "'/>");
+          form$.append("<input type='hidden' name='subscription[last_four]' value='" + response['last4'] + "'/>");
+          form$.append("<input type='hidden' name='subscription[card_type]' value='" + response['card_type'] + "'/>");
+          // and submit
+          form$.get(0).submit();
+      }
+  }
+
+  $(document).ready(function() {
+    
+    // By default, don't show errors.
+    $(".payment-errors").hide()
+    
+    $("#payment-form").submit(function(event) {
+
+      // disable the submit button to prevent repeated clicks
+      $('.submit-button').attr("disabled", "disabled");
+
+      Stripe.createToken({
+          number: $('.card-number').val(),
+          cvc: $('.card-cvc').val(),
+          exp_month: $('.card-expiry-month').val(),
+          exp_year: $('.card-expiry-year').val()
+      }, stripeResponseHandler);
+
+      // prevent the form from submitting with the default action
+      return false;
+    });
+  });
+
+</script>

data/app/views/koudoku/subscriptions/show.html.erb

@@ -0,0 +1,8 @@
+<h1>Thanks!</h1>
+<% if @subscription.plan.present? %>
+<p>You're subscribed to the <%= @subscription.plan.name %> plan!</p>
+<%= link_to 'Choose another plan', edit_owner_subscription_path(@owner, @subscription) %>
+<% else %>
+<p>You are not subscribed to a paid plan.</p>
+<%= link_to 'Choose a plan', edit_owner_subscription_path(@owner, @subscription) %>
+<% end %>

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

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

data/config/routes.rb

@@ -0,0 +1,11 @@
+Koudoku::Engine.routes.draw do
+  # e.g. :users
+  resources Koudoku.owner_resource, as: :owner do
+    resources :subscriptions do
+      member do
+        post :cancel
+      end
+    end
+  end
+  resources :webhooks, only: [:create]
+end

data/lib/generators/koudoku/install_generator.rb

@@ -29,17 +29,21 @@ module Koudoku
       <<-RUBY
 Koudoku.setup do |config|
   config.webhooks_api_key = "#{api_key}"
+  config.subscriptions_owned_by = :user
+  config.stripe_publishable_key = ENV['STRIPE_PUBLISHABLE_KEY']
+  config.stripe_secret_key = ENV['STRIPE_SECRET_KEY']
+  # config.free_trial_length = 30
 end
 RUBY
       end
 
       # Generate subscription.
-      generate("model", "subscription stripe_id:string plan_id:integer last_four:string coupon_id:integer current_price:float #{subscription_owner_model}_id:integer")
+      generate("model", "subscription stripe_id:string plan_id:integer last_four:string coupon_id:integer last_four:string card_type:string current_price:float #{subscription_owner_model}_id:integer")
       gsub_file "app/models/subscription.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  include Koudoku::Subscription\n\n  belongs_to :#{subscription_owner_model}\n  belongs_to :coupon\n"
       
       # Add the plans.
       generate("model", "plan name:string stripe_id:string price:float")
-      gsub_file "app/models/plan.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  belongs_to :#{subscription_owner_model}\n  belongs_to :coupon\n"
+      gsub_file "app/models/plan.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n  include Koudoku::Plan\n  belongs_to :#{subscription_owner_model}\n  belongs_to :coupon\n  has_many :subscriptions\n"
 
       # Add coupons.
       generate("model coupon code:string free_trial_length:string")
@@ -52,7 +56,7 @@ RUBY
       gsub_file "app/models/#{subscription_owner_model}.rb", /ActiveRecord::Base/, "ActiveRecord::Base\n\n  # Added by Koudoku.\n  has_one :subscription\n\n"
 
       # Add webhooks to the route.
-      gsub_file "config/routes.rb", /Application.routes.draw do/, "Application.routes.draw do\n\n  # Added by Koudoku.\n  namespace :koudoku do\n    match 'webhooks' => 'webhooks#process'\n  end\n\n"
+      gsub_file "config/routes.rb", /Application.routes.draw do/, "Application.routes.draw do\n\n  # Added by Koudoku.\n  mount Koudoku::Engine, at: \"koudoku\"\n\n"
       
       # Show the user the API key we generated.
       say "\nTo enable support for Stripe webhooks, point it to \"/koudoku/webhooks?api_key=#{api_key}\". This API key has been randomly generated, so it's unique to your application.\n\n"

data/lib/generators/koudoku/views_generator.rb

@@ -0,0 +1,28 @@
+# this generator based on rails_admin's install generator.
+# https://www.github.com/sferik/rails_admin/master/lib/generators/rails_admin/install_generator.rb
+
+require 'rails/generators'
+
+# http://guides.rubyonrails.org/generators.html
+# http://rdoc.info/github/wycats/thor/master/Thor/Actions.html
+
+module Koudoku
+  class ViewsGenerator < Rails::Generators::Base
+
+    # Not sure what this does.
+    source_root File.expand_path("../../../../app/views/koudoku/subscriptions", __FILE__)
+
+    include Rails::Generators::Migration
+
+    desc "Koudoku installation generator"
+
+    def install
+      
+      ["_pricing_table.html.erb", "edit.html.erb", "index.html.erb", "new.html.erb", "show.html.erb"].each do |file|
+        copy_file file, "app/views/koudoku/subscriptions/#{file}"
+      end
+
+    end
+
+  end
+end

data/lib/koudoku.rb

@@ -1,18 +1,55 @@
-require "koudoku/version"
-require "koudoku/subscription"
-require "koudoku/webhooks_controller"
+require "koudoku/engine"
 require "generators/koudoku/install_generator"
-
-# Load all rake tasks.
-Dir["tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)
+require "generators/koudoku/views_generator"
 
 module Koudoku
 
   mattr_accessor :webhooks_api_key
   @@webhooks_api_key = nil
   
+  mattr_accessor :subscriptions_owned_by
+  @@subscriptions_owned_by = nil
+  
+  mattr_accessor :stripe_publishable_key
+  @@stripe_publishable_key = nil
+  
+  mattr_accessor :stripe_secret_key
+  @@stripe_secret_key = nil
+  
+  mattr_accessor :free_trial_length
+  @@free_trial_length = nil
+  
   def self.setup
     yield self
+    
+    # Configure the Stripe 
+    Stripe.api_key = ENV['STRIPE_SECRET_KEY']
+  end
+  
+  # e.g. :users
+  def self.owner_resource
+    subscriptions_owned_by.to_s.pluralize.to_sym
+  end
+  
+  # e.g. :user_id
+  def self.owner_id_sym
+    # e.g. :user_id
+    (Koudoku.subscriptions_owned_by.to_s + '_id').to_sym
+  end
+  
+  def self.owner_assignment_sym
+    # e.g. :user=
+    (Koudoku.subscriptions_owned_by.to_s + '=').to_sym
+  end
+
+  # e.g. Users
+  def self.owner_class
+    # e.g. User
+    Koudoku.subscriptions_owned_by.to_s.classify.constantize
+  end
+  
+  def self.free_trial?
+    free_trial_length.to_i > 0
   end
   
 end

data/lib/koudoku/engine.rb

@@ -0,0 +1,6 @@
+require 'stripe'
+module Koudoku
+  class Engine < ::Rails::Engine
+    isolate_namespace Koudoku
+  end
+end

data/lib/koudoku/version.rb

@@ -1,3 +1,3 @@
 module Koudoku
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tasks/koudoku_tasks.rake

@@ -0,0 +1,12 @@
+namespace :koudoku do
+  desc "Install koudoku"
+  task :install do
+    system 'rails g koudoku:install'
+  end
+
+  desc "Install koudoku views for application-specific modification"
+  task :views do
+    system 'rails g koudoku:views'
+  end
+end
+

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.