koduc_stripe 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1052eede935a10f12f4ed31582e2aa2dc4f255f5
+  data.tar.gz: fc3c43b3b451d8f9be1def470f6fa88bb63f9d03
+SHA512:
+  metadata.gz: b9d8f3037a1245e0390d890551d802f2da5fe6e6486ba611da6c366c433298fbce554bc0b9fdf0570d5ad82c47a250d15857410d186bd4abc219287e624ab591
+  data.tar.gz: 1a250ede7a08b20192f2059e107656303010b38daaa56a3a48fc84f21d54629b8d5c2041a46092bacc6438075cb395a3cfda96a9dc873f396cbef1939efd1e2f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koduc_stripe.gemspec
+gemspec

data/README.md

@@ -0,0 +1,123 @@
+# KoducStripe
+
+KoducStripe is a lightweight wrapper for Stripe payments API. This ruby gem provides a platform to integrate Stripe payment gateway in Ruby on Rails Application.
+
+>Currently KoducStripe supports One-time Payment with partially or completely Refund payment with Stripe.
+
+It is developed for the usage in Ruby on Rails web applications and integrates as a Rails plugin.
+
+It is developed in November 2015 by [KSolves](http://www.ksolves.com/) team with the help of valuable contributors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'koduc_stripe'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koduc_stripe
+
+# Usage
+
+Provide the Stripe API Key while initializing the Rails Application by placing the key under `config/initializer`.
+
+Create a new file in initializer, say `koduc_stripe.rb` and write below piece of code there.
+```ruby
+KsStripe::Client.configure do |config|
+  config.stripe_api_key = STRIPE_API_KEY
+end
+```
+** Do not forget to restart the rails server after adding Stripe API Key.
+
+
+## Charge a user
+To charge a user, first create an object of `KsStripe::KsBase` class by supplying a hash containing card details. Hash should have below keys:
+* ``` card_number  => Card Number to charged (Required) ```
+* ``` cvc          => Card Verification Code of the card (Required)```
+* ``` exp_month    => Expiration month of the Card (Required)```
+* ``` exp_year     => Expiration Year of the Card (Required)```
+* ``` name         => Name on the Card (Optional)```
+* ``` card_type    => Type of the credit card (Optional)```
+
+For example:
+```ruby
+card_obj = KsStripe::KsBase.new(
+          :card_number=>'4242424242424242',
+          :cvc=>'123',
+          :exp_month => '01',
+          :exp_year => '2020',
+          :card_type => 'visa',
+          :name=>"Atul Khanduri"
+          )
+```
+
+Secondly, charge the user by calling `charge method` from `KsStripe::KsBase` object with amount to be charged and optional description of the payment as parameters.
+
+For example:
+```ruby
+charge = card_obj.charge(10, "This is a test payment by KsStripe Gem")
+```
+
+##### Please Note:
+* Amount to be charge must be in cents and supports only US Dollars.
+* Amount should be a positive integer as Stripe does not supports amount in decimals.
+* If card_type is provided then only Card is Validated using Regular expression. Although other algorithm's are always applied to validate card number.
+* Credit Card type can only be american_express, mastercard, visa, jcb, diners_club or discover as Stripe supports only these type of cards.
+
+
+#### Response of One Time Payment Charge:
+If the Charge is successful then the response will be the response returned by Stripe.
+
+If there's any validation or any other error in the payment, then all the errors are returned in below format:
+```ruby
+{
+  "error" => {
+    "message" => [<All the Error Messages in Array>]
+  }
+}
+```
+
+### Refund a Payment
+
+To refund a one-time payment, call `KsStripe::KsBase.refund` method with parameters as charge id, optional amount(in cents) to be refund and optional reason of the refund.
+```ruby
+KsStripe::KsBase.refund(<charge_id>, <amount>, <reason>)
+```
+
+##### Please Note:
+* Amount to be charge must be in cents and supports only US Dollars.
+* Complete payment is refunded if amount is not provided in the parameter else partially amount is refunded as provided in the parameter.
+* Amount must not be greater than the charge amount.
+* Refund reason must be one of duplicate, fraudulent or requested_by_customer
+
+#### Response of Refund:
+If the refund is successful then the response will be the response returned by Stripe.
+
+If there's any validation or any other error in payment refund, then all the errors are returned in below format:
+```ruby
+{
+  "error" => {
+    "message" => [<All the Error Messages in Array>]
+  }
+}
+```
+
+
+## Contact 
+
+If you found any issue in the Gem then do not forgot to create a issue in Github.
+
+If you have any query, need support or advice just DROP us a line and we’ll be in touch very soon.
+
+Email: support@koduc.com
+
+You can also contact us at +91-120-4540178
+
+We’d love to hear from you! :) :)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "koduc_stripe"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/koduc_stripe.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koduc_stripe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "koduc_stripe"
+  spec.version       = KsStripe::VERSION
+  spec.authors       = ["Koduc"]
+  spec.email         = ["ratan@ksolves.com"]
+
+  spec.summary       = "KsStripe is a Ruby Gem for Stripe Payment Gateway Integration"
+  spec.description   = "KsStripe provides a platform to integrate Stripe payment gateway in Ruby on Rails Application"
+  spec.homepage      = "https://github.com/kartiksolves/koduc-stripe"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  # Rails >=3.2 supports Ruby 1.9.3 (http://edgeguides.rubyonrails.org/3_2_release_notes.html)
+  spec.add_dependency 'activesupport', '>= 3.2'
+  spec.add_dependency "rest-client", '~> 1.4'
+end

data/lib/koduc_stripe.rb

@@ -0,0 +1,62 @@
+require "active_support"
+require "active_support/core_ext"
+require "rest_client"
+
+require "koduc_stripe/base"
+require "koduc_stripe/empty"
+require "koduc_stripe/error"
+require "koduc_stripe/luhn"
+require "koduc_stripe/number_check"
+require "koduc_stripe/validation"
+require "koduc_stripe/version"
+require "koduc_stripe/request"
+
+module KsStripe
+  # Set the Stripe API key
+  # 
+  class Client
+    cattr_reader :stripe_token
+
+    class << self
+      # Set the Stripe API key to a class variable
+      # 
+      # 
+      # == Parameter: A block of code having Stripe API Key
+      # == Returns: None
+      def configure(&block)
+        config = OpenStruct.new
+        block.call config
+
+        # if config[:stripe_api_key].blank?
+        #   raise "No Stripe API key provided."
+        # elsif KsStripe::Empty.empty?(config[:stripe_api_key])
+        if KsStripe::Empty.empty?(config[:stripe_api_key])
+          raise "No Stripe API key provided. Please initialize the App with valid stripe API key."
+        end
+        
+        @@stripe_token = config[:stripe_api_key]
+      end
+
+      # Gives the Stripe API Key
+      # 
+      # == Parameter: None
+      # == Returns: Stripe API Key
+      def stripe_key
+        return @@stripe_token
+      end
+
+      # Gives Stripe Authorization Header for Stripe API request
+      # 
+      # == Parameter: None
+      # == Returns: If stripe key is provided then return Stripe Authorization Header
+      #     otherwise Raise exception.
+      def get_key_header
+        if KsStripe::Empty.empty?(self.stripe_key)
+          raise "No Stripe API key provided. Please initialize the App with valid stripe API key."
+        end
+        @@stripe_auth_key = "Bearer #{self.stripe_key}"
+      end
+
+    end
+  end
+end

data/lib/koduc_stripe/version.rb

@@ -0,0 +1,3 @@
+module KsStripe
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: koduc_stripe
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Koduc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: KsStripe provides a platform to integrate Stripe payment gateway in Ruby
+  on Rails Application
+email:
+- ratan@ksolves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- koduc_stripe.gemspec
+- lib/koduc_stripe.rb
+- lib/koduc_stripe/version.rb
+homepage: https://github.com/kartiksolves/koduc-stripe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: KsStripe is a Ruby Gem for Stripe Payment Gateway Integration
+test_files: []
+has_rdoc: