pin_up 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85124623f3cd5ff6833e59d2c8ad52cd31df24c1
-  data.tar.gz: d7075d9da3852bab3db4fc2bbbd7afd102ccf76c
+  metadata.gz: 3a3e2632a57eb0ab9926a95fe146f83f43bca2da
+  data.tar.gz: 5e33cb060cdda7e2ed56a0d0847593c9b350ff34
 SHA512:
-  metadata.gz: b8b80ac154a3ac828c654628707d4dd42f98e83832648194450bdba1cfd41bd737edf3a3517ff86162ad1e7e0080f198620a582232deb32b7692ffaeee357ec9
-  data.tar.gz: 2fd697737e9ff57c7179b88c264efeef3701467a5451871597fc60229ff2729eb26a42e89f728d0cf42fbb7268be04c26dcbf8e96d9e71a5594db9f1416428d9
+  metadata.gz: b11cb5ab4da229ea354fe35fccf88ebc1f524bd822c1102f8bf7a03782ac265c59e9fb0553c9279456094537ff60314caabafb212f8dbbc5d5abd0893448ba5a
+  data.tar.gz: 71788c32b013479e8b6ffbf7cda8a333cc27c2ecb641066891d6c33619d185ae30207432687d90d5523062f61f9cda392daac4be32d697a50329db3735c599d1

data/.travis.yml

@@ -5,4 +5,4 @@ env:
       Z7eqtE7oQVsmz2iw45MULCsk9Ff028nsPHJjX04GskTCeqhn2AgeFbNEjB7d
       1mlrJDZyRggBW2ENK6Kti7p196hB1WfH52SYl9dZSLABWDW9oIKo46HjymNP
       J9RERcoevctKkRGUCvyx0kvX1uN4iI56OJPXFAsYA+w0zAm/1/c=
-script: rspec spec
+script: bundle exec rspec spec

data/Gemfile

@@ -1,10 +1,7 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-  gem "httparty"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
+gem "httparty"
+
 group :development do
   gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
@@ -14,6 +11,7 @@ group :development do
   gem "simplecov", ">= 0"
   gem "webmock"
   gem "vcr"
-  gem 'guard-rspec'
-  gem 'terminal-notifier-guard'
+  gem "guard-rspec"
+  gem "terminal-notifier-guard"
+  gem "capybara"
 end

data/Gemfile.lock

@@ -10,6 +10,12 @@ GEM
     addressable (2.3.5)
     atomic (1.1.10)
     builder (3.2.2)
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
     coderay (1.0.9)
     crack (0.4.0)
       safe_yaml (~> 0.9.0)
@@ -60,6 +66,7 @@ GEM
       rb-kqueue (>= 0.2)
     lumberjack (1.0.3)
     method_source (0.8.1)
+    mime-types (1.25)
     minitest (4.7.5)
     multi_json (1.7.7)
     multi_xml (0.5.4)
@@ -77,6 +84,8 @@ GEM
       method_source (~> 0.8)
       slop (~> 3.4)
     rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
     rake (10.1.0)
     rb-fsevent (0.9.3)
     rb-inotify (0.9.0)
@@ -114,11 +123,14 @@ GEM
     webmock (1.12.3)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  capybara
   guard-rspec
   httparty
   jeweler (~> 1.8.4)

data/README.md

@@ -140,6 +140,53 @@ Will return a card_token that can be stored against a customer.
 
 Only use this method if you're comfortable sending card details to your server - otherwise you can use a form that Pin provides (https://pin.net.au/docs/guides/payment-forms) and get the card_token that way.
 
+## Receipts
+
+One of the things I've found lacking with Pin is the ability to generate a receipt for a sale. So I've added this functionality into pin_up.
+
+At the moment basic receipt creation from a succesful charge is supported, however, I'd like to build out this feature and include failed transactions and refunds.
+
+There are two ways to go about creating and viewing / sharing a receipt.
+
+#### Rendering a receipt as HTML
+
+##### Basic Usage:
+
+The following will return a HTML receipt for you to do with as you wish.
+
+    @charge = Pin::Charges.find("token")
+    @company_details = ["ABC Widgets","123 Fake Street Melbourne","VIC 3000","ABN: 12 345 678 910"]
+    @receipt = Pin::Receipt.new(@charge, @company_details)
+    @receipt.render()
+
+Your "comapny_details" can be replaced with whatever information you wish to be displayed at the top right hand side (see `tmp/receipt.html`).
+
+##### Advanced Usage:
+
+There are four additional options that can be passed to `Pin::Receipt.new`.
+
+The first is the path to your logo should you wish to include it in the footer.
+
+The second is some additional payment information you might want to add (such as tax, fee or discount information). This can be done by passing a hash in as argument 4 eg:
+
+    payment_options = {}
+    payment_options["fee"] = {"name" => "late fee", "amount" => "$10.00"}
+    payment_options["tax"] = {"name" => "GST", "amount" => "$10.00"}
+    payment_options["discount"] = {"name" => "Member Discount", "amount" => "$10.00"}
+
+A path to a custom receipt template can be passed in as the 5th argument, while a path that you would like the receipt to be saved to can be passed in as the 6th argument.
+
+
+##### Saving a receipt
+
+To save a receipt it's exactky the same as above, just call `save` instead of render. By default, a receipt will be saved into `tmp/receipt.html` unless a path is specified.
+
+If you would like a PDF receipt, you should be able to "print as PDF" from a browser dialog.
+
+##### Custom receipt template
+
+If you would like you can use a custom receipt template to suit your branding or design needs. To get an idea of which variables are available, take a look at  `/views/receit.html.erb`
+
 ## Testing localy
 Create a YAML file under 'spec' called 'test_data.yml' and add in:
 
@@ -151,10 +198,10 @@ run
 
     rspec spec/*.rb
 
-## Todo
+## To do
 
+  * Flesh out receipts - handle failed transactions and refunds
   * Validate a response before it gets sent to Pin (eg. Update customer)
-  * Pagination
 
 ## Contributing to pin_up
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.1

data/lib/pin_up.rb

@@ -1,10 +1,12 @@
 require 'httparty'
 require 'json'
+require 'erb'
 
 require 'pin_up/base'
 require 'pin_up/card'
 require 'pin_up/charge'
 require 'pin_up/customer'
 require 'pin_up/refund'
+require 'pin_up/receipt'
 
 require 'pin_up/pin_errors'

data/lib/pin_up/receipt.rb

@@ -0,0 +1,64 @@
+module Pin
+  ##
+  # This class lets you generate and save receipts from a Pin::Charge.
+  class Receipt < Pin::Base
+
+    ##
+    # Create a new Pin::Receipt instance
+    # Args:
+    #  charge: Charge hash from Pin::Charge.find
+    #  your_details: (Array), an Array of details you would like displayed about you or your company
+    #  payment_options: (Hash), If your charge had extra components (such as late fees or discounts or taxes) pass them in here as a hash eg:
+    #
+    #     payment_options = {}
+    #     payment_options["fee"] = {"name" => "late fee", "amount" => "$10.00"}
+    #     payment_options["tax"] = {"name" => "GST", "amount" => "$10.00"}
+    #     payment_options["discount"] = {"name" => "Member Discount", "amount" => "$10.00"}
+    #
+    #  template_path: (String), path to your own template if you wish to design your own receipt (take a look at the included template for variable names)
+    #  save_path: (String), path that the HTML receipt will be saved
+    def initialize(charge, your_details, logo_path='', payment_options={}, template_path = 'views/receipt.html.erb', save_path = 'tmp/receipt.html')
+      @charge = charge
+      @logo = logo_path
+      @details = your_details
+      @payment_options = payment_options
+      @template_path = template_path if template_path
+      @save_path = save_path if save_path
+      @amount = number_to_currency(@charge["amount"], @charge["currency"])
+    end
+
+    ##
+    # Renders the HTML receipt but does not save it -- useful for showing on screen
+    def render
+      template = ERB.new File.new(@template_path).read, nil, "%"
+      template.result(binding)
+    end
+
+    ##
+    # Renders and saves the HTML receipt -- useful for emailing receipt
+    def save
+      receipt = File.new(@save_path, 'w')
+      receipt.write(render)
+      receipt.close
+    end
+
+    protected
+
+    ##
+    # Converts a string to currency format.
+    # Args:
+    #  number: (String) a dollar, pound or euro value in 'cents'
+    #  currency: (String) a string representation of a currency as provided by Pin
+    def number_to_currency(number, currency)
+      case currency
+      when 'GBP'
+        symbol = '£'
+      when 'EUR'
+        symbol = '€'
+      else
+        symbol = '$'
+      end
+      "#{symbol}#{"%0.2f" % (number.to_f / 100)}"
+    end
+  end
+end

data/pin_up.gemspec

@@ -2,14 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: pin_up 0.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pin_up"
-  s.version = "0.5.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Nitsikopoulos"]
-  s.date = "2013-08-18"
+  s.date = "2013-11-07"
   s.description = "A Ruby gem wrapper for the pin-payments (pin.net.au) API"
   s.email = "dnitza@gmail.com"
   s.extra_rdoc_files = [
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
     "lib/pin_up/charge.rb",
     "lib/pin_up/customer.rb",
     "lib/pin_up/pin_errors.rb",
+    "lib/pin_up/receipt.rb",
     "lib/pin_up/refund.rb",
     "pin_up.gemspec",
     "spec/base_spec.rb",
@@ -49,13 +51,15 @@ Gem::Specification.new do |s|
     "spec/charges_spec.rb",
     "spec/customers_spec.rb",
     "spec/errors_spec.rb",
+    "spec/receipt_spec.rb",
     "spec/refund_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "views/receipt.html.erb"
   ]
   s.homepage = "http://github.com/dNitza/pin_up"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.3"
+  s.rubygems_version = "2.1.4"
   s.summary = "A Ruby gem wrapper for the pin-payments (pin.net.au) API"
 
   if s.respond_to? :specification_version then
@@ -73,6 +77,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<vcr>, [">= 0"])
       s.add_development_dependency(%q<guard-rspec>, [">= 0"])
       s.add_development_dependency(%q<terminal-notifier-guard>, [">= 0"])
+      s.add_development_dependency(%q<capybara>, [">= 0"])
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
@@ -86,6 +91,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<vcr>, [">= 0"])
       s.add_dependency(%q<guard-rspec>, [">= 0"])
       s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
+      s.add_dependency(%q<capybara>, [">= 0"])
       s.add_dependency(%q<httparty>, [">= 0"])
     end
   else
@@ -100,6 +106,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<vcr>, [">= 0"])
     s.add_dependency(%q<guard-rspec>, [">= 0"])
     s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
+    s.add_dependency(%q<capybara>, [">= 0"])
     s.add_dependency(%q<httparty>, [">= 0"])
   end
 end

data/spec/receipt_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe "Receipt", :vcr, class: Pin::Receipt do
+  before(:each) do
+    Pin::Base.new(ENV["PIN_SECRET"], :test)
+    @charge = Pin::Charges.find("ch_0kdOMXP7gG0_W_Vh8qAWdA")
+    @company_details = ["ABC Widgets", "123 Fake Street Melbourne","VIC 3000", "ABN: 12 345 678 910"]
+    @receipt = Pin::Receipt.new(@charge, @company_details)
+  end
+
+  it "should generate an HTML receipt  given a charge" do
+    @receipt.render().should include(@charge["token"])
+  end
+
+  it "should save an index.html file for the receipt" do
+    @receipt.save()
+    File.read('tmp/receipt.html').should include(@charge["token"])
+  end
+
+  it "should format a number as a currency" do
+    expect @receipt.send(:number_to_currency, 1989, 'null').should match(/[$,£,€]\d{1,}[.]\d{2}/)
+  end
+
+  it "should print payment option information" do
+    payment_options = {}
+    payment_options["fee"] = {"name" => "late fee", "amount" => "$10.00"}
+    payment_options["tax"] = {"name" => "GST", "amount" => "$10.00"}
+    payment_options["discount"] = {"name" => "Member Discount", "amount" => "$10.00"}
+
+    @detailed_receipt = Pin::Receipt.new(@charge, @company_details, nil, payment_options)
+    expect @detailed_receipt.render().should include("GST")
+  end
+
+end

data/spec/spec_helper.rb

@@ -4,14 +4,16 @@ SimpleCov.start
 require 'rubygems'
 require 'bundler/setup'
 require 'webmock/rspec'
+require 'capybara/rspec'
 require 'vcr'
 
 require "net/https"
 require "uri"
 
 ## Uncomment to load in a .yml with your pin key
-ENV.update YAML.load(File.read(File.expand_path("../test_data.yml", __FILE__)))
-#gem
+# ENV.update YAML.load(File.read(File.expand_path("../test_data.yml", __FILE__)))
+
+# require pin_up gem
 require 'pin_up'
 
 RSpec.configure do |config|
@@ -28,5 +30,5 @@ VCR.configure do |c|
   c.cassette_library_dir = "spec/vcr"
   c.hook_into :webmock
   c.allow_http_connections_when_no_cassette = true
-  c.filter_sensitive_data('<key>') {'W_VrFld7oc9BnC4pOdQxmw'}
+  c.filter_sensitive_data('<key>') {ENV["PIN_SECRET"]}
 end

data/views/receipt.html.erb

@@ -0,0 +1,217 @@
+<html>
+<head>
+  <title><%= @details[0] %></title>
+  <style type="text/css">
+    body{
+      font-family: "Helvetica", arial, sans-serif;
+      text-align: center;
+      background: #eee;
+      font-size: 14px;
+    }
+    a{
+      color:#4b4b4b;
+      text-decoration: none;
+    }
+    a:hover{
+      color: #ccc;
+    }
+    h3,h5,h6{
+      color:#9ba4ae;
+      margin: 0px;
+    }
+    h5{
+      font-size: 14px;
+      margin: 20px 0 5px 0;
+    }
+    h3{
+      font-size: 16px;
+    }
+    h4{
+      color:#4b4b4b;
+      font-weight: 600;
+      margin:0;
+      /*font-size: 14px;*/
+    }
+    h2{
+      color:#4b4b4b;
+      text-align: left;
+    }
+    .half p{
+      /*margin: 20px 0 5px 0;*/
+    }
+    .full{
+      width:100%;
+      float: left;
+      overflow: hidden;
+    }
+    #receipt{
+      width:640px;
+      margin: 0 auto;
+      border:1px solid #ccc;
+      border-top:5px solid #4b4b4b;
+      padding: 15px;
+      overflow: hidden;
+      background: #fff;
+      margin-top: 55px;
+    }
+    .logo{
+      padding: 15px 0 25px 0;
+    }
+    .half{
+      width:50%;
+      overflow: hidden;
+    }
+    .right{
+      float: right;
+      text-align: right;
+    }
+    .left{
+      float: left;
+      text-align: left;
+    }
+    .center{
+      text-align: center;
+    }
+    section{
+      width:100%;
+      overflow: hidden;
+      float: left;
+    }
+    .text-right{
+      text-align: right;
+      color:#9ba4ae;
+    }
+    .break hr{
+      border-top: 2px solid #eee;
+      border-left:none;
+    }
+    table{
+      text-align: left;
+      font-size: 14px;
+    }
+    table th{
+      border-bottom: 2px solid #eee;
+      padding: 10px 0;
+    }
+    table td{
+      padding: 10px 0;
+    }
+    table td:first-child{
+      width:570px;
+      font-weight: 600;
+      padding-right: 90px;
+    }
+    .discount{
+      color: green;
+    }
+    .fee{
+      color: red;
+    }
+    .charge td{
+      border-bottom: 1px solid #eee;
+    }
+  </style>
+</head>
+<body>
+  <div id="receipt">
+    <header>
+      <div class="full center">
+        <h1><%= @details[0] %></h1>
+      </div>
+      <div class="full center">
+        <h3>Receipt</h3>
+      </div>
+    </header>
+
+    <section class="company-details">
+      <div class="half left">
+        <h5>Date</h5>
+        <h4><%= Time.parse(@charge["created_at"]).strftime("%d/%m/%Y") %></h4>
+
+        <h5>Prepared for</h5>
+        <h4><%= @charge["card"]["name"] %></h4>
+        <p><%= @charge["card"]["address_line1"] %></p>
+        <p><%= @charge["card"]["address_line2"] %></p>
+        <p><%= @charge["card"]["address_city"] %></p>
+        <p><%= @charge["card"]["address_state"] %></p>
+        <p><%= @charge["card"]["address_country"] %></p>
+      </div>
+      <div class="half right">
+        <h5>Prepared by</h5>
+        <h4><%= @details[0] %></h4>
+        <% @details.drop(1).each do |detail| %>
+          <p><%= detail %></p>
+        <% end %>
+      </div>
+    </section>
+
+    <section class="break">
+      <hr />
+    </section>
+
+    <section class="summary">
+      <h2>Invoice Summary</h2>
+      <table>
+        <tr>
+          <th>Description</th>
+          <th>Amount</th>
+        </tr>
+        <tr class="charge">
+          <td>
+            <p><%= @charge["description"] %></p>
+            <small><%= @charge["token"] %></small>
+          </td>
+          <td><%= @amount %></td>
+        </tr>
+        <tr>
+          <td class="text-right">Subtotal</td>
+          <td><%= @amount %></td>
+        </tr>
+        <% if @payment_options["discount"] %>
+        <tr class="discount">
+          <td class="text-right"><%= @payment_options["discount"]["name"] %></td>
+          <td><%= @payment_options["discount"]["amount"] %></td>
+        </tr>
+        <% end %>
+
+        <% if @payment_options["fee"] %>
+        <tr class="fee">
+          <td class="text-right"><%= @payment_options["fee"]["name"] %></td>
+          <td><%= @payment_options["fee"]["amount"] %></td>
+        </tr>
+        <% end %>
+
+        <% if @payment_options["tax"] %>
+        <tr>
+          <td class="text-right"><%= @payment_options["tax"]["name"] %></td>
+          <td><%= @payment_options["tax"]["amount"] %></td>
+        </tr>
+        <% end %>
+
+        <tr>
+          <td class="text-right">Total</td>
+          <td>$<%= @charge["amount"].to_f / 100.00 %></td>
+        </tr>
+      </table>
+    </section>
+
+    <section class="break">
+      <hr />
+    </section>
+
+    <section class="info">
+      <h2 class="center">That's it!</h2>
+      <p>If this paid invoice is correct, you do not need to take any further action.</p>
+      <p>Your credit card <em><%= @charge["card"]["display_number"] %></em> has been charged.</p>
+      <p>Payment processed by <a href="https://pin.net.au" target="_blank">Pin Payments.</a></p>
+      <p>Thank You.</p>
+      <% unless @logo == '' %>
+        <div class="full center">
+          <img src="<%= @logo %>" class="logo">
+        </div>
+      <% end %>
+    </section>
+
+  </div>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pin_up
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Daniel Nitsikopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-18 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -164,6 +164,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +225,7 @@ files:
 - lib/pin_up/charge.rb
 - lib/pin_up/customer.rb
 - lib/pin_up/pin_errors.rb
+- lib/pin_up/receipt.rb
 - lib/pin_up/refund.rb
 - pin_up.gemspec
 - spec/base_spec.rb
@@ -218,8 +233,10 @@ files:
 - spec/charges_spec.rb
 - spec/customers_spec.rb
 - spec/errors_spec.rb
+- spec/receipt_spec.rb
 - spec/refund_spec.rb
 - spec/spec_helper.rb
+- views/receipt.html.erb
 homepage: http://github.com/dNitza/pin_up
 licenses:
 - MIT
@@ -240,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
 summary: A Ruby gem wrapper for the pin-payments (pin.net.au) API