stripe-cli 1.4.6 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aab8d9e0ab67ead75e2e0621a82fc7958e0e7ccc
-  data.tar.gz: 251b927fe0b90104dc2d13ecf28538822bfe9984
+  metadata.gz: afab1ce2dae3b3d4d5c028e647829d329ff2e324
+  data.tar.gz: d3a8fbcc13accd0a239dc90a3c01ccd47633d734
 SHA512:
-  metadata.gz: 50e2e74d702a9fd8aba3d30412dddafe2cbd7347a43180be919990e948f40328ff832b53a3447856e003ec342bb744d03d6372e99d7d655d50a158afc39e9088
-  data.tar.gz: 510236f8782bb51c4e0dc36867faad52217149c4dfc2f843a6cd7f7a1cd42488e7b7cf3914925a42b4b181d2fb9e9fbf8fb68dceaae77a9d2a65c07356e39a63
+  metadata.gz: 30a7abda94bd08232483b3b480e2099f00856247ad3e6749f8e56e420b530b0ad3b331b8f2ba85751794a0bf15f90d6ac3f6bbdca51e3c1fdadc2f9baa139479
+  data.tar.gz: a6b057451bf64665368bd64a755c5030b892e2b0a84456421419e5ab097b618123d4bdbf63ee83ab27450b8f971bb9440c8dfff19b7f725188bf44a210c95627

data/README.md

@@ -18,19 +18,6 @@ Note that Date/Time stamps are converted automatically.  No more Epoch/Unix time
 
     $ gem install stripe-cli
 
-
-
-you may also clone the repo and build the gem locally yourself
-
-        $ git clone https://github.com/stripe-contrib/stripe-cli.git
-        $ cd ./stripe-cli
-        $ gem build stripe-cli.gemspec
-        $ gem install stripe-cli
-
-> because RubyGems looks **first** at the **current directory** before moving on to [rubygems.org](https://rubygems.org),  that last step will install the local gem you just built.
-
-
-
 ## Configuration
 
 For authentication, pass your secret key using the `-k` or `--key` option
@@ -39,7 +26,7 @@ For authentication, pass your secret key using the `-k` or `--key` option
 
 To use a specific api version, pass in the `-v` or `--version` option
 
-    $ stripe balance_transactions list -v "2013-10-29"
+    $ stripe balance_transactions list -v "2014-08-04"
 
 You may also store default configurations in a `~/.stripecli` file that conforms to the following example
 
@@ -73,17 +60,18 @@ If you choose to go this route, make sure to add `.stripecli` to your `.gitignor
 ## Usage
 
     Commands:
-      stripe balance         # show currently available and pending balance amounts
+      stripe balance         # show currently available & pending balance amounts
       stripe cards           # find, list, create, & delete cards for both customers & recipients
       stripe charges         # find, list, create, capture, & refund charges
       stripe coupons         # find, list, create, & delete coupons
       stripe customers       # find, list, create, & delete customers
       stripe events          # find & list events
       stripe help [COMMAND]  # Describe available commands or one specific command
-      stripe invoices        # find, list, pay, and close invoices
+      stripe invoices        # find, list, pay, & close invoices
       stripe plans           # find, list, create, & delete plans
-      stripe recipients      # find, list, create & delete recipients
-      stripe subscriptions   # find, list, create, cancel & reactivate multiple subscriptions per customer
+      stripe recipients      # find, list, create, & delete recipients
+      stripe refunds         # find, list, & create refunds
+      stripe subscriptions   # find, list, create, cancel, & reactivate multiple subscriptions per customer
       stripe tokens          # find & create tokens for bank accounts & credit cards
       stripe transactions    # find & list balance transactions
       stripe transfers       # find, list, & create transfers
@@ -101,6 +89,18 @@ or
 
     $ stripe charges create [--amount=AMOUNT][--customer=CUST_ID]
 
+### Interactive Menus
+
+Passing NO (or partial) arguments to any operation, will trigger an interactive menu
+
+    $ stripe charges create
+    Amount in dollars: __
+
+or
+
+    $ stripe charges create [--amount=AMOUNT]
+    Name on Card: __
+
 ### cursor-based pagination
 
 for all ```list``` operations
@@ -117,19 +117,6 @@ e.g. fetching a second page
 
     stripe events list --count=10 --offset=10
 
-
-### Interactive Menus
-
-Passing NO (or partial) arguments to any operation, will trigger an interactive menu
-
-    $ stripe charges create
-    Amount in dollars: __
-
-or
-
-    $ stripe charges create [--amount=AMOUNT]
-    Name on Card: __
-
 ### Exception Recovery
 
 Api errors are rescued and their messages displayed for you to read.  No more ```barfing``` to ```stdout```
@@ -143,7 +130,7 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe charges create          # Create a charge
       stripe charges find ID         # Find a charge
       stripe charges help [COMMAND]  # Describe subcommands or one specific subcommand
-      stripe charges list            # List charges
+      stripe charges list            # List charges (optionally by customer_id)
       stripe charges refund ID       # Refund a charge
 
 ### Tokens
@@ -221,7 +208,7 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
     Commands:
       stripe transactions find ID         # Find a transaction
       stripe transactions help [COMMAND]  # Describe subcommands or one specific subcommand
-      stripe transactions list [TYPE]     # List transactions, optionaly filter by type: ( charge refund adjustment application_fee application_fee_refund transfer transfer_failure )
+      stripe transactions list [TYPE]     # List transactions, optionaly filter by type:(charge refund adjustment application_fee application_fee_refund transfer transfer_failure)
 
 ### Recipients
 
@@ -232,6 +219,16 @@ Api errors are rescued and their messages displayed for you to read.  No more ``
       stripe recipients help [COMMAND]  # Describe subcommands or one specific subcommand
       stripe recipients list            # List recipients
 
+### Refunds
+
+Though ```refund```  is still a supported operation of the ```charges``` command. The ```refunds``` command offers additional functionality.
+
+    Commands:
+      stripe refunds create --charge=CHARGE   # apply a new refund to CHARGE charge
+      stripe refunds find ID --charge=CHARGE  # Find ID refund of CHARGE charge
+      stripe refunds help [COMMAND]           # Describe subcommands or one specific subcommand
+      stripe refunds list --charge=CHARGE     # List refunds for CHARGE charge
+
 ### Transfers
 
     Commands:

data/lib/stripe/cli/commands.rb

@@ -12,6 +12,7 @@ module Stripe
       autoload :Transactions, 'stripe/cli/commands/transactions'
       autoload :Balance, 'stripe/cli/commands/balance'
       autoload :Recipients, 'stripe/cli/commands/recipients'
+      autoload :Refunds, 'stripe/cli/commands/refunds'
       autoload :Subscriptions, 'stripe/cli/commands/subscriptions'
       autoload :Transfers, 'stripe/cli/commands/transfers'
       autoload :Version, 'stripe/cli/commands/gem_version'

data/lib/stripe/cli/commands/charges.rb

@@ -17,11 +17,11 @@ module Stripe
 
         desc "find ID", "Find a charge"
         def find charge_id
-        	super Stripe::Charge, charge_id
+          super Stripe::Charge, charge_id
         end
 
         desc "refund ID", "Refund a charge"
-        option :amount, :type => :numeric, :desc => "Refund amount in dollars"
+        option :amount, :type => :numeric, :desc => "Refund amount in dollars. (Entire charge by default)"
         option :metadata, :type => :hash
         option :refund_application_fee, :type => :boolean, :default => false, :desc => "Whether or not to refund the application fee"
         def refund charge_id

data/lib/stripe/cli/commands/refunds.rb

@@ -0,0 +1,52 @@
+module Stripe
+  module CLI
+    module Commands
+      class Refunds < Command
+        desc "list", "List refunds for CHARGE charge"
+        option :starting_after, :desc => "The ID of the last object in the previous paged result set. For cursor-based pagination."
+        option :ending_before, :desc => "The ID of the first object in the previous paged result set, when paging backwards through the list."
+        option :limit, :desc => "a limit on the number of resources returned, between 1 and 100"
+        option :offset, :desc => "the starting index to be used, relative to the entire list"
+        option :count, :desc => "depricated: use limit"
+        option :charge, :aliases => :c, :required => true, :desc => "Id of charge to search"
+        def list
+          if charge = retrieve_charge(options.delete :charge)
+            super charge.refunds, options
+          end
+        end
+
+        desc "find ID", "Find ID refund of CHARGE charge"
+        option :charge, :aliases => :c, :required => true, :desc => "Id of charge to search"
+        def find refund_id
+          if charge = retrieve_charge(options.delete :charge)
+            super charge.refunds, refund_id
+          end
+        end
+
+        desc "create", "apply a new refund to CHARGE charge"
+        option :amount, :type => :numeric, :desc => "Refund amount in dollars. (Entire charge by default)"
+        option :metadata, :type => :hash
+        option :refund_application_fee, :type => :boolean, :default => false, :desc => "Whether or not to refund the application fee"
+        option :charge, :aliases => :c, :required => true, :desc => "Id of charge to apply refund"
+        def create
+          options[:amount] = (Float(options[:amount]) * 100).to_i if options[:amount]
+          if charge = retrieve_charge(options.delete :charge)
+            super charge.refunds, options
+          end
+        end
+
+        private
+
+        def retrieve_charge id
+          begin
+            Stripe::Charge.retrieve(id, api_key)
+          rescue Exception => e
+            ap e.message
+            false
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/stripe/cli/runner.rb

@@ -10,10 +10,11 @@ module Stripe
       register Commands::Plans, 'plans', 'plans', 'find, list, create, & delete plans'
       register Commands::Coupons, 'coupons', 'coupons', 'find, list, create, & delete coupons'
       register Commands::Events, 'events', 'events', 'find & list events'
-      register Commands::Invoices, 'invoices', 'invoices', 'find, list, pay, and close invoices'
+      register Commands::Invoices, 'invoices', 'invoices', 'find, list, pay, & close invoices'
       register Commands::Transactions, 'transactions', 'transactions', 'find & list balance transactions'
-      register Commands::Balance, 'balance', 'balance', 'show currently available and pending balance amounts'
+      register Commands::Balance, 'balance', 'balance', 'show currently available & pending balance amounts'
       register Commands::Recipients, 'recipients', 'recipients', 'find, list, create & delete recipients'
+      register Commands::Refunds, 'refunds', 'refunds', 'find, list, & create refunds'
       register Commands::Subscriptions, 'subscriptions', 'subscriptions', 'find, list, create, cancel & reactivate multiple subscriptions per customer'
       register Commands::Transfers, 'transfers', 'transfers', 'find, list, & create transfers'
       register Commands::Version, 'version', 'version', 'display current gem version', hide: true

data/lib/stripe/cli/version.rb

@@ -1,5 +1,5 @@
 module Stripe
   module CLI
-    VERSION = "1.4.6"
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe-cli
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.5.0
 platform: ruby
 authors:
 - Alex MacCaw
@@ -176,6 +176,7 @@ files:
 - lib/stripe/cli/commands/invoices.rb
 - lib/stripe/cli/commands/plans.rb
 - lib/stripe/cli/commands/recipients.rb
+- lib/stripe/cli/commands/refunds.rb
 - lib/stripe/cli/commands/subscriptions.rb
 - lib/stripe/cli/commands/tokens.rb
 - lib/stripe/cli/commands/transactions.rb