stripe_local 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae0a73dda734ad56a0fef09489b79ea06f339b19
-  data.tar.gz: 58b6831c0ef5cbbb834e68e4972f6958c45b60ae
+  metadata.gz: c55acbf30f1906db9db8f6a78582a497f71cd50e
+  data.tar.gz: 1abc73fdd8f218c39284ad658892563d8c12be6b
 SHA512:
-  metadata.gz: 6ec4268e51a6f3db8fd413e8cce695269abf324041f26b2a64cfbb8fe9fd4ebbef1bb94c130642d9df95a73df4ae04a688159ae7ce8e38a52dc845c2e469f91e
-  data.tar.gz: 7c46dd84d7a868e8001238461594e630ec5ae3d1c078649e897b206982cd8d4876367da076d2cedbf0f695545045b99474c461dad2c7a0841845851d9e17ec82
+  metadata.gz: 89dc83ce29cfbb60612eb36ff3edf98a7ea0104d1a79bc35a873f3f45b4d1fbb46bd1ce3c4203f9d4fc34cba992ce517f256b588ca75e918f0c695462cac5779
+  data.tar.gz: 7bff5d0a529f5204ea3bf95207b863a38c3ce31aa85d8c0f6e7f9c97419f3de5d3b711cb8453a58dd851450cbc97dced00cf79f40f6567fd01d06fe137f78346

data/README.md

@@ -3,11 +3,57 @@
 A rails engine that maintains a local store of all your Stripe resources, keeping everything up to date with Stripe via their API and Webhook service.
 Manages the complexities of keeping two data sources in sync while providing the speed and simplicity of dealing with purely local data in a purely synchronous fashion.
 
-## <b style="color:red;">[</b>UNDER CONSTRUCTION<b style="color:red;">]</b>     Not in running condition!
+## <b style="color:red;">[</b>UNDER CONSTRUCTION<b style="color:red;">]</b>
+### Not in running condition!
 
-StripeLocal is an attempt at extracting a framework for Stripe Integration that I have found myself building into several large scale CRM projects.  It is my first Rails Engine and I am still learning the ends and outs of Engine building. If you find something I am doing terribly wrong, please bring it to my attention by opening an issue. I appreciate your help.
+I had considered waiting to open source this project untill it was something I would be proud to put my name on.  However, my free time is limited and there is no telling how long it might have taken me.
+
+My hope is that some of you will see some potential and dig in to help me get it working.  Please don't be shy, I don't claim to be an expert and I am open to your ideas for improvement.
+
+StripeLocal is an extraction of a framework for Stripe Integration that I have built into several large CRM projects.  There are likely some places in the code that still rely on the application it was extracted from. If you find such code please create an issue or fix it yourself and submit a pull request.
+
+This is my first Rails Engine and I am still learning the ends and outs of building an engine. If you find something I am doing terribly wrong, please bring it to my attention by opening an issue. I appreciate your help.
+
+
+### Pull Requests are highly encouraged!
+Feel free to fork and hack. You are of course welcome to do want you want with the code. However, I do plan to stay active in developing this code base and would like to see it become a real community effort.
+
+### How I see it
+
+The gem is hosted at [Rubygems.org](https://rubygems.org/gems/stripe_local) like any other gem and is available for use in a Rails project by including it in your gem file
+
+    gem 'stripe_local'
+
+After a `bundle install` you'll need to generate, and run the migrations..
+
+    rake stripe_local:install:migrations && rake db:migrate
+
+Stripe\_local integrates with your application via a _customer class_
+
+The _customer class_ does not need to be named *Customer*.  It just needs to be an active record class and contain a call to a special class macro in its definition
+
+    class ClassName < ActiveRecord::Base
+      stripe_customer
+    end
+
+this essentially mixes in a few modules which add a one-to-one relationship with a `Stripe::Customer` and form a `SimpleDelegator` *like* relationship.
+
+Once one of your *customers* has a `Stripe::Customer` you may call methods on your object as if it were itself a `Stripe::Customer`
+
+Use the generated `signup` instance method to create a `Stripe::Customer` for the object
+
+    my_client.signup({
+      card: "card_token",
+      plan: "plan_id",
+      coupon: "if you want",
+      lines: [
+        [10099, "this will be a line item on the initial invoice"],
+        [100, "optional array of (amount,description) tuples"]
+      ]
+    })
+
+    my_client.account_balance  #=> 0
 
-#### Feel free to fork and hack.  I'm also happy to accept pull requests...
 
 
 

data/app/models/stripe_local/customer.rb

@@ -4,7 +4,7 @@ module StripeLocal
 
     self.primary_key = :id
 
-    has_one    :model, inverse_of: :customer, class_name: "::#{StripeLocal::model_class}"
+    belongs_to :model, inverse_of: :customer, class_name: "::#{StripeLocal::model_class}"
 
     has_many   :cards, inverse_of: :customer
 
@@ -14,7 +14,9 @@ module StripeLocal
 
     has_one    :subscription, inverse_of: :customer
 
-    has_one    :plan, through: :subscription, source: :plan
+    has_one    :plan, through: :subscription,
+                   inverse_of: :members,
+                       source: :plan
 
     class<<self
       #=!=#>>>
@@ -91,6 +93,7 @@ module StripeLocal
 #   t.string   :description
 #   t.string   :email
 #   t.text     :metadata
+#   t.integer  :model_id
 #   t.timestamps
 
 #=¡=>>>

data/app/models/stripe_local/plan.rb

@@ -5,6 +5,9 @@ module StripeLocal
     self.primary_key = :id
 
     has_many :subscriptions, inverse_of: :plan
+    has_many :members, through: :subscriptions,
+                    inverse_of: :plan,
+                        source: :customer
 
     class<<self
       def create object

data/app/services/stripe_local/job_queue.rb

@@ -0,0 +1,7 @@
+module StripeLocal
+  class JobQueue
+
+
+
+  end
+end

data/db/migrate/20131122063517_load_stripe_tables.rb

@@ -7,11 +7,13 @@ class LoadStripeTables < ActiveRecord::Migration
       t.boolean :delinquent
       t.string  :description
       t.string  :email
+      t.integer :model_id
       t.text    :metadata
 
       t.timestamps
     end
 		add_index :stripe_local_customers, :id, unique: true
+		add_index :stripe_local_customers, :model_id
 
     create_table :stripe_local_cards, id: false do |t|
       t.string     :id, primary_key: true

data/lib/stripe_local/version.rb

@@ -1,3 +1,3 @@
 module StripeLocal
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20131122104223) do
+ActiveRecord::Schema.define(version: 20131122063517) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -22,7 +22,6 @@ ActiveRecord::Schema.define(version: 20131122104223) do
     t.string   "password"
     t.datetime "created_at"
     t.datetime "updated_at"
-    t.string   "stripe_customer_id"
   end
 
   create_table "stripe_local_balances", force: true do |t|
@@ -99,12 +98,14 @@ ActiveRecord::Schema.define(version: 20131122104223) do
     t.boolean  "delinquent"
     t.string   "description"
     t.string   "email"
+    t.integer  "model_id"
     t.text     "metadata"
     t.datetime "created_at"
     t.datetime "updated_at"
   end
 
   add_index "stripe_local_customers", ["id"], name: "index_stripe_local_customers_on_id", unique: true, using: :btree
+  add_index "stripe_local_customers", ["model_id"], name: "index_stripe_local_customers_on_model_id", using: :btree
 
   create_table "stripe_local_discounts", force: true do |t|
     t.string   "coupon_id"

data/spec/dummy/log/development.log

@@ -1288,3 +1288,99 @@ Migrating to AddStripeCustomerIdToClients (20131122104223)
   StripeLocal::Customer Load (1.0ms)  SELECT "stripe_local_customers".* FROM "stripe_local_customers" WHERE "stripe_local_customers"."id" = $1 ORDER BY "stripe_local_customers"."id" ASC LIMIT 1  [["id", "cus_2zIbb2qmfw4KLn"]]
   StripeLocal::Invoice Load (2.4ms)  SELECT "stripe_local_invoices".* FROM "stripe_local_invoices" WHERE "stripe_local_invoices"."customer_id" = $1  [["customer_id", "cus_2zIbb2qmfw4KLn"]]
   StripeLocal::Plan Load (1.3ms)  SELECT "stripe_local_plans".* FROM "stripe_local_plans" INNER JOIN "stripe_local_subscriptions" ON "stripe_local_plans"."id" = "stripe_local_subscriptions"."plan_id" WHERE "stripe_local_subscriptions"."customer_id" = $1 ORDER BY "stripe_local_plans"."id" ASC LIMIT 1  [["customer_id", "cus_2zIbb2qmfw4KLn"]]
+  ActiveRecord::SchemaMigration Load (2.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to AddStripeCustomerIdToClients (20131122104223)
+   (0.1ms)  BEGIN
+   (8.1ms)  ALTER TABLE "clients" DROP "stripe_customer_id"
+  SQL (2.5ms)  DELETE FROM "schema_migrations" WHERE "schema_migrations"."version" = '20131122104223'
+   (0.5ms)  COMMIT
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to LoadStripeTables (20131122063517)
+   (0.1ms)  BEGIN
+   (6.0ms)  DROP TABLE "stripe_local_balances"
+   (0.1ms)  DROP INDEX "index_transactions_on_source_id_and_source_type"
+   (0.1ms)  DROP INDEX "index_stripe_local_transactions_on_status"
+   (0.1ms)  DROP INDEX "index_stripe_local_transactions_on_id"
+   (0.4ms)  DROP TABLE "stripe_local_transactions"
+   (0.1ms)  DROP INDEX "index_stripe_local_transfers_on_transaction_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_transfers_on_status"
+   (0.1ms)  DROP INDEX "index_stripe_local_transfers_on_id"
+   (0.3ms)  DROP TABLE "stripe_local_transfers"
+   (0.1ms)  DROP INDEX "index_stripe_local_charges_on_transaction_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_charges_on_invoice_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_charges_on_customer_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_charges_on_card_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_charges_on_id"
+   (0.5ms)  DROP TABLE "stripe_local_charges"
+   (0.1ms)  DROP INDEX "index_stripe_local_line_items_on_invoice_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_line_items_on_id"
+   (0.5ms)  DROP TABLE "stripe_local_line_items"
+   (0.1ms)  DROP INDEX "index_stripe_local_invoices_on_customer_id"
+   (0.2ms)  DROP INDEX "index_stripe_local_invoices_on_id"
+   (2.1ms)  DROP TABLE "stripe_local_invoices"
+   (0.2ms)  DROP INDEX "index_stripe_local_subscriptions_on_plan_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_subscriptions_on_customer_id"
+   (0.6ms)  DROP TABLE "stripe_local_subscriptions"
+   (0.2ms)  DROP INDEX "index_stripe_local_discounts_on_coupon_id_and_subscription_id"
+   (0.5ms)  DROP TABLE "stripe_local_discounts"
+   (0.2ms)  DROP INDEX "index_stripe_local_coupons_on_id"
+   (0.4ms)  DROP TABLE "stripe_local_coupons"
+   (0.1ms)  DROP INDEX "index_stripe_local_plans_on_id"
+   (1.0ms)  DROP TABLE "stripe_local_plans"
+   (0.2ms)  DROP INDEX "index_stripe_local_cards_on_customer_id"
+   (0.1ms)  DROP INDEX "index_stripe_local_cards_on_id"
+   (0.3ms)  DROP TABLE "stripe_local_cards"
+   (0.1ms)  DROP INDEX "index_stripe_local_customers_on_id"
+   (0.3ms)  DROP TABLE "stripe_local_customers"
+  SQL (0.3ms)  DELETE FROM "schema_migrations" WHERE "schema_migrations"."version" = '20131122063517'
+   (53.7ms)  COMMIT
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to LoadStripeTables (20131122063517)
+   (0.1ms)  BEGIN
+   (5.3ms)  CREATE TABLE "stripe_local_customers" ("id" character varying(255), "account_balance" integer, "default_card" character varying(255), "delinquent" boolean, "description" character varying(255), "email" character varying(255), "model_id" integer, "metadata" text, "created_at" timestamp, "updated_at" timestamp) 
+   (0.6ms)  CREATE UNIQUE INDEX "index_stripe_local_customers_on_id" ON "stripe_local_customers" ("id")
+   (0.5ms)  CREATE INDEX "index_stripe_local_customers_on_model_id" ON "stripe_local_customers" ("model_id")
+   (1.1ms)  CREATE TABLE "stripe_local_cards" ("id" character varying(255), "customer_id" character varying(255), "name" character varying(255), "exp_month" integer, "exp_year" integer, "brand" character varying(255), "last4" character varying(255), "cvc_check" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (0.4ms)  CREATE UNIQUE INDEX "index_stripe_local_cards_on_id" ON "stripe_local_cards" ("id")
+   (0.5ms)  CREATE INDEX "index_stripe_local_cards_on_customer_id" ON "stripe_local_cards" ("customer_id")
+   (2.0ms)  CREATE TABLE "stripe_local_plans" ("id" character varying(255), "name" character varying(255), "amount" integer, "interval" character varying(255), "interval_count" integer DEFAULT 1, "trial_period_days" integer DEFAULT 0, "currency" character varying(255) DEFAULT 'usd', "synced" boolean DEFAULT 'f', "created_at" timestamp, "updated_at" timestamp) 
+   (0.6ms)  CREATE UNIQUE INDEX "index_stripe_local_plans_on_id" ON "stripe_local_plans" ("id")
+   (1.3ms)  CREATE TABLE "stripe_local_coupons" ("id" character varying(255), "percent_off" integer, "amount_off" integer, "currency" character varying(255) DEFAULT 'usd', "duration" character varying(255), "redeem_by" timestamp, "max_redemptions" integer, "times_redeemed" integer DEFAULT 0, "duration_in_months" integer, "synced" boolean DEFAULT 'f', "created_at" timestamp, "updated_at" timestamp) 
+   (0.6ms)  CREATE UNIQUE INDEX "index_stripe_local_coupons_on_id" ON "stripe_local_coupons" ("id")
+   (5.5ms)  CREATE TABLE "stripe_local_discounts" ("id" serial primary key, "coupon_id" character varying(255), "subscription_id" character varying(255), "start" timestamp, "end" timestamp, "created_at" timestamp, "updated_at" timestamp) 
+   (0.6ms)  CREATE INDEX "index_stripe_local_discounts_on_coupon_id_and_subscription_id" ON "stripe_local_discounts" ("coupon_id", "subscription_id")
+   (2.1ms)  CREATE TABLE "stripe_local_subscriptions" ("id" serial primary key, "customer_id" character varying(255), "plan_id" character varying(255), "status" character varying(255), "quantity" integer DEFAULT 1, "start" timestamp, "canceled_at" timestamp, "ended_at" timestamp, "current_period_start" timestamp, "current_period_end" timestamp, "trial_start" timestamp, "trial_end" timestamp, "created_at" timestamp, "updated_at" timestamp) 
+   (0.6ms)  CREATE INDEX "index_stripe_local_subscriptions_on_customer_id" ON "stripe_local_subscriptions" ("customer_id")
+   (0.8ms)  CREATE INDEX "index_stripe_local_subscriptions_on_plan_id" ON "stripe_local_subscriptions" ("plan_id")
+   (1.6ms)  CREATE TABLE "stripe_local_invoices" ("id" character varying(255), "customer_id" character varying(255), "amount_due" integer, "subtotal" integer, "total" integer, "attempted" boolean, "attempt_count" integer, "paid" boolean, "closed" boolean, "date" timestamp, "period_start" timestamp, "period_end" timestamp, "currency" character varying(255) DEFAULT 'usd', "starting_balance" integer, "ending_balance" integer, "charge_id" character varying(255), "discount" integer DEFAULT 0, "application_fee" integer, "next_payment_attempt" timestamp, "created_at" timestamp, "updated_at" timestamp) 
+   (0.5ms)  CREATE UNIQUE INDEX "index_stripe_local_invoices_on_id" ON "stripe_local_invoices" ("id")
+   (0.5ms)  CREATE INDEX "index_stripe_local_invoices_on_customer_id" ON "stripe_local_invoices" ("customer_id")
+   (1.4ms)  CREATE TABLE "stripe_local_line_items" ("id" character varying(255), "invoice_id" character varying(255), "subscription" boolean DEFAULT 't', "amount" integer, "currency" character varying(255) DEFAULT 'usd', "proration" boolean, "period_start" timestamp, "period_end" timestamp, "quantity" integer, "plan_id" character varying(255), "description" character varying(255), "metadata" text, "created_at" timestamp, "updated_at" timestamp) 
+   (0.6ms)  CREATE UNIQUE INDEX "index_stripe_local_line_items_on_id" ON "stripe_local_line_items" ("id")
+   (0.6ms)  CREATE INDEX "index_stripe_local_line_items_on_invoice_id" ON "stripe_local_line_items" ("invoice_id")
+   (1.5ms)  CREATE TABLE "stripe_local_charges" ("id" character varying(255), "card_id" character varying(255), "customer_id" character varying(255), "invoice_id" character varying(255), "transaction_id" character varying(255), "amount" integer, "captured" boolean DEFAULT 't', "refunded" boolean DEFAULT 'f', "paid" boolean, "created" timestamp, "currency" character varying(255) DEFAULT 'usd', "amount_refunded" integer DEFAULT 0, "description" character varying(255), "failure_code" character varying(255), "failure_message" character varying(255), "metadata" text, "created_at" timestamp, "updated_at" timestamp) 
+   (0.5ms)  CREATE UNIQUE INDEX "index_stripe_local_charges_on_id" ON "stripe_local_charges" ("id")
+   (0.5ms)  CREATE INDEX "index_stripe_local_charges_on_card_id" ON "stripe_local_charges" ("card_id")
+   (0.5ms)  CREATE INDEX "index_stripe_local_charges_on_customer_id" ON "stripe_local_charges" ("customer_id")
+   (0.6ms)  CREATE INDEX "index_stripe_local_charges_on_invoice_id" ON "stripe_local_charges" ("invoice_id")
+   (0.6ms)  CREATE INDEX "index_stripe_local_charges_on_transaction_id" ON "stripe_local_charges" ("transaction_id")
+   (1.0ms)  CREATE TABLE "stripe_local_transfers" ("id" character varying(255), "amount" integer, "date" timestamp, "status" character varying(255), "transaction_id" character varying(255), "description" character varying(255), "metadata" text, "created_at" timestamp, "updated_at" timestamp) 
+   (0.7ms)  CREATE UNIQUE INDEX "index_stripe_local_transfers_on_id" ON "stripe_local_transfers" ("id")
+   (0.8ms)  CREATE INDEX "index_stripe_local_transfers_on_status" ON "stripe_local_transfers" ("status")
+   (0.5ms)  CREATE INDEX "index_stripe_local_transfers_on_transaction_id" ON "stripe_local_transfers" ("transaction_id")
+   (1.4ms)  CREATE TABLE "stripe_local_transactions" ("id" character varying(255), "amount" integer, "available_on" timestamp, "created" timestamp, "fee" integer, "net" integer, "source_id" character varying(255), "source_type" character varying(255), "status" character varying(255), "description" character varying(255), "created_at" timestamp, "updated_at" timestamp) 
+   (0.5ms)  CREATE UNIQUE INDEX "index_stripe_local_transactions_on_id" ON "stripe_local_transactions" ("id")
+   (0.5ms)  CREATE INDEX "index_stripe_local_transactions_on_status" ON "stripe_local_transactions" ("status")
+   (0.5ms)  CREATE INDEX "index_transactions_on_source_id_and_source_type" ON "stripe_local_transactions" ("source_id", "source_type")
+   (1.3ms)  CREATE TABLE "stripe_local_balances" ("id" serial primary key, "available" integer, "pending" integer, "created_at" timestamp, "updated_at" timestamp) 
+  SQL (0.8ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20131122063517"]]
+   (1.0ms)  COMMIT
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"