slidepay 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cf7619f4c541983edb493fb3caa136c4c1eb1d4
-  data.tar.gz: 3af9338097e72789975c082244ffdce80af315b9
+  metadata.gz: 4fd5c93874d452c096489e21fc5e21299a402b6d
+  data.tar.gz: 831e67be3a2080f47b5d3bac38ca22c5989ddea7
 SHA512:
-  metadata.gz: 17a174b5c5e057bb323fded70397604d7c788821929495ac917ad75d2dfb0ab67ec88d9e63b75b8e79672213521ccb46be8b0a153528fb2fea4e82eeb432be43
-  data.tar.gz: 908c1acf7987fd88dda966228a5a67c8bb6e46ad00043ae61fbd5e06928b01a88e41040ce2016df71dd0975a9bb5e7545452521dffac58f9712562fed436c1b2
+  metadata.gz: 6c58e8724d17eb29812939567f60abcffea199e703842dfe3edfd61ba7761eb2da8a5fe748ab845ead0d48b77cf915e329303a829cc6c23b8fd75ad0b8664c89
+  data.tar.gz: 80276a5604efaa119532f372e4bcad0f6b4efd4cf557ccf03c0f81e9e79c257daf1f723891a5d0e9da5d7879fb6cff7eed6c9361875377076c172638139cc853

data/Guardfile

@@ -6,4 +6,5 @@ guard 'rspec', :version => 2 do
   watch(%r{^lib/.+\.rb$})
   watch(%r{^lib/slidepay/(.+)\.rb$})  { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^lib/slidepay/resources/(.+)\.rb$})  { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/slidepay/reports/(.+)\.rb$})  { |m| "spec/#{m[1]}_spec.rb" }
 end

data/README.md

@@ -4,7 +4,13 @@
 
 [![Gem Version](https://badge.fury.io/rb/slidepay.png)](http://badge.fury.io/rb/slidepay) [![Build Status](https://travis-ci.org/SlidePay/slidepay-ruby-sdk.png)](https://travis-ci.org/SlidePay/slidepay-ruby-sdk) [![Code Climate](https://codeclimate.com/github/SlidePay/slidepay-ruby-sdk.png)](https://codeclimate.com/github/SlidePay/slidepay-ruby-sdk)
 
-First version of the SlidePay Ruby SDK
+## Using the Gem
+
+Add the following line to your Gemfile:
+
+```ruby
+gem 'slidepay'
+```
 
 ## Dependencies
 
@@ -191,6 +197,62 @@ p.refund()
 SlidePay.post(path: 'payment/refund/#{payment_id}')
 ```
 
+## Reports
+
+The SlidePay reports allow broader views into a user's data. The reports retrieve this data based on constraints supplied in the Report class constructor.
+
+We currently expose two reports through the Ruby library: an Account Report and a Payment Report.
+
+### Account Report
+
+The account report gives a view into the current state of the SlidePay user's account.
+
+The only valid constraint for this report is on location_id, and may be supplied in the ways illustrated below.
+
+```ruby
+
+# Pass the location_id constraint in as an integer
+account_report = SlidePay::AccountReport.new(14)
+account_report.retrieve()
+
+# Pass the location_id constraint in as a string
+account_report = SlidePay::AccountReport.new("14")
+account_report.retrieve()
+
+# Pass the location_id constraint in as a hash
+account_report = SlidePay::AccountReport.new(location_id: 14)
+account_report.retrieve()
+
+```
+
+### Payment Report
+
+The payment report gives a detailed view into the past payments for an account. The report can be constrained in many dimensions using one or more [```search_filters```](https://getcube.atlassian.net/wiki/display/CDP/search_filter+and+search_filter_array).
+
+Search filters are optional, should be supplied on object instantiation, and can be supplied through a hash (if there is only one), or as an array (for > 0 search filters).
+
+```ruby
+
+# Supply no search filter to retrieve all payment data accessible by the currently authenticated account
+payment_report = SlidePay::PaymentReport.new()
+payment_report.retrieve()
+
+# Supply a single search filter as a hash
+single_time_search_filter = {field: "created", condition: "greater_than", value: "12/12/2013"}
+payment_report = SlidePay::PaymentReport.new(single_time_search_filter)
+payment_report.retrieve()
+
+# Supply multiple search filters in an array
+search_filter_array = []
+search_filter_array.push({field: "created", condition: "greater_than", value: "10/12/2013"})
+search_filter_array.push({field: "created", condition: "less_than", value: "12/12/2013"})
+search_filter_array.push({field: "amount", condition: "greater_than", value: 1.01})
+
+payment_report = SlidePay::PaymentReport.new(search_filter_array)
+payment_report.retrieve()
+
+```
+
 ## Testing
 
 ### Basics

data/TODO.md

@@ -0,0 +1,12 @@
+[ ] Reports
+---------------
+[ ] Account
+[ ] Payment
+
+[ ] ACH
+---------------
+[ ] Retrieval
+[ ] Settlement
+[ ] Balance
+-- Speculative
+[ ] Credit

data/lib/slidepay.rb

@@ -21,6 +21,14 @@ require "slidepay/resources/customer"
 require "slidepay/resources/location"
 require "slidepay/resources/company"
 
+# Reporting
+require "slidepay/reports/report"
+require "slidepay/reports/put_report"
+require "slidepay/reports/post_report"
+require "slidepay/reports/account_report"
+require "slidepay/reports/payment_report"
+
+
 module SlidePay
   class << self
     attr_accessor :token, :api_key, :endpoint

data/lib/slidepay/reports/account_report.rb

@@ -0,0 +1,17 @@
+module SlidePay
+  class AccountReport < PostReport
+    def initialize(options={})
+      @url = "report/account"
+
+      if options.is_a? String or options.is_a? Integer
+        @sfa = [{field: "location_id", condition: "equals", value: options}]
+      elsif options['location_id'] != nil or options[:location_id] != nil
+        @sfa = [{field: "location_id", condition: "equals", value: options['location_id'] || options[:location_id]}]
+      else
+        @sfa = []
+      end
+
+      super(@sfa)
+    end
+  end
+end

data/lib/slidepay/reports/payment_report.rb

@@ -0,0 +1,9 @@
+module SlidePay
+  class PaymentReport < PostReport
+    def initialize(options={})
+      @url = "report/payment"
+
+      super(options)
+    end
+  end
+end

data/lib/slidepay/reports/post_report.rb

@@ -0,0 +1,21 @@
+module SlidePay
+  class PostReport < Report
+    def initialize(options={})
+      @report_type = :post
+
+      super(options)
+    end
+
+    private
+
+    def data_from_sfa(options={})
+      return {
+        csv:            options[:csv] || false,
+        email_address:  options[:email_address] || nil,
+        html:           options[:html] || false,
+        raw_data:       options[:raw_data] || true,
+        sfa:            @sfa
+      }.to_json
+    end
+  end
+end

data/lib/slidepay/reports/put_report.rb

@@ -0,0 +1,9 @@
+module SlidePay
+  class PutReport < Report
+    def initialize(options={})
+      @report_type = :put
+
+      super(options)
+    end
+  end
+end

data/lib/slidepay/reports/report.rb

@@ -0,0 +1,53 @@
+module SlidePay
+  class Report < Hash
+    attr_accessor :sfa
+    attr_accessor :url
+    attr_accessor :report_type
+
+    attr_accessor :token, :api_key, :endpoint
+
+    def initialize(search_params={})
+      # Initialize search_filter_arrays
+      if search_params.is_a? Hash
+        @sfa = [search_params]
+      elsif search_params.is_a? Array
+        @sfa = search_params
+      else
+        @sfa = []
+      end
+    end
+
+    def retrieve(options={})
+      token = @token || options[:token]
+      api_key = @api_key || options[:api_key]
+      endpoint = @endpoint || options[:endpoint]
+
+      if @report_type == :put
+        response = SlidePay.put(path: @url, data: data_from_sfa, token: token, api_key: api_key, endpoint: endpoint)
+      elsif @report_type == :post
+        response = SlidePay.post(path: @url, data: data_from_sfa, token: token, api_key: api_key, endpoint: endpoint)
+      end
+
+      if response.was_successful?
+        populate_from_response(response)
+      end
+    end
+
+    private
+
+    # Override this for specialty reports
+    def data_from_sfa
+      return @sfa.to_json
+    end
+
+    def populate_from_response(response)
+      if response.data.instance_of? Array
+        self.merge! response.data.first
+      elsif response.data.instance_of? Hash
+        self.merge! response.data
+      else
+        raise Exception.new("Report was unsuccessful.")
+      end
+    end
+  end
+end

data/lib/slidepay/version.rb

@@ -1,3 +1,3 @@
 module SlidePay
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/scenarios/account_report_retrieve.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), 'spec'))
+
+require 'multi_json'
+require 'slidepay'
+require 'spec_helper'
+
+include SlidePay
+
+SlidePay.configure(development: true)
+SlidePay.api_key = ENV["api_key"]
+
+RestClient.proxy = "http://127.0.0.1:8888"
+
+
+puts "Retrieving account report with no search filters:"
+puts "======================================================================"
+
+account_report = SlidePay::AccountReport.new(14)
+account_report.retrieve()
+
+if account_report.empty?
+  puts "Account report returned empty nothing."
+else
+  puts "Account report: "
+  puts "#{account_report}"
+end

data/scenarios/payment_report_retrieve.rb

@@ -0,0 +1,27 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+$:.unshift(File.join(File.dirname(__FILE__), 'spec'))
+
+require 'multi_json'
+require 'slidepay'
+require 'spec_helper'
+
+include SlidePay
+
+SlidePay.configure(development: true)
+SlidePay.api_key = ENV["api_key"]
+
+# RestClient.proxy = "http://127.0.0.1:8888"
+
+
+puts "Retrieving payment report with no search filters:"
+puts "======================================================================"
+
+payment_report = SlidePay::PaymentReport.new([field: "created", condition: "greater_than", value: "12/12/2013"])
+payment_report.retrieve()
+
+if payment_report.empty?
+  puts "Payment report returned nothing."
+else
+  puts "Payment report: "
+  puts "#{payment_report}"
+end

data/spec/account_report_spec.rb

@@ -0,0 +1,68 @@
+require "slidepay"
+require "spec_helper"
+
+describe SlidePay::AccountReport do
+  def request_params(data)
+    return { path: "report/account", data: data, token: nil, api_key: nil, endpoint: nil }
+  end
+
+  def sfa(location_id)
+    [field: "location_id", condition: "equals", value: location_id]
+  end
+
+  def search_filter_data(location_id)
+    return {
+      csv:            false,
+      email_address:  nil,
+      html:           false,
+      raw_data:       true,
+      sfa:            sfa(location_id)
+    }.to_json
+  end
+
+
+  it "should be a post report" do
+    r = SlidePay::AccountReport.new()
+    expect(r.report_type).to eq(:post)
+  end
+
+  it "should be retrieve from the account_report url" do
+    r = SlidePay::AccountReport.new()
+    expect(r.url).to eq('report/account')
+  end
+
+  describe "initialize" do
+    it "should interpret a string as a location_id" do
+      location_id = "12"
+      r = SlidePay::AccountReport.new(location_id)
+      request_info = request_params(search_filter_data(location_id))
+      SlidePay.should_receive(:post).with(request_info).and_return(a_response_object)
+      r.retrieve()
+    end
+
+    it "should interpret an integer as a location_id" do
+      location_id = 12
+      r = SlidePay::AccountReport.new(location_id)
+      request_info = request_params(search_filter_data(location_id))
+      SlidePay.should_receive(:post).with(request_info).and_return(a_response_object)
+      r.retrieve()
+    end
+
+    it "should take a hash with a string for a key" do
+      location_id = 12
+      r = SlidePay::AccountReport.new({ "location_id" => location_id })
+      request_info = request_params(search_filter_data(location_id))
+      SlidePay.should_receive(:post).with(request_info).and_return(a_response_object)
+      r.retrieve()
+    end
+
+    it "should take a hash with a symbol for a key" do
+      location_id = 12
+      r = SlidePay::AccountReport.new(location_id: location_id)
+      request_info = request_params(search_filter_data(location_id))
+      SlidePay.should_receive(:post).with(request_info).and_return(a_response_object)
+      r.retrieve()
+    end
+
+  end
+end

data/spec/payment_report_spec.rb

@@ -0,0 +1,14 @@
+require "slidepay"
+require "spec_helper"
+
+describe SlidePay::PaymentReport do
+  it "should be a post report" do
+    r = SlidePay::PaymentReport.new([])
+    expect(r.report_type).to eq(:post)
+  end
+
+  it "should be retrieve from the payment_report url" do
+    r = SlidePay::PaymentReport.new([])
+    expect(r.url).to eq('report/payment')
+  end
+end

data/spec/post_report_spec.rb

@@ -0,0 +1,29 @@
+require "slidepay"
+require "spec_helper"
+
+describe SlidePay::PostReport do
+  def sfa
+    [field: "created", condition: "greater_than", value: "12/12/2013"]
+  end
+
+  def search_filter_data
+    return {
+      csv:            false,
+      email_address:  nil,
+      html:           false,
+      raw_data:       true,
+      sfa:            sfa
+    }.to_json
+  end
+
+  it "should have a report_type" do
+    b = SlidePay::PostReport.new([])
+    expect(b.report_type).to eq(:post)
+  end
+
+  it "should use a special type of report data structure" do
+    b = SlidePay::PostReport.new(sfa)
+    SlidePay.should_receive(:post).with(path: nil, data: search_filter_data, token: nil, api_key: nil, endpoint: nil).and_return(a_response_object)
+    b.retrieve()
+  end
+end

data/spec/put_report_spec.rb

@@ -0,0 +1,9 @@
+require "slidepay"
+require "spec_helper"
+
+describe SlidePay::PutReport do
+  it "should have a report_type" do
+    b = SlidePay::PutReport.new([])
+    expect(b.report_type).to eq(:put)
+  end
+end

data/spec/report_spec.rb

@@ -0,0 +1,61 @@
+require "slidepay"
+require "spec_helper"
+
+def example_search_filter
+  return { field: "created", condition: "equals", value: "12/01/2013"}
+end
+
+describe SlidePay::Report do
+  it "should accept an array on instantiation" do
+    b = SlidePay::Report.new([])
+    expect(b.sfa).to eq([])
+  end
+
+  it "should accept a hash on instantiation" do
+    b = SlidePay::Report.new(example_search_filter)
+    expect(b.sfa).to eq([example_search_filter])
+  end
+
+  describe "retrieve" do
+    it "should make a put request if report_type is :put" do
+      b = SlidePay::Report.new(example_search_filter)
+      b.report_type = :put
+
+      SlidePay.should_receive(:put).and_return(a_response_object)
+      b.retrieve()
+    end
+
+    it "should make a post request if report_type is :post" do
+      b = SlidePay::Report.new(example_search_filter)
+      b.report_type = :post
+
+      SlidePay.should_receive(:post).and_return(a_response_object)
+      b.retrieve()
+    end
+
+    it "should pass the report url and search filter array to the request method" do
+      b = SlidePay::Report.new(example_search_filter)
+      b.report_type = :put
+      b.url = "EXAMPLE_URL"
+
+      retrieve_params = { path: "EXAMPLE_URL", data: [example_search_filter].to_json, token: nil, api_key: nil, endpoint: nil }
+
+      SlidePay.should_receive(:put).with(retrieve_params).and_return(a_response_object)
+      b.retrieve()
+    end
+
+    it "should populate the report object from the response" do
+      b = SlidePay::Report.new([])
+      b.report_type = :put
+      b.url = "DOG_REPORT_URL"
+
+      retrieve_params = { path: "EXAMPLE_URL", data: [].to_json, options: {} }
+
+      SlidePay.should_receive(:put).and_return(a_response_object)
+      b.retrieve()
+
+      expect(b["id"]).to eq("1")
+      expect(b["name"]).to eq("Dog the Bounty Hunter")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slidepay
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Matt Rothstein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -154,9 +154,15 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- TODO.md
 - lib/slidepay.rb
 - lib/slidepay/client.rb
 - lib/slidepay/config.rb
+- lib/slidepay/reports/account_report.rb
+- lib/slidepay/reports/payment_report.rb
+- lib/slidepay/reports/post_report.rb
+- lib/slidepay/reports/put_report.rb
+- lib/slidepay/reports/report.rb
 - lib/slidepay/resources/api_key.rb
 - lib/slidepay/resources/api_resource.rb
 - lib/slidepay/resources/bank_account.rb
@@ -168,20 +174,27 @@ files:
 - lib/slidepay/response.rb
 - lib/slidepay/util.rb
 - lib/slidepay/version.rb
+- scenarios/account_report_retrieve.rb
 - scenarios/company_retrieve.rb
 - scenarios/example.rb
 - scenarios/location_retrieve.rb
 - scenarios/payment_find_where_id.rb
 - scenarios/payment_find_where_under_review.rb
+- scenarios/payment_report_retrieve.rb
 - scenarios/use_api_resource_for_arbitrary_object.rb
 - scenarios/user_master_find_with_first_name_fragment.rb
 - scenarios/user_master_retrieve.rb
 - slidepay.gemspec
+- spec/account_report_spec.rb
 - spec/api_key_spec.rb
 - spec/api_resource_spec.rb
 - spec/bank_account_spec.rb
 - spec/client_spec.rb
+- spec/payment_report_spec.rb
 - spec/payment_spec.rb
+- spec/post_report_spec.rb
+- spec/put_report_spec.rb
+- spec/report_spec.rb
 - spec/response_spec.rb
 - spec/slidepay_spec.rb
 - spec/spec_helper.rb
@@ -210,11 +223,16 @@ signing_key:
 specification_version: 4
 summary: SlidePay Ruby SDK
 test_files:
+- spec/account_report_spec.rb
 - spec/api_key_spec.rb
 - spec/api_resource_spec.rb
 - spec/bank_account_spec.rb
 - spec/client_spec.rb
+- spec/payment_report_spec.rb
 - spec/payment_spec.rb
+- spec/post_report_spec.rb
+- spec/put_report_spec.rb
+- spec/report_spec.rb
 - spec/response_spec.rb
 - spec/slidepay_spec.rb
 - spec/spec_helper.rb