stripe_wrapper 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6fb066fee9e3d91f471a5a9287b4fc5a7e28bf4
-  data.tar.gz: 6cf82ce54862e97ccb29e10d16ff9f8dd9a0f112
+  metadata.gz: 608895732525b9ea768c68e4e6a2abd91d5b5cd2
+  data.tar.gz: 1642287f1f67a297ec72ca68e5398c299f2a994c
 SHA512:
-  metadata.gz: e720529b1737ffad511db9c716426b66f456eafb955a9a5763fa5c7ac9f0bc5f9803bb089b6dfa6a7b48d2e9029d235cfdcbefbb85580bef711713d239071460
-  data.tar.gz: 19f0a04ab0284c64f54c35f657f0b438fb1e5614362517970fffa6e90058e3109dad9e2b340e058ab8cdac35864c6ff13da816811ca4548bcd621136a5b5bd68
+  metadata.gz: 235468ffcff1e8e40b28e2cb21a0ef9b82cf894994da7b2b38a167b1d7e14dc09bb6b207d66091174d51ed1e903d0b9620edc2aae40111b77bbd38f0fd35c8f2
+  data.tar.gz: 65326c20b042d0f0650a8db42724b4561b117123c2c0d5e6a2e2a67545bd9b1d664cb8eca456d6dc702e83ff9caf941a3ae91e49dede5e47a5906e3d69ae4ba8

data/README.md

@@ -1,8 +1,6 @@
 # StripeWrapper
-Short description and motivation.
+StripeWrapper is a Wrapper around the Stripe Gem, simplifying the amount of work you need to do in order to generate charges and customers using [Stripe](https://www.stripe.com). The main purpose of this gem is to allow you to implement an easy solution using [Stripe](https://www.stripe.com) in just a few lines of code.
 
-## Usage
-How to use my plugin.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -16,13 +14,89 @@ And then execute:
 $ bundle
 ```
 
+
 Or install it yourself as:
 ```bash
 $ gem install stripe_wrapper
 ```
 
+Then execute the installer in order to generate the migrations and mount the engine
+```bash
+$ rails generate stripe_wrapper:install
+```
+
+This will copy the two core models of the Wrapper:
+
+1. Charges (`StripeWrapper::Charge`)
+
+2. Customers (`StripeWrapper::Customer`)
+
+You can also copy all the controllers, views and models by running in order to customize the views and scaffolds as you like
+```
+$ rails generate stripe_wrapper:copy_files
+```
+
+## Usage
+After installing the gem and running the generators, using this gem is very easy. These are the steps you must follow in order to use it.
+
+1. You must add the main helper to your main_app's ApplicationController, as follows:
+
+  ```ruby
+  class ApplicationController < ActionController::Base
+      include StripeWrapper::StripeWrapperHelper
+      #More Code
+  end
+  ```
+
+2. Go to an action where you decide to charge the customer. Here you must set the amount you're charging your customer. You can do this easily by using the following method:
+
+  ```ruby
+    def my_cool_action
+      stripe_set_amount(@amount)
+    end
+  ```
+
+3. In the corresponding view, render stripe_wrapper's partial, passing as argument the URL you desire to be redirected to after the charge is processed. 
+
+  ```ruby
+  = render partial: 'stripe_wrapper/charges/pay',locals:{redirect_url: your_cool_path}
+  ```
+
+4. After the payment is processed, you will be redirected to the path you specified, with the charge_id param as response. Let's say you were redirected to the action payment_processed, you'd get the Charge ID like this
+
+  ```ruby
+  def payment_processed
+    charge_id = params[:charge_id]
+    redirect_to root_path, notice: "Payment with ID #{charge_id} was created"
+  end
+  ```
+
+5. You can access stripe_wrapper's dashboard by going to the engine's route (by default `/stripe_wrapper`). You'll be able to see the scaffolds of both Charges and Customers.
+
 ## Contributing
 Contribution directions go here.
 
+## TODO
+
+Tests are missing, and ideally charts are needed in both scaffolds
+
+## Development
+
+To be more clear - this is the for when you are working on this gem. Not for when you are implementing it into your Rails app.
+
+First, to get started, migrate and seed the database (SQLite by default):
+
+```bash
+bundle
+# Create, migrate, and seed the development database with fake forum users, topics, and posts:
+rake db:create db:migrate db:seed
+```
+
+Then, start the dummy app server:
+
+```bash
+rake dev:server
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/stripe_wrapper/file_copy/file_copy_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+module StripeWrapper
+  class FileCopyGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def copy_files
+      # controllers
+      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "app", "controllers", "stripe_wrapper")
+      target = File.join(Rails.root, "app", "controllers", "stripe_wrapper")
+      FileUtils.cp_r source, target
+      # models
+      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "app", "models", "stripe_wrapper")
+      target = File.join(Rails.root, "app", "models", "stripe_wrapper")
+      FileUtils.cp_r source, target
+      # views
+      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "app", "views", "stripe_wrapper")
+      target = File.join(Rails.root, "app", "views", "stripe_wrapper")
+      FileUtils.cp_r source, target
+      # locales
+      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "config", "locales", "en.yml")
+      target = File.join(Rails.root, "config", "locales", "stripe_wrapper.en.yml")
+      FileUtils.cp source, target
+      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "config", "locales", "es.yml")
+      target = File.join(Rails.root, "config", "locales", "stripe_wrapper.es.yml")
+      FileUtils.cp source, target
+    end
+  end
+end

data/lib/generators/stripe_wrapper/install/install_generator.rb

@@ -10,27 +10,5 @@ module StripeWrapper
     def mount_engine
       route 'mount StripeWrapper::Engine => "/stripe_wrapper", as: "stripe_wrapper"'
     end
-
-    def copy_files
-      # controllers
-      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "app", "controllers", "stripe_wrapper")
-      target = File.join(Rails.root, "app", "controllers", "stripe_wrapper")
-      FileUtils.cp_r source, target
-      # models
-      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "app", "models", "stripe_wrapper")
-      target = File.join(Rails.root, "app", "models", "stripe_wrapper")
-      FileUtils.cp_r source, target
-      # views
-      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "app", "views", "stripe_wrapper")
-      target = File.join(Rails.root, "app", "views", "stripe_wrapper")
-      FileUtils.cp_r source, target
-      # locales
-      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "config", "locales", "en.yml")
-      target = File.join(Rails.root, "config", "locales", "stripe_wrapper.en.yml")
-      FileUtils.cp source, target
-      source = File.join(Gem.loaded_specs["stripe_wrapper"].full_gem_path, "config", "locales", "es.yml")
-      target = File.join(Rails.root, "config", "locales", "stripe_wrapper.es.yml")
-      FileUtils.cp source, target
-    end
   end
 end

data/lib/stripe_wrapper.rb

@@ -5,8 +5,9 @@ module StripeWrapper
   Stripe.api_key = ENV["STRIPE_KEY"]
 
   # Source is either a customer or a token
-  def self.create_charge(customer=nil,source=nil,amount=0,currency='clp',metadata={},description='')
+  def self.create_charge(customer=nil,source=nil,amount=nil,currency='clp',metadata={},description='')
     #Metadata must be a hash. Example: :metadata => {'order_id' => '6735'}
+    return false if amount.blank?()
     Stripe::Charge.create({
       amount: amount,
       currency: currency,

data/lib/stripe_wrapper/version.rb

@@ -1,3 +1,3 @@
 module StripeWrapper
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - John Peebles | @waclock
@@ -378,6 +378,7 @@ files:
 - config/routes.rb
 - db/migrate/20161215195603_create_stripe_wrapper_customers.rb
 - db/migrate/20161215195608_create_stripe_wrapper_charges.rb
+- lib/generators/stripe_wrapper/file_copy/file_copy_generator.rb
 - lib/generators/stripe_wrapper/install/USAGE
 - lib/generators/stripe_wrapper/install/install_generator.rb
 - lib/stripe_wrapper.rb