apruve 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca4acc4179fdfb02a29fc9d0eb79a5dd7292c0e9
-  data.tar.gz: aadbe9f8aa10c6dd025ad9b9fdbf4931b7042b40
+  metadata.gz: 735a689ea67cfd8585c45094ec9a2072a7ba3304
+  data.tar.gz: 646194c5ea1924ed63b51945cc5549611c8df5aa
 SHA512:
-  metadata.gz: db0815354b4fb97b648c1fcd06aa22358daca85c12dab32b6a3d1ef80db2d42402c9ecb0c3ef266dabf75072800ea850c31a3246d86bcba9f2c8b142e670b916
-  data.tar.gz: c312cb67bc901ff1ad144aa65229ce20505e7873a530dd78e7accf6b54a4c12d057f414475ce8845067e0c57da93cf6cdc65fb360b4d201b444e3c550d9cceeb
+  metadata.gz: a0a108dff171f307f6e9f81040d190ed6ad96ac9d58472fc788f46903dbe1d887f7f51640c512d3929faa1a72e811cb38bb0ef9b51fef248baeb8ca9737b18a1
+  data.tar.gz: 6ed0eff7cd5cb2d7eca970ddcf9b7fc10e347b088165c345b32048cd84ed9f9f328a8531a6f09081d096ce3a3949b6c6c90c2506f6efdb4c97c2d6664b0d067a

data/.gitignore

@@ -14,6 +14,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage
 
 # Mac finder artifacts
 .DS_Store

data/Gemfile

@@ -23,4 +23,6 @@ group :test do
   gem 'rake'
   gem 'vcr'
   gem 'webmock'
+  gem 'simplecov'
+  gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    apruve (0.11.0)
+    apruve (1.0.0)
       addressable (~> 2.3)
       faraday (>= 0.8.6, <= 0.9.0)
       faraday_middleware (~> 0.9)
@@ -10,10 +10,12 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.6)
+    ast (2.3.0)
     coderay (1.1.0)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     faker (1.3.0)
       i18n (~> 0.5)
     faraday (0.9.0)
@@ -21,6 +23,7 @@ GEM
     faraday_middleware (0.9.1)
       faraday (>= 0.7.4, < 0.10)
     ffi (1.9.3)
+    ffi (1.9.3-x86-mingw32)
     guard (1.6.2)
       listen (>= 0.6.0)
       lumberjack (>= 1.0.2)
@@ -40,10 +43,19 @@ GEM
     method_source (0.8.2)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     pry (0.10.0)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    pry (0.10.0-x86-mingw32)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+      win32console (~> 1.3)
+    rainbow (2.1.0)
     rake (10.3.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.5)
@@ -61,18 +73,33 @@ GEM
       rspec-core (>= 2.99.0.beta1)
       rspec-expectations (>= 2.99.0.beta1)
     rspec-mocks (2.99.1)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
     safe_yaml (1.0.3)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.5.0)
     terminal-table (1.4.5)
     thor (0.19.1)
+    unicode-display_width (1.0.5)
     vcr (2.9.2)
     webmock (1.18.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+    win32console (1.3.2-x86-mingw32)
     yard (0.8.7.4)
 
 PLATFORMS
   ruby
+  x86-mingw32
 
 DEPENDENCIES
   addressable
@@ -89,6 +116,11 @@ DEPENDENCIES
   rake
   rspec
   rspec-its
+  rubocop
+  simplecov
   vcr
   webmock
   yard
+
+BUNDLED WITH
+   1.12.5

data/README.md

@@ -1,8 +1,7 @@
 # Apruve
 
-Apruve helps B2B merchants by making it easier for customers to buy what they need for
-their jobs. The apruve gem makes it easier for merchants on Ruby-based platforms to
-integrate Apruve!
+Apruve helps B2B merchants by helping manage complex business sales. The apruve gem makes it easier for merchants on
+Ruby-based platforms to integrate Apruve!
 
 ## Installation
 
@@ -38,16 +37,16 @@ For [test.apruve.com](test.apruve.com)
 For [www.apruve.com](www.apruve.com)
     Apruve.configure('YOUR_APRUVE_API_KEY', 'prod')
 
-### Create a PaymentRequest
+### Create an Order
 
-    @payment_request = Apruve::PaymentRequest.new(
+    @order = Apruve::Order.new(
           merchant_id: your_merchant_id,
           currency: 'USD',
           amount_cents: 6000,
           shipping_cents: 500
       )
 
-    @payment_request.line_items << Apruve::LineItem.new(
+    @order.order_items << Apruve::OrderItem.new(
           title: 'Letter Paper',
           description: '20 lb ream (500 Sheets). Paper dimensions are 8.5 x 11.00 inches.',
           sku: 'LTR-20R',
@@ -67,15 +66,13 @@ At the top of the file, import the apruve.js script.
 
 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
+1. use setOrder to set the order JSON and secureHash string
+1. register a callback to capture orderId
 
 ``` javascript
-    apruve.secureHash = '<%= @payment_request.secure_hash %>';
-    apruve.paymentRequest = <%= @payment_request.to_json %>;
-    apruve.registerApruveCallback(apruve.APRUVE_COMPLETE_EVENT, function () {
-        $('#paymentRequestId').val(apruve.paymentRequestId)
+    apruve.setOrder(<%= @order.to_json %>, '<%= @order.secure_hash %>');
+    apruve.registerApruveCallback(apruve.APRUVE_COMPLETE_EVENT, function (orderId) {
+        $('#orderId').val(orderId)
         $('#finishOrder').submit();
     });
 ```
@@ -86,22 +83,22 @@ Decide where to put the Apruve button
 
 ### Back on your server...
 
-Use the paymentRequestId to create a Payment
+Use the orderId to issue an Invoice
 
-    apruve_payment = Apruve::Payment.new(payment_request_id: params[:payment_request_id], amount_cents: 12345)
-    apruve_payment.save!
+    apruve_invoice = Apruve::Invoice.new(order_id: params[:order_id], amount_cents: params[:charge], issue_on_create: true)
+    apruve_invoice.save!
 
-Save the status and the payment ID with the payment in your database
+Save the status and the invoice 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!
+    my_invoice.apruve_invoice_id = apruve_invoice.id
+    my_invoice.apruve_invoice_status = apruve_payment.status
+    my_invoice.save!
 
-(optional) If you track orders separately from payments, save the paymentRequestId with your order in your database
+(optional) If you track orders separately from payments, save the orderId 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.apruve_order_id = params[:order_id]
     my_order.save
 
 ### Create a web hook listener
@@ -109,13 +106,13 @@ Save the status and the payment ID with the payment in your database
     # 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
+      puts "GOT WEBHOOK DATA FOR INVOICE #{@webhook_data}"
+      my_invoice.find_by(apruve_invoice_id: @webhook_data[:invoice_id])
+      my_invoice.apruve_payment_status = @webhook_data[:status]
+      if my_invoice.apruve_invoice_status == 'closed'
+        my_invoice.complete_order
+      elsif my_invoice.apruve_invoice_status == 'canceled'
+        my_invoice.cancel_order
       end
     end
 

data/lib/apruve.rb

@@ -14,7 +14,7 @@ module Apruve
       :scheme => 'http',
       :host => 'localhost',
       :port => 3000,
-      :version => 'v3',
+      :version => 'v4',
   }
 
   class << self
@@ -57,6 +57,10 @@ module Apruve
       self.client.put *args
     end
 
+    def patch(*args, &block)
+      self.client.patch *args
+    end
+
     def unstore(*args, &block)
       self.client.delete *args
     end
@@ -88,7 +92,7 @@ module Apruve
 
     def js_url
       port_param = [443, 80].include?(@config[:port]) ? '' : ":#{@config[:port]}"
-      "#{@config[:scheme]}://#{@config[:host]}#{port_param}/js/apruve.js"
+      "#{@config[:scheme]}://#{@config[:host]}#{port_param}/js/v4/apruve.js"
     end
   end
 

data/lib/apruve/client.rb

@@ -11,7 +11,7 @@ module Apruve
         :scheme => 'http',
         :host => 'localhost',
         :port => 3000,
-        :version => 'v3',
+        :version => 'v4',
         :logging_level => 'WARN',
         :connection_timeout => 60,
         :read_timeout => 60,
@@ -88,7 +88,7 @@ module Apruve
     private
 
     def is_http_method? method
-      [:get, :post, :put, :delete].include? method
+      [:get, :post, :put, :delete, :patch].include? method
     end
 
     def respond_to?(method, include_private = false)

data/lib/apruve/error.rb

@@ -25,11 +25,12 @@ module Apruve
       # set_attrs
       errors = body.fetch('errors', nil)
       unless errors.nil?
-        error = errors[0][:error]
-        extra = error[:message] ? " -- #{error[:message]}" : ""
+        error = errors[0]
+        extra = error[:source] ? " -- #{error[:source][:parameter]}" : ""
+        extra += error[:detail] ? " -- #{error[:detail]}" : ""
         "#{self.class.name}(#{response[:status]}):: "\
         "#{response[:method].to_s.upcase} #{response[:url].to_s}: "\
-        "#{error[:description]} #{extra}"
+        "#{error[:title]} #{extra}"
       end
     end
   end

data/lib/apruve/resources.rb

@@ -2,9 +2,11 @@
 
 require_relative 'resources/validation_error'
 require_relative 'resources/apruve_object'
-require_relative 'resources/payment_request'
-require_relative 'resources/line_item'
-require_relative 'resources/payment'
-require_relative 'resources/payment_item'
+require_relative 'resources/order'
+require_relative 'resources/order_item'
+require_relative 'resources/invoice'
+require_relative 'resources/invoice_item'
+require_relative 'resources/merchant'
 require_relative 'resources/subscription'
-require_relative 'resources/subscription_adjustment'
+require_relative 'resources/subscription_adjustment'
+require_relative 'resources/webhook_endpoint'

data/lib/apruve/resources/invoice.rb

@@ -0,0 +1,69 @@
+module Apruve
+  class Invoice < Apruve::ApruveObject
+    attr_accessor :id, :order_id, :status, :amount_cents, :currency, :merchant_notes, :merchant_invoice_id, :shipping_cents,
+                  :tax_cents, :invoice_items, :payments, :created_at, :opened_at, :due_at, :final_state_at, :issue_on_create, :links
+
+    def self.find(id)
+      response = Apruve.get("invoices/#{id}")
+      Invoice.new(response.body)
+    end
+
+    def initialize(params)
+      super
+      # hydrate payment items if appropriate
+      if @invoice_items.nil?
+        @invoice_items = []
+      elsif @invoice_items.is_a?(Array) && @invoice_items.first.is_a?(Hash)
+        hydrated_items = []
+        @invoice_items.each do |item|
+          hydrated_items << Apruve::OrderItem.new(item)
+        end
+        @invoice_items = hydrated_items
+      end
+      @currency = Apruve.default_currency if currency.nil?
+    end
+
+    def validate
+      errors = []
+      errors << 'order_id must be set' if order_id.nil?
+      errors << 'amount_cents must be set' if amount_cents.nil?
+      raise Apruve::ValidationError.new(errors) if errors.length > 0
+    end
+
+    def save!
+      validate
+      response = Apruve.post('invoices', self.to_json)
+      self.id = response.body['id']
+      self.status = response.body['status']
+      self.status
+    end
+
+    def update!
+      validate
+      response = Apruve.patch("invoices/#{id}", self.to_json)
+      self.status = response.body['status']
+      self.status
+    end
+
+    def issue!
+      validate
+      response = Apruve.post("invoices/#{id}/issue")
+      self.status = response.body['status']
+      self.status
+    end
+
+    def close!
+      validate
+      response = Apruve.post("invoices/#{id}/close")
+      self.status = response.body['status']
+      self.status
+    end
+
+    def cancel!
+      validate
+      response = Apruve.post("invoices/#{id}/cancel")
+      self.status = response.body['status']
+      self.status
+    end
+  end
+end

data/lib/apruve/resources/invoice_item.rb

@@ -0,0 +1,7 @@
+module Apruve
+  class InvoiceItem < Apruve::ApruveObject
+    attr_accessor :title, :price_total_cents, :price_ea_cents, :quantity, :description, :variant_info, :sku,
+                  :vendor, :view_product_url
+
+  end
+end

data/lib/apruve/resources/merchant.rb

@@ -0,0 +1,11 @@
+module Apruve
+  class Merchant < Apruve::ApruveObject
+    attr_accessor :id, :name, :email, :web_url, :phone
+
+    def self.find(id)
+      response = Apruve.get("merchants/#{id}")
+      logger.debug response.body
+      Merchant.new(response.body)
+    end
+  end
+end

data/lib/apruve/resources/order.rb

@@ -0,0 +1,81 @@
+module Apruve
+  class Order < Apruve::ApruveObject
+    attr_accessor :id, :merchant_id, :customer_id, :merchant_order_id, :status, :amount_cents, :currency, :tax_cents,
+                  :shipping_cents, :expire_at, :order_items, :accepts_payments_via, :accepts_payment_terms, :payment_terms,
+                  :created_at, :updated_at, :final_state_at, :default_payment_method, :links, :finalize_on_create, :invoice_on_create
+
+    def self.find(id)
+      response = Apruve.get("orders/#{id}")
+      logger.debug response.body
+      Order.new(response.body)
+    end
+
+    def self.finalize!(id)
+      response = Apruve.post("orders/#{id}/finalize")
+      logger.debug response.body
+      Order.new(response.body)
+    end
+
+    def self.invoices_for(order_id)
+      response = Apruve.get("orders/#{order_id}/invoices")
+      ret = []
+      response.body.each do |i|
+        ret << Invoice.new(i)
+      end
+      ret
+    end
+
+    def self.cancel!(id)
+      response = Apruve.post("orders/#{id}/cancel")
+      logger.debug response.body
+      Order.new(response.body)
+    end
+    
+    def update!
+      response = Apruve.patch("orders/#{id}", {order: self}.to_json )
+      logger.debug response.body
+      initialize response.body
+    end
+
+    def initialize(params)
+      super
+      # hydrate line items if appropriate
+      if @order_items.nil?
+        @order_items = []
+      elsif @order_items.is_a?(Array) && @order_items.first.is_a?(Hash)
+        hydrated_items = []
+        @order_items.each do |item|
+          hydrated_items << Apruve::OrderItem.new(item)
+        end
+        @order_items = hydrated_items
+      end
+    end
+
+    def validate
+      errors = []
+      errors << 'merchant_id must be set' if merchant_id.nil?
+      raise Apruve::ValidationError.new(errors) if errors.length > 0
+    end
+
+    def value_string
+      # add each field in the PR
+      str = "#{merchant_id}#{merchant_order_id}#{amount_cents}#{currency}#{tax_cents}#{shipping_cents}#{expire_at}#{accepts_payment_terms}#{finalize_on_create}#{invoice_on_create}"
+
+      # add the line items
+      self.order_items.each do |item|
+        str += "#{item.title}#{item.plan_code}#{item.amount_cents}#{item.price_ea_cents}"\
+        "#{item.quantity}#{item.merchant_notes}#{item.description}#{item.variant_info}#{item.sku}"\
+        "#{item.vendor}#{item.view_product_url}"
+      end
+
+      str
+    end
+
+    def secure_hash
+      if Apruve.client.api_key.nil?
+        raise 'api_key has not been set. Set it with Apruve.configure(api_key, environment, options)'
+      end
+      Digest::SHA256.hexdigest(Apruve.client.api_key+value_string)
+    end
+  end
+end