apruve 0.9.1 → 0.9.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 768587ceb2db4b6f9cee28a0ca12c24f95b2a15a
+  data.tar.gz: b11a64be202300c00734e2c2374723e828ca3357
+SHA512:
+  metadata.gz: 8881b9309a56ba775b8e9c987e9cfa62c600919072621ba64463dad5f96ca469c8709469071a09732aa12a49df47c37b3277be1f26ba29ab1e24bf64c2314fe0
+  data.tar.gz: 26b8c2fa1712781b992b3e22a57ae38a33bda6dede1fa43c86973289b3b7f9f1deb49e6663d8fc136574a013941c6c65c7886e5b3e6d2534cfab7576d04be96b

data/Gemfile

@@ -16,14 +16,11 @@ group :development do
 end
 
 group :test do
-
-  gem 'ruby-debug-base19x'
-  gem 'ruby-debug-ide'
-
   gem 'faker'
   gem 'net-http-persistent'
-  gem 'rspec', '~> 2.14.1'
-  gem 'rake', '~> 10.0.3'
-  gem 'vcr', '~> 2.4.0'
+  gem 'rspec'
+  gem 'rspec-its'
+  gem 'rake'
+  gem 'vcr'
   gem 'webmock'
 end

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    apruve (0.9.1)
-      addressable (~> 2.3.5)
+    apruve (0.9.2)
+      addressable (~> 2.3)
       faraday (>= 0.8.6, <= 0.9.0)
-      faraday_middleware (~> 0.9.0)
+      faraday_middleware (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
@@ -13,7 +13,6 @@ GEM
     coderay (1.1.0)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
-    debugger-ruby_core_source (1.3.2)
     diff-lcs (1.2.5)
     faker (1.3.0)
       i18n (~> 0.5)
@@ -37,40 +36,38 @@ GEM
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
       rb-kqueue (>= 0.2)
-    lumberjack (1.0.5)
+    lumberjack (1.0.7)
     method_source (0.8.2)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.0.4)
+    rake (10.3.2)
     rb-fsevent (0.9.4)
-    rb-inotify (0.9.4)
+    rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    rb-kqueue (0.2.2)
+    rb-kqueue (0.2.3)
       ffi (>= 0.5.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.1)
+    rspec-expectations (2.99.1)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    ruby-debug-base19x (0.11.30.pre15)
-      debugger-ruby_core_source (> 0)
-      rake (>= 0.8.1)
-    ruby-debug-ide (0.4.22)
-      rake (>= 0.8.1)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (2.99.1)
     safe_yaml (1.0.3)
     slop (3.5.0)
     terminal-table (1.4.5)
     thor (0.19.1)
-    vcr (2.4.0)
-    webmock (1.17.4)
-      addressable (>= 2.2.7)
+    vcr (2.9.2)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
     yard (0.8.7.4)
 
@@ -89,10 +86,9 @@ DEPENDENCIES
   json
   listen (~> 1.3.1)
   net-http-persistent
-  rake (~> 10.0.3)
-  rspec (~> 2.14.1)
-  ruby-debug-base19x
-  ruby-debug-ide
-  vcr (~> 2.4.0)
+  rake
+  rspec
+  rspec-its
+  vcr
   webmock
   yard

data/README.md

@@ -18,22 +18,106 @@ Or install it yourself as:
 
     $ gem install apruve
 
-## Usage
+## Usage (merchant integration)
 
-### Create a store on Apruve. Use test.apruve.com for test accounts.
+The following snippets are based on our apruve-ruby-demo project, which is a functional demo of how a merchant can
+integrate Apruve.
+
+[https://github.com/apruve/apruve-ruby-demo](https://github.com/apruve/apruve-ruby-demo)
+
+### Create an account on Apruve.
+
+Have a look though our [Getting Started documentation](https://www.apruve.com/doc/developers/) and be sure to use
+test.apruve.com for test accounts.
+
+### Initialize the library
+
+For [test.apruve.com](test.apruve.com)
+    Apruve.configure('YOUR_APRUVE_API_KEY', 'test')
+
+For [www.apruve.com](www.apruve.com)
+    Apruve.configure('YOUR_APRUVE_API_KEY', 'prod')
 
 ### Create a PaymentRequest
-    @pr = Apruve::PaymentRequest.new
-    @pr.merchant_id =
 
-### On your web page, declare apruve.js
+    @payment_request = Apruve::PaymentRequest.new(
+          merchant_id: your_merchant_id,
+          currency: 'USD',
+          amount_cents: 6000,
+          shipping_cents: 500
+      )
+
+    @payment_request.line_items << Apruve::LineItem.new(
+          title: 'Letter Paper',
+          description: '20 lb ream (500 Sheets). Paper dimensions are 8.5 x 11.00 inches.',
+          sku: 'LTR-20R',
+          price_ea_cents: 1200,
+          quantity: 3,
+          amount_cents: 3600,
+          view_product_url: 'https://www.example.com/letter-paper'
+      )
+
+### On your web page...
+
+(example in ERB...)
+
+At the top of the file, import the apruve.js script.
+
+    <%= Apruve.js %>
+
+Write a little Javascript to configure apruve.js
+
+1. set the secure hash
+2. set the payment request
+3. register a callback to capture apruve.paymentRequestId
+
+``` javascript
+    apruve.secureHash = '<%= @payment_request.secure_hash %>';
+    apruve.paymentRequest = <%= @payment_request.to_json %>;
+    apruve.registerApruveCallback(apruve.APRUVE_COMPLETE_EVENT, function () {
+        $('#paymentRequestId').val(apruve.paymentRequestId)
+        $('#finishOrder').submit();
+    });
+```
+
+Decide where to put the Apruve button
+
+    <%= Apruve.button %>
+
+### Back on your server...
+
+Use the paymentRequestId to create a Payment
+
+    apruve_payment = Apruve::Payment.new(payment_request_id: params[:payment_request_id], amount_cents: 12345)
+    apruve_payment.save!
+
+Save the status and the payment ID with the payment in your database
+
+    # dependent on your system, but something like this...
+    my_payment.apruve_payment_id = apruve_payment.id
+    my_payment.apruve_payment_status = apruve_payment.status
+    my_payment.save!
+
+(optional) If you track orders separately from payments, save the paymentRequestId with your order in your database
+
+    # dependent on your system, but something like this...
+    my_order.apruve_payment_request = params[:payment_request_id]
+    my_order.save
 
+### Create a web hook listener
 
-3. Load the PaymentRequest and it's hash into apruve.js
-4. Decide where to put the Apruve button
-5. Register a call-back function to get the transaction ID back to your server
-6. Tell Apruve to create a payment against the transaction ID
-7. Process the webhook from Apruve when payment is received
+    # dependent on your system, but if you use Sinatra, it might look something like this...
+    post '/webhook_notify' do
+      # We got a webhook. You should look up the order in your database and complete or cancel it as appropriate.
+      puts "GOT WEBHOOK DATA FOR PAYMENT #{@webhook_data}"
+      my_payment.find_by_apruve_payment_id(@webhook_data[:payment_id])
+      my_payment.apruve_payment_status = @webhook_data[:status]
+      if my_payment.apruve_payment_status == 'captured'
+        my_payment.complete_order
+      elsif my_payment.apruve_payment_status == 'rejected'
+        my_payment.cancel_order
+      end
+    end
 
 ## Contributing
 

data/apruve.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_development_dependency 'bundler', '~> 1.5'
-  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rake', '~> 10.3'
 
   gem.add_dependency('faraday', ['>= 0.8.6', '<= 0.9.0'])
-  gem.add_dependency('faraday_middleware', '~> 0.9.0')
-  gem.add_dependency('addressable', '~> 2.3.5')
+  gem.add_dependency('faraday_middleware', '~> 0.9')
+  gem.add_dependency('addressable', '~> 2.3')
 end

data/lib/apruve/resources/subscription_adjustment.rb

@@ -1,7 +1,7 @@
 module Apruve
   class SubscriptionAdjustment < Apruve::ApruveObject
     attr_accessor :id, :subscription_id, :status, :title, :amount_cents, :price_ea_cents, :quantity, :description,
-                  :variant_info, :sku, :vendor, :view_product_url
+                  :variant_info, :sku, :vendor, :view_product_url, :api_url
 
     def self.find(subscription_id, id)
       response = Apruve.get("subscriptions/#{subscription_id}/adjustments/#{id}")

data/lib/apruve/version.rb

@@ -1,3 +1,3 @@
 module Apruve
-  VERSION = '0.9.1'
+  VERSION = '0.9.2'
 end

data/spec/apruve/response/apruve_exception_middleware_spec.rb

@@ -34,9 +34,9 @@ describe Faraday::Response::RaiseApruveError, :type => :response do
                             })]
       }
 
-      lambda {
+      expect {
         connection.get('/error')
-      }.should raise_error(Apruve::BadRequest)
+      }.to raise_error(Apruve::BadRequest)
     end
 
   end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ end
 require 'rubygems'
 require 'faker'
 require 'vcr'
+require 'rspec/its'
 
 RSpec.configure do |config|
   # config.include Rack::Test::Methods

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apruve
 version: !ruby/object:Gem::Version
-  version: 0.9.1
-  prerelease: 
+  version: 0.9.2
 platform: ruby
 authors:
 - Apruve, Inc.
@@ -10,94 +9,84 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.6
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.6
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.5
+        version: '2.3'
 description: Easily integrate the Apruve B2B payment network into your ruby-based
   application.
 email:
@@ -106,8 +95,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -144,27 +133,26 @@ files:
 homepage: https://www.apruve.com
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helper library for integrating Apruve into a ruby app.
 test_files:
 - spec/apruve/apruve_spec.rb